System Fault Control
Messages/types for controlling or simulating system faults. More...
Classes Index
| struct | FaultControlMessage |
|
Enable/disable a specified system fault (MessageType::FAULT_CONTROL, version 1). More... | |
Enumerations Index
| enum class | CoComType : uint8_t { ... } |
|
The type of COCOM limit to be applied. More... | |
| enum class | FaultType : uint8_t { ... } |
|
Available fault types/control inputs. More... | |
Operators Index
| p1_ostream & | operator<< (p1_ostream &stream, CoComType type) |
| p1_ostream & | operator<< (p1_ostream &stream, FaultType type) |
|
ConfigurationSource stream operator. More... | |
Functions Index
| P1_CONSTEXPR_FUNC const char * | to_string (CoComType type) |
|
Get a human-friendly string name for the specified CoComType. More... | |
| P1_CONSTEXPR_FUNC const char * | to_string (FaultType type) |
|
Get a human-friendly string name for the specified FaultType. More... | |
Description
Messages/types for controlling or simulating system faults.
Enumerations
CoComType
| strong |
The type of COCOM limit to be applied.
- Enumeration values
-
NONE Clear the current COCOM limit (= 0) ACCELERATION Simulate a maximum acceleration limit (= 1) SPEED Simulate a maximum speed limit (= 2) ALTITUDE Simulate a maximum altitude limit (= 3)
Definition at line 164 of file fault_control.h.
FaultType
| strong |
Available fault types/control inputs.
- Enumeration values
See FaultControlMessage.
Definition at line 33 of file fault_control.h.
34 /**
35 * Clear existing faults.
36 *
37 * @note
38 * This cannot be used to clear a @ref FaultType::CRASH or @ref
39 * FaultType::FATAL_ERROR.
40 *
41 * Payload format: none
42 */
43 CLEAR_ALL = 0,
44 /**
45 * Force the device to crash (intended for factory test purposes only).
46 *
47 * On crash, the device no longer produce any output on any interfaces, and
48 * will stop responding to commands. If the watchdog is enabled, the device
49 * will restart automatically after the watchdog timer elapses.
50 *
51 * @warning
52 * The device will crash immediately after receiving this request. It will not
53 * send a @ref CommandResponseMessage back to the user.
54 *
55 * Payload format: none
56 */
57 CRASH = 1,
58 /**
59 * Force the device to exhibit a fatal error (intended for factory test
60 * purposes only).
61 *
62 * After a fatal error, the device will stop navigating and will no longer
63 * produce solution messages on any interfaces. Instead, it will output an
64 * @ref EventNotificationMessage indicating the fault status. If the watchdog
65 * is enabled, the device will restart automatically after the watchdog timer
66 * elapses.
67 *
68 * Unlike @ref FaultType::CRASH, a fatal error will send an error notification
69 * to the user, but will still not send a @ref CommandResponseMessage.
70 *
71 * Payload format: none
72 */
73 FATAL_ERROR = 2,
74 /**
75 * Simulate a COCOM limit (intended for factory test purposes only).
76 *
77 * When a COCOM limit is exceeded, the device will stop navigating and will
78 * produce @ref SolutionType::Invalid solution messages. COCOM limits may be
79 * cleared via @ref ResetRequest, or by sending a @ref CoComType::NONE fault
80 * control.
81 *
82 * Payload format: @ref CoComType
83 */
84 COCOM = 3,
85 /**
86 * Enable/disable use of GNSS measurements (intended for dead reckoning
87 * performance testing).
88 *
89 * Payload format: `uint8_t` (0=disable, 1=enable)
90 */
91 ENABLE_GNSS = 4,
92 /**
93 * Simulate a region blackout (intended for factory test purposes only).
94 *
95 * Payload format: `uint8_t` (0=disable, 1=enable)
96 */
97 REGION_BLACKOUT = 5,
98 /**
99 * Enable/disable Quectel test features (intended for factory test purposes
100 * only).
101 *
102 * Payload format: `uint8_t` (0=disable, 1=enable)
103 */
104 QUECTEL_TEST = 6,
105 /**
106 * Simulate a specified integrity status failure (intended for factory test
107 * purposes only).
108 *
109 * Payload format: `uint8_t`
110 */
111 INTEGRITY_STATUS = 7,
112};
Operators
operator<<()
| inline |
CoComType stream operator.
Definition at line 201 of file fault_control.h.
operator<<()
| inline |
ConfigurationSource stream operator.
Definition at line 155 of file fault_control.h.
Functions
to_string()
|
Get a human-friendly string name for the specified CoComType.
- Parameters
-
type The desired type.
- Returns
The corresponding string name.
Definition at line 183 of file fault_control.h.
183P1_CONSTEXPR_FUNC const char* to_string(CoComType type) {
184 switch (type) {
185 case CoComType::NONE:
186 return "No Limit";
187 case CoComType::ACCELERATION:
188 return "Acceleration";
189 case CoComType::SPEED:
190 return "Speed";
191 case CoComType::ALTITUDE:
192 return "Altitude";
193 }
194 return "Unrecognized";
195}
to_string()
|
Get a human-friendly string name for the specified FaultType.
- Parameters
-
type The desired fault type.
- Returns
The corresponding string name.
Definition at line 122 of file fault_control.h.
122P1_CONSTEXPR_FUNC const char* to_string(FaultType type) {
123 switch (type) {
124 case FaultType::CLEAR_ALL:
125 return "Clear Faults";
126
127 case FaultType::CRASH:
128 return "Crash";
129
130 case FaultType::FATAL_ERROR:
131 return "Fatal Error";
132
133 case FaultType::COCOM:
134 return "COCOM";
135
136 case FaultType::ENABLE_GNSS:
137 return "Enable GNSS";
138
139 case FaultType::REGION_BLACKOUT:
140 return "Region Blackout";
141
142 case FaultType::QUECTEL_TEST:
143 return "Quectel Test";
144
145 case FaultType::INTEGRITY_STATUS:
146 return "Integrity Status";
147 }
148 return "Unrecognized";
149}
Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.