HID: requestDevice() Methode

options

Ein Objekt, das ein Array von Filterobjekten für mögliche Geräte enthält, mit denen verbunden werden kann. Jedes Filterobjekt kann die folgenden Eigenschaften haben:

vendorId Optional

Eine Ganzzahl, die die vendorId des angeforderten HID-Geräts darstellt.

productId Optional

Eine Ganzzahl, die die productId des angeforderten HID-Geräts darstellt.

usagePage Optional

Eine Ganzzahl, die die Usage Page-Komponente der HID-Nutzung des angeforderten Geräts darstellt. Die Nutzung für eine oberste Sammlungsebene wird verwendet, um den Gerätetyp zu identifizieren.

Standard-HID-Verwendungswerte sind im Dokument HID Usage Tables zu finden.

usage Optional

Eine Ganzzahl, die die Usage ID-Komponente der HID-Nutzung des angeforderten Geräts darstellt.

Ein Promise, der mit einem Array von verbundenen HIDDevice Objekten aufgelöst wird, die den übergebenen Filtern entsprechen.

SecurityError DOMException

Wird ausgelöst, wenn die Seite keinen Zugriff auf die HID-Funktion erlaubt.

Transiente Benutzeraktivierung ist erforderlich. Der Benutzer muss mit der Seite oder einem UI-Element interagieren, damit diese Funktion funktioniert.

Im folgenden Beispiel wird ein HID-Gerät angefordert, das eine Hersteller-ID von 0xABCD, eine Produkt-ID von 0x1234, eine Usage Page von 0x0C und eine Usage ID von 0x01 hat. Es werden nur Geräte angezeigt, die alle diese Regeln erfüllen.

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}`);
  }
});

Dieses nächste Beispiel enthält zwei Filter. Geräte werden angezeigt, wenn sie einem dieser Filter entsprechen.

// 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 });