Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
RenardPluginDescription.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  * RenardPluginDescription.h
17  * Contains the description for the renard 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_RENARD_RENARDPLUGINDESCRIPTION_H_
23 #define PLUGINS_RENARD_RENARDPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace renard {
28 
29 const char plugin_description[] = "Renard Plugin\n"
30 "=============\n"
31 "\n"
32 "This plugin creates devices with one output port. It supports multiple\n"
33 "Renard SS boards directly connected, or daisy-chained. See this link for\n"
34 "more information:\n"
35 "http://www.doityourselfchristmas.com/wiki/index.php?title=Renard\n"
36 "\n"
37 "\n"
38 "## Config file: `ola-renard.conf`\n"
39 "\n"
40 "`device = /dev/ttyUSB0` \n"
41 "The device to use as a path for the serial port or USB-Serial adapter.\n"
42 "Renard boards don't have a built-in USB port, you will need an adapter\n"
43 "(USB->RS232 or USB->RS485). Multiple devices are supported.\n"
44 "\n"
45 "### Per Device Settings (using above device name without `/dev/`)\n"
46 "`<device>-baudrate = <int>` \n"
47 "The speed of the serial port, options are 9600, 19200, 38400, 57600, 115200.\n"
48 "Default is 57600.\n"
49 "\n"
50 "`<device>-channels = <int>` \n"
51 "The number of channels connected to this device. Default 64. Note that the\n"
52 "max number of channels vary by baud rate and the encoding.\n"
53 "\n"
54 "`<device>-dmx-offset = <int>` \n"
55 "Which starting point in the DMX universe this device is mapped to. The\n"
56 "default is 0, which means the first channel on Renard address 128 (0x80)\n"
57 "will be mapped to DMX channel 1.";
58 
59 } // namespace renard
60 } // namespace plugin
61 } // namespace ola
62 
63 #endif // PLUGINS_RENARD_RENARDPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44