update plugin documentation
This commit is contained in:
Simon Stürz
Michael Zanetti
parent
e30aace156
commit
c837d2c3af
@ -1,7 +0,0 @@
|
||||
/*!
|
||||
\page bluetooth-index.html
|
||||
\title Bluetooth Plugins
|
||||
|
||||
\annotatedlist bluetooth
|
||||
*/
|
||||
|
||||
@ -22,12 +22,6 @@
|
||||
\li \l{CoAP}{The CoAP API}
|
||||
\endlist
|
||||
\li \l{Plugins}{The guh plugins}
|
||||
\list
|
||||
\li \l{RF 433 MHz Plugins}
|
||||
\li \l{Service Plugins}
|
||||
\li \l{Network Plugins}
|
||||
\li \l{Bluetooth Plugins}
|
||||
\endlist
|
||||
\endlist
|
||||
|
||||
\section1 API's
|
||||
|
||||
@ -2,19 +2,16 @@
|
||||
\page plugins.html
|
||||
\title Plugins
|
||||
|
||||
Here you can find the current list of supported plugins.
|
||||
Here you can find the current list of supported plugins sorted by the corresponding package.
|
||||
|
||||
\section2 RF 433 MHz Plugins
|
||||
\annotatedlist rf433
|
||||
\section2 The default \tt{guh-plugins} package:
|
||||
\annotatedlist guh-plugins
|
||||
|
||||
\section2 Services
|
||||
\annotatedlist services
|
||||
\section2 The \tt{guh-plugins-merkur} package:
|
||||
\annotatedlist guh-plugins-merkur
|
||||
|
||||
\section2 Network Plugins
|
||||
\annotatedlist network
|
||||
|
||||
\section1 Bluetooth Plugins
|
||||
\annotatedlist bluetooth
|
||||
\section2 The \tt{guh-tests} plugins:
|
||||
\annotatedlist guh-tests
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
/*!
|
||||
\page rf433-index.html
|
||||
\title RF 433 MHz Plugins
|
||||
|
||||
\annotatedlist rf433
|
||||
*/
|
||||
|
||||
@ -1,7 +0,0 @@
|
||||
/*!
|
||||
\page services-index.html
|
||||
\title Service Plugins
|
||||
|
||||
\annotatedlist services
|
||||
*/
|
||||
|
||||
@ -21,6 +21,7 @@
|
||||
/*!
|
||||
\page awattar.html
|
||||
\title aWATTar
|
||||
\brief Plugin for aWATTar, an austrian energy provider.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-plugins
|
||||
@ -58,14 +59,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/awattar/devicepluginawattar.json
|
||||
*/
|
||||
|
||||
@ -22,9 +22,10 @@
|
||||
/*!
|
||||
\page commandlauncher.html
|
||||
\title Application and script launcher
|
||||
\brief Plugin for system commands.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup services
|
||||
\ingroup guh-plugins
|
||||
|
||||
The application and script launcher plugin allows you to execute bash commands and start bash scripts.
|
||||
|
||||
@ -88,14 +89,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": true}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/commandlauncher/deviceplugincommandlauncher.json
|
||||
*/
|
||||
|
||||
@ -22,9 +22,10 @@
|
||||
/*!
|
||||
\page conrad.html
|
||||
\title Conrad
|
||||
\brief Plugin for Conrad 433 MHz devices.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup rf433
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{http://www.conrad.at}{Conrad}
|
||||
devices.
|
||||
@ -33,14 +34,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/conrad/devicepluginconrad.json
|
||||
*/
|
||||
|
||||
@ -21,6 +21,7 @@
|
||||
/*!
|
||||
\page datetime.html
|
||||
\title Time
|
||||
\brief Plugin for timezone based time information.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-plugins
|
||||
@ -83,14 +84,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/datetime/deviceplugindatetime.json
|
||||
*/
|
||||
|
||||
@ -21,6 +21,7 @@
|
||||
/*!
|
||||
\page dollhouse.html
|
||||
\title Dollhouse
|
||||
\brief Plugin for a guh demo booth based on 6LoWPAN networking.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-plugins-merkur
|
||||
@ -31,16 +32,9 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
|
||||
\quotefile plugins/deviceplugins/datetime/deviceplugindollhouse.json
|
||||
\quotefile plugins/deviceplugins/dollhouse/deviceplugindollhouse.json
|
||||
*/
|
||||
|
||||
#include "deviceplugindollhouse.h"
|
||||
|
||||
@ -19,9 +19,10 @@
|
||||
/*!
|
||||
\page elgato.html
|
||||
\title Elgato
|
||||
\brief Plugin for Elgato Avea Blutooth lamp.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup bluetooth
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to find and controll the Bluetooth Low Energy bulb from \l{https://www.elgato.com/en/smart/avea}{Elgato Avea}.
|
||||
|
||||
@ -388,11 +389,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/elgato/devicepluginelgato.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page elro.html
|
||||
\title Elro
|
||||
\brief Plugin for all Elro 433 MHz based devices.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup rf433
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{http://www.elroshop.eu/}{Elro}
|
||||
devices.
|
||||
@ -32,14 +33,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/elro/devicepluginelro.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page eq3.html
|
||||
\title eQ-3 Max!
|
||||
\brief Plugin for the eQ-3 heating system.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup services
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to find and controll devices from Max!(eQ-3). To use this devices, you need at least
|
||||
one \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-lgw-o-tw.html}{Max! Cube LAN Gateway}
|
||||
@ -53,14 +54,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/eq-3/deviceplugineq-3.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page genericelements.html
|
||||
\title Generic elements
|
||||
\brief Common elements to test the rule engine.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup services
|
||||
\ingroup guh-plugins
|
||||
|
||||
The generic elements plugin allows you create virtual buttons, which can be connected with a rule. This gives you
|
||||
the possibility to execute multiple \l{Action}{Actions} with one signal. Without a rule this generic elements are
|
||||
@ -43,14 +44,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/genericelements/deviceplugingenericelements.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page intertechno.html
|
||||
\title Intertechno
|
||||
\brief Plugin for InterTechno 433 MHz devices.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup rf433
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from
|
||||
\l{http://www.intertechno.at}{Intertechno} devices.
|
||||
@ -32,14 +33,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/intertechno/devicepluginintertechno.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page kodi.html
|
||||
\title Kodi - Media Center
|
||||
\brief Plugin for the Kodi media center.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allowes you to controll the media center \l{http://kodi.tv/}{Kodi}. If you want to discover
|
||||
and control Kodi with guh, you need to activate the remote access and the UPnP service.
|
||||
@ -53,14 +54,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": true}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/kodi/devicepluginkodi.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page leynew.html
|
||||
\title Leynew
|
||||
\brief Plugin for the Leynew RF 433 MHz led controller.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup rf433
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{http://www.leynew.com/en/}{Leynew}
|
||||
devices.
|
||||
@ -38,14 +39,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/leynew/devicepluginleynew.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page lgsmarttv.html
|
||||
\title LG Smart Tv
|
||||
\brief Plugin for LG smart TVs.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to interact with \l{http://www.lg.com/us/experience-tvs/smart-tv}{LG Smart Tv's}
|
||||
with the \l{http://developer.lgappstv.com/TV_HELP/index.jsp?topic=%2Flge.tvsdk.references.book%2Fhtml%2FUDAP%2FUDAP%2FLG+UDAP+2+0+Protocol+Specifications.htm}{LG UDAP 2.0 Protocol Specifications}.
|
||||
@ -32,14 +33,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/lgsmarttv/devicepluginlgsmarttv.json
|
||||
*/
|
||||
|
||||
@ -22,9 +22,10 @@
|
||||
/*!
|
||||
\page lirc.html
|
||||
\title LIRC
|
||||
\brief Plugin for the LIRC infrared daemon.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to interact with \l{http://www.lirc.org/}{LIRC} daemon and controll commonly used remote controls.
|
||||
If lircd (LIRC daemon) is configured on your system, guh will connect to the lirc daemon and all configured remote
|
||||
@ -34,14 +35,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/lircd/devicepluginlircd.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page mailnotification.html
|
||||
\title Mail Notification
|
||||
\brief Plugin which allowes to get mail notification from guh.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup services
|
||||
\ingroup guh-plugins
|
||||
|
||||
The mail notification plugin allows you to send a mail notification from a mail
|
||||
account by performing an \l{Action}.
|
||||
@ -32,32 +33,26 @@
|
||||
This will be changed soon...
|
||||
|
||||
\chapter Supported services
|
||||
\section2 Google Mail
|
||||
With the Google Mail Notification you can send a mail with your gmail address to a recipient. The
|
||||
username is your mail address (e.g. "chuck.norris@gmail.com"). The recipient will receive the notification
|
||||
from your gmail account.
|
||||
|
||||
\section2 Yahoo Mail
|
||||
The Yahoo Mail Notification you can send a mail with your yahoo address to a recipient. The username
|
||||
is your mail address (e.g. "chuck.norris@yahoo.com"). The recipient will receive the notification
|
||||
from your yahoo account.
|
||||
\section2 Google Mail
|
||||
With the Google Mail Notification you can send a mail with your gmail address to a recipient. The
|
||||
username is your mail address (e.g. "chuck.norris@gmail.com"). The recipient will receive the notification
|
||||
from your gmail account.
|
||||
|
||||
\section2 Custom Mail
|
||||
With the Custom Mail Notification you can set up a custom SMTP connection. The supported authentification
|
||||
methods are ["PLAIN", "LOGIN"], the supported encryption methods are ["NONE", "SSL", "TLS"].
|
||||
\section2 Yahoo Mail
|
||||
The Yahoo Mail Notification you can send a mail with your yahoo address to a recipient. The username
|
||||
is your mail address (e.g. "chuck.norris@yahoo.com"). The recipient will receive the notification
|
||||
from your yahoo account.
|
||||
|
||||
\section2 Custom Mail
|
||||
With the Custom Mail Notification you can set up a custom SMTP connection. The supported authentification
|
||||
methods are ["PLAIN", "LOGIN"], the supported encryption methods are ["NONE", "SSL", "TLS"].
|
||||
|
||||
\chapter Plugin properties
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/mailnotification/devicepluginmailnotification.json
|
||||
*/
|
||||
|
||||
@ -19,6 +19,25 @@
|
||||
* *
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/*!
|
||||
\page mockdevices.html
|
||||
\title Mock devices
|
||||
\brief Devices for the guh test base.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-tests
|
||||
|
||||
The mock devices are used for testing.
|
||||
|
||||
\chapter Plugin properties
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/mailnotification/devicepluginmailnotification.json
|
||||
*/
|
||||
|
||||
#include "devicepluginmock.h"
|
||||
#include "httpdaemon.h"
|
||||
|
||||
|
||||
@ -20,10 +20,11 @@
|
||||
|
||||
/*!
|
||||
\page netatmo.html
|
||||
\title netatmo
|
||||
\title Netatmo
|
||||
\brief Plugin for the Netatmo weather stations.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to receive data from you netatmo weather station.
|
||||
|
||||
@ -31,14 +32,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/netatmo/devicepluginnetatmo.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page openweathermap.html
|
||||
\title Open Weather Map
|
||||
\brief Plugin for the Open Weather Map online weather service.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup services
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to get the current weather data from \l{http://www.openweathermap.org}{OpenWeatherMap}.
|
||||
The weather data will be refreshed every 15 minutes automatically, but can also refreshed manually.
|
||||
@ -39,14 +40,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/openweathermap/devicepluginopenweathermap.json
|
||||
*/
|
||||
|
||||
@ -19,6 +19,23 @@
|
||||
* *
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/*!
|
||||
\page orderbutton.html
|
||||
\title Orderbutton
|
||||
\brief Demonstration of an orderbutton based on 6LoWPAN networking.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-plugins-merkur
|
||||
|
||||
|
||||
\chapter Plugin properties
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/orderbutton/devicepluginorderbutton.json
|
||||
*/
|
||||
|
||||
#include "devicepluginorderbutton.h"
|
||||
#include "plugin/device.h"
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page osdomotics.html
|
||||
\title OSDomotics
|
||||
\brief Plugin for the OSDomotics Merkur board based on the OSDomotics tutorials.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins-merkur
|
||||
|
||||
This plugin allows you to connect guh to a 6LoWPAN network by adding a Mercury Board from OSDomotics
|
||||
as a RPL router to your devices \l{http://osdwiki.open-entry.com/doku.php/de:tutorials:contiki:merkur_board_rpl_usb_router}{OSDomotics Tutorial- RPL Router}.
|
||||
@ -35,14 +36,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/osdomotics/devicepluginosdomotics.json
|
||||
*/
|
||||
|
||||
@ -22,9 +22,10 @@
|
||||
/*!
|
||||
\page philipshue.html
|
||||
\title Philips hue
|
||||
\brief Plugin for the Philips Hue lighting system.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to interact with the \l{http://www2.meethue.com/}{Philips hue} bridge. Each light bulp connected to the bridge
|
||||
will appear automatically in the system, once the bridge is added to guh.
|
||||
@ -33,14 +34,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/philipshue/devicepluginphilipshue.json
|
||||
*/
|
||||
|
||||
@ -19,6 +19,24 @@
|
||||
* *
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/*!
|
||||
\page plantcare.html
|
||||
\title Plantcare
|
||||
\brief Plugin for the guh Plantcare example based on 6LoWPAN networking.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-plugins-merkur
|
||||
|
||||
This allowes to controll the guh plantcare demo for 6LoWPAN networks.
|
||||
|
||||
\chapter Plugin properties
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/plantcare/devicepluginplantcare.json
|
||||
*/
|
||||
|
||||
#include "devicepluginplantcare.h"
|
||||
#include "plugin/device.h"
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page udpcommander.html
|
||||
\title UDP Commander
|
||||
\brief Plugin for catching UDP commands from the network.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to receive UDP packages over a certain UDP port and generates an \l{Event} if the message content matches
|
||||
the \l{Param} command.
|
||||
@ -50,14 +51,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/udpcommander/devicepluginudpcommander.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page unitec.html
|
||||
\title Unitec
|
||||
\brief Plugin for Unitech RF 433 MHz devices.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup rf433
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{http://www.unitec-elektro.de}{Unitec}
|
||||
devices.
|
||||
@ -32,14 +33,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/unitec/devicepluginunitec.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page wakeonlan.html
|
||||
\title Wake On Lan
|
||||
\brief Plugin for wake up devices in the LAN (wol).
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
Wake-on-LAN (WOL) is an Ethernet computer networking standard that allows a computer
|
||||
to be turned on or awakened by a network message. This plugin allows you to send a
|
||||
@ -35,14 +36,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/wakeonlan/devicepluginwakeonlan.json
|
||||
*/
|
||||
|
||||
@ -21,9 +21,10 @@
|
||||
/*!
|
||||
\page wemo.html
|
||||
\title WeMo
|
||||
\brief Plugin for Belkin WeMo sockets.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to find and controll devices from WeMo, the
|
||||
\l{http://www.belkin.com/de/PRODUKTE/home-automation/c/wemo-home-automation/}{Belkin}
|
||||
@ -36,14 +37,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/wemo/devicepluginwemo.json
|
||||
*/
|
||||
|
||||
@ -22,9 +22,10 @@
|
||||
/*!
|
||||
\page wifidetector.html
|
||||
\title WiFi Detector
|
||||
\brief Plugin to monitor devices in the local network.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup network
|
||||
\ingroup guh-plugins
|
||||
|
||||
This plugin allows to find and monitor network devices in your local network by using the MAC address.
|
||||
|
||||
@ -34,14 +35,7 @@
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
Each \l{DeviceClass} has a list of \l{ParamType}{paramTypes}, \l{ActionType}{actionTypes}, \l{StateType}{stateTypes}
|
||||
and \l{EventType}{eventTypes}. The \l{DeviceClass::CreateMethod}{createMethods} parameter describes how the \l{Device}
|
||||
will be created in the system. A device can have more than one \l{DeviceClass::CreateMethod}{CreateMethod}.
|
||||
The \l{DeviceClass::SetupMethod}{setupMethod} describes the setup method of the \l{Device}.
|
||||
The detailed implementation of each \l{DeviceClass} can be found in the source code.
|
||||
|
||||
\note If a \l{StateType} has the parameter \tt{"writable": {...}}, an \l{ActionType} with the same uuid and \l{ParamType}{ParamTypes}
|
||||
will be created automatically.
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/wifidetector/devicepluginwifidetector.json
|
||||
*/
|
||||
|
||||
@ -19,6 +19,24 @@
|
||||
* *
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/*!
|
||||
\page ws2812.html
|
||||
\title ws2812
|
||||
\brief Plugin to controll ws2812 LEDs based on 6LoWPAN networking.
|
||||
|
||||
\ingroup plugins
|
||||
\ingroup guh-plugins-merkur
|
||||
|
||||
The plugin for the \l{http://cdn.sparkfun.com/datasheets/Components/LED/WS2812.pdf}{ws2812} led module. This plugin allowes to control a ws2812 module over a 6LoWPAN network.
|
||||
|
||||
\chapter Plugin properties
|
||||
Following JSON file contains the definition and the description of all available \l{DeviceClass}{DeviceClasses}
|
||||
and \l{Vendor}{Vendors} of this \l{DevicePlugin}.
|
||||
|
||||
For more details how to read this JSON file please check out the documentation for \l{The plugin JSON File}.
|
||||
|
||||
\quotefile plugins/deviceplugins/ws2812/devicepluginws2812.json
|
||||
*/
|
||||
|
||||
#include "devicepluginws2812.h"
|
||||
#include "plugin/device.h"
|
||||
|
||||
Reference in New Issue
Block a user