ETM-Schurig/etm-powersync-plugins
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Migrate unitec plugin documentation

Browse Source
This commit is contained in:
Simon Stürz 2019-06-19 12:13:34 +02:00
parent 92cb9150c7
commit 349244c665
2 changed files with 10 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
unitec/README.md Normal file
View File

@ -0,0 +1,10 @@
# Unitec
This plugin allows to controll RF 433 MHz actors an receive remote signals from [Unitec](http://www.unitec-elektro.de)
devices.
The unitec socket units have a learn function. If you plug in the switch, a red light will start to blink. This means
the socket is in the learning mode. Now you can add a Unitec switch (48111) to nymea with your desired Channel (A,B,C or D).
In order to pair the socket you just have to press the power ON, and the switch has to be in the pairing mode.
If the pairing was successful, the switch will turn on. If the switches will be removed from the socket or there will
be a power breakdown, the switch has to be re-paired. The device can not remember the teached channel.

26
unitec/devicepluginunitec.cpp
View File

@ -20,32 +20,6 @@
* * * *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page unitec.html
\title Unitec
\brief Plugin for Unitech RF 433 MHz devices.
\ingroup plugins
\ingroup nymea-plugins
This plugin allows to controll RF 433 MHz actors an receive remote signals from \l{http://www.unitec-elektro.de}{Unitec}
devices.
The unitec socket units have a learn function. If you plug in the switch, a red light will start to blink. This means
the socket is in the learning mode. Now you can add a Unitec switch (48111) to nymea with your desired Channel (A,B,C or D).
In order to pair the socket you just have to press the power ON, and the switch has to be in the pairing mode.
If the pairing was successful, the switch will turn on. If the switches will be removed from the socket or there will
be a power breakdown, the switch has to be re-paired. The device can not remember the teached channel.
\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/unitec/devicepluginunitec.json
*/
#include "devicepluginunitec.h" #include "devicepluginunitec.h"
#include "devicemanager.h" #include "devicemanager.h"
#include "plugininfo.h" #include "plugininfo.h"