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

Migrate eq-3 plugin documentation

Browse Source
This commit is contained in:
Simon Stürz 2019-05-30 14:17:44 +02:00
parent cbc45f5b57
commit e1e602e68f
2 changed files with 29 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
eq-3/README.md Normal file
View File

@ -0,0 +1,29 @@
# eQ-3
This plugin allows to find and control devices from Max!(eQ-3). To use this devices, you need at least
one [Max! Cube LAN Gateway](http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-lgw-o-tw.html)
in you local network. Once the cube is connected (DHCP), you can auto detect the cube in the network and
add it to your [nymea](https://nymea.io) devices. Also more than one cube in the network is supported. All
devices, which are connected to a cube, will be autogenerated. For the setup of a cube, the original
software is recomanded (min/max setpoint temperature, weekly program...).
## Supported devices
### Max! Cube LAN Gateway
This [cube](http://www.eq-3.de/max-heizungssteuerung-produktdetail/
items/bc-lgw-o-tw.html) can be discovered in the network. Every device, which is connected with the cube, will be appear automatically, once the cube is configrued and
added to nymea.
### Max! Wall Thermostat
In order to use this device, you need a [Max! Cube LAN Gateway](http://www.eq-3.de/max-heizungssteuerung-produktdetail/
items/bc-lgw-o-tw.html). A [MAX! Wall Thermostat](http://www.eq-3.de/max-raumloesung-produktdetail/items/bc-tc-c-wm.html) can not be added,
it will appear automatically in the device list, once you add it to the cube.
### Max! Radiator Thermostat
In order to use this device, you need a [Max! Cube LAN Gateway](http://www.eq-3.de/max-heizungssteuerung-produktdetail/
items/bc-lgw-o-tw.html). A [MAX! Radiator Thermostat](http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-rt-trx-cyg.html) can not be added,
it will appear automatically in the device list, once you add it to the cube.

42
eq-3/deviceplugineq-3.cpp
View File

@ -20,48 +20,6 @@
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page eq3.html
\title eQ-3 Max!
\brief Plugin for the eQ-3 heating system.
\ingroup plugins
\ingroup nymea-plugins
This plugin allows to find and control 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}
in you local network. Once the cube is connected (DHCP), you can auto detect the cube in the network and
add it to your \l{https://nymea.io}{nymea} devices. Also more than one cube in the network is supported. All
devices, which are connected to a cube, will be autogenerated. For the setup of a cube, the original
software is recomanded (min/max setpoint temperature, weekly program...).
\chapter Supported devices
\section2 Max! Cube LAN Gateway
This \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/
items/bc-lgw-o-tw.html}{cube} can be discovered in the network. Every
device, which is connected with the cube, will be appear automatically, once the cube is configrued and
added to nymea.
\section2 Max! Wall Thermostat
In order to use this device, you need a \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/
items/bc-lgw-o-tw.html}{Max! Cube LAN Gateway}. A \l{http://www.eq-3.de/max-raumloesung-produktdetail/items/bc-tc-c-wm.html}{MAX! Wall Thermostat} can not be added,
it will appear automatically in the device list, once you add it to the cube.
\section2 Max! Radiator Thermostat
In order to use this device, you need a \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/
items/bc-lgw-o-tw.html}{Max! Cube LAN Gateway}. A \l{http://www.eq-3.de/max-heizungssteuerung-produktdetail/items/bc-rt-trx-cyg.html}{MAX! Radiator Thermostat} can not be added,
it will appear automatically in the device list, once you add it to the cube.
\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/eq-3/deviceplugineq-3.json
*/
#include "deviceplugineq-3.h"
#include "plugin/device.h"