Massage is a microcontroller message packer and parser for different types of formats and protocols.
A massage message always starts with an address string and is followed by a user defined number of bytes, ints, floats or longs. The address string is used to route the message as in Open Sound Control.
There are two basic massage objetcs to work with massages:
- MassagePacker packs data to be sent
- MassageParser parses received data
This repository is the API. It is implemented through different packing formats that follow the same interface:
- AsciiMassage for easy-to-read ASCII messages:
- SlipMassage for sending lots binary data using SLIP encoding:
These packing formats can then be used to send and receive messages over different communication protocols such as serial, UDP, or web sockets.
MassageParser (): Constructor.
parse (int data, optional callbackFunction callback) : processes one byte of data, flushing any previous completed message if needed. Returns true if a new message has arrived. Optional callback function will be called if a new message has arrived.
parseStream (Stream* stream, optional callbackFunction callback) : processes all the available bytes in a stream (Serial, UDP, etc), flushing any previous completed message if needed. Returns true if a new message has arrived. Optional callback function will be called if a new message has arrived.
fullMatch (const char *address) : Return true if current message matches "address".
dispatch (const char *address, callbackFunction callback) : If current message matches "address", calls function "callback" and returns true.
nextByte () : Returns the next byte in the parsed massage.
nextFloat() : Returns the next float in the parsed massage.
nextInt () : Returns the next int in the parsed massage.
nextLong() : Returns the next long in the parsed massage.
MassagePacker() : Constructor
beginPacket(const char* address) : Begins a packet (erasing any previous packet).
addByte(uint8_t value) : Adds a byte.
addInt(int16_t value) : Adds an int.
addLong(int32_t value) : Adds a long.
addFloat(float value) : Adds a float.
endPacket() : Ends a packet.
streamPacket(Stream* stream) : Ends a packet and sends it out to a stream (Serial, UDP, etc).
streamEmpty(Stream* stream, const char *address) : Stream (Serial, UDP, etc) a packet with no arguments.
streamOneByte(Stream* stream, const char *address, uint8_t value) : Stream (Serial, UDP, etc) a packet with a single byte value.
streamOneInt(Stream* stream, const char *address, int16_t value) : Stream (Serial, UDP, etc) a packet with a single int value.
streamOneLong(Stream* stream, const char *address, int32_t value) : Stream (Serial, UDP, etc) a packet with a single long value.
streamOneFloat(Stream* stream, const char *address, float value) : Stream (Serial, UDP, etc) a packet with a single float value.
packEmpty(const char *address) : Create a packet with no arguments.
packOneByte(const char *address, uint8_t value) : Create a packet with a single byte value.
packOneInt(const char *address, int16_t value) : Create a packet with a single int value.
packOneLong(const char *address, int32_t value) : Create a packet with a single long value.
packOneFloat(const char *address, float value) : Create a packet with a single float value.
size() : Returns the size of the packed massage.
buffer() : Returns a pointer to the buffer.