Detailed Description

Messages/types for controlling or simulating system faults.

Classes
struct	point_one::fusion_engine::messages::FaultControlMessage
	Enable/disable a specified system fault (MessageType::FAULT_CONTROL, version 1.0). More...

Enumerations
enum	point_one::fusion_engine::messages::CoComType : uint8_t { point_one::fusion_engine::messages::CoComType::NONE = 0, point_one::fusion_engine::messages::CoComType::ACCELERATION = 1, point_one::fusion_engine::messages::CoComType::SPEED = 2, point_one::fusion_engine::messages::CoComType::ALTITUDE = 3 }
	The type of COCOM limit to be applied. More...

enum	point_one::fusion_engine::messages::FaultType : uint8_t { point_one::fusion_engine::messages::FaultType::CLEAR_ALL = 0, point_one::fusion_engine::messages::FaultType::CRASH = 1, point_one::fusion_engine::messages::FaultType::FATAL_ERROR = 2, point_one::fusion_engine::messages::FaultType::COCOM = 3, point_one::fusion_engine::messages::FaultType::ENABLE_GNSS = 4, point_one::fusion_engine::messages::FaultType::REGION_BLACKOUT = 5, point_one::fusion_engine::messages::FaultType::QUECTEL_TEST = 6, point_one::fusion_engine::messages::FaultType::INTEGRITY_STATUS = 7 }
	Available fault types/control inputs. More...

Functions
p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, CoComType type)
	CoComType stream operator. More...

p1_ostream &	point_one::fusion_engine::messages::operator<< (p1_ostream &stream, FaultType type)
	ConfigurationSource stream operator. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (CoComType type)
	Get a human-friendly string name for the specified CoComType. More...

P1_CONSTEXPR_FUNC const char *	point_one::fusion_engine::messages::to_string (FaultType type)
	Get a human-friendly string name for the specified FaultType. More...

Enumeration Type Documentation

◆ CoComType

enum point_one::fusion_engine::messages::CoComType : uint8_t

strong

The type of COCOM limit to be applied.

Enumerator
NONE	Clear the current COCOM limit.
ACCELERATION	Simulate a maximum acceleration limit.
SPEED	Simulate a maximum speed limit.
ALTITUDE	Simulate a maximum altitude limit.

Definition at line 166 of file fault_control.h.

◆ FaultType

enum point_one::fusion_engine::messages::FaultType : uint8_t

strong

Available fault types/control inputs.

See FaultControlMessage.

Enumerator
CLEAR_ALL	Clear existing faults. Note This cannot be used to clear a FaultType::CRASH or FaultType::FATAL_ERROR. Payload format: none
CRASH	Force the device to crash (intended for factory test purposes only). On crash, the device no longer produce any output on any interfaces, and will stop responding to commands. If the watchdog is enabled, the device will restart automatically after the watchdog timer elapses. Warning The device will crash immediately after receiving this request. It will not send a CommandResponseMessage back to the user. Payload format: none
FATAL_ERROR	Force the device to exhibit a fatal error (intended for factory test purposes only). After a fatal error, the device will stop navigating and will no longer produce solution messages on any interfaces. Instead, it will output an EventNotificationMessage indicating the fault status. If the watchdog is enabled, the device will restart automatically after the watchdog timer elapses. Unlike FaultType::CRASH, a fatal error will send an error notification to the user, but will still not send a CommandResponseMessage. Payload format: none
COCOM	Simulate a COCOM limit (intended for factory test purposes only). When a COCOM limit is exceeded, the device will stop navigating and will produce SolutionType::Invalid solution messages. COCOM limits may be cleared via ResetRequest, or by sending a CoComType::NONE fault control. Payload format: CoComType
ENABLE_GNSS	Enable/disable use of GNSS measurements (intended for dead reckoning performance testing). Payload format: `uint8_t` (0=disable, 1=enable)
REGION_BLACKOUT	Simulate a region blackout (intended for factory test purposes only). Payload format: `uint8_t` (0=disable, 1=enable)
QUECTEL_TEST	Enable/disable Quectel test features (intended for factory test purposes only). Payload format: `uint8_t` (0=disable, 1=enable)
INTEGRITY_STATUS	Simulate a specified integrity status failure (intended for factory test purposes only). Payload format: `uint8_t`

Definition at line 33 of file fault_control.h.

Function Documentation

◆ operator<<() [1/2]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		CoComType	type
	)

inline

CoComType stream operator.

Definition at line 204 of file fault_control.h.

◆ operator<<() [2/2]

p1_ostream& point_one::fusion_engine::messages::operator<<	(	p1_ostream &	stream,
		FaultType	type
	)

inline

ConfigurationSource stream operator.

Definition at line 157 of file fault_control.h.

◆ to_string() [1/2]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( CoComType type )

Get a human-friendly string name for the specified CoComType.

Parameters

type	The desired type.

Returns: The corresponding string name.

Definition at line 185 of file fault_control.h.

◆ to_string() [2/2]

P1_CONSTEXPR_FUNC const char* point_one::fusion_engine::messages::to_string ( FaultType type )

Get a human-friendly string name for the specified FaultType.