Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
E131PluginDescription.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  * E131PluginDescription.h
17  * Contains the description for the e131 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_E131_E131PLUGINDESCRIPTION_H_
23 #define PLUGINS_E131_E131PLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace e131 {
28 
29 const char plugin_description[] = "E1.31 (Streaming DMX over ACN) Plugin\n"
30 "=====================================\n"
31 "\n"
32 "This plugin creates a single device with a configurable number of input and\n"
33 "output ports.\n"
34 "\n"
35 "Each port can be assigned to a different E1.31 Universe.\n"
36 "\n"
37 "\n"
38 "## Config file: `ola-e131.conf`\n"
39 "\n"
40 "`cid = 00010203-0405-0607-0809-0A0B0C0D0E0F` \n"
41 "The CID to use for this device.\n"
42 "\n"
43 "`dscp = [int]` \n"
44 "The DSCP value to tag the packets with, range is 0 to 63.\n"
45 "\n"
46 "`draft_discovery = [bool]` \n"
47 "Enable the draft (2014) E1.31 discovery protocol.\n"
48 "\n"
49 "`ignore_preview = [true|false]` \n"
50 "Ignore preview data.\n"
51 "\n"
52 "`input_ports = [int]` \n"
53 "The number of input ports to create up to a max of 32.\n"
54 "\n"
55 "`ip = [a.b.c.d|<interface_name>]` \n"
56 "The IP address or interface name to bind to. If not specified it will use\n"
57 "the first non-loopback interface.\n"
58 "\n"
59 "`output_ports = [int]` \n"
60 "The number of output ports to create up to a max of 32.\n"
61 "\n"
62 "`prepend_hostname = [true|false]` \n"
63 "Prepend the hostname to the source name when sending packets.\n"
64 "\n"
65 "`revision = [0.2|0.46]` \n"
66 "Select which revision of the standard to use when sending data. 0.2 is the\n"
67 "standardized revision, 0.46 (default) is the ANSI standard version.";
68 
69 } // namespace e131
70 } // namespace plugin
71 } // namespace ola
72 
73 #endif // PLUGINS_E131_E131PLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44