Device Configuration and Control Message Definitions

Messages for controlling device configuration and operation. More...

Classes
struct	point_one::fusion_engine::messages::CommandResponseMessage
	Response to indicate if command was processed successfully (MessageType::COMMAND_RESPONSE, version 1.0). More...
struct	point_one::fusion_engine::messages::ConfigDataMessage
	Response to a GetConfigMessage request (MessageType::CONFIG_DATA, version 1.0). More...
struct	point_one::fusion_engine::messages::EventNotificationMessage
	Notification of a system event for logging purposes (MessageType::EVENT_NOTIFICATION, version 1.0). More...
struct	point_one::fusion_engine::messages::GetConfigMessage
	Query the value of a user configuration parameter (MessageType::GET_CONFIG, version 1.0). More...
struct	point_one::fusion_engine::messages::MessageRequest
	Request transmission of a specified message type, (MessageType::MESSAGE_REQUEST, version 1.0). More...
struct	point_one::fusion_engine::messages::ResetRequest
	Perform a software or hardware reset (MessageType::RESET_REQUEST, version 1.0). More...
struct	point_one::fusion_engine::messages::SaveConfigMessage
	Save or reload configuration settings (MessageType::SAVE_CONFIG, version 1.0). More...
struct	point_one::fusion_engine::messages::SetConfigMessage
	Set a user configuration parameter (MessageType::SET_CONFIG, version 1.0). More...
struct	point_one::fusion_engine::messages::VersionInfoMessage
	Software and hardware version information, (MessageType::VERSION_INFO, version 1.0). More...

Enumerations
enum	point_one::fusion_engine::messages::ConfigType : uint16_t {   point_one::fusion_engine::messages::ConfigType::INVALID = 0, point_one::fusion_engine::messages::ConfigType::DEVICE_LEVER_ARM = 16, point_one::fusion_engine::messages::ConfigType::DEVICE_COARSE_ORIENTATION = 17, point_one::fusion_engine::messages::ConfigType::GNSS_LEVER_ARM = 18,   point_one::fusion_engine::messages::ConfigType::OUTPUT_LEVER_ARM = 19, point_one::fusion_engine::messages::ConfigType::UART0_BAUD = 256, point_one::fusion_engine::messages::ConfigType::UART1_BAUD = 257 }
	An identifier for the contents of a parameter configuration message. More...
enum	point_one::fusion_engine::messages::ConfigurationSource : uint8_t { point_one::fusion_engine::messages::ConfigurationSource::ACTIVE = 0, point_one::fusion_engine::messages::ConfigurationSource::SAVED = 1 }
	The type of a device's configuration settings. More...
enum	point_one::fusion_engine::messages::SaveAction : uint8_t { point_one::fusion_engine::messages::SaveAction::SAVE = 0, point_one::fusion_engine::messages::SaveAction::REVERT_TO_SAVED = 1, point_one::fusion_engine::messages::SaveAction::REVERT_TO_DEFAULT = 2 }
	The type configuration save operation to be performed. More...

Functions
std::ostream &	point_one::fusion_engine::messages::operator<< (std::ostream &stream, ConfigType type)
	ConfigType stream operator. More...
std::ostream &	point_one::fusion_engine::messages::operator<< (std::ostream &stream, ConfigurationSource source)
	ConfigurationSource stream operator. More...
std::ostream &	point_one::fusion_engine::messages::operator<< (std::ostream &stream, SaveAction action)
	SaveAction stream operator. More...
const char *	point_one::fusion_engine::messages::to_string (ConfigType type)
	Get a human-friendly string name for the specified ConfigType. More...
const char *	point_one::fusion_engine::messages::to_string (ConfigurationSource source)
	Get a human-friendly string name for the specified ConfigurationSource. More...
const char *	point_one::fusion_engine::messages::to_string (SaveAction action)
	Get a human-friendly string name for the specified SaveAction. More...

Detailed Description

Messages for controlling device configuration and operation.

When a configuration/control message is received, a device typically responds with either a CommandResponseMessage or another appropriate response. For example, a MessageRequest requesting MessageType::VERSION_INFO may result in a VersionInfoMessage response, or a CommandResponseMessage indicating that directly requesting version messages is not supported. See the documentation for the individual control messages for details on the expected response.

See also Message Definitions.

Enumeration Type Documentation

ConfigType

enum point_one::fusion_engine::messages::ConfigType : uint16_t

strong

An identifier for the contents of a parameter configuration message.

See also SetConfigMessage.

Enumerator
INVALID
DEVICE_LEVER_ARM	The location of the device IMU with respect to the vehicle body frame (in meters). Payload format: Point3f
DEVICE_COARSE_ORIENTATION	The orientation of the device IMU with respect to the vehicle body axes. Payload format: CoarseOrientation
GNSS_LEVER_ARM	The location of the GNSS antenna with respect to the vehicle body frame (in meters). Payload format: Point3f
OUTPUT_LEVER_ARM	The location of the desired output location with respect to the vehicle body frame (in meters). Payload format: Point3f
UART0_BAUD	Configure the UART0 serial baud rate (in bits/second). Payload format: uint32_t
UART1_BAUD	Configure the UART1 serial baud rate (in bits/second). Payload format: uint32_t

Definition at line 37 of file configuration.h.

ConfigurationSource

enum point_one::fusion_engine::messages::ConfigurationSource : uint8_t

strong

The type of a device's configuration settings.

Enumerator
ACTIVE	Active configuration currently in use by the device.
SAVED	Settings currently saved to persistent storage.

Definition at line 135 of file configuration.h.

SaveAction

enum point_one::fusion_engine::messages::SaveAction : uint8_t

strong

The type configuration save operation to be performed.

Enumerator
SAVE	Save all active parameters to persistent storage.
REVERT_TO_SAVED	Revert the active configuration to previously saved values.
REVERT_TO_DEFAULT	Reset the active and saved configuration to default values.

Definition at line 176 of file configuration.h.

Function Documentation

operator<<() [1/3]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream, ConfigType  type  )

inline

ConfigType stream operator.

Definition at line 126 of file configuration.h.

operator<<() [2/3]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream, ConfigurationSource  source  )

inline

ConfigurationSource stream operator.

Definition at line 166 of file configuration.h.

operator<<() [3/3]

std::ostream& point_one::fusion_engine::messages::operator<< ( std::ostream &  stream, SaveAction  action  )

inline

SaveAction stream operator.

Definition at line 213 of file configuration.h.

to_string() [1/3]

const char* point_one::fusion_engine::messages::to_string ( ConfigType  type )

inline

Get a human-friendly string name for the specified ConfigType.

Parameters

type	The desired configuration parameter type.

Returns

The corresponding string name.

Definition at line 94 of file configuration.h.

to_string() [2/3]

const char* point_one::fusion_engine::messages::to_string ( ConfigurationSource  source )

inline

Get a human-friendly string name for the specified ConfigurationSource.

Parameters

source

The desired configuration source.

Returns

The corresponding string name.

Definition at line 149 of file configuration.h.

to_string() [3/3]

const char* point_one::fusion_engine::messages::to_string ( SaveAction  action )

inline

Get a human-friendly string name for the specified SaveAction.

Parameters

action

The desired save operation.

Returns

The corresponding string name.

Definition at line 193 of file configuration.h.