Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UsbDmxPluginDescription.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  * UsbDmxPluginDescription.h
17  * Contains the description for the usbdmx 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_USBDMX_USBDMXPLUGINDESCRIPTION_H_
23 #define PLUGINS_USBDMX_USBDMXPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace usbdmx {
28 
29 const char plugin_description[] = "USB DMX Plugin\n"
30 "==============\n"
31 "\n"
32 "This plugin supports various USB DMX devices including:\n"
33 "\n"
34 "* Anyma uDMX\n"
35 "* AVLdiy D512\n"
36 "* DMXControl Projects e.V. Nodle U1\n"
37 "* DMXCreator 512 Basic\n"
38 "* Eurolite USB-DMX512 PRO\n"
39 "* Eurolite USB-DMX512 PRO MK2 (when `enable_eurolite_mk2 = true`)\n"
40 "* Fadecandy\n"
41 "* ShowJockey SJ-DMX-U1\n"
42 "* Sunlite USBDMX2\n"
43 "* Velleman K8062.\n"
44 "\n"
45 "\n"
46 "## Config file : `ola-usbdmx.conf`\n"
47 "\n"
48 "`libusb_debug_level = {0,1,2,3,4}` \n"
49 "The debug level for libusb, see http://libusb.sourceforge.net/api-1.0/ \n"
50 "0 = No logging, 4 = Verbose debug.\n"
51 "\n"
52 "`enable_eurolite_mk2 = {false,true}`\n"
53 "Whether to enable detection of the Eurolite USB-DMX512 PRO MK2.\n"
54 "Default = false. This device is indistinguishable from other devices\n"
55 "with an FTDI chip, and is therefore disabled by default. When enabled,\n"
56 "this plugin will conflict with the usbserial, StageProfi and FTDI USB DMX\n"
57 "plugins.\n"
58 "\n"
59 "`nodle-<serial>-mode = {0,1,2,3,4,5,6,7}` \n"
60 "The mode for the Nodle U1 interface with serial number `<serial>` to operate\n"
61 "in. Default = 6 \n"
62 "0 - Standby \n"
63 "1 - DMX In -> DMX Out \n"
64 "2 - PC Out -> DMX Out \n"
65 "3 - DMX In + PC Out -> DMX Out \n"
66 "4 - DMX In -> PC In \n"
67 "5 - DMX In -> DMX Out & DMX In -> PC In \n"
68 "6 - PC Out -> DMX Out & DMX In -> PC In \n"
69 "7 - DMX In + PC Out -> DMX Out & DMX In -> PC In";
70 
71 } // namespace usbdmx
72 } // namespace plugin
73 } // namespace ola
74 
75 #endif // PLUGINS_USBDMX_USBDMXPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44