SerialPort | SiteKiosk Online API

Index

Properties

config lastData name state type

Accessors

readTimeout writeTimeout

Methods

discardInBuffer discardOutBuffer readBytes readBytesAsync readLine readLineAsync readText readTextAsync ready start stop writeBytes writeLine writeText

Events

onData onError onStateChanged

Properties

config

config: any

The device config.

lastData

lastData: undefined | SerialPortSensorData

Returns the last data which was generated by the sensor.

name

name: string

The name of the device.

state

state: DeviceState

The device state.

type

type: string

The type of the device.

Accessors

readTimeout

get readTimeout(): number
Returns number
set readTimeout(value: number): void
Parameters
- value: number
Returns void

writeTimeout

get writeTimeout(): number
Returns number
set writeTimeout(value: number): void
Parameters
- value: number
Returns void

Methods

discardInBuffer

discardInBuffer(): void
Discards the input buffer.

Returns void

discardOutBuffer

discardOutBuffer(): void
Discards the output buffer.

Returns void

readBytes

readBytes(count: number): Uint8Array
Reads the next count bytes from the port and returns the result as an array. It is possibly that this call will return less than the provided count of bytes.
Parameters
- count: number
Returns Uint8Array

readBytesAsync

readBytesAsync(count: number): Promise<Uint8Array>
Reads the next count bytes from the port and returns the result as an array. It is possibly that this call will return less than the provided count of bytes. Does not block the execution.
Parameters
- count: number
Returns Promise<Uint8Array>

readLine

readLine(): string
Reads the line from the port and returns the result as string.

Returns string

readLineAsync

readLineAsync(): Promise<string>
Reads the line from the port and returns the result as string. Does not block the execution.

Returns Promise<string>

readText

readText(count: number): string
Reads the next count bytes from the port and returns the result as string. It is possibly that this call will return less than the provided count of bytes.
Parameters
- count: number
Returns string

readTextAsync

readTextAsync(count: number): Promise<string>
Reads the next count bytes from the port and returns the result as string. It is possibly that this call will return less than the provided count of bytes. Does not block the execution.
Parameters
- count: number
Returns Promise<string>

ready

ready(): Promise<any>
Returns a promise which is fulfilled when the device is started.

Returns Promise<any>

Inherited from Sensor.ready

start

start(): Promise<any>
Starts the device when needed and returns a promise which is fulfilled when the device is started.

Returns Promise<any>

Inherited from Sensor.start

stop

stop(): Promise<any>
Stops the device.

Returns Promise<any>

Inherited from Sensor.stop

writeBytes

writeBytes(data: Uint8Array): void
Writes the data into the port.
Parameters
- data: Uint8Array
Returns void

writeLine

writeLine(data: string): void
Writes the data and new line symbols into the port.
Parameters
- data: string
Returns void

writeText

writeText(data: string): void
Writes the data into the port.
Parameters
- data: string
Returns void

Events

onData

onData(callback: ((data: SerialPortSensorData) => void)): EventSubscription
Registers a callback which will be triggered when a sensors value has changed.
Parameters
- callback: ((data: SerialPortSensorData) => void)
  
  The callback which will be called once the sensor has generated new data.
  - - (data: SerialPortSensorData): void
    - Parameters
      
      data: SerialPortSensorData
      
      Returns void
Returns EventSubscription

Inherited from Sensor.onData

onError

onError(callback: ((error: Error) => void)): EventSubscription
Registers a callback which will be triggered when the device encounters an error.
Parameters
- callback: ((error: Error) => void)
  
  The callback which will be called once the device encountered an error.
  - - (error: Error): void
    - Parameters
      
      error: Error
      
      Returns void
Returns EventSubscription

Inherited from Sensor.onError

onStateChanged

onStateChanged(callback: ((state: DeviceState) => void)): EventSubscription
Registers a callback which will be triggered when the device state changes.
Parameters
- callback: ((state: DeviceState) => void)
  
  The callback which will be called once the device changes its state.
  - - (state: DeviceState): void
    - Parameters
      
      state: DeviceState
      
      Returns void
Returns EventSubscription

Inherited from Sensor.onStateChanged

Generated using TypeDoc