Messages for controlling device configuration and operation.
More...
|
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::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::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::MessageOutputRateResponse |
| The requested output rate. 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::OutputInterfaceConfigResponseMessage |
| Response to a GetOutputInterfaceConfigMessage request (MessageType::OUTPUT_INTERFACE_CONFIG_RESPONSE, 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::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::ShutdownRequest |
| Perform a device shutdown (MessageType::SHUTDOWN_REQUEST, 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::VersionInfoMessage |
| Software and hardware version information, (MessageType::VERSION_INFO, version 1.0). More...
|
|
struct | point_one::fusion_engine::messages::WheelConfig |
| Vehicle/wheel speed measurement configuration settings. 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::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...
|
|
|
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...
|
|
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::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::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::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...
|
|
const char * | point_one::fusion_engine::messages::to_string (VehicleModel vehicle_model) |
| Get a human-friendly string name for the specified VehicleModel. More...
|
|
std::ostream & | point_one::fusion_engine::messages::operator<< (std::ostream &stream, VehicleModel vehicle_model) |
| VehicleModel stream operator. 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...
|
|
std::ostream & | point_one::fusion_engine::messages::operator<< (std::ostream &stream, WheelSensorType wheel_sensor_type) |
| WheelSensorType stream operator. 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...
|
|
std::ostream & | point_one::fusion_engine::messages::operator<< (std::ostream &stream, AppliedSpeedType applied_speed_type) |
| AppliedSpeedType stream operator. More...
|
|
const char * | point_one::fusion_engine::messages::to_string (SteeringType steering_type) |
| Get a human-friendly string name for the specified SteeringType. 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, TickMode tick_mode) |
| TickMode stream operator. More...
|
|
std::ostream & | point_one::fusion_engine::messages::operator<< (std::ostream &stream, TickDirection tick_direction) |
| TickDirection stream operator. More...
|
|
const char * | point_one::fusion_engine::messages::to_string (TickMode tick_mode) |
|
const char * | point_one::fusion_engine::messages::to_string (TickDirection tick_direction) |
|
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.
◆ AppliedSpeedType
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 658 of file configuration.h.
◆ ConfigType
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 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.
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.
Payload format: HardwareTickConfig
|
UART1_BAUD | Configure the UART1 serial baud rate (in bits/second).
Payload format: uint32_t
|
UART2_BAUD | Configure the UART2 serial baud rate (in bits/second).
Payload format: uint32_t
|
UART1_OUTPUT_DIAGNOSTICS_MESSAGES | Force output the diagnostic message set on UART1.
Payload format: bool
|
UART2_OUTPUT_DIAGNOSTICS_MESSAGES | Force output the diagnostic message set on UART2.
Payload format: bool
|
ENABLE_WATCHDOG_TIMER | Enable watchdog timer to restart device after fatal errors.
Payload format: bool
|
Definition at line 37 of file configuration.h.
◆ ConfigurationSource
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 196 of file configuration.h.
◆ SaveAction
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 237 of file configuration.h.
◆ SteeringType
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 718 of file configuration.h.
◆ TickDirection
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 887 of file configuration.h.
◆ TickMode
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 851 of file configuration.h.
◆ VehicleModel
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 | |
Definition at line 470 of file configuration.h.
◆ WheelSensorType
The type of vehicle/wheel speed measurements produced by the vehicle.
Enumerator |
---|
NONE | Wheel/vehicle speed data not available.
|
TICK_RATE | Individual wheel rotation rates, reported as an encoder tick rate (in ticks/second).
Will be scaled to meters/second using the specified scale factor.
|
TICKS | Individual wheel rotational angles, reported as accumulated encoder ticks.
|
WHEEL_SPEED | Individual wheel speeds, reported in meters/second.
|
VEHICLE_SPEED | A single value indicating the vehicle speed (in meters/second).
|
VEHICLE_TICKS | A single wheel rotational angle, reported as accumulated encoder ticks.
|
Definition at line 586 of file configuration.h.
◆ operator<<() [1/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
AppliedSpeedType |
applied_speed_type |
|
) |
| |
|
inline |
◆ operator<<() [2/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
ConfigType |
type |
|
) |
| |
|
inline |
◆ operator<<() [3/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
ConfigurationSource |
source |
|
) |
| |
|
inline |
◆ operator<<() [4/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
InterfaceID |
val |
|
) |
| |
|
inline |
◆ operator<<() [5/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
MessageRate |
val |
|
) |
| |
|
inline |
◆ operator<<() [6/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
NmeaMessageType |
val |
|
) |
| |
|
inline |
◆ operator<<() [7/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
ProtocolType |
val |
|
) |
| |
|
inline |
◆ operator<<() [8/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
SaveAction |
action |
|
) |
| |
|
inline |
◆ operator<<() [9/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
SteeringType |
steering_type |
|
) |
| |
|
inline |
◆ operator<<() [10/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
TickDirection |
tick_direction |
|
) |
| |
|
inline |
◆ operator<<() [11/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
TickMode |
tick_mode |
|
) |
| |
|
inline |
◆ operator<<() [12/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
TransportType |
val |
|
) |
| |
|
inline |
◆ operator<<() [13/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
UpdateAction |
val |
|
) |
| |
|
inline |
◆ operator<<() [14/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
VehicleModel |
vehicle_model |
|
) |
| |
|
inline |
◆ operator<<() [15/15]
std::ostream& point_one::fusion_engine::messages::operator<< |
( |
std::ostream & |
stream, |
|
|
WheelSensorType |
wheel_sensor_type |
|
) |
| |
|
inline |
◆ to_string() [1/14]
const char* point_one::fusion_engine::messages::to_string |
( |
AppliedSpeedType |
applied_speed_type | ) |
|
|
inline |
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 680 of file configuration.h.
◆ to_string() [2/14]
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 137 of file configuration.h.
◆ to_string() [3/14]
Get a human-friendly string name for the specified ConfigurationSource.
- Parameters
-
source | The desired configuration source. |
- Returns
- The corresponding string name.
Definition at line 210 of file configuration.h.
◆ to_string() [4/14]
const char* point_one::fusion_engine::messages::to_string |
( |
MessageRate |
value | ) |
|
|
inline |
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 1440 of file configuration.h.
◆ to_string() [5/14]
const char* point_one::fusion_engine::messages::to_string |
( |
NmeaMessageType |
value | ) |
|
|
inline |
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 1322 of file configuration.h.
◆ to_string() [6/14]
const char* point_one::fusion_engine::messages::to_string |
( |
ProtocolType |
val | ) |
|
|
inline |
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 990 of file configuration.h.
◆ to_string() [7/14]
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 254 of file configuration.h.
◆ to_string() [8/14]
const char* point_one::fusion_engine::messages::to_string |
( |
SteeringType |
steering_type | ) |
|
|
inline |
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 735 of file configuration.h.
◆ to_string() [9/14]
const char* point_one::fusion_engine::messages::to_string |
( |
TickDirection |
tick_direction | ) |
|
|
inline |
◆ to_string() [10/14]
const char* point_one::fusion_engine::messages::to_string |
( |
TickMode |
tick_mode | ) |
|
|
inline |
◆ to_string() [11/14]
const char* point_one::fusion_engine::messages::to_string |
( |
TransportType |
val | ) |
|
|
inline |
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 1038 of file configuration.h.
◆ to_string() [12/14]
const char* point_one::fusion_engine::messages::to_string |
( |
UpdateAction |
val | ) |
|
|
inline |
Get a human-friendly string name for the specified UpdateAction.
- Parameters
-
val | The enum to get the string name for. |
- Returns
- The corresponding string name.
Definition at line 1122 of file configuration.h.
◆ to_string() [13/14]
const char* point_one::fusion_engine::messages::to_string |
( |
VehicleModel |
vehicle_model | ) |
|
|
inline |
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 515 of file configuration.h.
◆ to_string() [14/14]
const char* point_one::fusion_engine::messages::to_string |
( |
WheelSensorType |
wheel_sensor_type | ) |
|
|
inline |
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 617 of file configuration.h.