[All addons] Review all readme.md files for V3 changes. (openhab#9439)

Signed-off-by: Matthew Skinner <[email protected]> * modbus.e3dc: newlines added and remove broken anchor. Signed-off-by: Matthew Skinner <[email protected]> * modbus.stie..:remove multiple newlines. Signed-off-by: Matthew Skinner <[email protected]> * modbus.sunspec: remove multiple newlines. Signed-off-by: Matthew Skinner <[email protected]> * Nanoleaf: remove PaperUI. Signed-off-by: Matthew Skinner <[email protected]> * Neato: Remove openhab 2 Signed-off-by: Matthew Skinner <[email protected]> * Nibe: remove PaperUI. Signed-off-by: Matthew Skinner <[email protected]> * NibeUplink: Remove PaperUI Signed-off-by: Matthew Skinner <[email protected]> * Niko: Remove PaperUI Signed-off-by: Matthew Skinner <[email protected]> * Nuki: Remove Paper UI Signed-off-by: Matthew Skinner <[email protected]> * OneWire: Remove multiple newlines. Signed-off-by: Matthew Skinner <[email protected]> * OpenUV: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * OpenWebNet: Remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * Pentair: remove openhab2 path Signed-off-by: Matthew Skinner <[email protected]> * Fix typo Signed-off-by: Matthew Skinner <[email protected]> * RFXCOM: remove PaperUI Signed-off-by: Matthew Skinner <[email protected]> * Russound: Remove PaperUI. Signed-off-by: Matthew Skinner <[email protected]> * Samsung: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * Siemens: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * Samsung Smartthings: remove openhab 2 mention. Signed-off-by: Matthew Skinner <[email protected]> * Somfy myLink: remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * Somfy Tahoma: remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * Sonos: Remove paperui ref Signed-off-by: Matthew Skinner <[email protected]> * Spotify: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * Tankerkönig: remove java8 and paperUI references. Signed-off-by: Matthew Skinner <[email protected]> * Tellstick: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * Tibber: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * Velbus: remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * Vitotronic: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * VolvoOnCall: remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * WiFi LED: remove paperui Signed-off-by: Matthew Skinner <[email protected]> * WlanThermo: remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * XmlTV: remove openhab2 path Signed-off-by: Matthew Skinner <[email protected]> * Z-Way: Remove paperUI Signed-off-by: Matthew Skinner <[email protected]> * Update bundles/org.openhab.binding.nanoleaf/README.md Signed-off-by: Matthew Skinner <[email protected]> Co-authored-by: Fabian Wolter <[email protected]> * MagentaTV: Fix typo Signed-off-by: Matthew Skinner <[email protected]> * MagentaTV: Change to userId Signed-off-by: Matthew Skinner <[email protected]> Co-authored-by: Fabian Wolter <[email protected]>
lsiepel · Dec 20, 2020 · ea3446f · ea3446f
1 parent 4f0caf1
commit ea3446f
Show file tree

Hide file tree

Showing 40 changed files with 136 additions and 229 deletions.
diff --git a/bundles/org.openhab.binding.magentatv/README.md b/bundles/org.openhab.binding.magentatv/README.md
@@ -25,11 +25,11 @@ The binding provides device discovery, sending keys for the remote and also rece
 
 ## Auto Discovery
 
-UPnP will be used to discover receivers on the local network and discover the nessesary parameters.
+UPnP will be used to discover receivers on the local network and discover the necessary parameters.
 The receiver needs to be powered on to get discovered.
 
 Once the receiver is discovered it can be added from the Inbox.
-Make sure to set the U in the Thing configuration after adding the new thing, see section Thing Configuration.
+Make sure to set `userId` in the Thing configuration after adding the new thing, see section Thing Configuration.
 
 Note:
 The binding uses the network settings in openHAB's system configuration to determine the local IP address.
@@ -126,11 +126,12 @@ For security reasons the credentials are automatically deleted from the thing co
 
 Please note:
 
-- POWER is a toggle button, not an on/off switch. The binding tries to detect and maintain the correct state, but due to device limitations this is not always possible. Make sure the receiver's and binding's state are in sync when OH is restarted (binidng assume state OFF).
+- POWER is a toggle button, not an on/off switch.
+The binding tries to detect and maintain the correct state, but due to device limitations this is not always possible.
+Make sure the receiver's and binding's state are in sync when OH is restarted (binding assumes state is OFF).
 - Channels receiving event information get updated when changing the channel or playing a video.
 There is no way to read the current status, therefore they don't get initialized on startup nor being updated in real-time.
 
-
 The player channel supports the following actions:
 
 |Channel |Command        |Description                       |
@@ -193,7 +194,6 @@ The player channel supports the following actions:
 In addition you could send any key code in the 0xHHHH format., refer to
 [Key Codes for Magenta/Huawei Media Receiver](http://support.huawei.com/hedex/pages/DOC1100366313CEH0713H/01/DOC1100366313CEH0713H/01/resources/dsv_hdx_idp/DSV/en/en-us_topic_0094619112.html)
 
-
 ## Full Configuraton Example
 
 ### magentatv.things
@@ -328,4 +328,3 @@ to switch it ON and
 to switch it off.
 
 After an openHAB restart you need to make sure that OH and receiver are in sync, because the binding can't read the power status at startup.
-
diff --git a/bundles/org.openhab.binding.mail/README.md b/bundles/org.openhab.binding.mail/README.md
@@ -25,9 +25,9 @@ If one or both are empty, no authentication data is provided to the SMTP server
 
 ### IMAP Server (`imap`) / POP3 Server (`pop3`)
 
-There is one mandatory parameter: `hostname`, `username`, `password`.
+There is one mandatory parameter: `hostname`.
 The `hostname` may contain an IP address or a FQDN like `mail.gmail.com`.
-For authentication `username` and `password` need to be supplied.
+For authentication `username` and `password` also need to be supplied.
 
 The `refresh`, `security`, `port`, `username` and `password` parameters are optional.
 

diff --git a/bundles/org.openhab.binding.max/README.md b/bundles/org.openhab.binding.max/README.md
@@ -1,7 +1,7 @@
 # MAX! Binding
 
 This is the binding for the [eQ-3 MAX! Home Solution](http://www.eq-3.de/).
-This binding allows you to integrate, view and control the MAX! Thermostats in the openHAB environment
+This binding allows you to integrate, view and control the MAX! Thermostats, Ecoswitch and Shuttercontact things.
 
 ## Supported Things
 
@@ -10,29 +10,25 @@ This binding support 6 different things types
 | Thing          | Type   | Description                                                                                                        |
 |----------------|--------|--------------------------------------------------------------------------------------------------------------------|
 | bridge         | Bridge | This is the MAX! Cube LAN gateway.                                                                                 |
-| thermostat     | Thing  | This is for the MAX! Heating Thermostat. This is also used for the powerplug switch "Zwischenstecker-Schaltaktor". |
+| thermostat     | Thing  | This is for the MAX! Heating Thermostat. This is also used for the power plug switch "Zwischenstecker-Schaltaktor". |
 | thermostatplus | Thing  | This is for the MAX! Heating Thermostat+. This is the type that can hold the program by itself.                    |
 | wallthermostat | Thing  | MAX! Wall Thermostat.                                                                                              |
 | ecoswitch      | Thing  | MAX! Ecoswitch.                                                                                                    |
 | shuttercontact | Thing  | MAX! Shuttercontact / Window Contact.                                                                              |
 
-
 Generally one does not have to worry about the thing types as they are automatically defined.
 If for any reason you need to manually define the Things and you are not exactly sure what type of thermostat you have, you can choose `thermostat` for both the thermostat and thermostat+, this will not affect their working.
 
 ## Discovery
 
-The discovery process for the MAX! binding works in 2 steps.
-When the binding is started or when manually triggered, the network is queried for the existence of a MAX! Cube LAN gateway.
-When the Cube is found, it will become available in the discovery inbox. Periodically the network is queried again for a Cube.
+When the bindings discovery is triggered, the network is queried for the existence of a MAX! Cube LAN gateway.
+When the Cube is found, it will become available in the inbox. 
 
-Once the Cube is available in openHAB, all the devices connected to it are discovered and added to the discovery inbox.
-No scan is needed to trigger this.
+After the Cube `bridge` is available in openHAB, all the devices connected to it are discovered and added to the inbox.
 
 ## Binding Configuration
 
-In the openHAB2 version of this binding there are no binding wide settings.
-All the configuration settings are now per MAX! Cube, hence in case you have multiple Cubes, they can run with alternative settings.
+There are no binding wide settings as all configuration settings are now per MAX! Cube, hence in case you have multiple Cubes, they can run with alternative settings.
 
 ## Thing Configuration
 
@@ -107,13 +103,13 @@ Please be aware that the actual temperature measure for thermostats is only upda
 Hence the temperature you see may be hours old.
 In that case you can update the temperature by changing the mode, wait approximately 2 minutes and change the mode back.
 There is an experimental mode that does this automatically.
-This can be enabled by showing the "advanced settings" (e.g. in HABmin UI).
+This can be enabled by ticking "Show advanced".
 Then the "Actual Temperature Refresh Rate" can be set.
 Minimum refresh rate once/10 minutes, recommended 60min to avoid excessive battery drain.
 
 ## New Device Inclusion
 
-When clicking the discovery button for MAX! devices manually in the UI, you  will start New Device Inclusion mode for 60seconds.
+When clicking the discovery button for MAX! devices manually in the UI, you  will start New Device Inclusion mode for 60 seconds.
 During this time, holding the _boost_ button on your device will link it to the Cube.
 
 ## Device Configuration
@@ -128,10 +124,6 @@ _Cube device configurable parameters_
 *   _ntpServer1_ The hostname for NTP Server 1 used by the Cube to get the time
 *   _ntpServer2_ The hostname for NTP Server 2 used by the Cube to get the time
 
-## Action Buttons (visible in HABmin)
-
-The Action Buttons are deprecated and will be removed in a future version.
-
 ## Thing Actions
 
 Several Thing Actions are available to trigger special actions on the MAX! Cube
@@ -144,9 +136,6 @@ On the MAX! devices you can trigger the following action
 
 *   `deleteFromCube()`: _Delete Device from Cube_ deletes the device from the MAX! Cube. Device will need to be included again!
 
-Note: In Paper UI there are no action buttons.
-You can trigger these actions changing from 'No Action' in the dropdown to the action value.
-
 ### Example Rule
 
 demo.rules:

diff --git a/bundles/org.openhab.binding.mihome/README.md b/bundles/org.openhab.binding.mihome/README.md
@@ -3,8 +3,8 @@
 This binding allows your openHAB to communicate with the Xiaomi Smart Home Suite.
 It consists of devices communicating over a ZigBee network with a ZigBee - WiFi gateway. 
 
-The devices are very affordable and you can get them from your favourite chinese marktes like [AliExpress](https://www.aliexpress.com/) or [GearBest](https://www.gearbest.com).
-The sensors run on a coincell battery for over a year. 
+The devices are very affordable and you can get them from your favourite Chinese markets like [AliExpress](https://www.aliexpress.com/) or [GearBest](https://www.gearbest.com).
+The sensors run on a coin cell battery for over a year. 
 
 After setup, you can disconnect the gateway from the internet to keep your sensor information private. 
 
@@ -70,7 +70,7 @@ Zigbee2Mqtt provides an alternative method to integrate Xiaomi devices.
 
 *   In openHAB you should now be able to discover the Xiaomi Gateway
 *   From now on you don't really need the app anymore. Only if you want to update the gateway firmware or if you want to add devices (see below). But adding devices can also be done without the app (see below)
-*   Enter the previously noted developer key in openHAB Paper UI -> Configuration -> Things -> Xiaomi Gateway -> Edit -> Developer Key. Save (This is required if you want to be able to send controls to the devices like the light of the gateway)
+*   Enter the previously noted developer key in openHAB Administration -> Settings -> Things -> Xiaomi Gateway -> Edit -> Developer Key. Save (This is required if you want to be able to send controls to the devices like the light of the gateway)
 
 ## Connecting devices to the gateway
 
@@ -88,7 +88,7 @@ There are three ways of connecting supported devices to the gateway:
 * With the binding
 
     1.  After adding the gateway make sure you have entered the right developer key
-    2.  In Paper UI, go to your Inbox and trigger a discovery for the binding
+    2.  In the UI, go to your Inbox and trigger a discovery for the binding
     3.  The gateway flashes in blue and you hear a female voice in Chinese, you have 30 seconds to include your new device
     4.  Follow the instructions for your device to pair it to the gateway
     5.  You will hear a confirmation message in Chinese

diff --git a/bundles/org.openhab.binding.miio/README.md b/bundles/org.openhab.binding.miio/README.md
@@ -381,7 +381,7 @@ After validation, please share the logfile and json files on the openHAB forum o
 
 Things using the basic handler (miio:basic things) are driven by json 'database' files.
 This instructs the binding which channels to create, which properties and actions are associated with the channels etc.
-The conf/misc/miio (e.g. in Linux `/opt/openhab2/conf/misc/miio/`) is scanned for database files and will be used for your devices. 
+The conf/misc/miio (e.g. in Linux `/opt/openhab/conf/misc/miio/`) is scanned for database files and will be used for your devices. 
 During the start of the binding the exact path used in your system will be printed in the debug log. 
 Watch for a line containing `Started miio basic devices local databases watch service. Watching for database files at path: …`
 If this folder is created after the start of the binding, you may need to restart the binding (or openHAB) to be able to use the local files. 

diff --git a/bundles/org.openhab.binding.milight/README.md b/bundles/org.openhab.binding.milight/README.md
@@ -33,9 +33,9 @@ Read the device manual for more information about how to connect your device to
 
 ## Thing Configuration
 
-Besides adding bridges through Paper UI, you can also add them manually in your Thing
+Besides adding bridges through the UI, you can also add them manually in your Thing
 configuration file.
-iBox and iBox2 have the version 6, older milight bridges have the version 3.
+iBox and iBox2 have the version 6, older Milight bridges have the version 3.
 The ID is the MAC address of the bridge in hexadecimal digits.
 
     Bridge milight:bridgeV3:mybridge [ host="192.168.0.70", bridgeid="ACCF23A6C0B4", passwordByte1=0, passwordByte2=0, repeat=2, delayTime=75 ] {
@@ -112,11 +112,10 @@ For rgbwLed/rgbwwLed bulbs these channels are supported:
     animation_speed_relative  Changes the speed of your chosen animation mode
     ledlink                   Sync bulb to this zone within 3 seconds of light bulb socket power on
     ledunlink                 Clear bulb from this zone within 3 seconds of light bulb socket power on
-
-
+
 Limitations:
 
-*   Only the rgbww bulbs support changing their saturation, for rgbv2Led/rgbwLed the colorpicker will only set the hue and brightness and change to whitemode if the saturation is under a given threshold of 50%.
+*   Only the rgbww bulbs support changing their saturation, for rgbv2Led/rgbwLed the colorpicker will only set the hue and brightness and change to white mode if the saturation is under a given threshold of 50%.
 
 ## Example
 
@@ -129,7 +128,7 @@ Dimmer Light_LivingroomC	{channel="milight:whiteLed:ACCF23A6C0B4:1:ledtemperatur
 Dimmer RGBW_LivingroomB		{channel="milight:rgbwLed:ACCF23A6C0B4:2:ledbrightness"}   //Dimmer changing brightness for RGBW bulb in zone 2
 Color Light_Party           {channel="milight:rgbwLed:ACCF23A6C0B4:1:ledcolor"}        //Colorpicker for rgb bulbs
 
-//You have to link the items to the channels of your prefered group e.g. in Paper UI after you have saved your items file.
+# You have to link the items to the channels of your prefered group.
 
 //The command types nightMode and whiteMode are stateless and should be configured as pushbuttons as they only support a trigger action:
 Switch Light_GroundfloorN	{channel="milight:whiteLed:ACCF23A6C0B4:0:lednightmode", autoupdate="false"} //Activate the NightMode for all bulbs

diff --git a/bundles/org.openhab.binding.minecraft/README.md b/bundles/org.openhab.binding.minecraft/README.md
@@ -68,7 +68,9 @@ Depending on the thing type, different channels are provided:
 
 ### Example Thing Definition
 
-The easiest method to add Minecraft servers, players, and signs is use the automatic discovery through Paper UI. However, you can manualy define the objects using thing configuration files. Players and signs are connected through Minecraft server [bridges](https://www.openhab.org/docs/configuration/things.html#defining-bridges-using-files).
+The easiest method to add Minecraft servers, players, and signs is use the automatic discovery.
+You can also manually define the objects using thing configuration files. 
+Players and signs are connected through Minecraft server [bridges](https://www.openhab.org/docs/configuration/things.html#defining-bridges-using-files).
 
 ```xtend
 Bridge minecraft:server:myminecraftserver "Minecraft server for Friends" @ "Minecraft" [ hostname="192.168.1.100", port=10692 ] {

diff --git a/bundles/org.openhab.binding.modbus.e3dc/README.md b/bundles/org.openhab.binding.modbus.e3dc/README.md
@@ -2,13 +2,13 @@
 
 <img align="right" src="./doc/E3DC_logo.png"/>
 
-Integrates the Home Power Plants from E3/DC GmbH into openHAB. See [E3DC Website](https://www.e3dc.com/) to find more informations about the device.
+Integrates the Home Power Plants from E3/DC GmbH into openHAB. 
+See [E3DC Website](https://www.e3dc.com/) to find more informations about the device.
 The Power Plant handles all your Electrical Energy Resources like Photovoltaic Producers, Battery Storage, Wallbox Power Supply, Household Consumption and even more.  
 E3DC devices are integrated into the Modbus Binding. 
 
 See chapter [Thing Configuration](#thing-configuration) how to set them up or check the [full example Things](#things) for manual setup. 
 
-
 ## Supported Things
 
 First you need a Bridge which establishes the basic connection towards your E3DC device
@@ -21,12 +21,12 @@ First you need a Bridge which establishes the basic connection towards your E3DC
 
 ## Discovery
 
-There's no discovery. Modbus registers are available for all devices. 
-
+There's no discovery. 
+Modbus registers are available for all devices. 
 
 ## Thing Configuration
 
-As mentioned earlier in the [Binding Description](#e3dc-binding) the needed Things can be found in the **Modbus Binding** and have to be added manually without Discovery
+The needed Things can be found in the **Modbus Binding** and have to be added manually without Discovery
 
 <img align="right" src="./doc/E3DC_Modbus_Settings.png"/>
 
@@ -151,7 +151,8 @@ Some of the Wallbox Settings can be changed. See the Access column if the actual
 
 ## Full Example
 
-Following example provides the full configuration. If you enter the correct Connection Data, IP Address, Device ID and Port number in the thing configuration you should be fine.
+Following example provides the full configuration. 
+If you enter the correct Connection Data, IP Address, Device ID and Port number in the thing configuration you should be fine.
 
 ### Things
 
@@ -306,8 +307,9 @@ Setup and configured everything the right way? Congratulations, you've now the r
 
 ### Persistence
 
-You can see in the example item configuration, that I added some items to the "persist". Feel free to choose your own group name but this opens the possibility 
-to store the items in a database. See following *.persist file configuration how this can be established.
+You can see in the example item configuration, that I added some items to the "persist". 
+Feel free to choose your own group name but this opens the possibility to store the items in a database. 
+See following *.persist file configuration how this can be established.
 
 ```
 Strategies {
@@ -325,8 +327,8 @@ Items {
 
 ### Visualization 
 
-After the timeline is available in your database you can continue with Visualization. I like the Grafana approach and I used the
-[InfluxDB & Grafana Tutorial](https://community.openhab.org/t/influxdb-grafana-persistence-and-graphing/13761)
+After the timeline is available in your database you can continue with Visualization. 
+I like the Grafana approach and I used the [InfluxDB & Grafana Tutorial](https://community.openhab.org/t/influxdb-grafana-persistence-and-graphing/13761)
 from the Community to set this up.
 I prepared my machine and I'm quite pleased with the results.
 
@@ -343,10 +345,11 @@ In the above picture there are two graphs
 
 ### Cross Connections 
 
-With the above setup you have now a great visualization and overview regarding your electric production and consumption. Now use the Power of openHAB and cross
-connect your data. For example you can use the 
-[OpenweatherMap API Binding](https://www.openhab.org/addons/bindings/openweathermap/)
-the cloudiness in Percent. With a modified *.persist file I store the cloudiness forecast also in the database
+With the above setup you have now a great visualization and overview regarding your electric production and consumption. 
+Now use the Power of openHAB and cross connect your data. 
+For example you can use the [OpenweatherMap API Binding](https://www.openhab.org/addons/bindings/openweathermap/)
+the cloudiness in Percent. 
+With a modified *.persist file I store the cloudiness forecast also in the database
 
 ```
 Strategies {
@@ -367,5 +370,4 @@ Having these values in the timeline you're able to cross check how the forecast
 
 <img style="float: right;" src="doc/GrafanaCloudiness.png">
 
-I personally would like to have
-more steering control of the E3DC to react on such forecast e.g. "stop charging the car if it gets too cloudy"
+I personally would like to have more steering control of the E3DC to react on such forecast e.g. "stop charging the car if it gets too cloudy"