Serial_packer.h

Go to the documentation of this file.

 
#ifndef SERIAL_PACKER_H
#define SERIAL_PACKER_H
 
#include <Arduino.h>
#include <HardwareSerial.h>
 
// JM9 UART packet:
// start-byte
// length-byte (sum of amount of cmd/reg-byte and data-bytes)
// cmd/reg-byte (optional, may be treated as the first data byte)
// data-bytes (variable length)
// xor-byte (xor of start-byte and length-byte and cmd/reg-byte and data-bytes)
//
// reject entire packet if xor-byte is not matched

class Serial_packer {
    private:
        HardwareSerial &uart;
    
        const uint8_t start_byte;

        uint8_t xor_byte;

        void send_byte (const uint8_t data);
    
    public:

        Serial_packer (HardwareSerial &init_uart, const uint8_t init_start_byte);

        bool send (const uint8_t * const tx_buf, const uint8_t tx_buf_len);

        HardwareSerial &get_uart ();
};
 
#endif // #ifndef SERIAL_PACKER_H