Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
MilInstPluginDescription.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  * MilInstPluginDescription.h
17  * Contains the description for the milinst 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_MILINST_MILINSTPLUGINDESCRIPTION_H_
23 #define PLUGINS_MILINST_MILINSTPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace milinst {
28 
29 const char plugin_description[] = "Milford Instruments Plugin\n"
30 "==========================\n"
31 "\n"
32 "This plugin creates devices with one output port. It currently supports the\n"
33 "1-463 DMX Protocol Converter and 1-553 512 Channel Serial to DMX\n"
34 "Transmitter.\n"
35 "\n"
36 "\n"
37 "## Config file: `ola-milinst.conf`\n"
38 "\n"
39 "`device = /dev/ttyS0` \n"
40 "The device to use as a path for the serial port. Multiple devices are\n"
41 "supported.\n"
42 "\n"
43 "### Per Device Settings\n"
44 "\n"
45 "`<device>-type = [1-463 | 1-553]` \n"
46 "The type of interface.\n"
47 "\n"
48 "#### 1-553 Specific Per Device Settings\n"
49 "\n"
50 "`<device>-baudrate = [9600 | 19200]` \n"
51 "The baudrate to connect at.\n"
52 "\n"
53 "`<device>-channels = [128 | 256 | 512]` \n"
54 "The number of channels to send.";
55 
56 } // namespace milinst
57 } // namespace plugin
58 } // namespace ola
59 
60 #endif // PLUGINS_MILINST_MILINSTPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44