The USBDevice interface of the the WebUSB API provides access metadata about a paired USB device and methods for controlling
The USBDevice interface of the the WebUSB API provides access metadata about a paired USB device and methods for controlling
(claim-interface this interface-number)
Method.
[Experimental]
The claimInterface() method of the web.usb.USBDevice
interface
a promise
that resolves when the requested interface is claimed
exclusive access.
var promise = USBDevice.claimInterface(interfaceNumber)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/claimInterface
Method. [Experimental] The claimInterface() method of the `web.usb.USBDevice` interface a `promise` that resolves when the requested interface is claimed exclusive access. `var promise = USBDevice.claimInterface(interfaceNumber)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/claimInterface`
(clear-halt this direction endpoint-number)
Method.
[Experimental]
The clearHalt() method of the web.usb.USBDevice
interface returns
promise
that resolves when a halt condition is cleared. A halt
is when a data tranfer to or from the device has a status of
which requires the web page (the host system, in USB terminology)
clear that condition. See the for details.
var promise = USBDevice.clearHalt(direction, endpointNumber)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/clearHalt
Method. [Experimental] The clearHalt() method of the `web.usb.USBDevice` interface returns `promise` that resolves when a halt condition is cleared. A halt is when a data tranfer to or from the device has a status of which requires the web page (the host system, in USB terminology) clear that condition. See the for details. `var promise = USBDevice.clearHalt(direction, endpointNumber)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/clearHalt`
(close this)
Method.
[Experimental]
The close() method of the web.usb.USBDevice
interface returns
promise
that resolves when all open interfaces are released
the device session has ended.
var promise = USBDevice.close()
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/close
Method. [Experimental] The close() method of the `web.usb.USBDevice` interface returns `promise` that resolves when all open interfaces are released the device session has ended. `var promise = USBDevice.close()` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/close`
(configuration this)
Property.
[Read Only] [Experimental]
The configuration read only property of the web.usb.USBDevice
returns a USBConfiguration
object for the currently selected
for a paired USB device.
var USBConfiguration = USBDevice.configuration
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/configuration
Property. [Read Only] [Experimental] The configuration read only property of the `web.usb.USBDevice` returns a `USBConfiguration` object for the currently selected for a paired USB device. `var USBConfiguration = USBDevice.configuration` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/configuration`
(configurations this)
Property.
[Read Only] [Experimental]
The configurations read only property of the web.usb.USBDevice
an array
of device-specific interfaces for controlling a paired
device.
var USBConfiguration[] = USBDevice.configurations
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/configurations
Property. [Read Only] [Experimental] The configurations read only property of the `web.usb.USBDevice` an `array` of device-specific interfaces for controlling a paired device. `var USBConfiguration[] = USBDevice.configurations` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/configurations`
(control-transfer-in this setup length)
Method.
[Experimental]
The controlTransferIn() method of the web.usb.USBDevice
interface
a promise
that resolves with a USBInTransferResult
when a
or status operation has been transmitted to the USB device.
var promise = USBDevice.controlTransferIn(setup, length)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/controlTransferIn
Method. [Experimental] The controlTransferIn() method of the `web.usb.USBDevice` interface a `promise` that resolves with a `USBInTransferResult` when a or status operation has been transmitted to the USB device. `var promise = USBDevice.controlTransferIn(setup, length)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/controlTransferIn`
(control-transfer-out this setup data)
Method.
[Experimental]
The controlTransferOut() method of the web.usb.USBDevice
interface
a promise
that resolves with a USBOutTransferResult
when
command or status operation has been transmitted from the USB
var promise = USBDevice.controlTransferOut(setup, data)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/controlTransferOut
Method. [Experimental] The controlTransferOut() method of the `web.usb.USBDevice` interface a `promise` that resolves with a `USBOutTransferResult` when command or status operation has been transmitted from the USB `var promise = USBDevice.controlTransferOut(setup, data)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/controlTransferOut`
(device-class this)
Property.
[Read Only] [Experimental]
The deviceClass read only property of the web.usb.USBDevice
one of three properties that identify USB devices for the purpose
loading a USB driver that will work with that device. The other
properties are USBDevice.deviceSubclass and USBDevice.deviceprotocol.
var number = USBDevice.deviceClass
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceClass
Property. [Read Only] [Experimental] The deviceClass read only property of the `web.usb.USBDevice` one of three properties that identify USB devices for the purpose loading a USB driver that will work with that device. The other properties are USBDevice.deviceSubclass and USBDevice.deviceprotocol. `var number = USBDevice.deviceClass` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceClass`
(device-protocol this)
Property.
[Read Only] [Experimental]
The deviceProtocol read only property of the web.usb.USBDevice
one of three properties that identify USB devices for the purpose
loading a USB driver that will work with that device. The other
properties are USBDevice.deviceClass and USBDevice.deviceSubclass.
var number = USBDevice.deviceProtocol
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceProtocol
Property. [Read Only] [Experimental] The deviceProtocol read only property of the `web.usb.USBDevice` one of three properties that identify USB devices for the purpose loading a USB driver that will work with that device. The other properties are USBDevice.deviceClass and USBDevice.deviceSubclass. `var number = USBDevice.deviceProtocol` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceProtocol`
(device-subclass this)
Property.
[Read Only] [Experimental]
The deviceSubclass read only property of the web.usb.USBDevice
one of three properties that identify USB devices for the purpose
loading a USB driver that will work with that device. The other
properties are USBDevice.deviceClass and USBDevice.deviceProtocol.
var serialNumber = USBDevice.deviceSubclass
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceSubclass
Property. [Read Only] [Experimental] The deviceSubclass read only property of the `web.usb.USBDevice` one of three properties that identify USB devices for the purpose loading a USB driver that will work with that device. The other properties are USBDevice.deviceClass and USBDevice.deviceProtocol. `var serialNumber = USBDevice.deviceSubclass` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceSubclass`
(device-version-major this)
Property.
[Read Only] [Experimental]
The deviceVersionMajor read only property of the web.usb.USBDevice
he major version number of the device in a semantic versioning
var serialNumber = USBDevice.deviceVersionMajor
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceVersionMajor
Property. [Read Only] [Experimental] The deviceVersionMajor read only property of the `web.usb.USBDevice` he major version number of the device in a semantic versioning `var serialNumber = USBDevice.deviceVersionMajor` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceVersionMajor`
(device-version-minor this)
Property.
[Read Only] [Experimental]
The deviceVersionMinor read only property of the web.usb.USBDevice
the minor version number of the device in a semantic versioning
var serialNumber = USBDevice.deviceVersionMinor
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceVersionMinor
Property. [Read Only] [Experimental] The deviceVersionMinor read only property of the `web.usb.USBDevice` the minor version number of the device in a semantic versioning `var serialNumber = USBDevice.deviceVersionMinor` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceVersionMinor`
(device-version-subminor this)
Property.
[Read Only] [Experimental]
The deviceVersionSubminor read only property of the web.usb.USBDevice
the patch version number of the device in a semantic versioning
var serialNumber = USBDevice.deviceVersionSubminor
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceVersionSubminor
Property. [Read Only] [Experimental] The deviceVersionSubminor read only property of the `web.usb.USBDevice` the patch version number of the device in a semantic versioning `var serialNumber = USBDevice.deviceVersionSubminor` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/deviceVersionSubminor`
(isochronous-transfer-in this endpoint-number packet-lengths)
Method.
[Experimental]
The isochronousTransferIn() method of the web.usb.USBDevice
returns a promise
that resolves with a USBIsochronousInTransferResult
time sensitive information has been transmitted to the USB device.
var promise = USBDevice.isochronousTransferIn(endpointNumber, packetLengths)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/isochronousTransferIn
Method. [Experimental] The isochronousTransferIn() method of the `web.usb.USBDevice` returns a `promise` that resolves with a `USBIsochronousInTransferResult` time sensitive information has been transmitted to the USB device. `var promise = USBDevice.isochronousTransferIn(endpointNumber, packetLengths)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/isochronousTransferIn`
(isochronous-transfer-out this endpoint-number data packet-lengths)
Method.
[Experimental]
The isochronousTransferOut() method of the web.usb.USBDevice
returns a promise
that resolves with a USBIsochronousOutTransferResult
time sensitive information has been transmitted from the USB
var promise = USBDevice.isochronousTransferOut(endpointNumber, data, packetLengths)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/isochronousTransferOut
Method. [Experimental] The isochronousTransferOut() method of the `web.usb.USBDevice` returns a `promise` that resolves with a `USBIsochronousOutTransferResult` time sensitive information has been transmitted from the USB `var promise = USBDevice.isochronousTransferOut(endpointNumber, data, packetLengths)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/isochronousTransferOut`
(manufacturer-name this)
Property.
[Read Only] [Experimental]
The manufacturerName read only property of the web.usb.USBDevice
the of the organization that manufactured the USB device.
var serialNumber = USBDevice.manufacturerName
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/manufacturerName
Property. [Read Only] [Experimental] The manufacturerName read only property of the `web.usb.USBDevice` the of the organization that manufactured the USB device. `var serialNumber = USBDevice.manufacturerName` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/manufacturerName`
(open this)
Method.
[Experimental]
The open() method of the web.usb.USBDevice
interface returns
promise
that resolves when a device session has started.
var promise = USBDevice.open()
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/open
Method. [Experimental] The open() method of the `web.usb.USBDevice` interface returns `promise` that resolves when a device session has started. `var promise = USBDevice.open()` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/open`
(opened this)
Property.
[Read Only] [Experimental]
The opened read only property of the web.usb.USBDevice
interface
whether a session has been started with a paired USB device.
device must be opened before it can conrolled by a web page.
var serialNumber = USBDevice.opened
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/opened
Property. [Read Only] [Experimental] The opened read only property of the `web.usb.USBDevice` interface whether a session has been started with a paired USB device. device must be opened before it can conrolled by a web page. `var serialNumber = USBDevice.opened` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/opened`
(product-id this)
Property.
[Read Only] [Experimental]
The productID read only property of the web.usb.USBDevice
interface
manufacturer-defined code that identifies a USB device.
var serialNumber = USBDevice.productID
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/productID
Property. [Read Only] [Experimental] The productID read only property of the `web.usb.USBDevice` interface manufacturer-defined code that identifies a USB device. `var serialNumber = USBDevice.productID` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/productID`
(product-name this)
Property.
[Read Only] [Experimental]
The productName read only property of the web.usb.USBDevice
the manufacturer-defined name that identifies a USB device.
var serialNumber = USBDevice.productName
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/productName
Property. [Read Only] [Experimental] The productName read only property of the `web.usb.USBDevice` the manufacturer-defined name that identifies a USB device. `var serialNumber = USBDevice.productName` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/productName`
(release-interface this interface-number)
Method.
[Experimental]
The releaseInterface() method of the web.usb.USBDevice
interface
a promise
that resolves when a cliamed interface is released
exclusive access.
var promise = USBDevice.releaseInterface(interfaceNumber)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/releaseInterface
Method. [Experimental] The releaseInterface() method of the `web.usb.USBDevice` interface a `promise` that resolves when a cliamed interface is released exclusive access. `var promise = USBDevice.releaseInterface(interfaceNumber)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/releaseInterface`
(reset this)
Method.
[Experimental]
The reset() method of the web.usb.USBDevice
interface eturns
promise
that resolves when the device is reset and all app
canceled and their promises rejected.
var promise = USBDevice.reset()
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/reset
Method. [Experimental] The reset() method of the `web.usb.USBDevice` interface eturns `promise` that resolves when the device is reset and all app canceled and their promises rejected. `var promise = USBDevice.reset()` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/reset`
(select-alternate-interface this inerface-number alternate-setting)
Method.
[Experimental]
The selectAlternateInterface() method of the web.usb.USBDevice
returns a promise
that resolves when the specified alternative
is selected.
var promise = USBDevice.selectAlternateInterface(inerfaceNumber, alternateSetting)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/selectAlternateInterface
Method. [Experimental] The selectAlternateInterface() method of the `web.usb.USBDevice` returns a `promise` that resolves when the specified alternative is selected. `var promise = USBDevice.selectAlternateInterface(inerfaceNumber, alternateSetting)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/selectAlternateInterface`
(select-configuration this configuration-value)
Method.
[Experimental]
The selectConfiguration() method of the web.usb.USBDevice
interface
a promise
that resolves when the specified configuration is
var promise = USBDevice.selectConfiguration(configurationValue)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/selectConfiguration
Method. [Experimental] The selectConfiguration() method of the `web.usb.USBDevice` interface a `promise` that resolves when the specified configuration is `var promise = USBDevice.selectConfiguration(configurationValue)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/selectConfiguration`
(serial-number this)
Property.
[Read Only] [Experimental]
The serialNumber read only property of the web.usb.USBDevice
is the manufacturer-defined serial number for the specific USB
var serialNumber = USBDevice.serialNumber
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/serialNumber
Property. [Read Only] [Experimental] The serialNumber read only property of the `web.usb.USBDevice` is the manufacturer-defined serial number for the specific USB `var serialNumber = USBDevice.serialNumber` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/serialNumber`
(transfer-in this endpoint-number length)
Method.
[Experimental]
The transferIn() method of the web.usb.USBDevice
interface
a promise
that resolves with a USBTransferInResult
when bulk
interrupt data is transmitted to the USB device.
var promise = USBDevice.transferIn(endpointNumber, length)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/transferIn
Method. [Experimental] The transferIn() method of the `web.usb.USBDevice` interface a `promise` that resolves with a `USBTransferInResult` when bulk interrupt data is transmitted to the USB device. `var promise = USBDevice.transferIn(endpointNumber, length)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/transferIn`
(transfer-out this endpoint-number data)
Method.
[Experimental]
The transferOut() method of the web.usb.USBDevice
interface
a promise
that resolves with a USBTransferOutResult
when
or interrupt data is transmitted from the USB device.
var promise = USBDevice.transferOut(endpointNumber, data)
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/transferOut
Method. [Experimental] The transferOut() method of the `web.usb.USBDevice` interface a `promise` that resolves with a `USBTransferOutResult` when or interrupt data is transmitted from the USB device. `var promise = USBDevice.transferOut(endpointNumber, data)` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/transferOut`
(usb-version-major this)
Property.
[Read Only] [Experimental]
The usbVersionMajor read only property of the web.usb.USBDevice
is one of three properties that declare the USB protocol version
by the device. The other two properties are USBDevice.usbVersionMinor
USBDevice.usbVersionSubminor.
var serialNumber = USBDevice.usbVersionMajor
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/usbVersionMajor
Property. [Read Only] [Experimental] The usbVersionMajor read only property of the `web.usb.USBDevice` is one of three properties that declare the USB protocol version by the device. The other two properties are USBDevice.usbVersionMinor USBDevice.usbVersionSubminor. `var serialNumber = USBDevice.usbVersionMajor` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/usbVersionMajor`
(usb-version-minor this)
Property.
[Read Only] [Experimental]
The usbVersionMinor read only property of the web.usb.USBDevice
is one of three properties that declare the USB protocol version
by the device. The other two properties are USBDevice.usbVersionMajor
USBDevice.usbVersionSubminor.
var serialNumber = USBDevice.usbVersionMinor
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/usbVersionMinor
Property. [Read Only] [Experimental] The usbVersionMinor read only property of the `web.usb.USBDevice` is one of three properties that declare the USB protocol version by the device. The other two properties are USBDevice.usbVersionMajor USBDevice.usbVersionSubminor. `var serialNumber = USBDevice.usbVersionMinor` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/usbVersionMinor`
(usb-version-subminor this)
Property.
[Read Only] [Experimental]
The usbVersionSubminor read only property of the web.usb.USBDevice
is one of three properties that declare the USB protocol version
by the device. The other two properties are USBDevice.usbVersionMajor
USBDevice.usbVersionMinor.
var serialNumber = USBDevice.usbVersionSubminor
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/usbVersionSubminor
Property. [Read Only] [Experimental] The usbVersionSubminor read only property of the `web.usb.USBDevice` is one of three properties that declare the USB protocol version by the device. The other two properties are USBDevice.usbVersionMajor USBDevice.usbVersionMinor. `var serialNumber = USBDevice.usbVersionSubminor` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/usbVersionSubminor`
(vendor-id this)
Property.
[Read Only] [Experimental]
The vendorID read only property of the web.usb.USBDevice
interface
the official usg.org-assigned vendor ID.
var serialNumber = USBDevice.vendorID
See also: https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/vendorID
Property. [Read Only] [Experimental] The vendorID read only property of the `web.usb.USBDevice` interface the official usg.org-assigned vendor ID. `var serialNumber = USBDevice.vendorID` See also: `https://developer.mozilla.org/en-US/docs/Web/API/USBDevice/vendorID`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close