Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UsbSerialPluginDescription.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  * UsbSerialPluginDescription.h
17  * Contains the description for the usbpro 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_USBPRO_USBSERIALPLUGINDESCRIPTION_H_
23 #define PLUGINS_USBPRO_USBSERIALPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace usbpro {
28 
29 const char plugin_description[] = "Serial USB Plugin\n"
30 "=================\n"
31 "\n"
32 "This plugin supports DMX USB devices that emulate a serial port. This\n"
33 "includes:\n"
34 "\n"
35 "* Arduino RGB Mixer\n"
36 "* DMX-TRI & RDM-TRI\n"
37 "* DMXking USB DMX512-A, Ultra DMX, Ultra DMX Pro\n"
38 "* DMXter4, DMXter4A & mini DMXter\n"
39 "* Enttec DMX USB Pro & USB Pro Mk II\n"
40 "* Robe Universe Interface\n"
41 "* LumenRadio CRMX Nova TX USB\n"
42 "\n"
43 "See https://wiki.openlighting.org/index.php/USB_Protocol_Extensions for \n"
44 "more info.\n"
45 "\n"
46 "\n"
47 "## Config file: `ola-usbserial.conf`\n"
48 "\n"
49 "`device_dir = /dev` \n"
50 "The directory to look for devices in.\n"
51 "\n"
52 "`device_prefix = ttyUSB` \n"
53 "The prefix of filenames to consider as devices. Multiple keys are allowed.\n"
54 "\n"
55 "`ignore_device = /dev/ttyUSB` \n"
56 "Ignore the device matching this string. Multiple keys are allowed.\n"
57 "\n"
58 "`pro_fps_limit = 190` \n"
59 "The max frames per second to send to a Usb Pro or DMXKing device.\n"
60 "\n"
61 "`tri_use_raw_rdm = [true|false]` \n"
62 "Bypass RDM handling in the {DMX,RDM}-TRI widgets.\n"
63 "\n"
64 "`ultra_fps_limit = 40` \n"
65 "The max frames per second to send to a Ultra DMX Pro device.";
66 
67 } // namespace usbpro
68 } // namespace plugin
69 } // namespace ola
70 
71 #endif // PLUGINS_USBPRO_USBSERIALPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44