@orchestra-platform/serial-port v0.1.5

Table of Contents

• utils
  • wait
  • byteArrayToString
  • log
  • numberToByteArray
  • byteArrayToNumber
• SerialPortHelper
  • removeFromBuffer
  • writeBytes
  • sendMessage
  • subscribe
  • readMessage
  • close

utils

wait

Parameters

• millis number milliseconds

byteArrayToString

Converts a byte array to string

Parameters

• byteArray Array

Returns String

log

Prints a byte array as hex values

Parameters

• byteArray Array
• text String

numberToByteArray

Converts a number to a byte array

Parameters

• n Number Number to convert
• length Number Length of the array

byteArrayToNumber

Converts a byte array to a number

Parameters

• bytes Array

SerialPortHelper

Parameters

• options Object
  • options.path string The system path of the serial port you want to open. For example, /dev/tty.XXX on Mac/Linux, or COM1 on Windows.
  • options.baudRate number The baud rate of the port to be opened. (optional, default 9600)
  • options.stopBits number Must be one of these: 1 or 2. (optional, default 1)
  • options.parity string Must be one of these: 'none', 'even', 'mark', 'odd', 'space'. (optional, default none)
  • options.dataBits number Must be one of these: 8, 7, 6, or 5. (optional, default 8)
  • options.readMessageTimeout number Time (in milliseconds) after which readMessage will throw an error if no data is received (optional, default 60000)
  • options.messages Object
  • options.logLevel number

Properties

• readMessageTimeout number Time (in milliseconds) after which readMessage will throw an error if no data is received

removeFromBuffer

Removes N bytes from the buffer

Parameters

• n Number Number of bytes to be removed. With n=-1 it emptys the buffer

writeBytes

Send a Buffer or an array of bytes on the serial port

Parameters

• data Buffer/Array Buffer or array of bytes

sendMessage

Generate a message

Parameters

• message String
• data Object (optional, default {})

Returns Array Array of bytes

subscribe

Subscribe to a message

Parameters

• options

readMessage

Read a message from the serialport

Parameters

• msg string Message

Returns Promise Promise

close

Close the serial port connection