ola::plugin::usbpro::ArduinoWidget Class Reference

Inheritance diagram for ola::plugin::usbpro::ArduinoWidget:

Collaboration diagram for ola::plugin::usbpro::ArduinoWidget:

Public Member Functions
	ArduinoWidget (ola::io::ConnectedDescriptor *descriptor, uint16_t esta_id, uint32_t serial, unsigned int queue_size=20)
void	Stop ()
bool	SendDMX (const DmxBuffer &buffer)
void	SendRDMRequest (ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *on_complete)
	Send a RDM command.
void	RunFullDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
	Start a full discovery operation.
void	RunIncrementalDiscovery (ola::rdm::RDMDiscoveryCallback *callback)
	Start an incremental discovery operation.
ola::io::ConnectedDescriptor *	GetDescriptor () const

Constructor & Destructor Documentation

ola::plugin::usbpro::ArduinoWidget::ArduinoWidget	(	ola::io::ConnectedDescriptor *	descriptor,
		uint16_t	esta_id,
		uint32_t	serial,
		unsigned int	queue_size = 20
	)

ArduinoWidget Constructor

Member Function Documentation

void ola::plugin::usbpro::ArduinoWidget::RunFullDiscovery ( ola::rdm::RDMDiscoveryCallback *  callback )

inlinevirtual

Start a full discovery operation.

Parameters

callback

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

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::plugin::usbpro::ArduinoWidget::RunIncrementalDiscovery ( ola::rdm::RDMDiscoveryCallback *  callback )

inlinevirtual

Start an incremental discovery operation.

Parameters

callback

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

Implements ola::rdm::DiscoverableRDMControllerInterface.

void ola::plugin::usbpro::ArduinoWidget::SendRDMRequest ( ola::rdm::RDMRequest *  request, ola::rdm::RDMCallback *  on_complete  )

inlinevirtual

Send a RDM command.

Parameters

request	the RDMRequest, ownership is transferred.
on_complete	The 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:

• plugins/usbpro/ArduinoWidget.h
• plugins/usbpro/ArduinoWidget.cpp