Classes | Namespaces | Enumerations | Functions
configuration.h File Reference

Device configuration settings control messages. More...

#include <ostream>
#include "point_one/fusion_engine/messages/defs.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::GetConfigMessage
 Query the value of a user configuration parameter (MessageType::GET_CONFIG, version 1.0). More...
 
struct  point_one::fusion_engine::messages::GetMessageOutputRate
 Get the configured output rate for the he requested message type on the specified interface. More...
 
struct  point_one::fusion_engine::messages::GetOutputInterfaceConfigMessage
 Query the set of message streams configured to be output by the device on a specified interface. More...
 
struct  point_one::fusion_engine::messages::HardwareTickConfig
 Hardware wheel encoder configuration settings. More...
 
struct  point_one::fusion_engine::messages::InterfaceID
 Identifies an IO interface. More...
 
struct  point_one::fusion_engine::messages::MessageOutputRateResponse
 The requested output rate. More...
 
struct  point_one::fusion_engine::messages::OutputInterfaceConfigEntry
 Configuration for the streams associated with a single output interface. More...
 
struct  point_one::fusion_engine::messages::OutputInterfaceConfigResponseMessage
 Response to a GetOutputInterfaceConfigMessage request (MessageType::OUTPUT_INTERFACE_CONFIG_RESPONSE, 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::SetMessageOutputRate
 Set the output rate for the requested message type on the specified interface. More...
 
struct  point_one::fusion_engine::messages::SetOutputInterfaceConfigMessage
 Configure the set of output streams enabled for a given output interface (MessageType::SET_OUTPUT_INTERFACE_CONFIG, version 1.0). More...
 
struct  point_one::fusion_engine::messages::VehicleDetails
 Information about the vehicle including model and dimensions. More...
 
struct  point_one::fusion_engine::messages::WheelConfig
 Vehicle/wheel speed measurement configuration settings. More...
 

Namespaces

 point_one
 
 point_one::fusion_engine
 
 point_one::fusion_engine::messages
 

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::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::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
}
 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...
 

Configuration Settings Type Definitions

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...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, AppliedSpeedType applied_speed_type)
 AppliedSpeedType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, SteeringType steering_type)
 SteeringType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, TickDirection tick_direction)
 TickDirection stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, TickMode tick_mode)
 TickMode stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, VehicleModel vehicle_model)
 VehicleModel stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, WheelSensorType wheel_sensor_type)
 WheelSensorType stream operator. 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...
 
const char * point_one::fusion_engine::messages::to_string (AppliedSpeedType applied_speed_type)
 Get a human-friendly string name for the specified AppliedSpeedType. More...
 
const char * point_one::fusion_engine::messages::to_string (SteeringType steering_type)
 Get a human-friendly string name for the specified SteeringType. More...
 
const char * point_one::fusion_engine::messages::to_string (TickDirection tick_direction)
 
const char * point_one::fusion_engine::messages::to_string (TickMode tick_mode)
 
const char * point_one::fusion_engine::messages::to_string (VehicleModel vehicle_model)
 Get a human-friendly string name for the specified VehicleModel. More...
 
const char * point_one::fusion_engine::messages::to_string (WheelSensorType wheel_sensor_type)
 Get a human-friendly string name for the specified WheelSensorType. 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
}
 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::TICK_RATE = 1, 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...
 

Input/Output Stream Control

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::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
}
 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
}
 Integer ID for NMEA messages. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, InterfaceID val)
 InterfaceID stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, MessageRate val)
 MessageRate stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, NmeaMessageType val)
 NmeaMessageType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, ProtocolType val)
 ProtocolType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, TransportType val)
 TransportType stream operator. More...
 
std::ostream & point_one::fusion_engine::messages::operator<< (std::ostream &stream, UpdateAction val)
 UpdateAction 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 }
 The framing protocol of a message. More...
 
const char * point_one::fusion_engine::messages::to_string (MessageRate value)
 Get a human-friendly string name for the specified MessageRate. More...
 
const char * point_one::fusion_engine::messages::to_string (NmeaMessageType value)
 Get a human-friendly string name for the specified NmeaMessageType. More...
 
const char * point_one::fusion_engine::messages::to_string (ProtocolType val)
 Get a human-friendly string name for the specified ProtocolType. More...
 
const char * point_one::fusion_engine::messages::to_string (TransportType val)
 Get a human-friendly string name for the specified TransportType. More...
 
const char * point_one::fusion_engine::messages::to_string (UpdateAction val)
 Get a human-friendly string name for the specified UpdateAction. 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_CLIENT = 3,
  point_one::fusion_engine::messages::TransportType::TCP_SERVER = 4, point_one::fusion_engine::messages::TransportType::UDP_CLIENT = 5, point_one::fusion_engine::messages::TransportType::UDP_SERVER = 6, point_one::fusion_engine::messages::TransportType::ALL = 255
}
 Type of IO interface transport. More...
 
enum  point_one::fusion_engine::messages::UpdateAction : uint8_t { point_one::fusion_engine::messages::UpdateAction::REPLACE = 0 }
 The ways that this configuration message can be applied to the previous list of values for that configuration type. More...
 

Detailed Description

Device configuration settings control messages.

Definition in file configuration.h.

Generated by   doxygen 1.8.18