HoustonAsh / Packet

Just a helper package for messing with byte buffers

Packet

A simple packet management library for Arduino and other embedded platforms designed for various communication protocols.

Usage

• In general:

  const uint8_t buffSize = 16
  uint8_t buff[buffSize] = {...}  
  Packet p(buff, buffSize);
  
  //if you need custom head and tail:
  uint8_t h[2] = {0x14, 0xBB};
  uint8_t t[2] = {0x88, 0xA1};
  Packet p(buff, buffSize, false, h, 2, t, 2);
  
  //if you need to create Packet instance from buffer:
  p.insertPacket(buff, buffSize, false, h, 2, t, 2)
   .fixCRC()
   .print();
  
  if (p.isValid()) {
    ...
  }

  // you can also pass crc function (CRC16 Kermit is by default)
  // you have to wrap non static function member with lambda
  // fastCRC is already initialized
  const uint8_t buffSize = 16
  uint8_t buff[buffSize] = {...}  
  Packet p(buff, buffSize, [](const uint8_t* data, uint16_t datalen) {return fastCRC.modbus(data, datalen);});
  
  //or
  //if you need custom head, tail and crc function (or any other own custom data integrity check function)
  uint8_t h[2] = {0x14, 0xBB};
  uint8_t t[2] = {0x88, 0xA1};
  Packet p2(buff, buffSize, true, h, 2, t, 2, [](const uint8_t* data, uint16_t datalen) {return fastCRC.modbus(data, datalen);});

• By default, memory for data will be allocated on the stack. If you want to use heap memory at some point, add this line to your platformio.ini file:

  build_flags = -DPACKET_BUFFER_SIZE=128

  Or if you use ArduinoIDE define PACKET_BUFFER_SIZE before including Packet.h:

  #define PACKET_BUFFER_SIZE 128
  #include <Packet.h>

• Note: operator '=' creates a copy