SetConfigMessage Struct

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

Declaration

struct point_one::fusion_engine::messages::SetConfigMessage { ... }

Included Headers

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

Base struct

struct	MessagePayload
	The base class for all message payloads. More...

Public Member Attributes Index

uint32_t	config_length_bytes = 0
	The size of the parameter value (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...

Public Static Attributes Index

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

Description

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

This message must be followed by the parameter value to be used:

 {MessageHeader, SetConfigMessage, Parameter[data_length_bytes]}

The format of the parameter value 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 494 of file configuration.h.

Public Member Attributes

config_length_bytes

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

The size of the parameter value (in bytes).

Definition at line 521 of file configuration.h.

521 uint32_t config_length_bytes = 0;

config_type

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

The type of parameter to be configured.

Definition at line 513 of file configuration.h.

513 ConfigType config_type;

flags

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

Bitmask of additional flags to modify the command.

Definition at line 516 of file configuration.h.

516 uint8_t flags = 0;

Public Static Attributes

FLAG_APPLY_AND_SAVE

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

constexpr static

Flag to immediately save the config after applying this setting.

Definition at line 499 of file configuration.h.

499 static constexpr uint8_t FLAG_APPLY_AND_SAVE = 0x01;

FLAG_REVERT_TO_DEFAULT

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

constexpr static

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 parameter value without any further payload.

Definition at line 510 of file configuration.h.

510 static constexpr uint8_t FLAG_REVERT_TO_DEFAULT = 0x02;

MESSAGE_TYPE

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

constexpr static

Definition at line 495 of file configuration.h.

495 static constexpr MessageType MESSAGE_TYPE = MessageType::SET_CONFIG;

MESSAGE_VERSION

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

constexpr static

Definition at line 496 of file configuration.h.

496 static constexpr uint8_t MESSAGE_VERSION = 0;

---

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

• configuration.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.