point_one::fusion_engine::messages::PlatformStorageDataMessage Struct Reference

Detailed Description

Message for reporting platform storage data (MessageType::PLATFORM_STORAGE_DATA, version 1.0).

This message will be followed by data_length_bytes bytes containing the data storage contents:

{MessageHeader, PlatformStorageDataMessage, Payload[data_length_bytes]}

See also ExportDataMessage.

Changes:

• Version 1: Added data_validity field.
• Version 2: Changed data_validity to a Response enum and added source field.
• Version 3: Added flags field.

Definition at line 1473 of file configuration.h.

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

Public Attributes
uint32_t	data_length_bytes = 0
	Number of bytes in data contents. More...
DataType	data_type = DataType::INVALID
	The type of data contained in this message. More...
DataVersion	data_version
	Version of data contents. More...
uint8_t	flags = 0
	DataType specific flags. More...
Response	response = Response::OK
	The status of the specified data type on the device. More...
ConfigurationSource	source = ConfigurationSource::ACTIVE
	The source this data was copied from. More...

Static Public Attributes
static constexpr uint8_t	FLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2
	DataType::USER_CONFIG flag for embedded platforms. More...
static constexpr uint8_t	FLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR = 3
	DataType::USER_CONFIG flag for embedded SSR platforms. More...
static constexpr uint8_t	FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0
	DataType::USER_CONFIG flag field is not set. More...
static constexpr uint8_t	FLAG_USER_CONFIG_PLATFORM_POSIX = 1
	DataType::USER_CONFIG flag for POSIX platforms. More...
static constexpr uint8_t	FLAG_USER_CONFIG_SSR_CLIENT = 254
	DataType::USER_CONFIG flag for the SSR client library. More...
static constexpr MessageType	MESSAGE_TYPE
static constexpr uint8_t	MESSAGE_VERSION = 3

Member Data Documentation

data_length_bytes

uint32_t point_one::fusion_engine::messages::PlatformStorageDataMessage::data_length_bytes = 0

Number of bytes in data contents.

Definition at line 1516 of file configuration.h.

data_type

DataType point_one::fusion_engine::messages::PlatformStorageDataMessage::data_type = DataType::INVALID

The type of data contained in this message.

Definition at line 1492 of file configuration.h.

data_version

DataVersion point_one::fusion_engine::messages::PlatformStorageDataMessage::data_version

Version of data contents.

Definition at line 1514 of file configuration.h.

FLAG_USER_CONFIG_PLATFORM_EMBEDDED

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2

staticconstexpr

DataType::USER_CONFIG flag for embedded platforms.

Definition at line 1483 of file configuration.h.

FLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_EMBEDDED_SSR = 3

staticconstexpr

DataType::USER_CONFIG flag for embedded SSR platforms.

Definition at line 1485 of file configuration.h.

FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0

staticconstexpr

DataType::USER_CONFIG flag field is not set.

Definition at line 1479 of file configuration.h.

FLAG_USER_CONFIG_PLATFORM_POSIX

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_PLATFORM_POSIX = 1

staticconstexpr

DataType::USER_CONFIG flag for POSIX platforms.

Definition at line 1481 of file configuration.h.

FLAG_USER_CONFIG_SSR_CLIENT

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::FLAG_USER_CONFIG_SSR_CLIENT = 254

staticconstexpr

DataType::USER_CONFIG flag for the SSR client library.

Definition at line 1487 of file configuration.h.

flags

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

DataType specific flags.

Currently, only defined for DataType::USER_CONFIG contents. This value can optionally set to one of the FLAG_USER_CONFIG_PLATFORM_* values to indicate which type of platform the UserConfig is valid for. This value can be left at 0 for backwards compatibility or to indicate the platform type is unknown.

Definition at line 1512 of file configuration.h.

MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::PlatformStorageDataMessage::MESSAGE_TYPE

staticconstexpr

Initial value:

=
      MessageType::PLATFORM_STORAGE_DATA

Definition at line 1474 of file configuration.h.

MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::PlatformStorageDataMessage::MESSAGE_VERSION = 3

staticconstexpr

Definition at line 1476 of file configuration.h.

response

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

The status of the specified data type on the device.

Definition at line 1496 of file configuration.h.

source

ConfigurationSource point_one::fusion_engine::messages::PlatformStorageDataMessage::source = ConfigurationSource::ACTIVE

The source this data was copied from.

If the data_type doesn't separate active and saved data, this will be set to ConfigurationSource::ACTIVE.

Definition at line 1502 of file configuration.h.

---

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

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