USBDevice
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
Note: This feature is available in Web Workers.
The USBDevice interface of the WebUSB API provides access to metadata about a paired USB device and methods for controlling it.
Instance properties
USBDevice.configurationRead only-
A
USBConfigurationobject for the currently selected interface for a paired USB device. USBDevice.configurationsRead only-
An
arrayof device-specific interfaces for controlling a paired USB device. USBDevice.deviceClassRead 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.deviceSubclassandUSBDevice.deviceProtocol. USBDevice.deviceProtocolRead 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.deviceClassandUSBDevice.deviceSubclass. USBDevice.deviceSubclassRead 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.deviceClassandUSBDevice.deviceProtocol. USBDevice.deviceVersionMajorRead only-
The major version number of the device in a semantic versioning scheme.
USBDevice.deviceVersionMinorRead only-
The minor version number of the device in a semantic versioning scheme.
USBDevice.deviceVersionSubminorRead only-
The patch version number of the device in a semantic versioning scheme.
USBDevice.manufacturerNameRead only-
The name of the organization that manufactured the USB device.
USBDevice.openedRead only-
Indicates whether a session has been started with a paired USB device.
USBDevice.productIdRead only-
The manufacturer-defined code that identifies a USB device.
USBDevice.productNameRead only-
The manufacturer-defined name that identifies a USB device.
USBDevice.serialNumberRead only-
The manufacturer-defined serial number for the specific USB device.
USBDevice.usbVersionMajorRead only-
One of three properties that declare the USB protocol version supported by the device. The other two properties are
USBDevice.usbVersionMinorandUSBDevice.usbVersionSubminor. USBDevice.usbVersionMinorRead only-
One of three properties that declare the USB protocol version supported by the device. The other two properties are
USBDevice.usbVersionMajorandUSBDevice.usbVersionSubminor. USBDevice.usbVersionSubminorRead only-
One of three properties that declare the USB protocol version supported by the device. The other two properties are
USBDevice.usbVersionMajorandUSBDevice.usbVersionMinor. USBDevice.vendorIdRead only-
The official usb.org-assigned vendor ID.
Instance methods
USBDevice.claimInterface()-
Returns a
Promisethat resolves when the requested interface is claimed for exclusive access. USBDevice.clearHalt()-
Returns a
Promisethat resolves when a halt condition is cleared. USBDevice.controlTransferIn()-
Returns a
Promisethat resolves with aUSBInTransferResultwhen a command or status operation has been transmitted to the USB device. USBDevice.controlTransferOut()-
Returns a
Promisethat resolves with aUSBOutTransferResultwhen a command or status operation has been transmitted from the USB device. USBDevice.close()-
Returns a
Promisethat resolves when all open interfaces are released and the device session has ended. USBDevice.forget()-
Returns a
Promisethat resolves after all open interfaces are released, the device session has ended, and the permission is reset. USBDevice.isochronousTransferIn()-
Returns a
Promisethat resolves with aUSBIsochronousInTransferResultwhen time sensitive information has been transmitted to the USB device. USBDevice.isochronousTransferOut()-
Returns a
Promisethat resolves with aUSBIsochronousOutTransferResultwhen time sensitive information has been transmitted from the USB device. USBDevice.open()-
Returns a
Promisethat resolves when a device session has started. USBDevice.releaseInterface()-
Returns a
Promisethat resolves when a claimed interface is released from exclusive access. USBDevice.reset()-
Returns a
Promisethat resolves when the device is reset and all app operations canceled and their promises rejected. USBDevice.selectAlternateInterface()-
Returns a
Promisethat resolves when the specified alternative endpoint is selected. USBDevice.selectConfiguration()-
Returns a
Promisethat resolves when the specified configuration is selected. USBDevice.transferIn()-
Returns a
Promisethat resolves with aUSBInTransferResultwhen bulk or interrupt data is received from the USB device. USBDevice.transferOut()-
Returns a
Promisethat resolves with aUSBOutTransferResultwhen bulk or interrupt data is sent to the USB device.
Specifications
| Specification |
|---|
| WebUSB API # device-usage |
Browser compatibility
| desktop | mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
USBDevice
|
|
|
|
|
|
|
|
|
|
|
|
|
claimInterface
|
|
|
|
|
|
|
|
|
|
|
|
|
clearHalt
|
|
|
|
|
|
|
|
|
|
|
|
|
close
|
|
|
|
|
|
|
|
|
|
|
|
|
configuration
|
|
|
|
|
|
|
|
|
|
|
|
|
configurations
|
|
|
|
|
|
|
|
|
|
|
|
|
controlTransferIn
|
|
|
|
|
|
|
|
|
|
|
|
|
controlTransferOut
|
|
|
|
|
|
|
|
|
|
|
|
|
deviceClass
|
|
|
|
|
|
|
|
|
|
|
|
|
deviceProtocol
|
|
|
|
|
|
|
|
|
|
|
|
|
deviceSubclass
|
|
|
|
|
|
|
|
|
|
|
|
|
deviceVersionMajor
|
|
|
|
|
|
|
|
|
|
|
|
|
deviceVersionMinor
|
|
|
|
|
|
|
|
|
|
|
|
|
deviceVersionSubminor
|
|
|
|
|
|
|
|
|
|
|
|
|
forget
|
|
|
|
|
|
|
|
|
|
|
|
|
isochronousTransferIn
|
|
|
|
|
|
|
|
|
|
|
|
|
isochronousTransferOut
|
|
|
|
|
|
|
|
|
|
|
|
|
manufacturerName
|
|
|
|
|
|
|
|
|
|
|
|
|
open
|
|
|
|
|
|
|
|
|
|
|
|
|
opened
|
|
|
|
|
|
|
|
|
|
|
|
|
productId
|
|
|
|
|
|
|
|
|
|
|
|
|
productName
|
|
|
|
|
|
|
|
|
|
|
|
|
releaseInterface
|
|
|
|
|
|
|
|
|
|
|
|
|
reset
|
|
|
|
|
|
|
|
|
|
|
|
|
selectAlternateInterface
|
|
|
|
|
|
|
|
|
|
|
|
|
selectConfiguration
|
|
|
|
|
|
|
|
|
|
|
|
|
serialNumber
|
|
|
|
|
|
|
|
|
|
|
|
|
transferIn
|
|
|
|
|
|
|
|
|
|
|
|
|
transferOut
|
|
|
|
|
|
|
|
|
|
|
|
|
usbVersionMajor
|
|
|
|
|
|
|
|
|
|
|
|
|
usbVersionMinor
|
|
|
|
|
|
|
|
|
|
|
|
|
usbVersionSubminor
|
|
|
|
|
|
|
|
|
|
|
|
|
vendorId
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Available in workers
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Partial support
- Partial support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- Has more compatibility info.