Class SerialComm

It represents a serial port resource at the client side.

Hierarchy

SerialComm

Index

Constructors

constructor

Properties

SERIAL_TIMEOUT

Accessors

Methods

Constructors

constructor

new SerialComm(portName: string, baudRate: number, parity: Parity, stopBits: StopBits, dataBits: DataBits, flowControl: Handshake): SerialComm

- Defined in SerialComm.ts:160
Creates an instance of the SerialComm class wiht the specified information.

Parameters
- portName: string
  
  The serial port name, for example COM1.
- baudRate: number
  
  The serial port baud rate in bits per second.
- parity: Parity
  
  The serial port parity-checking protocol.
- stopBits: StopBits
  
  The serial port standard number of stopbits per byte.
- dataBits: DataBits
  
  The serial port standard length of data bits per byte.
- flowControl: Handshake
  
  The handshaking protocol for serial port transmission of data.
Returns SerialComm

Properties

SERIAL_TIMEOUT

SERIAL_TIMEOUT: number = 5000

Accessors

baudRate

get baudRate(): number
set baudRate(value: number): void

- Defined in SerialComm.ts:39
Gets or sets the serial port baud rate in bits per second. Default value is 9600

Returns number
- Defined in SerialComm.ts:42
Gets or sets the serial port baud rate in bits per second. Default value is 9600

Parameters
- value: number
Returns void

cts

get cts(): Promise<boolean>

- Defined in SerialComm.ts:111
Gets the state of the Clear-to-Send line. true if the Clear-to-Send line is detected; otherwise, false.

Returns Promise<boolean>

dataBits

get dataBits(): DataBits
set dataBits(value: DataBits): void

- Defined in SerialComm.ts:70
Gets or sets the serial port standard length of data bits per byte. Default value is Serial.DataBits.Eight

Returns DataBits
- Defined in SerialComm.ts:73
Gets or sets the serial port standard length of data bits per byte. Default value is Serial.DataBits.Eight

Parameters
- value: DataBits
Returns void

dsr

get dsr(): Promise<boolean>

- Defined in SerialComm.ts:90
Gets the state of the Data Set Ready (DSR) signal. true if a Data Set Ready signal has been sent to the port; otherwise, false.

Returns Promise<boolean>

dtr

set dtr(value: boolean): void

- Defined in SerialComm.ts:144
Sets a value that enables the Data Terminal Ready (DTR) signal.

Parameters
- value: boolean
Returns void

flowControl

get flowControl(): Handshake
set flowControl(value: Handshake): void

- Defined in SerialComm.ts:80
Gets or sets the handshaking protocol for serial port transmission of data. Default value is Serial.Handshake.XOnXOff

Returns Handshake
- Defined in SerialComm.ts:83
Gets or sets the handshaking protocol for serial port transmission of data. Default value is Serial.Handshake.XOnXOff

Parameters
- value: Handshake
Returns void

isOpen

get isOpen(): Boolean

- Defined in SerialComm.ts:32
Gets whether the port is open.

Returns Boolean

parity

get parity(): Parity
set parity(value: Parity): void

- Defined in SerialComm.ts:49
Gets or sets the serial port parity-checking protocol. Default value is Serial.Parity.None

Returns Parity
- Defined in SerialComm.ts:52
Gets or sets the serial port parity-checking protocol. Default value is Serial.Parity.None

Parameters
- value: Parity
Returns void

portName

get portName(): string
set portName(value: string): void

- Defined in SerialComm.ts:22
Gets or sets the serial port name, for example COM1. Default value is "COM1"

Returns string
- Defined in SerialComm.ts:25
Gets or sets the serial port name, for example COM1. Default value is "COM1"

Parameters
- value: string
Returns void

rts

set rts(value: boolean): void

- Defined in SerialComm.ts:132
Sets a value that enables the Request to Send (RTS) signal.

Parameters
- value: boolean
Returns void

stopBits

get stopBits(): StopBits
set stopBits(value: StopBits): void

- Defined in SerialComm.ts:60
Gets or sets the serial port standard number of stopbits per byte. Default value is Serial.StopBits.One

Returns StopBits
- Defined in SerialComm.ts:63
Gets or sets the serial port standard number of stopbits per byte. Default value is Serial.StopBits.One

Parameters
- value: StopBits
Returns void

Methods

close

close(): void

- Defined in SerialComm.ts:258
Closes the port connection

Returns void

onClose

onClose(data: any): void

- Defined in SerialComm.ts:202
Occurs when communication is close.

Parameters
- data: any
  
  The callback function
Returns void

onDataReceived

onDataReceived(data: any): void

- Defined in SerialComm.ts:184
Occurs when data is received.

Parameters
- data: any
  
  The callback function
Returns void

onError

onError(data: any, critical: any): void

- Defined in SerialComm.ts:178
Occurs when an error is thrown.

Parameters
- data: any
  
  The callback function
- critical: any
Returns void

open

open(): Promise<unknown>

- Defined in SerialComm.ts:207
Opens a new serial port connection

Returns Promise<unknown>

propertiesJSON

propertiesJSON(): { type: string }

- Defined in SerialComm.ts:263
Returns { type: string }
- type: string

send

send(utf8string: string): void

- Defined in SerialComm.ts:250
Sends the specified string to the serial port.

Parameters
- utf8string: string
  
  The string to send to the serial port.
Returns void