Telemetry

telemetry Firmware More...

Classes
struct	Datagram
	Datagram storage class. More...
struct	TelemetryConfig
	Telemetry configuration data. More...
struct	TelemetryStorage
	Telemetry storage. More...

Macros
#define	DATAGRAM_BUFFER_SIZE   64U
	Datagram buffer size.
#define	DATAGRAM_START_FRAME   0xAAU
	Start of frame indicator.
#define	DATAGRAM_END_FRAME   0xBBU
	End of frame indicator.
#define	DATAGRAM_METADATA_SIZE   5U
	Datagram metadata size. More...

Functions
void	decode_can_message (Datagram *datagram, CanMessage *msg)
	Decode CAN message and update a datagram. More...
void	log_decoded_message (Datagram *datagram)
	Log the decoded datagram for debug purposes. More...
StatusCode	telemetry_init (TelemetryStorage *storage, TelemetryConfig *config)
	Initialize the telemetry interface. More...

Detailed Description

telemetry Firmware

Macro Definition Documentation

DATAGRAM_METADATA_SIZE

#define DATAGRAM_METADATA_SIZE   5U

Datagram metadata size.

1 byte for start frame 2 bytes for ID 1 byte for DLC 1 byte for end frame

Function Documentation

decode_can_message()

void decode_can_message	(	Datagram *	datagram,
		CanMessage *	msg
	)

Decode CAN message and update a datagram.

Parameters

datagram	Pointer to the datagram to be updated
msg	Pointer to the new CAN data

log_decoded_message()

void log_decoded_message

(

Datagram *

datagram

)

Log the decoded datagram for debug purposes.

Parameters

datagram

Pointer to the datagram to be debugged

telemetry_init()

StatusCode telemetry_init	(	TelemetryStorage *	storage,
		TelemetryConfig *	config
	)

Initialize the telemetry interface.

Parameters

storage	Pointer to the telemetry storage
config	Pointer to the telemetry config

Returns

STATUS_CODE_OK if telemetry initialization succeeded STATUS_CODE_INVALID_ARGS if one of the parameters are incorrect