Edit

Talking to USB devices, start to finish (UWP app)

  • Article

This article provides an end-to-end walkthrough of creating a UWP app that talks to a USB device.

Use the Windows Runtime APIs to write UWP apps that give users access to their peripheral USB device. Such apps can connect to a device based on user-specified criteria, get information about the device, send data to the device and conversely get data streams from the device, and poll the device for interrupt data.

Here, we describe how your UWP app can implement those tasks, and link to examples that demonstrate the use of classes included in Windows.Devices.Usb. We'll go over the device capabilities required in the app manifest and how to launch the app when the device connects. And we'll show how to run a data transfer task in the background even when the app suspends to conserve battery life.

Walkthrough—Writing a UWP app for USB devices

Follow the steps in this article or, skip directly to the Custom USB device access sample. The companion sample implements all the steps here, but to keep things moving, we don't walk through the code. Certain steps have a Find it in the sample section to help you find the code quickly. The structure of the sample's source files is simple and flat so you can easily find code without having to drill down through multiple layers of source files. But you may prefer to break up and organize your own project differently.

Install the Microsoft WinUSB driver

Install the Microsoft-provided WinUSB driver as function driver for your device.

QuickStart: WinUSB (Winusb.sys) installation

You can install Winusb.sys in these ways:

  • When you connect your device, you might notice that Windows loads Winusb.sys automatically because the device is a WinUSB Device.
  • Install the driver by specifying the system-provided device class in Device Manager.
  • Install the driver by using a custom INF. You can get the INF in either of these two ways:
    • Get the INF from the hardware vendor.
    • Write a custom INF that references the Microsoft-provided Winusb.inf file. For more information, see WinUSB (Winusb.sys) installation.

Get information about your device

Get the device interface GUID, hardware ID, and device class information about your device.

You can obtain that information from the device manufacturer.

  • Vendor and product identifiers

    In Device Manager, view the device properties. On the Details tab, view the Hardware Id property value. That value is a combination of those two identifiers. For example, for the SuperMUTT device, the Hardware Id is "USB\VID_045E&PID_F001"; vendor ID is "0x045E" and product ID is "0xF001".

  • Device class, subclass, and protocol codes

  • Device interface GUID

Alternatively, you can view information the registry. For more information, see USB device registry entries.

Determine if the USB API set allows the device class, subclass, and protocol

You can write a UWP app, if device class, subclass, and protocol code of the device is in the following list:

  • name:cdcControl, classId:02 * *
  • name:physical, classId:05 * *
  • name:personalHealthcare, classId:0f 00 00
  • name:activeSync, classId:ef 01 01
  • name:palmSync, classId:ef 01 02
  • name:deviceFirmwareUpdate, classId:fe 01 01
  • name:irda, classId:fe 02 00
  • name:measurement, classId:fe 03 *
  • name:vendorSpecific, classId:ff * *

Create a basic Visual Studio project

Create a basic Visual Studio project that you can extend in this tutorial.

For more information, see Getting started with UWP apps.

Add USB device capabilities to the app manifest

Learn how to add USB device capabilities to the app manifest.

QuickStart: How to add USB device capabilities to the app manifest

Open your Package.appxmanifest file in a text editor and add the DeviceCapability element with Name attribute set to "usb" as shown in this example.

Note

You cannot modify the USB device capability in Visual Studio. You must right-click the Package.appxmanifest file in Solution Explorer and select Open With..., and then XML (Text) Editor. The file opens in plain XML.

<Capabilities>
  <!--When the device's classId is FF * *, there is a predefined name for the class.
      You can use the name instead of the class id.
      There are also other predefined names that correspond to a classId.-->
  <m2:DeviceCapability Name="usb">
    <!--SuperMutt Device-->
    <m2:Device Id="vidpid:045E 0611">
      <!--<wb:Function Type="classId:ff * *"/>-->
      <m2:Function Type="name:vendorSpecific"/>
    </m2:Device>
  </m2:DeviceCapability>
</Capabilities>

Find it in the sample: The USB device capabilities are in the Package.appxmanifest file.

Open the device for communication

Extend the app to open the device for communication.

Quickstart: How to connect to a USB device (UWP app)

  1. Find the device by building an Advanced Query Syntax (AQS) string that contains search criteria for finding the device in the enumerated device collection.
  2. Open the device in one of two ways:
  3. Get the device instance from the DeviceInformation.Id property.
  4. Call FromIdAsync by passing the device instance string and get the UsbDevice object.

Find it in the sample: See files named Scenario1_DeviceConnect.

Study your USB device layout

Study your USB device layout.

Review basic USB concepts about configuring the device and performing data transfers: Concepts for all USB developers.

View the device configuration descriptor, interface descriptors for each supported alternate settings, and their endpoint descriptors. By using USBView, you can browse all USB controllers and the USB devices connected to them, and also inspect the device configuration.

Get and show USB descriptors in the UI

Extend the app to get and show USB descriptors in the UI.

Quickstart: How to get USB descriptors (UWP app)

Find it in the sample: See files named Scenario5_UsbDescriptors.

Send vendor-defined USB control transfers

Extend the app to send vendor-defined USB control transfers.

Quickstart: How to send a USB control transfer request (UWP app)

  1. Get the vendor command from the hardware specification of the device.
  2. Create a UsbSetupPacket object and populate the setup packet by setting various properties.
  3. Start an asynchronous operation to send the control transfer by these methods depending on the direction of the transfer:

Find it in the sample: See files named Scenario2_ControlTransfer.

Read or write bulk data

Extend the app to read or write bulk data.

Quickstart: How to send a USB bulk transfer request (UWP app)

  1. Get the bulk pipe object (UsbBulkOutPipe or UsbBulkInPipe).
  2. Configure the bulk pipe to set policy parameters.
  3. Set up the data stream by using the DataReader or DataWriter object.
  4. Start an asynchronous transfer operation by calling DataReader.LoadAsync or DataWriter.StoreAsync.
  5. Get results of the transfer operation.

Find it in the sample: See files named Scenario4_BulkPipes.

Get hardware interrupt data

Extend the app to get hardware interrupt data.

Quickstart: How to send a USB interrupt transfer request (UWP app)

  1. Get the interrupt pipe object (UsbInterruptInPipe or UsbInterruptOutPipe).
  2. Implement the interrupt handler for the DataReceived event.
  3. Register the event handler to start receiving data.
  4. Unregister the event handler to stop receiving data.

Find it in the sample: See files named Scenario3_InterruptPipes.

Select an interface setting that isn't currently active

Extend the app to select an interface setting that isn't currently active.

Quickstart: How to select a USB interface setting (UWP app)

When the device is opened for communication, the default interface and its first setting are selected. If you want to change that setting, follow these steps:

  1. Get the active setting of a USB interface by using the UsbInterfaceSetting.Selected value.
  2. Set a USB interface setting by starting an asynchronous operation by calling UsbInterfaceSetting.SelectSettingAsync.

Close the device

Extend the app to close the device.

Quickstart: How to connect to a USB device (UWP app)

After you finish using the UsbDevice object, close the device.

C++ apps must release the reference by using the delete keyword. C#/VB apps must call the UsbDevice.Dispose method. JavaScript apps must call UsbDevice.Close.

Find it in the sample: See files named Scenario1_DeviceConnect.

Create a device metadata package

Create a device metadata package for the app.

Tool: Device Metadata Authoring Wizard

  • If you have the Windows Driver Kit (WDK) installed, open Driver > Device Metadata > Authoring.
  • If you have the Standalone SDK installed, the tool is located at <install_path>\bin\x86\DeviceMetadataWizardexe.

Associate your app with the device by following the steps in the wizard. Enter this information about your device:

  • On the Device Info page, enter Model Name, Manufacturer, and Description.
  • On the Hardware Info page, enter the hardware ID of your device.

To declare the app as a privileged app for your device, follow these instructions:

  1. On the App Info page, in the Privileged application group, enter the Package name, Publisher name, and UWP app ID.

    Screenshot of Visual Studio, showing device metatdata for privileged apps.

    Note

    Do not check the Access custom driver option.

  2. Open the Finish tab. Select the Copy packages to your system's local metadata store check box.

  3. Connect the device, in Control Panel, open View devices and printers and verify that the icon of the device is correct.

Find it in the sample: See the DeviceMetadata folder.

Implement AutoPlay activation

Extend the app by implementing AutoPlay activation to launch the app when the device connects to the system.

Quickstart: Register an app for an AutoPlay device

You can add AutoPlay capabilities so the app launches when the device connects to the system. You can enable Autoplay for all UWP apps (privileged or otherwise).

  1. In your device metadata package, you must specify how the device should respond to an AutoPlay notification. On the Windows Info tab, select the UWP device app option and enter app information as shown here:

  2. In the app manifest, add AutoPlay Device declaration and launch information as shown here:

    Screenshot that shows the app manifest with 'Declarations' selected and 'AutoPlay Device' added.

  3. In the OnActivated method of the App class, check if the device activated the app. If it is, then the method receives a DeviceEventArgs parameter value that contains the DeviceInformation.Id property value. This is the same value described in Open the device for communication.

Find it in the sample: See files named Autoplay. For JavaScript, see default.js.

Implement a background task

Extend the app to implement a background task that can perform length transfers to the device, such as firmware update without the app getting suspended.

To implement background task, you need two classes.

The background task class implements the IBackgroundTask interface and contains the actual code you create to either sync or update your peripheral device. The background task class executes when the background task triggers and from the entry point provided in your app's application manifest.

Note

The device background tasks infrastructure provided by Windows 8.1. For more information about Windows background tasks, see Supporting your app with background tasks.

Background task class

  1. Implements the IBackgroundTask interface required by the Windows background task infrastructure.
  2. Obtains the DeviceUseDetails instance passed to the class in the Run method and uses this instance to report progress back to the Microsoft Store app and to register for cancellation events.
  3. The Run method also calls the private OpenDevice and WriteToDeviceAsync methods that implement the background device sync code.

The UWP app registers and triggers a DeviceUseTrigger background task. The app register, trigger, and handle progress on a background task.

Note

The example code that follows can be applied to the DeviceServicingTrigger background task by use the corresponding objects. The only difference between the two trigger objects and their corresponding APIs are the policy checks made by Windows.

  1. Creates DeviceUseTrigger and BackgroundTaskRegistration objects.
  2. Checks to see if any background tasks were previously registered by this sample application and cancels them by calling the Unregister method on the task.
  3. Registers the background task that syncs with the device. The SetupBackgroundTask method is called from the SyncWithDeviceAsync method in the next step.
    1. Initializes the DeviceUseTrigger and saves it for later use.
    2. Creates a BackgroundTaskBuilder object and uses its Name, TaskEntryPoint and SetTrigger properties and method to register the app's DeviceUseTrigger object and background task name. The BackgroundTaskBuilder object's TaskEntryPoint property is set to the full name of the background task class that will be run when the background task is triggered.
    3. Registers for completion and progress events from the background task so the Microsoft Store app can provide completion and progress updates to the user.
  4. The private SyncWithDeviceAsync method registers the background task that will sync with the device and starts the background sync.

    1. Calls the SetupBackgroundTask method from the previous step and registers the background task that will sync with the device.

    2. Calls the private StartSyncBackgroundTaskAsync method which starts the background task.

    3. Closes the app's handle to the device to ensure that the background task is able to open the device when it starts.

      Note

      The background task will need to open the device to perform the update so the Microsoft Store app must close its connections to the device before calling RequestAsync

    4. Calls the DeviceUseTrigger object's RequestAsync method which starts triggers the background task and returns the DeviceTriggerResults object from RequestAsync used to determine if the background task started successfully.

      Note

      Windows checks to ensure that all necessary task initiation policy checks have been completed. If all policy checks are completed the update operation is now running as a background task outside of the Microsoft Store app, allowing the app to be safely suspended while the operation is in progress. Windows will also enforce any runtime requirements and cancel the background task if those requirements are no longer met.

    5. Uses the DeviceTriggerResults object returned from StartSyncBackgroundTaskAsync to determine if the background task started successfully. A switch statement is used to inspect the result from DeviceTriggerResults.

  5. Implements a private OnSyncWithDeviceProgress event handler that will update the app UI with progress from the background task.
  6. Implements a private OnSyncWithDeviceCompleted event handler to handle the transition from background tasks to foreground app when the background task has completed.
    1. Uses the CheckResults method of the BackgroundTaskCompletedEventArgs object to determine if any exceptions were thrown by the background task.
    2. The app reopens the device for use by the foreground app now that the background task is complete and updates the UI to notify the user.
  7. Implements private button click event handlers from the UI to start and cancel the background task.
    1. The private Sync_Click event handler calls the SyncWithDeviceAsync method described in the previous steps.
    2. The private CancelSync_Click event handler calls the private CancelSyncWithDevice method to cancel the background task.
  8. The private CancelSyncWithDevice method unregisters and cancels any active device syncs so the device can be reopened by using the Unregister method on the BackgroundTaskRegistration object.

Find it in the sample: See files named Scenario7_Sync files. Background class is implemented in IoSyncBackgroundTask.

Run Windows app certification kit

Run the Windows app certification kit.

Using the Windows App Certification Kit

Recommended. Running the Windows app certification kit helps you make sure your app fulfills Microsoft Store requirements. You should run it whenever you add major functionality to your app.

UWP app UI, start to finish (XAML)

Learn more about designing UWP app UI.

Roadmap for UWP apps using C# and Visual Basic and Roadmap for UWP apps using C++

Learn more about creating UWP apps using C++, C#, or Visual Basic in general.

Asynchronous programming (UWP apps)

Learn about how to make your apps stay responsive when they do work that might take an extended amount of time.

Important APIs