Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GPIOPort.h
1 /*
2  * This program is free software; you can redistribute it and/or modify
3  * it under the terms of the GNU General Public License as published by
4  * the Free Software Foundation; either version 2 of the License, or
5  * (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  * GNU Library General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15  *
16  * GPIOPort.h
17  * An OLA GPIO Port.
18  * Copyright (C) 2014 Simon Newton
19  */
20 
21 #ifndef PLUGINS_GPIO_GPIOPORT_H_
22 #define PLUGINS_GPIO_GPIOPORT_H_
23 
24 #include <string>
25 #include "ola/DmxBuffer.h"
26 #include "olad/Port.h"
27 #include "plugins/gpio/GPIODevice.h"
28 #include "plugins/gpio/GPIODriver.h"
29 
30 namespace ola {
31 namespace plugin {
32 namespace gpio {
33 
38  public:
44  GPIOOutputPort(GPIODevice *parent,
45  const GPIODriver::Options &options);
46 
51 
56  bool Init();
57 
58  std::string Description() const;
59 
60  bool WriteDMX(const DmxBuffer &buffer, uint8_t priority);
61 
62  private:
63  std::auto_ptr<GPIODriver> m_driver;
64 
65  DISALLOW_COPY_AND_ASSIGN(GPIOOutputPort);
66 };
67 } // namespace gpio
68 } // namespace plugin
69 } // namespace ola
70 #endif // PLUGINS_GPIO_GPIOPORT_H_
The Options.
Definition: GPIODriver.h:43
~GPIOOutputPort()
Destructor.
Definition: GPIOPort.h:50
GPIOOutputPort(GPIODevice *parent, const GPIODriver::Options &options)
Create a new GPIOOutputPort.
Definition: GPIOPort.cpp:37
Used to hold a single universe of DMX data.
Definition: DmxBuffer.h:49
A class used to hold a single universe of DMX data.
bool Init()
Initialize the port.
Definition: GPIOPort.cpp:43
std::string Description() const
Fetch the string description for a Port.
Definition: GPIOPort.cpp:47
The GPIO Output port.
Definition: GPIOPort.h:37
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition: GPIOPort.cpp:52
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
The GPIO Device.
Definition: GPIODevice.h:38
Definition: Port.h:282