Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
DummyPluginDescription.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  * DummyPluginDescription.h
17  * Contains the description for the dummy 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_DUMMY_DUMMYPLUGINDESCRIPTION_H_
23 #define PLUGINS_DUMMY_DUMMYPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace dummy {
28 
29 const char plugin_description[] = "Dummy Plugin\n"
30 "============\n"
31 "\n"
32 "The plugin creates a single device with one port. When used as an output\n"
33 "port it prints the first two bytes of dmx data to stdout.\n"
34 "\n"
35 "The Dummy plugin can also emulate a range of RDM devices. It supports the\n"
36 "following RDM device types:\n"
37 "\n"
38 "* Dummy Device (original)\n"
39 "* Dimmer Rack, with a configurable number of sub-devices\n"
40 "* Moving Light\n"
41 "* Advanced Dimmer Rack, with E1.37-1 PIDs\n"
42 "* A device that responds with ack timers\n"
43 "* Sensor Device, with a number of sensors implemented\n"
44 "* Network Device, with E1.37-2 PIDs\n"
45 "\n"
46 "The number of each type of device is configurable.\n"
47 "\n"
48 "\n"
49 "## Config file: `ola-dummy.conf`\n"
50 "\n"
51 "`ack_timer_count = 0` \n"
52 "The number of ack timer responders to create.\n"
53 "\n"
54 "`advanced_dimmer_count = 0` \n"
55 "The number of E1.37-1 dimmer responders to create.\n"
56 "\n"
57 "`dimmer_count = 1` \n"
58 "The number of dimmer devices to create.\n"
59 "\n"
60 "`dimmer_subdevice_count = 1` \n"
61 "The number of sub-devices each dimmer device should have.\n"
62 "\n"
63 "`dummy_device_count = 1` \n"
64 "The number of dummy devices to create.\n"
65 "\n"
66 "`moving_light_count = 1` \n"
67 "The number of moving light devices to create.\n"
68 "\n"
69 "`sensor_device_count = 1` \n"
70 "The number of sensor-only devices to create.\n"
71 "\n"
72 "`network_device_count = 1` \n"
73 "The number of network E1.37-2 devices to create.";
74 
75 } // namespace dummy
76 } // namespace plugin
77 } // namespace ola
78 
79 #endif // PLUGINS_DUMMY_DUMMYPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44