@orchestra-platform/byte-message-parser

Table of Contents

• MessagesManager
  • Parameters
  • _messages
  • getMessage
    • Parameters
  • getMessages
    • Parameters
  • recognizeMessage
    • Parameters
• Buffer
  • Parameters
  • Properties
  • handleData
    • Parameters
  • _removeFromByteBuffer
    • Parameters
  • subscribe
    • Parameters
  • readMessage
    • Parameters
• MessageFragment
  • Properties
• Message
  • Parameters
  • Properties
  • name
  • fragments
  • getPattern
  • generateBytes
    • Parameters

MessagesManager

Parameters

• messages Array<Message>

_messages

Type: Array<Message>

getMessage

Parameters

• name String Message name

getMessages

Parameters

• names Array<String> Array of message names

recognizeMessage

Recognize a message from an array of bytes

Parameters

• bytes Array
• messages Array<Message>

Returns Boolean Returns false if no message is found

Returns Object Returns an Object {type,bytes,values} if a message is found

Buffer

Parameters

• options Object
  • options.isMessageStart Object
  • options.recognizeMessage Object Function that recognize a message from an array of bytes, it must return false or an Object with a property 'type'
• readMessageTimeout Number? The value of Buffer.readMessageTimeout

Properties

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

handleData

Functions that receive chunks of data and recognize the messages

Parameters

• data Array<Number>

_removeFromByteBuffer

Removes N bytes from the buffer

Parameters

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

subscribe

Subscribe to a message

Parameters

• options Object
  • options.msg Message Message
  • options.once Boolean (optional, default true)
  • options.all Boolean (optional, default false)
  • options.callback Function

Returns Function unsubscribe callback

readMessage

Read a message from the serialport

Parameters

• msg String Message
• options Object (optional, default {})
  • options.timeout Number? If not set it uses the readMessageTimeout that was passed to the constructor

Returns Message message

MessageFragment

Message Fragment

Type: Object

Properties

• name String Name of the fragment
• desc String? Description of the fragment
• pattern Array<(Number | Function | String)> Defines the fragment byte pattern. undefined works as a wildcard for a byte and "*" for multiple bytes
• default Array Used when a message is created

Message

Parameters

• name String
• fragments Array<MessageFragment>

Properties

• name String

name

Type: String

fragments

Type: Array<MessageFragment>

getPattern

Return pattern

Returns Array Array of Bytes and Function that return array of bytes

generateBytes

Generate the raw message

Parameters

• data Object Dictionary with array of bytes (optional, default {})

Returns Array<Number> Array of bytes