+
+
+This repository contains integrations for nymea.
+
+nymea (/[n'aiːmea:]/ - is an open source IoT edge server. The plug-in based architecture allows to integrate protocols and APIs. With the build-in rule engine you are able to interconnect devices or services available in the system and create individual scenes and behaviours for your environment.
+
+
+## Getting help
+
+If you want to present your project or want to share your newest developments you can share it in
+[Our Forum](https://forum.nymea.io)
+
+If you are facing any troubles, don't hesitate to reach out for us or the community members, we will be pleased to help you:
+Chat with us on [Telegram](http://t.me/nymeacommunity)
+
+## Documentation
+
+* A detailed description how to install and getting started with the *nymea* can be found here:
+
+ [nymea | user documentation](https://nymea.io/documentation/users/installation/getting-started).
+
+* A detailed documentation for developers can be found here:
+
+ [nymea | developer documentation](https://nymea.io/documentation/developers/).
+
+
+## Contributing
+
+To contribute support for a device or service, you're welcome to file a pull request to this repository. If you need help in creating an integration plugin, feel free to ask in our forum or the Telegram group as well.
+
+If you don't have any developer skills at all, still feel free to bring the topic up. Our community is happy to help wherever possible."
+
+## License
+--------------------------------------------
+> nymea is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License.
diff --git a/anel/README.md b/anel/README.md
index c0f4342e..f46642d1 100644
--- a/anel/README.md
+++ b/anel/README.md
@@ -1,7 +1,36 @@
-# ANEL Elektronik devices
-
-This plugin allows to make use of ANEL Elektronik NET-PwrCtrl controlled power sockets.
+# Anel-Elektronik AG
-See [https://anel-elektronik.de](https://anel-elektronik.de/) for a detailed description of the devices.
+This integration allows nymea to control ANEL Elektronik NET-PwrCtrl power sockets.
+Once a NET-PwrCtl device is added, the associated sockets appear as child devices. Deleting the NET-PwerCtl device will also remove the associated sockets. This means each socket can be named and will appear as an individual socket inside the nymea:app.
+## Supported Things
+* NET-PwrCtl HOME
+* NET-PwrCtl PRO
+ * Includes temperature sensor
+* NET-PwrCtl ADV
+ * Includes temperature sensor
+* NET-PwrCtl HUT
+ * Includes temperature sensor
+ * Includes humidity sensor
+ * Includes light intensity sensor
+
+Each of the mentioned device types supports following features:
+
+* Auto discovery setup
+* Auto rediscovery on IP address change
+* Secure connection with username and password
+* Get and set the state of each socket
+* No internet or cloud connection required
+
+## Requirements
+
+* The NET-PwrCtrl device must be in the same local area network as nymea.
+* UDP multicast on Port 30303 must not be blocked by the router.
+* TCP Sockets on port 80 must not be blocked by the router.
+* Access to the NET-PwrCtl device login credentials.
+* The package “nymea-plugin-anel” must be installed
+
+## More
+
+See https://anel-elektronik.de for a detailed description of the devices.
diff --git a/anel/anel.jpg b/anel/anel.jpg
new file mode 100644
index 00000000..4d39915f
Binary files /dev/null and b/anel/anel.jpg differ
diff --git a/anel/meta.json b/anel/meta.json
new file mode 100644
index 00000000..cf45a28d
--- /dev/null
+++ b/anel/meta.json
@@ -0,0 +1,14 @@
+{
+ "title": "Anel",
+ "tagline": "Integrates Anel with nymea.",
+ "icon": "anel.jpg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "sensor",
+ "socket"
+ ]
+}
diff --git a/aqi/README.md b/aqi/README.md
index 6e18d23f..d940e9d5 100644
--- a/aqi/README.md
+++ b/aqi/README.md
@@ -1,4 +1,3 @@
-
# Air Quality Index
This plug-in gets air quality information from http://aqicn.org.
diff --git a/aqi/aqi.png b/aqi/aqi.png
new file mode 100644
index 00000000..096b1807
Binary files /dev/null and b/aqi/aqi.png differ
diff --git a/aqi/meta.json b/aqi/meta.json
new file mode 100644
index 00000000..1155d047
--- /dev/null
+++ b/aqi/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Air Quality Index",
+ "tagline": "Get air quality index data.",
+ "icon": "aqi.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "online-service"
+ ]
+}
diff --git a/avahimonitor/README.md b/avahimonitor/README.md
index 91559864..84b2cba2 100644
--- a/avahimonitor/README.md
+++ b/avahimonitor/README.md
@@ -1,7 +1,20 @@
# Avahi Monitor
-This plugin allows you to discover and monitor zeroconf based services in the local network.
+This integration plug-in allows nymea to discover and monitor zeroconf services in the local area network.
+Avahi is a free zeroconf implementation and is utilised by nymea. In nymea:app an added Avahi thing will appear as a presence sensor.
-This allows also to monitor the existence of a certain device in the network or just a special service of interest.
+## Supported Things
-More information and explanation of zeroconf can be found [here](http://www.zeroconf.org/).
+* Avahi Monitor
+ * List all zeroconf services in the local area network during device setup
+ * Displays the presence of the zeroconf service
+ * No internet or cloud connection required
+
+## Requirements
+
+* The zeroconf service must be in the same local area network as nymea.
+* The router must not block avahi/zeroconf multicast messages
+* The package “nymea-plugin-avahimonitor” must be installed.
+
+## More
+See http://www.zeroconf.org for more information about the Zeroconf discovery protocol, or see https://www.avahi.org for more information about avahi.
diff --git a/avahimonitor/avahi.svg b/avahimonitor/avahi.svg
new file mode 100644
index 00000000..a2cebf97
--- /dev/null
+++ b/avahimonitor/avahi.svg
@@ -0,0 +1,1207 @@
+
+
+
\ No newline at end of file
diff --git a/avahimonitor/meta.json b/avahimonitor/meta.json
new file mode 100644
index 00000000..1103cec5
--- /dev/null
+++ b/avahimonitor/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Avahi",
+ "tagline": "Discover Avahi devices in your network.",
+ "icon": "avahi.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/awattar/README.md b/awattar/README.md
index 151fb498..1f889f1e 100644
--- a/awattar/README.md
+++ b/awattar/README.md
@@ -1,25 +1,35 @@
# aWATTar
-This plugin allows to receive the current energy market price from the aWATTar GmbH.
-
-* [aWATTar Austria](https://www.awattar.com)
-* [aWATTar Germany](https://www.awattar.de)
+This integration allows to receive the current energy market price from [aWATTar GmbH](https://www.awattar.com/). aWattar is currently available in Austria and Germany.
The Austrian edition of aWATTar requires 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).
-The German servers do not require a token at this point.
-
-## Available data
+## Supported Things
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 positive, 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]
+In the following chart you can see an example of the market prices from -12 hours to + 12 hours.The green line displays the current market prices, the red-dotted line is the average price of the regarding interval and the red line describes the deviation. If the deviation is positive, 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]

+## Requirements
+
+* Valid aWATTar access token for aWATTar Austria.
+ * The German servers do not require a token at this point.
+* aWattar "Hourly" energy tarif.
+* Internet access.
+
+## More
+
+* [aWATTar Austria](https://www.awattar.com)
+* [aWATTar Germany](https://www.awattar.de)
+
+The aWATTar access token is available [here](https://www.awattar.com/api-unser-datenfeed).
diff --git a/awattar/awattar.png b/awattar/awattar.png
new file mode 100644
index 00000000..f1f71f5b
Binary files /dev/null and b/awattar/awattar.png differ
diff --git a/awattar/meta.json b/awattar/meta.json
new file mode 100644
index 00000000..1ad485fc
--- /dev/null
+++ b/awattar/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "aWATTar",
+ "tagline": "Get the latest energy price from aWATTar.",
+ "icon": "awattar.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "online-service"
+ ]
+}
diff --git a/boblight/README.md b/boblight/README.md
index a0690f79..8e117ad7 100644
--- a/boblight/README.md
+++ b/boblight/README.md
@@ -1,9 +1,34 @@
# 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.
+This plugin allows to communicate with a [Boblight server](https://code.google.com/p/boblight/)
+
+The boblight server needs to be installed and running. In nymea it is required to setup the Boblight server connection first, during the setup you can configure how many channels you want to add. Each channel will appear auotamtically as an own device insided nymea. Default configuration for the Boblight server is `localhost:19333`, you can change the parameters during device setup.
+
+Once the Boblight devices are added you can control them like any other color light in nymea.
+
+
+## Supported Things
+
+* Boblight Server
+ * Gateway device
+ * Define channel count
+* Boblight Channel
+ * Color light
+ * Set color
+ * Set color temperature
+ * Set brightness
+ * Set power
+
+**Generall**
+
+* No internet connection required
+
+## Requirements
+
+* Boblight server running on `localhost:19333` or any other reachable IP address.
+* Boblight device connected to the Boblight server.
+* The package "nymea-plugin-boblight" must be installed.
+
+## More
For more information regarding the project please visit the [project site](https://sites.google.com/site/wikikrautbox/krautbox/hardware/boblight).
-
-
diff --git a/boblight/boblight.png b/boblight/boblight.png
new file mode 100644
index 00000000..acee03d0
Binary files /dev/null and b/boblight/boblight.png differ
diff --git a/boblight/meta.json b/boblight/meta.json
new file mode 100644
index 00000000..093c2bb3
--- /dev/null
+++ b/boblight/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Boblight",
+ "tagline": "Connect to Boblight devices.",
+ "icon": "boblight.png",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "light"
+ ]
+}
diff --git a/bose/README.md b/bose/README.md
index 4cf0e523..a35d2616 100644
--- a/bose/README.md
+++ b/bose/README.md
@@ -1,8 +1,27 @@
-# Bose Soundtouch
+# Bose SoundTouch
-This plug-in controls Bose SoundTouch speakers throught the local API.
+This integration plug-in controls Bose SoundTouch speakers throught the local API.
-## Device Setup
+## Supported Things
-To connect the speaker to a WiFi network the Bose SoundTouch app is needed. This plug-in
-supports device discovery. Nymea and the speaker are required to be in the same network.
+* Bose devices from the SoundTouch series
+ * Control the player
+ * Browse presets
+ * Set volume, bass level
+ * Store presets
+ * Auto descovery setup
+ * No internet or cloud connection required
+
+## Requirements
+
+* Any Bose SoundTouch device
+* Bose SoundTouch app installed
+ * to connect the speaker to the WiFi network
+* nymea and the SoundTouch device are required to be in the same network.
+* ZeroConf multicast messages must not be blocked by the router.
+* TCP sockets on port 80 must nor be blocked by the router.
+
+
+## More
+
+https://www.bose.com/en_us/apps/soundtouch.html
diff --git a/bose/bose.svg b/bose/bose.svg
new file mode 100644
index 00000000..b68fd14d
--- /dev/null
+++ b/bose/bose.svg
@@ -0,0 +1,61 @@
+
+
\ No newline at end of file
diff --git a/bose/meta.json b/bose/meta.json
new file mode 100644
index 00000000..9df0021b
--- /dev/null
+++ b/bose/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Bose",
+ "tagline": "Connect to Bose speaker.",
+ "icon": "bose.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "multimedia"
+ ]
+}
diff --git a/coinmarketcap/README.md b/coinmarketcap/README.md
index 13ddcd0e..9a256dd1 100644
--- a/coinmarketcap/README.md
+++ b/coinmarketcap/README.md
@@ -1,7 +1,8 @@
-#CoinMarketCap
+# CoinMarketCap
-The coin market cap plugin gets the latest crypto prices from coin market cap and displays it in your favorite flat currency.
+The coin market cap plugin gets the latest crypto prices from coin market cap and displays it in your favorite fiat currency.
+## Supported Things
Supported cypto currencies:
@@ -16,7 +17,7 @@ Supported cypto currencies:
* miota - IOTA
* ans - NEO
-Supported flat currencies:
+Supported fiat currencies:
* EUR
* USD
@@ -33,3 +34,14 @@ Supported flat currencies:
* KRW
* MXN
* RUB
+
+## Requirements
+
+* Internet connection
+* coinmarketcap.com beeing reachable.
+* The package “nymea-plugin-coinmarketcap” must be installed.
+
+## More
+
+https://coinmarketcap.com/
+
diff --git a/coinmarketcap/coinmarketcap.png b/coinmarketcap/coinmarketcap.png
new file mode 100644
index 00000000..336185a3
Binary files /dev/null and b/coinmarketcap/coinmarketcap.png differ
diff --git a/coinmarketcap/meta.json b/coinmarketcap/meta.json
new file mode 100644
index 00000000..ae6af916
--- /dev/null
+++ b/coinmarketcap/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "CoinMarketCap",
+ "tagline": "Get latest crypto prices from CoinMarketCap.",
+ "icon": "coinmarketcap.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "online-service"
+ ]
+}
diff --git a/commandlauncher/README.md b/commandlauncher/README.md
index 15001422..b008e4f0 100644
--- a/commandlauncher/README.md
+++ b/commandlauncher/README.md
@@ -1,26 +1,28 @@
-# Application and script launcher
+# Application and Bashscript Launcher
This plugin allows you to execute system commands and start bash scripts.
-## Application launcher
+## Usage
+
+### Application launcher
The application launcher allows you to call bash applications or commands with parameters from nymea.
Once, the application started, the `running` state will change to `true`, if the application
is finished, the `running` state will change to `false`.
-### Example
+**Example**
An example command could be [espeak](http://linux.die.net/man/1/espeak). (`apt-get install espeak`)
espeak -v en "Chuck Norris is using nymea"
-## Bash script launcher
+### Bash script launcher
The bashscript launcher allows you to start a bash script (with parameters)
from nymea. Once, the script is running, the `running` state will change to `true`, if the application
is finished, the `running` state will change to `false`.
-### Example
+**Example**
An example for a very useful script could be a backup scrip like following `backup.sh` script.
@@ -57,3 +59,21 @@ To make the script executable use following command:
chmod +x backup.sh
+## Supported Things
+
+* Application launcher
+ * Enter command during thing setup
+ * Get running state
+ * Trigger and kill the command
+* Bashscript launcher
+ * Enter script during thing setup
+ * Get running state
+ * Trigger and kill the script
+
+## Requirements
+
+* The package “nymea-plugin-commandlauncher” must be installed.
+
+## More
+
+https://ubuntu.com/tutorials/command-line-for-beginners
diff --git a/commandlauncher/commandlauncher.svg b/commandlauncher/commandlauncher.svg
new file mode 100644
index 00000000..4ff04de5
--- /dev/null
+++ b/commandlauncher/commandlauncher.svg
@@ -0,0 +1,14 @@
+
+
+
+
diff --git a/commandlauncher/meta.json b/commandlauncher/meta.json
new file mode 100644
index 00000000..0119f590
--- /dev/null
+++ b/commandlauncher/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Command Launcher",
+ "tagline": "Launch local commands or bash scripts.",
+ "icon": "commandlauncher.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/conrad/README.md b/conrad/README.md
index af2c2580..c06a9672 100644
--- a/conrad/README.md
+++ b/conrad/README.md
@@ -1,4 +1,17 @@
# Conrad
-This plugin allows to controll RF 433 MHz actors an receive remote signals from [Conrad](http://www.conrad.at) devices.
+This plugin allows to controll RF 433 MHz actors an receive remote signals from Conrad devices
+
+## Supported Things
+
+* Conrad Shutter (RSM900R)
+ * Up/Down/Sync
+
+## Requirements
+
+* 433 MHz Transceiver
+
+## More
+
+http://www.conrad.de
diff --git a/datetime/README.md b/datetime/README.md
index 2202e986..02d467e8 100644
--- a/datetime/README.md
+++ b/datetime/README.md
@@ -2,10 +2,18 @@
The time plugin allows you to create rules based on time, day, month, year, weekday or on weekend.
+## Usage
+
For the correct setup, you can configure the time zone in the plugin configuration. The language
of the "month name" and "weekday name" depends on the locale settings of your system. To have the correct
time you need [ntp](https://en.wikipedia.org/wiki/Network_Time_Protocol).
+** Today **
+
+The today thing gives you information about the current day and some special times of the day like
+dawn, sunrise, noon, sunset and dawn. In order to get the correct times of the current day for your location, the plugin needs to know where you are. The plugin will autodetect your location according to you WAN IP [http://ip-api.com/json](http://ip-api.com/json) and will download the sunset / sunrise times from the online database [http://sunrise-sunset.org/](http://sunrise-sunset.org/).
+If the configured timezone does not match with the autodetected timezone from the IP, the `specialdates` will be set to 0 (01.01.1970 - 00:00.00).
+
The weekday integer value stands for:
* Monday: `1`
@@ -18,21 +26,31 @@ The weekday integer value stands for:
The *weekend* state will be true, if the current weekday is Saturday or Sunday, otherwise it will be false.
-## Today
+## Supported Things
-The today plugin gives you information about the current day and some special times of the day like
-dawn, sunrise, noon, sunset and dawn. In order to get the correct times of the current day for your location, the plugin needs to know where you are. The plugin will autodetect your location according to you WAN IP [http://ip-api.com/json](http://ip-api.com/json) and will download the sunset / sunrise times from the online database [http://sunrise-sunset.org/](http://sunrise-sunset.org/).
-If the configured timezone does not match with the autodetected timezone from the IP, the `specialdates` will be set to 0 (01.01.1970 - 00:00.00).
+* Today
+ * Get location, country, closest city
+ * Timezone
+ * Get date: weekend, day, month and year
+ * Get astronomic data: dawn, noon, sunset, dusk
+* Alarm
+ * Define time for trigger
+ * Choose trigger to be time or astronomical events.
+ * Set weekdays
+ * Emits an event on alarm
+* Countdown
+ * Specify duration hours/minutes/seconds
+ * Start, stop, restart timer
+ * Get running state
+ * Emits event on timeout
+
+## Requirements
+
+* Internet connection
+* The package 'nymea-plugin-datetime' must be installed.
+
+## More

Special times of a day ([original source](https://en.wikipedia.org/wiki/Twilight#/media/File:Twilight_description_full_day.svg))
-
-## Alarm
-
-The alarm plugin allows you to define an alarm which depends on a certain time, weekday or special day time, like sunrise or
-sunset. An offset can also be defined.
-
-## Countdown
-
-The countdown plugin allows you to define a countdown, which triggers an event on timeout.
diff --git a/datetime/datetime.svg b/datetime/datetime.svg
new file mode 100644
index 00000000..a7ab8b2e
--- /dev/null
+++ b/datetime/datetime.svg
@@ -0,0 +1,15 @@
+
+
+
+
diff --git a/datetime/meta.json b/datetime/meta.json
new file mode 100644
index 00000000..a7b3e0bf
--- /dev/null
+++ b/datetime/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Date and Time",
+ "tagline": "Get astronomical data, set alarm and countdown",
+ "icon": "datetime.svg",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/daylightsensor/daylightsensor.svg b/daylightsensor/daylightsensor.svg
new file mode 100644
index 00000000..f9dd08c4
--- /dev/null
+++ b/daylightsensor/daylightsensor.svg
@@ -0,0 +1,27 @@
+
+
+
+
diff --git a/daylightsensor/meta.json b/daylightsensor/meta.json
new file mode 100644
index 00000000..554fe960
--- /dev/null
+++ b/daylightsensor/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Daylight Sensor",
+ "tagline": "Get sunrise and sundown events.",
+ "icon": "daylightsensor.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/denon/denon.svg b/denon/denon.svg
new file mode 100644
index 00000000..d3e6ef81
--- /dev/null
+++ b/denon/denon.svg
@@ -0,0 +1,144 @@
+
+
+
diff --git a/denon/meta.json b/denon/meta.json
new file mode 100644
index 00000000..5f48f43e
--- /dev/null
+++ b/denon/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Denon",
+ "tagline": "Control Denon Heos and AVR devices.",
+ "icon": "denon.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "multimedia"
+ ]
+}
diff --git a/dweetio/dweetio.png b/dweetio/dweetio.png
new file mode 100644
index 00000000..1a9e5b25
Binary files /dev/null and b/dweetio/dweetio.png differ
diff --git a/dweetio/meta.json b/dweetio/meta.json
new file mode 100644
index 00000000..6f98bc96
--- /dev/null
+++ b/dweetio/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "dweet.io",
+ "tagline": "Get and push data to dweet.io",
+ "icon": "dweetio.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "online-service"
+ ]
+}
diff --git a/dynatrace/README.md b/dynatrace/README.md
index 8f78c5b8..1fb0915e 100644
--- a/dynatrace/README.md
+++ b/dynatrace/README.md
@@ -1,20 +1,11 @@
# Dynatrace
-This plug-in enables nymea to control the Dynatrace Ufo.
-
-The Dynatrace UFO is a sophisticated status light by Dynatrace. More information about the the UFO can be found
-(here)[https://www.dynatrace.com/news/blog/using-dynatrace-devops-pipeline-state-ufo/]. 3D print layouts and
-build instructions for your own UFO are available at this (github page)[https://github.com/Dynatrace/ufo].
+This plug-in enables nymea to control the Dynatrace Ufo. The Dynatrace UFO is a sophisticated status light by Dynatrace.
This nymea integration supports auto discovering UFOs in the network and set them up as a color light in nymea.
Each ring can as well as the top logo can be controlled individually and morph and rotate effects can be enabled.
-## Requirements
-
-* The UFO device must be in the same local are network as nymea.
-* TCP sockets on port 80 must not be blocked by the router.
-* The package "nymea-plugin-dynatrace" must be installed.
-
+## Usage
* Plug it in!
* Press the little black dot on the top. The UFO starts blinking blue and now offers a WiFi hotspot with the name “ufo”
@@ -24,3 +15,27 @@ Each ring can as well as the top logo can be controlled individually and morph a
* While it reboots itself it will blink yellow. Once it has its assigned IP Address it will start visualizing its IP Address through a special „blink code“ as explained in the Quick Start Guide!
* Remember: the UFO will also try to register its hostname as „ufo“ with your DHCP server. If that works you can simply browse to http://ufo
+## Supported Things
+
+* Dynatrace UFO
+ * Network discovery
+ * Color light appearance
+ * Set power
+ * Set color
+ * Set brightness
+ * Set color temperature
+ * Set color for each ring.
+ * Set effect "Morph" or "Whirl" for each ring
+ * Set color for logo
+
+## Requirements
+
+* The UFO device must be in the same local are network as nymea.
+* TCP sockets on port 80 must not be blocked by the router.
+* The package "nymea-plugin-dynatrace" must be installed.
+
+## More
+
+More information about the the UFO can be found
+(here)[https://www.dynatrace.com/news/blog/using-dynatrace-devops-pipeline-state-ufo/]. 3D print layouts and
+build instructions for your own UFO are available at this (github page)[https://github.com/Dynatrace/ufo].
diff --git a/dynatrace/dynatrace.svg b/dynatrace/dynatrace.svg
new file mode 100644
index 00000000..ca30d40b
--- /dev/null
+++ b/dynatrace/dynatrace.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/dynatrace/meta.json b/dynatrace/meta.json
new file mode 100644
index 00000000..5385551f
--- /dev/null
+++ b/dynatrace/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Dynatrace",
+ "tagline": "Connect to the Dynatrace UFO.",
+ "icon": "dynatrace.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "light"
+ ]
+}
diff --git a/elgato/avea.png b/elgato/avea.png
new file mode 100644
index 00000000..9c45bc46
Binary files /dev/null and b/elgato/avea.png differ
diff --git a/elgato/meta.json b/elgato/meta.json
new file mode 100644
index 00000000..fc9577aa
--- /dev/null
+++ b/elgato/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Elgato",
+ "tagline": "Connect to Elgato devices.",
+ "icon": "avea.png",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "bluetooth"
+ ],
+ "categories": [
+ "light"
+ ]
+}
diff --git a/eq-3/eq3.png b/eq-3/eq3.png
new file mode 100644
index 00000000..cfac2577
Binary files /dev/null and b/eq-3/eq3.png differ
diff --git a/eq-3/meta.json b/eq-3/meta.json
new file mode 100644
index 00000000..f70eafef
--- /dev/null
+++ b/eq-3/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "eQ-3",
+ "tagline": "Connect to eQ-3 devices.",
+ "icon": "eq3.png",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "heating"
+ ]
+}
diff --git a/flowercare/meta.json b/flowercare/meta.json
new file mode 100644
index 00000000..73c3c8ec
--- /dev/null
+++ b/flowercare/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Flower Care",
+ "tagline": "Flower Care.",
+ "icon": "xiaomi.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "bluetooth"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/flowercare/xiaomi.svg b/flowercare/xiaomi.svg
new file mode 100644
index 00000000..72c4236e
--- /dev/null
+++ b/flowercare/xiaomi.svg
@@ -0,0 +1,20 @@
+
+
diff --git a/genericelements/genericelements.svg b/genericelements/genericelements.svg
new file mode 100644
index 00000000..3e1a4cf9
--- /dev/null
+++ b/genericelements/genericelements.svg
@@ -0,0 +1,22 @@
+
+
+
+
diff --git a/genericelements/meta.json b/genericelements/meta.json
new file mode 100644
index 00000000..5b9fd6b7
--- /dev/null
+++ b/genericelements/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Generic Elements",
+ "tagline": "Add basic buttons.",
+ "icon": "genericelements.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/genericinterfaces/genericinterfaces.svg b/genericinterfaces/genericinterfaces.svg
new file mode 100644
index 00000000..6fb8fe80
--- /dev/null
+++ b/genericinterfaces/genericinterfaces.svg
@@ -0,0 +1,17 @@
+
+
+
+
diff --git a/genericinterfaces/meta.json b/genericinterfaces/meta.json
new file mode 100644
index 00000000..f0b5bac0
--- /dev/null
+++ b/genericinterfaces/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Generic Interfaces",
+ "tagline": "Add generic device types.",
+ "icon": "genericinterfaces.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/gpio/gpio.svg b/gpio/gpio.svg
new file mode 100644
index 00000000..3e1a4cf9
--- /dev/null
+++ b/gpio/gpio.svg
@@ -0,0 +1,22 @@
+
+
+
+
diff --git a/gpio/meta.json b/gpio/meta.json
new file mode 100644
index 00000000..e94613fa
--- /dev/null
+++ b/gpio/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "GPIO",
+ "tagline": "Control GPIOs for Raspberry Pi or BeagleBone Black.",
+ "icon": "gpio.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ ],
+ "categories": [
+ "sensor",
+ "tool"
+ ]
+}
diff --git a/httpcommander/README.md b/httpcommander/README.md
index fd13a348..c7005944 100644
--- a/httpcommander/README.md
+++ b/httpcommander/README.md
@@ -1,11 +1,22 @@
-# HTTP commander
+# HTTP Commander
-The HTTP commander allows you to send and reqceive generiv HTTP requests.
+The HTTP commander allows to send and receive raw HTTP requests.
-## HTTP Request
+## Supported Things
-Send simple HTTP GET/POST/PUT/DELETE requests. URL and port will be defined during setup, body and HTTP method can be set within every request.
+* HTTP Request
+ * GET/POST/PUT/DELETE
+ * URL and port get defined during thing setup
+ * Body and HTTP method can be set within every request
+* HTTP Server
+ * GET/POST/PUT/DELETE
+ * Get event with HTTP request type, url and body as parameter.
-## HTTP Server
+## Requirements
+
+* The package 'nymea-plugin-httpcommander' must be installed.
+
+## More
+
+https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol
-Simple HTTP Server to receive GET/POST/PUT/DELETE requests. Emits an event including HTTP request type, Url and body as parameter.
diff --git a/httpcommander/httpcommander.svg b/httpcommander/httpcommander.svg
new file mode 100644
index 00000000..9b43e0f9
--- /dev/null
+++ b/httpcommander/httpcommander.svg
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/httpcommander/meta.json b/httpcommander/meta.json
new file mode 100644
index 00000000..44edeeb4
--- /dev/null
+++ b/httpcommander/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "HTTP Commander",
+ "tagline": "Send raw HTTP commands.",
+ "icon": "httpcommander.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/keba/keba.svg b/keba/keba.svg
new file mode 100644
index 00000000..78e6eda7
--- /dev/null
+++ b/keba/keba.svg
@@ -0,0 +1,115 @@
+
+
+
\ No newline at end of file
diff --git a/keba/meta.json b/keba/meta.json
new file mode 100644
index 00000000..116b6309
--- /dev/null
+++ b/keba/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Keba",
+ "tagline": "Control Keba wallbox.",
+ "icon": "keba.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ ]
+}
diff --git a/kodi/README.md b/kodi/README.md
index 2288d959..ec5181f4 100644
--- a/kodi/README.md
+++ b/kodi/README.md
@@ -1,9 +1,8 @@
# Kodi
-This plugin allows to integrate nymea with the [Kodi media center](http://kodi.tv/). The minimum requred version of
-Kodi is 13 (Gotham).
+This plugin allows to integrate nymea with the Kodi media center.
-## Setup
+## Usage
Is is required to enable the following settings in Kodi:
@@ -19,3 +18,25 @@ Once those settings are activated, the kodi system can be added to nymea.
Note: If ZeroConf cannot be used, the device can be added manually and at least the IP, Port and HTTP Port parameters must be given.
It is recommended to configure the Kodi system to a static IP if the manual setup with IP is used. When using discovery, nymea
will re-detect kodi when its IP address changes.
+
+## Supported Things
+
+* Kodi
+ * Set mute and volume
+ * Set playback status
+ * Get information about artist, collection, etc
+ * Skip next, skip back, shuffle, repeat
+ * Navigate buttons
+ * System commands
+ * Browse library
+ * No internet connection required
+
+## Requirements
+
+* Kodi must either be running on the same host or be in the same local area network as nymea.
+* The minimum required version of Kodi is 13 (Gotham).
+* The package “nymea-plugin-kodi” must be installed.
+
+## More
+
+Kodi media center: http://kodi.tv
diff --git a/kodi/kodi.svg b/kodi/kodi.svg
new file mode 100644
index 00000000..ac90da69
--- /dev/null
+++ b/kodi/kodi.svg
@@ -0,0 +1,71 @@
+
+
\ No newline at end of file
diff --git a/kodi/meta.json b/kodi/meta.json
new file mode 100644
index 00000000..a9e372fa
--- /dev/null
+++ b/kodi/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Kodi",
+ "tagline": "Control the Kodi media player.",
+ "icon": "kodi.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "multimedia"
+ ]
+}
diff --git a/lgsmarttv/README.md b/lgsmarttv/README.md
index bfbed57e..feb119db 100644
--- a/lgsmarttv/README.md
+++ b/lgsmarttv/README.md
@@ -1,5 +1,22 @@
# LG Smart TV
-This plugin allows to interact with [LG Smart Tv's](http://www.lg.com/us/experience-tvs/smart-tv)
-with the [LG UDAP 2.0 Protocol Specifications](http://developer.lgappstv.com/TV_HELP/index.jsp?topic=%2Flge.tvsdk.references.book%2Fhtml%2FUDAP%2FUDAP%2FLG+UDAP+2+0+Protocol+Specifications.htm).
+This plugin allows to connect to LG Smart TV's.
+## Supported Things
+
+* LG Smart TV
+ * PIN authentication
+ * Get channel, source, program
+ * Set volume, mute
+ * Power on/off
+ * Menu navigation
+
+## Requirements
+
+* The device must be in the same local area network as nymea.
+* The package 'nymea-plugin-lgsmarttv' must be installed.
+
+## More
+
+[LG Smart Tv's](http://www.lg.com/us/experience-tvs/smart-tv)
+[LG UDAP 2.0 Protocol Specifications](http://developer.lgappstv.com/TV_HELP/index.jsp?topic=%2Flge.tvsdk.references.book%2Fhtml%2FUDAP%2FUDAP%2FLG+UDAP+2+0+Protocol+Specifications.htm).
diff --git a/lgsmarttv/lg.svg b/lgsmarttv/lg.svg
new file mode 100644
index 00000000..3f95ae2a
--- /dev/null
+++ b/lgsmarttv/lg.svg
@@ -0,0 +1,23 @@
+
+
+
+
diff --git a/lgsmarttv/meta.json b/lgsmarttv/meta.json
new file mode 100644
index 00000000..98c04e08
--- /dev/null
+++ b/lgsmarttv/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "LG Smart TV",
+ "tagline": "Connect to the LG Smart TV.",
+ "icon": "lg.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "multimedia"
+ ]
+}
diff --git a/mailnotification/README.md b/mailnotification/README.md
index 73ab1d05..ac984055 100644
--- a/mailnotification/README.md
+++ b/mailnotification/README.md
@@ -3,3 +3,22 @@
The mail notification plugin allows you to send a mail notification from a mail account by performing an action.
> Note: Google mail is currently not supported since that requires OAuth2.0 which is currently a missing feature.
+
+## Supported Things
+
+* E-mail notifications
+ * Username and password login
+ * Send mail
+
+ NOTE: This plug-in is not able to receive E-Mails
+
+## Requirements
+
+* The mail sever must be reachable.
+* Valid user account credentials.
+* The package 'nymea-plugin-mailnotification' must be installed.
+
+## More
+
+https://www.liquidweb.com/kb/how-to-set-up-any-e-mail-client/
+
diff --git a/mailnotification/mailnotification.svg b/mailnotification/mailnotification.svg
new file mode 100644
index 00000000..c666d944
--- /dev/null
+++ b/mailnotification/mailnotification.svg
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/mailnotification/meta.json b/mailnotification/meta.json
new file mode 100644
index 00000000..a362df1e
--- /dev/null
+++ b/mailnotification/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Mail Notification",
+ "tagline": "Send E-Mails.",
+ "icon": "mailnotification.svg",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "notification"
+ ]
+}
diff --git a/mqttclient/README.md b/mqttclient/README.md
index adf49fe8..0fe61d74 100644
--- a/mqttclient/README.md
+++ b/mqttclient/README.md
@@ -1,11 +1,10 @@
-# MQTT client
+# MQTT Client
This plugin allows to subscribe and publish to MQTT brokers (the nymea internal broker and external ones).
> This plugin is ment to be combined with a rule.
-
-## Example
+## Usage
A device is configured to publish its state to a MQTT broker. Using this plugin the user can subscribe to
the same topic on that broker and monitor the device's state.
@@ -14,3 +13,23 @@ Publishing is also supported. This allows use cases such as controlling IoT thin
to topics such devices are subscribed to. Other possibilities are to use nymea as a "translator" between other
transport layers to MQTT. For instance a sensor might deliver sensor data via Bluetooth to Nymea and using this
MQTT plugin and a rule nymea can be configured to forward all those sensor values to a MQTT broker.
+
+## Supported Things
+
+* Internal MQTT client
+ * Define topic
+ * Publish messages
+* MQTT client
+ * Username and password authentication
+ * Topic filter
+ * Received messages
+ * Publish messages
+
+## Requirements
+
+* The package 'nymea-plugin-mqttclient' must be installed.
+
+## More
+
+https://wikipedia.org/wiki/MQTT
+
diff --git a/mqttclient/meta.json b/mqttclient/meta.json
new file mode 100644
index 00000000..5e0aa4dd
--- /dev/null
+++ b/mqttclient/meta.json
@@ -0,0 +1,14 @@
+{
+ "title": "MQTT client",
+ "tagline": "Send and receive raw MQTT messages",
+ "icon": "mqtt.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network",
+ "mqtt"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/mqttclient/mqtt.svg b/mqttclient/mqtt.svg
new file mode 100644
index 00000000..ea9b84b6
--- /dev/null
+++ b/mqttclient/mqtt.svg
@@ -0,0 +1,543 @@
+
+
+
+
diff --git a/nanoleaf/meta.json b/nanoleaf/meta.json
new file mode 100644
index 00000000..784f03e9
--- /dev/null
+++ b/nanoleaf/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Nanoleaf",
+ "tagline": "Control Nanoleaf light panels.",
+ "icon": "nanoleaf.png",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "light"
+ ]
+}
diff --git a/nanoleaf/nanoleaf.png b/nanoleaf/nanoleaf.png
new file mode 100644
index 00000000..4ece80c1
Binary files /dev/null and b/nanoleaf/nanoleaf.png differ
diff --git a/netatmo/README.md b/netatmo/README.md
index d00940c8..84ec1392 100644
--- a/netatmo/README.md
+++ b/netatmo/README.md
@@ -1,3 +1,35 @@
# Netatmo
-This plugin allows to receive data from you netatmo weather station server.
+This plugin integrates the Netatmo Smart Home Weather Station.
+
+## Supported Things
+
+* Netatmo Connection
+ * Netatmo account
+ * Username and password login
+* Indoor Station
+ * Appears automatically
+ * Temperature
+ * Temperature minimum & maximum
+ * Humidity
+ * Pressure
+ * Noise
+ * CO2
+ * WiFi signal strength
+* Outdoor Station
+ * Appears automatically
+ * Temperature
+ * Temperature minimum & maximum
+ * Humidity
+ * Signal strength
+
+## Requirements
+
+* Internet connection
+* Netatmo account credentials
+* The package “nymea-plugin-netatmo” must be installed.
+
+## More
+
+https://www.netatmo.com/en-us/weather/weatherstation
+
diff --git a/netatmo/meta.json b/netatmo/meta.json
new file mode 100644
index 00000000..b1b79758
--- /dev/null
+++ b/netatmo/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Netatmo",
+ "tagline": "Get data from Netatmo weatherstations.",
+ "icon": "netatmo.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/netatmo/netatmo.png b/netatmo/netatmo.png
new file mode 100644
index 00000000..dd5e13bc
Binary files /dev/null and b/netatmo/netatmo.png differ
diff --git a/networkdetector/README.md b/networkdetector/README.md
index 6e859d2f..8c2e0064 100644
--- a/networkdetector/README.md
+++ b/networkdetector/README.md
@@ -2,4 +2,19 @@
This plugin allows to find and monitor network devices in your local network by using the hostname of the devices.
-> Note: the application `nmap` has to be installed and nymea has to run as `root`.
+## Supported Things
+
+* Network Device
+ * Presence sensor appearance
+ * Grace period adjustable
+ * Present and last seen state
+
+## Requirements
+
+* The application `nmap` has to be installed and nymea has to run as `root`.
+* The network devices needs to be in the same local area network as nymea.
+* The package 'nymea-plugin-networkdetector'
+
+## More
+
+https://nmap.org/
diff --git a/networkdetector/meta.json b/networkdetector/meta.json
new file mode 100644
index 00000000..279d07e6
--- /dev/null
+++ b/networkdetector/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Network Detector",
+ "tagline": "Detect devices connected to the LAN.",
+ "icon": "networkdetector.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/networkdetector/networkdetector.svg b/networkdetector/networkdetector.svg
new file mode 100644
index 00000000..15f770e6
--- /dev/null
+++ b/networkdetector/networkdetector.svg
@@ -0,0 +1,11 @@
+
+
+
+
diff --git a/nuki/README.md b/nuki/README.md
index 55891fa1..24693d7f 100644
--- a/nuki/README.md
+++ b/nuki/README.md
@@ -1,3 +1,21 @@
-# nymea-plugin-nuki
+# Nuki
-Device plugin for the [Nuki Smartlock](https://nuki.io/en/) Bluetooth API.
+Integration plugin for the Nuki Smartlock. This plug-in uses Bluetooth to connect to the lock, the Nuki Gateway is not required.
+
+## Supported Things
+
+* Smartlock
+ * Push button authentication
+ * Battery status
+ * Lock status (unlocked, locked ...)
+ * Connection mode
+ * Open, lock, unlock door
+
+## Requirements
+
+* Bluetooth 4.0 interface on the nymea host device.
+* The package 'nymea-plugin-nuki' must be installed.
+
+## More
+
+https://nuki.io/en/
diff --git a/nuki/meta.json b/nuki/meta.json
new file mode 100644
index 00000000..67202c9c
--- /dev/null
+++ b/nuki/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Nuki",
+ "tagline": "Connect Nuki Smartlocks via Bluetooth.",
+ "icon": "nuki.png",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "bluetooth"
+ ],
+ "categories": [
+ "lock"
+ ]
+}
diff --git a/nuki/nuki.png b/nuki/nuki.png
new file mode 100644
index 00000000..68ab7292
Binary files /dev/null and b/nuki/nuki.png differ
diff --git a/onewire/README.md b/onewire/README.md
index c022e19d..71aa816b 100644
--- a/onewire/README.md
+++ b/onewire/README.md
@@ -1,39 +1,60 @@
-# One wire
+# One-Wire
-This plugin allows to add one wire devices through the one wire file system.
+This integration plugin allows to integrate one-wire devices like temperature sensors and switches.
+## Supported Things
-## One wire interface device
-
-This device initializes OWFS, during the device setup you can set OWFS init arguments.
-Default arguments are "--i2c=ALL:ALL" to scan for one-wire devices on all I2C interfaces.
+* OWFS Interface
+ * Gateway device
+ * Initializes OWFS
+* Temperature Sensors
+ * Family Code 10
+ * DS18S20
+ * DS1820
+ * DS18S20-PAR
+ * DS1920
+ * Family Code 22
+ * DS1822
+ * DS1822-PAR
+ * Family Code 28
+ * DS18B20
+ * DS18B20-PAR
+ * DS18B20X
+ * Family Code 3B
+ * DS1825
+* Switches
+ * Family Code 05
+ * Single channel switch
+ * DS2405
+ * Family Code 12
+ * Dual channel switch
+ * DS2406
+ * DS2407
+ * Family Code 3A
+ * Dual channel switch
+ * DS2413
+ * Family Code 29
+ * Eight channel switch
+ * DS2408
+
+## Usage
+
+First step is to setup the "One wire interface". During the device setup it is required to enter the OWFS init arguments. Default arguments are "--i2c=ALL:ALL", means OWFS is about to scan for one-wire bus masters on all I2C interfaces.
You can simulate one-wire device with following init argument: "--fake=10,22,28,05"
More about init arguments here: https://www.owfs.org
-## Supported one-wire devices
+The "One wire interface" thing has the toggle button to "Auto add one wire devices". Is this activated one-wire devices that get connected to the bus will appear in nymea automatically.
+
+NOTE: As long as the "Auto add one wire devices" feature is activated you won't be able to manually discover devices.
+
+## Requirements
+
+* The package “nymea-plugin-onewire” must be installed.
+
+## More
+
+This plug-in uses "OWFS" the one-wire file system: https://owfs.org
+
-* Family Code 10 - Temperature Sensors
-..* DS18S20
-..* DS1820
-..* DS18S20-PAR
-..* DS1920
-* Family Code 22 - Temperature Sensors
-..* DS1822
-..* DS1822-PAR
-* Family Code 28 - Temperature Sensors
-..* DS18B20
-..* DS18B20-PAR
-..* DS18B20X
-* Family Code 3B - Temperature Sensors
-..* DS1825
-* Family Code 05 - Single channel switch
-..* DS2405
-* Family Code 12 - Dual channel switch
-..* DS2406
-..* DS2407
-* Family Code 3A - Dual channel switch
-..* DS2413
-* Family Code 29 - Eight channel switch
-..* DS2408
diff --git a/onewire/meta.json b/onewire/meta.json
new file mode 100644
index 00000000..a56477ad
--- /dev/null
+++ b/onewire/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "One-Wire",
+ "tagline": "Connect one-wire temperature sensors and switches.",
+ "icon": "onewire.png",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "one-wire"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/onewire/onewire.png b/onewire/onewire.png
new file mode 100644
index 00000000..89d02d07
Binary files /dev/null and b/onewire/onewire.png differ
diff --git a/openuv/README.md b/openuv/README.md
index 30524675..07523605 100644
--- a/openuv/README.md
+++ b/openuv/README.md
@@ -2,5 +2,27 @@
Get the current UV index for your location.
+## Supported Things
+
+* OpenUV
+ * Auto location discovery
+ * Based on you IP-Address
+ * UV index
+ * UV day max index
+ * max UV Index for the day (at solar noon)
+ * Ozone in du (Dobson Units)
+ * Safe exposure time
+ * Safe exposure time (mins) till burn for each skin type
+
+NOTE: The save exposure time is not available for all regions. If all save exposure times are zero it due to unavailability of this information
+
+## Requirments
+
+* The package “nymea-plugin-openuv” must be installed
+* A valid OpenUV API key
+* Internet connection
+
+## More
+
+https://www.openuv.io/
-The save exposure time is not available for all regions. If all save exposure times are zero it due to unavailability of this information
diff --git a/openuv/meta.json b/openuv/meta.json
new file mode 100644
index 00000000..acdbe552
--- /dev/null
+++ b/openuv/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "OpenUV",
+ "tagline": "Get UV data for your location",
+ "icon": "openuv.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "online-service"
+ ]
+}
diff --git a/openuv/openuv.png b/openuv/openuv.png
new file mode 100644
index 00000000..b9780dcf
Binary files /dev/null and b/openuv/openuv.png differ
diff --git a/openweathermap/README.md b/openweathermap/README.md
index 6f82402f..25d1a9a6 100644
--- a/openweathermap/README.md
+++ b/openweathermap/README.md
@@ -1,6 +1,9 @@
# OpenWeatherMap
-This plugin allows to get the current weather data from [OpenWeatherMap](http://www.openweathermap.org).
+This plugin allows to get the current weather data from OpenWeatherMap.
+
+## Usage
+
The weather data will be refreshed every 15 minutes automatically, but can also refreshed manually.
The plugin offers two different search methods for the location: if the user searches for a empty string,
the plugin makes an autodetection with the WAN ip and offers the user the found weather stations.
@@ -9,3 +12,25 @@ stations in a radius of 1.5 km. Otherwise the plugin returns the list of the fou
from the search string.
> Note: If you are using a VPN connection, the autodetection will show the results around your VPN location.
+
+## Supported Things
+
+* Weather
+ * Weather condition
+ * Temperature
+ * Humidity
+ * Pressure
+ * Wind speed and direction
+ * Cloudiness and visibility
+ * Sunset and sunset time
+
+## Requirements
+
+* Internet connection
+* The OpenWeatherMap must be reachable
+* The package 'nymea-plugin-openweathermap' must be installed
+* An API key must be purchased for commercial use.
+
+## More
+
+OpenWeatherMap http://www.openweathermap.org
diff --git a/openweathermap/meta.json b/openweathermap/meta.json
new file mode 100644
index 00000000..980adaa3
--- /dev/null
+++ b/openweathermap/meta.json
@@ -0,0 +1,14 @@
+{
+ "title": "OpenWeatherMap",
+ "tagline": "Get current weather data for your location",
+ "icon": "openweathermap.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "weather",
+ "online-service"
+ ]
+}
diff --git a/openweathermap/openweathermap.png b/openweathermap/openweathermap.png
new file mode 100644
index 00000000..0e5d792a
Binary files /dev/null and b/openweathermap/openweathermap.png differ
diff --git a/osdomotics/README.md b/osdomotics/README.md
new file mode 100644
index 00000000..d8bfa8a2
--- /dev/null
+++ b/osdomotics/README.md
@@ -0,0 +1,21 @@
+# Open Source Domotics
+
+This plug-in integrates 6LowPAN based Merkur boards from OSDomotics.
+
+## Supported Things
+
+* RPL Router
+ * No internet or cloud connection required
+* Merkur Node
+ * Battery voltage
+ * Toggle LED
+
+## Requirements
+
+* An Merkur-RPL Router connected over serial bus.
+* Merkur nodes within reach.
+* The package “nymea-plugin-osdomotics” must be installed
+
+## More
+
+http://osdwiki.open-entry.com
diff --git a/osdomotics/merkur-board.jpg b/osdomotics/merkur-board.jpg
new file mode 100644
index 00000000..8c8a87c3
Binary files /dev/null and b/osdomotics/merkur-board.jpg differ
diff --git a/osdomotics/meta.json b/osdomotics/meta.json
new file mode 100644
index 00000000..6697af1e
--- /dev/null
+++ b/osdomotics/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "OSDomotics",
+ "tagline": "Connect and control Merkur boards.",
+ "icon": "merkur-board.jpg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "serial-port"
+ ],
+ "categories": [
+ "gateway"
+ ]
+}
diff --git a/philipshue/README.md b/philipshue/README.md
index ae11671a..796aeab3 100644
--- a/philipshue/README.md
+++ b/philipshue/README.md
@@ -1,3 +1,28 @@
# Philips Hue
-This plugin allows to interact with the [Philips hue](http://www2.meethue.com/) bridge. Each light bulb, sensor and remote controller connected to the bridge will appear automatically in the system, once the bridge is added to nymea.
+This plugin allows to interact with the Hue bridge. Each light bulb, sensor and remote controller connected to the bridge will appear automatically in the system, once the bridge is added to nymea.
+
+## Supported Things
+
+* Hue Bridge V1 + V2
+ * Auto network discovery
+ * Connected devices appear automatically
+ * No internet or cloud connection required
+* Hue Dimmer switch
+* Hue Tap Switch
+* Hue Smart Button
+* Hue Motion Sensor
+* Hue Outdoor Motion Sensor
+* Hue Ambient White Bulb
+* Hue Color Bulb
+* Any other Bulb that can be connected and controlled by the Hue App.
+
+## Requirements
+
+* The Philips Hue bridge must be in the same local area network as nymea.
+* The package “nymea-plugin-philipshue” must be installed
+* Access to the Philips Hue bidge push button
+
+## More
+
+ [Philips hue](http://www2.meethue.com/)
diff --git a/philipshue/meta.json b/philipshue/meta.json
new file mode 100644
index 00000000..7263a379
--- /dev/null
+++ b/philipshue/meta.json
@@ -0,0 +1,16 @@
+{
+ "title": "Philips Hue",
+ "tagline": "Connect and control Philips Hue devices.",
+ "icon": "philipshue.png",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "gateway",
+ "light",
+ "sensor",
+ "switch"
+ ]
+}
diff --git a/philipshue/philipshue.png b/philipshue/philipshue.png
new file mode 100644
index 00000000..70dd93b4
Binary files /dev/null and b/philipshue/philipshue.png differ
diff --git a/pushbullet/meta.json b/pushbullet/meta.json
new file mode 100644
index 00000000..1fea37b3
--- /dev/null
+++ b/pushbullet/meta.json
@@ -0,0 +1,14 @@
+{
+ "title": "Pushbullet",
+ "tagline": "Send notifictions over Pushbullet.",
+ "icon": "pushbullet.png",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "online-service",
+ "notification"
+ ]
+}
diff --git a/pushbullet/pushbullet.png b/pushbullet/pushbullet.png
new file mode 100644
index 00000000..130e8ca8
Binary files /dev/null and b/pushbullet/pushbullet.png differ
diff --git a/remotessh/README.md b/remotessh/README.md
index 93a47773..226ed8d7 100644
--- a/remotessh/README.md
+++ b/remotessh/README.md
@@ -1,3 +1,19 @@
# Remote ssh
-This plugin allowes to to establish a reverse SSH tunnel to the device where nymea is running. This requires a reverse ssh proxy running somewhere accessable from the system.
\ No newline at end of file
+This plugin allowes to to establish a reverse SSH tunnel to the device where nymea is running. This requires a reverse ssh proxy running somewhere accessable from the system.
+
+## Supported Things
+
+* Remote SSH
+ * Reverse SSH connection
+ * Config target IP-address, local and remote port
+ * Username and Password login
+
+## Requirements
+
+* The package “nymea-plugin-remotessh” must be installed
+* Reverse SSH proxy server
+
+## More
+
+https://www.howtogeek.com/428413/what-is-reverse-ssh-tunneling-and-how-to-use-it/
diff --git a/remotessh/meta.json b/remotessh/meta.json
new file mode 100644
index 00000000..a9cf7a62
--- /dev/null
+++ b/remotessh/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Remote SSH",
+ "tagline": "Get SSH access over a reverse SSH proxy.",
+ "icon": "remotessh.svg",
+ "stability": "community",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/remotessh/remotessh.svg b/remotessh/remotessh.svg
new file mode 100644
index 00000000..172543b8
--- /dev/null
+++ b/remotessh/remotessh.svg
@@ -0,0 +1,14 @@
+
+
+
+
diff --git a/senic/README.md b/senic/README.md
index 9d0a203b..ab02b823 100644
--- a/senic/README.md
+++ b/senic/README.md
@@ -1,3 +1,24 @@
# Senic
-This plugin allows you to integrate the Nuimo device from [Senic](https://www.senic.com/en/). The device can be used together with the rule engine to controll whatever device you want within nymea.
\ No newline at end of file
+This plugin allows you to integrate the Nuimo device from Senic. This device can be used together with the rule engine to control any other device connected to nymea e.g. Philips Hue, Sonos.
+
+## Supported Things
+
+* nuimo
+ * Auto Bluetooth discovery
+ * Pressed, Long-Pressed
+ * Swipe gestures
+ * Turning movement
+ * Display icons
+ * Get battery level
+ * No internet connection required
+
+## Requirements
+
+* The package “nymea-plugin-senic” must be installed
+* Device must be within reach.
+* Bluetooth 4.0 interface
+
+## More
+
+[Senic](https://www.senic.com/en/).
diff --git a/senic/meta.json b/senic/meta.json
new file mode 100644
index 00000000..49177146
--- /dev/null
+++ b/senic/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Senic",
+ "tagline": "Connect to Nuimo over Bluetooth.",
+ "icon": "senic.png",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "bluetooth"
+ ],
+ "categories": [
+ "switch"
+ ]
+}
diff --git a/senic/senic.png b/senic/senic.png
new file mode 100644
index 00000000..8a83e376
Binary files /dev/null and b/senic/senic.png differ
diff --git a/serialportcommander/meta.json b/serialportcommander/meta.json
new file mode 100644
index 00000000..cb134c4f
--- /dev/null
+++ b/serialportcommander/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Serial Port Commander",
+ "tagline": "Send and receive raw serial port commands.",
+ "icon": "serialportcommander.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "serial-port"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/serialportcommander/serialportcommander.svg b/serialportcommander/serialportcommander.svg
new file mode 100644
index 00000000..9b43e0f9
--- /dev/null
+++ b/serialportcommander/serialportcommander.svg
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/shelly/meta.json b/shelly/meta.json
new file mode 100644
index 00000000..6319b07b
--- /dev/null
+++ b/shelly/meta.json
@@ -0,0 +1,14 @@
+{
+ "title": "Shelly",
+ "tagline": "Control Shelly devices.",
+ "icon": "shelly.png",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "socket",
+ "relay"
+ ]
+}
diff --git a/shelly/shelly.png b/shelly/shelly.png
new file mode 100644
index 00000000..7e83cb55
Binary files /dev/null and b/shelly/shelly.png differ
diff --git a/simulation/meta.json b/simulation/meta.json
new file mode 100644
index 00000000..80ee19f6
--- /dev/null
+++ b/simulation/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Simulation",
+ "tagline": "Simulate different thing types.",
+ "icon": "simulation.svg",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/simulation/simulation.svg b/simulation/simulation.svg
new file mode 100644
index 00000000..2ee9397f
--- /dev/null
+++ b/simulation/simulation.svg
@@ -0,0 +1,18 @@
+
+
+
+
diff --git a/snapd/meta.json b/snapd/meta.json
new file mode 100644
index 00000000..2ecfbde7
--- /dev/null
+++ b/snapd/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Snapd",
+ "tagline": "Control the Snap daemon.",
+ "icon": "snapd.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/snapd/snapd.svg b/snapd/snapd.svg
new file mode 100644
index 00000000..b3d11790
--- /dev/null
+++ b/snapd/snapd.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/sonos/README.md b/sonos/README.md
new file mode 100644
index 00000000..41487a05
--- /dev/null
+++ b/sonos/README.md
@@ -0,0 +1,26 @@
+# Sonos
+
+This plug-in allows to connect to Sonos speakers.
+
+## Supported Things
+
+* Sonos Connection
+ * Sonos Account
+* Sonos Group
+ * Control devices inside a group
+ * Play/Pause/Stop/Skip ..
+ * Set Volume, Mute
+ * Get Title, Album artcover
+
+## Requirements
+
+* Internet connection
+* Sonos Account
+* Sonos App
+ * Required to connect the speaker to the Wifi network.
+ * Also needed to setup the Sonos account
+* The package “nymea-plugin-sonos” must be installed.
+
+## More
+
+https://www.sonos.com/
diff --git a/sonos/meta.json b/sonos/meta.json
new file mode 100644
index 00000000..07ec557e
--- /dev/null
+++ b/sonos/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Sonos",
+ "tagline": "Control Sonos speakers.",
+ "icon": "sonos.svg",
+ "stability": "consumer",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "multimedia"
+ ]
+}
diff --git a/sonos/sonos.svg b/sonos/sonos.svg
new file mode 100644
index 00000000..2207a972
--- /dev/null
+++ b/sonos/sonos.svg
@@ -0,0 +1,19 @@
+
+
+
+
+
diff --git a/systemmonitor/README.md b/systemmonitor/README.md
index e6fe822b..8a34f1d8 100644
--- a/systemmonitor/README.md
+++ b/systemmonitor/README.md
@@ -1,9 +1,19 @@
-# Systemmonitor
+# System monitor
-Displays the system usage of nymea, containing:
+This integration plug-in displays the system usage of nymea.
-* CPU usage (in percent)
-* Memory usage (in percent)
-* RSS memory usage (in KiloByte)
-* Virtual memory usage (in KiloByte)
+## Supported Things
+* System monitor
+ * CPU usage (in percent)
+ * Memory usage (in percent)
+ * RSS memory usage (in KiloByte)
+ * Virtual memory usage (in KiloByte)
+
+## Requirements
+
+* The package “nymea-plugin-systemmonitor” must be installed
+
+## More
+
+This plug-in uses "ps" to gather the required system information: http://man7.org/linux/man-pages/man1/ps.1.html
diff --git a/systemmonitor/meta.json b/systemmonitor/meta.json
new file mode 100644
index 00000000..34a59e26
--- /dev/null
+++ b/systemmonitor/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "System Monitor",
+ "tagline": "Monitor nymea's resource consumption.",
+ "icon": "systemmonitor.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/systemmonitor/systemmonitor.svg b/systemmonitor/systemmonitor.svg
new file mode 100644
index 00000000..1fa43aa5
--- /dev/null
+++ b/systemmonitor/systemmonitor.svg
@@ -0,0 +1,24 @@
+
+
+
+
diff --git a/tado/meta.json b/tado/meta.json
new file mode 100644
index 00000000..d83ccd63
--- /dev/null
+++ b/tado/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Tado",
+ "tagline": "Connect to you Tado account.",
+ "icon": "tado.png",
+ "stability": "community",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "heating"
+ ]
+}
diff --git a/tado/tado.png b/tado/tado.png
new file mode 100644
index 00000000..73a0fc0c
Binary files /dev/null and b/tado/tado.png differ
diff --git a/tasmota/integrationplugintasmota.json b/tasmota/integrationplugintasmota.json
index 523cb4fb..d87e94b9 100644
--- a/tasmota/integrationplugintasmota.json
+++ b/tasmota/integrationplugintasmota.json
@@ -1,4 +1,4 @@
-{
+ {
"name": "tasmota",
"displayName": "Sonoff-Tasmota",
"id": "d136e0c0-0cbf-4731-aabb-b2201088d6cb",
diff --git a/tasmota/meta.json b/tasmota/meta.json
new file mode 100644
index 00000000..b10b580a
--- /dev/null
+++ b/tasmota/meta.json
@@ -0,0 +1,15 @@
+{
+ "title": "Tasmota",
+ "tagline": "Tasmota",
+ "icon": "tasmota.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network",
+ "mqtt"
+ ],
+ "categories": [
+ "relay",
+ "socket"
+ ]
+}
diff --git a/tasmota/tasmota.svg b/tasmota/tasmota.svg
new file mode 100644
index 00000000..a5a7e695
--- /dev/null
+++ b/tasmota/tasmota.svg
@@ -0,0 +1,128 @@
+
+
diff --git a/tcpcommander/meta.json b/tcpcommander/meta.json
new file mode 100644
index 00000000..2b62049a
--- /dev/null
+++ b/tcpcommander/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "TCP Commander",
+ "tagline": "Send and receive raw TCP commands.",
+ "icon": "tcpcommander.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/tcpcommander/tcpcommander.svg b/tcpcommander/tcpcommander.svg
new file mode 100644
index 00000000..9b43e0f9
--- /dev/null
+++ b/tcpcommander/tcpcommander.svg
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/texasinstruments/meta.json b/texasinstruments/meta.json
new file mode 100644
index 00000000..b58a0dc5
--- /dev/null
+++ b/texasinstruments/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Texas Instruments",
+ "tagline": "Connect to the TI multisensor over Bluetooth.",
+ "icon": "texasinstruments.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "bluetooth"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/texasinstruments/texasinstruments.svg b/texasinstruments/texasinstruments.svg
new file mode 100644
index 00000000..69e32aa1
--- /dev/null
+++ b/texasinstruments/texasinstruments.svg
@@ -0,0 +1,92 @@
+
+
+
diff --git a/tplink/meta.json b/tplink/meta.json
new file mode 100644
index 00000000..bb84973b
--- /dev/null
+++ b/tplink/meta.json
@@ -0,0 +1,15 @@
+{
+ "title": "TP-Link",
+ "tagline": "TP-Link",
+ "icon": "tplink.png",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "sensor",
+ "switch",
+ "socket"
+ ]
+}
diff --git a/tplink/tplink.png b/tplink/tplink.png
new file mode 100644
index 00000000..1bf925c4
Binary files /dev/null and b/tplink/tplink.png differ
diff --git a/tuya/meta.json b/tuya/meta.json
new file mode 100644
index 00000000..9ca71396
--- /dev/null
+++ b/tuya/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "Tuya",
+ "tagline": "Connect to the Tuya cloud.",
+ "icon": "tuya.jpg",
+ "stability": "community",
+ "offline": false,
+ "technologies": [
+ "cloud"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/tuya/tuya.jpg b/tuya/tuya.jpg
new file mode 100644
index 00000000..efa4eb43
Binary files /dev/null and b/tuya/tuya.jpg differ
diff --git a/udpcommander/README.md b/udpcommander/README.md
index 7390928a..f009fab6 100644
--- a/udpcommander/README.md
+++ b/udpcommander/README.md
@@ -4,7 +4,7 @@ This plugin allows to receive UDP packages over a certain UDP port and generates
> Note: This plugin is ment to be combined with a rule.
-## Example
+## Usage
If you create an UDP Commander on port 2323 and with the command `"Light 1 ON"`, following command will trigger an event in nymea and allows you to connect this event with a rule.
@@ -17,3 +17,23 @@ If you create an UDP Commander on port 2323 and with the command `"Light 1 ON"`,
This allows you to execute actions in your nymea system when a certain UDP message will be sent to nymea.
If the command will be recognized from nymea, the sender will receive as answere a `"OK"` string.
+
+## Supported Things
+
+* UDP Commander
+ * Send UDP strings
+ * Set target IP-address and port
+* UDP Received
+ * Received UDP strings
+ * Set receiveing port
+
+## Requirements
+
+* The package “nymea-plugin-udpcommander” must be installed
+* The selected port must be available on the host system.
+
+## More
+
+https://en.wikipedia.org/wiki/User_Datagram_Protocol
+
+
diff --git a/udpcommander/meta.json b/udpcommander/meta.json
new file mode 100644
index 00000000..337c6819
--- /dev/null
+++ b/udpcommander/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "UDP Commander",
+ "tagline": "Send and receive raw UDP commands.",
+ "icon": "udpcommander.svg",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "tool"
+ ]
+}
diff --git a/udpcommander/udpcommander.svg b/udpcommander/udpcommander.svg
new file mode 100644
index 00000000..9b43e0f9
--- /dev/null
+++ b/udpcommander/udpcommander.svg
@@ -0,0 +1,8 @@
+
+
+
+
diff --git a/unifi/README.md b/unifi/README.md
index 3085daad..c1ddc04e 100644
--- a/unifi/README.md
+++ b/unifi/README.md
@@ -2,7 +2,7 @@
This plugin adds support to connect nymea to a UniFi network controller and monitor devices for presence.
-## Setup
+## Usage
In order to monitor network devices via a UniFi controller, it is required to configure the UniFi controller.
The IP, as well as username and password for the UniFi controller must be provided.
@@ -11,3 +11,17 @@ Once the controller is added to the system, additional Wi-Fi devices may be adde
UniFi clients. After a client is addded, it will appear as presence sensor in the system.
Client devices, by default have a one minute grace period before they are marked as offline. This value can
be changed in the device settings. A value of 0 will immediately mark a device as offline.
+
+## Supported Things
+
+* UniFi Controller
+ *
+* Client
+
+## Requirements
+
+* The package “nymea-plugin-unifi” must be installed
+
+## More
+
+https://www.ui.com/software/
diff --git a/unifi/meta.json b/unifi/meta.json
new file mode 100644
index 00000000..5bca69bd
--- /dev/null
+++ b/unifi/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "UniFi",
+ "tagline": "Connect to the UniFi controller.",
+ "icon": "unifi.png",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "sensor"
+ ]
+}
diff --git a/unifi/unifi.png b/unifi/unifi.png
new file mode 100644
index 00000000..acd0c1b9
Binary files /dev/null and b/unifi/unifi.png differ
diff --git a/unitec/README.md b/unitec/README.md
index 5b1f55fe..4198d54a 100644
--- a/unitec/README.md
+++ b/unitec/README.md
@@ -1,10 +1,27 @@
# Unitec
-This plugin allows to controll RF 433 MHz actors an receive remote signals from [Unitec](http://www.unitec-elektro.de)
-devices.
+This plugin allows to controll RF 433 MHz actors an receive remote signals from 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.
+## Usage
+
+The unitec socket units have a teach function. If you plug in the switch, a red light will start blinking. That means the socket is now in teaching mode. This Unitec switch (48111) can now be added to nymea with the desired Channel (A,B,C or D).
+
+To pair the socket the power ON button must be pressed, and the switch needs to be in the pairing mode. If the pairing was successful, the switch will turn on.
+
+NOTE: If a switch loses power once, it needs to be repaired, the devices do not store the teached channel.
+
+## Supported Things
+
+* Unitec switch (48111)
+ * Select channel
+ * Power on/off
+ * No internet connection required
+
+## Requirements
+
+* 433MHz RF transceiver
+* The package “nymea-plugin-anel” must be installed
+
+## More
+
+Unitec: http://www.unitec-elektro.de
diff --git a/usbrelay/README.md b/usbrelay/README.md
index 12cae02d..035e0e88 100644
--- a/usbrelay/README.md
+++ b/usbrelay/README.md
@@ -1,5 +1,19 @@
# usbrelay
--------------------------------
-This plugin eneblas you to control low-cost USB HID relays. The plugin creates a power device for each relay and can be controlled using the `power?? interface.
-Examples of USB relay hardware can be found [here](http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface).
+This plugin eneblas you to control low-cost USB HID relays.
+
+## Supported Things
+
+* USB-Relays
+ * Discovery setup
+ * Power on/off
+
+## Requirements
+
+* The package 'nymea-plugin-usbrelay' must be installed.
+
+## More
+
+Examples of USB relay hardware can be found
+[here](http://vusb.wikidot.com/project:driver-less-usb-relays-hid-interface).
diff --git a/usbrelay/meta.json b/usbrelay/meta.json
new file mode 100644
index 00000000..19bd508b
--- /dev/null
+++ b/usbrelay/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "USB Relay",
+ "tagline": "Control relays connected over USB.",
+ "icon": "usbrelay.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "usb"
+ ],
+ "categories": [
+ ]
+}
diff --git a/usbrelay/usbrelay.svg b/usbrelay/usbrelay.svg
new file mode 100644
index 00000000..3e1a4cf9
--- /dev/null
+++ b/usbrelay/usbrelay.svg
@@ -0,0 +1,22 @@
+
+
+
+
diff --git a/wakeonlan/README.md b/wakeonlan/README.md
index d29959a9..dbba6826 100644
--- a/wakeonlan/README.md
+++ b/wakeonlan/README.md
@@ -4,4 +4,17 @@ Wake-on-LAN (WOL) is an Ethernet computer networking standard that allows a comp
to be turned on or awakened by a network message. This plugin allows you to send a
a "magic packet" to a certain mac address in the local network.
-> Note: The WOL service has to be enabled on the host computer.
+## Supported Things
+
+* Wake-on-LAN
+ * No internet connection required
+
+## Requires
+
+* MAC address of the target device
+* The WOL service has to be enabled on the host computer
+* The package “nymea-plugin-wakeonlan” must be installed
+
+## More
+
+https://en.wikipedia.org/wiki/Wake-on-LAN
diff --git a/wakeonlan/meta.json b/wakeonlan/meta.json
new file mode 100644
index 00000000..01fbd884
--- /dev/null
+++ b/wakeonlan/meta.json
@@ -0,0 +1,12 @@
+{
+ "title": "Wake-On-LAN",
+ "tagline": "Wake up devices in you LAN.",
+ "icon": "wol.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ ]
+}
diff --git a/wakeonlan/wol.svg b/wakeonlan/wol.svg
new file mode 100644
index 00000000..20563b0f
--- /dev/null
+++ b/wakeonlan/wol.svg
@@ -0,0 +1,15 @@
+
+
+
+
diff --git a/wemo/README.md b/wemo/README.md
index e3ada5bc..3eb1b5e2 100644
--- a/wemo/README.md
+++ b/wemo/README.md
@@ -1,7 +1,22 @@
# Wemo
-This plugin allows to find and control devices from WeMo, the
-[Belkin](http://www.belkin.com/de/PRODUKTE/home-automation/c/wemo-home-automation/)
-home automation system.
+This plugin allows to find and control devices from WeMo, the Belkin home automation system.
-> Note: The devices can only be discovered if they are already in the local network. In order to configure the WeMo devices please use the original software.
+## Supported Things
+
+* WeMo Smart Plug
+ * Auto discovery setup
+ * Set power
+ * No internet connection required
+
+## Requirements
+
+* The WeMo device must be in the same local area network as nymea.
+* The package “nymea-plugin-wemo” must be installed
+* UPnP discovery request messages must not be blocked by the router.
+* TCP connections must not be blocked by the router.
+> Note: In order to setup and configure the WeMo devices please use the original software.
+
+## More
+
+http://www.belkin.com/de/PRODUKTE/home-automation/c/wemo-home-automation/
diff --git a/wemo/meta.json b/wemo/meta.json
new file mode 100644
index 00000000..8b4b54e4
--- /dev/null
+++ b/wemo/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "WeMo",
+ "tagline": "Control WeMo devices.",
+ "icon": "wemo.svg",
+ "stability": "consumer",
+ "offline": true,
+ "technologies": [
+ "network"
+ ],
+ "categories": [
+ "socket"
+ ]
+}
diff --git a/wemo/wemo.svg b/wemo/wemo.svg
new file mode 100644
index 00000000..7ef7fed1
--- /dev/null
+++ b/wemo/wemo.svg
@@ -0,0 +1,24 @@
+
+
+
diff --git a/ws2812fx/README.md b/ws2812fx/README.md
index b516a2eb..b3903550 100644
--- a/ws2812fx/README.md
+++ b/ws2812fx/README.md
@@ -4,4 +4,25 @@ Plug-In for the WS2812FX project, a WS2812 effect library for Arduino and ESP826
Flash your microcontroller with the provided "serial_control" example. Connect the microcontroller
over USB to the nymea device.
+## Supported Things
+
+* WS2812FX
+ * Auto discovery setup
+ * Set color
+ * Set color temperature
+ * Set brightness
+ * Set power
+ * Select effect
+ * Set effect speed
+ * No internet connection required
+
+## Requires
+
+* Arduino compatible hardware
+* Flashed with the WS2812FX serial_control firmware
+* Device connected over USB to the host system
+* The package “nymea-plugin-ws2812fx” must be installed
+
+## More
+
See also: https://github.com/kitesurfer1404/WS2812FX
diff --git a/ws2812fx/meta.json b/ws2812fx/meta.json
new file mode 100644
index 00000000..6b3d504a
--- /dev/null
+++ b/ws2812fx/meta.json
@@ -0,0 +1,13 @@
+{
+ "title": "WS2812FX",
+ "tagline": "Connect to devices flashed with the WS2812FX library.",
+ "icon": "ws2812fx.png",
+ "stability": "community",
+ "offline": true,
+ "technologies": [
+ "usb"
+ ],
+ "categories": [
+ "light"
+ ]
+}
diff --git a/ws2812fx/ws2812fx.png b/ws2812fx/ws2812fx.png
new file mode 100644
index 00000000..e7e21277
Binary files /dev/null and b/ws2812fx/ws2812fx.png differ