SerialTransport

Defined in: packages/transports/src/serial.ts:35

Transport over USB serial with the '<' / '>' framing. Needs serialport installed.

Extends

• TypedEmitter<TransportEvents>

Implements

• Transport

Constructors

Constructor

new SerialTransport(options, deps?): SerialTransport;

Defined in: packages/transports/src/serial.ts:47

Parameters

options

SerialTransportOptions

path and baudRate. Default 115200

deps?

SerialTransportDeps = {}

Test seam replacing the serialport import

Returns

SerialTransport

Overrides

TypedEmitter.constructor

Properties

baudRate

readonly baudRate: number;

Defined in: packages/transports/src/serial.ts:38

kind

readonly kind: "serial" = 'serial';

Defined in: packages/transports/src/serial.ts:36

Implementation of

Transport.kind

path

readonly path: string;

Defined in: packages/transports/src/serial.ts:37

Accessors

connected

Get Signature

get connected(): boolean;

Defined in: packages/transports/src/serial.ts:54

Returns

boolean

Implementation of

Transport.connected

Methods

close()

close(): Promise<void>;

Defined in: packages/transports/src/serial.ts:108

Returns

Promise<void>

Implementation of

Transport.close

connect()

connect(signal?): Promise<void>;

Defined in: packages/transports/src/serial.ts:59

Parameters

signal?

AbortSignal

Aborts the connection attempt

Returns

Promise<void>

Implementation of

Transport.connect

emit()

emit<K>(event, ...args): boolean;

Defined in: packages/transports/src/typed-emitter.ts:44

Type Parameters

K

K extends string

Parameters

event

K

Event name

args

...TransportEvents[K]

Event arguments

Returns

boolean

Implementation of

Transport.emit

Inherited from

TypedEmitter.emit

listenerCount()

listenerCount<K>(event): number;

Defined in: packages/transports/src/typed-emitter.ts:49

Type Parameters

K

K extends string

Parameters

event

K

Event name

Returns

number

Implementation of

Transport.listenerCount

Inherited from

TypedEmitter.listenerCount

off()

off<K>(event, listener): this;

Defined in: packages/transports/src/typed-emitter.ts:35

Type Parameters

K

K extends string

Parameters

event

K

Event name

listener

Listener<TransportEvents[K]>

Listener to remove

Returns

this

Implementation of

Transport.off

Inherited from

TypedEmitter.off

on()

on<K>(event, listener): this;

Defined in: packages/transports/src/typed-emitter.ts:17

Type Parameters

K

K extends string

Parameters

event

K

Event name

listener

Listener<TransportEvents[K]>

Called with the event arguments

Returns

this

Implementation of

Transport.on

Inherited from

TypedEmitter.on

once()

once<K>(event, listener): this;

Defined in: packages/transports/src/typed-emitter.ts:26

Type Parameters

K

K extends string

Parameters

event

K

Event name

listener

Listener<TransportEvents[K]>

Called once with the event arguments

Returns

this

Implementation of

Transport.once

Inherited from

TypedEmitter.once

removeAllListeners()

removeAllListeners<K>(event?): this;

Defined in: packages/transports/src/typed-emitter.ts:54

Type Parameters

K

K extends string

Parameters

event?

K

Event name, or every event when omitted

Returns

this

Implementation of

Transport.removeAllListeners

Inherited from

TypedEmitter.removeAllListeners

write()

write(payload): Promise<void>;

Defined in: packages/transports/src/serial.ts:96

Parameters

payload

Uint8Array

Frame payload without framing

Returns

Promise<void>

Implementation of

Transport.write