Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Member Functions | List of all members
ola::plugin::gpio::GPIODriver Class Reference

Detailed Description

Uses data in a DMXBuffer to drive GPIO pins.

Inheritance diagram for ola::plugin::gpio::GPIODriver:
Inheritance graph
[legend]
Collaboration diagram for ola::plugin::gpio::GPIODriver:
Collaboration graph
[legend]

Classes

struct  Options
 The Options. More...
 

Public Member Functions

 GPIODriver (const Options &options)
 Create a new GPIODriver. More...
 
 ~GPIODriver ()
 Destructor.
 
bool Init ()
 Initialize the GPIODriver. More...
 
std::vector< uint16_t > PinList () const
 Get a list of the GPIO pins controlled by this driver. More...
 
bool SendDmx (const DmxBuffer &dmx)
 Set the values of the GPIO pins from the data in the DMXBuffer. More...
 
void * Run ()
 The entry point for the new thread. More...
 

Constructor & Destructor Documentation

ola::plugin::gpio::GPIODriver::GPIODriver ( const Options options)
explicit

Create a new GPIODriver.

Parameters
optionsthe Options struct.

Member Function Documentation

bool ola::plugin::gpio::GPIODriver::Init ( )

Initialize the GPIODriver.

Returns
true is successful, false otherwise.
std::vector<uint16_t> ola::plugin::gpio::GPIODriver::PinList ( ) const
inline

Get a list of the GPIO pins controlled by this driver.

Returns
A list of GPIO pin numbers.
void * ola::plugin::gpio::GPIODriver::Run ( )
virtual

The entry point for the new thread.

Returns
A value returned to Join().

Sub classes must implement this.

Implements ola::thread::Thread.

bool ola::plugin::gpio::GPIODriver::SendDmx ( const DmxBuffer dmx)

Set the values of the GPIO pins from the data in the DMXBuffer.

Parameters
dmxthe DmxBuffer with the values to use.
Returns
true is the GPIO pins were updated.

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