RDMnet  HEAD (unstable)
Implementation of ANSI E1.33 (RDMnet)
View other versions:
RdmnetRdmResponse Struct Reference

Overview

An RDMnet RDM response received by a local component.

Data Fields

RdmUid rdmnet_source_uid
 
uint16_t source_endpoint
 
uint32_t seq_num
 
bool is_response_to_me
 Whether the response was sent in response to a command previously sent by this controller. More...
 
RdmCommandHeader original_cmd_header
 
const uint8_t * original_cmd_data
 
uint8_t original_cmd_data_len
 
RdmResponseHeader rdm_header
 
const uint8_t * rdm_data
 
size_t rdm_data_len
 
bool more_coming
 

Field Documentation

◆ is_response_to_me

bool is_response_to_me

Whether the response was sent in response to a command previously sent by this controller.

If this is false, the command was a broadcast sent to all controllers.

◆ more_coming

bool more_coming

This message contains partial RDM data. This can be set when the library runs out of static memory in which to store RDM response data and must deliver a partial data buffer before continuing (this only applies to the data buffer within the RDM response). The application should store the partial data but should not act on it until another RdmnetRdmResponse is received with more_coming set to false.

◆ original_cmd_data

const uint8_t* original_cmd_data

Any parameter data associated with the original RDM command; valid if seq_num != 0.

◆ original_cmd_data_len

uint8_t original_cmd_data_len

The length of the parameter data associated with the original RDM command; valid if seq_num != 0.

◆ original_cmd_header

RdmCommandHeader original_cmd_header

The header of the original command associated with this response; valid if seq_num != 0.

◆ rdm_data

const uint8_t* rdm_data

Any parameter data associated with the RDM response.

◆ rdm_data_len

size_t rdm_data_len

The length of the parameter data associated with the RDM response.

◆ rdm_header

RdmResponseHeader rdm_header

The header information from the encapsulated RDM response.

◆ rdmnet_source_uid

RdmUid rdmnet_source_uid

The UID of the RDMnet component that sent this response.

◆ seq_num

uint32_t seq_num

The sequence number of the response, for matching with a corresponding command.

◆ source_endpoint

uint16_t source_endpoint

The endpoint from which the response was sent.


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