official
/
OpenLCP
1
0
Fork 0
Code Releases 1 Activity

additional documentation

This commit is contained in:
Kevin Matz 2023-05-02 13:00:57 -04:00
parent 9985f21cb2
commit e1f0836a55
2 changed files with 19 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
protocol/esta/rdm/message.h
View File

@ -32,9 +32,10 @@
namespace RDM {
struct Message; //!< \cite RDM 6 Message Structure
struct Message; //!< \cite RDM 6 Message Structure
using MsgPtr = std::shared_ptr<Message>; //!< Managed RDM Message pointer.
using MsgPtr = std::shared_ptr<Message>; //!< Managed RDM Message pointer.
using MsgPair = std::pair<const MsgPtr, MsgPtr>; //!< Call/Response message pair.
/**
* @brief \cite RDM 6.2 Packet Format

27
protocol/esta/rdm/status.h
View File

@ -29,26 +29,31 @@
namespace RDM {
/**
* @brief The Status struct
* @brief \cite RDM 10.3.2 Status Messages
*
* The Status Type of STATUS_NONE shall be used when a controller wants to establish whether
* a device is present on the network without retrieving any Status Message data from the device.
*
* The Status Type STATUS_GET_LAST_MESSAGE shall be used by the Controller to request the
* retransmission of the last sent Status Message or Queued Message.
*/
struct Status
{
/// Each status message shall be a fixed length of 9 bytes.
union {
uint8_t bytes[9];
uint8_t bytes[9] = {0};
struct {
uint16_t subdevice_id; //!< sub-device ID
uint8_t status_type; //!< status type
uint16_t status_message; //!< status message
int16_t data1; //!< data field 1
int16_t data2; //!< data field 2
uint16_t subdevice_id; //!< 10.3.2.1 Sub-Device ID
uint8_t status_type; //!< 10.3.2.2 Status Type
uint16_t status_message_id; //!< 10.3.2.3 Status Message ID
int16_t data1; //!< 10.3.2.4 Data Value 1
int16_t data2; //!< 10.3.2.4 Data Value 2
} __attribute__ ((packed));
};
}; // struct Status
/**
* @brief a valid status
*/
using StatusPtr = std::shared_ptr<Status>;
using StatusPtr = std::shared_ptr<Status>; //!< A memory managed Status pointer
} // namespace RDM