Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ArtNetPluginDescription.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  * ArtNetPluginDescription.h
17  * Contains the description for the artnet 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_ARTNET_ARTNETPLUGINDESCRIPTION_H_
23 #define PLUGINS_ARTNET_ARTNETPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace artnet {
28 
29 const char plugin_description[] = "Art-Net Plugin\n"
30 "==============\n"
31 "\n"
32 "This plugin creates a single device with four input and four output ports\n"
33 "and supports Art-Net, Art-Net 2 and Art-Net 3.\n"
34 "\n"
35 "Art-Net limits a single device (identified by a unique IP) to four input and\n"
36 "four output ports, each bound to a separate Art-Net Port Address (see the\n"
37 "Art-Net spec for more details). The Art-Net Port Address is a 16 bits int,\n"
38 "defined as follows:\n"
39 "\n"
40 "| Bit 15 | Bits 14 - 8 | Bits 7 - 4 | Bits 3 - 0 |\n"
41 "| ------ | ----------- | ---------- | ---------- |\n"
42 "| 0 | Net | Sub-Net | Universe |\n"
43 "\n"
44 "For OLA, the Net and Sub-Net values can be controlled by the config file.\n"
45 "The Universe bits are the `OLA Universe number modulo 16`.\n"
46 "\n"
47 "| Art-Net Net | Art-Net Subnet | OLA Universe | Art-Net Port Address |\n"
48 "| ----------- | -------------- | ------------ | -------------------- |\n"
49 "| 0 | 0 | 0 | 0 |\n"
50 "| 0 | 0 | 1 | 1 |\n"
51 "| 0 | 0 | 15 | 15 |\n"
52 "| 0 | 0 | 16 | 0 |\n"
53 "| 0 | 0 | 17 | 1 |\n"
54 "| 0 | 1 | 0 | 16 |\n"
55 "| 0 | 1 | 1 | 17 |\n"
56 "| 0 | 15 | 0 | 240 |\n"
57 "| 0 | 15 | 15 | 255 |\n"
58 "| 1 | 0 | 0 | 256 |\n"
59 "| 1 | 0 | 1 | 257 |\n"
60 "| 1 | 0 | 15 | 271 |\n"
61 "| 1 | 1 | 0 | 272 |\n"
62 "| 1 | 15 | 0 | 496 |\n"
63 "| 1 | 15 | 15 | 511 |\n"
64 "\n"
65 "That is `Port Address = (Net << 8) + (Subnet << 4) + (Universe % 16)`\n"
66 "\n"
67 "\n"
68 "## Config file: `ola-artnet.conf`\n"
69 "\n"
70 "`always_broadcast = [true|false]` \n"
71 "Use Art-Net v1 and always broadcast the DMX data. Turn this on if you have\n"
72 "devices that don't respond to ArtPoll messages.\n"
73 "\n"
74 "`ip = [a.b.c.d|<interface_name>]` \n"
75 "The ip address or interface name to bind to. If not specified it will use\n"
76 "the first non-loopback interface.\n"
77 "\n"
78 "`long_name = ola - Art-Net node` \n"
79 "The long name of the node.\n"
80 "\n"
81 "`net = 0` \n"
82 "The Art-Net Net to use (0-127).\n"
83 "\n"
84 "`output_ports = 4` \n"
85 "The number of output ports (Send Art-Net) to create. Only the first 4 will\n"
86 "appear in ArtPoll messages\n"
87 "\n"
88 "`short_name = ola - Art-Net node` \n"
89 "The short name of the node (first 17 chars will be used).\n"
90 "\n"
91 "`subnet = 0` \n"
92 "The Art-Net subnet to use (0-15).\n"
93 "\n"
94 "`use_limited_broadcast = [true|false]` \n"
95 "When broadcasting, use the limited broadcast address `255.255.255.255`\n"
96 "rather than the subnet directed broadcast address. Some devices which don't\n"
97 "follow the Art-Net spec require this. This only affects ArtDMX packets.\n"
98 "\n"
99 "`use_loopback = [true|false]` \n"
100 "Enable use of the loopback device.";
101 
102 } // namespace artnet
103 } // namespace plugin
104 } // namespace ola
105 
106 #endif // PLUGINS_ARTNET_ARTNETPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44