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:

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_GNSS_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...

static constexpr uint32_t	RESET_FAST_IMU_CORRECTIONS = 0x00000400
	Reset bias estimates, and other IMU corrections that are typically estimated quickly. 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 all IMU corrections (fast and slow) and other 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...

Restart Hardware Modules
static constexpr uint32_t	RESTART_GNSS_MEASUREMENT_ENGINE = 0x01000000
	Restart the GNSS measurement engine. More...

static constexpr uint32_t	REBOOT_NAVIGATION_PROCESSOR = 0x02000000
	Reboot the navigation processor. More...

Device Reset Bitmasks
static constexpr uint32_t	HOT_START = 0x000000FF
	Perform a device hot start. More...

static constexpr uint32_t	WARM_START = 0x000001FF
	Perform a device warm start. More...

static constexpr uint32_t	COLD_START = 0x01000FFF
	Perform a device cold start. More...

static constexpr uint32_t	FACTORY_RESET = 0xFFFFFFFF
	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 96 of file control.h.

Member Data Documentation

◆ COLD_START

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::COLD_START = 0x01000FFF

staticconstexpr

Perform a device cold start.

A cold start is typically used to reset the device's state estimate in the case of error that cannot be resolved by a WARM_START.

To be reset:

The navigation engine (RESTART_NAVIGATION_ENGINE)
All runtime data (GNSS corrections (RESET_GNSS_CORRECTIONS), etc.)
Position, velocity, orientation (RESET_POSITION_DATA)
Fast IMU corrections (RESET_FAST_IMU_CORRECTIONS)
GNSS measurement engine (RESTART_GNSS_MEASUREMENT_ENGINE)

Not reset:

Training parameters (slowly estimated IMU corrections, temperature compensation, etc.; RESET_NAVIGATION_ENGINE_DATA)
Calibration data (RESET_CALIBRATION_DATA)
User configuration settings (RESET_CONFIG)
Reboot navigation processor (REBOOT_NAVIGATION_PROCESSOR)

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

Definition at line 239 of file control.h.

◆ FACTORY_RESET

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::FACTORY_RESET = 0xFFFFFFFF

staticconstexpr

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

Definition at line 245 of file control.h.

◆ HOT_START

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

staticconstexpr

Perform a device hot start.

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

To be reset:

The navigation engine (RESTART_NAVIGATION_ENGINE)
All runtime data (GNSS corrections (RESET_GNSS_CORRECTIONS), etc.)

Not reset:

Position, velocity, orientation (RESET_POSITION_DATA)
Fast IMU corrections (RESET_FAST_IMU_CORRECTIONS)
Training parameters (slowly estimated IMU corrections, temperature compensation, etc.; RESET_NAVIGATION_ENGINE_DATA)
Calibration data (RESET_CALIBRATION_DATA)
User configuration settings (RESET_CONFIG)
GNSS measurement engine (RESTART_GNSS_MEASUREMENT_ENGINE)
Reboot navigation processor (REBOOT_NAVIGATION_PROCESSOR)

Definition at line 191 of file control.h.

◆ MESSAGE_TYPE

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

staticconstexpr

Definition at line 97 of file control.h.

◆ MESSAGE_VERSION

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

staticconstexpr

Definition at line 98 of file control.h.

◆ REBOOT_NAVIGATION_PROCESSOR

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::REBOOT_NAVIGATION_PROCESSOR = 0x02000000

staticconstexpr

Reboot the navigation processor.

Definition at line 164 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 146 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 154 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 120 of file control.h.

◆ RESET_FAST_IMU_CORRECTIONS

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_FAST_IMU_CORRECTIONS = 0x00000400

staticconstexpr

Reset bias estimates, and other IMU corrections that are typically estimated quickly.

Definition at line 125 of file control.h.

◆ RESET_GNSS_CORRECTIONS

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_GNSS_CORRECTIONS = 0x00000002

staticconstexpr

Delete all GNSS corrections information.

Definition at line 107 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 249 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 all IMU corrections (fast and slow) and other training data.

Definition at line 137 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 118 of file control.h.

◆ RESTART_GNSS_MEASUREMENT_ENGINE

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESTART_GNSS_MEASUREMENT_ENGINE = 0x01000000

staticconstexpr

Restart the GNSS measurement engine.

Definition at line 162 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 105 of file control.h.

◆ WARM_START

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

staticconstexpr

Perform a device warm start.

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

To be reset:

The navigation engine (RESTART_NAVIGATION_ENGINE)
All runtime data (GNSS corrections (RESET_GNSS_CORRECTIONS), etc.)
Position, velocity, orientation (RESET_POSITION_DATA)

Not reset:

Fast IMU corrections (RESET_FAST_IMU_CORRECTIONS)
Training parameters (slowly estimated IMU corrections, temperature compensation, etc.; RESET_NAVIGATION_ENGINE_DATA)
Calibration data (RESET_CALIBRATION_DATA)
User configuration settings (RESET_CONFIG)
GNSS measurement engine (RESTART_GNSS_MEASUREMENT_ENGINE)
Reboot navigation processor (REBOOT_NAVIGATION_PROCESSOR)

Definition at line 213 of file control.h.

The documentation for this struct was generated from the following file:

src/point_one/fusion_engine/messages/control.h

Public Attributes

Static Public Attributes

Detailed Description

Member Data Documentation

◆ COLD_START

◆ FACTORY_RESET

◆ HOT_START

◆ MESSAGE_TYPE

◆ MESSAGE_VERSION

◆ REBOOT_NAVIGATION_PROCESSOR

◆ RESET_CALIBRATION_DATA

◆ RESET_CONFIG

◆ RESET_EPHEMERIS

◆ RESET_FAST_IMU_CORRECTIONS

◆ RESET_GNSS_CORRECTIONS

◆ reset_mask

◆ RESET_NAVIGATION_ENGINE_DATA

◆ RESET_POSITION_DATA

◆ RESTART_GNSS_MEASUREMENT_ENGINE

◆ RESTART_NAVIGATION_ENGINE

◆ WARM_START