Skip to content

ElectronSerialPort

Unofficial

A serial port available for selection via the Web Serial API.

Import:

import type { ElectronSerialPort } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface ElectronSerialPort

Properties

Property Type Description
deviceInstanceId? string A stable identifier on Windows that can be used for device permissions.
displayName string A string suitable for display to the user for describing this device.
portId string Unique identifier for the port.
portName string Name of the port.
productId string Optional USB product ID.
serialNumber string The USB device serial number.
usbDriverName? string Represents a single serial port on macOS that can be enumerated by multiple drivers.
vendorId string Optional USB vendor ID.

Links to this page: