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

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
GPIOPlugin.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 * GPIOPlugin.h
17 * The General Purpose digital I/O plugin.
18 * Copyright (C) 2014 Simon Newton
19 */
20
21#ifndef PLUGINS_GPIO_GPIOPLUGIN_H_
22#define PLUGINS_GPIO_GPIOPLUGIN_H_
23
24#include <string>
25#include "olad/Plugin.h"
26#include "ola/plugin_id.h"
27
28namespace ola {
29namespace plugin {
30namespace gpio {
31
35 class GPIOPlugin: public ola::Plugin {
36 public:
41 explicit GPIOPlugin(class ola::PluginAdaptor *plugin_adaptor)
42 : Plugin(plugin_adaptor),
43 m_device(NULL) {}
44
45 std::string Name() const { return PLUGIN_NAME; }
46 std::string Description() const;
47 ola_plugin_id Id() const { return OLA_PLUGIN_GPIO; }
48 std::string PluginPrefix() const { return PLUGIN_PREFIX; }
49
50 private:
51 class GPIODevice *m_device;
52
53 bool StartHook();
54 bool StopHook();
55 bool SetDefaultPreferences();
56
57 static const char GPIO_PINS_KEY[];
58 static const char GPIO_SLOT_OFFSET_KEY[];
59 static const char GPIO_TURN_OFF_KEY[];
60 static const char GPIO_TURN_ON_KEY[];
61 static const char PLUGIN_NAME[];
62 static const char PLUGIN_PREFIX[];
63
64 GPIOPlugin(const GPIOPlugin &) = delete;
65 const GPIOPlugin &operator=(const GPIOPlugin &) = delete;
66};
67} // namespace gpio
68} // namespace plugin
69} // namespace ola
70#endif // PLUGINS_GPIO_GPIOPLUGIN_H_
ola::PluginAdaptor
Definition PluginAdaptor.h:41
ola::Plugin
Definition Plugin.h:118
ola::Plugin::SetDefaultPreferences
virtual bool SetDefaultPreferences()
Definition Plugin.h:159
ola::plugin::gpio::GPIODevice
The GPIO Device.
Definition GPIODevice.h:38
ola::plugin::gpio::GPIOPlugin
A plugin that drives general purpose digital I/O lines.
Definition GPIOPlugin.h:35
ola::plugin::gpio::GPIOPlugin::GPIOPlugin
GPIOPlugin(class ola::PluginAdaptor *plugin_adaptor)
Create a new GPIOPlugin.
Definition GPIOPlugin.h:41
ola::plugin::gpio::GPIOPlugin::Id
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition GPIOPlugin.h:47
ola::plugin::gpio::GPIOPlugin::PluginPrefix
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition GPIOPlugin.h:48
ola::plugin::gpio::GPIOPlugin::Description
std::string Description() const
Definition GPIOPlugin.cpp:113
ola::plugin::gpio::GPIOPlugin::Name
std::string Name() const
Get the plugin name.
Definition GPIOPlugin.h:45
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