USBDevice

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The USBDevice interface of the the WebUSB API provides access to metadata about a paired USB device and methods for controlling it.

Properties

USBDevice.configuration Read only
USBConfiguration object for the currently selected interface for a paired USB device.
USBDevice.configurations Read only
An array of device-specific interfaces for controlling a paired USB device.
USBDevice.deviceClass Read only
One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are USBDevice.deviceSubclass and USBDevice.deviceprotocol.
USBDevice.deviceProtocol Read only
One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are USBDevice.deviceClass and USBDevice.deviceSubclass.
USBDevice.deviceSubclass Read only
One of three properties that identify USB devices for the purpose of loading a USB driver that will work with that device. The other two properties are USBDevice.deviceClass and USBDevice.deviceProtocol.
USBDevice.deviceVersionMajor Read only
The major version number of the device in a semantic versioning scheme.
USBDevice.deviceVersionMinor Read only
The minor version number of the device in a semantic versioning scheme.
USBDevice.deviceVersionSubminor Read only
The patch version number of the device in a semantic versioning scheme.
USBDevice.manufacturerName Read only
The of the organization that manufactured the USB device.
USBDevice.opened Read only
Indicates whether a session has been started with a paired USB device.
USBDevice.productId Read only
The manufacturer-defined code that identifies a USB device.
USBDevice.productName Read only
The manufacturer-defined name that identifies a USB device.
USBDevice.serialNumber Read only
The manufacturer-defined serial number for the specific USB device.
USBDevice.usbVersionMajor Read only
One of three properties that declare the USB protocol version supported by the device. The other two properties are USBDevice.usbVersionMinor and USBDevice.usbVersionSubminor.
USBDevice.usbVersionMinor Read only
One of three properties that declare the USB protocol version supported by the device. The other two properties are USBDevice.usbVersionMajor and USBDevice.usbVersionSubminor.
USBDevice.usbVersionSubminor Read only
One of three properties that declare the USB protocol version supported by the device. The other two properties are USBDevice.usbVersionMajor and USBDevice.usbVersionMinor.
USBDevice.vendorId Read only
The official usg.org-assigned vendor ID.

Methods

USBDevice.claimInterface()
Returns a promise that resolves when the requested interface is claimed for exclusive access.
USBDevice.clearHalt()
Returns a promise that resolves when a halt condition is cleared.
USBDevice.controlTransferIn()
Returns a promise that resolves with a USBTransferInResult when a command or status operation has been transmitted to the USB device.
USBDevice.controlTransferOut()
Returns a promise that resolves with a USBTransferOutResult when a command or status operation has been transmitted from the USB device.
USBDevice.close()
Returns a promise that resolves when all open interfaces are released and the device session has ended.
USBDevice.isochronousTransferIn()
Returns a promise that resolves with a USBIsochronousInTransferResult when time sensitive information has been transmitted to the USB device.
USBDevice.isochronousTransferOut()
Returns a promise that resolves with a USBIsochronousOutTransferResult when time sensitive information has been transmitted from the USB device.
USBDevice.open()
Returns a promise that resolves when a device session has started.
USBDevice.releaseInterface()
Returns a promise that resolves when a cliamed interface is released from exclusive access.
USBDevice.reset()
Returns a promise that resolves when the device is reset and all app operations canceled and their promises rejected.
USBDevice.selectAlternateInterface()
Returns a promise that resolves when the specified alternative endpoint is selected.
USBDevice.selectConfiguration()
Returns a promise that resolves when the specified configuration is selected.
USBDevice.transferIn()
Returns a promise that resolves with a USBTransferInResult when bulk or interrupt data is transmitted to the USB device.
USBDevice.transferOut()
Returns a promise that resolves with a USBTransferOutResult when bulk or interrupt data is transmitted from the USB device.

Specifications

Specification Status Comment
WebUSB
The definition of 'USBDevice' in that specification.
Draft Initial definition.

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support61 No No No48 No
usbVersionMajor61 No No No48 No
usbVersionMinor61 No No No48 No
usbVersionSubminor61 No No No48 No
deviceClass61 No No No48 No
deviceSubclass61 No No No48 No
deviceProtocol61 No No No48 No
vendorId61 No No No48 No
productId61 No No No48 No
deviceVersionMajor61 No No No48 No
deviceVersionMinor61 No No No48 No
deviceVersionSubminor61 No No No48 No
manufacturerName61 No No No48 No
productName61 No No No48 No
serialNumber61 No No No48 No
configuration61 No No No48 No
configurations61 No No No48 No
opened61 No No No48 No
open61 No No No48 No
close61 No No No48 No
selectConfiguration61 No No No48 No
claimInterface61 No No No48 No
releaseInterface61 No No No48 No
selectAlternateInterface61 No No No48 No
controlTransferIn61 No No No48 No
controlTransferOut61 No No No48 No
clearHalt61 No No No48 No
transferIn61 No No No48 No
transferOut61 No No No48 No
isochronousTransferIn61 No No No48 No
isochronousTransferOut61 No No No48 No
reset61 No No No48 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No61 No No48 No No
usbVersionMajor No61 No No48 No No
usbVersionMinor No61 No No48 No No
usbVersionSubminor No61 No No48 No No
deviceClass No61 No No48 No No
deviceSubclass No61 No No48 No No
deviceProtocol No61 No No48 No No
vendorId No61 No No48 No No
productId No61 No No48 No No
deviceVersionMajor No61 No No48 No No
deviceVersionMinor No61 No No48 No No
deviceVersionSubminor No61 No No48 No No
manufacturerName No61 No No48 No No
productName No61 No No48 No No
serialNumber No61 No No48 No No
configuration No61 No No48 No No
configurations No61 No No48 No No
opened No61 No No48 No No
open No61 No No48 No No
close No61 No No48 No No
selectConfiguration No61 No No48 No No
claimInterface No61 No No48 No No
releaseInterface No61 No No48 No No
selectAlternateInterface No61 No No48 No No
controlTransferIn No61 No No48 No No
controlTransferOut No61 No No48 No No
clearHalt No61 No No48 No No
transferIn No61 No No48 No No
transferOut No61 No No48 No No
isochronousTransferIn No61 No No48 No No
isochronousTransferOut No61 No No48 No No
reset No61 No No48 No No

Document Tags and Contributors

Contributors to this page: jpmedley
Last updated by: jpmedley,