Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | List of all members
ola::plugin::spi::SPIOutput Class Reference
Inheritance diagram for ola::plugin::spi::SPIOutput:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::spi::SPIOutput:
Collaboration graph
[legend]

Classes

struct  Options
 

Public Types

enum  SPI_PERSONALITY {
  PERS_WS2801_INDIVIDUAL = 1, PERS_WS2801_COMBINED = 2, PERS_LDP8806_INDIVIDUAL = 3, PERS_LDP8806_COMBINED = 4,
  PERS_P9813_INDIVIDUAL = 5, PERS_P9813_COMBINED = 6, PERS_APA102_INDIVIDUAL = 7, PERS_APA102_COMBINED = 8,
  PERS_APA102_PB_INDIVIDUAL, PERS_APA102_PB_COMBINED
}
 

Public Member Functions

 SPIOutput (const ola::rdm::UID &uid, class SPIBackendInterface *backend, const Options &options)
 
std::string GetDeviceLabel () const
 
bool SetDeviceLabel (const std::string &device_label)
 
uint8_t GetPersonality () const
 
bool SetPersonality (uint16_t personality)
 
uint16_t GetStartAddress () const
 
bool SetStartAddress (uint16_t start_address)
 
unsigned int PixelCount () const
 
std::string Description () const
 
bool WriteDMX (const DmxBuffer &buffer)
 
void RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start a full discovery operation. More...
 
void RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
 Start an incremental discovery operation. More...
 
void SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
 Send a RDM command. More...
 

Member Function Documentation

void ola::plugin::spi::SPIOutput::RunFullDiscovery ( ola::rdm::RDMDiscoveryCallback callback)
virtual

Start a full discovery operation.

Parameters
callbackThe callback run when discovery completes. This may run immediately in some implementations.

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::plugin::spi::SPIOutput::RunIncrementalDiscovery ( ola::rdm::RDMDiscoveryCallback callback)
virtual

Start an incremental discovery operation.

Parameters
callbackThe callback run when discovery completes. This may run immediately in some implementations.

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::plugin::spi::SPIOutput::SendRDMRequest ( ola::rdm::RDMRequest request,
ola::rdm::RDMCallback on_complete 
)
virtual

Send a RDM command.

Parameters
requestthe RDMRequest, ownership is transferred.
on_completeThe callback to run when the request completes.

Implementors much ensure that the callback is always run at some point. In other words, there must be no way that a request can be dropped in such a way that the callback is never run. Doing so will either block all subsequent requests, or leak memory depending on the implementation.

Also the implementor of this class may want to re-write the transaction #, and possibly the UID (changing src UIDs isn't addressed by the RDM spec).

The RDMRequest may be a DISCOVERY_COMMAND, if the implementation does not support DISCOVERY_COMMANDs then the callback should be run with ola::rdm::RDM_PLUGIN_DISCOVERY_NOT_SUPPORTED.

Implements ola::rdm::RDMControllerInterface.


The documentation for this class was generated from the following files: