Add avahimonitor and boblight README.md

master
Simon Stürz 2019-05-29 10:50:30 +02:00
parent abb4bb8c60
commit a5949ca574
4 changed files with 18 additions and 47 deletions

7
avahimonitor/README.md Normal file
View File

@ -0,0 +1,7 @@
# Avahi Monitor
This plugin allowes you to discover and monitor zeroconf based services in the local network.
This allowes also to monitor the existence of a certain device in the network or just a special service of interest.
More information and explanation of zeroconf can be found [here](http://www.zeroconf.org/).

View File

@ -2,7 +2,7 @@
This plugin allows to receive the current energy market price from the \l{https://www.awattar.com/}{aWATTar GmbH}.
This plugin allows to receive the current energy market price from the [aWATTar GmbH](https://www.awattar.com/).
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).
@ -17,7 +17,7 @@ price is above the average, if the deviation is negative, the current price is b
* 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")
![aWATTar graph](https://raw.githubusercontent.com/guh/nymea-plugins/master/awattar/docs/images/awattar-graph.png "aWATTar graph")
# Heat pump

View File

@ -20,51 +20,6 @@
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*!
\page awattar.html
\title aWATTar
\brief Plugin for aWATTar, an austrian energy provider.
\ingroup plugins
\ingroup nymea-plugins
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 \l{https://www.awattar.com/api-unser-datenfeed}{here}.
\chapter 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.
\list
\li -100 % \unicode{0x2192} current price equals lowest price in the interval [-12h < now < + 12h]
\li 0 % \unicode{0x2192} current price equals average price in the interval [-12h < now < + 12h]
\li +100 % \unicode{0x2192} current price equals highest price in the interval [-12h < now < + 12h]
\endlist
\image awattar-graph.png
\chapter Heat pump
Information about the smart grid modes can be found \l{https://www.waermepumpe.de/sg-ready/}{here}.
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.
\note Currently there should be only one heat pump in the 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/awattar/devicepluginawattar.json
*/
#include "devicepluginawattar.h"
#include "plugin/device.h"

9
boblight/README.md Normal file
View File

@ -0,0 +1,9 @@
# Boblight
This plugin allows to communicate with a [boblight server](https://code.google.com/p/boblight/)
running on `localhost:19333`. If a boblight server is running, the configured light devices from the server will
appear automatically in nymea.
For more information regarding the project please visit the [project site](https://sites.google.com/site/wikikrautbox/krautbox/hardware/boblight).