point_one::fusion_engine::messages::SetConfigMessage Struct Reference

Detailed Description

Set a user configuration parameter (MessageType::SET_CONFIG, version 1.0).

The format of the parameter value, config_change_data, is defined by the the specified config_type (ConfigType). For example, an antenna lever arm definition may require three 32-bit float values, one for each axis, while a serial port baud rate may be specified as single 32-bit unsigned integer (uint32_t).

Not all parameters defined in ConfigType are supported on all devices.

Parameter changes are applied to the device's active configuration immediately, but are not saved to persistent storage and will be restored to their previous values on reset. To save configuration settings to persistent storage, see SaveConfigMessage.

Expected Response

The device will respond with a CommandResponseMessage indicating whether or not the request succeeded.

Definition at line 491 of file configuration.h.

Inheritance diagram for point_one::fusion_engine::messages::SetConfigMessage:

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

Public Attributes
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...
ConfigType	config_type
	The type of parameter to be configured. More...
uint8_t	flags = 0
	Bitmask of additional flags to modify the command. More...

Static Public Attributes
static constexpr uint8_t	FLAG_APPLY_AND_SAVE = 0x01
	Flag to immediately save the config after applying this setting. More...
static constexpr uint8_t	FLAG_REVERT_TO_DEFAULT = 0x02
	Flag to restore the config_type back to its default value. More...
static constexpr MessageType	MESSAGE_TYPE = MessageType::SET_CONFIG
static constexpr uint8_t	MESSAGE_VERSION = 0

Member Data Documentation

config_change_data

uint8_t point_one::fusion_engine::messages::SetConfigMessage::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 526 of file configuration.h.

config_length_bytes

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

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

Definition at line 518 of file configuration.h.

config_type

ConfigType point_one::fusion_engine::messages::SetConfigMessage::config_type

The type of parameter to be configured.

Definition at line 510 of file configuration.h.

FLAG_APPLY_AND_SAVE

constexpr uint8_t point_one::fusion_engine::messages::SetConfigMessage::FLAG_APPLY_AND_SAVE = 0x01

staticconstexpr

Flag to immediately save the config after applying this setting.

Definition at line 496 of file configuration.h.

FLAG_REVERT_TO_DEFAULT

constexpr uint8_t point_one::fusion_engine::messages::SetConfigMessage::FLAG_REVERT_TO_DEFAULT = 0x02

staticconstexpr

Flag to restore the config_type back to its default value.

When set, the config_length_bytes should be 0 and no data should be included unless the config_type is ConfigType::INTERFACE_CONFIG. In that case the config_length_bytes should be sizeof(InterfaceConfigSubmessage) with a an InterfaceConfigSubmessage as the config_change_data without any further payload.

Definition at line 507 of file configuration.h.

flags

uint8_t point_one::fusion_engine::messages::SetConfigMessage::flags = 0

Bitmask of additional flags to modify the command.

Definition at line 513 of file configuration.h.

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::SetConfigMessage::MESSAGE_TYPE = MessageType::SET_CONFIG

staticconstexpr

Definition at line 492 of file configuration.h.

MESSAGE_VERSION

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

staticconstexpr

Definition at line 493 of file configuration.h.

---

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

• src/point_one/fusion_engine/messages/configuration.h