probe-web / @probe-web/serial / SerialPortLike

Interface: SerialPortLike

Defined in: index.ts:28

The subset of the WebSerial API this package uses (no @types dependency).

Properties

Property	Modifier	Type	Description	Defined in
readable	readonly	ReadableStream<Uint8Array<ArrayBufferLike>> | null	Incoming bytes while open; null when closed or after a fatal error.	index.ts:30
writable	readonly	WritableStream<Uint8Array<ArrayBufferLike>> | null	Outgoing bytes while open; null when closed.	index.ts:32

Methods

open()

open(options): Promise<void>;

Defined in: index.ts:34

Open the port with these line settings.

Parameters

Parameter	Type
options	SerialOpenOptions

Returns

Promise<void>

---

close()

close(): Promise<void>;

Defined in: index.ts:36

Close the port.

Returns

Promise<void>

---

setSignals()?

optional setSignals(signals): Promise<void>;

Defined in: index.ts:38

Set control lines (DTR, RTS) or send a break.

Parameters

Parameter	Type
signals	{ dataTerminalReady?: boolean; requestToSend?: boolean; break?: boolean; }
signals.dataTerminalReady?	boolean
signals.requestToSend?	boolean
signals.break?	boolean

Returns

Promise<void>

---

getInfo()?

optional getInfo(): {
  usbVendorId?: number;
  usbProductId?: number;
};

Defined in: index.ts:40

USB ids of the bridge, when it is a USB device.

Returns

{
  usbVendorId?: number;
  usbProductId?: number;
}

Name	Type	Defined in
usbVendorId?	number	index.ts:40
usbProductId?	number	index.ts:40

---

addEventListener()?

optional addEventListener(type, listener): void;

Defined in: index.ts:42

Fires disconnect when the device is unplugged.

Parameters

Parameter	Type
type	"disconnect"
listener	() => void

Returns

void