Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
NanoleafPluginDescription.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  * NanoleafPluginDescription.h
17  * Contains the description for the nanoleaf plugin.
18  * Copyright (C) 2016 Florian Edelmann
19  *
20  * This file has been autogenerated by convert_README_to_header.sh, DO NOT EDIT.
21  */
22 #ifndef PLUGINS_NANOLEAF_NANOLEAFPLUGINDESCRIPTION_H_
23 #define PLUGINS_NANOLEAF_NANOLEAFPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace nanoleaf {
28 
29 const char plugin_description[] = "Nanoleaf Plugin\n"
30 "============\n"
31 "\n"
32 "This plugin creates a device per IP, each with one output port. Each port\n"
33 "represents a Nanoleaf Aurora controller, with up to 30 panels attached.\n"
34 "This plugin uses the streaming external control effects functionality of\n"
35 "the Aurora OpenAPI.\n"
36 "\n"
37 "Currently only the [Nanoleaf\n"
38 "Aurora](https://nanoleaf.me/en/consumer-led-lighting/products/\n"
39 "smarter-series/nanoleaf-light-panels-smarter-kit/)\n"
40 "is supported.\n"
41 "\n"
42 "\n"
43 "## Config file: `ola-nanoleaf.conf`\n"
44 "\n"
45 "`controller = <ip>` \n"
46 "The IP of the controller to send to. You can communicate with more than\n"
47 "one controller by adding multiple `controller =` lines\n"
48 "\n"
49 "### Per Device Settings\n"
50 "\n"
51 "`<controller IP>-port = <int>`\n"
52 "The port to stream to on the controller, range is 1 - 65535.\n"
53 "\n"
54 "`<controller IP>-panels = [int]`\n"
55 "The list of panel IDs to control, each panel is mapped to three DMX512 slots\n"
56 "(for Red, Green and Blue).";
57 
58 } // namespace nanoleaf
59 } // namespace plugin
60 } // namespace ola
61 
62 #endif // PLUGINS_NANOLEAF_NANOLEAFPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44