uCRC16XModemLib
https://github.com/Naguissa/uCRC16XModemLib
Public Member Functions | List of all members
uCRC16XModemLib Class Reference

Tiny and cross-device compatible CRC16 XModem calculator library. Compatible with UKHAS - uCRC16XModemLib. More...

Public Member Functions

 uCRC16XModemLib ()
 Constructor. More...
 
void reset ()
 Reset internal status.
 
void feedBit (bool)
 Calculate CRC16 bit per bit. More...
 
void feedByte (char)
 Calculate CRC16 function, feed a byte. More...
 
uint16_t getResult ()
 Get previously calculated result. More...
 
uint16_t calculate (const char *)
 Calculate CRC16 function of a char array. More...
 
uint16_t calculate (const char *, const uint8_t)
 Calculate CRC16 function of a char array with an offset. More...
 

Detailed Description

Tiny and cross-device compatible CRC16 XModem calculator library. Compatible with UKHAS - uCRC16XModemLib.

Compatible with UKHAS message signing (use offset 2 on full message to skip leading "$").

Constructor & Destructor Documentation

◆ uCRC16XModemLib()

uCRC16XModemLib::uCRC16XModemLib ( )

Constructor.

Reset internal status

Member Function Documentation

◆ calculate() [1/2]

uint16_t uCRC16XModemLib::calculate ( const char *  string)

Calculate CRC16 function of a char array.

Parameters
data_pPointer to char array
Returns
calculated CRC

◆ calculate() [2/2]

uint16_t uCRC16XModemLib::calculate ( const char *  string,
const uint8_t  offset 
)

Calculate CRC16 function of a char array with an offset.

Parameters
data_pPointer to char array
offsetoffset from the star of char array
Returns
calculated CRC

◆ feedBit()

void uCRC16XModemLib::feedBit ( bool  data_p)

Calculate CRC16 bit per bit.

Parameters
data_pFeeded bit

◆ feedByte()

void uCRC16XModemLib::feedByte ( char  data_p)

Calculate CRC16 function, feed a byte.

Parameters
data_pByte to add

◆ getResult()

uint16_t uCRC16XModemLib::getResult ( )

Get previously calculated result.

Parameters
data_pPointer to char array
Returns
calculated CRC

The documentation for this class was generated from the following files: