[All addons] Review all readme.md files for V3 changes. (#9439)
Signed-off-by: Matthew Skinner <matt@pcmus.com> * modbus.e3dc: newlines added and remove broken anchor. Signed-off-by: Matthew Skinner <matt@pcmus.com> * modbus.stie..:remove multiple newlines. Signed-off-by: Matthew Skinner <matt@pcmus.com> * modbus.sunspec: remove multiple newlines. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Nanoleaf: remove PaperUI. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Neato: Remove openhab 2 Signed-off-by: Matthew Skinner <matt@pcmus.com> * Nibe: remove PaperUI. Signed-off-by: Matthew Skinner <matt@pcmus.com> * NibeUplink: Remove PaperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Niko: Remove PaperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Nuki: Remove Paper UI Signed-off-by: Matthew Skinner <matt@pcmus.com> * OneWire: Remove multiple newlines. Signed-off-by: Matthew Skinner <matt@pcmus.com> * OpenUV: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * OpenWebNet: Remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Pentair: remove openhab2 path Signed-off-by: Matthew Skinner <matt@pcmus.com> * Fix typo Signed-off-by: Matthew Skinner <matt@pcmus.com> * RFXCOM: remove PaperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Russound: Remove PaperUI. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Samsung: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * Siemens: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * Samsung Smartthings: remove openhab 2 mention. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Somfy myLink: remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Somfy Tahoma: remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Sonos: Remove paperui ref Signed-off-by: Matthew Skinner <matt@pcmus.com> * Spotify: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * Tankerkönig: remove java8 and paperUI references. Signed-off-by: Matthew Skinner <matt@pcmus.com> * Tellstick: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * Tibber: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * Velbus: remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Vitotronic: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * VolvoOnCall: remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * WiFi LED: remove paperui Signed-off-by: Matthew Skinner <matt@pcmus.com> * WlanThermo: remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * XmlTV: remove openhab2 path Signed-off-by: Matthew Skinner <matt@pcmus.com> * Z-Way: Remove paperUI Signed-off-by: Matthew Skinner <matt@pcmus.com> * Update bundles/org.openhab.binding.nanoleaf/README.md Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de> * MagentaTV: Fix typo Signed-off-by: Matthew Skinner <matt@pcmus.com> * MagentaTV: Change to userId Signed-off-by: Matthew Skinner <matt@pcmus.com> Co-authored-by: Fabian Wolter <github@fabian-wolter.de>
This commit is contained in:
Matthew Skinner
GitHub
@@ -11,30 +11,33 @@ The binding uses the [Nanoleaf OpenAPI](https://forum.nanoleaf.me/docs/openapi),
|
||||
|
||||
## Supported Things
|
||||
|
||||
Currently Nanoleaf's "Light Panels" and "Canvas" devices are supported. Note that only the canvas type does support the touch functionality.
|
||||
|
||||
Currently Nanoleaf's "Light Panels" and "Canvas" devices are supported.
|
||||
Note that only the canvas type does support the touch functionality.
|
||||
|
||||
The binding supports two thing types: controller and lightpanel.
|
||||
|
||||
The controller thing is the bridge for the individually attached panels/canvas and can be perceived as the nanoleaf device at the wall as a whole (either called "light panels" or "canvas" by Nanoleaf).
|
||||
With the controller thing you can control channels which affect all panels, e.g. selecting effects or setting the brightness.
|
||||
|
||||
The lightpanel (singular) thing controls one of the individual panels/canvas that are connected to each other. Each individual panel has therefore its own id assigned to it.
|
||||
The lightpanel (singular) thing controls one of the individual panels/canvas that are connected to each other.
|
||||
Each individual panel has therefore its own id assigned to it.
|
||||
You can set the **color** for each panel or turn it on (white) or off (black) and in the case of a nanoleaf canvas you can even detect single and double **touch events** related to an individual panel which opens a whole new world of controlling any other device within your openHAB environment.
|
||||
|
||||
Note: In case of major changes of a binding (like adding more features to a thing) it becomes necessary to delete your things due to the things not being compatible anymore. Don't worry too much though as they will be easily redetected and nothing really is lost. Just make sure that you delete them and rediscover as described below.
|
||||
Note: In case of major changes of a binding (like adding more features to a thing) it becomes necessary to delete your things due to the things not being compatible anymore.
|
||||
Don't worry too much though as they will be easily redetected and nothing really is lost.
|
||||
Just make sure that you delete them and rediscover as described below.
|
||||
|
||||
## Discovery
|
||||
|
||||
**Adding the Controller as a Thing**
|
||||
|
||||
To add a nanoleaf controller you need to go to your inbox in Paper UI, press the plus sign which **starts a scan** (you can of course use habmin for that as well). Then choose "Nanoleaf Binding".
|
||||
A controller (also known as bridge) device is discovered automatically through mDNS in the local network.
|
||||
To add a nanoleaf controller, go to your inbox and start a scan.
|
||||
Then choose "Nanoleaf Binding".
|
||||
A controller (bridge) device is discovered automatically using mDNS in your local network.
|
||||
Alternatively, you can also provide a things file (see below for more details).
|
||||
After the device is discovered and added as a thing, it needs a valid authentication token that must be obtained by pairing it with your openHAB instance.
|
||||
Without the token the light panels remain in status OFFLINE.
|
||||
|
||||
|
||||
The binding supports pairing of the device with your openHAB instance as follows:
|
||||
|
||||
1. Make sure that the authentication token field in your Nanoleaf controller thing configuration is left empty.
|
||||
@@ -46,10 +49,11 @@ Tip: if you press (2) just before adding the item from the inbox it usually catc
|
||||
|
||||
**Adding the invidual light panels as a thing**
|
||||
|
||||
After you have added the controller as a thing and it has been successfully paired as described as above, the individual panels connected to it can be discovered by **starting another scan** for the Nanoleaf binding (e.g. from the Inbox in Paper UI).
|
||||
After you have added the controller as a thing and it has been successfully paired as described as above, the individual panels connected to it can be discovered by **starting another scan** for the Nanoleaf binding.
|
||||
All connected panels will be added as separate things to the inbox.
|
||||
|
||||
Troubleshooting: In seldom cases (in particular together with updating the binding) things or items do not work as expected, are offline or may not be detected. In this case
|
||||
Troubleshooting: In seldom cases (in particular together with updating the binding) things or items do not work as expected, are offline or may not be detected.
|
||||
In this case:
|
||||
|
||||
- remove the panels (maybe twice by force removing it)
|
||||
- remove the controller (maybe twice by force removing it)
|
||||
@@ -58,12 +62,11 @@ Troubleshooting: In seldom cases (in particular together with updating the bindi
|
||||
|
||||
**Knowing which panel has which id**
|
||||
|
||||
Unfortunately it is not easy to find out which panel gets which id while this is pretty important if you have lots of them and you want to assign rules to it.
|
||||
Don't worry: the binding comes with some helpful support in the background the canvas type (this is only provided for the canvas device because triangles can have weird layouts that are hard to express in a log output)
|
||||
Unfortunately it is not easy to find out which panel gets which id, and this becomes pretty important if you have lots of them and want to assign rules.
|
||||
Don't worry as the binding comes with some helpful support in the background the canvas type (this is only provided for the canvas device because triangles can have weird layouts that are hard to express in a log output)
|
||||
|
||||
- fire up your browser and open the openHAB server on port 9001 which shows the logs.
|
||||
- Set up a switch item with the channel panelLayout on the controller (see NanoRetrieveLayout below) and set the switch to true
|
||||
- look out for something like "Panel layout and ids" in the logs. Below that you will see a panel layout similar to
|
||||
- look out for something like "Panel layout and ids" in the openHAB logs. Below that you will see a panel layout similar to
|
||||
|
||||
Compare the following output with the right picture at the beginning of the article
|
||||
|
||||
@@ -76,7 +79,7 @@ Compare the following output with the right picture at the beginning of the arti
|
||||
|
||||
41451
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
Disclaimer: this works best with square devices and not necessarily well with triangles due to the more geometrically flexible layout.
|
||||
|
||||
@@ -126,7 +129,6 @@ A lightpanel thing has the following channels:
|
||||
| singleTap | Switch | [Canvas Only] Is set when the user taps that panel once (1 second pulse) | Yes |
|
||||
| doubleTap | Switch | [Canvas Only] Is set when the user taps that panel twice (1 second pulse) | Yes |
|
||||
|
||||
|
||||
**color and panelColor**
|
||||
|
||||
The color and panelColor channels support full color control with hue, saturation and brightness values.
|
||||
@@ -142,9 +144,7 @@ What might not be obvious and even maybe confusing is the fact that brightness a
|
||||
- As soon as you set an individual panel a so called "static effect" is created which replaces the chosen dynamic effect. You can even see that in the nanoleaf app that shows that a static effect is now running.
|
||||
- Unfortunately, at least at the moment, the colors of the current state cannot be retrieved due to the high frequency of color changes that cannot be read quickly enough from the canvas, so all panels go to OFF
|
||||
- The the first panelColor command is applied to that panel (and of course then all subsequent commands)
|
||||
- The fact that it is called a static effect does not mean that you cannot create animations. The Rainbow rule below shows a good example for the whole canvas. Just replace the controller item with a panel item and you will get the rainbow effect with an individual panel.
|
||||
|
||||
|
||||
- The fact that it is called a static effect does not mean that you cannot create animations. The Rainbow rule below shows a good example for the whole canvas. Just replace the controller item with a panel item and you will get the rainbow effect with an individual panel.
|
||||
|
||||
**Touch Support**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user