diff --git a/bundles/org.openhab.binding.atlona/README.md b/bundles/org.openhab.binding.atlona/README.md index e8390239e85..cde05a2ffe9 100644 --- a/bundles/org.openhab.binding.atlona/README.md +++ b/bundles/org.openhab.binding.atlona/README.md @@ -17,7 +17,7 @@ This binding supports the following thing types: ## Discovery -The Atlona AT-UHD-PRO3 switch can be discovered by starting a scan in the Paper UI and then logging into your switch and pressing the "SDDP" button on the "Network" tab. +The Atlona AT-UHD-PRO3 switch can be discovered by starting a discovery scan in the UI and then logging into your switch and pressing the "SDDP" button on the "Network" tab. The "SDDP" (simple device discovery protocol) button will initiate the discovery process. If "Telnet Login" is enabled ("Network" tab from the switch configuration UI), you will need to set the username and password in the configuration of the newly discovered thing before a connection can be made. diff --git a/bundles/org.openhab.binding.bigassfan/README.md b/bundles/org.openhab.binding.bigassfan/README.md index e9fc5c11da1..6892fac00c5 100644 --- a/bundles/org.openhab.binding.bigassfan/README.md +++ b/bundles/org.openhab.binding.bigassfan/README.md @@ -31,7 +31,7 @@ In the event that any of this information is changed on the device, the thing co ### Manual Thing Creation -Fans and lights can be manually created in the *Paper UI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory. +Fan and light things can be manually created using the *UI*, or by placing a *.things* file in the *conf/things* directory. See example below. ## Device Discovery diff --git a/bundles/org.openhab.binding.bticinosmarther/README.md b/bundles/org.openhab.binding.bticinosmarther/README.md index b925169ddb5..3fd53d0611e 100644 --- a/bundles/org.openhab.binding.bticinosmarther/README.md +++ b/bundles/org.openhab.binding.bticinosmarther/README.md @@ -112,7 +112,7 @@ If you want to later receive push notifications (device status) from Legrand for ![Tutorial 3](doc/images/tutorial-3.png) -Now that you have got your bridge _ONLINE_ it is time to discover your devices! Go to Paper UI Inbox and search for **"BTicino Smarther Chronothermostat"** things. +Now that you have got your bridge _ONLINE_ it is time to discover your devices! Go to Inbox in the UI and search for **"BTicino Smarther Chronothermostat"** things. Any BTicino Smarther Chronothermostat device currently available on your account should show up immediately. If no devices show up you may have to trigger the openHAB discovery several times as bridge will only find active devices known by the Smarther API at the time the discovery is triggered. diff --git a/bundles/org.openhab.binding.buienradar/README.md b/bundles/org.openhab.binding.buienradar/README.md index 20eeb03f10a..dc81d5880f4 100644 --- a/bundles/org.openhab.binding.buienradar/README.md +++ b/bundles/org.openhab.binding.buienradar/README.md @@ -19,7 +19,7 @@ No auto-discovery is currently possible. ## Configuration of the thing -The configuration can be done via the Paper UI web interface, or manually by adding a Thing to your `.things` file: +The configuration can be done by adding a Rain Forecast Thing using the UI, or by adding it to a `.things` file: ``` Thing buienradar:rain_forecast:home [ location="52.198864211111925,5.4192629660193585" ] diff --git a/bundles/org.openhab.binding.cbus/README.md b/bundles/org.openhab.binding.cbus/README.md index 8d25df089b7..b4154cee4c3 100644 --- a/bundles/org.openhab.binding.cbus/README.md +++ b/bundles/org.openhab.binding.cbus/README.md @@ -5,9 +5,12 @@ This binding allows you to view and control groups on C-Bus networks from openHA ## Configuration -This binding connects to C-Gate software which can be downloaded from the [Clipsal Downloads Site](https://updates.clipsal.com/ClipsalSoftwareDownload/mainsite/cis/technical/index.html). There is information about setting up the C-Gate software in the [CBus Forums](https://www.cbusforums.com/forums/c-bus-toolkit-and-c-gate-software.4). Make sure that the config/access.txt file allows a connection from computer running openHAB. +This binding connects to C-Gate software which can be downloaded from the [Clipsal Downloads Site](https://updates.clipsal.com/ClipsalSoftwareDownload/mainsite/cis/technical/index.html). +There is information about setting up the C-Gate software in the [CBus Forums](https://www.cbusforums.com/forums/c-bus-toolkit-and-c-gate-software.4). +Make sure that the config/access.txt file allows a connection from computer running openHAB. -Whilst all versions of C-Gate should work 2.11.2 contained a fix for handling Indicator Kill messages for trigger groups. Without that they will remain on the last value set and wont match what is shown on CBus devices. +Whilst all versions of C-Gate should work 2.11.2 contained a fix for handling Indicator Kill messages for trigger groups. +Without that they will remain on the last value set and wont match what is shown on CBus devices. First the CGate Connection bridge needs to be configured with the ip address of the computer running the C-Gate software. After this a Bridge is creaed for each network configured on the CBus Network. The CBus Project Name and the network Id for that network @@ -17,19 +20,21 @@ After this a Bridge is creaed for each network configured on the CBus Network. T This binding support 6 different things types -| Thing | Type | Description | -|----------------|---------|-----------------------------------| -| cgate | Bridge | This connects to a C-Bus CGate instance to | -| network | Bridge | This connects to a C-Bus Network via a CGate bridge | -| light | Thing | This is for C-Bus lighting groups | -| temperature | Thing | This is for C-Bus temperature groups | -| trigger | Thing | This is for C-Bus trigger groups | -| dali | Thing | This is for C-Bus DALI dimming groups | +| Thing | Type | Description | +|-------------|--------|-----------------------------------------------------| +| cgate | Bridge | This connects to a C-Bus CGate instance to | +| network | Bridge | This connects to a C-Bus Network via a CGate bridge | +| light | Thing | This is for C-Bus lighting groups | +| temperature | Thing | This is for C-Bus temperature groups | +| trigger | Thing | This is for C-Bus trigger groups | +| dali | Thing | This is for C-Bus DALI dimming groups | + +When a discovery scan is started in the UI, Things are discovered for the groups that are found on the CBus network. -The scan within Paper UI will find all the groups on the CBus network and allow Things to be creaed for them. ##Channels -At startup the binding will scan the network for the values of all the groups and set those on the appropriate channels. It is not possible to fetch the value of a Trigger Group so those values will only be updated when a trigger is set on the CBus network. +At startup the binding will scan the network for the values of all the groups and set those on the appropriate channels. +It is not possible to fetch the value of a Trigger Group so those values will only be updated when a trigger is set on the CBus network. ### Lights @@ -107,6 +112,3 @@ sitemap cbusdemo label="CBus Binding Demo" } } ``` - - - diff --git a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/handler/DenonMarantzHandler.java b/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/handler/DenonMarantzHandler.java index 0be9348c12d..7f95d4c7a79 100644 --- a/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/handler/DenonMarantzHandler.java +++ b/bundles/org.openhab.binding.denonmarantz/src/main/java/org/openhab/binding/denonmarantz/internal/handler/DenonMarantzHandler.java @@ -197,8 +197,7 @@ public class DenonMarantzHandler extends BaseThingHandler implements DenonMarant } /** - * Try to auto configure the connection type (Telnet or HTTP) - * for Things not added through Paper UI. + * Try to auto configure the connection type (Telnet or HTTP) for unmanaged Things. */ private void autoConfigure() throws InterruptedException { /* diff --git a/bundles/org.openhab.binding.dscalarm/README.md b/bundles/org.openhab.binding.dscalarm/README.md index 8cbc1eb69d0..79fc3e3d3ab 100644 --- a/bundles/org.openhab.binding.dscalarm/README.md +++ b/bundles/org.openhab.binding.dscalarm/README.md @@ -3,7 +3,7 @@ The DSC PowerSeries Alarm System is a popular do-it-yourself home security system, which can be monitored and controlled remotely through a standard web-browser or mobile device. This is the binding for the DSC PowerSeries Alarm System, utilizing either the EyezOn Envisalink 4/3/2DS interface or the DSC IT-100 RS-232 interface. -It provides connectivity to the DSC Alarm panel via a TCP socket connection to the EyesOn Envisalink 4/3/2DS interface or a RS-232 serial connection to the DSC IT-100 interface. +It provides connectivity to the DSC Alarm panel via a TCP socket connection to the EyesOn Envisalink 4/3/2DS interface or a RS-232 serial connection to the DSC IT-100 interface. Additionally, their is provision to connect to the DSC IT-100 interface through a TCP serial server. ## Supported Things @@ -27,16 +27,16 @@ Most settings are through thing configuration parameters. ## Discovery -The DSC Alarm binding incorporates a discovery modes in order to find DSC Alarm systems. +The DSC Alarm binding incorporates a discovery modes in order to find DSC Alarm systems. There is the Envisalink bridge discovery mode which performs a network query for any Envisalink adapters and adds them to the discovery inbox. -This bridge discovery mode is started manually through Paper UI. +This bridge discovery mode is started manually through the UI. After a bridge is discovered and available to openHAB, the binding will attempt to discover DSC Alarm things and add them to the discovery inbox. The TCP Server bridge does not implement bridge discovery but will utilize thing discovery once it is online. Note: The Envisalink Bridge discovery does a TCP scan across your local network to find the interface. This may create issues on the network so it is suggested that caution be used when trying this discovery. -The recommended method would be to manually add and configure the bridge through the 'dscalarm.thing' file or the Paper UI. +The recommended method would be to manually add and configure the bridge through the 'dscalarm.thing' file or the UI. And then allow the binding to discover the DSC Alarm things. ## Thing Configuration @@ -55,8 +55,8 @@ The following table shows the available configuration parameters for each thing. keypadNo parameters -The binding can be configured manually if discovery is not used. -A thing configuration file in the format 'bindingName.things' would need to be created, and placed in the 'conf/things' folder. +The binding can be configured manually if discovery is not used. +A thing configuration file in the format 'bindingName.things' would need to be created, and placed in the 'conf/things' folder. Here is an example of a thing configuration file called 'dscalarm.things': ```perl @@ -175,7 +175,7 @@ DSC Alarm things support a variety of channels as seen below in the following ta 1=ON
2=Flashing
keypad_lcd_updateStringText Changes of the IT-100 LCD Menu. - keypad_lcd_cursorStringLCD Cursor Position for The IT-100 + keypad_lcd_cursorStringLCD Cursor Position for The IT-100 ##Example diff --git a/bundles/org.openhab.binding.dsmr/README.md b/bundles/org.openhab.binding.dsmr/README.md index fa2a22c38b5..a99d1416ba4 100644 --- a/bundles/org.openhab.binding.dsmr/README.md +++ b/bundles/org.openhab.binding.dsmr/README.md @@ -152,7 +152,7 @@ Bridge dsmr:dsmrBridge:myDSMRDevice [serialPort="/dev/ttyUSB0"] { #### Item configuration -Paper UI. Item configuration can be done in the regular way. +Item configuration can be done in the regular way. Manual configuration: The following channels are supported: diff --git a/bundles/org.openhab.binding.enocean/README.md b/bundles/org.openhab.binding.enocean/README.md index 54c77c8ad71..a32ab02b157 100644 --- a/bundles/org.openhab.binding.enocean/README.md +++ b/bundles/org.openhab.binding.enocean/README.md @@ -159,8 +159,8 @@ To set this SenderId to a specific one, you have to use the nextSenderId paramet ## Thing Configuration -The pairing process of an openHAB thing and an EnOcean device has to be triggered within Paper UI. -Therefore if you do not want to use Paper UI, a mixed mode configuration approach has to be done. +The pairing process of an openHAB thing and an EnOcean device has to be triggered within the UI. +Therefore if you do not want to use the UI, a mixed mode configuration approach has to be done. To determine the EEP and EnOceanId of the device and announce a SenderId to it, you first have to pair an openHAB thing with the EnOcean device. Afterwards you can delete this thing and manage it with its necessary parameters through a configuration file. If you change the SenderId of your thing, you have to pair again the thing with your device. diff --git a/bundles/org.openhab.binding.folding/README.md b/bundles/org.openhab.binding.folding/README.md index 782ce533a5f..918c8b2e640 100644 --- a/bundles/org.openhab.binding.folding/README.md +++ b/bundles/org.openhab.binding.folding/README.md @@ -1,26 +1,18 @@ # Folding@home Binding -Binding for the [Folding@home](https://folding.stanford.edu/) distributed computing -software. +Binding for the [Folding@home](https://folding.stanford.edu/) distributed computing software. -This binding can control multiple Folding@home clients and slots, using the TCP -interface. -Clients are modeled as bridges, and support adding any number of slots -(though, usually CPU and GPU). +This binding can control multiple Folding@home clients and slots, using the TCP interface. +Clients are modeled as bridges, and support adding any number of slots (though, usually CPU and GPU). The binding provides control over Run / Pause and Finish. -It polls for the status of the client, updates the run / pause state, and -provides a basic description of the slot. +It polls for the status of the client, updates the run / pause state, and provides a basic description of the slot. -The clients must be added manually in the Paper UI, but the slots for that -client will then appear using auto-discovery. +The clients must be added manually in the UI, but the slots for a client will then appear using auto-discovery. ## Requirements (network access to F@H) -The Folding@home TCP interface is enabled only on localhost by default, without -a password. -In order to allow control of Folding on other machines than the one -running openHAB, it is necessary to configure the Folding client to accept commands -from a non-localhost address. +The Folding@home TCP interface is enabled only on localhost by default, without a password. +In order to allow control of Folding on other machines than the one running openHAB, it is necessary to configure the Folding client to accept commands from a non-localhost address. Here is how to do it in the FAHControl application: - Open FAHControl on the client to be added diff --git a/bundles/org.openhab.binding.globalcache/README.md b/bundles/org.openhab.binding.globalcache/README.md index 742831088e7..a32d2210c90 100644 --- a/bundles/org.openhab.binding.globalcache/README.md +++ b/bundles/org.openhab.binding.globalcache/README.md @@ -112,7 +112,7 @@ parameters for **baud rate**, **flow control**, and **parity** to match the conf ### Manual Thing Creation -Devices can be created in the *Paper UI* or *HABmin*, or by placing a *.things* file in the *conf/things* directory. +Devices can be created in the *UI*, or by placing a *.things* file in the *conf/things* directory. See example below. ### Binding Dependencies @@ -132,7 +132,7 @@ discovery.globalcache:background=false ``` Note that automatic device discovery **will not work** with GC-100's running firmware earlier than v3.0 as those versions do not emit announcement beacons on the multicast address. -GC-100's running firmware earlier than v3.0 must be configured manually, either through *Paper UI* or using a *.things* file. +GC-100's running firmware earlier than v3.0 must be configured manually, either through the *UI* or using a *.things* file. See below. ## Channels and Channel Types @@ -197,7 +197,7 @@ Other settings, such as *Sensor In*, *Sensor Notify*, and *LED Lighting*, may be ## Contact Closure (CC) Channel -A *Contact Closure channel* activates the contact closure (relay) on the iTach or GC-100 device. +A *Contact Closure channel* activates the contact closure (relay) on the iTach or GC-100 device. For example, the following item links to the module 1, connector 1 channel on an iTach CC device. ``` @@ -212,7 +212,7 @@ String MyRelay "My Relay [%s]" (gRelays) { channel="globalcache:itachFlex ## Serial (SL) Channel -An *SL channel* sends serial command strings out the serial connector on the device. +An *SL channel* sends serial command strings out the serial connector on the device. For example, the following item links to the module 1 connector 1 channel on a GC-100-6 device. ``` diff --git a/bundles/org.openhab.binding.heos/README.md b/bundles/org.openhab.binding.heos/README.md index 83e0b0089d8..5a728a15b24 100644 --- a/bundles/org.openhab.binding.heos/README.md +++ b/bundles/org.openhab.binding.heos/README.md @@ -34,9 +34,9 @@ __Important!__ Please note that only one bridge is required to establish a connection. Adding a second bridge can cause trouble with the connection. -It is recommended to use the Paper UI to setup the system and add all players and groups. +It is recommended to use the UI to setup the system and add all players and groups. The bridge is discovered through UPnP in the local network. -Once it is added the players and groups are discovered via the bridge and placed in the Paper UI Inbox. +Once it is added the players and groups are discovered via the bridge and placed in the Inbox. ## Binding Configuration @@ -80,7 +80,7 @@ Thing heos:player:player1 "name" [pid="123456789"] PID behind the heos:player:--- should be changed as required. It is recommended to use the Player PID. If the PID isn't known it can be discovered by establishing a Telnet connection (port 1255) to one player and search for available players (Command: heos://player/get_players) within the network. -Another way is to use Paper UI to discover the Player via the bridge and get the PID. +Another way is to use the UI to discover the Player via the bridge and get the PID. For further details refer to the [HEOS CLI](https://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification.pdf) specification. ### Group Configuration @@ -91,8 +91,9 @@ Player have the following configuration parameter |----------------- |------------------------------------------------------------------------------------- | --------- | | members | The members of the groups. These are the player IDs. IDs have to be separated by ";" | yes | -If you use Paper UI to manage your Things (which is the preferred way), you can also set up your group automatically from Paper UI. -Groups will automatically appear in the Inbox if that Group is active. To do this, build your Group from the HEOS app, then the group will appear in the Inbox. +Groups will automatically appear in the Inbox if that Group is active. +To do this, build your Group from the HEOS app, then the group will appear in the Inbox. + ``` Thing heos:group:group1 "name" [members="45345634;35534567"] ``` diff --git a/bundles/org.openhab.binding.hue/README.md b/bundles/org.openhab.binding.hue/README.md index f809c21f4f3..d6649590eb7 100644 --- a/bundles/org.openhab.binding.hue/README.md +++ b/bundles/org.openhab.binding.hue/README.md @@ -118,7 +118,7 @@ or 0107 motion-sensor "Motion Sensor" @ "Entrance" [ sensorId="4" ] ``` -You can freely choose the thing identifier (such as motion-sensor), its name (such as "Motion Sensor") and the location (such as "Entrance"). The name will then be used e.g. by Paper UI to show the item. +You can freely choose the thing identifier (such as motion-sensor), its name (such as "Motion Sensor") and the location (such as "Entrance"). The following device types also have an optional configuration value to specify the fade time in milliseconds for the transition to a new state: @@ -144,7 +144,6 @@ group kitchen-bulbs "Kitchen Lamps" @ "Kitchen" [ groupId="1" ] ``` You can freely choose the thing identifier (such as kitchen-bulbs), its name (such as "Kitchen Lamps") and the location (such as "Kitchen"). -The name will then be used e.g. by Paper UI to show the item. The group type also have an optional configuration value to specify the fade time in milliseconds for the transition to a new state. @@ -307,7 +306,7 @@ String LightScene { channel="hue:bridge:1:scene"} ``` Note: The bridge ID is in this example **1** but can be different in each system. -Also, if you are doing all your configuration through files and do not use Paper UI and the Inbox, you may add the full bridge id to the channel definitions (e.g. `channel="hue:0210:00178810d0dc:bulb1:color`) instead of the short version (e.g. `channel="hue:0210:1:bulb1:color`) to prevent frequent discovery messages in the log file. +Also, if you are doing all your configuration through files, you may add the full bridge id to the channel definitions (e.g. `channel="hue:0210:00178810d0dc:bulb1:color`) instead of the short version (e.g. `channel="hue:0210:1:bulb1:color`) to prevent frequent discovery messages in the log file. ### demo.sitemap: diff --git a/bundles/org.openhab.binding.icloud/README.md b/bundles/org.openhab.binding.icloud/README.md index fd3b77d0fc1..1f3e5733393 100644 --- a/bundles/org.openhab.binding.icloud/README.md +++ b/bundles/org.openhab.binding.icloud/README.md @@ -68,7 +68,7 @@ Bridge icloud:account:myaccount [appleId="mail@example.com", password="secure", } ``` -The device ID can be found in the Paper UI inbox. +The device ID can be found in the Inbox after it has been discovered. The information *@ "World"* is optional. ### icloud.items diff --git a/bundles/org.openhab.binding.innogysmarthome/README.md b/bundles/org.openhab.binding.innogysmarthome/README.md index 99abded6437..0869850a580 100644 --- a/bundles/org.openhab.binding.innogysmarthome/README.md +++ b/bundles/org.openhab.binding.innogysmarthome/README.md @@ -105,7 +105,7 @@ When `invert` is `true` than `0` on innogy is `UP` and `100` is `DOWN`. ### Configuring the SmartHome Controller (SHC) -The SmartHome Controller (SHC) can be configured in the Paper UI as follows: +The SmartHome Controller (SHC) can be configured in the UI as follows: After the "innogy SmartHome Controller" is added via the Inbox, edit the controller and add the "Authorization code" by following the hints in the description. Save your changes. @@ -116,7 +116,7 @@ Be sure it is connected to the Internet. Authorization is done as oauth2 workflow with the innogy API. -To receive the auth-code, go to one of the following URLs depending on your brand and login with your credentials (you can find this link also in the SHC thing in Paper UI, if you edit it): +To receive the auth-code, go to one of the following URLs depending on your brand and login with your credentials (you can find this link also in the SHC thing in the UI, if you edit it): https://auth.services-smarthome.de/AUTH * [innogy SmartHome authorization page](https://auth.services-smarthome.de/AUTH/authorize?response_type=code&client_id=24635748&redirect_uri=https%3A%2F%2Fwww.openhab.org%2Foauth%2Finnogy%2Finnogy-smarthome.html&scope&lang=de-DE) * [SmartHome Austria authorization page](https://auth.services-smarthome.de/AUTH/authorize?response_type=code&client_id=24635749&redirect_uri=https%3A%2F%2Fwww.openhab.org%2Foauth%2Finnogy%2Fsmarthome-austria.html&scope&lang=de-DE) @@ -138,9 +138,9 @@ All devices bound to the bridge are found by the discovery service once the SHC As device discovery is not implemented as a background service, you should start it manually in the Inbox to find all devices. Now you can add all devices from your Inbox as things. -### Manual configuration +### File based configuration -As an alternative to the automatic discovery process and graphical configuration using Paper UI, innogy things can be configured manually. +As an alternative to using automatic discovery, innogy things can be configured using .things files. The innogy SmartHome Controller (SHC) can be configured using the following syntax: ``` @@ -163,7 +163,7 @@ All other innogy devices can be added using the following syntax: Thing WDS "" @ "" [ id="" ] ``` -The device ID (e.g. e9a74941a3807b57332214f346fb1129) can be found in the Paper UI inbox, as you find it below all things there in the form `innogysmarthome:::` (example: `innogysmarthome:WSC2:SMARTHOME01:e9a74941a3807b57332214f346fb1129`). +The device ID (e.g. e9a74941a3807b57332214f346fb1129) can be found in the Inbox, as you find it below all things there in the form `innogysmarthome:::` (example: `innogysmarthome:WSC2:SMARTHOME01:e9a74941a3807b57332214f346fb1129`). However, a full example .things configuration look like this: @@ -227,7 +227,7 @@ end ## Resolving certificate issues -If the bridge stays offline with the following status shown in the Paper UI, the reason could be an expired certificate: +If the bridge stays offline with the following status shown in the UI, the reason could be an expired certificate: `OFFLINE - COMMUNICATION_ERROR sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target` diff --git a/bundles/org.openhab.binding.km200/README.md b/bundles/org.openhab.binding.km200/README.md index 7ccb8bed0f6..68c332cc991 100644 --- a/bundles/org.openhab.binding.km200/README.md +++ b/bundles/org.openhab.binding.km200/README.md @@ -9,19 +9,19 @@ It is possible to receive and send parameters like string or float values. This binding supports 11 different things types -| Thing | Paper UI Only | Description | -| ---------------- | ------------- |---------------------------------------------------------- | -| `appliance` | | The appliance (The heater inside of this heating system). | -| `dhwCircuit` | | A hot water circuit. | -| `gateway` | | The gateway. (The connected KM200/100/50 device). | -| `heatingCircuit` | | A heating circuit. | -| `heatSource` | | The heat source. | -| `holidayMode` | | The holiday modes configuration. | -| `sensor` | | The sensors. | -| `solarCircuit` | | A solar circuit. | -| `system` | | The system without sensors and appliance. | -| `notification` | | The notifications. | -| `switchProgram` | X | A switch program. | +| Thing | UI Only | Description | +|------------------|:-------:|-----------------------------------------------------------| +| `appliance` | | The appliance (The heater inside of this heating system). | +| `dhwCircuit` | | A hot water circuit. | +| `gateway` | | The gateway. (The connected KM200/100/50 device). | +| `heatingCircuit` | | A heating circuit. | +| `heatSource` | | The heat source. | +| `holidayMode` | | The holiday modes configuration. | +| `sensor` | | The sensors. | +| `solarCircuit` | | A solar circuit. | +| `system` | | The system without sensors and appliance. | +| `notification` | | The notifications. | +| `switchProgram` | X | A switch program. | ### KM 50/100/200 @@ -47,9 +47,9 @@ The *kmdevice* bridge requires the following configuration parameters: ### Channels -This binding creates the channels depending on the connected heating system fully automatically. -These channels depend on the connected heating system. -You can see the complete list of supported channels of the thing in the Paper UI. +This binding creates the channels depending on the connected heating system fully automatically. +These channels depend on the connected heating system. +You can see the complete list of supported channels of the thing in the UI. There is no official documentation for the parameters available from Buderus, so the names of the channels is all that reflects their purpose. ## Full Examples diff --git a/bundles/org.openhab.binding.lametrictime/README.md b/bundles/org.openhab.binding.lametrictime/README.md index 53f58ecaef2..c05bea7a2bb 100644 --- a/bundles/org.openhab.binding.lametrictime/README.md +++ b/bundles/org.openhab.binding.lametrictime/README.md @@ -125,7 +125,7 @@ They exist as one-way communication only. ## How Tos The following configuration examples assume the device was added with the thing id `lametrictime:device:demo`. -Replace the thing id in all the configurations with your real thing id which can be looked up via Paper UI. +Replace the thing id in all the configurations with your real thing id which can be looked up the UI. ### Notifications diff --git a/bundles/org.openhab.binding.lgtvserial/README.md b/bundles/org.openhab.binding.lgtvserial/README.md index 9e356fb738a..d26e82c9408 100644 --- a/bundles/org.openhab.binding.lgtvserial/README.md +++ b/bundles/org.openhab.binding.lgtvserial/README.md @@ -23,7 +23,6 @@ Tested and developed with : ## Discovery No discovery supported, manual configuration is required. -The things may be configured through the Paper UI. ## Thing Configuration diff --git a/bundles/org.openhab.binding.loxone/README.md b/bundles/org.openhab.binding.loxone/README.md index 37ab59094e6..d651859d5b6 100644 --- a/bundles/org.openhab.binding.loxone/README.md +++ b/bundles/org.openhab.binding.loxone/README.md @@ -189,7 +189,7 @@ Channels have the default tags as follows: ## Advanced Parameters -This section describes the optional advanced parameters that can be configured for a Miniserver. They can be set using UI (e.g. Paper UI) or in a .things file. +This section describes the optional advanced parameters that can be configured for a Miniserver. If a parameter is not explicitly defined, binding will use its default value. To define a parameter value in a .things file, please refer to it by parameter's ID, for example: diff --git a/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/bridge.xml b/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/bridge.xml index 83f75b364dc..e0924f09f57 100644 --- a/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/bridge.xml +++ b/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/bridge.xml @@ -31,7 +31,7 @@ Device parameter settings true - + @@ -90,7 +90,7 @@ true - + Resets the MAX! Cube room and device information. Devices will @@ -102,7 +102,7 @@ -1 true - + Restarts the Cube. diff --git a/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/thing-types.xml index 9de8c50ace7..fc602df4c94 100644 --- a/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.max/src/main/resources/OH-INF/thing/thing-types.xml @@ -109,7 +109,7 @@ 0 true - + Deletes the device from the MAX! Cube. Device will need to be @@ -231,7 +231,7 @@ 0 true - + Deletes the device from the MAX! Cube. Device will need to be @@ -297,7 +297,7 @@ The RF Address used for communication between the devices. - + Deletes the device from the MAX! Cube. Device will need to be @@ -402,7 +402,7 @@ The RF Address used for communication between the devices. - + Deletes the device from the MAX! Cube. Device will need to be diff --git a/bundles/org.openhab.binding.mihome/README.md b/bundles/org.openhab.binding.mihome/README.md index 4e0a574d8fe..25d10a7cb56 100644 --- a/bundles/org.openhab.binding.mihome/README.md +++ b/bundles/org.openhab.binding.mihome/README.md @@ -102,7 +102,7 @@ __Hints:__ ## Removing devices from the gateway -If you remove a Thing in PaperUI it will also trigger the gateway to unpair the device. +If you remove a Thing it will also trigger the gateway to unpair the device. It will only reappear in your Inbox, if you connect it to the gateway again. Just follow the instructions in ["Connecting devices to the gateway"](#connecting-devices-to-the-gateway). diff --git a/bundles/org.openhab.binding.onewire/README.md b/bundles/org.openhab.binding.onewire/README.md index 89cbfea1ecb..3b092ee5c14 100644 --- a/bundles/org.openhab.binding.onewire/README.md +++ b/bundles/org.openhab.binding.onewire/README.md @@ -23,11 +23,11 @@ There are different types of things: the simple one (`basic`), multisensors buil ## Discovery -Discovery is supported for things. You have to add the bridges manually. +Discovery is supported for things. You have to add the bridges manually. ## Thing Configuration -It is strongly recommended to use discovery and Paper UI for thing configuration. +It is strongly recommended to add things using discovery and configure them using the UI. Please note that: * All things need a bridge. @@ -46,7 +46,7 @@ The `address` parameter is used to denote the location of the owserver instance. It supports both, a hostname or an IP address. The `port` parameter is used to adjust non-standard OWFS installations. -It defaults to `4304`, which is the default of each OWFS installation. +It defaults to `4304`, which is the default of each OWFS installation. Bridges of type `owserver` are extensible with channels of type `owfs-number` and `owfs-string`. diff --git a/bundles/org.openhab.binding.robonect/README.md b/bundles/org.openhab.binding.robonect/README.md index c3146abc478..4267ae985d0 100644 --- a/bundles/org.openhab.binding.robonect/README.md +++ b/bundles/org.openhab.binding.robonect/README.md @@ -1,15 +1,13 @@ # Robonect Binding -Robonect is a piece of hardware which has to be put into your Husqvarna, Gardena and other branded automower and makes -it accessible in your internal network. +Robonect is a piece of hardware which has to be put into your Husqvarna, Gardena and other branded automower and makes it accessible in your internal network. More details about the Robonect module can be found at [robonect.de](https://forum.robonect.de/) -This binding integrates mowers having the robonect module installed as a thing into the home automation solution, allowing to -control the mower and react on mower status changes in rules. +This binding integrates mowers having the robonect module installed as a thing into the home automation solution, allowing to control the mower and react on mower status changes in rules. ## Supported Things -The binding exposes just one Thing type which is the `mower`. +The binding supports one Thing type which is the `mower`. Tested mowers @@ -23,11 +21,11 @@ Tested mowers ## Discovery -Robonect does not support automatic discovery. So the thing has to be added manually either via Paper UI or things configuration. +Automatic discovery is not supported. ## Thing Configuration -following configuration settings are supported for the `mower` thing. +The following configuration settings are supported for the `mower` thing. | parameter name | mandatory | description | |----------------|-----------|---------------------------------------------------------------------------------------------------| @@ -39,7 +37,7 @@ following configuration settings are supported for the `mower` thing. | timezone | no | the timezone as configured in Robonect on the robot (default: Europe/Berlin) | -An example things configuration might look like +An example things configuration might look like: ```java Thing robonect:mower:automower "Mower" @ "Garden" [ host="192.168.2.1", pollInterval="5", user="gardener", password = "cutter"] @@ -71,7 +69,7 @@ Thing robonect:mower:automower "Mower" @ "Garden" [ host="192.168.2.1", pollInte ### Offline Trigger Channel -This channel s triggered if the mower is longer than the configured `offlineTriggerTimeout` offline. +This channel s triggered if the mower is longer than the configured `offlineTriggerTimeout` offline. This may indicate that the mower may stuck somewhere in error state but does not have a signal. ## Full Example diff --git a/bundles/org.openhab.binding.squeezebox/README.md b/bundles/org.openhab.binding.squeezebox/README.md index 5f9da040347..147c88c9e5e 100644 --- a/bundles/org.openhab.binding.squeezebox/README.md +++ b/bundles/org.openhab.binding.squeezebox/README.md @@ -123,7 +123,7 @@ All devices support some of the following channels: ## Example .Items File -Add the items you want to the .items file. A few examples are shown below, the power, volume and album art channels are connected here to the items by copying across the channel discriptions from the Paper UI. Make suure each channel is linked for your needs See [openHAB New User Configuration documentation](https://www.openhab.org/docs/tutorial/configuration.html) for further details on linking and channels. +Add the items you want to use to an .items file, for example: ``` Switch YourPlayer_Power "Squeezebox Power" {channel="squeezebox:squeezeboxplayer:736549a3:00042016e7a0:power"} diff --git a/bundles/org.openhab.binding.surepetcare/README.md b/bundles/org.openhab.binding.surepetcare/README.md index 4a6e85a103f..04e93b1a998 100644 --- a/bundles/org.openhab.binding.surepetcare/README.md +++ b/bundles/org.openhab.binding.surepetcare/README.md @@ -39,9 +39,11 @@ This binding supports the following thing types The binding consists of a Bridge (the API connection), and a number of Things, which relates to the individual hardware devices and pets. Sure Petcare things can be configured either through the online configuration utility via discovery, or manually through a 'surepetcare.things' configuration file. -The Bridge will not be autodiscovered and must be added manually. This can be done via bridge thing configuration file or via PaperUI. That is because the Sure Petcare API requires authentication credentials to communicate with the service. +The Bridge is not automatically discovered and must be added manually. +That is because the Sure Petcare API requires authentication credentials to communicate with the service. -After adding the Bridge, it will go ONLINE, and after a short while, the discovery process for household, devices and pets will start. When new hardware is discovered it will appear in the Inbox. +After adding the Bridge, it will go ONLINE, and after a short while, the discovery process for household, devices and pets will start. +When new hardware is discovered it will appear in the Inbox. ## Things and their channels @@ -150,8 +152,6 @@ Channel names in **bold** are read/write, everything else is read-only ### Things configuration -If you use the label parameter (after the @ sign) you then have these things grouped in single tabs on PaperUI Control. - ``` Bridge surepetcare:bridge:bridge1 "Demo API Bridge" @ "SurePetcare" [ username="", password="", refreshIntervalTopology=36000, refreshIntervalStatus=300 ] { @@ -357,7 +357,9 @@ sitemap surepetcare label="My home automation" { ### Using Group Items -You can also set pet locations with a group item. Please Note: the location for each pet gets updated only if the current location is not already the location you want to set. This can be very useful if you have alot of pets that often enter the home by any window/door. +You can also set pet locations with a group item. +Please Note: the location for each pet gets updated only if the current location is not already the location you want to set. +This can be very useful if you have alot of pets that often enter the home by any window/door. Your .items file should contain this: ``` diff --git a/bundles/org.openhab.binding.yamahareceiver/README.md b/bundles/org.openhab.binding.yamahareceiver/README.md index 891ee8397ad..d72e9834e7a 100644 --- a/bundles/org.openhab.binding.yamahareceiver/README.md +++ b/bundles/org.openhab.binding.yamahareceiver/README.md @@ -6,15 +6,17 @@ If your hardware is on the list but still does not work, please fill a bug repor ## Supported Things -Thing | Type | Description ---------|------|------ -yamahaAV | Bridge | Yamaha Receiver hardware -zone | Thing | Zones of your receiver +| Thing | Type | Description | +|----------|--------|--------------------------| +| yamahaAV | Bridge | Yamaha Receiver hardware | +| zone | Thing | Zones of your receiver | ## Discovery -Just use the auto discovery feature to detect your hardware. Initially a thing for the main zone will be created. This will trigger a zone detection internally and all available additional zones will appear as new things. +Just use the auto discovery feature to detect your hardware. +Initially a thing for the main zone will be created. +This will trigger a zone detection internally and all available additional zones will appear as new things. ## Thing Configuration @@ -32,22 +34,22 @@ Bridge yamahareceiver:yamahaAV:ReceiverID "Yamaha Receiver Bridge Name" [host="a Configuration parameters for Bridge `yamahaAV`: -Parameter | Required | Default | Description ---------|------|------|------ -`host` | yes | N/A | The IP address of the AVR to control -`port` | no | 80 | The API port of the AVR to control -`refreshInterval` | no | 60 | Refresh interval in seconds -`albumUrl` | no | embedded image URL | When the album image is not provided by the Yamaha input source, you can specify the default image URL to apply -`inputMapping` | no | "" (empty string) | Some Yamaha models return different input values on status update than required in the change input commands. See [below](#input-values) for details +| Parameter | Required | Default | Description | +|-------------------|----------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| `host` | yes | N/A | The IP address of the AVR to control | +| `port` | no | 80 | The API port of the AVR to control | +| `refreshInterval` | no | 60 | Refresh interval in seconds | +| `albumUrl` | no | embedded image URL | When the album image is not provided by the Yamaha input source, you can specify the default image URL to apply | +| `inputMapping` | no | "" (empty string) | Some Yamaha models return different input values on status update than required in the change input commands. See [below](#input-values) for details | Configruation parameters for Thing `zone`: -Parameter | Required | Default | Description ---------|------|------|------ -`zone` | yes | / | The zone can be Main_Zone, Zone_2, Zone_3, Zone_4 depending on your device -`volumeRelativeChangeFactor` | no | 2 | Relative volume change in percent -`volumeDbMin` | no | -80 | Lowest volume in dB -`volumeDbMax` | no | 12 | Highest volume in dB +| Parameter | Required | Default | Description | +|------------------------------|----------|---------|----------------------------------------------------------------------------| +| `zone` | yes | / | The zone can be Main_Zone, Zone_2, Zone_3, Zone_4 depending on your device | +| `volumeRelativeChangeFactor` | no | 2 | Relative volume change in percent | +| `volumeDbMin` | no | -80 | Lowest volume in dB | +| `volumeDbMax` | no | 12 | Highest volume in dB | ## Channels @@ -101,9 +103,9 @@ Navigation is not supported by Spotify input. ### Basic Setup -##### For auto linking with Paper UI +##### Auto Linking -Link the items to the channels of your preferred zone (here `Main_Zone`) in Paper UI after you have saved your items file. +Link the items to the channels of your preferred zone (here `Main_Zone`) in the UI after you have saved your items file. Items: @@ -117,7 +119,7 @@ String Yamaha_Scene "Scene []"