Detailed Description

Enable/disable a specified system fault (MessageType::FAULT_CONTROL, version 1.0).

This message is followed by an N-byte payload. The size and format of the payload are specified by the fault_type. See FaultType for details. For example, a message with a uint8_t payload will be serialized as follows:

{MessageHeader, FaultControlMessage, uint8_t}

Expected Response

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

Definition at line 227 of file fault_control.h.

Inheritance diagram for point_one::fusion_engine::messages::FaultControlMessage:

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

Public Attributes
FaultType	fault_type = FaultType::CLEAR_ALL
	The type of fault/control to be performed. More...

uint32_t	payload_length_bytes = 0
	The size of the payload (in bytes). More...

Static Public Attributes
static constexpr MessageType	MESSAGE_TYPE = MessageType::FAULT_CONTROL

static constexpr uint8_t	MESSAGE_VERSION = 0

Member Data Documentation

◆ fault_type

FaultType point_one::fusion_engine::messages::FaultControlMessage::fault_type = FaultType::CLEAR_ALL

The type of fault/control to be performed.

Definition at line 232 of file fault_control.h.

◆ MESSAGE_TYPE

constexpr MessageType point_one::fusion_engine::messages::FaultControlMessage::MESSAGE_TYPE = MessageType::FAULT_CONTROL

staticconstexpr

Definition at line 228 of file fault_control.h.

◆ MESSAGE_VERSION

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

staticconstexpr

Definition at line 229 of file fault_control.h.

◆ payload_length_bytes

uint32_t point_one::fusion_engine::messages::FaultControlMessage::payload_length_bytes = 0

The size of the payload (in bytes).

Definition at line 237 of file fault_control.h.

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

src/point_one/fusion_engine/messages/fault_control.h