HID.requestDevice()

The requestDevice() method of the HID interface requests access to a HID device.

The user agent will present a permission dialog including a list of connected devices, and ask the user to select and grant permission to one of these devices.

options

An object containing an array of filter objects for possible devices to pair with. Each filter object can have the following properties:

vendorId Optional

An integer representing the vendorId of the requested HID device

productId Optional

An integer representing the productId of the requested HID device.

usagePage Optional

An integer representing the usage page component of the HID usage of the requested device. The usage for a top level collection is used to identify the device type.

Standard HID usage values can be found in the HID Usage Tables document

usage Optional

An integer representing the usage ID component of the HID usage of the requested device.

A Promise that resolves with an array of connected HIDDevice objects that match the filters passed in.

DOMException SecurityError

Thrown if the page does not allow access to the HID feature.

In the following example a HID device is requested that has a vendor ID of 0xABCD, product ID of 0x1234, usage page 0x0C and usage ID 0x01. Only devices that match all of these rules will be shown.

let requestButton = document.getElementById("request-hid-device");
  requestButton.addEventListener("click", async () => {
    let device;
    try {
      const devices = await navigator.hid.requestDevice({
        filters: [
          {
            vendorId: 0xabcd,
            productId: 0x1234,
            usagePage: 0x0c,
            usage: 0x01,
          },
        ],
      });
      device = devices[0];
    } catch (error) {
      console.log("An error occurred.");
    }

    if (!device) {
      console.log("No device was selected.");
    } else {
      console.log(`HID: ${device.productName}`);
    }
  });

This next example includes two filters. Devices will be shown if they match either of these filters.

// Filter on devices with the Nintendo Switch Joy-Con USB Vendor/Product IDs.
  const filters = [
    {
      vendorId: 0x057e, // Nintendo Co., Ltd
      productId: 0x2006 // Joy-Con Left
    },
    {
      vendorId: 0x057e, // Nintendo Co., Ltd
      productId: 0x2007 // Joy-Con Right
    }
  ];

  // Prompt user to select a Joy-Con device.
  const [device] = await navigator.hid.requestDevice({ filters });