Public Attributes | Static Public Attributes | List of all members
point_one::fusion_engine::messages::ResetRequest Struct Reference
Message Definitions » Device Configuration and Control Message Definitions

Perform a software or hardware reset (MessageType::RESET_REQUEST, version 1.0). More...

#include <point_one/fusion_engine/messages/control.h>

Inheritance diagram for point_one::fusion_engine::messages::ResetRequest:
point_one::fusion_engine::messages::MessagePayload

Public Attributes

uint32_t reset_mask = 0
 Bit mask of functionality to reset. More...
 

Static Public Attributes

static constexpr MessageType MESSAGE_TYPE = MessageType::RESET_REQUEST
 
static constexpr uint8_t MESSAGE_VERSION = 0
 
Runtime State Reset
static constexpr uint32_t RESTART_NAVIGATION_ENGINE = 0x00000001
 Restart the navigation engine, but do not clear its position estimate. More...
 
static constexpr uint32_t RESET_CORRECTIONS = 0x00000002
 Delete all GNSS corrections information. More...
 
Clear Short Lived Data
static constexpr uint32_t RESET_POSITION_DATA = 0x00000100
 Reset the navigation engine's estimate of position, velocity, and orientation. More...
 
static constexpr uint32_t RESET_EPHEMERIS = 0x00000200
 Delete all saved satellite ephemeris. More...
 
Clear Long Lived Data
static constexpr uint32_t RESET_NAVIGATION_ENGINE_DATA = 0x00001000
 Reset all stored navigation engine data, including position, velocity, and orientation state, as well as training data. More...
 
static constexpr uint32_t RESET_CALIBRATION_DATA = 0x00002000
 Reset the device calibration data. More...
 
Clear Configuration Data
static constexpr uint32_t RESET_CONFIG = 0x00100000
 Clear all configuration data. More...
 
Device Reset Bitmasks
static constexpr uint32_t HOT_START = 0x000000FF
 Perform a device hot start: reload the navigation engine and clear all runtime data (GNSS corrections, etc.), but do not reset any saved state data (position, orientation, training parameters, calibration, etc.). More...
 
static constexpr uint32_t WARM_START = 0x000001FF
 Perform a device warm start: reload the navigation engine, resetting the saved position, velocity, and orientation, but do not reset training parameters or calibration data. More...
 
static constexpr uint32_t COLD_START = 0x00000FFF
 Perform a device cold start: reset the navigation engine including saved position, velocity, and orientation state, but do not reset training data, calibration data, or user configuration parameters. More...
 
static constexpr uint32_t FACTORY_RESET = 0x00FFFFFF
 Restart mask to set all persistent data, including calibration and user configuration, back to factory defaults. More...
 

Detailed Description

Perform a software or hardware reset (MessageType::RESET_REQUEST, version 1.0).

This message contains a bitmask indicating the set of components to be reset. Helper bitmasks are provided for common reset operations.

Definition at line 126 of file control.h.

Member Data Documentation

◆ COLD_START

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::COLD_START = 0x00000FFF
staticconstexpr

Perform a device cold start: reset the navigation engine including saved position, velocity, and orientation state, but do not reset training data, calibration data, or user configuration parameters.

Note
To reset training or calibration data as well, set the RESET_NAVIGATION_ENGINE_DATA and RESET_CALIBRATION_DATA bits.

Definition at line 214 of file control.h.

◆ FACTORY_RESET

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::FACTORY_RESET = 0x00FFFFFF
staticconstexpr

Restart mask to set all persistent data, including calibration and user configuration, back to factory defaults.

Note: Upper 8 bits reserved for future use (e.g., hardware reset).

Definition at line 222 of file control.h.

◆ HOT_START

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::HOT_START = 0x000000FF
staticconstexpr

Perform a device hot start: reload the navigation engine and clear all runtime data (GNSS corrections, etc.), but do not reset any saved state data (position, orientation, training parameters, calibration, etc.).

A hot start is typically used to restart the navigation engine in a deterministic state, particularly for logging purposes.

Definition at line 193 of file control.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::ResetRequest::MESSAGE_TYPE = MessageType::RESET_REQUEST
staticconstexpr

Definition at line 127 of file control.h.

◆ MESSAGE_VERSION

constexpr uint8_t point_one::fusion_engine::messages::ResetRequest::MESSAGE_VERSION = 0
staticconstexpr

Definition at line 128 of file control.h.

◆ RESET_CALIBRATION_DATA

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_CALIBRATION_DATA = 0x00002000
staticconstexpr

Reset the device calibration data.

Note
This does not reset any existing navigation engine state. It is recommended that you set RESET_NAVIGATION_ENGINE_DATA as well under normal circumstances.

Definition at line 170 of file control.h.

◆ RESET_CONFIG

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_CONFIG = 0x00100000
staticconstexpr

Clear all configuration data.

Definition at line 178 of file control.h.

◆ RESET_CORRECTIONS

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_CORRECTIONS = 0x00000002
staticconstexpr

Delete all GNSS corrections information.

Definition at line 137 of file control.h.

◆ RESET_EPHEMERIS

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_EPHEMERIS = 0x00000200
staticconstexpr

Delete all saved satellite ephemeris.

Definition at line 150 of file control.h.

◆ reset_mask

uint32_t point_one::fusion_engine::messages::ResetRequest::reset_mask = 0

Bit mask of functionality to reset.

Definition at line 226 of file control.h.

◆ RESET_NAVIGATION_ENGINE_DATA

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_NAVIGATION_ENGINE_DATA = 0x00001000
staticconstexpr

Reset all stored navigation engine data, including position, velocity, and orientation state, as well as training data.

Definition at line 161 of file control.h.

◆ RESET_POSITION_DATA

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_POSITION_DATA = 0x00000100
staticconstexpr

Reset the navigation engine's estimate of position, velocity, and orientation.

Definition at line 148 of file control.h.

◆ RESTART_NAVIGATION_ENGINE

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESTART_NAVIGATION_ENGINE = 0x00000001
staticconstexpr

Restart the navigation engine, but do not clear its position estimate.

Definition at line 135 of file control.h.

◆ WARM_START

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::WARM_START = 0x000001FF
staticconstexpr

Perform a device warm start: reload the navigation engine, resetting the saved position, velocity, and orientation, but do not reset training parameters or calibration data.

A warm start is typically used to reset the device's position estimate in case of error.

Definition at line 203 of file control.h.

The documentation for this struct was generated from the following file:
Generated by   doxygen 1.8.18