FaultControlMessage Struct

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

Declaration

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

Included Headers

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

Base struct

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

Public Member Attributes Index

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

Public Static Attributes Index

static constexpr MessageType	MESSAGE_TYPE = MessageType::FAULT_CONTROL
static constexpr uint8_t	MESSAGE_VERSION = 0

Description

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

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 224 of file fault_control.h.

Public Member Attributes

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 229 of file fault_control.h.

229 FaultType fault_type = FaultType::CLEAR_ALL;

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 234 of file fault_control.h.

234 uint32_t payload_length_bytes = 0;

Public Static Attributes

MESSAGE_TYPE

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

constexpr static

Definition at line 225 of file fault_control.h.

225 static constexpr MessageType MESSAGE_TYPE = MessageType::FAULT_CONTROL;

MESSAGE_VERSION

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

constexpr static

Definition at line 226 of file fault_control.h.

226 static constexpr uint8_t MESSAGE_VERSION = 0;

---

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

• fault_control.h

---

Generated via doxygen2docusaurus 2.0.0 by Doxygen 1.9.8.