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.

Modules
	System Fault Control
	Messages/types for controlling or simulating system faults.

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::ConfigResponseMessage
	Response to a GetConfigMessage request (MessageType::CONFIG_RESPONSE, version 1.0). More...

struct	point_one::fusion_engine::messages::DeviceIDMessage
	Device identifier information (MessageType::DEVICE_ID, 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::ExportDataMessage
	Export data from the device (MessageType::EXPORT_DATA, version 1.0). More...

struct	point_one::fusion_engine::messages::GetConfigMessage
	Query the value of a user configuration parameter (MessageType::GET_CONFIG, version 1.1). More...

struct	point_one::fusion_engine::messages::GetMessageRate
	Get the configured output rate for the he requested message type on the specified interface (MessageType::GET_MESSAGE_RATE, version 1.0). More...

struct	point_one::fusion_engine::messages::HardwareTickConfig
	Hardware wheel tick encoder configuration settings. More...

struct	point_one::fusion_engine::messages::HeadingBias
	Heading bias horizontal/vertical configuration settings. More...

struct	point_one::fusion_engine::messages::ImportDataMessage
	Import data from the host to the device (MessageType::IMPORT_DATA, version 1.0). More...

struct	point_one::fusion_engine::messages::InterfaceConfigSubmessage
	A submessage header for configuration data associated with the ConfigType::INTERFACE_CONFIG. More...

struct	point_one::fusion_engine::messages::IonosphereConfig
	Ionospheric delay model configuration. More...

struct	point_one::fusion_engine::messages::LBandConfig
	Configuration of the L-band demodulator parameters. More...

struct	point_one::fusion_engine::messages::MessageRateResponse
	Response to a GetMessageRate request (MessageType::MESSAGE_RATE_RESPONSE, version 1.1). More...

struct	point_one::fusion_engine::messages::MessageRateResponseEntry
	An element of a MessageRateResponse message. 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::PlatformStorageDataMessage
	Message for reporting platform storage data (MessageType::PLATFORM_STORAGE_DATA, 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::SetMessageRate
	Set the output rate for the requested message types (MessageType::SET_MESSAGE_RATE, version 1.0). More...

struct	point_one::fusion_engine::messages::ShutdownRequest
	Perform a device shutdown (MessageType::SHUTDOWN_REQUEST, version 1.0). More...

struct	point_one::fusion_engine::messages::StartupRequest
	Start up a device (MessageType::STARTUP_REQUEST, version 1.0). More...

struct	point_one::fusion_engine::messages::SupportedIOInterfacesMessage
	A list of transport interfaces supported by the device (MessageType::SUPPORTED_IO_INTERFACES, version 1.0). More...

struct	point_one::fusion_engine::messages::TroposphereConfig
	Tropospheric delay model configuration. More...

struct	point_one::fusion_engine::messages::VehicleDetails
	Information about the vehicle including model and dimensions. More...

struct	point_one::fusion_engine::messages::VersionInfoMessage
	Software version information, (MessageType::VERSION_INFO, version 1.0). More...

struct	point_one::fusion_engine::messages::WheelConfig
	Software vehicle/wheel speed measurement configuration settings. More...

Enumerations
enum	point_one::fusion_engine::messages::AppliedSpeedType : uint8_t { point_one::fusion_engine::messages::AppliedSpeedType::NONE = 0, point_one::fusion_engine::messages::AppliedSpeedType::REAR_WHEELS = 1, point_one::fusion_engine::messages::AppliedSpeedType::FRONT_WHEELS = 2, point_one::fusion_engine::messages::AppliedSpeedType::FRONT_AND_REAR_WHEELS = 3, point_one::fusion_engine::messages::AppliedSpeedType::VEHICLE_BODY = 4 }
	The type of vehicle/wheel speed measurements to be applied. More...

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::VEHICLE_DETAILS = 20, point_one::fusion_engine::messages::ConfigType::WHEEL_CONFIG = 21, point_one::fusion_engine::messages::ConfigType::HARDWARE_TICK_CONFIG = 22, point_one::fusion_engine::messages::ConfigType::HEADING_BIAS = 23, point_one::fusion_engine::messages::ConfigType::ENABLED_GNSS_SYSTEMS = 50, point_one::fusion_engine::messages::ConfigType::ENABLED_GNSS_FREQUENCY_BANDS = 51, point_one::fusion_engine::messages::ConfigType::LEAP_SECOND = 52, point_one::fusion_engine::messages::ConfigType::GPS_WEEK_ROLLOVER = 53, point_one::fusion_engine::messages::ConfigType::IONOSPHERE_CONFIG = 54, point_one::fusion_engine::messages::ConfigType::TROPOSPHERE_CONFIG = 55, point_one::fusion_engine::messages::ConfigType::INTERFACE_CONFIG = 200, point_one::fusion_engine::messages::ConfigType::UART1_BAUD = 256, point_one::fusion_engine::messages::ConfigType::UART2_BAUD = 257, point_one::fusion_engine::messages::ConfigType::UART1_OUTPUT_DIAGNOSTICS_MESSAGES = 258, point_one::fusion_engine::messages::ConfigType::UART2_OUTPUT_DIAGNOSTICS_MESSAGES = 259, point_one::fusion_engine::messages::ConfigType::ENABLE_WATCHDOG_TIMER = 300, point_one::fusion_engine::messages::ConfigType::USER_DEVICE_ID = 301, point_one::fusion_engine::messages::ConfigType::LBAND_PARAMETERS = 1024 }
	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::DeviceType : uint8_t { point_one::fusion_engine::messages::DeviceType::UNKNOWN = 0, point_one::fusion_engine::messages::DeviceType::ATLAS = 1, point_one::fusion_engine::messages::DeviceType::LG69T_AM = 2, point_one::fusion_engine::messages::DeviceType::LG69T_AP = 3, point_one::fusion_engine::messages::DeviceType::LG69T_AH = 4 }
	Identifies a FusionEngine device. More...

enum	point_one::fusion_engine::messages::InterfaceConfigType : uint8_t { point_one::fusion_engine::messages::InterfaceConfigType::INVALID = 0, point_one::fusion_engine::messages::InterfaceConfigType::OUTPUT_DIAGNOSTICS_MESSAGES = 1, point_one::fusion_engine::messages::InterfaceConfigType::BAUD_RATE = 2, point_one::fusion_engine::messages::InterfaceConfigType::REMOTE_ADDRESS = 3, point_one::fusion_engine::messages::InterfaceConfigType::PORT = 4 }
	An identifier for the contents of a output interface configuration submessage. More...

enum	point_one::fusion_engine::messages::IonoDelayModel : uint8_t { point_one::fusion_engine::messages::IonoDelayModel::AUTO = 0, point_one::fusion_engine::messages::IonoDelayModel::OFF = 1, point_one::fusion_engine::messages::IonoDelayModel::KLOBUCHAR = 2 }
	The ionospheric delay model to use. 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...

enum	point_one::fusion_engine::messages::SteeringType : uint8_t { point_one::fusion_engine::messages::SteeringType::UNKNOWN = 0, point_one::fusion_engine::messages::SteeringType::FRONT = 1, point_one::fusion_engine::messages::SteeringType::FRONT_AND_REAR = 2 }
	Indication of which of the vehicle's wheels are steered. More...

enum	point_one::fusion_engine::messages::TickDirection : uint8_t { point_one::fusion_engine::messages::TickDirection::OFF = 0, point_one::fusion_engine::messages::TickDirection::FORWARD_ACTIVE_HIGH = 1, point_one::fusion_engine::messages::TickDirection::FORWARD_ACTIVE_LOW = 2 }
	The way to interpret an incoming voltage signal, used to indicate direction of a hardware wheel tick pulse, if available. More...

enum	point_one::fusion_engine::messages::TickMode : uint8_t { point_one::fusion_engine::messages::TickMode::OFF = 0, point_one::fusion_engine::messages::TickMode::RISING_EDGE = 1, point_one::fusion_engine::messages::TickMode::FALLING_EDGE = 2 }
	The signal edge to use when capturing a wheel tick voltage signal. More...

enum	point_one::fusion_engine::messages::TropoDelayModel : uint8_t { point_one::fusion_engine::messages::TropoDelayModel::AUTO = 0, point_one::fusion_engine::messages::TropoDelayModel::OFF = 1, point_one::fusion_engine::messages::TropoDelayModel::SAASTAMOINEN = 2 }
	The tropospheric delay model to use. More...

enum	point_one::fusion_engine::messages::VehicleModel : uint16_t { point_one::fusion_engine::messages::VehicleModel::UNKNOWN_VEHICLE = 0, point_one::fusion_engine::messages::VehicleModel::DATASPEED_CD4 = 1, point_one::fusion_engine::messages::VehicleModel::J1939 = 2, point_one::fusion_engine::messages::VehicleModel::LEXUS_CT200H = 20, point_one::fusion_engine::messages::VehicleModel::KIA_SORENTO = 40, point_one::fusion_engine::messages::VehicleModel::KIA_SPORTAGE = 41, point_one::fusion_engine::messages::VehicleModel::AUDI_Q7 = 60, point_one::fusion_engine::messages::VehicleModel::AUDI_A8L = 61, point_one::fusion_engine::messages::VehicleModel::TESLA_MODEL_X = 80, point_one::fusion_engine::messages::VehicleModel::TESLA_MODEL_3 = 81, point_one::fusion_engine::messages::VehicleModel::HYUNDAI_ELANTRA = 100, point_one::fusion_engine::messages::VehicleModel::PEUGEOT_206 = 120, point_one::fusion_engine::messages::VehicleModel::MAN_TGX = 140, point_one::fusion_engine::messages::VehicleModel::FACTION = 160, point_one::fusion_engine::messages::VehicleModel::LINCOLN_MKZ = 180, point_one::fusion_engine::messages::VehicleModel::BMW_7 = 200, point_one::fusion_engine::messages::VehicleModel::BMW_MOTORRAD = 201, point_one::fusion_engine::messages::VehicleModel::VW_4 = 220, point_one::fusion_engine::messages::VehicleModel::RIVIAN = 240 }
	The make and model of the vehicle. More...

enum	point_one::fusion_engine::messages::WheelSensorType : uint8_t { point_one::fusion_engine::messages::WheelSensorType::NONE = 0, point_one::fusion_engine::messages::WheelSensorType::TICKS = 2, point_one::fusion_engine::messages::WheelSensorType::WHEEL_SPEED = 3, point_one::fusion_engine::messages::WheelSensorType::VEHICLE_SPEED = 4, point_one::fusion_engine::messages::WheelSensorType::VEHICLE_TICKS = 5 }
	The type of vehicle/wheel speed measurements produced by the vehicle. More...

Functions
p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, AppliedSpeedType applied_speed_type)
	AppliedSpeedType stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, ConfigType type)
	ConfigType stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, ConfigurationSource source)
	ConfigurationSource stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, InterfaceConfigType type)
	InterfaceConfigType stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, IonoDelayModel iono_delay_model)
	IonoDelayModel stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, SaveAction action)
	SaveAction stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, SteeringType steering_type)
	SteeringType stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, TickDirection tick_direction)
	TickDirection stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, TickMode tick_mode)
	TickMode stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, TropoDelayModel tropo_delay_model)
	TropoDelayModel stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, VehicleModel vehicle_model)
	VehicleModel stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, WheelSensorType wheel_sensor_type)
	WheelSensorType stream operator. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (AppliedSpeedType applied_speed_type)
	Get a human-friendly string name for the specified AppliedSpeedType. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (ConfigType type)
	Get a human-friendly string name for the specified ConfigType. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (ConfigurationSource source)
	Get a human-friendly string name for the specified ConfigurationSource. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (DeviceType val)
	Get a human-friendly string name for the specified DeviceType. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (InterfaceConfigType type)
	Get a human-friendly string name for the specified ConfigType. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (SaveAction action)
	Get a human-friendly string name for the specified SaveAction. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (SteeringType steering_type)
	Get a human-friendly string name for the specified SteeringType. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (VehicleModel vehicle_model)
	Get a human-friendly string name for the specified VehicleModel. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (WheelSensorType wheel_sensor_type)
	Get a human-friendly string name for the specified WheelSensorType. More...

Input/Output Stream Control
P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (ProtocolType val)
	Get a human-friendly string name for the specified ProtocolType. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, ProtocolType val)
	ProtocolType stream operator. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (TransportType val)
	Get a human-friendly string name for the specified TransportType. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, TransportType val)
	TransportType stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, InterfaceID val)
	InterfaceID stream operator. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (NmeaMessageType value)
	Get a human-friendly string name for the specified NmeaMessageType. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, NmeaMessageType val)
	NmeaMessageType stream operator. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (MessageRate value)
	Get a human-friendly string name for the specified MessageRate. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, MessageRate val)
	MessageRate stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, DataType val)
	DataType stream operator. More...

Enumeration Type Documentation

◆ AppliedSpeedType

enum point_one::fusion_engine::messages::AppliedSpeedType : uint8_t

strong

The type of vehicle/wheel speed measurements to be applied.

Enumerator
NONE	Speed data not applied to the system.
REAR_WHEELS	Rear wheel speed data to be applied to the system (recommended).
FRONT_WHEELS	Front wheel speed data to be applied to the system.
FRONT_AND_REAR_WHEELS	Front and rear wheel speed data to be applied to the system.
VEHICLE_BODY	Individual vehicle speed to be applied to the system.

Definition at line 940 of file configuration.h.

◆ ConfigType

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

strong

An identifier for the contents of a parameter configuration message.

◆ 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 442 of file configuration.h.

◆ DeviceType

enum point_one::fusion_engine::messages::DeviceType : uint8_t

strong

Identifies a FusionEngine device.

Enumerator
UNKNOWN	Unable to map device to a defined entry.
ATLAS	Device is a Point One Atlas.
LG69T_AM	Device is a Quectel LG69T-AM system.
LG69T_AP	Device is a Quectel LG69T-AP system.
LG69T_AH	Device is a Quectel LG69T-AH system.

Definition at line 375 of file control.h.

◆ InterfaceConfigType

enum point_one::fusion_engine::messages::InterfaceConfigType : uint8_t

strong

An identifier for the contents of a output interface configuration submessage.

◆ IonoDelayModel

enum point_one::fusion_engine::messages::IonoDelayModel : uint8_t

strong

The ionospheric delay model to use.

Enumerator
AUTO	Select the best available ionospheric delay model.
OFF	Ionospheric delay model disabled.
KLOBUCHAR	Use the Klobuchar ionospheric model.

Definition at line 1346 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 482 of file configuration.h.

◆ SteeringType

enum point_one::fusion_engine::messages::SteeringType : uint8_t

strong

Indication of which of the vehicle's wheels are steered.

Enumerator
UNKNOWN	Steered wheels unknown.
FRONT	Front wheels are steered.
FRONT_AND_REAR	Front and rear wheels are steered.

Definition at line 1000 of file configuration.h.

◆ TickDirection

enum point_one::fusion_engine::messages::TickDirection : uint8_t

strong

The way to interpret an incoming voltage signal, used to indicate direction of a hardware wheel tick pulse, if available.

Enumerator
OFF	Wheel tick direction not provided.
FORWARD_ACTIVE_HIGH	Assume vehicle is moving forward when direction signal voltage is high, and backward when direction signal is low.
FORWARD_ACTIVE_LOW	Assume vehicle is moving forward when direction signal voltage is low, and backward when direction signal is high.

Definition at line 1209 of file configuration.h.

◆ TickMode

enum point_one::fusion_engine::messages::TickMode : uint8_t

strong

The signal edge to use when capturing a wheel tick voltage signal.

Enumerator
OFF	Wheel tick capture disabled.
RISING_EDGE	Capture a wheel tick on the rising edge of the incoming pulse.
FALLING_EDGE	Capture a wheel tick on the falling edge of the incoming pulse.

Definition at line 1173 of file configuration.h.

◆ TropoDelayModel

enum point_one::fusion_engine::messages::TropoDelayModel : uint8_t

strong

The tropospheric delay model to use.

Enumerator
AUTO	Select the best available tropospheric delay model.
OFF	Tropospheric delay model disabled.
SAASTAMOINEN	Use the Saastamoinen tropospheric model.

Definition at line 1393 of file configuration.h.

◆ VehicleModel

enum point_one::fusion_engine::messages::VehicleModel : uint16_t

strong

The make and model of the vehicle.

Enumerator
UNKNOWN_VEHICLE
DATASPEED_CD4
J1939
LEXUS_CT200H
KIA_SORENTO
KIA_SPORTAGE
AUDI_Q7
AUDI_A8L
TESLA_MODEL_X
TESLA_MODEL_3
HYUNDAI_ELANTRA
PEUGEOT_206
MAN_TGX
FACTION
LINCOLN_MKZ
BMW_7
BMW_MOTORRAD
VW_4
RIVIAN

Definition at line 741 of file configuration.h.

◆ WheelSensorType

enum point_one::fusion_engine::messages::WheelSensorType : uint8_t

strong

The type of vehicle/wheel speed measurements produced by the vehicle.

Enumerator
NONE	Wheel/vehicle speed data not available.
TICKS	Individual rotational angle measurements for multiple wheels, reported as accumulated encoder ticks. See WheelTickInput.
WHEEL_SPEED	Individual speed measurements for multiple wheels, reported in meters/second. See WheelSpeedInput.
VEHICLE_SPEED	A single value indicating the vehicle speed (in meters/second). See VehicleSpeedInput.
VEHICLE_TICKS	A single wheel rotational angle, reported as accumulated encoder ticks. See VehicleSpeedInput.

Definition at line 867 of file configuration.h.

Function Documentation

◆ operator<<() [1/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		AppliedSpeedType	applied_speed_type
	)

inline

AppliedSpeedType stream operator.

Definition at line 989 of file configuration.h.

◆ operator<<() [2/18]

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

inline

ConfigType stream operator.

Definition at line 334 of file configuration.h.

◆ operator<<() [3/18]

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

inline

ConfigurationSource stream operator.

Definition at line 473 of file configuration.h.

◆ operator<<() [4/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		DataType	val
	)

inline

DataType stream operator.

Definition at line 2200 of file configuration.h.

◆ operator<<() [5/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		InterfaceConfigType	type
	)

inline

InterfaceConfigType stream operator.

Definition at line 433 of file configuration.h.

◆ operator<<() [6/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		InterfaceID	val
	)

inline

InterfaceID stream operator.

Definition at line 1661 of file configuration.h.

◆ operator<<() [7/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		IonoDelayModel	iono_delay_model
	)

inline

IonoDelayModel stream operator.

Definition at line 1372 of file configuration.h.

◆ operator<<() [8/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		MessageRate	val
	)

inline

MessageRate stream operator.

Definition at line 1897 of file configuration.h.

◆ operator<<() [9/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		NmeaMessageType	val
	)

inline

NmeaMessageType stream operator.

Definition at line 1755 of file configuration.h.

◆ operator<<() [10/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		ProtocolType	val
	)

inline

ProtocolType stream operator.

Definition at line 1530 of file configuration.h.

◆ operator<<() [11/18]

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

inline

SaveAction stream operator.

Definition at line 519 of file configuration.h.

◆ operator<<() [12/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		SteeringType	steering_type
	)

inline

SteeringType stream operator.

Definition at line 1038 of file configuration.h.

◆ operator<<() [13/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		TickDirection	tick_direction
	)

inline

TickDirection stream operator.

Definition at line 1241 of file configuration.h.

◆ operator<<() [14/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		TickMode	tick_mode
	)

inline

TickMode stream operator.

Definition at line 1199 of file configuration.h.

◆ operator<<() [15/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		TransportType	val
	)

inline

TransportType stream operator.

Definition at line 1602 of file configuration.h.

◆ operator<<() [16/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		TropoDelayModel	tropo_delay_model
	)

inline

TropoDelayModel stream operator.

Definition at line 1419 of file configuration.h.

◆ operator<<() [17/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		VehicleModel	vehicle_model
	)

inline

VehicleModel stream operator.

Definition at line 840 of file configuration.h.

◆ operator<<() [18/18]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		WheelSensorType	wheel_sensor_type
	)

inline

WheelSensorType stream operator.

Definition at line 929 of file configuration.h.

◆ to_string() [1/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( AppliedSpeedType applied_speed_type )

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

Parameters

applied_speed_type The desired applied speed type.

Returns: The corresponding string name.

Definition at line 962 of file configuration.h.

◆ to_string() [2/13]

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

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 255 of file configuration.h.

◆ to_string() [3/13]

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

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

Parameters

source The desired configuration source.

Returns: The corresponding string name.

Definition at line 456 of file configuration.h.

◆ to_string() [4/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( DeviceType val )

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

Parameters

val	The enum to get the string name for.

Returns: The corresponding string name.

Definition at line 396 of file control.h.

◆ to_string() [5/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( InterfaceConfigType type )

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 407 of file configuration.h.

◆ to_string() [6/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( MessageRate value )

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

Parameters

value The enum to get the string name for.

Returns: The corresponding string name.

Definition at line 1854 of file configuration.h.

◆ to_string() [7/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( NmeaMessageType value )

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

Parameters

value The enum to get the string name for.

Returns: The corresponding string name.

Definition at line 1714 of file configuration.h.

◆ to_string() [8/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( ProtocolType val )

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

Parameters

val	The enum to get the string name for.

Returns: The corresponding string name.

Definition at line 1509 of file configuration.h.

◆ to_string() [9/13]

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

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

Parameters

action The desired save operation.

Returns: The corresponding string name.

Definition at line 499 of file configuration.h.

◆ to_string() [10/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( SteeringType steering_type )

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

Parameters

steering_type The desired steering type.

Returns: The corresponding string name.

Definition at line 1017 of file configuration.h.

◆ to_string() [11/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( TransportType val )

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

Parameters

val	The enum to get the string name for.

Returns: The corresponding string name.

Definition at line 1572 of file configuration.h.

◆ to_string() [12/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( VehicleModel vehicle_model )

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

Parameters

vehicle_model The desired vehicle model.

Returns: The corresponding string name.

Definition at line 791 of file configuration.h.

◆ to_string() [13/13]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( WheelSensorType wheel_sensor_type )

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

Parameters

wheel_sensor_type The desired wheel sensor type.

Returns: The corresponding string name.

Definition at line 902 of file configuration.h.

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 offset of the desired output location with respect to the vehicle body frame (in meters). Payload format: Point3f
VEHICLE_DETAILS	Information about the vehicle including model and dimensions. Payload format: VehicleDetails
WHEEL_CONFIG	Information pertaining to wheel speed/rotation measurements when wheel data is transmitted via software. Note For hardware wheel tick voltage capture, use ConfigType::HARDWARE_TICK_CONFIG instead. Payload format: WheelConfig
HARDWARE_TICK_CONFIG	Indicates the mode and direction used when capturing vehicle wheel tick data from a voltage pulse on an I/O pin. Note For software wheel tick capture (wheel ticks sent as FusionEngine messages or on a CAN bus), use ConfigType::WHEEL_CONFIG instead. Payload format: HardwareTickConfig
HEADING_BIAS	Used to set horizontal (yaw) & vertical (pitch) biases (in degrees) on a dual-antenna heading platform configuration. Payload format: HeadingBias
ENABLED_GNSS_SYSTEMS	A bitmask indicating which GNSS constellations are enabled. Payload format: `uint32_t` (see SatelliteType Bitmask Support)
ENABLED_GNSS_FREQUENCY_BANDS	A bitmask indicating which GNSS frequency bands are enabled. Payload format: `uint32_t` (see FrequencyBand Bitmask Support)
LEAP_SECOND	Specify a UTC leap second count override value to use for all UTC time conversions. Setting this value will disable all internal leap second sources, including data received from the GNSS almanac decoded from available signals. Set to -1 to disable leap second override and re-enable internal leap second handling. Payload format: `int32_t`
GPS_WEEK_ROLLOVER	Specify a GPS legacy week rollover count override to use when converting all legacy 10-bit GPS week numbers. Setting this value will disable all internal week rollover sources, including data received from modern GPS navigation messages (CNAV, CNAV2) or non-GPS constellations. Set to -1 to disable week rollover override and re-enable internal handling. Payload format: `int32_t`
IONOSPHERE_CONFIG	Ionospheric delay model configuration. Payload format: IonosphereConfig
TROPOSPHERE_CONFIG	Tropospheric delay model configuration. Payload format: TroposphereConfig
INTERFACE_CONFIG	Change a configuration setting for a specified output interface. Payload format: `InterfaceConfigSubmessage`
UART1_BAUD	Configure the UART1 serial baud rate (in bits/second). Deprecated: The ConfigType::INTERFACE_CONFIG type combined with InterfaceConfigType::BAUD_RATE in the InterfaceConfigSubmessage should be used to configure this value going forward. Payload format: `uint32_t`
UART2_BAUD	Configure the UART2 serial baud rate (in bits/second). Deprecated: The ConfigType::INTERFACE_CONFIG type combined with InterfaceConfigType::BAUD_RATE in the InterfaceConfigSubmessage should be used to configure this value going forward. Payload format: `uint32_t`
UART1_OUTPUT_DIAGNOSTICS_MESSAGES	Enable/disable output of diagnostic data on UART1. Deprecated: The ConfigType::INTERFACE_CONFIG type combined with InterfaceConfigType::OUTPUT_DIAGNOSTICS_MESSAGES in the InterfaceConfigSubmessage should be used to configure this value going forward. Note Enabling this setting will override the message rate/off settings for some FusionEngine messages. Payload format: `bool`
UART2_OUTPUT_DIAGNOSTICS_MESSAGES	Enable/disable output of diagnostic data on UART2. Deprecated: The ConfigType::INTERFACE_CONFIG type combined with InterfaceConfigType::OUTPUT_DIAGNOSTICS_MESSAGES in the InterfaceConfigSubmessage should be used to configure this value going forward. Note Enabling this setting will override the message rate/off settings for some FusionEngine messages. Payload format: `bool`
ENABLE_WATCHDOG_TIMER	Enable watchdog timer to restart device after fatal errors. Payload format: `bool`
USER_DEVICE_ID	A string for identifying a device. This is a string of ASCII characters padded to 32 bytes with `NULL`. Payload format: `char[32]`
LBAND_PARAMETERS	Configuration of L-band Demodulator Parameters. Note This setting is only available on devices with an L-band receiver. Payload format: LBandConfig

Enumerator
INVALID
OUTPUT_DIAGNOSTICS_MESSAGES	Enable/disable output of diagnostic data on this interface. Valid for: All TransportType Note Enabling this setting will override the message rate/off settings for some FusionEngine messages. Payload format: `bool`
BAUD_RATE	Configure the serial baud rate (in bits/second). Valid for: TransportType::SERIAL Payload format: `uint32_t`
REMOTE_ADDRESS	Configure the network address for a client to connect to. Valid for: TransportType::TCP_CLIENT TransportType::UDP_CLIENT Payload format: `char[64]` containing a NULL terminated string.
PORT	Configure the network port. Valid for: TransportType::TCP_CLIENT TransportType::TCP_SERVER TransportType::UDP_CLIENT TransportType::UDP_SERVER TransportType::WEBSOCKET_SERVER Payload format: `uint16_t`

Detailed Description

Modules

Classes

Enumerations

Functions

Input/Output Stream Control

Enumeration Type Documentation

◆ AppliedSpeedType

◆ ConfigType

◆ ConfigurationSource

◆ DeviceType

◆ InterfaceConfigType

◆ IonoDelayModel

◆ SaveAction

◆ SteeringType

◆ TickDirection

◆ TickMode

◆ TropoDelayModel

◆ VehicleModel

◆ WheelSensorType

Function Documentation

◆ operator<<() [1/18]

◆ operator<<() [2/18]

◆ operator<<() [3/18]

◆ operator<<() [4/18]

◆ operator<<() [5/18]

◆ operator<<() [6/18]

◆ operator<<() [7/18]

◆ operator<<() [8/18]

◆ operator<<() [9/18]

◆ operator<<() [10/18]

◆ operator<<() [11/18]

◆ operator<<() [12/18]

◆ operator<<() [13/18]

◆ operator<<() [14/18]

◆ operator<<() [15/18]

◆ operator<<() [16/18]

◆ operator<<() [17/18]

◆ operator<<() [18/18]

◆ to_string() [1/13]

◆ to_string() [2/13]

◆ to_string() [3/13]

◆ to_string() [4/13]

◆ to_string() [5/13]

◆ to_string() [6/13]

◆ to_string() [7/13]

◆ to_string() [8/13]

◆ to_string() [9/13]

◆ to_string() [10/13]

◆ to_string() [11/13]

◆ to_string() [12/13]

◆ to_string() [13/13]