Skip to main content

ResetRequest Struct

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

Declaration​

struct point_one::fusion_engine::messages::ResetRequest { ... }

Included Headers​

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

Base struct​

structMessagePayload

The base class for all message payloads. More...

Public Member Attributes Index​

uint32_treset_mask = 0

Bit mask of functionality to reset. More...

Public Static Attributes Index​

static constexpr MessageTypeMESSAGE_TYPE = MessageType::RESET_REQUEST
static constexpr uint8_tMESSAGE_VERSION = 0

Runtime State Reset Index​

static constexpr uint32_tRESTART_NAVIGATION_ENGINE = 0x00000001

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

static constexpr uint32_tRESET_GNSS_CORRECTIONS = 0x00000002

Delete all GNSS corrections information. More...

static constexpr uint32_tRESET_GNSS_TIME = 0x00000004

Delete all GNSS time information. More...

Clear Short Lived Data Index​

static constexpr uint32_tRESET_POSITION_DATA = 0x00000100

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

static constexpr uint32_tRESET_EPHEMERIS = 0x00000200

Delete all saved satellite ephemeris. More...

static constexpr uint32_tRESET_FAST_IMU_CORRECTIONS = 0x00000400

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

Clear Long Lived Data Index​

static constexpr uint32_tRESET_NAVIGATION_ENGINE_DATA = 0x00001000

Reset all stored navigation engine data, including position, velocity, and orientation state (same as RESET_POSITION_DATA), plus all IMU corrections and other training data. More...

static constexpr uint32_tRESET_CALIBRATION_DATA = 0x00002000

Reset the device calibration data. More...

Clear Configuration Data Index​

static constexpr uint32_tRESET_CONFIG = 0x00100000

Clear all configuration data. More...

Software Reboot And Special Reset Modes Index​

static constexpr uint32_tREBOOT_GNSS_MEASUREMENT_ENGINE = 0x01000000

Reboot the GNSS measurement engine (GNSS receiver), in addition to performing any other requested resets (e.g., RESET_EPHEMERIS). More...

static constexpr uint32_tREBOOT_NAVIGATION_PROCESSOR = 0x02000000

Reboot the navigation processor. More...

static constexpr uint32_tDIAGNOSTIC_LOG_RESET = 0x04000000

Perform a diagnostic log reset to guarantee deterministic performance for data post-processing and diagnostic support. More...

Device Reset Bitmasks Index​

static constexpr uint32_tHOT_START = 0x00000001

Perform a device hot start. More...

static constexpr uint32_tWARM_START = 0x00000201

Perform a device warm start. More...

static constexpr uint32_tPOSE_RESET = 0x000001FB

Perform a pose reset: reset all position, velocity, and orientation information (i.e., the navigation engine's kinematic state). More...

static constexpr uint32_tCOLD_START = 0x00000FFF

Perform a device cold start. More...

static constexpr uint32_tFACTORY_RESET = 0xFFFFFFFF

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

Description​

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

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

Expected Response​

The device will respond with a CommandResponseMessage indicating whether or not the request succeeded.

Definition at line 101 of file control.h.

Public Member Attributes​

reset_mask​

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

Bit mask of functionality to reset.

Definition at line 322 of file control.h.

322 uint32_t reset_mask = 0;

Public Static Attributes​

MESSAGE_TYPE​

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

Definition at line 102 of file control.h.

102 static constexpr MessageType MESSAGE_TYPE = MessageType::RESET_REQUEST;

MESSAGE_VERSION​

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

Definition at line 103 of file control.h.

103 static constexpr uint8_t MESSAGE_VERSION = 0;

Runtime State Reset​

RESET_GNSS_CORRECTIONS​

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

Delete all GNSS corrections information.

Definition at line 112 of file control.h.

112 static constexpr uint32_t RESET_GNSS_CORRECTIONS = 0x00000002;

RESET_GNSS_TIME​

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::RESET_GNSS_TIME = 0x00000004
 constexpr static

Delete all GNSS time information.

Definition at line 114 of file control.h.

114 static constexpr uint32_t RESET_GNSS_TIME = 0x00000004;

RESTART_NAVIGATION_ENGINE​

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

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

Definition at line 110 of file control.h.

110 static constexpr uint32_t RESTART_NAVIGATION_ENGINE = 0x00000001;

Clear Short Lived Data​

RESET_EPHEMERIS​

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

Delete all saved satellite ephemeris.

Definition at line 127 of file control.h.

127 static constexpr uint32_t RESET_EPHEMERIS = 0x00000200;

RESET_FAST_IMU_CORRECTIONS​

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

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

Definition at line 132 of file control.h.

132 static constexpr uint32_t RESET_FAST_IMU_CORRECTIONS = 0x00000400;

RESET_POSITION_DATA​

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

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

Definition at line 125 of file control.h.

125 static constexpr uint32_t RESET_POSITION_DATA = 0x00000100;

Clear Long Lived Data​

RESET_CALIBRATION_DATA​

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

Reset the device calibration data.

info

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 153 of file control.h.

153 static constexpr uint32_t RESET_CALIBRATION_DATA = 0x00002000;

RESET_NAVIGATION_ENGINE_DATA​

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

Reset all stored navigation engine data, including position, velocity, and orientation state (same as RESET_POSITION_DATA), plus all IMU corrections and other training data.

Definition at line 144 of file control.h.

144 static constexpr uint32_t RESET_NAVIGATION_ENGINE_DATA = 0x00001000;

Clear Configuration Data​

RESET_CONFIG​

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

Clear all configuration data.

Definition at line 161 of file control.h.

161 static constexpr uint32_t RESET_CONFIG = 0x00100000;

Software Reboot And Special Reset Modes​

DIAGNOSTIC_LOG_RESET​

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::DIAGNOSTIC_LOG_RESET = 0x04000000
 constexpr static

Perform a diagnostic log reset to guarantee deterministic performance for data post-processing and diagnostic support.

Diagnostic log resets are useful when capturing data to be sent to Point One for analysis and support. Performing a diagnostic reset guarantees that the performance of the device seen in real time can be reproduced during post-processing.

This reset performs the following:

  • Restart the navigation engine (RESTART_NAVIGATION_ENGINE)
  • Clear any stored data in RAM that was received since startup such as ephemeris or GNSS corrections
    • This is not the same as RESET_EPHEMERIS; this action does not reset ephemeris data stored in persistent storage
  • Flush internal data buffers on the device

Note that this does not reset the navigation engine's position data, GNSS times, training parameters, or calibration. If the navigation engine has existing position information, it will be used.

This reset may be combined with other resets as needed to clear additional information.

Definition at line 201 of file control.h.

201 static constexpr uint32_t DIAGNOSTIC_LOG_RESET = 0x04000000;

REBOOT_GNSS_MEASUREMENT_ENGINE​

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::REBOOT_GNSS_MEASUREMENT_ENGINE = 0x01000000
 constexpr static

Reboot the GNSS measurement engine (GNSS receiver), in addition to performing any other requested resets (e.g., RESET_EPHEMERIS).

If no other resets are specified, the GNSS receiver will reboot and should perform a hot start.

Definition at line 174 of file control.h.

174 static constexpr uint32_t REBOOT_GNSS_MEASUREMENT_ENGINE = 0x01000000;

REBOOT_NAVIGATION_PROCESSOR​

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

Reboot the navigation processor.

Definition at line 176 of file control.h.

176 static constexpr uint32_t REBOOT_NAVIGATION_PROCESSOR = 0x02000000;

Device Reset Bitmasks​

COLD_START​

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

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:

Not reset/performed:

info

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

Definition at line 312 of file control.h.

312 static constexpr uint32_t COLD_START = 0x00000FFF;

FACTORY_RESET​

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

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

Definition at line 318 of file control.h.

318 static constexpr uint32_t FACTORY_RESET = 0xFFFFFFFF;

HOT_START​

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::HOT_START = 0x00000001
 constexpr static

Perform a device hot start.

This will reset the navigation engine into a known state, using previously stored position and time information. The device will begin navigating immediately if possible.

To be reset:

Not reset/performed:

Definition at line 231 of file control.h.

231 static constexpr uint32_t HOT_START = 0x00000001;

POSE_RESET​

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::POSE_RESET = 0x000001FB
 constexpr static

Perform a pose reset: reset all position, velocity, and orientation information (i.e., the navigation engine's kinematic state).

A pose reset is typically used to reset the kinematic portion of the navigation engine's state if you are experiencing errors on startup or after a HOT_START.

To be reset:

Not reset/performed:

Definition at line 284 of file control.h.

284 static constexpr uint32_t POSE_RESET = 0x000001FB;

WARM_START​

constexpr uint32_t point_one::fusion_engine::messages::ResetRequest::WARM_START = 0x00000201
 constexpr static

Perform a device warm start.

During a warm start, the device retains its knowledge of approximate position and time, plus almanac data if available, but resets all ephemeris data. As a result, the device will need to download ephemeris data before continuing to navigate with GNSS.

To be reset:

Not reset/performed:

Definition at line 258 of file control.h.

258 static constexpr uint32_t WARM_START = 0x00000201;

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

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.