Skip to main content

ImportDataMessage Struct

Import data from the host to the device (MessageType::IMPORT_DATA, version 1). More...

Declaration​

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

Included Headers​

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

Public Member Attributes Index​

uint32_tdata_length_bytes = 0

Number of bytes to update. More...

DataTypedata_type = DataType::INVALID

The type of data being imported. More...

DataVersiondata_version

Version of data contents. More...

ConfigurationSourcesource = ConfigurationSource::ACTIVE

The location of the data to update (active, saved, etc.). More...

Public Static Attributes Index​

static constexpr MessageTypeMESSAGE_TYPE = MessageType::IMPORT_DATA
static constexpr uint8_tMESSAGE_VERSION = 0

Description​

Import data from the host to the device (MessageType::IMPORT_DATA, version 1).

This message must be followed by data_length_bytes bytes containing the data to be imported:

 {MessageHeader, ImportDataMessage, Payload[data_length_bytes]}

Expected Response​

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

Definition at line 1408 of file configuration.h.

Public Member Attributes​

data_length_bytes​

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

Number of bytes to update.

Definition at line 1425 of file configuration.h.

1425 uint32_t data_length_bytes = 0;

data_type​

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

The type of data being imported.

Definition at line 1414 of file configuration.h.

1414 DataType data_type = DataType::INVALID;

data_version​

DataVersion point_one::fusion_engine::messages::ImportDataMessage::data_version

Version of data contents.

Definition at line 1422 of file configuration.h.

1422 DataVersion data_version;

source​

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

The location of the data to update (active, saved, etc.).

For data that doesn't have separate active and saved copies, this parameter is ignored.

Definition at line 1419 of file configuration.h.

1419 ConfigurationSource source = ConfigurationSource::ACTIVE;

Public Static Attributes​

MESSAGE_TYPE​

constexpr MessageType point_one::fusion_engine::messages::ImportDataMessage::MESSAGE_TYPE = MessageType::IMPORT_DATA
 constexpr static

Definition at line 1409 of file configuration.h.

1409 static constexpr MessageType MESSAGE_TYPE = MessageType::IMPORT_DATA;

MESSAGE_VERSION​

constexpr uint8_t point_one::fusion_engine::messages::ImportDataMessage::MESSAGE_VERSION = 0
 constexpr static

Definition at line 1410 of file configuration.h.

1410 static constexpr uint8_t MESSAGE_VERSION = 0;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.