Migrate anel and awattar documentation to markdown

This commit is contained in:
Simon Stürz 2019-05-29 10:36:33 +02:00
parent c99bec1415
commit abb4bb8c60
4 changed files with 37 additions and 18 deletions

8
anel/README.md Normal file
View File

@ -0,0 +1,8 @@
# ANEL Elektronik devices
------------------
This plugin allows to make use of ANEL Elektronik NET-PwrCtrl controlled powet sockets.
See [https://anel-elektronik.de](https://anel-elektronik.de/) for a detailed description of the devices.

View File

@ -1,18 +0,0 @@
/*!
\page anel.html
\title ANEL Elektronik devices
\brief Plugin for ANEL Elektronik NET-PwrCtrl network controlled power sockets.
\ingroup plugins
\ingroup nymea-plugins-maker
This plugin allows to make use of ANEL Elektronik NET-PwrCtrl controlled powet sockets.
See https://anel-elektronik.de/ for a detailed description of the devices.
\chapter Plugin properties
When adding a device it will detect the type of the panel and create a gateway device and a powersocket
device for each of the available sockets on the panel.
\quotefile ../devicepluginanel.json
*/

29
awattar/README.md Normal file
View File

@ -0,0 +1,29 @@
# aWATTar
This plugin allows to receive the current energy market price from the \l{https://www.awattar.com/}{aWATTar GmbH}.
In order to use this plugin you need to enter the access token from your energy provider. You can find more
information about you accesstoken [here](https://www.awattar.com/api-unser-datenfeed).
## Available data
In following chart you can see an example of the market prices from -12 hours to + 12 hours from the current
time (0).The green line describes the current market price, the red point line describes the average
price of this interval and the red line describes the deviation. If the deviation is positiv, the current
price is above the average, if the deviation is negative, the current price is below the average.
* -100 % current price equals lowest price in the interval [-12h < now < + 12h]
* 0 % current price equals average price in the interval [-12h < now < + 12h]
* +100 % current price equals highest price in the interval [-12h < now < + 12h]
![alt text](awattar-graph.png "aWATTar graph")
# Heat pump
Information about the smart grid modes can be found [here](https://www.waermepumpe.de/sg-ready/).
In order to interact with the heat pump (SG-ready), this plugin creates a CoAP connection to the server running on the
6LoWPAN bridge. The server IPv6 can be configured in the plugin configuration. Once the connection is established, the
plugin searches for 6LoWPAN neighbors in the network.

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB