HIDDevice.open()

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

The open() method of the HIDDevice interface requests that the operating sytem opens the HID device.

Note: HID devices are not opened automatically. Therefore, a HIDDevice returned by HID.getRequestDevice() must be opened with this method before it is available to transfer data.

Syntax

HIDDevice.open();

Parameters

None.

Return value

A Promise that resolves with undefined once the connection is opened.

Exceptions

DOMException InvalidStateError

Thrown if the connection is already open.

DOMException NotAllowedError

Thrown if the attempt to open the connection fails for any reason.

Examples

In the following example, we wait for the HID connection to open before attempting to send or receive data.

await device.open();

Specifications

Specification
WebHID API
# dom-hiddevice-open

Browser compatibility

BCD tables only load in the browser