OLE Developer Guide  Latest Git
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
TransceiverEvent Struct Reference

Detailed Description

Information about a transceiver event.

In controller mode an event occurs when:

  • A DMX frame has been completely sent.
  • A TX error occurred.
  • A RDM frame has been broadcast.
  • A RDM response (either DUB or Get/Set) has been received.
  • A RDM timeout has occurred.

In responder mode, events occur when a frame is received.

Collaboration diagram for TransceiverEvent:

Data Fields

int16_t token
 The Token associated with the operation. More...
 
TransceiverOperation op
 The type of operation that triggered the event.
 
TransceiverOperationResult result
 The result of the operation.
 
const uint8_t * data
 The received data. May be null.
 
unsigned int length
 The length of the received data.
 
TransceiverTimingtiming
 The timing parameters associated with the operation. More...
 

Field Documentation

TransceiverTiming* TransceiverEvent::timing

The timing parameters associated with the operation.

This may be NULL, if no timing information was available.

int16_t TransceiverEvent::token

The Token associated with the operation.

This will match the token passed in to Transceiver_QueueDMX(), Transceiver_QueueASC(), Transceiver_QueueRDMDUB() or Transceiver_QueueRDMRequest().

In responder mode, the token will be 0.


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