Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
EspNetPluginDescription.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  * EspNetPluginDescription.h
17  * Contains the description for the espnet 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_ESPNET_ESPNETPLUGINDESCRIPTION_H_
23 #define PLUGINS_ESPNET_ESPNETPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace espnet {
28 
29 const char plugin_description[] = "Enttec ESP Net Plugin\n"
30 "=====================\n"
31 "\n"
32 "This plugin creates a single device with five input and five output ports.\n"
33 "\n"
34 "ESP supports up to 255 universes. As ESP has no notion of ports, we provide\n"
35 "a fixed number of ports which can be patched to any universe. When sending\n"
36 "data from a port, the data is addressed to the universe the port is patched\n"
37 "to. For example if port 0 is patched to universe 10, the data will be sent\n"
38 "to ESP universe 10.\n"
39 "\n"
40 "\n"
41 "## Config file: `ola-espnet.conf`\n"
42 "\n"
43 "`ip = [a.b.c.d|<interface_name>]` \n"
44 "The IP address or interface name to bind to. If not specified it will use\n"
45 "the first non-loopback interface.\n"
46 "\n"
47 "`name = ola-EspNet` \n"
48 "The name of the node.";
49 
50 } // namespace espnet
51 } // namespace plugin
52 } // namespace ola
53 
54 #endif // PLUGINS_ESPNET_ESPNETPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44