USBDevice

Limited availabilitySecure contextAvailable in workers

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

Instance properties

• configuration Read only Experimental
  • : A USBConfiguration object for the currently selected interface for a paired USB device.
• configurations Read only Experimental
  • : An Array of device-specific interfaces for controlling a paired USB device.
• deviceClass Read only Experimental
  • : 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.
• deviceProtocol Read only Experimental
  • : 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.
• deviceSubclass Read only Experimental
  • : 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.
• deviceVersionMajor Read only Experimental
  • : The major version number of the device in a semantic versioning scheme.
• deviceVersionMinor Read only Experimental
  • : The minor version number of the device in a semantic versioning scheme.
• deviceVersionSubminor Read only Experimental
  • : The patch version number of the device in a semantic versioning scheme.
• manufacturerName Read only Experimental
  • : The name of the organization that manufactured the USB device.
• opened Read only Experimental
  • : Indicates whether a session has been started with a paired USB device.
• productId Read only Experimental
  • : The manufacturer-defined code that identifies a USB device.
• productName Read only Experimental
  • : The manufacturer-defined name that identifies a USB device.
• serialNumber Read only Experimental
  • : The manufacturer-defined serial number for the specific USB device.
• usbVersionMajor Read only Experimental
  • : One of three properties that declare the USB protocol version supported by the device. The other two properties are USBDevice.usbVersionMinor and USBDevice.usbVersionSubminor.
• usbVersionMinor Read only Experimental
  • : One of three properties that declare the USB protocol version supported by the device. The other two properties are USBDevice.usbVersionMajor and USBDevice.usbVersionSubminor.
• usbVersionSubminor Read only Experimental
  • : One of three properties that declare the USB protocol version supported by the device. The other two properties are USBDevice.usbVersionMajor and USBDevice.usbVersionMinor.
• vendorId Read only Experimental
  • : The official usb.org-assigned vendor ID.

Instance methods

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

Specifications

Browser compatibility