1.1.0 • Published 5 years ago
@orchestra-platform/byte-message-parser v1.1.0
Table of Contents
MessagesManager
Parameters
_messages
getMessage
Parameters
name
String Message name
getMessages
Parameters
recognizeMessage
Recognize a message from an array of bytes
Parameters
Returns Boolean Returns false if no message is found
Returns Object Returns an Object {type,bytes,values} if a message is found
Buffer
Parameters
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
_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
Returns Function unsubscribe callback
readMessage
Read a message from the serialport
Parameters
msg
String Messageoptions
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 fragmentdesc
String? Description of the fragmentpattern
Array<(Number | Function | String)> Defines the fragment byte pattern. undefined works as a wildcard for a byte and "*" for multiple bytesdefault
Array Used when a message is created
Message
Parameters
name
Stringfragments
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{}
)