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/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/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/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/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/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/wemo/README.md b/wemo/README.md index eb7f3e7c..3eb1b5e2 100644 --- a/wemo/README.md +++ b/wemo/README.md @@ -9,7 +9,7 @@ This plugin allows to find and control devices from WeMo, the Belkin home automa * Set power * No internet connection required -## Requires +## Requirements * The WeMo device must be in the same local area network as nymea. * The package “nymea-plugin-wemo” must be installed