Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PathportPluginDescription.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  * PathportPluginDescription.h
17  * Contains the description for the pathport 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_PATHPORT_PATHPORTPLUGINDESCRIPTION_H_
23 #define PLUGINS_PATHPORT_PATHPORTPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace pathport {
28 
29 const char plugin_description[] = "Pathway Pathport Plugin\n"
30 "=======================\n"
31 "\n"
32 "This plugin creates a single device with 5 input and 5 output ports.\n"
33 "\n"
34 "The universe the port is patched to corresponds with the DMX channels used\n"
35 "in the PathPort protocol. For example universe 0 is xDMX channels 0 - 511,\n"
36 "universe 1 is xDMX channels 512 - 1023.\n"
37 "\n"
38 "\n"
39 "## Config file: `ola-pathport.conf`\n"
40 "\n"
41 "`dscp = <int>` \n"
42 "Set the DSCP value for the packets. Range is 0-63.\n"
43 "\n"
44 "`ip = [a.b.c.d|<interface_name>]` \n"
45 "The IP address or interface name to bind to. If not specified it will use\n"
46 "the first non-loopback interface.\n"
47 "\n"
48 "`name = ola-Pathport` \n"
49 "The name of the node.\n"
50 "\n"
51 "`node-id = <int>` \n"
52 "The pathport id of the node.";
53 
54 } // namespace pathport
55 } // namespace plugin
56 } // namespace ola
57 
58 #endif // PLUGINS_PATHPORT_PATHPORTPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44