CAN Message Serialization function reference

msg_actuator.h

Functions

void build_actuator_cmd_msg(can_msg_prio_t prio, uint16_t timestamp, can_actuator_id_t actuator_id, can_actuator_state_t actuator_cmd, can_msg_t *output)

void build_actuator_status_msg(can_msg_prio_t prio, uint16_t timestamp, can_actuator_id_t actuator_id, can_actuator_state_t actuator_cmd_state, can_actuator_state_t actuator_curr_state, can_msg_t *output)

w_status_t get_actuator_id(const can_msg_t *msg, can_actuator_id_t *actuator_id)

w_status_t get_curr_actuator_state(const can_msg_t *msg, can_actuator_state_t *curr_actuator_state)

w_status_t get_cmd_actuator_state(const can_msg_t *msg, can_actuator_state_t *cmd_actuator_state)

msg_common.h

Functions

void build_canard_firmware_error_msg(can_msg_prio_t prio, uint16_t timestamp, can_canards_module_id_t module_id, uint32_t error_bitfield, can_canards_health_severity_t severity, can_msg_t *output)

w_status_t get_canard_firmware_error_msg(const can_msg_t *msg, can_canards_module_id_t *module_id, uint32_t *error_bitfield, can_canards_health_severity_t *severity)

msg_common.h

Defines

BOARD_TYPE_UNIQUE_ID

BOARD_INST_UNIQUE_ID

Functions

static inline uint32_t build_sid(can_msg_prio_t prio, can_msg_type_t msg_type, uint8_t metadata)

static inline can_msg_type_t get_message_type(const can_msg_t *msg)

static inline uint8_t get_board_type_unique_id(const can_msg_t *msg)

static inline uint8_t get_board_inst_unique_id(const can_msg_t *msg)

static inline uint8_t get_message_metadata(const can_msg_t *msg)

static inline void write_timestamp(uint16_t timestamp, can_msg_t *output)

static inline uint16_t get_timestamp(const can_msg_t *msg)

msg_general.h

Functions

void build_general_board_status_msg(can_msg_prio_t prio, uint16_t timestamp, uint32_t board_error_bitfield, can_msg_t *output)

void build_reset_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t board_type_id, uint8_t board_inst_id, can_msg_t *output)

void build_debug_raw_msg(can_msg_prio_t prio, uint16_t timestamp, const uint8_t *data, can_msg_t *output)

void build_config_set_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t board_type_id, uint8_t board_inst_id, uint16_t config_id, uint16_t config_value, can_msg_t *output)

void build_config_status_msg(can_msg_prio_t prio, uint16_t timestamp, uint16_t config_id, uint16_t config_value, can_msg_t *output)

w_status_t get_general_board_status(const can_msg_t *msg, uint32_t *board_error_bitfield)

w_status_t get_reset_board_id(const can_msg_t *msg, uint8_t *board_type_id, uint8_t *board_inst_id)

w_status_t check_board_need_reset(const can_msg_t *msg, bool *board_need_reset)

w_status_t get_debug_raw_data(const can_msg_t *msg, uint8_t *data)

w_status_t get_config_set_target_board(const can_msg_t *msg, uint8_t *board_type_id, uint8_t *board_inst_id)

w_status_t get_config_id_value(const can_msg_t *msg, uint16_t *config_id, uint16_t *config_value)

msg_gps.h

Functions

void build_gps_time_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t utc_hours, uint8_t utc_mins, uint8_t utc_secs, uint8_t utc_dsecs, can_msg_t *output)

void build_gps_lat_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t degrees, uint8_t minutes, uint16_t dminutes, uint8_t direction, can_msg_t *output)

void build_gps_lon_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t degrees, uint8_t minutes, uint16_t dminutes, uint8_t direction, can_msg_t *output)

void build_gps_alt_msg(can_msg_prio_t prio, uint16_t timestamp, uint32_t altitude, uint8_t daltitude, can_msg_t *output)

void build_gps_info_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t num_sat, uint8_t quality, can_msg_t *output)

w_status_t get_gps_time(const can_msg_t *msg, uint8_t *utc_hours, uint8_t *utc_mins, uint8_t *utc_secs, uint8_t *utc_dsecs)

w_status_t get_gps_lat(const can_msg_t *msg, uint8_t *degrees, uint8_t *minutes, uint16_t *dminutes, uint8_t *direction)

w_status_t get_gps_lon(const can_msg_t *msg, uint8_t *degrees, uint8_t *minutes, uint16_t *dminutes, uint8_t *direction)

w_status_t get_gps_alt(const can_msg_t *msg, uint32_t *altitude, uint8_t *daltitude)

w_status_t get_gps_info(const can_msg_t *msg, uint8_t *num_sat, uint8_t *quality)

msg_recovery.h

Functions

void build_alt_arm_cmd_msg(can_msg_prio_t prio, uint16_t timestamp, can_altimeter_id_t alt_id, can_alt_arm_state_t arm_cmd, can_msg_t *output)

void build_alt_arm_status_msg(can_msg_prio_t prio, uint16_t timestamp, can_altimeter_id_t alt_id, can_alt_arm_state_t arm_state, uint16_t v_drogue, uint16_t v_main, can_msg_t *output)

w_status_t get_alt_arm_state(const can_msg_t *msg, can_altimeter_id_t *alt_id, can_alt_arm_state_t *arm_state)

w_status_t get_pyro_voltage_data(const can_msg_t *msg, uint16_t *v_drogue, uint16_t *v_main)

msg_sensor.h

Functions

void build_analog_sensor_16bit_msg(can_msg_prio_t prio, uint16_t timestamp, can_analog_sensor_id_t sensor_id, uint16_t sensor_data, can_msg_t *output)

void build_analog_sensor_32bit_msg(can_msg_prio_t prio, uint16_t timestamp, can_analog_sensor_id_t sensor_id, uint32_t sensor_data, can_msg_t *output)

void build_3d_analog_sensor_16bit_msg(can_msg_prio_t prio, uint16_t timestamp, can_dem_3d_sensor_id_t sensor_id, uint16_t sensor_data_x, uint16_t sensor_data_y, uint16_t sensor_data_z, can_msg_t *output)

void build_2d_analog_sensor_24bit_msg(can_msg_prio_t prio, uint16_t timestamp, can_dem_2d_sensor_id_t sensor_id, uint32_t sensor_data_x, uint32_t sensor_data_y, can_msg_t *output)

bool msg_is_analog_sensor(const can_msg_t *msg)

w_status_t get_analog_sensor_data_16bit(const can_msg_t *msg, can_analog_sensor_id_t *sensor_id, uint16_t *output_data)

w_status_t get_analog_sensor_data_32bit(const can_msg_t *msg, can_analog_sensor_id_t *sensor_id, uint32_t *output_data)

w_status_t get_3d_analog_sensor_data_16bit(const can_msg_t *msg, can_dem_3d_sensor_id_t *sensor_id, uint16_t *output_data_x, uint16_t *output_data_y, uint16_t *output_data_z)

w_status_t get_2d_analog_sensor_data_24bit(const can_msg_t *msg, can_dem_2d_sensor_id_t *sensor_id, uint32_t *sensor_data_x, uint32_t *sensor_data_y)

msg_stream.h

Defines

STREAM_DATA_MAX_PAYLOAD_LEN

Functions

void build_stream_status_msg(can_msg_prio_t prio, uint16_t timestamp, uint32_t total_size, uint32_t tx_size, can_msg_t *output)

void build_stream_data_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t seq_id, const uint8_t *payload, uint8_t payload_len, can_msg_t *output)

void build_stream_retry_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t seq_id, can_msg_t *output)

w_status_t get_stream_status(const can_msg_t *msg, uint32_t *total_size, uint32_t *tx_size)

w_status_t get_stream_data(const can_msg_t *msg, uint8_t *seq_id, uint8_t *payload, uint8_t *payload_len)

w_status_t get_stream_retry_seq_id(const can_msg_t *msg, uint8_t *seq_id)

msg_telemetry.h

Functions

void build_telemetry_info_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t channel_id, uint8_t lqi, int8_t rssi, can_msg_t *output)

w_status_t get_telemetry_info_msg(const can_msg_t *msg, uint8_t *channel_id, uint8_t *lqi, int8_t *rssi)

void build_telemetry_state_switch_msg(can_msg_prio_t prio, uint16_t timestamp, uint8_t channel_id, can_msg_t *output)

w_status_t get_telemetry_state_switch_msg(const can_msg_t *msg, uint8_t *channel_id)