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