Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
UartDmxPluginDescription.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  * UartDmxPluginDescription.h
17  * Contains the description for the uartdmx 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_UARTDMX_UARTDMXPLUGINDESCRIPTION_H_
23 #define PLUGINS_UARTDMX_UARTDMXPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace uartdmx {
28 
29 const char plugin_description[] = "Native UART DMX Plugin\n"
30 "======================\n"
31 "\n"
32 "This plugin drives a supported POSIX UART (plus extensions) to produce a\n"
33 "direct DMX output stream. The host needs to create the DMX stream itself as\n"
34 "there is no external microcontroller.\n"
35 "\n"
36 "This is tested with the on-board UART of the Raspberry Pi. See here for a\n"
37 "possible schematic:\n"
38 "http://eastertrail.blogspot.co.uk/2014/04/command-and-control-ii.html\n"
39 "\n"
40 "\n"
41 "## Config file: `ola-uartdmx.conf`\n"
42 "\n"
43 "`enabled = true`\n"
44 "Enable this plugin (DISABLED by default).\n"
45 "\n"
46 "`device = /dev/ttyAMA0`\n"
47 "The device to use for DMX output (optional). Multiple devices are supported\n"
48 "if the hardware exists. On later software it may also be /dev/serial0.\n"
49 "Using USB-serial adapters is not supported (try the\n"
50 "*ftdidmx* plugin instead).\n"
51 "\n"
52 "\n"
53 "### Per Device Settings (using above device name)\n"
54 "\n"
55 "`<device>-break = 100`\n"
56 "The DMX break time in microseconds for this device (optional).\n"
57 "\n"
58 "`<device>-malf = 100`\n"
59 "The Mark After Last Frame time in microseconds for this device (optional).";
60 
61 } // namespace uartdmx
62 } // namespace plugin
63 } // namespace ola
64 
65 #endif // PLUGINS_UARTDMX_UARTDMXPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44