ola::plugin::usbdmx::UsbDmxPlugin Class Reference

Detailed Description

A plugin that uses libusb to communicate with USB devices.

This plugin supports a number of USB dongles including

• Anyma uDMX.
• AVLdiy D512.
• DMXControl Projects e.V. Nodle U1.
• DMXCreator 512 Basic USB.
• Eurolite DMX USB Pro.
• Eurolite DMX USB Pro MK2.
• Scanlime's Fadecandy.
• Sunlite.
• Velleman K8062.

Inheritance diagram for ola::plugin::usbdmx::UsbDmxPlugin:

Collaboration diagram for ola::plugin::usbdmx::UsbDmxPlugin:

Public Member Functions
	UsbDmxPlugin (PluginAdaptor *plugin_adaptor)
	Create a new UsbDmxPlugin. More...
std::string	Name () const
	Get the plugin name. More...
std::string	Description () const
ola_plugin_id	Id () const
	Get the plugin ID of this plugin. More...
std::string	PluginPrefix () const
	The prefix to use for storing configuration files. More...
void	ConflictsWith (std::set< ola_plugin_id > *conflicting_plugins) const
Public Member Functions inherited from ola::Plugin
	Plugin (PluginAdaptor *plugin_adaptor)
bool	LoadPreferences ()
	Load the preferences for a plugin and set defaults.
std::string	PreferenceConfigLocation () const
	The location for preferences. More...
bool	IsEnabled () const
	Is the plugin enabled? More...
void	SetEnabledState (bool enable)
	Set the plugin's enabled state. More...
virtual bool	Start ()
	Start the plugin. More...
virtual bool	Stop ()
	Stop the plugin. More...
virtual bool	DefaultMode () const
bool	operator< (const AbstractPlugin &other) const

Additional Inherited Members
Protected Attributes inherited from ola::Plugin
PluginAdaptor *	m_plugin_adaptor
class Preferences *	m_preferences
Static Protected Attributes inherited from ola::Plugin
static const char	ENABLED_KEY [] = "enabled"

Constructor & Destructor Documentation

UsbDmxPlugin()

ola::plugin::usbdmx::UsbDmxPlugin::UsbDmxPlugin ( PluginAdaptor *  plugin_adaptor )

explicit

Create a new UsbDmxPlugin.

Parameters

plugin_adaptor

The PluginAdaptor to use, ownership is not transferred.

Member Function Documentation

Description()

string ola::plugin::usbdmx::UsbDmxPlugin::Description ( ) const

virtual

Return the description for this plugin.

Returns

a string description of the plugin

Implements ola::AbstractPlugin.

Id()

ola_plugin_id ola::plugin::usbdmx::UsbDmxPlugin::Id ( ) const

inlinevirtual

Get the plugin ID of this plugin.

Returns

the ola_plugin_id of this plugin

Implements ola::Plugin.

Name()

std::string ola::plugin::usbdmx::UsbDmxPlugin::Name ( ) const

inlinevirtual

Get the plugin name.

Returns

the name of this plugin

Implements ola::AbstractPlugin.

PluginPrefix()

std::string ola::plugin::usbdmx::UsbDmxPlugin::PluginPrefix ( ) const

inlinevirtual

The prefix to use for storing configuration files.

Returns

A unique prefix used to identify the configuration file for this plugin.

Implements ola::Plugin.

---

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

• plugins/usbdmx/UsbDmxPlugin.h
• plugins/usbdmx/UsbDmxPlugin.cpp