Serial.requestPort()

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

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The Serial.requestPort() method of the Serial interface returns a Promise that resolves with an instance of SerialPort representing the device chosen by the user or rejects if no device was selected.

Syntax

requestPort()
requestPort(options)

Parameters

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.

Return value

A Promise that resolves with an instance of SerialPort.

Exceptions

SecurityError DOMException

The returned Promise rejects with this error if a Feature Policy restricts use of this API or a permission to use it has not granted via a user gesture.

AbortError DOMException

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

Examples

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

Specifications

Specification
Web Serial API
# dom-serial-requestport

Browser compatibility

BCD tables only load in the browser