Functions
xbus.c File Reference
#include "xbus.h"
Include dependency graph for xbus.c:

Go to the source code of this file.

Functions

bool Xbus_checkPreamble (const uint8_t *xbusMessage)
 Returns true if the preamble equeals 0xFA, false othersise. More...
 
int Xbus_getBusId (const uint8_t *xbusMessage)
 Returns xbus Bus identifier. More...
 
uint8_t const * Xbus_getConstPointerToPayload (uint8_t const *xbusMessage)
 Returns a const pointer to payload of an xbus message. More...
 
int Xbus_getMessageId (const uint8_t *xbusMessage)
 Returns xbus Message identifier. More...
 
int Xbus_getPayloadLength (const uint8_t *xbusMessage)
 Returns xbus message (payload) length. More...
 
uint8_t * Xbus_getPointerToPayload (uint8_t *xbusMessage)
 Returns pointer to payload of an xbus message. More...
 
int Xbus_getRawLength (const uint8_t *xbusMessage)
 Returns total length of xbus message (header + payload + checksum) More...
 
void Xbus_insertChecksum (uint8_t *xbusMessage)
 Inserts the correct checksum in xbus message. More...
 
void Xbus_message (uint8_t *xbusMessage, uint8_t bid, uint8_t mid, uint16_t len)
 Initialize a xbus message with BID, MID and Length. More...
 
void Xbus_setBusId (uint8_t *xbusMessage, uint8_t busId)
 Sets xbus Bus identifier. More...
 
void Xbus_setMessageId (uint8_t *xbusMessage, uint8_t messageId)
 Sets xbus Message identifier. More...
 
void Xbus_setPayloadLength (uint8_t *xbusMessage, uint16_t payloadLength)
 Sets xbus message (payload) length. More...
 
bool Xbus_verifyChecksum (const uint8_t *xbusMessage)
 Verifies the checksum of aon xbus message. More...
 

Function Documentation

◆ Xbus_checkPreamble()

bool Xbus_checkPreamble ( const uint8_t *  xbusMessage)

Returns true if the preamble equeals 0xFA, false othersise.

Definition at line 70 of file xbus.c.

◆ Xbus_getBusId()

int Xbus_getBusId ( const uint8_t *  xbusMessage)

Returns xbus Bus identifier.

Definition at line 77 of file xbus.c.

◆ Xbus_getConstPointerToPayload()

uint8_t const* Xbus_getConstPointerToPayload ( uint8_t const *  xbusMessage)

Returns a const pointer to payload of an xbus message.

Definition at line 167 of file xbus.c.

◆ Xbus_getMessageId()

int Xbus_getMessageId ( const uint8_t *  xbusMessage)

Returns xbus Message identifier.

Definition at line 91 of file xbus.c.

◆ Xbus_getPayloadLength()

int Xbus_getPayloadLength ( const uint8_t *  xbusMessage)

Returns xbus message (payload) length.

Definition at line 105 of file xbus.c.

◆ Xbus_getPointerToPayload()

uint8_t* Xbus_getPointerToPayload ( uint8_t *  xbusMessage)

Returns pointer to payload of an xbus message.

Definition at line 157 of file xbus.c.

◆ Xbus_getRawLength()

int Xbus_getRawLength ( const uint8_t *  xbusMessage)

Returns total length of xbus message (header + payload + checksum)

Definition at line 144 of file xbus.c.

◆ Xbus_insertChecksum()

void Xbus_insertChecksum ( uint8_t *  xbusMessage)

Inserts the correct checksum in xbus message.

Definition at line 175 of file xbus.c.

◆ Xbus_message()

void Xbus_message ( uint8_t *  xbusMessage,
uint8_t  bid,
uint8_t  mid,
uint16_t  len 
)

Initialize a xbus message with BID, MID and Length.

Definition at line 134 of file xbus.c.

◆ Xbus_setBusId()

void Xbus_setBusId ( uint8_t *  xbusMessage,
uint8_t  busId 
)

Sets xbus Bus identifier.

Definition at line 84 of file xbus.c.

◆ Xbus_setMessageId()

void Xbus_setMessageId ( uint8_t *  xbusMessage,
uint8_t  messageId 
)

Sets xbus Message identifier.

Definition at line 98 of file xbus.c.

◆ Xbus_setPayloadLength()

void Xbus_setPayloadLength ( uint8_t *  xbusMessage,
uint16_t  payloadLength 
)

Sets xbus message (payload) length.

Definition at line 120 of file xbus.c.

◆ Xbus_verifyChecksum()

bool Xbus_verifyChecksum ( const uint8_t *  xbusMessage)

Verifies the checksum of aon xbus message.

Definition at line 188 of file xbus.c.



xsens_mti_driver
Author(s):
autogenerated on Sun Sep 3 2023 02:43:21