Response to a GetConfigMessage request (MessageType::CONFIG_RESPONSE, version 1.0). More...

#include <point_one/fusion_engine/messages/configuration.h>

Inheritance diagram for point_one::fusion_engine::messages::ConfigResponseMessage:

Public Attributes
bool	active_differs_from_saved = false
	Set to `true` if the active configuration differs from the saved configuration for this parameter. More...

uint8_t	config_change_data [0]
	A pointer to the beginning of the configuration parameter value. More...

uint32_t	config_length_bytes = 0
	The size of the parameter value, config_change_data (in bytes). More...

ConfigurationSource	config_source = ConfigurationSource::ACTIVE
	The source of the parameter value (active, saved, etc.). More...

ConfigType	config_type = ConfigType::INVALID
	The type of configuration parameter contained in this message. More...

Response	response = Response::OK
	The response status (success, error, etc.). More...

Static Public Attributes
static constexpr MessageType	MESSAGE_TYPE = MessageType::CONFIG_RESPONSE

static constexpr uint8_t	MESSAGE_VERSION = 0

Detailed Description

Response to a GetConfigMessage request (MessageType::CONFIG_RESPONSE, version 1.0).

This message is followed by N bytes, where N is equal to config_length_bytes that make up the data associated with config_type. For example if the config_type is ConfigType::UART1_BAUD, the payload will include a single 32-bit unsigned integer:

{MessageHeader, ConfigResponseMessage, uint32_t}

In response to a GetConfigMessage with an invalid or unsupported ConfigType, config_type in the resulting ConfigResponseMessage will be set to ConfigType::INVALID, and response will indicate the reason. Note that all GetConfigMessage requests, including invalid and rejected requests, will receive a ConfigResponseMessage, not a CommandResponseMessage.

Definition at line 386 of file configuration.h.

Member Data Documentation

◆ active_differs_from_saved

bool point_one::fusion_engine::messages::ConfigResponseMessage::active_differs_from_saved = false

Set to true if the active configuration differs from the saved configuration for this parameter.

Definition at line 397 of file configuration.h.

◆ config_change_data

uint8_t point_one::fusion_engine::messages::ConfigResponseMessage::config_change_data[0]

A pointer to the beginning of the configuration parameter value.

The size and format of the contents is specified by the config_type. See ConfigType.

Definition at line 416 of file configuration.h.

◆ config_length_bytes

uint32_t point_one::fusion_engine::messages::ConfigResponseMessage::config_length_bytes = 0

The size of the parameter value, config_change_data (in bytes).

Definition at line 408 of file configuration.h.

◆ config_source

ConfigurationSource point_one::fusion_engine::messages::ConfigResponseMessage::config_source = ConfigurationSource::ACTIVE

The source of the parameter value (active, saved, etc.).

Definition at line 391 of file configuration.h.

◆ config_type

ConfigType point_one::fusion_engine::messages::ConfigResponseMessage::config_type = ConfigType::INVALID

The type of configuration parameter contained in this message.

Definition at line 400 of file configuration.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::ConfigResponseMessage::MESSAGE_TYPE = MessageType::CONFIG_RESPONSE

staticconstexpr

Definition at line 387 of file configuration.h.

◆ MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::ConfigResponseMessage::MESSAGE_VERSION = 0

staticconstexpr

Definition at line 388 of file configuration.h.

◆ response

Response point_one::fusion_engine::messages::ConfigResponseMessage::response = Response::OK

The response status (success, error, etc.).

Definition at line 403 of file configuration.h.

The documentation for this struct was generated from the following file:

src/point_one/fusion_engine/messages/configuration.h

Public Attributes

Static Public Attributes