Serial: requestPort() method

options

An object with the following properties:

filters

A list of objects containing vendor and product IDs used to search for attached devices. The USB Implementors Forum assigns IDs to specific companies. Each company assigns IDs to its products. Filters contain the following values:

usbVendorId

An unsigned short integer that identifies a USB device vendor.

usbProductId

An unsigned short integer that identifies a USB device.

A Promise that resolves with an instance of SerialPort.

SecurityError DOMException

The returned Promise rejects with this error if a Permissions Policy blocks the use of this feature or a user permission prompt was denied.

NotFoundError DOMException

The returned Promise rejects with this if the user does not select a port when prompted.

Transient activation is required. The user has to interact with the page or a UI element in order for this feature to work.

The following example shows a filter being passed to requestPort() with a USB vendor ID in order to limit the set of devices shown to the user to only USB devices built by a particular manufacturer. If this filter was omitted the user would be able to select any available port.

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