Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GPIOPluginDescription.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  * GPIOPluginDescription.h
17  * Contains the description for the gpio 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_GPIO_GPIOPLUGINDESCRIPTION_H_
23 #define PLUGINS_GPIO_GPIOPLUGINDESCRIPTION_H_
24 
25 namespace ola {
26 namespace plugin {
27 namespace gpio {
28 
29 const char plugin_description[] = "General Purpose I/O Plugin\n"
30 "==========================\n"
31 "\n"
32 "This plugin controls the General Purpose Digital I/O (GPIO) pins on devices\n"
33 "like a Raspberry Pi. It creates a single device, with a single output port.\n"
34 "The offset (start address) of the GPIO pins is configurable.\n"
35 "\n"
36 "\n"
37 "## Config file: `ola-gpio.conf`\n"
38 "\n"
39 "`gpio_pins = [int]` \n"
40 "The list of GPIO pins to control, each pin is mapped to a DMX512 slot.\n"
41 "\n"
42 "`gpio_slot_offset = <int>` \n"
43 "The DMX512 slot for the first pin. Slots are indexed from 1.\n"
44 "\n"
45 "`gpio_turn_on = <int>` \n"
46 "The DMX512 value above which a GPIO pin will be turned on.\n"
47 "\n"
48 "`gpio_turn_off = <int>` \n"
49 "The DMX512 value below which a GPIO pin will be turned off.";
50 
51 } // namespace gpio
52 } // namespace plugin
53 } // namespace ola
54 
55 #endif // PLUGINS_GPIO_GPIOPLUGINDESCRIPTION_H_
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44