Class SerialPortCommunicator

Represents a communicator using the SerialPort library for communication with hardware devices.

Implements

Communicator

Index

Constructors

Accessors

deviceIndentifier isConnected

Methods

connect disconnect setOnResiveFunc write listDevices

Constructors

constructor

new SerialPortCommunicator(device, options?): SerialPortCommunicator
Parameters
- device: string
- options: Partial<SerialPortOptions> = {}
Returns SerialPortCommunicator
- Defined in Communicators/SerialPortCommunicator.ts:13

Accessors

deviceIndentifier

get deviceIndentifier(): string
Gets the identifier for the communication device.

Returns string
The device identifier.
Implementation of Communicator.deviceIndentifier
- Defined in Communicators/SerialPortCommunicator.ts:50

isConnected

get isConnected(): boolean
Checks if the communication device is currently connected.

Returns boolean
True if the device is connected, otherwise false.
Implementation of Communicator.isConnected
- Defined in Communicators/SerialPortCommunicator.ts:59

Methods

connect

connect(): Promise<void>
Connects to the serial port device.

Returns Promise<void>
Implementation of Communicator.connect
- Defined in Communicators/SerialPortCommunicator.ts:72

disconnect

disconnect(): Promise<void>
Disconnects from the serial port device.

Returns Promise<void>
Implementation of Communicator.disconnect
- Defined in Communicators/SerialPortCommunicator.ts:87

setOnResiveFunc

setOnResiveFunc(func): Promise<void>
Sets a callback function to handle incoming data from the serial port.
Parameters
- func: ((data) => void)
  The function to be called with received data.
  - - (data): void
    - Parameters
      data: string
      Returns void
Returns Promise<void>
Implementation of Communicator.setOnResiveFunc
- Defined in Communicators/SerialPortCommunicator.ts:104

write

write(data): Promise<void>
Writes data to the serial port.
Parameters
- data: string
  The data to be written.
Returns Promise<void>
Implementation of Communicator.write
- Defined in Communicators/SerialPortCommunicator.ts:113

`Static` listDevices

listDevices(): Promise<PortInfo[]>
Retrieves a list of available serial ports.

Returns Promise<PortInfo[]>
A promise resolving to an array of available serial ports.

See
https://serialport.io/docs/api-bindings-cpp#list
- Defined in Communicators/SerialPortCommunicator.ts:123

Generated using TypeDoc