Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
OPCPluginDescription.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  * OPCPluginDescription.h
17  * Contains the description for the openpixelcontrol 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_OPENPIXELCONTROL_OPCPLUGINDESCRIPTION_H_
23 #define PLUGINS_OPENPIXELCONTROL_OPCPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace openpixelcontrol {
28 
29 const char plugin_description[] = "OPC Plugin\n"
30 "==========\n"
31 "\n"
32 "This plugin creates OPC Client and/or OPC Server Devices.\n"
33 "\n"
34 "\n"
35 "## Config file: `ola-opc.conf`\n"
36 "\n"
37 "`target = <IP>:<port>` \n"
38 "Create a Open Pixel Control client, connected to the `IP:port`. Multiple\n"
39 "targets can be specified and a device will be created for each.\n"
40 "\n"
41 "`listen = <IP>:<port>` \n"
42 "Create an Open Pixel Control server, listening on `IP:port`. To listen on\n"
43 "any address use `listen = 0.0.0.0`. Multiple listen keys can be specified\n"
44 "and a device will be created for each.\n"
45 "\n"
46 "`target_<IP>:<port>_channel = <channel>` \n"
47 "The Open Pixel Control channels to use for the specified device. Multiple\n"
48 "channels can be specified and an output port will be created for each.\n"
49 "\n"
50 "`listen_<IP>:<port>_channel = <channel>` \n"
51 "The Open Pixel Control channels to use for the specified device. Multiple\n"
52 "channels can be specified and an input port will be created for each.";
53 
54 } // namespace openpixelcontrol
55 } // namespace plugin
56 } // namespace ola
57 
58 #endif // PLUGINS_OPENPIXELCONTROL_OPCPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44