Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SPIPlugin.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  * SPIPlugin.h
17  * An SPI plugin.
18  * Copyright (C) 2013 Simon Newton
19  */
20 
21 #ifndef PLUGINS_SPI_SPIPLUGIN_H_
22 #define PLUGINS_SPI_SPIPLUGIN_H_
23 
24 #include <string>
25 #include <vector>
26 #include "olad/Plugin.h"
27 #include "ola/plugin_id.h"
28 
29 namespace ola {
30 namespace plugin {
31 namespace spi {
32 
33 class SPIPlugin: public ola::Plugin {
34  public:
35  explicit SPIPlugin(class ola::PluginAdaptor *plugin_adaptor)
36  : Plugin(plugin_adaptor) {}
37 
38  std::string Name() const { return PLUGIN_NAME; }
39  std::string Description() const;
40  ola_plugin_id Id() const { return OLA_PLUGIN_SPI; }
41  std::string PluginPrefix() const { return PLUGIN_PREFIX; }
42 
43  private:
44  std::vector<class SPIDevice*> m_devices;
45 
46  bool StartHook();
47  bool StopHook();
48  bool SetDefaultPreferences();
49 
50  static const char DEFAULT_BASE_UID[];
51  static const char DEFAULT_SPI_DEVICE_PREFIX[];
52  static const char PLUGIN_NAME[];
53  static const char PLUGIN_PREFIX[];
54  static const char SPI_BASE_UID_KEY[];
55  static const char SPI_DEVICE_PREFIX_KEY[];
56 };
57 } // namespace spi
58 } // namespace plugin
59 } // namespace ola
60 #endif // PLUGINS_SPI_SPIPLUGIN_H_
ola_plugin_id Id() const
Get the plugin ID of this plugin.
Definition: SPIPlugin.h:40
std::string PluginPrefix() const
The prefix to use for storing configuration files.
Definition: SPIPlugin.h:41
std::string Description() const
Definition: SPIPlugin.cpp:116
Definition: SPIPlugin.h:33
Definition: Plugin.h:118
Definition: PluginAdaptor.h:41
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
std::string Name() const
Get the plugin name.
Definition: SPIPlugin.h:38