Artemis::Devices::PDU::pdu_packet Struct Reference

The PDU packet structure. More...

#include <pdu.h>

Public Attributes
PDU_Type	type = PDU_Type::NOP
	The type of packet.
PDU_SW	sw = PDU_SW::None
	The switch on the PDU.
uint8_t	sw_state = 0
	The state of the switch.

Detailed Description

The PDU packet structure.

This defines the structure of a PDU packet.

The PDU packet consists of three members: the type of packet (type), the switch to be controlled (sw), and the state of that switch (sw_state).A diagram of the struct is included below.

 1 byte 1 byte 1 byte
+------+------+----------+
| type | sw   | sw_state |
+------+------+----------+

Member Data Documentation

sw

PDU_SW Artemis::Devices::PDU::pdu_packet::sw = PDU_SW::None

The switch on the PDU.

The PDU_SW of the packet, which is set to None by default.

sw_state

uint8_t Artemis::Devices::PDU::pdu_packet::sw_state = 0

The state of the switch.

State is represented as a number. Values greater than zero are on, and zero or less is off. By default, the switch state is off.

type

PDU_Type Artemis::Devices::PDU::pdu_packet::type = PDU_Type::NOP

The type of packet.

The PDU_Type of the packet, which is set to NOP by default.

---

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

• lib/artemis_pdu/pdu.h