Serial: requestPort() Methode

Wenn der Benutzer eine Seite erstmals besucht, hat diese keine Berechtigung auf serielle Geräte zuzugreifen. Eine Seite muss zuerst requestPort() aufrufen, um den Benutzer aufzufordern, das Gerät auszuwählen, das die Seite steuern dürfen soll.

Diese Methode muss via transiente Aktivierung aufgerufen werden. Der Benutzer muss mit der Seite oder einem UI-Element interagieren, damit diese Funktion aktiviert wird.

options Optional

Ein Objekt mit den folgenden Eigenschaften:

filters Optional

Eine Liste von Objekten, die Anbieter-, Produkt- oder Bluetooth-Dienstklassen-IDs enthalten, die verwendet werden, um die spezifischen Gerätetypen zu filtern, die dem Benutzer zur Auswahl einer Verbindung bereitgestellt werden dürfen. Wenn keine Filter angegeben sind, erhält der Benutzer eine Liste aller verfügbaren Geräte zur Auswahl. Filter können die folgenden Werte enthalten:

bluetoothServiceClassId Optional

Eine nicht-signierte lange Ganzzahl oder Zeichenkette, die eine Bluetooth-Dienstklassen-ID darstellt. Dies kann ein 16- oder 32-Bit-UUID-Alias, eine gültige UUID oder ein gültiger Name aus einem GATT zugewiesenen Schlüsseldienst sein.

usbVendorId Optional

Eine nicht-signierte kurze Ganzzahl, die einen USB-Geräteanbieter identifiziert. Das USB Implementors Forum weist IDs für spezifische Anbieter zu.

usbProductId Optional

Eine nicht-signierte kurze Ganzzahl, die ein USB-Gerät identifiziert. Jeder Anbieter weist IDs für seine Produkte zu.

allowedBluetoothServiceClassIds Optional

Eine Liste von nicht-signierten langen Ganzzahlen und/oder Zeichenketten, die Bluetooth-Dienstklassen-IDs darstellen. Bluetooth-Ports mit benutzerdefinierten Dienstklassen-IDs sind von der Liste der dem Benutzer präsentierten Ports ausgeschlossen, es sei denn, die Dienstklassen-ID ist in dieser Liste enthalten. Dies gilt unabhängig davon, ob die Liste gefiltert wird oder nicht.

Ein Promise, das mit einer Instanz von SerialPort aufgelöst wird.

SecurityError DOMException

Das zurückgegebene Promise wird mit diesem Fehler in einem der folgenden Fälle abgelehnt:

• Eine serial Berechtigungsrichtlinie blockiert die Nutzung dieser Funktion.
• Eine Benutzerberechtigungsabfrage wurde abgelehnt.

NotFoundError DOMException

Das zurückgegebene Promise wird mit dieser Ausnahme abgelehnt, wenn der Benutzer bei der Aufforderung keinen Port auswählt.

Dieses Beispiel fordert den Benutzer auf, ein Gerät über requestPort() auszuwählen, wenn ein <button> gedrückt wird. Es enthält keinen Filter, was bedeutet, dass die Auswahl alle verfügbaren Geräte umfasst:

<button id="connect">Connect</button>

const connectBtn = document.getElementById("connect");
connectBtn.addEventListener("click", () => {
  try {
    const port = await navigator.serial.requestPort();
    // Connect to port or add it to the list of available ports
  } catch (e) {
    // The user didn't select a device
  }
});

In diesem Fall wird ein Filter mit einer USB-Anbieter-ID an requestPort() übergeben, um die Auswahl der dem Benutzer angezeigten Geräte auf nur USB-Geräte eines bestimmten Herstellers zu beschränken.

connectBtn.addEventListener("click", () => {
  const usbVendorId = 0xabcd;
  try {
    const port = await navigator.serial.requestPort({ filters: [{ usbVendorId }] });
    // Connect to port or add it to the list of available ports
  } catch (e) {
    // The user didn't select a device
  }
});

Obwohl die meisten Geräte SPP-basierte Kommunikation durch das standardisierte Bluetooth Classic Serial Port Profile bereitstellen, verwenden einige benutzerdefinierte RFCOMM-basierte Dienste. Diese Geräte haben eine Dienstklassen-ID, die nicht im Standard-Bluetooth-UUID-Bereich liegt.

Sie müssen die Liste allowedBluetoothServiceClassIds an requestPort() übergeben, um auf diese benutzerdefinierten RFCOMM-basierten Dienste zuzugreifen:

const myBluetoothServiceUuid = "01234567-89ab-cdef-0123-456789abcdef";

// Prompt user to select any serial port
// Access to the custom Bluetooth RFCOMM service above will be allowed
const port = await navigator.serial.requestPort({
  allowedBluetoothServiceClassIds: [myBluetoothServiceUuid],
});

Sie können auch den bluetoothServiceClassId Filterkey verwenden, wenn Sie requestPort() aufrufen, um dem Benutzer eine Liste gefilterter Bluetooth-Serienports anzuzeigen, die durch Dienstklassen-IDs identifiziert werden:

const myBluetoothServiceUuid = "01234567-89ab-cdef-0123-456789abcdef";

// Prompt the user to select Bluetooth serial ports with
// the custom Bluetooth RFCOMM service above.
const port = await navigator.serial.requestPort({
  allowedBluetoothServiceClassIds: [myBluetoothServiceUuid],
  filters: [{ bluetoothServiceClassId: myBluetoothServiceUuid }],
});