Module @novastar/serial

Index

Classes

SerialBinding

Interfaces

SerialBindingEvents

Type aliases

Variables

serial

Functions

Type aliases

KnownDevice

KnownDevice: [vendorId: string, productId: string]

SerialSession

SerialSession: Session<SerialPort> & API

Serial Session type

Variables

Const serial

serial: SerialBinding = ...

Binding to work with serial devices

Functions

addKnownDevice

addKnownDevice(vendorId: string | number, productId: string | number): readonly KnownDevice[]

- Defined in packages/serial/src/serial.ts:45
Add a new known device type

Parameters
- vendorId: string | number
- productId: string | number
Returns readonly KnownDevice[]

clearKnownDevices

clearKnownDevices(): void

- Defined in packages/serial/src/serial.ts:79
Clear all known devices

Returns void

findSendingCards

findSendingCards(known?: readonly KnownDevice[]): Promise<PortInfo[]>

- Defined in packages/serial/src/serial.ts:113
Finding serial devices

Parameters
- known: readonly KnownDevice[] = []
Returns Promise<PortInfo[]>
- paths to found devices

getKnownDevices

getKnownDevices(): readonly KnownDevice[]

- Defined in packages/serial/src/serial.ts:32
Get all known devices

Returns readonly KnownDevice[]

removeKnownDevice

removeKnownDevice(vendorId: string | number, productId: string | number): readonly KnownDevice[]

- Defined in packages/serial/src/serial.ts:63
Remove known device by VID,PID

Parameters
- vendorId: string | number
- productId: string | number
Returns readonly KnownDevice[]

Generated using TypeDoc