From 8d285008a7e8fd424fdaf27f3002d5c4b1d206d8 Mon Sep 17 00:00:00 2001 From: "bernhard.trinnes" Date: Fri, 6 Mar 2020 15:17:11 +0100 Subject: [PATCH] updated anel README --- README.md | 37 +++++++++++++++++++++++++++++++++++++ anel/README.md | 41 +++++++++++++++++++++++++++++++++++++---- 2 files changed, 74 insertions(+), 4 deletions(-) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..5949079e --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# nymea plug-ins + +-------------------------------------------- +

+ + + +

+ + +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) + +## Wiki and Documentation + +* A detailed description how to install and getting started with the *nymea* can be found in the + + [nymea | github wiki](https://wiki.nymea.io). + +* A detailed documentation of the source code can be found in the + + [nymea | developer documentation](https://doc.nymea.io). + + +## 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..f65c5e22 100644 --- a/anel/README.md +++ b/anel/README.md @@ -1,7 +1,40 @@ -# ANEL Elektronik devices - -This plugin allows to make use of ANEL Elektronik NET-PwrCtrl controlled power sockets. +--- +id: anelElektronik +title: 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 devices is added, the associated sockets appear as a child device. Deleting the NET-PwerCtl device +will also remove the associated sockets. So each socket can be named and they will individually appear as socket inside nymea:app. +## Supported Things +* NET-PwrCtl HOME + * Get and set the state of each socket +* 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.