Open Lighting Architecture: plugins/gpio/GPIOPort.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
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
30namespace ola {
31namespace plugin {
32namespace gpio {
33
37 class GPIOOutputPort: public BasicOutputPort {
38 public:
44 GPIOOutputPort(GPIODevice *parent,
45 const GPIODriver::Options &options);
46
50 ~GPIOOutputPort() {}
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 GPIOOutputPort(const GPIOOutputPort &) = delete;
66 const GPIOOutputPort &operator=(const GPIOOutputPort &) = delete;
67};
68} // namespace gpio
69} // namespace plugin
70} // namespace ola
71#endif // PLUGINS_GPIO_GPIOPORT_H_
DmxBuffer.h
A class used to hold a single universe of DMX data.
ola::BasicOutputPort::BasicOutputPort
BasicOutputPort(AbstractDevice *parent, unsigned int port_id, bool start_rdm_discovery_on_patch=false, bool supports_rdm=false)
Create a new BasicOutputPort.
Definition Port.cpp:120
ola::DmxBuffer
Used to hold a single universe of DMX data.
Definition DmxBuffer.h:49
ola::plugin::gpio::GPIODevice
The GPIO Device.
Definition GPIODevice.h:38
ola::plugin::gpio::GPIOOutputPort
The GPIO Output port.
Definition GPIOPort.h:37
ola::plugin::gpio::GPIOOutputPort::Init
bool Init()
Initialize the port.
Definition GPIOPort.cpp:43
ola::plugin::gpio::GPIOOutputPort::~GPIOOutputPort
~GPIOOutputPort()
Destructor.
Definition GPIOPort.h:50
ola::plugin::gpio::GPIOOutputPort::WriteDMX
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition GPIOPort.cpp:52
ola::plugin::gpio::GPIOOutputPort::Description
std::string Description() const
Fetch the string description for a Port.
Definition GPIOPort.cpp:47
ola::plugin::gpio::GPIOOutputPort::GPIOOutputPort
GPIOOutputPort(GPIODevice *parent, const GPIODriver::Options &options)
Create a new GPIOOutputPort.
Definition GPIOPort.cpp:37
ola::plugin::gpio
The General Purpose digital I/O Plugin.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44
ola::plugin::gpio::GPIODriver::Options
The Options.
Definition GPIODriver.h:43