diff --git a/bundles/org.openhab.binding.oceanic/README.md b/bundles/org.openhab.binding.oceanic/README.md index c47a2f3717265..a72ade98e0748 100644 --- a/bundles/org.openhab.binding.oceanic/README.md +++ b/bundles/org.openhab.binding.oceanic/README.md @@ -1,18 +1,18 @@ # Oceanic Binding -This binding integrates the Oceanic water softener and management system (, but also distributed by Syr in Germany ()). -The binding supports the Limex IQ and Limex Pro water softeners and require the optional CAN-Serial gateway has to be installed +This binding integrates the Oceanic water softener and management system (, also distributed by Syr in Germany at ). +The binding supports the Limex IQ and Limex Pro water softeners and requires the optional CAN-Serial gateway to be installed. ## Supported Things - **serial** - A water softener connected to the openHAB host by means of a serial port -- **network** - A water softener that can be reached through a TCP proxy. See Known Issues below as when to use this kind of configuration +- **network** - A water softener that can be reached through a TCP proxy. See Known Issues below for when to use this configuration. ## Thing Configuration -The **serial** Thing configuration requires the name of the serial port that is used to connect openHAB with the Oceanic unit, and the interval period in seconds to poll the Oceanic unit +The **serial** Thing configuration requires the name of the serial port used to connect openHAB with the Oceanic unit, and the interval period in seconds to poll the Oceanic unit. -The **network** Thing configuration requires the hostname or ip address of the proxy, the TCP port number to connect to, and the interval period in seconds to poll the Oceanic unit +The **network** Thing configuration requires the hostname or IP address of the proxy, the TCP port number to connect to, and the interval period in seconds to poll the Oceanic unit. ## Channels @@ -88,7 +88,7 @@ The Oceanic binding makes use of the nrjavaserial library, and unfortunately jav Although some work is being done to improve things (), the best thing is to avoid serial ports as much as possible, as some issues () are not resolved. -For example, On Ubuntu 17.10 nrjavaserial seems to return only HEX 00 characters through the InputStream of the SerialPort. +For example, on Ubuntu 17.10 nrjavaserial seems to return only HEX 00 characters through the InputStream of the SerialPort. Within the Oceanic binding two routes are provided: @@ -98,7 +98,7 @@ Within the Oceanic binding two routes are provided: /usr/bin/socat -v TCP-LISTEN:9000 /dev/ttyUSB0,raw,echo=0 ``` - In the above example, the name of the host running socat, and the TCP port number 9000, will be part of the **network** Thing configuration + In the above example, the name of the host running socat and the TCP port number 9000 will be part of the **network** Thing configuration. 1. Connect to the Oceanic softener over a serial port on the openHAB host and use `socat` to pipe the data from that serial port to a pseudo tty, which has to be manipulated in a CommPortIdentifier.PORT_RAW manner. ```shell @@ -120,7 +120,7 @@ Restart=always RestartSec=10 ``` -However, in order to fix permissions at the OS level, one has to issue following commands in order to make /dev/ttyS1 accessible by the 'openhab' system user (that is used to start up the openHAB runtime), and to make the tty both readable and writable. +However, to fix permissions at the OS level, issue the following commands to make /dev/ttyS1 accessible by the 'openhab' system user (used to start the openHAB runtime), and to make the tty both readable and writable. ```shell sudo useradd -G dialout openhab diff --git a/bundles/org.openhab.binding.omnikinverter/README.md b/bundles/org.openhab.binding.omnikinverter/README.md index 0d06b761570e2..58a602b6bed86 100644 --- a/bundles/org.openhab.binding.omnikinverter/README.md +++ b/bundles/org.openhab.binding.omnikinverter/README.md @@ -9,7 +9,7 @@ moment of writing the _Omniksol-3.0k-TL2_ has been tested. ## Discovery -No autodiscovery available +No auto-discovery available ## Thing Configuration @@ -34,9 +34,9 @@ No autodiscovery available | currentAC1 | Number:ElectricCurrent | The current for feed 1 to the grid, in ampere by default | | currentAC2 | Number:ElectricCurrent | The current for feed 2 to the grid, in ampere by default | | currentAC3 | Number:ElectricCurrent | The current for feed 3 to the grid, in ampere by default | -| frequencyAC1 | Number:Frequency | The frequrence of feed 1 of the grid, in hertz by default | -| frequencyAC2 | Number:Frequency | The frequrence of feed 2 of the grid, in hertz by default | -| frequencyAC3 | Number:Frequency | The frequrence of feed 3 of the grid, in hertz by default | +| frequencyAC1 | Number:Frequency | The frequency of feed 1 of the grid, in hertz by default | +| frequencyAC2 | Number:Frequency | The frequency of feed 2 of the grid, in hertz by default | +| frequencyAC3 | Number:Frequency | The frequency of feed 3 of the grid, in hertz by default | | currentPV1 | Number:ElectricCurrent | The current generation for input string 1, in ampere by default | | currentPV2 | Number:ElectricCurrent | The current generation for input string 2, in ampere by default | | currentPV3 | Number:ElectricCurrent | The current generation for input string 3, in ampere by default | diff --git a/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/i18n/omnikinverter.properties b/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/i18n/omnikinverter.properties index fb639c1281e62..a433f482bb4e0 100644 --- a/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/i18n/omnikinverter.properties +++ b/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/i18n/omnikinverter.properties @@ -53,7 +53,7 @@ thing-type.config.omnikinverter.omnik.port.description = The TCP port of the Omn thing-type.config.omnikinverter.omnik.refreshInterval.label = Refresh Interval thing-type.config.omnikinverter.omnik.refreshInterval.description = Interval the device is polled in seconds. thing-type.config.omnikinverter.omnik.serial.label = Serial -thing-type.config.omnikinverter.omnik.serial.description = The serial of the Omnik inverter's Wifi module. This the number part only. +thing-type.config.omnikinverter.omnik.serial.description = The serial of the Omnik inverter's Wi‑Fi module. This is the number part only. # channel types diff --git a/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/thing/thing-types.xml index 9486a7a2372e9..ef87427ec8d24 100644 --- a/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.omnikinverter/src/main/resources/OH-INF/thing/thing-types.xml @@ -102,7 +102,7 @@ - The serial of the Omnik inverter's Wifi module. This the number part only. + The serial of the Omnik inverter's Wi‑Fi module. This is the number part only. @@ -202,18 +202,12 @@ Measurement Temperature - - - - Number:Time - - The total amount of running hours - + Number:Time The total amount of running hours - + diff --git a/bundles/org.openhab.binding.omnilink/README.md b/bundles/org.openhab.binding.omnilink/README.md index 79e72f87d2a91..640d2831f381a 100644 --- a/bundles/org.openhab.binding.omnilink/README.md +++ b/bundles/org.openhab.binding.omnilink/README.md @@ -147,7 +147,7 @@ The devices support some of the following trigger channels: ## Rule Actions This binding includes a rule action, which allows synchronizing the controller time to match the openHAB system time with a user specified zone. -There is a separate instance for each contoller, which can be retrieved through: +There is a separate instance for each controller, which can be retrieved through: :::: tabs diff --git a/bundles/org.openhab.binding.ondilo/README.md b/bundles/org.openhab.binding.ondilo/README.md index 275ef2ff8457e..33f51fecfd980 100644 --- a/bundles/org.openhab.binding.ondilo/README.md +++ b/bundles/org.openhab.binding.ondilo/README.md @@ -8,7 +8,7 @@ This binding integrates Ondilo ICO pool monitoring devices with openHAB, allowin - `ondilo:` Represents an individual Ondilo ICO device Ondilo ICO Pool as well as Spa devices are supported. -Chlor as well as salt water. +Chlorine as well as salt water. ## Discovery @@ -24,7 +24,7 @@ Each Ondilo ICO will appear as a new Thing in the inbox. ### `ondilo` Thing Configuration -- **id**: The Id of an Ondilo ICO device. Set via discovery service (e.g. `12345`) +- **id**: The ID of an Ondilo ICO device. Set via discovery service (e.g. `12345`) Ondilo ICO takes measures every hour. Higher polling will not increase the update interval. @@ -37,7 +37,7 @@ The requests to the Ondilo Customer API are limited to the following per user qu Example using default interval: -- `account` Thing performs 2 request per cycle - 8 requests per hour per Ondilo Account +- `account` Thing performs 2 requests per cycle - 8 requests per hour per Ondilo Account - `ondilo` Thing performs 4 requests per cycle - 16 requests per hour per Ondilo ICO ## Channels @@ -63,7 +63,7 @@ Example using default interval: | tds | Number:Density | false | R | Total dissolved solids in the pool (chlor pools only) | | tds-trend | Number:Density | true | R | Change in TDS since last measure | | battery | Number:Dimensionless | false | R | Battery level of the device | -| rssi | Number:Dimensionless | false | R | Signal strength (RSSI) | +| rssi | Number | false | R | Signal strength (RSSI) | | value-time | DateTime | true | R | Timestamp of the set of measures | ### Recommendations Channels diff --git a/bundles/org.openhab.binding.ondilo/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.ondilo/src/main/resources/OH-INF/thing/thing-types.xml index 55001aef3f913..6a8196caca610 100644 --- a/bundles/org.openhab.binding.ondilo/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.ondilo/src/main/resources/OH-INF/thing/thing-types.xml @@ -22,7 +22,7 @@ http://localhost:8080 - The URL of the openHAB instance. Required for the redirect during oAuth2 flow + The URL of the openHAB instance. Required for the redirect during OAuth2 flow network-address @@ -112,8 +112,8 @@ - - Maximum PH level + + Maximum pH level @@ -166,8 +166,8 @@ Number - - PH level + + pH level Measurement @@ -175,8 +175,8 @@ Number - - Change in PH level since last measure + + Change in pH level since last measure Measurement @@ -345,8 +345,8 @@ Number - - Minimum PH level + + Minimum pH level Setpoint diff --git a/bundles/org.openhab.binding.onebusaway/README.md b/bundles/org.openhab.binding.onebusaway/README.md index fb40eb7ddbcb4..ab2695bee438a 100644 --- a/bundles/org.openhab.binding.onebusaway/README.md +++ b/bundles/org.openhab.binding.onebusaway/README.md @@ -1,6 +1,6 @@ # OneBusAway Binding -[OneBusAway](https://onebusaway.org/) is an open source, real-time, transit-information service. This binding allows you to get events based on transit arrival and departures, so you can create rules to do something based on that data. +[OneBusAway](https://onebusaway.org/) is an open source, real-time, transit-information service. This binding lets you get events based on transit arrivals and departures, so you can create rules to do something based on that data. ## Preparation @@ -37,18 +37,18 @@ The following configuration options are available for a Route (which requires a ## Channels -The Route Thing supports the following state channels: +The Route Thing supports the following channels: | Channel Type ID | Channel Kind | Item Type | Description | |------------------|--------------|-----------|----------------------------------------------------------------------------------------------------------| | arrival | state | DateTime | The arrival time of a Route at a Stop. | | departure | state | DateTime | The departure time of a Route at a Stop. | | update | state | DateTime | The last time this data was updated (per the data provider, not the last time openHAB updated the data). | -| arrivalDeparture | trigger | DateTime | Triggered when a Route arrives or departs a Stop. | +| routeEvent | trigger | — | Triggered when a Route arrives or departs a Stop (event values: `ARRIVAL`, `DEPARTURE`). | ### Channel Configurations -The `arrival`, `departure`, and `arrivalDeparture` channels can be configured with an `offset` specifying the number of seconds to move an event back in time. +The `arrival`, `departure`, and `routeEvent` channels can be configured with an `offset` specifying the number of seconds to move an event back in time. ## Full Example diff --git a/bundles/org.openhab.binding.onewire/README.md b/bundles/org.openhab.binding.onewire/README.md index e8e4b94e26cd5..6831d3a111200 100644 --- a/bundles/org.openhab.binding.onewire/README.md +++ b/bundles/org.openhab.binding.onewire/README.md @@ -61,10 +61,10 @@ Depending on the chip, either `present`, `temperature`, `digitalX` or `counterX` ### Multisensor (`ms-tx`) -The multisensor is build around the DS2438 or DS1923 chipset. +The multisensor is built around the DS2438 or DS1923 chipset. It always provides a `temperature` channel. -Depnding on the actual sensor, additional channels (`current`, `humidity`, `light`, `voltage`, `supplyvoltage`) are added. +Depending on the actual sensor, additional channels (`current`, `humidity`, `light`, `voltage`, `supplyvoltage`) are added. If the voltage input of the DS2438 is connected to a humidity sensor, several common types are supported (see below). It has three parameters: sensor id `id`, refresh time `refresh` and `manualsensor` (advanced option). @@ -115,7 +115,7 @@ Additional channels (`light`, `pressure`, `humidity`, `dewpoint`, `abshumidity`) Currently this thing only supports BAE0910 sensors. All functional pins of this sensor have multiple functions which can be configured individually. For detailed information of each mode, please see the official documentation. -Each pin has the can be configured as `disabled`. +Each pin can be configured as `disabled`. The necessary channels are automatically added. Pin 1 (`pin1`) has only one function `counter` (channel `counter`). @@ -186,13 +186,13 @@ It defaults to 300s. ### Temperature (`temperature`, `temperature-por`, `temperature-por-res`) -There are three temperature channel types: `temperature`, `temperature-por`and `temperature-por-res`. +There are three temperature channel types: `temperature`, `temperature-por` and `temperature-por-res`. The correct channel-type is selected automatically by the thing handler depending on the sensor type. If the channel-type is `temperature`, there is nothing else to configure. Some sensors (e.g. DS18x20) report 85 °C as Power-On-Reset value. -In some installations this leads to errorneous temperature readings. +In some installations this leads to erroneous temperature readings. If the `ignorepor` parameter is set to `true` 85 °C values will be filtered. The default is `false` as correct reading of 85 °C will otherwise be filtered, too. Please note that the parameter value must not be set in quotation marks (see example below). @@ -221,7 +221,7 @@ The duty cycle can be set from 0-100%. ### BAE PIO (`bae-pio`) The PIO channel (programmable I/O channel) has two configuration options: `mode` and `pulldevice`. -The `mode`can be set to `input`or `output`. +The `mode` can be set to `input` or `output`. The default is `input`. The `pulldevice` is only relevant for `input` mode. diff --git a/bundles/org.openhab.binding.onewiregpio/README.md b/bundles/org.openhab.binding.onewiregpio/README.md index 5fd0484b629b4..32b67215598c1 100644 --- a/bundles/org.openhab.binding.onewiregpio/README.md +++ b/bundles/org.openhab.binding.onewiregpio/README.md @@ -1,6 +1,6 @@ # OneWire GPIO Binding -This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry Pi. +This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on a Raspberry Pi. ## Supported Things @@ -9,18 +9,16 @@ Tested successfully with DS18B20 sensor on Raspberry Pi 3. ## Binding Configuration -The binding requires OneWire sensor to be properly connected to Raspberry Pi GPIO bus, -"w1_gpio" and "wire" kernel modules should be loaded. -Configuration is proper when /sys/bus/w1/devices folder is present, and contains sensor's data. +The binding requires a OneWire sensor properly connected to the Raspberry Pi GPIO bus; the "w1_gpio" and "wire" kernel modules must be loaded. +Configuration is correct when the `/sys/bus/w1/devices` folder is present and contains the sensor's data. ## Thing Configuration The sensors are visible in the system as folders containing files with sensor data. -By default all OneWire GPIO devices are stored in /sys/bus/w1/devices/DEVICE_ID_FOLDER, -and the temperature value is available in the file "w1_slave". The Thing needs full path to the w1_slave file. +By default, all OneWire GPIO devices are stored in `/sys/bus/w1/devices/DEVICE_ID_FOLDER`, and the temperature value is available in the file `w1_slave`. The Thing needs the full path to the `w1_slave` file. Note the values in sysfs are in Celsius. -Optional parameter precision makes it easier to lower precision of the sensor value, i.e. precision 1 makes sensor value to show only one digit after the floating point, precision 2 - shows 2 digits. It makes precision reduction with round up, i.e. 20.534C with precision 1 will be 20.5C, 20.555 with same precision will be 20.6C. Allowed values are from 0 to 3. Default value of parameter is 3(max precision). +The optional `precision` parameter lets you lower the precision of the sensor value, e.g., precision `1` shows one digit after the decimal point, precision `2` shows two digits. Rounding is applied (e.g., 20.534 °C with precision 1 becomes 20.5 °C; 20.555 °C with the same precision becomes 20.6 °C). Allowed values are from 0 to 3. The default is 3 (maximum precision). In the thing file, this looks e.g. like @@ -30,7 +28,7 @@ Thing onewiregpio:sensor:livingRoom "Living room" [gpio_bus_file="/sys/bus/w1/de ## Channels -The devices supports currently one channel - "temperature" which allows to read temperature from OneWire temperature sensor. +The device currently supports one channel, "temperature", which reads the temperature from the OneWire sensor. ## Full Example @@ -42,7 +40,7 @@ Thing onewiregpio:sensor:livingroom "Living room" [gpio_bus_file="/sys/bus/w1/de sample onewiregpio.items file content (implements QuantityType for unit conversion): -``` java +```java Number:Temperature LivingRoomTemperature "Temperature: [%.2f %unit%]" { channel="onewiregpio:sensor:livingroom:temperature" } ``` diff --git a/bundles/org.openhab.binding.onkyo/README.md b/bundles/org.openhab.binding.onkyo/README.md index f0c724da5970b..f7acdc4906b35 100644 --- a/bundles/org.openhab.binding.onkyo/README.md +++ b/bundles/org.openhab.binding.onkyo/README.md @@ -4,11 +4,11 @@ This binding integrates the Onkyo AV receivers. ## Introduction -Binding should be compatible with Onkyo AV receivers which support ISCP (Integra Serial Control Protocol) over Ethernet (eISCP). +The binding is compatible with Onkyo AV receivers that support ISCP (Integra Serial Control Protocol) over Ethernet (eISCP). ## Supported Things -This binding supports only one thing: The Onkyo AV receiver. +This binding supports only one thing: the Onkyo AV receiver. All supported Onkyo devices are registered as an audio sink in the framework. ## Discovery @@ -75,10 +75,10 @@ Sometimes it is necessary to use the Callback URL to override the default, such ## Thing Configuration -The Onkyo AVR thing requires the ip address and the port to access it on. -In the code `avr-livingroom` refers to the user defined unique id of your Onkyo device. +The Onkyo AVR Thing requires the IP address and the port to access it. +In the code, `avr-livingroom` refers to the user-defined unique ID of your Onkyo device. A second device could be called avr2. -In the thing file, this looks e.g. like +In the thing file, this looks for example like Model specific @@ -94,25 +94,25 @@ Generic model onkyo:onkyoAVR:avr-livingroom [ipAddress="192.168.1.100", port=60128] ``` -Optionally you can specify the refresh interval by `refreshInterval` parameter. +Optionally, you can specify the refresh interval with the `refreshInterval` parameter. ```java onkyo:onkyoAVR:avr-livingroom [ipAddress="192.168.1.100", port=60128, refreshInterval=30] ``` -Maximum volume level can also be configured by `volumeLimit` parameter. -This prevent setting receiver volume level too high, which could damage your speakers or receiver. +The maximum volume level can also be configured with the `volumeLimit` parameter. +This prevents setting the receiver’s volume level too high, which could damage your speakers or receiver. ```java onkyo:onkyoAVR:avr-livingroom [ipAddress="192.168.1.100", port=60128, volumeLimit=50] ``` -Binding then automatically scale the volume level in both directions (100% = 50 = 100%). +The binding then automatically scales the volume level in both directions (100% = 50 = 100%). -You can also change the way volume scaling works. -This can be necessary if your receiver uses a different scaling system than 0-100. -You can specify a decimal number that acts as the coefficient for scaling. -See below for a few examples: +You can also change how volume scaling works. +This can be necessary if your receiver uses a scaling system different from 0–100. +You can specify a decimal number that acts as the scaling coefficient. +See a few examples below: | Value | Description | Value for 100% | | ----- | --------------------------------------------------- | -------------- | @@ -121,7 +121,7 @@ See below for a few examples: | 0.8 | For receivers that go from 0-80 | 80 | | 0.5 | For receivers that go from 0-50 | 50 | -Note that this is applied after the volume limiting took place. +Note that this is applied after volume limiting takes place. ```java onkyo:onkyoAVR:avr-livingroom [ipAddress="192.168.1.100", port=60128, volumeScale=2] @@ -131,7 +131,7 @@ The binding will send value 200 for maximum volume to the receiver. ## Channels -The Onkyo AVR supports the following channels (some channels are model specific): +The Onkyo AVR supports the following channels (some channels are model-specific): | Channel Type ID | Item Type | Description | | ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------- | @@ -147,13 +147,13 @@ The Onkyo AVR supports the following channels (some channels are model specific) | zone3#mute | Switch | Mute/unmute zone 3 | | zone3#input | Number | The input for zone 3 | | zone3#volume | Dimmer | Volume of zone 3 | -| player#control | Player | Control the Zone Player, e.g. play/pause/next/previous/ffward/rewind (available if playing from Network or USB) | +| player#control | Player | Control the Zone Player, e.g., play/pause/next/previous/fast-forward/rewind (available if playing from Network or USB) | | player#title | String | Title of the current song (available if playing from Network or USB) | | player#album | String | Album name of the current song (available if playing from Network or USB) | | player#artist | String | Artist name of the current song (available if playing from Network or USB) | | player#currentPlayingTime | String | Current playing time of the current song (available if playing from Network or USB) | | player#listenmode | Number | Current listening mode e.g. Stereo, 5.1ch Surround, ... | -| player#audysseyeq | Number | Current Audyseey EQ mode (e.g. OFF, Movie, Music) | +| player#audysseyeq | Number | Current Audyssey EQ mode (e.g., Off, Movie, Music) | | player#audioinfo | String | Current audio info (Refresh timer must be configured for updates) | | player#playuri | String | Plays the URI provided to the channel | | player#albumArt | Image | Image of the current album art of the current song | @@ -178,7 +178,7 @@ The Onkyo AVR supports the following channels (some channels are model specific) ## Rule Actions -This binding includes a rule action which allows to send raw eISCP messages to the receiver. +This binding includes a rule action that allows sending raw eISCP messages to the receiver. The rule action can be used to send commands to the receiver that are not supported by channels. There is a separate instance for each receiver, which can be retrieved through @@ -187,7 +187,7 @@ val onkyoActions = getActions("onkyo","onkyo:onkyoAVR:avr-livingroom") ``` where the first parameter always has to be `onkyo` and the second (`onkyo:onkyoAVR:avr-livingroom`) is the Thing UID of the broker that should be used. -Once this action instance is retrieved, you can invoke the `onkyoActions.sendRawCommand(String action, String value)` method on it: +Once this action instance is retrieved, you can invoke the `onkyoActions.sendRawCommand(String action, String value)` method: ```java onkyoActions.sendRawCommand("CTL", "UP") @@ -196,11 +196,11 @@ onkyoActions.sendRawCommand("CTL", "UP") This command for instance increases the volume for the center channel. For a description of all commands you can e.g. search [this GitHub project](https://github.com/miracle2k/onkyo-eiscp/tree/master/commands/main). -Also note that when sending multiple commands there has to be a `Thread::sleep(100)` in between the commands because the action does not wait for a response from the receiver. +When sending multiple commands, insert a short `Thread::sleep(100)` between them because the action does not wait for a response from the receiver. ## Input Source Mapping -Here after are the ID values of the input sources: +Here are the ID values of the input sources: - 00: DVR/VCR - 01: SATELLITE/CABLE @@ -243,10 +243,10 @@ Dimmer avrLrZ2_Volume "Volume [%s]" { channel="onkyo:onkyoAVR:avr- Player avrLrPlayer_Control "Control" { channel="onkyo:onkyoAVR:avr-livingroom:player#control" } String avrLrPlayer_Title "Title [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#title" } String avrLrPlayer_Album "Album [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#album" } -String avrLrPlayer_Artist "Artist [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#artist" } +String avrLrPlayer_Artist "Artist [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#artist" } String avrLrPlayer_CurrentPlayingTime "CurrentPlayingTime [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#currentPlayingTime" } Number avrLrPlayer_Listenmode "Listenmode [%d]" { channel="onkyo:onkyoAVR:avr-livingroom:player#listenmode" } -Number avrLrPlayer_AudysseyEQ "AudysseeyEQ [%d]" { channel="onkyo:onkyoAVR:avr-livingroom:player#audysseyeq" } +Number avrLrPlayer_AudysseyEQ "AudysseyEQ [%d]" { channel="onkyo:onkyoAVR:avr-livingroom:player#audysseyeq" } String avrLrPlayer_PlayURI "PlayURI [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#playuri" } Image avrLrPlayer_AlbumArt "AlbumArt [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#albumArt" } String avrLrPlayer_AlbumArtUrl "AlbumArtURL [%s]" { channel="onkyo:onkyoAVR:avr-livingroom:player#albumArtUrl" } @@ -304,7 +304,7 @@ sitemap demo label="Onkyo AVR" Frame label="NetMenu" { Text item=avrLrNet_Title - Selection item=avrLrNet_Control mappings=[ Up='Up', Down='Down', Select='Select', Back='Back', PageUp='PageUp', PageDown='PageDow', Select0='Select0', Select1='Select1', Select2='Select2', Select3='Select3', Select4='Select4', Select5='Select5', Select6='Select6', Select7='Select7', Select8='Select8', Select9='Select9' ] + Selection item=avrLrNet_Control mappings=[ Up='Up', Down='Down', Select='Select', Back='Back', PageUp='PageUp', PageDown='PageDown', Select0='Select0', Select1='Select1', Select2='Select2', Select3='Select3', Select4='Select4', Select5='Select5', Select6='Select6', Select7='Select7', Select8='Select8', Select9='Select9' ] Selection item=avrLrNet_Selection mappings=[ 0='Item0', 1='Item1', 2='Item2', 3='Item3', 4='Item4', 5='Item5', 6='Item6', 7='Item7', 8='Item8', 9='Item9' ] Text item=avrLrNet_Item0 Text item=avrLrNet_Item1 diff --git a/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/addon/addon.xml index b17cd2cbc924c..0eb5cdea42523 100644 --- a/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/addon/addon.xml @@ -11,7 +11,7 @@ - url to use for playing notification sounds, e.g. http://192.168.0.2:8080 + URL to use for playing notification sounds, e.g. http://192.168.0.2:8080 diff --git a/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/i18n/onkyo.properties b/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/i18n/onkyo.properties index 24323ce7de614..18badcb1dfd6d 100644 --- a/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/i18n/onkyo.properties +++ b/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/i18n/onkyo.properties @@ -6,7 +6,7 @@ addon.onkyo.description = This is the binding for Onkyo receivers. # add-on config addon.config.onkyo.callbackUrl.label = Callback URL -addon.config.onkyo.callbackUrl.description = url to use for playing notification sounds, e.g. http://192.168.0.2:8080 +addon.config.onkyo.callbackUrl.description = URL to use for playing notification sounds, e.g. http://192.168.0.2:8080 # thing types @@ -133,8 +133,8 @@ channel-type.onkyo.album.label = Album channel-type.onkyo.album.description = Album name of the current song channel-type.onkyo.albumArt.label = Album Art channel-type.onkyo.albumArt.description = Image of cover art of the current song -channel-type.onkyo.albumArtUrl.label = Album Art Url -channel-type.onkyo.albumArtUrl.description = Url to the image of cover art of the current song +channel-type.onkyo.albumArtUrl.label = Album Art URL +channel-type.onkyo.albumArtUrl.description = URL to the image of cover art of the current song channel-type.onkyo.artist.label = Artist channel-type.onkyo.artist.description = Artist name of the current song channel-type.onkyo.audioIn.label = Audio Input Info @@ -145,11 +145,11 @@ channel-type.onkyo.audioinfo.label = Audio Info channel-type.onkyo.audioinfo.description = Detailed audio info channel-type.onkyo.audysseyeq.label = Audyssey EQ Mode channel-type.onkyo.audysseyeq.description = Choose between Audyssey 2EQ/MultiEQ Equalizer curves -channel-type.onkyo.audysseyeq.state.option.0 = Audyssey EQ Off -channel-type.onkyo.audysseyeq.state.option.1 = Audyssey EQ Movie -channel-type.onkyo.audysseyeq.state.option.2 = Audyssey EQ Music +channel-type.onkyo.audysseyeq.state.option.0 = Off +channel-type.onkyo.audysseyeq.state.option.1 = Movie +channel-type.onkyo.audysseyeq.state.option.2 = Music channel-type.onkyo.control.label = Control -channel-type.onkyo.control.description = Control the Zone Player, e.g. start/stop/next/previous/ffward/rewind +channel-type.onkyo.control.description = Control the Zone Player, e.g. start/stop/next/previous/fast-forward/rewind channel-type.onkyo.currentPlayingTime.label = Playing Time channel-type.onkyo.currentPlayingTime.description = Current Playing Time channel-type.onkyo.input.label = Input Source diff --git a/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/thing/channels.xml b/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/thing/channels.xml index 9271cf66f4d7c..e71731aa89aaa 100644 --- a/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/thing/channels.xml +++ b/bundles/org.openhab.binding.onkyo/src/main/resources/OH-INF/thing/channels.xml @@ -73,7 +73,7 @@ Player - Control the Zone Player, e.g. start/stop/next/previous/ffward/rewind + Control the Zone Player, e.g. start/stop/next/previous/fast-forward/rewind Player @@ -199,8 +199,8 @@ String - - Url to the image of cover art of the current song + + URL to the image of cover art of the current song Status Info diff --git a/bundles/org.openhab.binding.opengarage/README.md b/bundles/org.openhab.binding.opengarage/README.md index 48d43df819a10..b70bdfcf38a80 100644 --- a/bundles/org.openhab.binding.opengarage/README.md +++ b/bundles/org.openhab.binding.opengarage/README.md @@ -1,6 +1,6 @@ # OpenGarage Binding -The OpenGarage binding allows you to control an OpenGarage controller () using openHAB +The OpenGarage binding allows you to control an OpenGarage controller () using openHAB. ## Supported Things @@ -8,7 +8,7 @@ OpenGarage controllers from are ## Discovery -Auto-discover is not currently supported. +Auto-discovery is not currently supported. You need to manually add a new item using its IP address. ## Thing Configuration @@ -16,12 +16,10 @@ You need to manually add a new item using its IP address. As a minimum, the IP address is needed: - `hostname` - The hostname of the OpenGarage controller. Typically you'd use an IP address such as `192.168.0.5` for this field. -- `port` - the port the OpenGarage is listening on. Defaults to port 80 -- `refresh` - The frequency with which to refresh information from the OpenGarage controller specified in seconds. Defaults to 10 seconds. -- `password` - The password to send commands to the OpenGarage. Defaults to "opendoor" -- `doorTransitionTimeSeconds` - Specifies how long it takes the garage door -to fully open / close after triggering it from OpenGarage, including auditory -beeps. Recommend to round up or pad by a second or two. +- `port` - The port the OpenGarage is listening on. Defaults to port 80. +- `refresh` - The frequency with which to refresh information from the OpenGarage controller specified in seconds. Defaults to 60 seconds. +- `password` - The password to send commands to the OpenGarage. Defaults to "opendoor". +- `doorTransitionTimeSeconds` - Specifies how long it takes the garage door to fully open / close after triggering it from OpenGarage, including auditory beeps. Recommend to round up or pad by a second or two. - `doorOpeningState` - Text state to report when garage is opening. Defaults to "OPENING". - `doorOpenState` - Text state to report when garage is open (and not in transition). Defaults to "OPEN". - `doorClosingState` - Text state to report when garage is closing. Defaults to "CLOSING". @@ -29,14 +27,15 @@ beeps. Recommend to round up or pad by a second or two. ## Channels -| channel | type | description | -|----------------------|---------------|---------------------------------------------------------------------------------------| -| distance | Number:Length | Distance reading from the OpenGarage controller (default in cm) | -| status-switch | Switch | Door status (OFF = Closed, ON = Open), set "invert=true" on channel to invert switch | -| status-text | String | Text status of the current door state, including transition, using values from configuration: doorOpeningState, doorOpenState, doorClosingState, doorClosedState. | -| status-contact | Contact | Door status (Open or Closed) | -| status-rollershutter | Rollershutter | Door status (DOWN = Closed, UP = Open) | -| vehicle-status | Number | Report vehicle presence (0=Not Detected, 1=Detected, 2=Unknown) | +| channel | type | description | +|----------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| distance | Number:Length | Distance reading from the OpenGarage controller (default in cm) | +| status-switch | Switch | Door status (OFF = Closed, ON = Open), set "invert=true" on channel to invert switch | +| status-text | String | Text status of the current door state, including transition, using values from configuration: doorOpeningState, doorOpenState, doorClosingState, doorClosedState | +| status-contact | Contact | Door status (Open or Closed) | +| status-rollershutter | Rollershutter | Door status (DOWN = Closed, UP = Open) | +| vehicle | String | Vehicle presence (deprecated, use vehicle-status instead) | +| vehicle-status | Number | Report vehicle presence (0=No vehicle detected, 1=Vehicle detected, 2=Vehicle status unknown, 3=Vehicle status not available) | ## Full Example @@ -49,11 +48,11 @@ opengarage:opengarage:OpenGarage [ hostname="192.168.0.5" ] opengarage.items: ```java -Switch OpenGarage_Status { channel="opengarage:opengarage:OpenGarage:status" } +Switch OpenGarage_Status { channel="opengarage:opengarage:OpenGarage:status-switch" } Contact OpenGarage_Status_Contact { channel="opengarage:opengarage:OpenGarage:status-contact" } Rollershutter OpenGarage_Status_Rollershutter { channel="opengarage:opengarage:OpenGarage:status-rollershutter" } -Number:Length OpenGarage_Distance { channel="opengarage:opengarage:OpenGarage:setpoint" } -String OpenGarage_Vehicle { channel="opengarage:opengarage:OpenGarage:vehicle" } +Number:Length OpenGarage_Distance { channel="opengarage:opengarage:OpenGarage:distance" } +Number OpenGarage_VehicleStatus { channel="opengarage:opengarage:OpenGarage:vehicle-status" } String OpenGarage_StatusText { channel="opengarage:opengarage:OpenGarage:status-text" } ``` @@ -61,14 +60,13 @@ opengarage.sitemap: ```perl Text item=OpenGarage_StatusText label="Status" -Switch item=OpenGarage_Status icon="garagedoorclosed" mappings=[ON=Open] visibility=[OpenGarage_Status == OFF] -Switch item=OpenGarage_Status icon="garagedooropen" mappings=[OFF=Close] visibility=[OpenGarage_Status == ON] +Switch item=OpenGarage_Status icon="garagedoorclosed" mappings=[ON=Open] visibility=[OpenGarage_Status == OFF] +Switch item=OpenGarage_Status icon="garagedooropen" mappings=[OFF=Close] visibility=[OpenGarage_Status == ON] Switch item=OpenGarage_Status icon="garage" Contact item=OpenGarage_Status_Contact icon="garage" Rollershutter item=OpenGarage_Status_Rollershutter icon="garage" Text item=OpenGarage_Distance label="OG distance" -Text item=OpenGarage_Vehicle label="Vehicle Presence" - +Text item=OpenGarage_VehicleStatus label="Vehicle Presence" ``` ## Adding to HomeKit @@ -90,4 +88,4 @@ It's needed because HomeKit requires it, and OpenGarage does not provide it. HomeKit requires a status for the garage door of `OPEN`, `CLOSED`, `CLOSING`, `OPENING`. In order to report that, we must provide state transition information. State transition information is inferred when the garage door state is changed. -For `doorTransitionTimeSeconds` since the last open/close command was issued, the binding reports the state as either "closing" or "opening". +For `doorTransitionTimeSeconds` since the last open/close command was issued, the binding reports the state as either `CLOSING` or `OPENING`. diff --git a/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/i18n/opengarage.properties b/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/i18n/opengarage.properties index 5bf5c729df1c2..1827105d66a28 100644 --- a/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/i18n/opengarage.properties +++ b/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/i18n/opengarage.properties @@ -10,6 +10,16 @@ thing-type.opengarage.opengarage.description = OpenGarage Controller # thing types config +thing-type.config.opengarage.opengarage.doorClosedState.label = Door Closed State +thing-type.config.opengarage.opengarage.doorClosedState.description = Text state to report when garage is closed (and not in transition) +thing-type.config.opengarage.opengarage.doorClosingState.label = Door Closing State +thing-type.config.opengarage.opengarage.doorClosingState.description = Text state to report when garage is closing +thing-type.config.opengarage.opengarage.doorOpenState.label = Door Open State +thing-type.config.opengarage.opengarage.doorOpenState.description = Text state to report when garage is open (and not in transition) +thing-type.config.opengarage.opengarage.doorOpeningState.label = Door Opening State +thing-type.config.opengarage.opengarage.doorOpeningState.description = Text state to report when garage is opening +thing-type.config.opengarage.opengarage.doorTransitionTimeSeconds.label = Door Transition Time +thing-type.config.opengarage.opengarage.doorTransitionTimeSeconds.description = Specifies number of seconds that it takes for the garage door to fully open / close, including the time it takes for OpenGarage to emit beeps. Round up. thing-type.config.opengarage.opengarage.hostname.label = Hostname/IP Address thing-type.config.opengarage.opengarage.hostname.description = The host name or IP address of the OpenGarage Web API interface. thing-type.config.opengarage.opengarage.password.label = Password @@ -18,16 +28,6 @@ thing-type.config.opengarage.opengarage.port.label = Port thing-type.config.opengarage.opengarage.port.description = Port of the OpenGarage Web API interface. thing-type.config.opengarage.opengarage.refresh.label = Refresh Interval thing-type.config.opengarage.opengarage.refresh.description = Specifies the refresh interval in seconds. -thing-type.config.opengarage.opengarage.doorTransitionTimeSeconds.label = Door Transition Time -thing-type.config.opengarage.opengarage.doorTransitionTimeSeconds.description = Specifies number of seconds that it takes for the garage door to fully open / close, including the time it takes for OpenHab to emit beeps. Round up. -thing-type.config.opengarage.opengarage.doorOpeningState.label = Door Opening State -thing-type.config.opengarage.opengarage.doorOpeningState.description = Text state to report when garage is opening. Defaults to "OPENING". -thing-type.config.opengarage.opengarage.doorOpenState.label = Door Open State -thing-type.config.opengarage.opengarage.doorOpenState.description = Text state to report when garage is open (and not in transition). Defaults to "OPEN". -thing-type.config.opengarage.opengarage.doorClosingState.label = Door Closing State -thing-type.config.opengarage.opengarage.doorClosingState.description = Text state to report when garage is closing. Defaults to "CLOSING". -thing-type.config.opengarage.opengarage.doorClosedState.label = Door Closed State -thing-type.config.opengarage.opengarage.doorClosedState.description = Text state to report when garage is closed (and not in transition). Defaults to "CLOSED". # channel types @@ -39,10 +39,10 @@ channel-type.opengarage.opengarage-status-rollershutter.label = Rollershutter St channel-type.opengarage.opengarage-status-rollershutter.description = Roller Shutter Status of the OG unit channel-type.opengarage.opengarage-status-switch.label = Status channel-type.opengarage.opengarage-status-switch.description = On/Off Status of the OG unit -channel-type.opengarage.opengarage-status.label = Status -channel-type.opengarage.opengarage-status.description = On/Off Status of the OG unit (now deprecated, use status-switch instead) channel-type.opengarage.opengarage-status-text.label = Text status channel-type.opengarage.opengarage-status-text.description = Text status of the current door state, including transition, using values from configuration: doorOpeningState, doorOpenState, doorClosingState, doorClosedState. +channel-type.opengarage.opengarage-status.label = Status +channel-type.opengarage.opengarage-status.description = On/Off Status of the OG unit (now deprecated, use status-switch instead) channel-type.opengarage.opengarage-vehicle-status.label = Vehicle Presence channel-type.opengarage.opengarage-vehicle-status.description = Vehicle presence detection channel-type.opengarage.opengarage-vehicle-status.state.option.0 = No vehicle detected diff --git a/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/thing/thing-types.xml index 97376b4b3d015..80e742838b273 100644 --- a/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.opengarage/src/main/resources/OH-INF/thing/thing-types.xml @@ -46,8 +46,9 @@ - Specifies number of seconds that it takes for the garage door to fully open / close, including the time - it takes for OpenHab to emit beeps. Round up. + Specifies number of seconds that it takes for the garage door to fully open / close, including the + time + it takes for OpenGarage to emit beeps. Round up. 17 @@ -81,7 +82,7 @@ Measurement Opening - + Switch diff --git a/bundles/org.openhab.binding.opensprinkler/README.md b/bundles/org.openhab.binding.opensprinkler/README.md index 613463b32b778..7c6b9fea880bd 100644 --- a/bundles/org.openhab.binding.opensprinkler/README.md +++ b/bundles/org.openhab.binding.opensprinkler/README.md @@ -12,10 +12,10 @@ Mixing the two concepts can also be done, the choice is yours. ## Supported Things -- `OpenSprinkler Station` is for gaining advanced controls and status information over a single station (zone) of a device, e.g. to turn it on or off, or the time remaining. -- `OpenSprinkler Device` is for device-specific controls that usually apply to multiple stations or main unit sensors, e.g. if rain was detected. +- `OpenSprinkler Station` is for gaining advanced controls and status information over a single station (zone) of a device, e.g., to turn it on or off, or the time remaining. +- `OpenSprinkler Device` is for device-specific controls that usually apply to multiple stations or main unit sensors, e.g., if rain was detected. -Recommend that you first add a single `device` thing and then if you need the extra controls, add as many of the `station` things as you wish. +It is recommended that you first add a single `device` thing and then, if you need the extra controls, add as many of the `station` things as you wish. ## Discovery @@ -26,7 +26,7 @@ Due to this method used, it is very slow at finding devices and can saturate net - hostname: Hostname or IP address of the OpenSprinkler HTTP API. - port: Port the OpenSprinkler device is listening on. Usually 80. -- password: Admin password of the API. Factory default is: opendoor +- password: Admin password of the API. Factory default is: opendoor. - refresh: Number of seconds in between refreshing the Thing state with the API. - timeout: (optional) Number of seconds to wait for a timeout when calling the OpenSprinkler HTTP API. - retry: (optional) Number of retries on connection timeouts. @@ -37,7 +37,7 @@ Due to this method used, it is very slow at finding devices and can saturate net The `station` thing must be used with a `http` bridge and has the following configuration properties: -- stationIndex: The index of the station to communicate with, starting with 0 for the first station +- stationIndex: The index of the station to communicate with, starting with 0 for the first station. ## Channels @@ -76,7 +76,7 @@ NOTE: Some channels will only show up if the hardware has the required sensor an | rainsensor | Switch | RO | This channel indicates whether rain is detected by the device or not. | | resetStations | Switch | RW | The ON command will stop all stations immediately, including those waiting to run. | | sensor2 | Switch | RO | This channel is for the second sensor (if your hardware supports it). | -| signalStrength | Number | RO | Shows how strong the WiFi Signal is. | +| signalStrength | Number | RO | Shows how strong the WiFi signal is. | | stations | String | RW | Display a list of stations that can be run when selected to the length of time set | | | | | in the `nextDuration` channel. | | waterlevel | Number:Dimensionless | RO | This channel shows the current water level in percent (0-250%). The water level is | @@ -104,7 +104,7 @@ demo.items: ```java Group stations Switch Station01 (stations) { channel="opensprinkler:station:http:01:stationState" } -Number:Time Station01RaminingTime { channel="opensprinkler:station:http:01:remainingWaterTime" } +Number:Time Station01RemainingTime { channel="opensprinkler:station:http:01:remainingWaterTime" } Switch Station02 (stations) { channel="opensprinkler:station:http:02:stationState" } Switch Station03 (stations) { channel="opensprinkler:station:http:03:stationState" } Number:Time Station03NextDuration { channel="opensprinkler:station:http:03:nextDuration" } @@ -113,7 +113,7 @@ Switch Station05 (stations) { channel="opensprinkler:station:http:05:stationStat Switch Station06 (stations) { channel="opensprinkler:station:http:06:stationState" } Switch RainSensor { channel="opensprinkler:device:http:device:rainsensor" } -Number:ElectricCurrent CurrentDraw {channel="opensprinkler:device:http:device:currentDraw"} +Number:ElectricCurrent CurrentDraw { channel="opensprinkler:device:http:device:currentDraw" } ``` demo.sitemap: diff --git a/bundles/org.openhab.binding.openthermgateway/README.md b/bundles/org.openhab.binding.openthermgateway/README.md index 8ca854960acc9..3f995b781f4c6 100644 --- a/bundles/org.openhab.binding.openthermgateway/README.md +++ b/bundles/org.openhab.binding.openthermgateway/README.md @@ -1,7 +1,7 @@ # OpenTherm Gateway Binding This binding is used to integrate the OpenTherm Gateway into openHAB. -The OpenTherm Gateway is a module designed by Schelte Bron that can be connected to units that support communication using the OpenTherm protocol, such as boiler or ventilation / heat recovery unit. +The OpenTherm Gateway is a module designed by Schelte Bron that can be connected to units that support communication using the OpenTherm protocol, such as a boiler or ventilation / heat recovery unit. More information on the OpenTherm Gateway device can be found at @@ -26,7 +26,7 @@ The OpenTherm Gateway binding supports three Things: ### Thing Configuration for `openthermgateway` The `openthermgateway` bridge is designed to support various ways of connecting to the OpenTherm Gateway device, but currently only supports a TCP socket connection. -The configuration settings for the bridge are Hostname/IP address and Port, which are used to connect to the gateway, and an automatic connection retry interval in case the connection to the OpenTherm Gateway device is lost. +The configuration settings for the bridge are hostname/IP address and port, which are used to connect to the gateway, and an automatic connection retry interval in case the connection to the OpenTherm Gateway device is lost. | Parameter | Name | Description | Required | Default | |---------------------------|---------------------------|----------------------------------------------------------------------------------|----------|---------| @@ -156,7 +156,7 @@ The `ventilationheatrecovery` thing supports the following channels: | vh_fhbnumber | Number:Dimensionless | Number of fault history buffer entries | R | | vh_fhbentry | Number:Dimensionless | Fault history buffer entry | R | -## Transparent Slave Parameters and Fault History Buffer channels +## Transparent Slave Parameters and Fault History Buffer Channels The transparent slave parameters (TSP) and fault history buffer (FHB) use a variable number of entries. The number of entries is determined by a TSP or FHB size message. @@ -165,12 +165,12 @@ An index number is added to the base channel name to create a unique channel nam For example, if a TSP size message is received for a boiler unit (OpenTherm DATA-ID 10) with value 60, then channels `tspentry_0` through `tspentry_59` will be automatically created and linked to the corresponding TSP entry (OpenTherm DATA-ID 11). -## Using OpenTherm Gateway as a master device +## Using OpenTherm Gateway as a Master Device When using OpenTherm with a boiler and a thermostat, the thermostat (master) periodically sends messages to the boiler to request data. The boiler (slave) then sends a response message with the requested data which is then used by the OpenTherm Gateway binding to update the channel values in openHAB. -If you have a setup without a master device requesting data, then the slave device may send fewer or even no OpenTherm mesages at all. +If you have a setup without a master device requesting data, then the slave device may send fewer or even no OpenTherm messages at all. In this case, you can make the OpenTherm Gateway act as a master device by sending Priority Message (PM) commands. With openHAB rules, you can use the `sendcommand` channel of the `openthermgateway` bridge to periodically send PM commands to the OpenTherm Gateway. @@ -181,7 +181,8 @@ Example: SendCommand.sendCommand("PM=10") ``` -This will cause the OpenTherm Gateway to send a READ-DATA message to the slave device with DATA-ID 10. If supported, the slave device will respond with a READ-ACK message and the current value. +This will cause the OpenTherm Gateway to send a READ-DATA message to the slave device with DATA-ID 10. +If supported, the slave device will respond with a READ-ACK message and the current value. ## Full Example @@ -203,56 +204,56 @@ Text SendCommand "Send command channel" { channel="openthermgateway:openthermgat ### demo.items for `boiler` ```java -Number:Temperature RoomTemperature "Room Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:roomtemp } -Number:Temperature RoomSetpoint "Room Setpoint [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:roomsetpoint } -Number:Temperature TemporaryRoomSetpointOverride "Temporary Room Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:temperaturetemporary } -Number:Temperature ConstantRoomSetpointOverride "Constant Room Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:temperatureconstant } -Number:Temperature ControlSetpoint "Control Setpoint [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint } -Number:Temperature ControlSetpointRequested "Control Setpoint Requested [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpointrequested } -Number:Temperature ControlSetpointOverride "Control Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpointoverride } -Number:Temperature ControlSetpoint2 "Control Setpoint 2 [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint2 } -Number:Temperature ControlSetpoint2Requested "Control Setpoint 2 Requested [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint2requested } -Number:Temperature ControlSetpoint2Override "Control Setpoint 2 Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint2override } -Number:Temperature DomesticHotWaterTemperature "Domestic Hot Water Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:dhwtemp } -Number:Temperature DomesticHotWaterSetpoint "Domestic Hot Water Setpoint [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:tdhwset } -Number:Temperature DomesticHotWaterSetpointOverride "Domestic Hot Water Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:overridedhwsetpoint } -Number:Temperature BoilerWaterTemperature "Boiler Water Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:flowtemp } -Number:Temperature ReturnWaterTemperature "Return Water Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:returntemp } -Number:Temperature OutsideTemperature "Outside Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:outsidetemp } -Number:Dimensionless CentralHeatingWaterPressure "Central Heating Water Pressure [%.1f bar]" { channel="openthermgateway:boiler:1:remeha:waterpressure } -Switch CentralHeatingEnabled "Central Heating Enabled" { channel="openthermgateway:boiler:1:remeha:ch_enable } -Switch CentralHeatingEnabledThermostat "Central Heating Enabled Thermostat" { channel="openthermgateway:boiler:1:remeha:ch_enablerequested } -Switch CentralHeatingOverridden "Central Heating Overridden" { channel="openthermgateway:boiler:1:remeha:ch_enableoverride } -Switch CentralHeating2Enabled "Central Heating 2 Enabled" { channel="openthermgateway:boiler:1:remeha:ch2_enable } -Switch CentralHeating2EnabledThermostat "Central Heating 2 Enabled Thermostat" { channel="openthermgateway:boiler:1:remeha:ch2_enablerequested } -Switch CentralHeating2Overridden "Central Heating 2 Overridden" { channel="openthermgateway:boiler:1:remeha:ch2_enableoverride } -Switch CentralHeatingActive "Central Heating Active" { channel="openthermgateway:boiler:1:remeha:ch_mode } -Switch DomesticHotWaterEnabled "Domestic Hot Water Enabled" { channel="openthermgateway:boiler:1:remeha:dhw_enable } -Switch DomesticHotWaterActive "Domestic Hot Water Active" { channel="openthermgateway:boiler:1:remeha:dhw_mode } -Switch BurnerActive "Burner Active" { channel="openthermgateway:boiler:1:remeha:flame } -Number:Dimensionless RelativeModulationLevel "Relative Modulation Level [%.1f %%]" { channel="openthermgateway:boiler:1:remeha:modulevel } -Number:Dimensionless MaximumRelativeModulationLevel "Maximum Relative Modulation Level [%.1f %%]" { channel="openthermgateway:boiler:1:remeha:maxrelmdulevel } -Switch FaultIndication "Fault Indication" { channel="openthermgateway:boiler:1:remeha:fault } -Switch ServiceRequired "Service Required" { channel="openthermgateway:boiler:1:remeha:servicerequest } -Switch LockoutResetEnabled "Lockout-Reset Enabled" { channel="openthermgateway:boiler:1:remeha:lockout-reset } -Switch LowWaterPressureFault "Low Water Pressure Fault" { channel="openthermgateway:boiler:1:remeha:lowwaterpress } -Switch GasOrFlameFault "Gas Or Flame Fault" { channel="openthermgateway:boiler:1:remeha:gasflamefault } -Switch AirPressureFault "Air Pressure Fault" { channel="openthermgateway:boiler:1:remeha:airpressfault } -Switch WaterOverTemperatureFault "Water Over-Temperature Fault" { channel="openthermgateway:boiler:1:remeha:waterovtemp } -Number:Dimensionless OEMFaultCode "OEM Fault Code" { channel="openthermgateway:boiler:1:remeha:oemfaultcode } -Number:Dimensionless UnsuccessfulBurnerStarts "Unsuccessful Burner Starts" { channel="openthermgateway:boiler:1:remeha:unsuccessfulburnerstarts } -Number:Dimensionless BurnerStarts "Burner Starts" { channel="openthermgateway:boiler:1:remeha:burnerstarts } -Number:Dimensionless CentralHeatingPumpStarts "Central Heating Pump Starts" { channel="openthermgateway:boiler:1:remeha:chpumpstarts } -Number:Dimensionless DomesticHotWaterPump/ValveStarts "Domestic Hot Water Pump/Valve Starts" { channel="openthermgateway:boiler:1:remeha:dhwpvstarts } -Number:Dimensionless DomesticHotWaterBurnerStarts "Domestic Hot Water Burner Starts" { channel="openthermgateway:boiler:1:remeha:dhwburnerstarts } -Number:Time BurnerHours "Burner Hours" { channel="openthermgateway:boiler:1:remeha:burnerhours } -Number:Time CentralHeatingPumpHours "Central Heating Pump Hours" { channel="openthermgateway:boiler:1:remeha:chpumphours } -Number:Time DomesticHotWaterPumpValveHours "Domestic Hot Water Pump/Valve Hours" { channel="openthermgateway:boiler:1:remeha:dhwpvhours } -Number:Time DomesticHotWaterBurnerHours "Domestic Hot Water Burner Hours" { channel="openthermgateway:boiler:1:remeha:dhwburnerhours } -Number:Dimensionless TransparentSlaveParameterNumber "Transparent Slave Parameter Number" { channel="openthermgateway:boiler:1:remeha:tspnumber } -Number:Dimensionless TransparentSlaveParameterEntry "Transparent Slave Parameter Entry" { channel="openthermgateway:boiler:1:remeha:tspentry } -Number:Dimensionless FaultHistoryBufferNumber "Fault History Buffer Number" { channel="openthermgateway:boiler:1:remeha:fhbnumber } -Number:Dimensionless FaultHistoryBufferEntry "Fault History Buffer Entry" { channel="openthermgateway:boiler:1:remeha:fhbentry } +Number:Temperature RoomTemperature "Room Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:roomtemp" } +Number:Temperature RoomSetpoint "Room Setpoint [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:roomsetpoint" } +Number:Temperature TemporaryRoomSetpointOverride "Temporary Room Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:temperaturetemporary" } +Number:Temperature ConstantRoomSetpointOverride "Constant Room Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:temperatureconstant" } +Number:Temperature ControlSetpoint "Control Setpoint [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint" } +Number:Temperature ControlSetpointRequested "Control Setpoint Requested [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpointrequested" } +Number:Temperature ControlSetpointOverride "Control Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpointoverride" } +Number:Temperature ControlSetpoint2 "Control Setpoint 2 [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint2" } +Number:Temperature ControlSetpoint2Requested "Control Setpoint 2 Requested [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint2requested" } +Number:Temperature ControlSetpoint2Override "Control Setpoint 2 Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:controlsetpoint2override" } +Number:Temperature DomesticHotWaterTemperature "Domestic Hot Water Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:dhwtemp" } +Number:Temperature DomesticHotWaterSetpoint "Domestic Hot Water Setpoint [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:tdhwset" } +Number:Temperature DomesticHotWaterSetpointOverride "Domestic Hot Water Setpoint Override [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:overridedhwsetpoint" } +Number:Temperature BoilerWaterTemperature "Boiler Water Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:flowtemp" } +Number:Temperature ReturnWaterTemperature "Return Water Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:returntemp" } +Number:Temperature OutsideTemperature "Outside Temperature [%.1f %unit%]" { channel="openthermgateway:boiler:1:remeha:outsidetemp" } +Number:Dimensionless CentralHeatingWaterPressure "Central Heating Water Pressure [%.1f bar]" { channel="openthermgateway:boiler:1:remeha:waterpressure" } +Switch CentralHeatingEnabled "Central Heating Enabled" { channel="openthermgateway:boiler:1:remeha:ch_enable" } +Switch CentralHeatingEnabledThermostat "Central Heating Enabled Thermostat" { channel="openthermgateway:boiler:1:remeha:ch_enablerequested" } +Switch CentralHeatingOverridden "Central Heating Overridden" { channel="openthermgateway:boiler:1:remeha:ch_enableoverride" } +Switch CentralHeating2Enabled "Central Heating 2 Enabled" { channel="openthermgateway:boiler:1:remeha:ch2_enable" } +Switch CentralHeating2EnabledThermostat "Central Heating 2 Enabled Thermostat" { channel="openthermgateway:boiler:1:remeha:ch2_enablerequested" } +Switch CentralHeating2Overridden "Central Heating 2 Overridden" { channel="openthermgateway:boiler:1:remeha:ch2_enableoverride" } +Switch CentralHeatingActive "Central Heating Active" { channel="openthermgateway:boiler:1:remeha:ch_mode" } +Switch DomesticHotWaterEnabled "Domestic Hot Water Enabled" { channel="openthermgateway:boiler:1:remeha:dhw_enable" } +Switch DomesticHotWaterActive "Domestic Hot Water Active" { channel="openthermgateway:boiler:1:remeha:dhw_mode" } +Switch BurnerActive "Burner Active" { channel="openthermgateway:boiler:1:remeha:flame" } +Number:Dimensionless RelativeModulationLevel "Relative Modulation Level [%.1f %%]" { channel="openthermgateway:boiler:1:remeha:modulevel" } +Number:Dimensionless MaximumRelativeModulationLevel "Maximum Relative Modulation Level [%.1f %%]" { channel="openthermgateway:boiler:1:remeha:maxrelmdulevel" } +Switch FaultIndication "Fault Indication" { channel="openthermgateway:boiler:1:remeha:fault" } +Switch ServiceRequired "Service Required" { channel="openthermgateway:boiler:1:remeha:servicerequest" } +Switch LockoutResetEnabled "Lockout-Reset Enabled" { channel="openthermgateway:boiler:1:remeha:lockout-reset" } +Switch LowWaterPressureFault "Low Water Pressure Fault" { channel="openthermgateway:boiler:1:remeha:lowwaterpress" } +Switch GasOrFlameFault "Gas Or Flame Fault" { channel="openthermgateway:boiler:1:remeha:gasflamefault" } +Switch AirPressureFault "Air Pressure Fault" { channel="openthermgateway:boiler:1:remeha:airpressfault" } +Switch WaterOverTemperatureFault "Water Over-Temperature Fault" { channel="openthermgateway:boiler:1:remeha:waterovtemp" } +Number:Dimensionless OEMFaultCode "OEM Fault Code" { channel="openthermgateway:boiler:1:remeha:oemfaultcode" } +Number:Dimensionless UnsuccessfulBurnerStarts "Unsuccessful Burner Starts" { channel="openthermgateway:boiler:1:remeha:unsuccessfulburnerstarts" } +Number:Dimensionless BurnerStarts "Burner Starts" { channel="openthermgateway:boiler:1:remeha:burnerstarts" } +Number:Dimensionless CentralHeatingPumpStarts "Central Heating Pump Starts" { channel="openthermgateway:boiler:1:remeha:chpumpstarts" } +Number:Dimensionless DomesticHotWaterPumpValveStarts "Domestic Hot Water Pump/Valve Starts" { channel="openthermgateway:boiler:1:remeha:dhwpvstarts" } +Number:Dimensionless DomesticHotWaterBurnerStarts "Domestic Hot Water Burner Starts" { channel="openthermgateway:boiler:1:remeha:dhwburnerstarts" } +Number:Time BurnerHours "Burner Hours" { channel="openthermgateway:boiler:1:remeha:burnerhours" } +Number:Time CentralHeatingPumpHours "Central Heating Pump Hours" { channel="openthermgateway:boiler:1:remeha:chpumphours" } +Number:Time DomesticHotWaterPumpValveHours "Domestic Hot Water Pump/Valve Hours" { channel="openthermgateway:boiler:1:remeha:dhwpvhours" } +Number:Time DomesticHotWaterBurnerHours "Domestic Hot Water Burner Hours" { channel="openthermgateway:boiler:1:remeha:dhwburnerhours" } +Number:Dimensionless TransparentSlaveParameterNumber "Transparent Slave Parameter Number" { channel="openthermgateway:boiler:1:remeha:tspnumber" } +Number:Dimensionless TransparentSlaveParameterEntry "Transparent Slave Parameter Entry" { channel="openthermgateway:boiler:1:remeha:tspentry" } +Number:Dimensionless FaultHistoryBufferNumber "Fault History Buffer Number" { channel="openthermgateway:boiler:1:remeha:fhbnumber" } +Number:Dimensionless FaultHistoryBufferEntry "Fault History Buffer Entry" { channel="openthermgateway:boiler:1:remeha:fhbentry" } ``` ### demo.items for `ventilationheatrecovery` diff --git a/bundles/org.openhab.binding.openthermgateway/src/main/resources/OH-INF/i18n/openthermgateway.properties b/bundles/org.openhab.binding.openthermgateway/src/main/resources/OH-INF/i18n/openthermgateway.properties index a87378dcd8248..33dbc845ad799 100644 --- a/bundles/org.openhab.binding.openthermgateway/src/main/resources/OH-INF/i18n/openthermgateway.properties +++ b/bundles/org.openhab.binding.openthermgateway/src/main/resources/OH-INF/i18n/openthermgateway.properties @@ -5,19 +5,27 @@ addon.openthermgateway.description = This is the binding for the OpenTherm Gatew # thing types -thing-type.openthermgateway.otgw.label = OpenTherm Gateway -thing-type.openthermgateway.otgw.description = OpenTherm Gateway binding +thing-type.openthermgateway.boiler.label = Boiler +thing-type.openthermgateway.boiler.description = Boiler and thermostat +thing-type.openthermgateway.openthermgateway.label = OpenTherm Gateway +thing-type.openthermgateway.openthermgateway.description = OpenTherm Gateway +thing-type.openthermgateway.ventilationheatrecovery.label = Ventilation / Heat Recovery +thing-type.openthermgateway.ventilationheatrecovery.description = Ventilation or Heat Recovery unit # thing types config -thing-type.config.openthermgateway.otgw.connectionRetryInterval.label = Connection Retry Interval -thing-type.config.openthermgateway.otgw.connectionRetryInterval.description = The interval in seconds to retry connecting (0 = disabled). -thing-type.config.openthermgateway.otgw.group.connection.label = Connection -thing-type.config.openthermgateway.otgw.group.connection.description = Connection settings. -thing-type.config.openthermgateway.otgw.ipaddress.label = Hostname or IP address -thing-type.config.openthermgateway.otgw.ipaddress.description = The hostname or IP address to connect to the OpenTherm Gateway. -thing-type.config.openthermgateway.otgw.port.label = Port -thing-type.config.openthermgateway.otgw.port.description = The port used to connect to the OpenTherm Gateway. +thing-type.config.openthermgateway.openthermgateway.connectTimeoutSeconds.label = Connect Timeout +thing-type.config.openthermgateway.openthermgateway.connectTimeoutSeconds.description = The maximum time (seconds) to wait for establishing a connection to the gateway. +thing-type.config.openthermgateway.openthermgateway.connectionRetryInterval.label = Connection Retry Interval +thing-type.config.openthermgateway.openthermgateway.connectionRetryInterval.description = The interval in seconds to retry connecting (0 = disabled). +thing-type.config.openthermgateway.openthermgateway.group.connection.label = Connection +thing-type.config.openthermgateway.openthermgateway.group.connection.description = Connection settings. +thing-type.config.openthermgateway.openthermgateway.ipaddress.label = Hostname or IP address +thing-type.config.openthermgateway.openthermgateway.ipaddress.description = The hostname or IP address to connect to the OpenTherm Gateway. +thing-type.config.openthermgateway.openthermgateway.port.label = Port +thing-type.config.openthermgateway.openthermgateway.port.description = The port used to connect to the OpenTherm Gateway. +thing-type.config.openthermgateway.openthermgateway.readTimeoutSeconds.label = Read Timeout +thing-type.config.openthermgateway.openthermgateway.readTimeoutSeconds.description = The maximum time (seconds) to wait for reading responses from the gateway. # channel types @@ -75,6 +83,10 @@ channel-type.openthermgateway.diag.label = Diagnostics Indication channel-type.openthermgateway.diag.description = Diagnostics indication channel-type.openthermgateway.fault.label = Fault Indication channel-type.openthermgateway.fault.description = Fault indication +channel-type.openthermgateway.fhbentry.label = Fault History Buffer Entry +channel-type.openthermgateway.fhbentry.description = Fault history buffer entry +channel-type.openthermgateway.fhbnumber.label = Fault History Buffer Number +channel-type.openthermgateway.fhbnumber.description = Number of fault history buffer entries channel-type.openthermgateway.flame.label = Burner Active channel-type.openthermgateway.flame.description = Burner active channel-type.openthermgateway.flowtemp.label = Boiler Water Temperature @@ -111,8 +123,108 @@ channel-type.openthermgateway.temperatureconstant.label = Constant Room Setpoint channel-type.openthermgateway.temperatureconstant.description = Constant override room temperature setpoint channel-type.openthermgateway.temperaturetemporary.label = Temporary Room Setpoint Override channel-type.openthermgateway.temperaturetemporary.description = Temporary override room temperature setpoint +channel-type.openthermgateway.tspentry.label = Transparent Slave Parameter Entry +channel-type.openthermgateway.tspentry.description = Transparent slave parameter entry +channel-type.openthermgateway.tspfhb.label = Set Dynamically +channel-type.openthermgateway.tspfhb.description = Transparent slave parameter or Fault history buffer value +channel-type.openthermgateway.tspnumber.label = Transparent Slave Parameter Number +channel-type.openthermgateway.tspnumber.description = Number of transparant slave parameter entries channel-type.openthermgateway.unsuccessfulburnerstarts.label = Unsuccessful Burner Starts channel-type.openthermgateway.unsuccessfulburnerstarts.description = Unsuccessful burner starts +channel-type.openthermgateway.vh_actualexhaustfanspeed.label = Actual Exhaust Fan Speed +channel-type.openthermgateway.vh_actualexhaustfanspeed.description = Actual exhaust fan speed +channel-type.openthermgateway.vh_actualinletfanspeed.label = Actual Inlet Fan Speed +channel-type.openthermgateway.vh_actualinletfanspeed.description = Actual inlet fan speed +channel-type.openthermgateway.vh_bypass.label = Bypass +channel-type.openthermgateway.vh_bypass.description = Bypass +channel-type.openthermgateway.vh_bypassautomaticstatus.label = Bypass Automatic Status +channel-type.openthermgateway.vh_bypassautomaticstatus.description = Bypass automatic status +channel-type.openthermgateway.vh_bypassautomaticstatus.state.option.0 = manual +channel-type.openthermgateway.vh_bypassautomaticstatus.state.option.1 = automatic +channel-type.openthermgateway.vh_bypassmode.label = Bypass Mode +channel-type.openthermgateway.vh_bypassmode.description = Bypass mode +channel-type.openthermgateway.vh_bypassmode.state.option.0 = manual +channel-type.openthermgateway.vh_bypassmode.state.option.1 = automatic +channel-type.openthermgateway.vh_bypassposition.label = Bypass Position +channel-type.openthermgateway.vh_bypassposition.description = Bypass position +channel-type.openthermgateway.vh_bypassposition.state.option.0 = close +channel-type.openthermgateway.vh_bypassposition.state.option.1 = open +channel-type.openthermgateway.vh_bypassstatus.label = Bypass Status +channel-type.openthermgateway.vh_bypassstatus.description = Bypass status +channel-type.openthermgateway.vh_co2level.label = CO2 Level +channel-type.openthermgateway.vh_co2level.description = CO2 level exhaust air +channel-type.openthermgateway.vh_controlsetpoint.label = Control Setpoint +channel-type.openthermgateway.vh_controlsetpoint.description = Control setpoint +channel-type.openthermgateway.vh_diagnosticcode.label = Diagnostic Code +channel-type.openthermgateway.vh_diagnosticcode.description = Diagnostic code +channel-type.openthermgateway.vh_diagnosticindication.label = Diagnostic Indication +channel-type.openthermgateway.vh_diagnosticindication.description = Diagnostic indication +channel-type.openthermgateway.vh_exhaustfanfault.label = Exhaust Fan Fault +channel-type.openthermgateway.vh_exhaustfanfault.description = Exhaust fan fault +channel-type.openthermgateway.vh_exhaustinlettemp.label = Exhaust Inlet Temperature +channel-type.openthermgateway.vh_exhaustinlettemp.description = Exhaust inlet temperature +channel-type.openthermgateway.vh_exhaustoutlettemp.label = Exhaust Outlet Temperature +channel-type.openthermgateway.vh_exhaustoutlettemp.description = Exhaust outlet temperature +channel-type.openthermgateway.vh_faultcode.label = Fault Code +channel-type.openthermgateway.vh_faultcode.description = Fault code +channel-type.openthermgateway.vh_faultindication.label = Fault Indication +channel-type.openthermgateway.vh_faultindication.description = Fault indication +channel-type.openthermgateway.vh_fhbentry.label = Fault History Buffer Entry +channel-type.openthermgateway.vh_fhbentry.description = Fault history buffer entry +channel-type.openthermgateway.vh_fhbnumber.label = Fault History Buffer Number +channel-type.openthermgateway.vh_fhbnumber.description = Number of fault history buffer entries +channel-type.openthermgateway.vh_filtercheck.label = Filter Check +channel-type.openthermgateway.vh_filtercheck.description = Filter Check enabled +channel-type.openthermgateway.vh_freeventilationmode.label = Free Ventilation Mode +channel-type.openthermgateway.vh_freeventilationmode.description = Free ventilation mode +channel-type.openthermgateway.vh_freeventilationstatus.label = Free Ventilation Status +channel-type.openthermgateway.vh_freeventilationstatus.description = Free ventilation status +channel-type.openthermgateway.vh_frostprotection.label = Frost Protection +channel-type.openthermgateway.vh_frostprotection.description = Frost protection +channel-type.openthermgateway.vh_inletfanfault.label = Inlet Fan Fault +channel-type.openthermgateway.vh_inletfanfault.description = Inlet fan fault +channel-type.openthermgateway.vh_memberid.label = Member ID +channel-type.openthermgateway.vh_memberid.description = Member ID +channel-type.openthermgateway.vh_nominalventenable.label = Nominal Ventilation Value Transfer +channel-type.openthermgateway.vh_nominalventenable.description = Nominal ventilation value transfer enabled +channel-type.openthermgateway.vh_nominalventilationvalue.label = Nominal Ventilation Value +channel-type.openthermgateway.vh_nominalventilationvalue.description = Nominal ventilation value +channel-type.openthermgateway.vh_nominalventrw.label = Nominal Ventilation Value +channel-type.openthermgateway.vh_nominalventrw.description = Nominal ventilation value +channel-type.openthermgateway.vh_nominalventrw.state.option.0 = read-only +channel-type.openthermgateway.vh_nominalventrw.state.option.1 = read/write +channel-type.openthermgateway.vh_openthermversion.label = OpenTherm Version +channel-type.openthermgateway.vh_openthermversion.description = OpenTherm version +channel-type.openthermgateway.vh_relativehumidity.label = Relative Humidity +channel-type.openthermgateway.vh_relativehumidity.description = Relative humidity exhaust air +channel-type.openthermgateway.vh_relativeventilation.label = Relative Ventilation +channel-type.openthermgateway.vh_relativeventilation.description = Relative ventilation position +channel-type.openthermgateway.vh_servicerequest.label = Service Request +channel-type.openthermgateway.vh_servicerequest.description = Service request +channel-type.openthermgateway.vh_speedcontrol.label = Speed Control +channel-type.openthermgateway.vh_speedcontrol.description = Speed control +channel-type.openthermgateway.vh_speedcontrol.state.option.0 = 3-speed +channel-type.openthermgateway.vh_speedcontrol.state.option.1 = variable +channel-type.openthermgateway.vh_supplyinlettemp.label = Supply Inlet Temperature +channel-type.openthermgateway.vh_supplyinlettemp.description = Supply inlet temperature +channel-type.openthermgateway.vh_supplyoutlettemp.label = Supply Outlet Temperature +channel-type.openthermgateway.vh_supplyoutlettemp.description = Supply outlet temperature +channel-type.openthermgateway.vh_systemtype.label = System Type +channel-type.openthermgateway.vh_systemtype.description = System type +channel-type.openthermgateway.vh_systemtype.state.option.0 = central exaust +channel-type.openthermgateway.vh_systemtype.state.option.1 = heat-recovery +channel-type.openthermgateway.vh_tspentry.label = Transparent Slave Parameter Entry +channel-type.openthermgateway.vh_tspentry.description = Transparent slave parameter entry +channel-type.openthermgateway.vh_tspnumber.label = Transparent Slave Parameter Number +channel-type.openthermgateway.vh_tspnumber.description = Number of transparent slave parameter entries +channel-type.openthermgateway.vh_ventilationenable.label = Ventilation +channel-type.openthermgateway.vh_ventilationenable.description = Ventilation enabled +channel-type.openthermgateway.vh_ventilationmode.label = Ventilation Mode +channel-type.openthermgateway.vh_ventilationmode.description = Ventilation mode +channel-type.openthermgateway.vh_ventilationsetpoint.label = Ventilation Setpoint +channel-type.openthermgateway.vh_ventilationsetpoint.description = Ventilation setpoint override +channel-type.openthermgateway.vh_versiontype.label = Version Type +channel-type.openthermgateway.vh_versiontype.description = Version type channel-type.openthermgateway.waterovtemp.label = Water Over-Temperature Fault channel-type.openthermgateway.waterovtemp.description = Water over-temperature fault channel-type.openthermgateway.waterpressure.label = Central Heating Water Pressure diff --git a/bundles/org.openhab.binding.openuv/README.md b/bundles/org.openhab.binding.openuv/README.md index 5384a18319721..dd96aaec99f3d 100644 --- a/bundles/org.openhab.binding.openuv/README.md +++ b/bundles/org.openhab.binding.openuv/README.md @@ -6,7 +6,7 @@ To use this binding, you first need to [register and get your API token](https:/ ## Discovery -Once a bridge with the api Key has been created, Local UV Index information can be auto discovered based on system location. +Once a bridge with the API key has been created, local UV Index information can be auto-discovered based on the system location. ## Binding Configuration @@ -20,7 +20,7 @@ The bridge has only one configuration parameter: |-----------|--------------------------------------------------------------| | apikey | Data-platform token to access the OpenUV service. Mandatory. | -Will accept a Refresh command in order to reinitiate connexion (eg in case of Quota exceeded). +Will accept a Refresh command in order to reinitiate connection (e.g., in case of quota exceeded). ## Thing Configuration @@ -96,10 +96,10 @@ demo.items: ```xtend Number UVIndex "UV Index" { channel = "openuv:uvreport:local:city1:UVIndex" } -Number UVMax "UV Max" { channel = "openuv:uvreport:local:city1:UVMaxEvent" } +Number UVMax "UV Max" { channel = "openuv:uvreport:local:city1:UVMax" } Number:ArealDensity Ozone "Ozone" { channel = "openuv:uvreport:local:city1:Ozone" } Number:Time SafeExp3 "Parents" { channel = "openuv:uvreport:local:city1:parents" } -Number:Time SafeExp2 "Childs" { channel = "openuv:uvreport:local:city1:childs" } +Number:Time SafeExp2 "Children" { channel = "openuv:uvreport:local:city1:childs" } ``` diff --git a/bundles/org.openhab.binding.openuv/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.openuv/src/main/resources/OH-INF/thing/thing-types.xml index 9374ed1f90301..b68ea939ecd98 100644 --- a/bundles/org.openhab.binding.openuv/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.openuv/src/main/resources/OH-INF/thing/thing-types.xml @@ -124,7 +124,7 @@ Safe exposure duration for Fitzpatrick Skin Types. Time - + diff --git a/bundles/org.openhab.binding.openweathermap/README.md b/bundles/org.openhab.binding.openweathermap/README.md index 1f09456013d8a..8dd5cc808fa33 100644 --- a/bundles/org.openhab.binding.openweathermap/README.md +++ b/bundles/org.openhab.binding.openweathermap/README.md @@ -185,7 +185,7 @@ The `forecastMinutely` channel group provides [time series support](#persisting- | forecastHours03, forecastHours06, ... forecastHours120 | rain | Number:Length | Expected rain volume. | | forecastHours03, forecastHours06, ... forecastHours120 | snow | Number:Length | Expected snow volume. | | forecastHours01 ... forecastHours48 | dew-point | Number:Temperature | Expected dew-point. Only available in the One Call API | -| forecastHours01 ... forecastHours48 | precip-probability | Number:Dimensionles | Precipitation probability. Only available in the One Call API | +| forecastHours01 ... forecastHours48 | precip-probability | Number:Dimensionless | Precipitation probability. Only available in the One Call API | ### One Call API Hourly Forecast @@ -205,7 +205,7 @@ In a future release, the `forecastHours01` to `forecastHours48` channel groups w | forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | sunset | DateTime | Time of sunset for the given day. | | forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | moonrise | DateTime | Time of moonrise for the given day. | | forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | moonset | DateTime | Time of moonset for the given day. | -| forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | moon-phase | Number:Dimensionless | Moon phase for the given day. 0 and 1 are 'new moon', 0.25 is 'first quarter moon', 0.5 is 'full moon' and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibous', 'waning gibous', and 'waning crescent', respectively. | +| forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | moon-phase | Number:Dimensionless | Moon phase for the given day. 0 and 1 are 'new moon', 0.25 is 'first quarter moon', 0.5 is 'full moon' and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibbous', 'waning gibbous', and 'waning crescent', respectively. | | forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | condition | String | Forecast weather condition. | | forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | condition-id | String | Id of the forecasted weather condition. **Advanced** | | forecastDaily, forecastToday, forecastTomorrow, forecastDay2, ... forecastDay16 | icon | Image | Icon representing the forecasted weather condition. | @@ -399,7 +399,7 @@ Number:Temperature localHours01Temperature "Temperature [%.1f %unit%]" { channel="openweathermap:onecall:api:local:forecastHours01#apparent-temperature" } Number:Pressure localHours01Pressure "Barometric pressure [%.1f %unit%]" { channel="openweathermap:onecall:api:local:forecastHours01#pressure" } Number:Dimensionless localHours01Humidity "Atmospheric humidity [%d %unit%]" { channel="openweathermap:onecall:api:local:forecastHours01#humidity" } -Number:Temperature localHours01Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall:api:local:current#dew-point" } +Number:Temperature localHours01Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall:api:local:forecastHours01#dew-point" } Number:Speed localHours01WindSpeed "Wind speed [%.1f km/h]" { channel="openweathermap:onecall:api:local:forecastHours01#wind-speed" } Number:Angle localHours01WindDirection "Wind direction [%d %unit%]" { channel="openweathermap:onecall:api:local:forecastHours01#wind-direction" } Number:Speed localHours01GustSpeed "Gust speed [%.1f km/h]" { channel="openweathermap:onecall:api:local:forecastHours01#gust-speed" } @@ -415,7 +415,7 @@ Number:Temperature localHours48Temperature "Temperature [%.1f %unit%]" { channel="openweathermap:onecall:api:local:forecastHours48#apparent-temperature" } Number:Pressure localHours48Pressure "Barometric pressure [%.1f %unit%]" { channel="openweathermap:onecall:api:local:forecastHours48#pressure" } Number:Dimensionless localHours48Humidity "Atmospheric humidity [%d %unit%]" { channel="openweathermap:onecall:api:local:forecastHours48#humidity" } -Number:Temperature localHours48Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall:api:local:current#dew-point" } +Number:Temperature localHours48Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall:api:local:forecastHours48#dew-point" } Number:Speed localHours48WindSpeed "Wind speed [%.1f km/h]" { channel="openweathermap:onecall:api:local:forecastHours48#wind-speed" } Number:Angle localHours48WindDirection "Wind direction [%d %unit%]" { channel="openweathermap:onecall:api:local:forecastHours48#wind-direction" } Number:Speed localHours48GustSpeed "Gust speed [%.1f km/h]" { channel="openweathermap:onecall:api:local:forecastHours48#gust-speed" } @@ -512,7 +512,7 @@ Number:Temperature localHistory1Temperature "Temperature [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:history#apparent-temperature" } Number:Pressure localHistory1Pressure "Barometric pressure [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:history#pressure" } Number:Dimensionless localHistory1Humidity "Atmospheric humidity [%d %unit%]" { channel="openweathermap:onecall-history:api:local-history:history#humidity" } -Number:Temperature localHistory1Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:current#dew-point" } +Number:Temperature localHistory1Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:history#dew-point" } Number:Speed localHistory1WindSpeed "Wind speed [%.1f km/h]" { channel="openweathermap:onecall-history:api:local-history:history#wind-speed" } Number:Angle localHistory1WindDirection "Wind direction [%d %unit%]" { channel="openweathermap:onecall-history:api:local-history:history#wind-direction" } Number:Speed localHistory1GustSpeed "Gust speed [%.1f km/h]" { channel="openweathermap:onecall-history:api:local-history:history#gust-speed" } @@ -531,7 +531,7 @@ Number:Temperature localHistory1Hours01Temperature "Minimum temperature [%.1f %u Number:Temperature localHistory1Hours01ApparentTemperature "Minimum temperature [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#apparent-temperature" } Number:Pressure localHistory1Hours01Pressure "Barometric pressure [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#pressure" } Number:Dimensionless localHistory1Hours01Humidity "Atmospheric humidity [%d %unit%]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#humidity" } -Number:Temperature localHistory1Hours01Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:current#dew-point" } +Number:Temperature localHistory1Hours01Dewpoint "Dew point [%.1f %unit%]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#dew-point" } Number:Speed localHistory1Hours01WindSpeed "Wind speed [%.1f km/h]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#wind-speed" } Number:Angle localHistory1Hours01WindDirection "Wind direction [%d %unit%]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#wind-direction" } Number:Speed localHistory1Hours01GustSpeed "Gust speed [%.1f km/h]" { channel="openweathermap:onecall-history:api:local-history:historyHours01#gust-speed" } diff --git a/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/i18n/openweathermap.properties b/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/i18n/openweathermap.properties index 8dac1f45fd2b4..df88975e05742 100644 --- a/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/i18n/openweathermap.properties +++ b/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/i18n/openweathermap.properties @@ -64,6 +64,8 @@ thing-type.openweathermap.weather-api.description = Provides access to the OpenW bridge-type.config.openweathermap.weather-api.apiVersion.label = One Call API Version bridge-type.config.openweathermap.weather-api.apiVersion.description = One Call API version (defaults to 3.0, version 2.5 is to be closed in June 2024). +bridge-type.config.openweathermap.weather-api.apiVersion.option.2.5 = 2.5 +bridge-type.config.openweathermap.weather-api.apiVersion.option.3.0 = 3.0 bridge-type.config.openweathermap.weather-api.apikey.label = API Key bridge-type.config.openweathermap.weather-api.apikey.description = API key to access the OpenWeatherMap API. bridge-type.config.openweathermap.weather-api.language.label = Language @@ -266,8 +268,8 @@ channel-type.openweathermap.forecasted-outdoor-temperature.label = Forecasted Te channel-type.openweathermap.forecasted-outdoor-temperature.description = Forecasted outdoor temperature. channel-type.openweathermap.forecasted-ozone.label = Forecasted Ozone channel-type.openweathermap.forecasted-ozone.description = Forecasted concentration of ozone. -channel-type.openweathermap.forecasted-particulate-matter-10.label = Particulate Matter - PM10 -channel-type.openweathermap.forecasted-particulate-matter-10.description = Current density of particles less than 10 µm in diameter. +channel-type.openweathermap.forecasted-particulate-matter-10.label = Forecasted Particulate Matter - PM10 +channel-type.openweathermap.forecasted-particulate-matter-10.description = Forecasted density of particles less than 10 µm in diameter. channel-type.openweathermap.forecasted-particulate-matter-2dot5.label = Forecasted Particulate Matter - PM2.5 channel-type.openweathermap.forecasted-particulate-matter-2dot5.description = Forecasted density of particles less than 2.5 µm in diameter. channel-type.openweathermap.forecasted-rain.label = Forecasted Rain @@ -288,7 +290,7 @@ channel-type.openweathermap.hourly-forecast-time-stamp.label = Forecast Time channel-type.openweathermap.hourly-forecast-time-stamp.description = Time of data forecasted. channel-type.openweathermap.hourly-forecast-time-stamp.state.pattern = %1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS channel-type.openweathermap.moon-phase.label = Moon Phase -channel-type.openweathermap.moon-phase.description = Moon phase for the given day. 0 and 1 are 'new moon', 0.25 is 'first quarter moon', 0.5 is 'full moon' and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibous', 'waning gibous', and 'waning crescent', respectively. +channel-type.openweathermap.moon-phase.description = Moon phase for the given day. 0 and 1 are 'new moon', 0.25 is 'first quarter moon', 0.5 is 'full moon' and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibbous', 'waning gibbous', and 'waning crescent', respectively. channel-type.openweathermap.moonrise.label = Moonrise Time channel-type.openweathermap.moonrise.description = Time of moonrise for the given day. channel-type.openweathermap.moonrise.state.pattern = %1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS @@ -305,8 +307,8 @@ channel-type.openweathermap.nitrogen-monoxide.label = Nitrogen Monoxide channel-type.openweathermap.nitrogen-monoxide.description = Current concentration of nitrogen monoxide. channel-type.openweathermap.ozone.label = Ozone channel-type.openweathermap.ozone.description = Current concentration of ozone. -channel-type.openweathermap.particulate-matter-10.label = Forecasted Particulate Matter - PM10 -channel-type.openweathermap.particulate-matter-10.description = Forecasted density of particles less than 10 µm in diameter. +channel-type.openweathermap.particulate-matter-10.label = Particulate Matter - PM10 +channel-type.openweathermap.particulate-matter-10.description = Current density of particles less than 10 µm in diameter. channel-type.openweathermap.particulate-matter-2dot5.label = Particulate Matter - PM2.5 channel-type.openweathermap.particulate-matter-2dot5.description = Current density of particles less than 2.5 µm in diameter. channel-type.openweathermap.precip-probability.label = Precipitation Probability diff --git a/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/thing/channel-types.xml b/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/thing/channel-types.xml index 16940d05632ea..c3b3bff6eebf4 100644 --- a/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/thing/channel-types.xml +++ b/bundles/org.openhab.binding.openweathermap/src/main/resources/OH-INF/thing/channel-types.xml @@ -435,8 +435,8 @@ Number Moon phase for the given day. 0 and 1 are 'new moon', 0.25 is 'first quarter moon', 0.5 is 'full moon' - and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibous', 'waning - gibous', and 'waning crescent', respectively. + and 0.75 is 'last quarter moon'. The periods in between are called 'waxing crescent', 'waxing gibbous', 'waning + gibbous', and 'waning crescent', respectively. Moon Forecast @@ -913,8 +913,8 @@ Number:Density - - Current density of particles less than 10 µm in diameter. + + Forecasted density of particles less than 10 µm in diameter. Forecast ParticulateMatter @@ -924,8 +924,8 @@ Number:Density - - Forecasted density of particles less than 10 µm in diameter. + + Current density of particles less than 10 µm in diameter. Measurement ParticulateMatter diff --git a/bundles/org.openhab.binding.openwebnet/README.md b/bundles/org.openhab.binding.openwebnet/README.md index fbf88115924c5..68adb06232300 100644 --- a/bundles/org.openhab.binding.openwebnet/README.md +++ b/bundles/org.openhab.binding.openwebnet/README.md @@ -5,7 +5,7 @@ This binding integrates **BTicino / Legrand** **MyHOME ® - BUS/SCS** and **M The binding supports: - both wired MyHOME - BUS/SCS and wireless MyHOME Radio - Zigbee setups. The two networks can be configured simultaneously -- auto discovery of MyHOME - BUS/SCS IP and MyHOME Radio - Zigbee USB gateways; auto discovery of devices +- auto-discovery of MyHOME - BUS/SCS IP and MyHOME Radio - Zigbee USB gateways; auto-discovery of devices - commands from openHAB and feedback (events) from BUS/SCS and Radio network ![MyHOMEServer1 Gateway](doc/MyHOMEServer1_gateway.jpg) @@ -110,7 +110,7 @@ Configuration parameters are: - if the BUS/SCS gateway is configured to accept connections from the openHAB computer IP address, no password should be required - in all other cases, a password must be configured. This includes gateways that have been discovered and added from Inbox: without a password configured they will remain OFFLINE - `discoveryByActivation`: discover BUS devices when they are activated also when a device scan hasn't been started from Inbox (`boolean`, _optional_, default: `false`). See [Discovery by Activation](#discovery-by-activation). -- `dateTimeSynch`: synchronise date and time of slave elements on the BUS using openHAB timestamp (`boolean`, _optional_, default: `false`). Set this parameter to `true` to send time-date synchronisation commands on the BUS when the timestamp received from the gateway differs by more than 1 minute from that of openHAB. Useful if the BUS gateway is not syncronized with Internet time servers and with daylight saving time changes. +- `dateTimeSynch`: synchronise date and time of slave elements on the BUS using openHAB timestamp (`boolean`, _optional_, default: `false`). Set this parameter to `true` to send time-date synchronisation commands on the BUS when the timestamp received from the gateway differs by more than 1 minute from that of openHAB. Useful if the BUS gateway is not synchronised with Internet time servers and with daylight saving time changes. Alternatively the MyHOME - BUS/SCS Gateway Thing can be configured using the `.things` file, see `openwebnet.things` example [below](#full-example). @@ -153,7 +153,7 @@ Thermo zones can be configured defining a `bus_thermo_zone` Thing for each zone - the `where` configuration parameter (`OpenWebNet Address`): - example BUS/SCS zone `1` --> `where="1"` -- the `standAlone` configuration parameter (`boolean`, default: `true`): identifies if the zone is managed or not by a Central Unit (4- or 99-zones). `standAlone=true` means the zone is indipendent and no Central Unit is present in the system. +- the `standAlone` configuration parameter (`boolean`, default: `true`): identifies if the zone is managed or not by a Central Unit (4- or 99-zones). `standAlone=true` means the zone is independent and no Central Unit is present in the system. Temperature sensors can be configured defining a `bus_thermo_sensor` Thing with the following parameters: @@ -317,14 +317,14 @@ See [openwebnet.sitemap](#openwebnetsitemap) & [openwebnet.rules](#openwebnetrul - possible events are: - for CEN: - `START_PRESS` - sent when you start pressing the button - - `SHORT_PRESS` - sent if you pressed the button shorter than 0,5sec (sent at the moment when you release it) - - `EXTENDED_PRESS` - sent if you keep the button pressed longer than 0,5sec; will be sent again every 0,5sec as long as you hold pressed (good for dimming rules) - - `RELEASE_EXTENDED_PRESS` - sent once when you finally release the button after having it pressed longer than 0,5sec + - `SHORT_PRESS` - sent if you pressed the button shorter than 0.5 sec (sent at the moment when you release it) + - `EXTENDED_PRESS` - sent if you keep the button pressed longer than 0.5 sec; will be sent again every 0.5 sec as long as you hold pressed (good for dimming rules) + - `RELEASE_EXTENDED_PRESS` - sent once when you finally release the button after having it pressed longer than 0.5 sec - for CEN+: - - `SHORT_PRESS` - sent if you pressed the button shorter than 0,5sec (sent at the moment when you release it) - - `START_EXTENDED_PRESS` - sent once as soon as you keep the button pressed longer than 0,5sec - - `EXTENDED_PRESS` - sent after `START_EXTENDED_PRESS` if you keep the button pressed longer; will be sent again every 0,5sec as long as you hold pressed (good for rules involving dimming/volume) - - `RELEASE_EXTENDED_PRESS` - sent once when you finally release the button after having it pressed longer than 0,5sec + - `SHORT_PRESS` - sent if you pressed the button shorter than 0.5 sec (sent at the moment when you release it) + - `START_EXTENDED_PRESS` - sent once as soon as you keep the button pressed longer than 0.5 sec + - `EXTENDED_PRESS` - sent after `START_EXTENDED_PRESS` if you keep the button pressed longer; will be sent again every 0.5 sec as long as you hold pressed (good for rules involving dimming/volume) + - `RELEASE_EXTENDED_PRESS` - sent once when you finally release the button after having it pressed longer than 0.5 sec #### Thermo Central Unit `mode`: `WEEKLY` and `SCENARIO` diff --git a/bundles/org.openhab.binding.oppo/README.md b/bundles/org.openhab.binding.oppo/README.md index 6483066a0f08d..7842586ca5f88 100644 --- a/bundles/org.openhab.binding.oppo/README.md +++ b/bundles/org.openhab.binding.oppo/README.md @@ -58,7 +58,7 @@ Some notes: - For the older models, some of the features in the control API were added after the players were shipped. - Available HDMI modes for BDP-83 & BDP-9x: AUTO, SRC, 1080P, 1080I, 720P, SDP, SDI - Available HDMI modes for BDP-10x: AUTO, SRC, 4K2K, 1080P, 1080I, 720P, SDP, SDI -- Available HDMI modes for UDP-20x: AUTO, SRC, UHD_AUTO, UHD24, UHD50, UHD60, 1080P_AUTO, 1080P24, 1080P50, 1080P60, 1080I50, 1080I60, 720P50, 720P60, 567P, 567I, 480P, 480I +- Available HDMI modes for UDP-20x: AUTO, SRC, UHD_AUTO, UHD24, UHD50, UHD60, 1080P_AUTO, 1080P24, 1080P50, 1080P60, 1080I50, 1080I60, 720P50, 720P60, 576P, 576I, 480P, 480I - On Linux, you may get an error stating the serial port cannot be opened when the Oppo binding tries to load. - You can get around this by adding the `openhab` user to the `dialout` group like this: `usermod -a -G dialout openhab`. @@ -99,7 +99,7 @@ The following channels are available: | time_display | Number:Time | The playback time elapsed/remaining in seconds (ReadOnly) | | current_title | Number | The current title or track number playing (ReadOnly) | | total_title | Number | The total number of titles or tracks on the disc (ReadOnly) | -| current_chapter | Number | The current chapter number player (ReadOnly) | +| current_chapter | Number | The current chapter number (ReadOnly) | | total_chapter | Number | The total number of chapters in the current title (ReadOnly) | | repeat_mode | String | Sets the current repeat mode (00-06) | | zoom_mode | String | Sets the current zoom mode (00-12) | diff --git a/bundles/org.openhab.binding.oppo/src/main/resources/OH-INF/thing/channels.xml b/bundles/org.openhab.binding.oppo/src/main/resources/OH-INF/thing/channels.xml index 2cc0d42cefb75..ec50e09e67b62 100644 --- a/bundles/org.openhab.binding.oppo/src/main/resources/OH-INF/thing/channels.xml +++ b/bundles/org.openhab.binding.oppo/src/main/resources/OH-INF/thing/channels.xml @@ -77,7 +77,8 @@ - If true, the player will send time updates every second. If false, the binding polls the player evey 10 + If true, the player will send time updates every second. If false, the binding polls the player every + 10 seconds false true @@ -139,7 +140,7 @@ Status Duration - + diff --git a/bundles/org.openhab.binding.orbitbhyve/README.md b/bundles/org.openhab.binding.orbitbhyve/README.md index 325a28eb5bd01..8b3ce9b71718c 100644 --- a/bundles/org.openhab.binding.orbitbhyve/README.md +++ b/bundles/org.openhab.binding.orbitbhyve/README.md @@ -1,6 +1,6 @@ # Orbit B-hyve Binding -This is the binding for the [Orbit B-hyve](https://bhyve.orbitonline.com/) wi-fi sprinklers. +This is the binding for the [Orbit B-hyve](https://bhyve.orbitonline.com/) Wi‑Fi sprinklers. ## Supported Things @@ -9,13 +9,13 @@ So far only the [Orbit B-hyve 8-zone Indoor Timer](https://bhyve.orbitonline.com ## Discovery -This binding supports the auto discovery of the sprinklers bound to your Orbit B-hyve account. +This binding supports the auto-discovery of the sprinklers bound to your Orbit B-hyve account. To start the discovery you need to create a bridge thing and enter valid credentials to your Orbit B-hyve cloud account. ## Thing Configuration -The bridge thing requires a manual configuration. You have to enter valid credentials to your Orbit B-hyve account, and you can also set the refresh time in seconds for polling data from the Orbit cloud. -There is no user configuration related to sprinkler things. Sprinklers do need a configuration property _id_ identifying the device, but the only way how to retrieve it is to let the bridge to auto discover sprinklers. +The bridge thing requires manual configuration. You must enter valid credentials to your Orbit B-hyve account, and you can also set the refresh time in seconds for polling data from the Orbit cloud. +There is no user configuration for sprinkler things. Sprinklers have an _id_ configuration property identifying the device; it is populated when the bridge auto-discovers sprinklers. ## Channels diff --git a/bundles/org.openhab.binding.orbitbhyve/src/main/resources/OH-INF/i18n/orbitbhyve.properties b/bundles/org.openhab.binding.orbitbhyve/src/main/resources/OH-INF/i18n/orbitbhyve.properties index ed0173e951d34..634f9dc6b5d1f 100644 --- a/bundles/org.openhab.binding.orbitbhyve/src/main/resources/OH-INF/i18n/orbitbhyve.properties +++ b/bundles/org.openhab.binding.orbitbhyve/src/main/resources/OH-INF/i18n/orbitbhyve.properties @@ -35,6 +35,10 @@ channel-type.orbitbhyve.program.label = Program Channel channel-type.orbitbhyve.program.description = Dynamic channel representing a program channel-type.orbitbhyve.rain_delay.label = Rain Delay channel-type.orbitbhyve.rain_delay.description = Channel representing rain delay in hours +channel-type.orbitbhyve.rain_delay.state.option.0\ h = OFF +channel-type.orbitbhyve.rain_delay.state.option.24\ h = 24h +channel-type.orbitbhyve.rain_delay.state.option.48\ h = 48h +channel-type.orbitbhyve.rain_delay.state.option.72\ h = 72h channel-type.orbitbhyve.smart_watering.label = Smart Watering Control channel-type.orbitbhyve.smart_watering.description = Channel for enabling/disabling the smart watering mode channel-type.orbitbhyve.watering_time.label = Zone Watering Time diff --git a/bundles/org.openhab.binding.orvibo/README.md b/bundles/org.openhab.binding.orvibo/README.md index afe64a53e444d..6a30e81ee80e9 100644 --- a/bundles/org.openhab.binding.orvibo/README.md +++ b/bundles/org.openhab.binding.orvibo/README.md @@ -1,15 +1,15 @@ # Orvibo Binding This binding integrates Orvibo devices that communicate using UDP. -Primarily this was designed for S20 Wifi Sockets but other products using the same protocol may be implemented in future. +Primarily this was designed for S20 Wi‑Fi sockets, but other products using the same protocol may be implemented in the future. ## Supported Things -- S20 Wifi Sockets +- S20 Wi‑Fi sockets ## Discovery -This binding can automatically discover devices that have already been added to the Wifi network. Please see the check your instruction manual or the help guide in the app for instructions on how to add your device to your Wifi network. +This binding can automatically discover devices that have already been added to the Wi‑Fi network. Please see the instruction manual or the in‑app help guide for instructions on how to add your device to your Wi‑Fi network. ## Binding Configuration @@ -17,7 +17,7 @@ This binding does not require any special configuration. ## Thing Configuration -This is optional, it is recommended to let the binding discover and add Orvibo devices. +This is optional; it is recommended to let the binding discover and add Orvibo devices. To manually configure an S20 Thing you must specify its deviceId (MAC address). In the thing file, this looks like: @@ -39,9 +39,9 @@ Thing orvibo:s20:mysocket [ deviceId="AABBCCDDEEFF"] Switch MySwitch "Switch state [%s]" { channel="orvibo:s20:mysocket:power" } ``` -## `orbivo.sitemap` Example +## `orvibo.sitemap` Example -Using the above things channels and items +Using the above Things and Items Sitemap: ```perl diff --git a/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/i18n/orvibo.properties b/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/i18n/orvibo.properties index f2f7394093221..1dce60e9f7896 100644 --- a/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/i18n/orvibo.properties +++ b/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/i18n/orvibo.properties @@ -5,8 +5,8 @@ addon.orvibo.description = This is the binding for Orvibo devices. # thing types -thing-type.orvibo.s20.label = Orvibo S20 Smart Wifi Socket -thing-type.orvibo.s20.description = This is an Orvibo S20 Smart Wifi Socket +thing-type.orvibo.s20.label = Orvibo S20 Smart Wi‑Fi Socket +thing-type.orvibo.s20.description = This is an Orvibo S20 Smart Wi‑Fi Socket # thing types config diff --git a/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/thing/thing-types.xml index b3bfee83d65e3..e270926ea887c 100644 --- a/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.orvibo/src/main/resources/OH-INF/thing/thing-types.xml @@ -5,8 +5,8 @@ xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd"> - - This is an Orvibo S20 Smart Wifi Socket + + This is an Orvibo S20 Smart Wi‑Fi Socket PowerOutlet