Removal of reference to PaperUI (openhab#9905)

Related to openhab#8607. In some cases removed information that is actually generic information and should not be in binding readme. Signed-off-by: Hilbrand Bouwkamp <[email protected]>
lolodomo · Jan 22, 2021 · 8889762 · 8889762
1 parent ca6d62d
commit 8889762
Show file tree

Hide file tree

Showing 17 changed files with 56 additions and 109 deletions.
diff --git a/bundles/org.openhab.binding.amazonechocontrol/README.md b/bundles/org.openhab.binding.amazonechocontrol/README.md
@@ -165,7 +165,7 @@ It will be configured at runtime by using the save channel to store the current
 | radioStationId        | String      | R/W         | echo, echoshow, echospot, wha | Start playing of a TuneIn radio station by specifying its id or stops playing if an empty string was provided
 | radio                 | Switch      | R/W         | echo, echoshow, echospot, wha | Start playing of the last used TuneIn radio station (works after the radio station started after the openHAB start)
 | amazonMusicTrackId    | String      | R/W         | echo, echoshow, echospot, wha | Start playing of an Amazon Music track by its id or stops playing if an empty string was provided
-| amazonMusicPlayListId | String      | W           | echo, echoshow, echospot, wha | Write Only! Start playing of an Amazon Music playlist by specifying its id or stops playing if an empty string was provided. Selection will only work in PaperUI
+| amazonMusicPlayListId | String      | W           | echo, echoshow, echospot, wha | Write Only! Start playing of an Amazon Music playlist by specifying its id or stops playing if an empty string was provided.
 | amazonMusic           | Switch      | R/W         | echo, echoshow, echospot, wha | Start playing of the last used Amazon Music song (works after at least one song was started after the openHAB start)
 | remind                | String      | R/W         | echo, echoshow, echospot      | Write Only! Speak the reminder and sends a notification to the Alexa app (Currently the reminder is played and notified two times, this seems to be a bug in the Amazon software)
 | nextReminder          | DateTime    | R           | echo, echoshow, echospot      | Next reminder on the device
@@ -348,7 +348,7 @@ sitemap amazonechocontrol label="Echo Devices"
             // Change the <YOUR_DEVICE_MAC> Place holder with the MAC address shown, if Alexa is connected to the device
             Selection item=Echo_Living_Room_BluetoothMAC mappings=[ ''='Disconnected', '<YOUR_DEVICE_MAC>'='Bluetooth Device 1', '<YOUR_DEVICE_MAC>'='Bluetooth Device 2']
 
-            // These are only view of the possible options. Enable ShowIDsInGUI in the binding configuration and look in drop-down-box of this channel in the Paper UI Control section
+            // These are only view of the possible options.
             Selection item=Echo_Living_Room_PlayAlarmSound mappings=[ ''='None', 'ECHO:system_alerts_soothing_01'='Adrift', 'ECHO:system_alerts_atonal_02'='Clangy']
 
             Switch  item=Echo_Living_Room_Bluetooth
@@ -446,11 +446,11 @@ The polling interval configured in the Account Thing to get the state is specifi
 |--------------------------|---------------------------------------------------------------------------|
 | id                       | The id of the device or device group                                      |
 
-The only possibility to find out the id is by using the discover function in the PaperUI. You can use then the id, if you want define the Thing in a file.
+The only possibility to find out the id is by using the discover function in the UI. You can use then the id, if you want define the Thing in a file.
 
 #### Channels
 
-The channels of the smarthome devices will be generated at runtime. Check in the paperUI thing configurations, which channels are created.
+The channels of the smarthome devices will be generated at runtime. Check in the UI thing configurations, which channels are created.
 
 | Channel Type ID          | Item Type | Access Mode | Thing Type                    | Description                                                                                                                                                                
 |--------------------------|-----------|-------------|-------------------------------|------------------------------------------------------------------------------------------
@@ -505,7 +505,7 @@ Switch Arm_State "State" { channel="amazonechocontrol:smartHomeDevice:account1:s
 Switch Group_State "On/Off" { channel="amazonechocontrol:smartHomeDeviceGroup:account1:smartHomeDeviceGroup1:powerState" }
 ```
 
-The only possibility to find out the id for the smartHomeDevice and smartHomeDeviceGroup Things is by using the discover function in the PaperUI.
+The only possibility to find out the id for the smartHomeDevice and smartHomeDeviceGroup Things is by using the discover function.
 
 #### smarthome.sitemap:
 

diff --git a/bundles/org.openhab.binding.dsmr/README.md b/bundles/org.openhab.binding.dsmr/README.md
@@ -336,7 +336,7 @@ Number:Energy MeterDeliveryTariff1 "Total electricity delivered to the resident
 
 ## Determine M-Bus channel
 
-By manually trigger the discovery process, e.g. via PaperUI, you can use the logging to find out a M-Bus channel. Look for the following logfile line:
+By manually trigger the discovery process, you can use the logging to find out a M-Bus channel. Look for the following logfile line:
 `<Timestamp> [INFO ] [<class>] - New compatible meter: [Meter type: M3_V5_0, channel: 1, Meter type: ELECTRICITY_V5, channel: 0]`
 
 Here you find the ThingTypeID (it is stated only in capitals) and the M-Bus channel. The above example would lead to the following Thing definition

diff --git a/bundles/org.openhab.binding.dwdpollenflug/README.md b/bundles/org.openhab.binding.dwdpollenflug/README.md
@@ -26,9 +26,9 @@ This can be used for `region` things you may add manually.
 
 ### Region
 
-| Parameter  | Default | Required | Description                                                                                              |
-| ---------- | :-----: | :------: | -------------------------------------------------------------------------------------------------------- |
-| `regionID` |    -    |   yes    | In PaperUI just select the region you want to display data for. For files-configuration see table below. |
+| Parameter  | Default | Required | Description                                                         |
+| ---------- | :-----: | :------: | ------------------------------------------------------------------- |
+| `regionID` |    -    |   yes    | The id of the region. The available options are in the table below. |
 
 #### Manual region or partregion selection ####
 

diff --git a/bundles/org.openhab.binding.enocean/README.md b/bundles/org.openhab.binding.enocean/README.md
@@ -114,7 +114,7 @@ To pair an EnOcean device with its openHAB thing representation, you have to dif
 
 ### Sensors
 
-To pair a sensor with its thing, you first have to start the discovery scan for this binding in PaperUI.
+To pair a sensor with its thing, you first have to start the discovery scan for this binding.
 Then press the "teach-in" button of the sensor.
 The sensor sends a teach-in message which contains the information about the EEP and the EnOceanId of the sensor.
 If the EEP is known by this binding the thing representation of the device is created.
@@ -123,7 +123,7 @@ The corresponding channels are created dynamically, too.
 ### Actuators
 
 If the actuator supports UTE teach-in, the corresponding thing can be created and paired automatically.
-First you have to **start the discovery scan for a gateway** in PaperUI.
+First you have to **start the discovery scan for a gateway**.
 Then press the teach-in button of the actuator.
 If the EEP of the actuator is known, the binding sends an UTE teach-in response with a new SenderId and creates a new thing with its channels. 
 

diff --git a/bundles/org.openhab.binding.fmiweather/README.md b/bundles/org.openhab.binding.fmiweather/README.md
@@ -28,10 +28,6 @@ The binding automatically discovers weather stations and forecasts for nearby pl
 
 ## Thing Configuration
 
-Typically there is no need to manually configure things unless you prefer to use textual configuration, or if you want to have observation or forecast for a specific location.
-
-In case you are using textual configuration, you need to use quotes around text parameters. In PaperUI this is not necessary.
-
 ### `observation` thing configuration
 
 | Parameter | Type | Required | Description                                                                                                                                                                                                                                                                                                                                                         | Example                              |

diff --git a/bundles/org.openhab.binding.homematic/README.md b/bundles/org.openhab.binding.homematic/README.md
@@ -209,7 +209,7 @@ Bridge homematic:bridge:occu  [ gatewayAddress="..."]
 
 ## Thing Configuration
 
-Things are all discovered automatically, you can handle them in PaperUI.
+Things are all discovered automatically.
 
 If you really like to manually configure a thing:
 
@@ -225,13 +225,6 @@ If you are using Homegear, you have to add the prefix `HG-` for each type.
 The `HG-` prefix is only needed for Things, not for Items or channel configs.
 This is necessary, because the Homegear devices supports more datapoints than Homematic devices.
 
-```java
-  Thing HG-HM-LC-Dim1T-Pl-2     JEQ0999999
-```
-
-As additional parameters you can define a name and a location for each thing.
-The `Name` will be used to identify the thing in the Paper UI lists, the `Location` will be used in the Control section of PaperUI to sort the things.
-
 ```java
   Thing HG-HM-LC-Dim1T-Pl-2     JEQ0999999  "Name"  @  "Location"
 ```

diff --git a/bundles/org.openhab.binding.hue/README.md b/bundles/org.openhab.binding.hue/README.md
@@ -65,16 +65,9 @@ They are presented by the following ZigBee Device ID and _Thing type_:
 
 The Hue Dimmer Switch has 4 buttons and registers as a Non-Colour Controller switch, while the Hue Tap (also 4 buttons) registers as a Non-Colour Scene Controller in accordance with the ZLL standard.
 
-Also, Hue bridge support CLIP Generic Status Sensor and CLIP Generic Flag Sensor. These sensors save state for rules and calculate what actions to do. CLIP Sensor set or get by JSON through IP.
-
-The type of a specific device can be found in the configuration section for things in the PaperUI.
-It is part of the unique thing id which could look like:
-
-```
-hue:0210:00178810d0dc:1
-```
-
-The thing type is the second string behind the first colon and in this example it is **0210**.
+Also, Hue bridge support CLIP Generic Status Sensor and CLIP Generic Flag Sensor.
+These sensors save state for rules and calculate what actions to do.
+CLIP Sensor set or get by JSON through IP.
 
 Finally, the Hue binding also supports the groups of lights and rooms set up on the Hue bridge.
 

diff --git a/bundles/org.openhab.binding.knx/README.md b/bundles/org.openhab.binding.knx/README.md
@@ -1,7 +1,7 @@
 
 # KNX Binding
 
-The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations. 
+The openHAB KNX binding allows to connect to [KNX Home Automation](https://www.knx.org/) installations.
 Switching lights on and off, activating your roller shutters or changing room temperatures are only some examples.
 
 To access your KNX bus you either need a gateway device which is connected to the KNX bus and allows computers to access the bus communication.
@@ -17,7 +17,7 @@ There is an *ip* bridge to connect to KNX IP Gateways, and a *serial* bridge for
 
 ## Binding Configuration
 
-The binding itself does not require any special configuration. 
+The binding itself does not require any special configuration.
 
 ## Bridges
 
@@ -209,11 +209,11 @@ Only add parameters to the Bridge and Thing configuration if you know exactly wh
 knx.things:
 
 ```xtend
-Bridge knx:ip:bridge [ 
+Bridge knx:ip:bridge [
     type="ROUTER",
     autoReconnectPeriod=60 //optional, do not set <30 sec.
 ] {
-    Thing device knx_device "knx_device_name" @ "knx_device_group_in_paperui" [ 
+    Thing device knx_device "knx_device_name" @ "knx_device_group" [
         //readInterval=3600 //optional, only used if reading values are present
     ] {
         //Items configurations
@@ -226,12 +226,12 @@ Bridge knx:ip:bridge [
 knx.things:
 
 ```xtend
-Bridge knx:ip:bridge [ 
+Bridge knx:ip:bridge [
     type="TUNNEL",
     ipAddress="192.168.0.111",
     autoReconnectPeriod=60 //optional, do not set <30 sec.
 ] {
-    Thing device knx_device "knx_device_name" @ "knx_device_group_in_paperui" [ 
+    Thing device knx_device "knx_device_name" @ "knx_device_group" [
         //readInterval=3600 //optional, only used if reading values are present
     ] {
         //Items configurations
@@ -243,14 +243,14 @@ Bridge knx:ip:bridge [
 
 ```xtend
 //TUNNEL
-Bridge knx:ip:bridge [  
-    type="TUNNEL", 
-    ipAddress="192.168.0.10", 
-    portNumber=3671, 
+Bridge knx:ip:bridge [
+    type="TUNNEL",
+    ipAddress="192.168.0.10",
+    portNumber=3671,
     localIp="192.168.0.11",
-    readingPause=50, 
-    responseTimeout=10, 
-    readRetriesLimit=3, 
+    readingPause=50,
+    responseTimeout=10,
+    readRetriesLimit=3,
     autoReconnectPeriod=60,
     localSourceAddr="0.0.0"
 ] {
@@ -271,14 +271,14 @@ Bridge knx:ip:bridge [
 }
 
 //ROUTER
-Bridge knx:ip:bridge [  
-    type="ROUTER", 
-    ipAddress="224.0.23.12", 
-    portNumber=3671, 
+Bridge knx:ip:bridge [
+    type="ROUTER",
+    ipAddress="224.0.23.12",
+    portNumber=3671,
     localIp="192.168.0.11",
-    readingPause=50, 
-    responseTimeout=10, 
-    readRetriesLimit=3, 
+    readingPause=50,
+    responseTimeout=10,
+    readRetriesLimit=3,
     autoReconnectPeriod=60,
     localSourceAddr="0.0.0"
 ] {}
@@ -308,7 +308,7 @@ sitemap knx label="KNX Demo Sitemap" {
     Slider item=demoDimmer
     Text   item=demoString
     Text   item=demoDatetime
-  }                
+  }
 }
 
 ```
@@ -318,11 +318,11 @@ sitemap knx label="KNX Demo Sitemap" {
 control.things:
 
 ```xtend
-Bridge knx:serial:bridge [ 
-    serialPort="/dev/ttyAMA0", 
-    readingPause=50, 
-    responseTimeout=10, 
-    readRetriesLimit=3, 
+Bridge knx:serial:bridge [
+    serialPort="/dev/ttyAMA0",
+    readingPause=50,
+    responseTimeout=10,
+    readRetriesLimit=3,
     autoReconnectPeriod=60
 ] {
     Thing device generic {
@@ -335,9 +335,9 @@ Bridge knx:serial:bridge [
     }
 }
 
-Bridge hue:bridge:bridge "Philips Hue Bridge" [ 
-    ipAddress="...", 
-    userName="..." 
+Bridge hue:bridge:bridge "Philips Hue Bridge" [
+    ipAddress="...",
+    userName="..."
 ] {
     Thing 0210 1 "Color Lamp" [ lightId="1" ]
 }

diff --git a/...entatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVHandler.java b/...entatv/src/main/java/org/openhab/binding/magentatv/internal/handler/MagentaTVHandler.java
@@ -185,7 +185,7 @@ private void initializeThing() {
     }
 
     /**
-     * This routine is called every time the Thing configuration has been changed (e.g. PaperUI)
+     * This routine is called every time the Thing configuration has been changed.
      */
     @Override
     public void handleConfigurationUpdate(Map<String, Object> configurationParameters) {

diff --git a/...binding.max/src/main/java/org/openhab/binding/max/internal/handler/MaxDevicesHandler.java b/...binding.max/src/main/java/org/openhab/binding/max/internal/handler/MaxDevicesHandler.java
@@ -158,7 +158,7 @@ public void handleConfigurationUpdate(Map<String, Object> configurationParameter
                     configurationParameter.getKey(), configurationParameter.getValue());
 
             // Test if it is a part of the configuration properties.
-            // As paperUI sends all parameters as changed, we need to determine which ones really changed.
+            // With the update all parameters are sends, so we need to determine which ones really changed.
             if (deviceProperties.containsKey(configurationParameter.getKey())) {
                 if (deviceProperties.get(configurationParameter.getKey()).equals(configurationParameter.getValue())) {
                     logger.trace("Device {} Property {} value {} unchanged.", getThing().getUID(),

diff --git a/...va/org/openhab/binding/nikohomecontrol/internal/handler/NikoHomeControlBridgeHandler.java b/...va/org/openhab/binding/nikohomecontrol/internal/handler/NikoHomeControlBridgeHandler.java
@@ -168,8 +168,7 @@ public void controllerOnline() {
     }
 
     /**
-     * Update bridge properties with properties returned from Niko Home Control Controller, so they can be made visible
-     * in PaperUI.
+     * Update bridge properties with properties returned from Niko Home Control Controller.
      */
     protected abstract void updateProperties();
 

diff --git a/...g.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java b/...g.shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyBaseHandler.java
@@ -176,7 +176,7 @@ public void initialize() {
     }
 
     /**
-     * This routine is called every time the Thing configuration has been changed (e.g. PaperUI)
+     * This routine is called every time the Thing configuration has been changed.
      */
     @Override
     public void handleConfigurationUpdate(Map<String, Object> configurationParameters) {

diff --git a/....shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyRelayHandler.java b/....shelly/src/main/java/org/openhab/binding/shelly/internal/handler/ShellyRelayHandler.java
@@ -131,7 +131,6 @@ public boolean handleDeviceCommand(ChannelUID channelUID, Command command) throw
     }
 
     /**
-     * PaperUI Control has a combined Slider for Brightness combined with On/Off
      * Brightness channel has 2 functions: Switch On/Off (OnOnType) and setting brightness (PercentType)
      * There is some more logic in the control. When brightness is set to 0 the control sends also an OFF command
      * When current brightness is 0 and slider will be moved the new brightness will be set, but also a ON command is

diff --git a/bundles/org.openhab.binding.smartthings/doc/Troubleshooting.md b/bundles/org.openhab.binding.smartthings/doc/Troubleshooting.md
@@ -1,37 +1,6 @@
 # Smartthings Binding Troubleshooting Guidelines
 Below are some recommendations on resolving issues with things not working as expected 
 
-## Device specific issues
-If the binding is working for some devices but there is one device that doesn't seem to work then verify that the device is supported by checking the following in the PaperUI:
-1. Open the PaperUI webpage
-2. Select Configuration -> Bindings -> Smartthings
-3. Verify that the thing you want to use is included in the list of Supported Things
-
-If the device is listed then create a new topic in the [openHAB Community Add-ons -> Bindings](https://community.openhab.org/c/add-ons/bindings/) website. 
-
-## Setting openHAB logs to Debug
-You will need to edit the logging configuration file and set the log level for the Smartthings binding to debug.
-
-The following assumes you are running on Linux or Raspbian
-
-Follow these steps on your openHAB server:
-1. If logged on to the server: cd /var/lib/openhab2/etc or if using Samba open file explorer to \\\\OPENHABIANPI\openHAB-userdata\etc
-2. Edit the file org.ops4j.pax.logging.cfg
-      * Just ** before ** the line "log4j2.logger.openhab.name = org.openhab" add the following lines:
-      * log4j2.logger.smartthings.name=org.openhab.binding.smartthings
-      * log4j2.logger.smartthings.level=DEBUG
-      * Save the file
-3. Restart the server (i.e. sudo systemctl restart openhab2.service)
-
-## Viewing the openHAB logs
-Viewing the logs is best done on the openHAB server where you can using the linux command "tail -f" to watch the log messages as they are created
-
-Follow these steps on your openHAB server:
-1. cd /var/log/openhab2 or if using Samba open file explorer to \\OPENHABIANPI\openHAB-log
-2. The log file you want to see is openhab.log
-3. Using unix "tail -f openhab.log"
-4. Try the device that isn't working and look for log messages related to the device you are using 
-
 ## Viewing Smartthings logs
 On the Smartthings hub all of the incoming messages and the responses are logged. Looking at these logs can be very informative.
 

diff --git a/...adfri/src/main/java/org/openhab/binding/tradfri/internal/handler/TradfriLightHandler.java b/...adfri/src/main/java/org/openhab/binding/tradfri/internal/handler/TradfriLightHandler.java
@@ -198,7 +198,6 @@ private void handleColorCommand(Command command) {
         } else if (command instanceof OnOffType) {
             setState(((OnOffType) command));
         } else if (command instanceof PercentType) {
-            // PaperUI sends PercentType on color channel when changing Brightness
             setBrightness((PercentType) command);
         } else if (command instanceof IncreaseDecreaseType) {
             final TradfriLightData state = this.state;

diff --git a/bundles/org.openhab.binding.velux/src/main/resources/OH-INF/i18n/velux_de.properties b/bundles/org.openhab.binding.velux/src/main/resources/OH-INF/i18n/velux_de.properties
@@ -175,7 +175,7 @@ runtime.bridge-offline-login-sequence-failed = Anmeldung am Kopplungselement feh
 channelValue.check-integrity-failed = Integritätsprüfung fehlgeschlagen. Nachfolgende Szenen werden nicht verwendet: 
 channelValue.check-integrity-ok = Integritätsprüfung bestanden. Alle definierten Szenen werden verwendet.
 #
-# Note: this entry should overwrite the implicit naming within paperUI slider element
+# Note: this entry should overwrite the implicit naming
 #
 channel-type.velux.control.label = Steuerung
 channel-type.velux.control.description = Steuerungselement (hoch/runter/stop).