configuration.h File Reference

Detailed Description

Device configuration settings control messages.

Definition in file configuration.h.

Go to the source code of this file.

Classes

struct  point_one::fusion_engine::messages::CoarseOrientation
 The orientation of a device with respect to the vehicle body axes. 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::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::InterfaceID
 Identifies an I/O interface. 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::PlatformStorageDataMessage
 Message for reporting platform storage data (MessageType::PLATFORM_STORAGE_DATA, version 1.0). More...
 
struct  point_one::fusion_engine::messages::Point3f
 A 3-dimensional vector (used for lever arms, etc.). 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::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::WheelConfig
 Software vehicle/wheel speed measurement configuration settings. More...
 

Namespaces

 point_one
 GNSS signal and frequency type definitions.
 
 point_one::fusion_engine
 
 point_one::fusion_engine::messages
 

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, point_one::fusion_engine::messages::ConfigurationSource::DEFAULT = 2 }
 The type of a device's configuration settings. 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, point_one::fusion_engine::messages::InterfaceConfigType::ENABLED = 5, point_one::fusion_engine::messages::InterfaceConfigType::DIRECTION = 6, point_one::fusion_engine::messages::InterfaceConfigType::SOCKET_TYPE = 7
}
 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, point_one::fusion_engine::messages::IonoDelayModel::SBAS = 3 }
 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_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, AppliedSpeedType applied_speed_type)
 AppliedSpeedType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, ConfigType type)
 ConfigType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, ConfigurationSource source)
 ConfigurationSource stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, InterfaceConfigType type)
 InterfaceConfigType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, IonoDelayModel iono_delay_model)
 IonoDelayModel stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, SaveAction action)
 SaveAction stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, SteeringType steering_type)
 SteeringType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, TickDirection tick_direction)
 TickDirection stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, TickMode tick_mode)
 TickMode stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, TropoDelayModel tropo_delay_model)
 TropoDelayModel stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, VehicleModel vehicle_model)
 VehicleModel stream operator. More...
 
p1_ostreampoint_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 (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 (IonoDelayModel iono_delay_model)
 
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 (TickDirection tick_direction)
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TickMode tick_mode)
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TropoDelayModel tropo_delay_model)
 
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

constexpr uint16_t point_one::fusion_engine::messages::ALL_MESSAGES_ID = 0xFFFF
 Setting message_id to this value acts as a wild card. More...
 
enum  point_one::fusion_engine::messages::DataType : uint8_t {
  point_one::fusion_engine::messages::DataType::CALIBRATION_STATE = 0, point_one::fusion_engine::messages::DataType::CRASH_LOG = 1, point_one::fusion_engine::messages::DataType::FILTER_STATE = 2, point_one::fusion_engine::messages::DataType::USER_CONFIG = 3,
  point_one::fusion_engine::messages::DataType::INVALID = 255
}
 Type of data stored on device. More...
 
enum  point_one::fusion_engine::messages::MessageRate : uint8_t {
  point_one::fusion_engine::messages::MessageRate::OFF = 0, point_one::fusion_engine::messages::MessageRate::ON_CHANGE = 1, point_one::fusion_engine::messages::MessageRate::MAX_RATE = 1, point_one::fusion_engine::messages::MessageRate::INTERVAL_10_MS = 2,
  point_one::fusion_engine::messages::MessageRate::INTERVAL_20_MS = 3, point_one::fusion_engine::messages::MessageRate::INTERVAL_40_MS = 4, point_one::fusion_engine::messages::MessageRate::INTERVAL_50_MS = 5, point_one::fusion_engine::messages::MessageRate::INTERVAL_100_MS = 6,
  point_one::fusion_engine::messages::MessageRate::INTERVAL_200_MS = 7, point_one::fusion_engine::messages::MessageRate::INTERVAL_500_MS = 8, point_one::fusion_engine::messages::MessageRate::INTERVAL_1_S = 9, point_one::fusion_engine::messages::MessageRate::INTERVAL_2_S = 10,
  point_one::fusion_engine::messages::MessageRate::INTERVAL_5_S = 11, point_one::fusion_engine::messages::MessageRate::INTERVAL_10_S = 12, point_one::fusion_engine::messages::MessageRate::INTERVAL_30_S = 13, point_one::fusion_engine::messages::MessageRate::INTERVAL_60_S = 14,
  point_one::fusion_engine::messages::MessageRate::DEFAULT = 255
}
 The output rate for a message type on an interface. More...
 
enum  point_one::fusion_engine::messages::NmeaMessageType : uint16_t {
  point_one::fusion_engine::messages::NmeaMessageType::INVALID = 0, point_one::fusion_engine::messages::NmeaMessageType::Standard NMEA Messages, point_one::fusion_engine::messages::NmeaMessageType::GGA = 1, point_one::fusion_engine::messages::NmeaMessageType::GLL = 2,
  point_one::fusion_engine::messages::NmeaMessageType::GSA = 3, point_one::fusion_engine::messages::NmeaMessageType::GSV = 4, point_one::fusion_engine::messages::NmeaMessageType::RMC = 5, point_one::fusion_engine::messages::NmeaMessageType::VTG = 6,
  point_one::fusion_engine::messages::NmeaMessageType::Point One Proprietary Messages, point_one::fusion_engine::messages::NmeaMessageType::P1CALSTATUS = 1000, point_one::fusion_engine::messages::NmeaMessageType::P1MSG = 1001, point_one::fusion_engine::messages::NmeaMessageType::Quectel Proprietary Messages,
  point_one::fusion_engine::messages::NmeaMessageType::PQTMVERNO = 1200, point_one::fusion_engine::messages::NmeaMessageType::PQTMVER = 1201, point_one::fusion_engine::messages::NmeaMessageType::PQTMGNSS = 1202, point_one::fusion_engine::messages::NmeaMessageType::PQTMVERNO_SUB = 1203,
  point_one::fusion_engine::messages::NmeaMessageType::PQTMVER_SUB = 1204, point_one::fusion_engine::messages::NmeaMessageType::PQTMTXT = 1205
}
 Integer ID for NMEA messages. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, DataType val)
 DataType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, InterfaceID val)
 InterfaceID stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, MessageRate val)
 MessageRate stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, NmeaMessageType val)
 NmeaMessageType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, ProtocolType val)
 ProtocolType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, SocketType val)
 SocketType stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, TransportDirection val)
 TransportDirection stream operator. More...
 
p1_ostreampoint_one::fusion_engine::messages::operator<< (p1_ostream &stream, TransportType val)
 TransportType stream operator. More...
 
enum  point_one::fusion_engine::messages::ProtocolType : uint8_t {
  point_one::fusion_engine::messages::ProtocolType::INVALID = 0, point_one::fusion_engine::messages::ProtocolType::FUSION_ENGINE = 1, point_one::fusion_engine::messages::ProtocolType::NMEA = 2, point_one::fusion_engine::messages::ProtocolType::RTCM = 3,
  point_one::fusion_engine::messages::ProtocolType::ALL = 0xFF
}
 The framing protocol of a message. More...
 
enum  point_one::fusion_engine::messages::SocketType : uint8_t { point_one::fusion_engine::messages::SocketType::INVALID = 0, point_one::fusion_engine::messages::SocketType::STREAM = 1, point_one::fusion_engine::messages::SocketType::DATAGRAM = 2, point_one::fusion_engine::messages::SocketType::SEQPACKET = 3 }
 The socket type specifying how data is transmitted for UNIX domain sockets. More...
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (DataType type)
 Get a string representation of a DataType. 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_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_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_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (SocketType val)
 Get a human-friendly string name for the specified SocketType. More...
 
P1_CONSTEXPR_FUNC const char * point_one::fusion_engine::messages::to_string (TransportDirection val)
 Get a human-friendly string name for the specified TransportDirection. 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...
 
enum  point_one::fusion_engine::messages::TransportDirection : uint8_t { point_one::fusion_engine::messages::TransportDirection::INVALID = 0, point_one::fusion_engine::messages::TransportDirection::SERVER = 1, point_one::fusion_engine::messages::TransportDirection::CLIENT = 2 }
 The direction (client/server) for an individual interface. More...
 
enum  point_one::fusion_engine::messages::TransportType : uint8_t {
  point_one::fusion_engine::messages::TransportType::INVALID = 0, point_one::fusion_engine::messages::TransportType::SERIAL = 1, point_one::fusion_engine::messages::TransportType::FILE = 2, point_one::fusion_engine::messages::TransportType::TCP = 4,
  point_one::fusion_engine::messages::TransportType::UDP = 5, point_one::fusion_engine::messages::TransportType::WEBSOCKET = 7, point_one::fusion_engine::messages::TransportType::UNIX = 8, point_one::fusion_engine::messages::TransportType::CURRENT = 254,
  point_one::fusion_engine::messages::TransportType::ALL = 255
}
 Type of I/O interface transport. More...