[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
2020-12-21 00:43:48 +11:00
committed by GitHub
parent 4f0caf1a1f
commit ea3446f50e
40 changed files with 136 additions and 229 deletions

View File

@@ -63,9 +63,9 @@ and then you will be able to use /dev/rfxtrx0 as the serial device regardless of
### Manual Configuration
If you have any problems with JD2XX or you don't want to disable FTDI driver on OS X or Linux, you can also configure RFXCOM transceivers/receivers manually.
If you have any problems with JD2XX, or you don't want to disable FTDI driver under OS X or Linux, you can also configure RFXCOM transceivers/receivers manually.
To do that via the Paper UI, manually add the generic RFXCOM device named `RFXCOM USB Transceiver`, with the description "This is universal RFXCOM transceiver bridge for manual configuration purposes".
To do that, manually add the generic RFXCOM device named `RFXCOM USB Transceiver`, with the description "This is universal RFXCOM transceiver bridge for manual configuration purposes".
You will need to specify at least the serial port which has been assigned to the RFXCOM (see notes above).
To configure the serial port within openHAB see the [general documentation about serial port configuration](/docs/administration/serial.html).
@@ -86,7 +86,7 @@ To start a TCP server for an RFXCOM device, you can use socat:
socat tcp-listen:10001,fork,reuseaddr file:/dev/ttyUSB0,raw
```
A TCP bridge, for use with socat on a remote host, can only be configured manually either through the Paper UI by adding an "RFXCOM USB Transceiver over TCP/IP" device or in a thing file like this:
A TCP bridge, for use with socat on a remote host, can be configured manually, or by adding an "RFXCOM USB Transceiver over TCP/IP" device or in a thing file like this:
```
Bridge rfxcom:tcpbridge:sunflower [ host="sunflower", port=10001 ] {
@@ -196,23 +196,16 @@ The binding uses the following system channels:
| system.battery-level | Number | Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (eg 4 levels) should convert to a percentage to provide a consistent battery level reading. |
| system.low-battery | Switch | Represents a low battery warning with possible values on/off. |
## Full example
### Thing files
Sensors/actuators are easy to configure through the Paper UI.
However, if you used a thing file for your RFXCOM you can also configure them manually there as well, for example:
## Full Example
*.thing
```
Bridge rfxcom:bridge:usb0 [ serialPort="/dev/<device>" ] {
Thing lighting2 100001_1 [ deviceId="100001.1", subType="AC" ]
}
```
### Item files
Items may be created through Paper UI or add using item files in which you add a channel parameter specifying the bridge's name, the thing ID and channel that the item should be linked to, for example:
*.items
```
Switch Switch {channel="rfxcom:lighting2:usb0:100001_1:command"}
```
@@ -731,7 +724,7 @@ A Lighting4 device
The support for lighting 4 in RFXCOM is less complete because a lot of different devices use the same chips and can not easily be distinguished.
So some extra configuration can be used for fine tuning the behavior of your Lighting4 devices.
For configuration via the Paper UI three extra fields are available, being the the pulse length and a commmand id for on and off commands.
When configuring, three extra fields are available, being the the pulse length, and a separate command id for both on and off.
If your item is auto-discovered normally the on or off command should be recognized properly.
For a USB attached RFXCOM on Windows the configuration could look like this (note that the `onCommandId`, `offCommandId` and `pulse` are all optional):