Functions — github.com/PowerBroker2/SerialTransfer

CodeHub MCPcopy Create free account

hub / github.com/PowerBroker2/SerialTransfer / functions

Functions33 in github.com/PowerBroker2/SerialTransfer

⨍ Functions 33 ◇ Types & classes 6

↓ 3 callersMethodcalculate

src/PacketCRC.h:52

↓ 3 callersMethodparse

src/Packet.cpp:119

↓ 2 callersMethodavailable

uint8_t SerialTransfer::available() Description: ------------ * Parses incoming serial data, analyzes packet contents, and reports errors/su

src/SerialTransfer.cpp:87

↓ 2 callersMethodconstructPacket

uint8_t Packet::constructPacket(const uint16_t& messageLen, const uint8_t& packetID) Description: ------------ * Calculate, format, and insert

src/Packet.cpp:68

↓ 1 callersMethodreset

void I2CTransfer::reset() Description: ------------ * Clears out the tx, and rx buffers, plus resets the "bytes read" variable, finite state

src/I2CTransfer.cpp:145

↓ 1 callersMethodtxObj

src/SerialTransfer.h:43

↓ 1 callersMethodtxObj

src/I2CTransfer.h:47

MethodI2CTransfer

src/I2CTransfer.h:16

MethodPacketCRC

src/PacketCRC.h:11

void I2CTransfer::begin(TwoWire &_port, configST& configs) Description: ------------ * Advanced initializer for the I2CTransfer Class Inputs:

src/I2CTransfer.cpp:18

void SerialTransfer::begin(Stream &_port, configST configs) Description: ------------ * Advanced initializer for the SerialTransfer Class Inp

src/SerialTransfer.cpp:18

void Packet::begin(const configST& configs) Description: ------------ * Advanced initializer for the Packet Class Inputs: ------- * cons

src/Packet.cpp:20

MethodcalcOverhead

void Packet::calcOverhead(uint8_t arr[], const uint8_t &len) Description: ------------ * Calculates the COBS (Consistent Overhead Stuffing) Ove

src/Packet.cpp:321

MethodcurrentPacketID

uint8_t I2CTransfer::currentPacketID() Description: ------------ * Returns the ID of the last parsed packet Inputs: ------- * void Ret

src/I2CTransfer.cpp:126

MethodcurrentPacketID

uint8_t SerialTransfer::currentPacketID() Description: ------------ * Returns the ID of the last parsed packet Inputs: ------- * void

src/SerialTransfer.cpp:160

MethodcurrentPacketID

uint8_t Packet::currentPacketID() Description: ------------ * Returns the ID of the last parsed packet Inputs: ------- * void Return:

src/Packet.cpp:298

int16_t Packet::findLast(uint8_t arr[], const uint8_t &len) Description: ------------ * Finds last instance of the value START_BYTE within the

src/Packet.cpp:351

MethodgenerateTable

src/PacketCRC.h:21

MethodprintTable

src/PacketCRC.h:39

MethodprocessData

void I2CTransfer::processData() Description: ------------ * Parses incoming serial data automatically when an I2C frame is received Inputs

src/I2CTransfer.cpp:92

void SerialTransfer::reset() Description: ------------ * Clears out the tx, and rx buffers, plus resets the "bytes read" variable, finite st

src/SerialTransfer.cpp:179

void Packet::reset() Description: ------------ * Clears out the tx, and rx buffers, plus resets the "bytes read" variable, finite state mach

src/Packet.cpp:437

src/Packet.h:134

src/SerialTransfer.h:69

src/I2CTransfer.h:73

uint8_t I2CTransfer::sendData(const uint16_t &messageLen, const uint8_t &packetID, const uint8_t &targetAddress=0) Description: ------------ *

src/I2CTransfer.cpp:63

uint8_t SerialTransfer::sendData(const uint16_t &messageLen, const uint8_t packetID) Description: ------------ * Send a specified number of byt

src/SerialTransfer.cpp:61

MethodsendDatum

src/SerialTransfer.h:93

MethodsendDatum

src/I2CTransfer.h:100

MethodstuffPacket

void Packet::stuffPacket(uint8_t arr[], const uint8_t &len) Description: ------------ * Enforces the COBS (Consistent Overhead Stuffing) rulese

src/Packet.cpp:375

bool SerialTransfer::tick() Description: ------------ * Checks to see if any packets have been fully parsed. This is basically a wrapper aro

src/SerialTransfer.cpp:139

src/Packet.h:92

MethodunpackPacket

void Packet::unpackPacket(uint8_t arr[], const uint8_t &len) Description: ------------ * Unpacks all COBS-stuffed bytes within the array Inpu

src/Packet.cpp:406