Class SerialPort<T>

Type Parameters

T extends AutoDetectTypes = AutoDetectTypes

Hierarchy

SerialPortStream<T>
- SerialPort

Index

Constructors

Properties

Methods

asyncClose asyncFlush asyncFlushAndClose asyncGet asyncOpen asyncSet

Constructors

constructor

new SerialPort<T extends AutoDetectTypes = AutoDetectTypes>(
options: SerialPortOpenOptions<T>,
openCallback?: ErrorCallback,
): SerialPort<T>
Type Parameters
- T extends AutoDetectTypes = AutoDetectTypes
Parameters
- options: SerialPortOpenOptions<T>
- OptionalopenCallback: ErrorCallback
Returns SerialPort<T>
Overrides SerialPortStream<T>.constructor
- Defined in src/adapter/serialPort.ts:15

Properties

`Static` `Readonly`binding

binding: AutoDetectTypes = DetectedBinding

`Static`list

list: () => Promise<PortInfo[]> = DetectedBinding.list

Type declaration

- (): Promise<PortInfo[]>
- Retrieves a list of available serial ports with metadata. The path must be guaranteed, and all other fields should be undefined if unavailable. The path is either the path or an identifier (eg COM1) used to open the serialport.
  
  Returns Promise<PortInfo[]>

Methods

asyncClose

asyncClose(): Promise<void>
Returns Promise<void>
- Defined in src/adapter/serialPort.ts:29

asyncFlush

asyncFlush(): Promise<void>
Returns Promise<void>
- Defined in src/adapter/serialPort.ts:35

asyncFlushAndClose

asyncFlushAndClose(): Promise<void>
Returns Promise<void>
- Defined in src/adapter/serialPort.ts:41

asyncGet

asyncGet(): Promise<{ cts: boolean; dcd: boolean; dsr: boolean }>
Returns Promise<{ cts: boolean; dcd: boolean; dsr: boolean }>
- Defined in src/adapter/serialPort.ts:46

asyncOpen

asyncOpen(): Promise<void>
Returns Promise<void>
- Defined in src/adapter/serialPort.ts:23

asyncSet

asyncSet(options: SetOptions): Promise<void>
Parameters
- options: SetOptions
Returns Promise<void>
- Defined in src/adapter/serialPort.ts:52