diff --git a/bundles/org.openhab.binding.haassohnpelletstove/README.md b/bundles/org.openhab.binding.haassohnpelletstove/README.md index c87068b17c293..88165e16b6cce 100644 --- a/bundles/org.openhab.binding.haassohnpelletstove/README.md +++ b/bundles/org.openhab.binding.haassohnpelletstove/README.md @@ -1,18 +1,18 @@ -# Haas Sohn Pellet Stove Binding +# Haas+Sohn Pellet Stove Binding -The binding for Haassohnpelletstove communicates with a Haas and Sohn Pelletstove through the optional -WIFI module. More information about the WIFI module can be found here: +This binding communicates with a Haas+Sohn pellet stove through the optional Wi‑Fi module. +More information about the Wi‑Fi module can be found here: ## Supported Things -| Things | Description | Thing Type | -|--------|--------------|------------| -| haassohnpelletstove | Control of a Haas & Sohn Pellet Stove| oven| +| Things | Description | Thing Type | +|----------------------|----------------------------------------|------------| +| haassohnpelletstove | Control of a Haas+Sohn pellet stove | oven | ## Thing Configuration -In general two parameters are required. The IP-Address of the WIFI-Modul of the Stove in the local Network and the Access PIN of the Stove. -The PIN can be found directly at the stove under the Menue/Network/WLAN-PIN. +Two parameters are required: the IP address of the stove’s Wi‑Fi module on the local network and the stove’s access PIN. +The PIN can be found directly at the stove under Menu → Network → WLAN-PIN. ```java Thing haassohnpelletstove:oven:myOven "Pelletstove" [ hostIP="192.168.0.23", hostPIN="1234"] @@ -20,20 +20,20 @@ Thing haassohnpelletstove:oven:myOven "Pelletstove" [ hostIP="192.168.0.23", ho ## Channels -The following channels are yet supported: - -| Channel | Type | Access| Description| -|---------|-------|-------|------------| -| power| Switch | read/write|Turn the stove on/off| -|channelIsTemp|Number:Temperature|read|Receives the actual temperature of the stove| -|channelSpTemp|Number:Temperature|read/write|Receives and sets the target temperature of the stove| -|channelMode|String|read|Receives the actual mode the stove is in like heating, cooling, error, ....| -|channelEcoMode|Switch|read/write|Turn the eco mode of the stove on/off| -|channelIngitions|Number|read|Amount of ignitions of the stove| -|channelMaintenanceIn|Number:Mass|read|States the next maintenance in kg| -|channelCleaningIn|String|read|States the next cleaning window in hours:minutes as string| -|channelConsumption|Number:Mass|read|Total consumption of the stove| -|channelOnTime|Number|read|Operation hours of the stove| +The following channels are supported: + +| Channel | Type | Access | Description | +|----------------------|--------------------|------------|-----------------------------------------------| +| power | Switch | read/write | Turn the stove on/off | +| channelIsTemp | Number:Temperature | read | Current stove temperature | +| channelSpTemp | Number:Temperature | read/write | Target stove temperature | +| channelMode | String | read | Current stove mode (e.g., heating, error) | +| channelEcoMode | Switch | read/write | Enable/disable Eco Mode | +| channelIgnitions | Number | read | Total number of ignitions | +| channelMaintenanceIn | Number:Mass | read | Estimated pellets until next maintenance (kg) | +| channelCleaningIn | String | read | Estimated time until next cleaning (hh:mm) | +| channelConsumption | Number:Mass | read | Total pellet consumption | +| channelOnTime | Number | read | Total operating hours | ## Full Example @@ -61,7 +61,7 @@ Number TemperaturFeuer "TemperaturFeuer" (g_FeuerThermostat) {ga="thermostatTemp ## Tested Hardware -The binding was successfully tested with the following ovens: +The binding has been successfully tested with the following ovens: - HSP 7 DIANA - HSP6 434.08 diff --git a/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/addon/addon.xml index 00ee83af8c878..c7fc98e3fe1fd 100644 --- a/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/addon/addon.xml @@ -4,9 +4,9 @@ xsi:schemaLocation="https://openhab.org/schemas/addon/v1.0.0 https://openhab.org/schemas/addon-1.0.0.xsd"> binding - Haas and Sohn Pelletstove Binding - This binding communicates with Haas and Sohn Pelletstoves through the optional WIFI module. It allows to - power the stove on and off and receives different operation information. + Haas+Sohn Pellet Stove Binding + This binding communicates with Haas+Sohn pellet stoves through the optional Wi‑Fi module. It allows you to + power the stove on and off and receive operational information. local diff --git a/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/i18n/haassohnpelletstove.properties b/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/i18n/haassohnpelletstove.properties index 933282455fed1..a4a7de77d7250 100644 --- a/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/i18n/haassohnpelletstove.properties +++ b/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/i18n/haassohnpelletstove.properties @@ -1,41 +1,41 @@ # add-on -addon.haassohnpelletstove.name = Haas and Sohn Pelletstove Binding -addon.haassohnpelletstove.description = This binding communicates with Haas and Sohn Pelletstoves through the optional WIFI module. It allows to power the stove on and off and receives different operation information. +addon.haassohnpelletstove.name = Haas+Sohn Pellet Stove Binding +addon.haassohnpelletstove.description = This binding communicates with Haas+Sohn pellet stoves through the optional Wi‑Fi module. It allows you to power the stove on and off and receive operational information. # thing types thing-type.haassohnpelletstove.oven.label = Haas+Sohn Oven -thing-type.haassohnpelletstove.oven.description = The binding for Haas and Sohn Pelletstove communicates with a Haas and Sohn Pelletstove through the optional WLAN-Modul. More information can be found here: https://www.haassohn.com/de/ihr-plus/WLAN-Funktion. It allows to power on/off the stove as well as receiving different operation information about the stove. +thing-type.haassohnpelletstove.oven.description = This binding communicates with a Haas+Sohn pellet stove through the optional Wi‑Fi module. More information: https://www.haassohn.com/de/ihr-plus/WLAN-Funktion. It allows you to power the stove on/off and receive operational information. # thing types config thing-type.config.haassohnpelletstove.oven.hostIP.label = IP Address -thing-type.config.haassohnpelletstove.oven.hostIP.description = Please add the IP Address of the WIFI Module of the Haas and Sohn oven here +thing-type.config.haassohnpelletstove.oven.hostIP.description = Enter the IP address of the Haas+Sohn oven’s Wi‑Fi module. thing-type.config.haassohnpelletstove.oven.hostPIN.label = PIN thing-type.config.haassohnpelletstove.oven.hostPIN.description = Please add the PIN of your oven here. You can find it in the Menu directly in your oven. thing-type.config.haassohnpelletstove.oven.refreshRate.label = Refresh Rate -thing-type.config.haassohnpelletstove.oven.refreshRate.description = How often the Pellet Stove should schedule a refresh after a channel is linked to an item. Temperature data will be refreshed according this set time in seconds. Valid input is 0 - 999. +thing-type.config.haassohnpelletstove.oven.refreshRate.description = How often the pellet stove schedules a refresh after a channel is linked to an item. Temperature data will be refreshed according to this interval in seconds. Valid input is 1–1000. # channel types channel-type.haassohnpelletstove.cleaningIn.label = Next Cleaning Window -channel-type.haassohnpelletstove.cleaningIn.description = Provides a time forecast in hours:minutes when the stove need to be cleaned next as String -channel-type.haassohnpelletstove.consumption.label = Total Consumption Stove -channel-type.haassohnpelletstove.consumption.description = Provides the information about the total consumption of pellets of the stove as number:mass -channel-type.haassohnpelletstove.ecoMode.label = On/Off Eco Mode -channel-type.haassohnpelletstove.ecoMode.description = To turn the Eco Mode on/off for the stove as switch -channel-type.haassohnpelletstove.ignitions.label = Ignitions Stove -channel-type.haassohnpelletstove.ignitions.description = Receives the total amount of ignitions of the stove as string -channel-type.haassohnpelletstove.isTemp.label = Is Temperature Stove -channel-type.haassohnpelletstove.isTemp.description = Receives the is temperature of the stove as number:temperature +channel-type.haassohnpelletstove.cleaningIn.description = Estimated time until next cleaning (hh:mm). +channel-type.haassohnpelletstove.consumption.label = Total Pellet Consumption +channel-type.haassohnpelletstove.consumption.description = Total pellet consumption. +channel-type.haassohnpelletstove.ecoMode.label = Eco Mode +channel-type.haassohnpelletstove.ecoMode.description = Enable or disable Eco Mode. +channel-type.haassohnpelletstove.ignitions.label = Ignitions +channel-type.haassohnpelletstove.ignitions.description = Total number of ignitions. +channel-type.haassohnpelletstove.isTemp.label = Actual Stove Temperature +channel-type.haassohnpelletstove.isTemp.description = Current stove temperature. channel-type.haassohnpelletstove.maintenanceIn.label = Next Maintenance -channel-type.haassohnpelletstove.maintenanceIn.description = Provides a pellet forecast when the stove need to be maintained next in kilogram as number:mass -channel-type.haassohnpelletstove.mode.label = Mode Stove -channel-type.haassohnpelletstove.mode.description = Receives the actual mode of the stove as string -channel-type.haassohnpelletstove.onTime.label = Operation Hours Stove -channel-type.haassohnpelletstove.onTime.description = Provides the information of the operating hours of stove as number -channel-type.haassohnpelletstove.power.label = On/Off Stove -channel-type.haassohnpelletstove.power.description = To turn the stove on/off as switch -channel-type.haassohnpelletstove.spTemp.label = Set Temperature Stove -channel-type.haassohnpelletstove.spTemp.description = Set the target temperature of the stove as number:temperature +channel-type.haassohnpelletstove.maintenanceIn.description = Estimated pellet quantity until next maintenance (kg). +channel-type.haassohnpelletstove.mode.label = Stove Mode +channel-type.haassohnpelletstove.mode.description = Current stove mode. +channel-type.haassohnpelletstove.onTime.label = Operating Hours +channel-type.haassohnpelletstove.onTime.description = Total operating hours. +channel-type.haassohnpelletstove.power.label = Power +channel-type.haassohnpelletstove.power.description = Turn the stove on/off. +channel-type.haassohnpelletstove.spTemp.label = Target Stove Temperature +channel-type.haassohnpelletstove.spTemp.description = Target stove temperature. diff --git a/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/thing/thing-types.xml index 3de648bea9b23..b0e90cd17fa9e 100644 --- a/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/thing/thing-types.xml @@ -7,10 +7,11 @@ - The binding for Haas and Sohn Pelletstove communicates with a Haas and Sohn Pelletstove through the - optional - WLAN-Modul. More information can be found here: https://www.haassohn.com/de/ihr-plus/WLAN-Funktion. It allows - to power on/off the stove as well as receiving different operation information about the stove. + This binding communicates with a Haas+Sohn pellet stove through the optional Wi‑Fi module. + More + information: https://www.haassohn.com/de/ihr-plus/WLAN-Funktion. + It allows you to power the stove on/off and receive + operational information. Furnace @@ -29,7 +30,7 @@ - Please add the IP Address of the WIFI Module of the Haas and Sohn oven here + Enter the IP address of the Haas+Sohn oven’s Wi‑Fi module. network-address @@ -38,9 +39,9 @@ - How often the Pellet Stove should schedule a refresh after a channel is linked to an item. Temperature - data will be refreshed according this set time in seconds. Valid input is 0 - 999. - + How often the pellet stove schedules a refresh after a channel is linked to an item. + Temperature data + will be refreshed according to this interval in seconds. Valid input is 1–1000. true 30 @@ -49,8 +50,8 @@ Number:Temperature - - Receives the is temperature of the stove as number:temperature + + Current stove temperature. Measurement Temperature @@ -60,8 +61,8 @@ String - - Receives the actual mode of the stove as string + + Current stove mode. Status Mode @@ -71,8 +72,8 @@ Number:Temperature - - Set the target temperature of the stove as number:temperature + + Target stove temperature. Setpoint Temperature @@ -81,8 +82,8 @@ Switch - - To turn the stove on/off as switch + + Turn the stove on/off. Switch Power @@ -91,8 +92,8 @@ Switch - - To turn the Eco Mode on/off for the stove as switch + + Enable or disable Eco Mode. Switch Mode @@ -101,36 +102,36 @@ Number - - Receives the total amount of ignitions of the stove as string + + Total number of ignitions. Number:Mass - Provides a pellet forecast when the stove need to be maintained next in kilogram as number:mass + Estimated pellet quantity until next maintenance (kg). String - Provides a time forecast in hours:minutes when the stove need to be cleaned next as String + Estimated time until next cleaning (hh:mm). Number:Mass - - Provides the information about the total consumption of pellets of the stove as number:mass + + Total pellet consumption. Number - - Provides the information of the operating hours of stove as number + + Total operating hours. diff --git a/bundles/org.openhab.binding.harmonyhub/README.md b/bundles/org.openhab.binding.harmonyhub/README.md index adfa3dd56e443..b6d3851d87e40 100644 --- a/bundles/org.openhab.binding.harmonyhub/README.md +++ b/bundles/org.openhab.binding.harmonyhub/README.md @@ -5,46 +5,46 @@ The API exposed by the Harmony Hub is relatively limited, but it does allow for ## Overview -The Harmony binding represents a "Hub" as a bridge thing type and "Devices" as things connected to the bridge. +The Harmony binding represents a "Hub" as a bridge Thing type and "Devices" as things connected to the bridge. ### Hub -A hub (bridge thing) represents a physical Harmony Hub. +A hub (bridge Thing) represents a physical Harmony Hub. The hub possesses a single channel with the id "activity" which is a StringType set to the name of the current activity. This channel is dynamically generated with the possible activity strings listed as channel state options. ### Devices Devices are dynamically created. -There is a single device thing for every physical device configured on the harmony hub. +There is a single device Thing for every physical device configured on the harmony hub. Each device has a single channel with the id "button" which sends a string with the name of the button to press on the device. This channel is dynamically generated with the possible button press strings listed as channel state options. ## Discovery The Harmony binding will automatically find all Harmony Hubs on the local network and add them to the inbox. -Once a Hub has been added, any connected devices will also added to the Inbox. +Once a hub has been added, any connected devices will also be added to the Inbox. ## Binding Configuration -The binding requires no special configuration +The binding requires no special configuration. ## Thing Configuration This is optional, it is recommended to let the binding discover and add hubs and devices. -To manually configure a Harmony Hub thing you may specify its host name ("host") as well as an optional search timeout value in seconds ("discoveryTimeout") and optional heart beat interval (heartBeatInterval) in seconds. +To manually configure a Harmony Hub Thing you may specify its host name ("host") as well as an optional search timeout value in seconds ("discoveryTimeout") and optional heartbeat interval (heartBeatInterval) in seconds. -In the thing file, this looks e.g. like +In the Thing file, this looks for example like ```java Bridge harmonyhub:hub:GreatRoom [ host="192.168.1.100"] ``` -To manually configure a Harmony device thing you may specify its numeric id ("id") or its name ("name"), but not both. +To manually configure a Harmony device Thing you may specify its numeric ID ("id") or its name ("name"), but not both. Note that this is prefixed by the hub the device is controlled from. -In the thing file, this looks e.g. like +In the Thing file, this looks e.g. like ```java Bridge harmonyhub:hub:GreatRoom [ name="Great Room"] { @@ -82,7 +82,7 @@ String HarmonyHubGreatButton { channel="harmonyhub:hub:GreatRoom:butt Player HarmonyHubGreatPlayer { channel="harmonyhub:hub:GreatRoom:player" } ``` -Devices can be sent button commands directly, regardless if they are part of the current running activity or not. Note that you must define a Harmony device thing for this to work. +Devices can be sent button commands directly, regardless if they are part of the current running activity or not. Note that you must define a Harmony device Thing for this to work. ```java String HarmonyGreatRoomDenon "Denon Button Press" (gMain) { channel="harmonyhub:device:GreatRoom:denon:buttonPress" } diff --git a/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/i18n/harmonyhub.properties b/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/i18n/harmonyhub.properties index eede1c3d1249c..980f316039606 100644 --- a/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/i18n/harmonyhub.properties +++ b/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/i18n/harmonyhub.properties @@ -34,6 +34,6 @@ channel-type.harmonyhub.buttonPress.description = The label/name of the button t channel-type.harmonyhub.currentActivity.label = Current Activity channel-type.harmonyhub.currentActivity.description = The label/name of the current activity of a Harmony Hub channel-type.harmonyhub.eventTrigger.label = Harmony Hub Event Trigger -channel-type.harmonyhub.eventTrigger.description = Triggered when Harmony Hub sent an event with activity status +channel-type.harmonyhub.eventTrigger.description = Triggered when the Harmony Hub sends an event with activity status. channel-type.harmonyhub.player.label = Player Control -channel-type.harmonyhub.player.description = Send player commands (Rewind,FastForward,Play,Pause,SkipForward,SkipBackwards) to the device associated with the current running activity. +channel-type.harmonyhub.player.description = Send player commands (Rewind, FastForward, Play, Pause, SkipForward, SkipBackward) to the device associated with the currently running activity. diff --git a/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/thing/thing-types.xml index 21632a44265d6..01d3879826dd3 100644 --- a/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.harmonyhub/src/main/resources/OH-INF/thing/thing-types.xml @@ -77,7 +77,7 @@ trigger - Triggered when Harmony Hub sent an event with activity status + Triggered when the Harmony Hub sends an event with activity status. @@ -89,8 +89,9 @@ Player - Send player commands (Rewind,FastForward,Play,Pause,SkipForward,SkipBackwards) to the device associated - with the current running activity. + Send player commands (Rewind, FastForward, Play, Pause, SkipForward, SkipBackward) to the device + associated + with the currently running activity. Control MediaControl diff --git a/bundles/org.openhab.binding.haywardomnilogic/README.md b/bundles/org.openhab.binding.haywardomnilogic/README.md index 7fbdb4ec334d9..9bd00c4e1e5ee 100644 --- a/bundles/org.openhab.binding.haywardomnilogic/README.md +++ b/bundles/org.openhab.binding.haywardomnilogic/README.md @@ -1,25 +1,25 @@ -# Hayward Omnilogic Binding +# Hayward OmniLogic Binding -The Hayward Omnilogic binding integrates the Omnilogic pool controller using the Hayward API. +The Hayward OmniLogic binding integrates the OmniLogic pool controller using the Hayward API. -The Hayward Omnilogic API interacts with Hayward's cloud server requiring a connection with the Internet for sending and receiving information. +The Hayward OmniLogic API interacts with Hayward's cloud servers and requires an Internet connection for sending and receiving information. ## Supported Things -The table below lists the Hayward OmniLogic binding thing types: +The table below lists the Hayward OmniLogic binding Thing types: | Things | Description | Thing Type | |------------------------------|---------------------------------------------------------------------------------|---------------| -| Hayward OmniLogix Connection | Connection to Hayward's Server | bridge | +| Hayward OmniLogic Connection | Connection to Hayward's server | bridge | | Backyard | Backyard | backyard | | Body of Water | Body of Water | bow | | Chlorinator | Chlorinator | chlorinator | | Colorlogic Light | Colorlogic Light | colorlogic | | Filter | Filter control | filter | | Heater Equipment | Actual heater (i.e. gas, solar, electric) | heater | -| Pump | Auxillary pump control (i.e. spillover) | pump | +| Pump | Auxiliary pump control (i.e., spillover) | pump | | Relay | Accessory relay control (deck jet sprinklers, lights, etc.) | relay | -| Virtaul Heater | A Virtual Heater that can control all of the heater equipment based on priority | virtualHeater | +| Virtual Heater | A virtual heater that can control all heater equipment based on priority | virtualHeater | ## Discovery @@ -150,7 +150,7 @@ Hayward OmniLogic Connection Parameters: |------------------|----------------------|----------------------|:----------:| | pumpEnable | Switch | Pump enable | R/W | | pumpSpeedPercent | Number:Dimensionless | Pump speed (%) | R/W | -| pumpSpeedRpm | Number: Frequency | Pump speed in rpm | R/W | +| pumpSpeedRpm | Number:Frequency | Pump speed in RPM | R/W | | pumpSpeedSelect | String | Pump speed presets | R/W | | pumpState | String | Pump state | R | | pumpLastSpeed | Number:Dimensionless | Pump last speed (%) | R | @@ -168,10 +168,10 @@ Hayward OmniLogic Connection Parameters: | heaterEnable | Switch | Heater enable | R | | heaterCurrentSetpoint | Number:Temperature | Heater Current Setpoint | R/W | -**Item Types Number:Dimensionless should have the units (i.e. %, ppm) defined in the Unit metadata +Note: Item types such as Number:Dimensionless should have their units (e.g., %, ppm) defined in the unit metadata. ## Full Example -After installing the binding, you will need to manually add the Hayward Connection thing and enter your credentials. +After installing the binding, manually add the Hayward Connection Thing and enter your credentials. All pool items can be automatically discovered by scanning the bridge. -Goto the inbox and add the things. +Go to the Inbox and add the things. diff --git a/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/addon/addon.xml index 553bdefe44fe5..9554c40d53263 100644 --- a/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/addon/addon.xml @@ -4,8 +4,8 @@ xsi:schemaLocation="https://openhab.org/schemas/addon/v1.0.0 https://openhab.org/schemas/addon-1.0.0.xsd"> binding - Hayward OmniLogix Binding - Binding for the Hayward OmniLogix swimming pool automation controller. + Hayward OmniLogic Binding + Binding for the Hayward OmniLogic swimming pool automation controller. cloud diff --git a/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/i18n/haywardomnilogic.properties b/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/i18n/haywardomnilogic.properties index 72cfcd05da290..a0345cce5cc8f 100644 --- a/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/i18n/haywardomnilogic.properties +++ b/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/i18n/haywardomnilogic.properties @@ -1,7 +1,7 @@ # add-on -addon.haywardomnilogic.name = Hayward OmniLogix Binding -addon.haywardomnilogic.description = Binding for the Hayward OmniLogix swimming pool automation controller. +addon.haywardomnilogic.name = Hayward OmniLogic Binding +addon.haywardomnilogic.description = Binding for the Hayward OmniLogic swimming pool automation controller. # thing types @@ -52,6 +52,7 @@ channel-type.haywardomnilogic.chlorError.label = Chlorinator Error channel-type.haywardomnilogic.chlorOperatingMode.label = Operating Mode channel-type.haywardomnilogic.chlorOperatingMode.state.option.1 = Timed Percent channel-type.haywardomnilogic.chlorOperatingMode.state.option.2 = ORP Autosense +channel-type.haywardomnilogic.chlorStatus.label = Status channel-type.haywardomnilogic.currentSetpoint.label = Current Setpoint channel-type.haywardomnilogic.currentShow.label = Current Show channel-type.haywardomnilogic.enable.label = Heater Enable @@ -107,8 +108,8 @@ channel-type.haywardomnilogic.pumpLastSpeed.description = Last pump speed in per channel-type.haywardomnilogic.pumpSpeedPercent.label = Pump Speed channel-type.haywardomnilogic.pumpSpeedPercent.description = Pump speed in percentage channel-type.haywardomnilogic.pumpSpeedRpm.label = Pump Speed -channel-type.haywardomnilogic.pumpSpeedRpm.description = Pump speed in rpm -channel-type.haywardomnilogic.pumpSpeedSelect.label = Pump Speed States +channel-type.haywardomnilogic.pumpSpeedRpm.description = Pump speed in RPM +channel-type.haywardomnilogic.pumpSpeedSelect.label = Pump Speed Presets channel-type.haywardomnilogic.pumpSpeedSelect.state.option.0 = Off channel-type.haywardomnilogic.pumpSpeedSelect.state.option.33 = Low channel-type.haywardomnilogic.pumpSpeedSelect.state.option.66 = Medium @@ -134,7 +135,6 @@ channel-type.haywardomnilogic.state.label = Heater State channel-type.haywardomnilogic.state.state.option.0 = Off channel-type.haywardomnilogic.state.state.option.1 = Heating channel-type.haywardomnilogic.state.state.option.2 = Paused -channel-type.haywardomnilogic.status.label = Status channel-type.haywardomnilogic.timedPercent.label = Salt Output (%) channel-type.haywardomnilogic.valvePosition.label = Valve Position channel-type.haywardomnilogic.valvePosition.state.option.0 = Off @@ -143,3 +143,4 @@ channel-type.haywardomnilogic.valvePosition.state.option.2 = Spa Only channel-type.haywardomnilogic.valvePosition.state.option.3 = Spill Over channel-type.haywardomnilogic.waterFlow.label = Flow Sensor channel-type.haywardomnilogic.waterTemp.label = Water Temp + diff --git a/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/pump.xml b/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/pump.xml index 5a24849b6c839..9faf031b1ddec 100644 --- a/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/pump.xml +++ b/bundles/org.openhab.binding.haywardomnilogic/src/main/resources/OH-INF/thing/pump.xml @@ -53,7 +53,7 @@ Number:Frequency - Pump speed in rpm + Pump speed in RPM Control Frequency @@ -63,7 +63,7 @@ String - + Control Speed diff --git a/bundles/org.openhab.binding.hccrubbishcollection/README.md b/bundles/org.openhab.binding.hccrubbishcollection/README.md index 40caa675e410c..a18aebea804b8 100644 --- a/bundles/org.openhab.binding.hccrubbishcollection/README.md +++ b/bundles/org.openhab.binding.hccrubbishcollection/README.md @@ -5,12 +5,12 @@ This binding will keep track of your rubbish collection days and uses the [Fight ## Supported Things -A single supported thing called `collection`. +A single supported Thing called `collection`. ## Thing Configuration -The thing supports one setting labelled `address` which is your street number and name as it appears on Google.
-_For Example: +The Thing supports one setting labeled `address`, which is your street number and name as it appears on Google.
+_For example: 1 Victoria Street_ > Note: The above address example is not valid as it is a business address. @@ -23,8 +23,8 @@ _If the address is not valid or rubbish collection service does not apply (for e | ---------------- | ------ | -------------------------------------------------------------------- | | day | Number | The upcoming rubbish collection day of the week (1=Monday, 7=Sunday) | | general | Date | The next general household (red bin) collection day | -| recycling | Date | The next recycling (yellow bin, glass bin) colleciton day | -| collection-event | Event | Event trigger on the day of the rubbish | +| recycling | Date | The next recycling (yellow bin, glass bin) collection day | +| collection-event | Event | Event triggered on the day of rubbish collection | ### Collection Event diff --git a/bundles/org.openhab.binding.hdanywhere/README.md b/bundles/org.openhab.binding.hdanywhere/README.md index 93aa890fb14b9..528657f5fc203 100644 --- a/bundles/org.openhab.binding.hdanywhere/README.md +++ b/bundles/org.openhab.binding.hdanywhere/README.md @@ -4,15 +4,13 @@ This binding integrates with [HDanywhere](https://www.hdanywhere.co.uk) HDMI mat HDanywhere is a manufacturer of multiroom/distributed audio/video equipment. This binding supports their V3 of the Multiroom+ HDMI matrix running firmware V1.2(20131222), as well as the newer MHUB series of matrices. -These matrices support the highest HD resolutions, including 1080p 3D & 4K, use a single Cat5e/6/7 wiring structure with reliable performance up to 100m, -have IR passback to allow you to select and control what you watch from every room and are fully compatible with universal remote controls +These matrices support the highest HD resolutions, including 1080p 3D & 4K, use a single Cat5e/6/7 wiring structure with reliable performance up to 100m, have IR passback to allow you to select and control what you watch from every room, and are fully compatible with universal remote controls. -The matrices can be controlled by either UDP/IP and/or Serial connections, -but due to the lack of feedback on the actual state of the HDMI matrix when using those methods, this binding operates by controlling the built-in webserver of the matrix. +The matrices can be controlled by either UDP/IP and/or serial connections, but due to the lack of feedback on the actual state of the HDMI matrix when using those methods, this binding operates by controlling the built-in webserver of the matrix. ## Supported Things -This binding currently supports the following thing types: +This binding currently supports the following Thing types: - _multiroomplus_ : Multiroom+ V3 (**Note:** This product is no longer sold by HDanywhere) - _mhub4k431_ : MHUB 4K (4X3+1) @@ -27,8 +25,8 @@ This binding does not require any special configuration. ## Thing Configuration -Each thing requires the IP address of the matrix, and the interval in between status updates that are fetched from the matrix. -Additionally, the _multiroomplus_ has an additional required parameter 'ports' to specify the number of physical ports (e.g. 4x4, 8x8,...) of the matrix. +Each Thing requires the IP address of the matrix, and the interval in between status updates that are fetched from the matrix. +Additionally, the _multiroomplus_ has an additional required parameter 'ports' to specify the number of physical ports (e.g., 4x4, 8x8, ...) of the matrix. ```java Thing hdanywhere:mhub4k431:m1 [ipAddress="192.168.0.89",interval=15] @@ -37,7 +35,7 @@ Thing hdanywhere:multiroomplus:m2 [ipAddress="192.168.0.88", ports=4, interval=1 ## Channels -The following channels are supported (actual number of channels is a function of the number of physical ports on the matrix): +The following channels are supported (actual number of channels depends on the number of physical ports on the matrix): | Thing Type | Item Type | Description | |------------|-----------|---------------------------------------------------------------------| @@ -49,7 +47,7 @@ The following channels are supported (actual number of channels is a function of ## Example -demo.Things: +demo.things: ```java hdanywhere:mhub4k431:m1 [ipAddress="192.168.0.89",interval=15] diff --git a/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/addon/addon.xml index 11db217dd83b7..91044593f9e0d 100644 --- a/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/addon/addon.xml @@ -4,8 +4,8 @@ xsi:schemaLocation="https://openhab.org/schemas/addon/v1.0.0 https://openhab.org/schemas/addon-1.0.0.xsd"> binding - openHAB HDanywhere Binding - This is the binding for HDanywhere HDMI Matrices + HDanywhere Binding + This is the binding for HDanywhere HDMI matrices. local diff --git a/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/i18n/hdanywhere.properties b/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/i18n/hdanywhere.properties index cf6458c504912..7e1f4c25b6e57 100644 --- a/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/i18n/hdanywhere.properties +++ b/bundles/org.openhab.binding.hdanywhere/src/main/resources/OH-INF/i18n/hdanywhere.properties @@ -1,7 +1,7 @@ # add-on -addon.hdanywhere.name = openHAB HDanywhere Binding -addon.hdanywhere.description = This is the binding for HDanywhere HDMI Matrices +addon.hdanywhere.name = HDanywhere Binding +addon.hdanywhere.description = This is the binding for HDanywhere HDMI matrices. # thing types @@ -25,7 +25,7 @@ thing-type.config.hdanywhere.multiroomplus.ports.description = Specifies the num # channel types -channel-type.hdanywhere.port.label = Output Port -channel-type.hdanywhere.port.description = The port channel allows to set or read the number of the input port that is connected to the output port. Valid values are 1 to 8 depending on the nature of the Matrix, e.g 4x4 8x8 etc channel-type.hdanywhere.port.label = Output Port channel-type.hdanywhere.port.description = The port channel allows to set or read the number of the input port that is connected to the output port. Valid values are 1 to 4 +channel-type.hdanywhere.port.label = Output Port +channel-type.hdanywhere.port.description = The port channel allows to set or read the number of the input port that is connected to the output port. Valid values are 1 to 8 depending on the nature of the Matrix, e.g 4x4 8x8 etc diff --git a/bundles/org.openhab.binding.hdpowerview/README.md b/bundles/org.openhab.binding.hdpowerview/README.md index 093c83e3e24a8..52b610cebfaf5 100644 --- a/bundles/org.openhab.binding.hdpowerview/README.md +++ b/bundles/org.openhab.binding.hdpowerview/README.md @@ -32,17 +32,17 @@ Make sure your shades are visible in the PowerView app before attempting discove The binding can automatically discover PowerView hubs and gateways. The discovery process can be started by pressing the refresh button in the Main Configuration UI Inbox. -However you can also manually create a (bridge) thing for the hub, and enter the required configuration parameters (see Thing Configuration below). +However you can also manually create a (bridge) Thing for the hub, and enter the required configuration parameters (see Thing Configuration below). If the configuration parameters are all valid, the binding will then automatically attempt to connect to the hub/gateway. If the connection succeeds, the hub will indicate its status as Online, otherwise it will show an error status. -Once the hub thing has been created and successfully connected, the binding will automatically discover all shades and scenes that are in it. +Once the hub Thing has been created and successfully connected, the binding will automatically discover all shades and scenes that are in it. -- For each shade discovered: the binding will create a new dedicated thing with its own channels. -- For each scene discovered: the binding will create a new channel dynamically within the hub/gateway thing. -- [1/2] For each repeater discovered: the binding will create a new dedicated thing with its own channels. -- [1/2] For each scene group discovered: the binding will create a new channel dynamically within the hub thing. -- [1/2] For each automation discovered: the binding will create a new channel dynamically within the hub thing. +- For each shade discovered: the binding will create a new dedicated Thing with its own channels. +- For each scene discovered: the binding will create a new channel dynamically within the hub/gateway Thing. +- [1/2] For each repeater discovered: the binding will create a new dedicated Thing with its own channels. +- [1/2] For each scene group discovered: the binding will create a new channel dynamically within the hub Thing. +- [1/2] For each automation discovered: the binding will create a new channel dynamically within the hub Thing. [1/2] Generation 1/2 hubs only. diff --git a/bundles/org.openhab.binding.helios/README.md b/bundles/org.openhab.binding.helios/README.md index 750e9566a74cf..ec036936e3600 100644 --- a/bundles/org.openhab.binding.helios/README.md +++ b/bundles/org.openhab.binding.helios/README.md @@ -1,20 +1,20 @@ # Helios Binding -This binding integrates the Heliop door/videophone system (). +This binding integrates the Helios door/videophone system (). ## Supported Things -Currently, the Helios IP Vario is supported by this binding, running the 2.21 version of the firmware +Currently, the Helios IP Vario is supported by this binding, running the 2.21 version of the firmware. ## Binding Configuration -There is no specific binding configuration +There is no specific binding configuration. ## Thing Configuration The ipvario221 Thing requires the IP address of the videophone, and the username and password as a configuration value in order for the binding to log into the videophone. -In the thing file, this looks e.g. like +In the Thing file, this looks for example like ```java Thing helios:ipvario213:gate [ipAddress="192.168.0.14", username="admin", password="mypassword"] @@ -24,17 +24,17 @@ Thing helios:ipvario213:gate [ipAddress="192.168.0.14", username="admin", passwo All devices support the following channels: -| Channel Type ID | Item Type | Description | -|-----------------|-----------|-------------------------------------------------------------------------------| -| keypressed | Trigger | Code of a key pressed on the videophone keyboard | -| keyreleased | Trigger | Code of a key released on the videophone keyboard | -| callstate | String | State of the call being made | -| calldirection | String | Direction (e.g. inbound, outbound) of the call being made | -| card | Trigger | ID of the card presented to the RFID reader | -| cardvalid | Switch | The card presented to the RFID reader is valid (i.e. registered in the Vario) | -| code | Trigger | Numerical PIN code (i.e. 1234) entered on the keyboard | -| codevalid | Switch | The code entered is valid (i.e. registerd in the Vario) | -| devicestate | String | State of the device | +| Channel Type ID | Item Type | Description | +|-----------------|-----------|--------------------------------------------------------------------------------| +| keypressed | Trigger | Code of a key pressed on the videophone keyboard | +| keyreleased | Trigger | Code of a key released on the videophone keyboard | +| callstate | String | State of the call being made | +| calldirection | String | Direction (e.g., inbound, outbound) of the call being made | +| card | Trigger | ID of the card presented to the RFID reader | +| cardvalid | Switch | The card presented to the RFID reader is valid (i.e., registered in the Vario) | +| code | Trigger | Numerical PIN code (e.g., 1234) entered on the keyboard | +| codevalid | Switch | The code entered is valid (i.e., registered in the Vario) | +| devicestate | String | State of the device | In addition, devices running the v2.13 firmware support the following channels as well: @@ -45,12 +45,12 @@ In addition, devices running the v2.13 firmware support the following channels a | noise | Switch | Indicates if noise was detected by the videophone | | switchstate | Switch | Indicates the state of an internal switch in the videophone | -For most of the channels a "stamp" channel (of Type DateTime) (e.g. "keypressedstamp") is available and will be updated with the time stamp the relevant event happened on the device. -For switchstate, there are as well the switchstateswitch and switchstateoriginator channels indicating the number of the switch that changed state (1 to 4, depending on the hardware configuration) and the source of the switch state change (keypad, DTMF signal,...) +For most of the channels, a "stamp" channel (of type DateTime) (e.g., "keypressedstamp") is available and will be updated with the time stamp the relevant event happened on the device. +For switchstate, there are also the switchstateswitch and switchstateoriginator channels indicating the number of the switch that changed state (1 to 4, depending on the hardware configuration) and the source of the switch state change (keypad, DTMF signal, etc.). ## Full Example -demo.Things: +demo.things: ```java Thing helios:ipvario221:gate [ipAddress="192.168.0.14", username="admin", password="mypassword"] diff --git a/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/addon/addon.xml index 826c458a78726..0058cca9a9e3a 100644 --- a/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/addon/addon.xml @@ -5,7 +5,7 @@ binding Helios Binding - This is the binding for Helios IP (Vario/...) class of intercom/(video)doorstations. + This is the binding for Helios IP (Vario) class of intercom/video door stations. local diff --git a/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/i18n/helios.properties b/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/i18n/helios.properties index 9bfa9e46ff8c7..d59e634b53def 100644 --- a/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/i18n/helios.properties +++ b/bundles/org.openhab.binding.helios/src/main/resources/OH-INF/i18n/helios.properties @@ -1,14 +1,12 @@ # add-on addon.helios.name = Helios Binding -addon.helios.description = This is the binding for Helios IP (Vario/...) class of intercom/(video)doorstations. +addon.helios.description = This is the binding for Helios IP (Vario) class of intercom/video door stations. # thing types thing-type.helios.ipvario221.label = Helios IP Vario thing-type.helios.ipvario221.description = Helios IP Vario Door Station / Intercom with Firmware v2.21 -thing-type.helios.ipvario27.label = Helios IP Vario -thing-type.helios.ipvario27.description = Helios IP Vario Door Station / Intercom with Firmware v2.7 # thing types config @@ -18,12 +16,6 @@ thing-type.config.helios.ipvario221.password.label = Password thing-type.config.helios.ipvario221.password.description = Password to access REST services on the Helios IP device thing-type.config.helios.ipvario221.username.label = Username thing-type.config.helios.ipvario221.username.description = Username to access REST services on the Helios IP device -thing-type.config.helios.ipvario27.ipAddress.label = Network Address -thing-type.config.helios.ipvario27.ipAddress.description = Network address of the Helios IP device -thing-type.config.helios.ipvario27.openHABipAddress.label = Network Address -thing-type.config.helios.ipvario27.openHABipAddress.description = Network address of the openHAB host -thing-type.config.helios.ipvario27.openHABportNumber.label = Port Number -thing-type.config.helios.ipvario27.openHABportNumber.description = TCP port number the notification web service will be registered on # channel types diff --git a/bundles/org.openhab.binding.heliosventilation/README.md b/bundles/org.openhab.binding.heliosventilation/README.md index b57e989767364..5ceb09eb2ec61 100644 --- a/bundles/org.openhab.binding.heliosventilation/README.md +++ b/bundles/org.openhab.binding.heliosventilation/README.md @@ -1,28 +1,28 @@ # HeliosVentilation Binding This is the binding for Helios Ventilation Systems KWL EC 200/300/500 Pro. -It requires a connection to the RS485 bus used by the original remote controls KWL-FB (9417) and does not use the Modbus/TCP interface of the newer EasyControl devices. +It requires a connection to the RS485 bus used by the original remote controls KWL-FB (9417), and does not use the Modbus/TCP interface of the newer EasyControl devices. For electrical connection it is recommended to use an USB-RS485 interface, but any RS485 interface that shows up as a serial port will do. Setup the device as described in . The binding will use the remote control address 15 for communication, so make sure that this is not assigned to a physically present remote control. -For Helios ventilation devices supporting the easyControls web interface, the separate binding [Helios easyControls binding](https://www.openhab.org/addons/bindings/modbus.helioseasycontrols/) can be used. +For Helios ventilation devices supporting the easyControls web interface, the separate [Helios easyControls binding](https://www.openhab.org/addons/bindings/modbus.helioseasycontrols/) can be used. ## Supported Things -There is only one thing type supported by this binding: a Helios Ventilation System KWL EC 200/300/500 Pro from Helios. -The binding was developed and test on a KWL EC 200 Pro device. +There is only one Thing type supported by this binding: a Helios Ventilation System KWL EC 200/300/500 Pro from Helios. +The binding was developed and tested on a KWL EC 200 Pro device. ## Binding Configuration The binding requires access to the serial device connecting to the RS485 bus as described in . -Otherwise only thing configuration is needed. +Otherwise only Thing configuration is needed. ## Thing Configuration -The binding supports only one thing and requires the configuration of the serial port (typically /dev/ttyUSB0 on Linux and COM3 on Windows) and optionally the polling time which is the cycle time after which the binding tries to reconnect to the bus and requests data updates. +The binding supports only one Thing and requires the configuration of the serial port (typically /dev/ttyUSB0 on Linux and COM3 on Windows) and optionally the polling time which is the cycle time after which the binding tries to reconnect to the bus and requests data updates. ## Channels @@ -43,35 +43,35 @@ Supported operation channels: Supported configuration channels: -| channel | type | description | -|--------------------|----------------------|-----------------------------------------------| -| bypassTemp | Number:Temperature | Temperature to disable the bypass function | -| supplyStopTemp | Number:Temperature | Temperature to stop supply fan for defrosting | -| preheatTemp | Number:Temperature | Temperature to enable the preheater | -| minFanspeed | Number | Minimal level of the fanspeed (1-8) | -| maxFanspeed | Number | Maximal level of the fanspeed (1-8) | -| rhLimit | Number:Dimensionless | Limit for relative humidity sensor | -| hysteresis | Number:Temperature | Hysteresis on defroster temperature | -| DCFanExtract | Number:Dimensionless | Speed reduction for the extract fan | -| DCFanSupply | Number:Dimensionless | Speed reduction for the supply fan | -| maintenanceInterval| Number:Dimensionless | Maintenance interval in months | -| adjustInveral | Number:Dimensionless | Adjust interval in minutes for air quality | -| RHLevelAuto | Switch | Automatic base humidity determination | -| switchType | Switch | External Switch type (Boost or Fireplace) | -| radiatorType | Switch | Use water (ON) or electric (OFF) radiator | -| cascade | Switch | System is cascaded | +| channel | type | description | +|--------------------|----------------------|------------------------------------------------| +| bypassTemp | Number:Temperature | Temperature to disable the bypass function | +| supplyStopTemp | Number:Temperature | Temperature to stop the supply fan for defrost | +| preheatTemp | Number:Temperature | Temperature to enable the preheater | +| minFanspeed | Number | Minimal level of the fanspeed (1-8) | +| maxFanspeed | Number | Maximal level of the fanspeed (1-8) | +| rhLimit | Number:Dimensionless | Limit for relative humidity sensor | +| hysteresis | Number:Temperature | Hysteresis on defroster temperature | +| DCFanExtract | Number:Dimensionless | Speed reduction for the extract fan | +| DCFanSupply | Number:Dimensionless | Speed reduction for the supply fan | +| maintenanceInterval| Number:Dimensionless | Maintenance interval in months | +| adjustInterval | Number:Dimensionless | Adjust interval in minutes for air quality | +| RHLevelAuto | Switch | Automatic base humidity determination | +| switchType | Switch | External switch type (Boost or Fireplace) | +| radiatorType | Switch | Use water (ON) or electric (OFF) radiator | +| cascade | Switch | System is cascaded | Note: the configuration channels are not intended to be written regularly. ## Full Example -Things: +`heliosventilation.things`: ```java heliosventilation:ventilation:MyKWL [ serialPort="/dev/ttyUSB0" ] ``` -Items: +`heliosventilation.items`: ```java Switch KWLOnOff { channel="heliosventilation:ventilation:MyKWL:powerState" } @@ -90,7 +90,7 @@ Number Max_Fan_Speed "Max Fan Speed" { channel="heliosventilation:ventilat ``` -Sitemap: +`heliosventilation.sitemap`: ```perl sitemap helios_kwl label="Helios Ventilation" { diff --git a/bundles/org.openhab.binding.heos/README.md b/bundles/org.openhab.binding.heos/README.md index c6d9d91808618..6a8f57acc9400 100644 --- a/bundles/org.openhab.binding.heos/README.md +++ b/bundles/org.openhab.binding.heos/README.md @@ -1,27 +1,27 @@ # Denon HEOS Binding -This binding support the HEOS-System from Denon. +This binding supports the HEOS system from Denon. The binding provides control of the players and groups within the network. It also supports selecting favorites and play them on players or groups within the HEOS-Network. -The binding first establishes a connection to one of the players of the HEOS-Network and use them as a bridge. +The binding first establishes a connection to one of the players of the HEOS network and uses it as a bridge. After a connection is established, the binding searches for all available players and groups via the bridge. -To keep the network traffic low it is recommended to establish only one connection via one bridge. +To keep the network traffic low, it is recommended to establish only one connection via one bridge. Connection to the bridge is done via a Telnet connection on port 1255. ## Supported Things Bridge: -The binding supports a bridge to connect to the HEOS-Network. -A bridge uses the thing ID "bridge". +The binding supports a bridge to connect to the HEOS network. +A bridge uses the Thing ID `bridge`. Player: A generic player is supported via this binding. Currently no differences are made between the players. -A player uses the Thing ID "player" +A player uses the Thing ID `player`. Groups: The binding supports HEOS groups. -A group uses the Thing ID "group" +A group uses the Thing ID `group`. ## Discovery @@ -32,7 +32,7 @@ You need to add a Bridge device first (which is also auto-discovered by the bind Please note that only one bridge is required to establish a connection. Adding a second bridge can cause trouble with the connection. -It is recommended to use the UI to setup the system and add all players and groups. +It is recommended to use the UI to set up the system and add all players and groups. The bridge is discovered through UPnP in the local network. Once it is added the players and groups are discovered via the bridge and placed in the Inbox. @@ -63,7 +63,7 @@ Bridge heos:bridge:main "name" [ipAddress="192.168.0.1", username="xxx", passwor ### Player Configuration -Player have the following configuration parameter +Players have the following configuration parameter: | Parameter | Description | Required | |----------------- |----------------------------------------------------------- | --------- | @@ -83,7 +83,7 @@ For further details refer to the [HEOS CLI](https://rn.dmglobal.com/usmodel/HEOS ### Group Configuration -Player have the following configuration parameter +Groups have the following configuration parameter: | Parameter | Description | Required | |----------------- |------------------------------------------------------------------------------------- | --------- | @@ -126,11 +126,11 @@ Bridge heos:bridge:main "Bridge" [ipAddress="192.168.0.1", username="userName", | CurrentPosition | Number:Time | Shows the current track position in seconds | | Duration | Number:Time | The overall track duration in seconds | | Type | String | The type of the played media. Station or song for example | -| Station | String | The station name if it is a station (Spotify shows track name....) | +| Station | String | The station name if it is a station (Spotify shows track name) | | PlayUrl | String | Plays a media file located at the URL | | Shuffle | Switch | Switches shuffle ON or OFF | -| RepeatMode | String | Defines the repeat mode: Inputs are: "One" , "All" or "Off" | -| Favorites | String | Plays a favorite. The selection options are retrieved automatically | +| RepeatMode | String | Defines the repeat mode: Inputs are: "One", "All", or "Off" | +| Favorites | String | Plays a favorite. The selection options are retrieved automatically | | Playlists | String | Plays a playlist. The selection options are retrieved automatically | | Queue | String | Plays from the queue. The queue items are retrieved automatically | | ClearQueue | Switch | Clear the queue when turned ON | @@ -143,7 +143,7 @@ You can send commands to these channels from rules by sending the name of the se ```java Player LivingRoom_Control "Control" {channel="heos:player:main:LivingRoom:Control"} -Selection item=LivingRoom_Playlists label="Playlist" icon="music" +Selection item=LivingRoom_Playlists label="Playlist" icon="music" ``` ### Channels of Thing type 'group' @@ -161,19 +161,19 @@ Selection item=LivingRoom_Playlists label="Playlist" icon="music" | CurrentPosition | Number:Time | Shows the current track position in seconds | | Duration | Number:Time | The overall track duration in seconds | | Type | String | The type of the played media. Station or song for example | -| Station | String | The station name if it is a station (Spotify shows track name....) | +| Station | String | The station name if it is a station (Spotify shows track name) | | Inputs | String | The input to be switched to. Input values from HEOS protocol | | PlayUrl | String | Plays a media file located at the URL | | Shuffle | Switch | Switches shuffle ON or OFF | -| RepeatMode | String | Defines the repeat mode: Inputs are: "One" ; "All" or "Off" | -| Favorites | String | Plays a favorite. The selection options are retrieved automatically | +| RepeatMode | String | Defines the repeat mode: Inputs are: "One", "All", or "Off" | +| Favorites | String | Plays a favorite. The selection options are retrieved automatically | | Playlists | String | Plays a playlist. The selection options are retrieved automatically | | Queue | String | Plays from the queue. The queue items are retrieved automatically | | ClearQueue | Switch | Clear the queue when turned ON | The `Favorites`, `Playlists`, `Queue` selection options are queried automatically from the HEOS system (if you set up any in the HEOS app). -This means the available options will be visible in a Selection, you don't have to specify them manually. -You can send commands to these channels from rules by sending the name of the selected item (For example: Starting a favorite radio channel from rule). +This means the available options will be visible in a selection, and you don't have to specify them manually. +You can send commands to these channels from rules by sending the name of the selected item (for example, starting a favorite radio channel from a rule). ### Available inputs @@ -218,28 +218,28 @@ A current list can be found within the [HEOS CLI Protocol Specification 2021 PDF | Channel ID | Item Type | Description | |---------------------- |----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- | | Reboot | Switch | Reboot the whole HEOS System. Can be used if you get in trouble with the system | -| BuildGroup | Switch | Is used to define a group. The player which shall be grouped has to be selected first. If Switch is then activated the group is built. | +| BuildGroup | Switch | Is used to define a group. The player that shall be grouped has to be selected first. If the switch is then activated, the group is built. | -For a list of the commands please refer to the [HEOS CLI protocol](https://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification_2021.pdf). +For a list of the commands, please refer to the [HEOS CLI protocol](https://rn.dmglobal.com/euheos/HEOS_CLI_ProtocolSpecification_2021.pdf). ## _Dynamic Channels_ -Also the bridge supports dynamic channels which represent the players of the network. +The bridge also supports dynamic channels which represent the players of the network. They are added dynamically if a player is found. The player and group channels are only shown on the bridge. ### Player Channels | Channel ID | Item Type | Description | |------------ |----------- |----------------------------------------------------------------------------------------------------- | -| {playerID} | Switch | A channel which represents the player. Please check via UI how the correct Channel Type looks like. | +| {playerID} | Switch | A channel which represents the player. Please check via UI how the correct channel type looks. | Example - ```java +```java Switch Player_1 "Player [%s]" {channel="heos:bridge:main:P123456789"} - ``` +``` - The {playerUID} has either a P in front of the number which indicates that this is a player or a G to indicate this is a group. +The {playerUID} has either a P in front of the number, which indicates that this is a player, or a G to indicate this is a group. ## Full Example @@ -288,11 +288,11 @@ This section gives some detailed explanations how to use the binding. ### Grouping Players Players can be grouped via the binding. -The easiest way to do this is to use the created Group type Thing. To group them simply use the `Ungroup` channel on the Group. Switching this Switch ON and OFF will group and ungroup that Group. -The first player which is selected will be the Group leader. -Therefore changing play/pause and some other things at any player (which is included in that group) will also change that at the whole group. -Muting and Volume on the other hand can be changed individually for each Player also for the group leader. -If you want to change that for the whole group you have to do it via the Group thing. +The easiest way to do this is to use the created Group type Thing. To group them, simply use the `Ungroup` channel on the Group. Switching this switch ON and OFF will group and ungroup that group. +The first player that is selected will be the group leader. +Therefore, changing play/pause and some other things at any player (which is included in that group) will also change that for the whole group. +Muting and volume, on the other hand, can be changed individually for each player, also for the group leader. +If you want to change that for the whole group, you have to do it via the Group Thing. ### Inputs @@ -397,7 +397,7 @@ Multiple actions are supported by this binding. In classic rules these are acces ```java val actions = getActions("heos","heos:bridge:bridgeId") if(null === actions) { - logInfo("actions", "Actions not found, check thing ID") + logInfo("actions", "Actions not found, check Thing ID") return } else { actions.playInputFromPlayer(-3213214, "aux_in_1", 89089081) diff --git a/bundles/org.openhab.binding.herzborg/README.md b/bundles/org.openhab.binding.herzborg/README.md index 2088cdb7dc681..254a9b49a7960 100644 --- a/bundles/org.openhab.binding.herzborg/README.md +++ b/bundles/org.openhab.binding.herzborg/README.md @@ -4,10 +4,10 @@ This binding supports smart curtain motors by Herzborg ( **WARNING**: Please don't use your developer account username - - _Redirect URIs_: add your openHAB URL followed by `/homeconnect` + - _Redirect URIs_: add your openHAB URL followed by `/homeconnect`, for example: `http://192.168.178.34:8080/homeconnect` or `https://myhome.domain.com/homeconnect` - _One Time Token Mode_: keep unchecked - _Proof Key for Code Exchange_: keep unchecked @@ -124,11 +124,11 @@ The Home Connect bridge can be configured in the openHAB UI as follows: 1. Go to the Inbox and press the add button 1. Choose `Home Connect Binding` 1. Select `Home Connect API` -1. Setup and save thing +1. Setup and save Thing - **client id:** your application client id - **client secret:** your application client secret - **simulator:** false -1. Now navigate to the URL (`Redirct URI`) you've added to your Home Connect application in the previous step (2.3). For example `http://192.168.178.80:8080/homeconnect`. +1. Now navigate to the URL (`Redirect URI`) you've added to your Home Connect application in the previous step (2.3). For example, `http://192.168.178.80:8080/homeconnect`. 1. Please follow the steps shown to authenticate your binding. You can redo this step every time. For example if you have authentication problems, just start wizard again. ![Screenshot Home Connect wizard page 1](doc/homeconnect_setup_1.png "Screenshot Home Connect wizard page 1") ![Screenshot Home Connect wizard page 2](doc/homeconnect_setup_2.png "Screenshot Home Connect wizard page 2") @@ -210,7 +210,7 @@ Switch Washer_LaundryCareWasherIdos2 "i-Dos 2 Switch Washer_LaundryCareWasherVarioPerfect "Vario Perfect State" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_vario_perfect"} Switch Washer_LaundryCareWasherLessIroning "Ironing State" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_less_ironing"} Switch Washer_LaundryCareWasherPreWash "Prewash State" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_pre_wash"} -Switch Washer_LaundryCareWasherRinsePlus "Amount Aadditional Rinses" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_rinse_plus"} +String Washer_LaundryCareWasherRinsePlus "Amount Additional Rinses" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_rinse_plus"} Switch Washer_LaundryCareWasherRinseHold "Spin Hold" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_rinse_hold"} Switch Washer_LaundryCareWasherSoak "Soaking State" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_soak"} Number:Mass Washer_LaundryCareWasherLoadRecommendation "Load Recommendation" {channel="homeconnect:washer:api_bridge_at_home:washer1:laundry_care_washer_load_recommendation"} @@ -222,17 +222,17 @@ String Washer_BasicActionsState "Basic C ## Home Connect Console -The binding comes with a separate user interface, which is reachable through the web browser http(s)://[YOUROPENHAB]:[YOURPORT]/homeconnect (e.g. `http://192.168.178.100:8080/homeconnect`). +The binding comes with a separate user interface, which is reachable through the web browser `http(s)://[YOUROPENHAB]:[YOURPORT]/homeconnect` (e.g., `http://192.168.178.100:8080/homeconnect`). Features: -- overview of your bridges and appliances -- send commands to your appliances -- see latest API requests -- see received events from the Home Connect backend +- Overview of your bridges and appliances +- Send commands to your appliances +- See latest API requests +- See received events from the Home Connect backend - API request counts -> **INFO**: If you have a problems with your installation, please always provide request and event exports. ![Screenshot Home Connect wizard page 4](doc/export_button.png "Export button") +> **INFO**: If you have problems with your installation, please always provide request and event exports. ![Screenshot Home Connect wizard page 4](doc/export_button.png "Export button") ## How To @@ -273,14 +273,14 @@ Currently, not all program options of a device are available as items in openHAB #### 1. Retrieve "special command" payload -You have a couple options to get the program settings payload. +You have a couple of options to get the program settings payload. a) You could have a look at the Home Connect developer documentation () and create the payload on your own. b) You could have a look at the request logs and extract the payload from there. 1. On the physical device, select your desired program with the appropriate options. -1. Open the appliance section of the binding UI (http(s)://[YOUROPENHAB]:[YOURPORT]/appliances) and click the 'Selected Program' button. +1. Open the appliance section of the binding UI (`http(s)://[YOUROPENHAB]:[YOURPORT]/appliances`) and click the 'Selected Program' button. ![Screenshot Home Connect wizard page 4](doc/selected_program_1.png "Get selected program") 1. ![Screenshot Home Connect wizard page 4](doc/selected_program_2.png "Get selected program") Copy the JSON payload. In a further step, this payload will be used to start the program. @@ -327,16 +327,18 @@ The channel of type `remote_start_allowance_state` is read only. You can only en ### In case of error... -Please check log UI (http(s)://[YOUROPENHAB]:[YOURPORT]/homeconnect) and ask for help in the community forum or on github. Please provide request and event exports. +Please check log UI (`http(s)://[YOUROPENHAB]:[YOURPORT]/homeconnect`) and ask for help in the community forum or on GitHub. Please provide request and event exports. ![Screenshot Home Connect wizard page 4](doc/export_button.png "Export button") ### Rate limit reached -The Home Connect API enforces rate [limits](https://developer.home-connect.com/docs/general/ratelimiting). If you have a lot of `429` response codes in your request log section (http(s)://[YOUROPENHAB]:[YOURPORT]/homeconnect/log/requests), please check the error response. +The Home Connect API enforces rate [limits](https://developer.home-connect.com/docs/general/ratelimiting). If you have a lot of `429` response codes in your request log section (`http(s)://[YOUROPENHAB]:[YOURPORT]/homeconnect/log/requests`), please check the error response. -### Error message 'Program not supported', 'Unsupported operation' or 'SDK.Error.UnsupportedOption' +### Error message 'Program not supported', 'Unsupported operation', or 'SDK.Error.UnsupportedOption' -Not all appliance programs and program options are supported by the Home Connect API. Unfortunately you can't use them. You will see error messages like the following in the binding UI (request log): +Not all appliance programs and program options are supported by the Home Connect API. +Unfortunately, you can't use them. +You will see error messages like the following in the binding UI (request log): ```json { diff --git a/bundles/org.openhab.binding.homematic/README.md b/bundles/org.openhab.binding.homematic/README.md index 9b88cde618c30..81cafba3268b7 100644 --- a/bundles/org.openhab.binding.homematic/README.md +++ b/bundles/org.openhab.binding.homematic/README.md @@ -5,7 +5,7 @@ This binding allows you to integrate, view, control and configure all Homematic ## Configuration of the CCU -Under `Home page > Settings > Control panel` with the menu `Configure Firewall` the Firewall configurations have to be adjusted. +Under `Home page > Settings > Control panel` with the menu `Configure Firewall`, the firewall configurations have to be adjusted. The CCU has to be configured to have "XML-RPC" set to "Full Access" or "Restricted access". Also the "Remote Homematic-Script API" has to be set to "Full Access" or "Restricted access". When the option "Restricted access" is used, some ports have to be added to the "Port opening" list. @@ -24,8 +24,7 @@ Also the IP of the device running openHAB has to be set to the list of "IP addre Also under `Home page > Settings > Control panel` with the menu `Security` the option `Authentication` has to be disabled if the option 'useAuthentication' is not set. This option may be enabled if the option 'useAuthentication' is set and BIN-RPC is not used. In this case, a user and password must be created. -This can be done under `Home page > Settings > Control panel` with the menu `User management`. -This can be done under `Home page > Settings > Control Panel` in the `User Management` menu. +This can be done under `Home page > Settings > Control panel` in the `User management` menu. The new user should have the following configuration: - User name - button for login: No @@ -35,7 +34,7 @@ The new user should have the following configuration: The user and password must then be entered in the 'Username' and 'Password' settings. -If this is not done the binding will not be able to connect to the CCU and the CCU Thing will stay uninitialized and sets a timeout exception or a authentication error +If this is not done, the binding will not be able to connect to the CCU and the CCU Thing will stay uninitialized and set a timeout exception or an authentication error: ```text xxx-xx-xx xx:xx:xx.xxx [hingStatusInfoChangedEvent] - - 'homematic:bridge:xxx' changed from INITIALIZING to OFFLINE (COMMUNICATION_ERROR): java.net.SocketTimeoutException: Connect Timeout @@ -43,7 +42,7 @@ xxx-xx-xx xx:xx:xx.xxx [hingStatusInfoChangedEvent] - - 'homematic:bridge:xxx' c ## Supported Bridges -All gateways which provides the Homematic BIN- or XML-RPC API: +All gateways which provide the Homematic BIN- or XML-RPC API: - CCU 1, 2 and 3 - [RaspberryMatic](https://github.com/jens-maus/RaspberryMatic) @@ -53,7 +52,7 @@ All gateways which provides the Homematic BIN- or XML-RPC API: - [Windows BidCos service](https://eq-3.de/service/downloads.html?kat=download&id=125) (included in "LAN Usersoftware" download) - [OCCU](https://github.com/eq-3/occu) -The Homematic IP Access Point **does not support** this API and and can't be used with this binding. +The Homematic IP Access Point **does not support** this API and can't be used with this binding. Homematic IP support: @@ -113,10 +112,10 @@ Gateway discovery is available: For all other gateways you have to manually add a bridge in a things file. Device discovery is supported for all gateways. The binding has a gateway type autodetection, but sometimes a gateway does not clearly notify the type. -If you are using a YAHM for example, you have to manually set the gateway type in the bride configuration to CCU. +If you are using a YAHM for example, you have to manually set the gateway type in the bridge configuration to CCU. -If autodetection can not identify the gateway, the binding uses the default gateway implementation. -The difference is, that variables, scripts and device names are not supported, everything else is the same. +If autodetection cannot identify the gateway, the binding uses the default gateway implementation. +The difference is that variables, scripts, and device names are not supported; everything else is the same. ### Automatic install mode during discovery @@ -193,7 +192,7 @@ Bridge homematic:bridge:occu [ gatewayAddress="..."] Things are all discovered automatically. -If you really like to manually configure a thing: +If you really like to manually configure a Thing: ```java Bridge homematic:bridge:ccu [ gatewayAddress="..." ] @@ -217,9 +216,9 @@ All channels have two configs: - **receiveDelay**: delays a received event **from** the Homematic gateway, duplicate events are filtered out (OH 2.2) The `receiveDelay` is handy for dimmers and roller shutters for example. -If you have a slider in a UI and you move this slider to a new position, it jumps around because the gateway sends multiple events with different positions until the final has been reached. -If you set the `receiveDelay` to some seconds, these events are filtered out and only the last position is distributed to the binding. -The disadvantage is of course, that all events for this channel are delayed. +If you have a slider in a UI and you move this slider to a new position, it jumps around because the gateway sends multiple events with different positions until the final position has been reached. +If you set the `receiveDelay` to a few seconds, these events are filtered out and only the last position is distributed to the binding. +The disadvantage is, of course, that all events for this channel are delayed. ```java Thing HM-LC-Dim1T-Pl-2 JEQ0999999 "Name" @ "Location" { @@ -231,8 +230,8 @@ The disadvantage is of course, that all events for this channel are delayed. } ``` -The `Type` is the device type, channel number and UPPERCASE channel name separated with an underscore. -Note that, for Homegear devices, in contrast to the specification of the Thing above no `HG-` prefix is needed for the specification of the Type of the Channel. +The `Type` is the device type, channel number, and UPPERCASE channel name separated with an underscore. +Note that for Homegear devices, in contrast to the specification of the Thing above, no `HG-` prefix is needed for the specification of the type of the channel. The channel configs are optional. @@ -310,12 +309,12 @@ A virtual datapoint (Switch) to remove the device from the gateway, available in A virtual datapoint (Enum) to configure the device deletion with DELETE_MODE, available in channel 0 for each device -- **LOCKED:** (default) device can not be deleted +- **LOCKED:** (default) device cannot be deleted - **RESET:** device is reset to factory settings before deleting - **FORCE:** device is also deleted if it is not reachable -- **DEFER:** if the device can not be reached, it is deleted at the next opportunity +- **DEFER:** if the device cannot be reached, it is deleted at the next opportunity -**Note:** if you change the value and don't delete the device, the virtual datapoints resets to LOCKED after 30 seconds +**Note:** if you change the value and don't delete the device, the virtual datapoint resets to LOCKED after 30 seconds ### ON_TIME_AUTOMATIC @@ -358,7 +357,7 @@ You have several additional options to control the display. - SYMBOL _(BULB, SWITCH, WINDOW, DOOR, BLIND, SCENE, PHONE, BELL, CLOCK, ARROW_UP, ARROW_DOWN)_ - display symbols, multiple symbols possible You can combine any option, they must be separated by a comma. -If you specify more than one option for BEEP, BACKLIGHT and UNIT, only the first one is taken into account and all others are ignored. For SYMBOL you can specify multiple options. +If you specify more than one option for BEEP, BACKLIGHT, and UNIT, only the first one is taken into account and all others are ignored. For SYMBOL you can specify multiple options. **Examples:** @@ -678,8 +677,8 @@ Var_1.refresh :::: -**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS thing is currently not supported. -You have to delete the thing, start a scan and add it again. +**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS Thing is currently not supported. +You have to delete the Thing, start a scan and add it again. **`openhab.log` contains an exception with message: `Buffering capacity 2097152 exceeded` resp. discovery detects no devices** diff --git a/bundles/org.openhab.binding.homewizard/README.md b/bundles/org.openhab.binding.homewizard/README.md index e023b37bc2b4e..d277603c1a1bf 100644 --- a/bundles/org.openhab.binding.homewizard/README.md +++ b/bundles/org.openhab.binding.homewizard/README.md @@ -4,18 +4,17 @@ The HomeWizard binding provides access to several HomeWizard devices by using th ## Installation -There are two important points of attention: +There are two important points to note: 1. For API v1, the local API of each device must be enabled. -1. For API v2, a bearer token needs to be obtained from the device. - -See for a more detailed description of the API and for instructions how to enable/use the API versions. +1. For API v2, a bearer token needs to be obtained from the device. +See for a more detailed description of the API and for instructions on how to enable/use the API versions. ### Fixed Address -The devices support mDNS discovery but the binding does not support that yet. -As a result the devices should be reachable through a hostname or a fixed IP address. +The devices support mDNS discovery, but the binding does not support that yet. +As a result, the devices should be reachable through a hostname or a fixed IP address. Since the devices themselves have no option to set a fixed IP address you will need a different solution, for instance having your router hand out an IP address based upon the MAC address of the devices. ## Supported Things @@ -25,12 +24,12 @@ The binding offers Things, providing access to all the supported HomeWizard devi | Thing | Device | Description | |---------------|---------------------|-----------------------------------------------------------------------------------------------------| | hwe-p1 | P1 Meter | Reads total and current energy usage and total gas usage (v1 and v2). | -| hwe-skt | Energy Socket | Reads total and current energy usage. Controls power switch, lock and ring brightness (v1). | +| hwe-skt | Energy Socket | Reads total and current energy usage. Controls power switch, lock, and ring brightness (v1). | | hwe-wtr | Watermeter | Reads total and current water usage (v1). | | hwe-kwh | kWh Meter | Reads total and current energy usage (v1). | | hwe-bat | Plug-In Battery | Reads total and current energy usage and the current charge (v2). | | p1_wifi_meter | Wi-Fi P1 Meter | [Deprecated] Reads total and current energy usage and total gas usage. | -| energy_socket | Wi-Fi Energy Socket | [Deprecated] Reads total and current energy usage. Controls power switch, lock and ring brightness. | +| energy_socket | Wi-Fi Energy Socket | [Deprecated] Reads total and current energy usage. Controls power switch, lock, and ring brightness.| | watermeter | Wi-Fi Watermeter | [Deprecated] Reads total and current water usage. | ## Discovery @@ -71,8 +70,8 @@ For DSMR5 meters this is generally once per second, for older versions the frequ | energy_import_t1 | Number:Energy | This channel provides the energy usage meter reading for tariff 1 in kWh. | hwe-p1 | | energy_import_t2 | Number:Energy | This channel provides the energy usage meter reading for tariff 2 in kWh. | hwe-p1 | | energy_export | Number:Energy | This channel provides the total energy feed-in meter reading in kWh. | hwe-p1, hwe-skt, hwe-kwh, hwe-bat | -| energy_export_t1 | Number:Energy | This channel provides the energy feed-in meter reading for tarff 1 in kWh. | hwe-p1 | -| energy_export_t2 | Number:Energy | This channel provides the energy feed-in meter reading for tarff 2 in kWh. | hwe-p1 | +| energy_export_t1 | Number:Energy | This channel provides the energy feed-in meter reading for tariff 1 in kWh. | hwe-p1 | +| energy_export_t2 | Number:Energy | This channel provides the energy feed-in meter reading for tariff 2 in kWh. | hwe-p1 | | reactive_power | Number | This channel provides the active reactive power in Volt-Ampere reactive. | hwe-p1, hwe-skt, hwe-kwh | | apparent_power | Number | This channel provides the active apparent power in Volt-Ampere. | hwe-p1, hwe-skt, hwe-kwh | | power_factor | Number:Dimensionless | This channel provides the active power factor. | hwe-p1, hwe-skt, hwe-kwh | diff --git a/bundles/org.openhab.binding.hpprinter/README.md b/bundles/org.openhab.binding.hpprinter/README.md index 3f27e068bd82b..204b66d7eb680 100644 --- a/bundles/org.openhab.binding.hpprinter/README.md +++ b/bundles/org.openhab.binding.hpprinter/README.md @@ -4,7 +4,7 @@ This binding supports [HP Printers](https://store.hp.com/us/en/cv/printers), whi ## Supported Things -There is only one thing type named `printer`. +There is only one Thing type named `printer`. All channels are added dynamically depending on the type of printer and its capabilities. ## Discovery @@ -77,7 +77,7 @@ Notes: - All channels are dynamically added at runtime. - The word color in channel names follows American spelling ("color"). -- The `colorLevel`, `colorMarkingUsed` and `colorPagesRemaining` channels are used on printers that have only a single color cartridge instead of separate Ccyan, magenta and yellow cartridges. +- The `colorLevel`, `colorMarkingUsed`, and `colorPagesRemaining` channels are used on printers that have only a single color cartridge instead of separate cyan, magenta, and yellow cartridges. - The `scanner` group is for the scanning engine which consists of scan, copy and other operations; the `scan` group is for scanner operations only. - If no `status` group channels are selected, then those relevant data endpoints on the _Embedded Web Server_ are not polled for status information. diff --git a/bundles/org.openhab.binding.http/README.md b/bundles/org.openhab.binding.http/README.md index 7993d22921b92..4046c8e988d70 100644 --- a/bundles/org.openhab.binding.http/README.md +++ b/bundles/org.openhab.binding.http/README.md @@ -4,28 +4,28 @@ This binding allows using HTTP to bring external data into openHAB or execute HT ## Supported Things -Only one thing named `url` is available. +Only one Thing named `url` is available. It can be extended with different channels. ## Thing Configuration | parameter | optional | default | description | |-----------------------|----------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `baseURL` | no | - | The base URL (including protocol `http://` or `https://`) for this thing. Can be extended in channel-configuration. | -| `refresh` | no | 30 | Time in seconds between two refresh calls for the channels of this thing. | +| `baseURL` | no | - | The base URL (including protocol `http://` or `https://`) for this Thing. Can be extended in channel-configuration. | +| `refresh` | no | 30 | Time in seconds between two refresh calls for the channels of this Thing. | | `timeout` | no | 3000 | Timeout for HTTP requests in ms. | | `bufferSize` | no | 2048 | The buffer size for the response data (in kB). | | `delay` | no | 0 | Delay between two requests in ms (advanced parameter). | | `username` | yes | - | Username for authentication (advanced parameter). | -| `password` | yes | - | Password for authentication (advanced parameter). Also used for the authentication token when using `TOKEN` authentication. | -| `authMode` | no | BASIC | Authentication mode, `BASIC`, `BASIC_PREEMPTIVE`, `TOKEN` or `DIGEST` (advanced parameter). | +| `password` | yes | - | Password for authentication (advanced parameter). Also used for the authentication token when using `TOKEN` authentication. | +| `authMode` | no | BASIC | Authentication mode: `BASIC`, `BASIC_PREEMPTIVE`, `TOKEN`, or `DIGEST` (advanced parameter). | | `stateMethod` | no | GET | Method used for requesting the state: `GET`, `PUT`, `POST`. | | `commandMethod` | no | GET | Method used for sending commands: `GET`, `PUT`, `POST`. | -| `contentType` | yes | - | MIME content-type of the command requests. Only used for `PUT` and `POST`. | +| `contentType` | yes | - | MIME content-type of the command requests. Only used for `PUT` and `POST`. | | `encoding` | yes | - | Encoding to be used if no encoding is found in responses (advanced parameter). | -| `headers` | yes | - | Additional headers that are sent along with the request. Format is "header=value". Multiple values can be stored as `headers="key1=value1", "key2=value2", "key3=value3",` | +| `headers` | yes | - | Additional headers that are sent along with the request. Format is "header=value". Multiple values can be stored as `headers="key1=value1", "key2=value2", "key3=value3"`. | | `ignoreSSLErrors` | no | false | If set to true, ignores invalid SSL certificate errors. This is potentially dangerous. | -| `strictErrorHandling` | no | false | If set to true, thing status is changed depending on last request result (failed = `OFFLINE`). Failed requests result in `UNDEF` for channel values. | +| `strictErrorHandling` | no | false | If set to true, Thing status is changed depending on last request result (failed = `OFFLINE`). Failed requests result in `UNDEF` for channel values. | | `userAgent` | yes | (yes ) | Sets a custom user agent (default is "Jetty/version", e.g. "Jetty/9.4.20.v20190813"). | _Note:_ Optional "no" means that you have to configure a value unless a default is provided, and you are ok with that setting. @@ -33,7 +33,7 @@ _Note:_ Optional "no" means that you have to configure a value unless a default _Note:_ The `BASIC_PREEMPTIVE` mode adds basic authentication headers even if the server did not request authentication. This is dangerous and might be misused. The option exists to be able to authenticate when the server is not sending the proper 401/Unauthorized code. -Authentication might fail if redirections are involved as headers are stripper prior to redirection. +Authentication might fail if redirections are involved as headers are stripped prior to redirection. _Note:_ If you rate-limit requests by using the `delay` parameter you have to make sure that the time between two refreshes is larger than the time needed for one refresh cycle. @@ -43,9 +43,9 @@ When automatic encoding is not possible (e.g. because you need to include an enc ## Channels -The thing has two channels of type `request-date-time` which provide the timestamp of the last successful (`last-success`) and last failed (`last-failure`) request. +The Thing has two channels of type `request-date-time` which provide the timestamp of the last successful (`last-success`) and last failed (`last-failure`) request. -Additionally, the thing can be extended with data channels. +Additionally, the Thing can be extended with data channels. Each item type has its own channel-type. Depending on the channel-type, channels have different configuration options. All channel-types (except `image`) have `stateExtension`, `commandExtension`, `stateTransformation`, `commandTransformation` and `mode` parameters. diff --git a/bundles/org.openhab.binding.hue/README.md b/bundles/org.openhab.binding.hue/README.md index 68f3f7743ea53..9c6962a07f857 100644 --- a/bundles/org.openhab.binding.hue/README.md +++ b/bundles/org.openhab.binding.hue/README.md @@ -11,28 +11,28 @@ The Hue Bridge is required as a "bridge" for accessing any other Hue device. It supports the Zigbee Light Link protocol as well as the upwards compatible Zigbee 3.0 protocol. There are two types of Hue Bridges, generally referred to as v1 (the rounded version) and v2 (the squared version). The difference between the two generations of bridges is that the v2 bridge added support for Apple HomeKit and the CLIP v2 API [see next paragraph](#api-versions). -Both bridges are fully supported by this binding. +Both bridge types are fully supported by this binding. Almost all available Hue devices are supported by this binding. This includes not only the "Friends of Hue", but also products like the LivingWhites adapter. Additionally, it is possible to use OSRAM Lightify devices as well as other Zigbee Light Link compatible products, including the IKEA TRÅDFRI lights (when updated). -Beside bulbs and luminaires the Hue binding also supports some Zigbee sensors. -Currently only Hue specific sensors are tested successfully (Hue Motion Sensor and Hue Dimmer Switch). +Besides bulbs and luminaires, the Hue binding also supports some Zigbee sensors. +Currently, only Hue-specific sensors are tested successfully (Hue Motion Sensor and Hue Dimmer Switch). Please note that the devices need to be registered with the Hue Bridge before it is possible for this binding to use them. ## API Versions Bridges are accessed by means of the "CLIP" ('Connected Lighting Interface Protocol') Application Program Interface ('API'). -There are two versions of CLIP - namely CLIP v1 and CLIP v2, which are referred to as API v1 and API v2 in the links below. +There are two versions of CLIP—namely CLIP v1 and CLIP v2, which are referred to as API v1 and API v2 in the links below. Signify has stated that any new features (such as dynamic scenes) will only be available on API v2, and in the long term API v1 will eventually be removed. -The API v2 has more features, e.g. it supports Server Sent Events 'SSE' which means that it is much faster to receive status updates in openHAB. +The API v2 has more features, e.g., it supports Server Sent Events (SSE), which means that it is much faster to receive status updates in openHAB. For this reason it is recommended to use API v2 for new openHAB installations. But unfortunately the API v2 is not supported by older v1 (round) bridges, nor by newer v2 (square-ish) bridges if their firmware is under v1948086000. ## Discovery The Hue Bridge is discovered through mDNS in the local network. -Potentially two types of Bridge will be discovered - namely an API v1 Bridge and/or an API v2 Bridge. +Potentially, two types of bridges will be discovered—namely an API v1 Bridge and/or an API v2 Bridge. Auto-discovery is enabled by default. To disable it, you can add the following line to `/services/runtime.cfg`: @@ -58,17 +58,17 @@ You might also need to edit the names and types of your items, depending on the ### Migration via Automatic Discovery Services -When new API v2 things are created via the discovery services, then if a matching legacy API v1 thing exists, the new v2 thing will clone some of the the attributes of the existing API v1 thing. -And also, if a legacy API v1 thing exists and has items linked to its channels, then the new API v2 thing will replicate the links between those items and the respective new API v2 thing's channels. +When new API v2 things are created via the discovery services, then if a matching legacy API v1 Thing exists, the new v2 Thing will clone some of the attributes of the existing API v1 Thing. +And also, if a legacy API v1 Thing exists and has items linked to its channels, then the new API v2 Thing will replicate the links between those items and the respective new API v2 Thing's channels. ### Migration via a `.things` File -You need to manually edit your bridge and thing definitions as shown below: +You need to manually edit your bridge and Thing definitions as shown below: - Bridge definitions change from `hue:bridge:bridgename` to `hue:bridge-api2:bridgename`. - Bridge configuration parameters change `userName` to `applicationKey`. -- Physical thing definitions change from `hue:0100:thingname` or `hue:0210:thingname` etc. to `hue:device:thingname`. -- Room or zone thing definitions change from `hue:group:thingname` to `hue:room:thingname` resp. `hue:zone:thingname`. +- Physical Thing definitions change from `hue:0100:thingname` or `hue:0210:thingname` etc. to `hue:device:thingname`. +- Room or zone Thing definitions change from `hue:group:thingname` to `hue:room:thingname` resp. `hue:zone:thingname`. - Thing configuration parameters change from `lightId` or `sensorId` etc. to `resourceId`. Notes: diff --git a/bundles/org.openhab.binding.huesync/README.md b/bundles/org.openhab.binding.huesync/README.md index 9e95c5136794f..5983245ffd183 100644 --- a/bundles/org.openhab.binding.huesync/README.md +++ b/bundles/org.openhab.binding.huesync/README.md @@ -20,8 +20,8 @@ The integration happens directly through the Hue [HDMI Sync Box API](https://dev ## Supported Things -This binding provides only one thing type: **`box`**. -Each thing will represent a Hue Play HDMI sync box. +This binding provides only one Thing type: **`box`**. +Each Thing will represent a Hue Play HDMI sync box. ## Discovery @@ -50,11 +50,11 @@ If the device is not discovered you can check if it is properly configured and d

mDNS uses link-local multicast addresses; its scope is limited to a single physical or logical LAN ([Layer 3](https://en.wikipedia.org/wiki/OSI_model#Layer_3:_Network_layer")). -If your device is not automatically discovered, create a thing and manually configure the "host" parameter. +If your device is not automatically discovered, create a Thing and manually configure the "host" parameter. -To communicate with the sync box, you need to couple the thing with the hardware (registration). -The thing will start this process automatically. -To complete the registration you just press the "coupling" button on the sync box for 3 seconds.: +To communicate with the sync box, you need to couple the Thing with the hardware (registration). +The Thing will start this process automatically. +To complete the registration, simply press the "coupling" button on the sync box for 3 seconds: ![Device Registration](doc/device_registration.png) @@ -85,7 +85,7 @@ Information about the installed device firmware and available updates. ### HDMI connections [in\|out] -Information about a HDMI input connection. +Information about an HDMI input connection. | Channel | Type | Read/Write | Description | | ------- | ------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/bundles/org.openhab.binding.hydrawise/README.md b/bundles/org.openhab.binding.hydrawise/README.md index c0468f6345c06..266ca014004fb 100644 --- a/bundles/org.openhab.binding.hydrawise/README.md +++ b/bundles/org.openhab.binding.hydrawise/README.md @@ -8,8 +8,8 @@ The Hydrawise binding allows monitoring and control of [Hunter Industries's](htt - `account`: Bridge type represents the user's account on the Hydrawise cloud service. The bridge can have one or more child [Controllers](#controller-thing) linked. An account must be manually added and configured. -- `controller` Things are automatically discovered once an account Bridge is properly configured.[more details](#local-thing) -- `local` Things uses an undocumented API that allows direct HTTP access to an irrigation controller on the user's network. [more details](#local-thing) +- `controller` Things are automatically discovered once an account Bridge is properly configured. [more details](#local-thing) +- `local` Things use an undocumented API that allows direct HTTP access to an irrigation controller on the user's network. [more details](#local-thing) ### `controller` Thing @@ -21,15 +21,15 @@ Controller Things require a parent `account` Bridge ### `local` Thing The Local Thing type uses an undocumented API that allows direct HTTP access to an irrigation controller on the user's network. -This provides a subset of features compared to the Cloud Thing type limited to basic zone control. +This provides a subset of features compared to the Cloud Thing type, limited to basic zone control. Controlling zones through the local API will not be reported back to the cloud service or the Hydrawise mobile/web applications, and reporting functionality will not reflect the locally controlled state. Local control may not be available on later Hydrawise controller firmware versions. Use Cases -- The Local thing can be useful when testing zones, as there is no delay when starting/stopping zones as compared to the cloud API which can take anywhere between 5-15 seconds. -- This is also useful if you wish to not use the cloud scheduling at all and use openHAB as the irrigation scheduling system. +- The Local Thing can be useful when testing zones, as there is no delay when starting/stopping zones as compared to the cloud API, which can take anywhere between 5-15 seconds. +- This is also useful if you wish to not use the cloud scheduling at all and use openHAB as the irrigation scheduling system. ## Thing Configuration @@ -39,7 +39,7 @@ Use Cases |--------------------|---------|----------|---------------------------------------------------------------------------------------------------------------------------| | userName | String | False | The Hydrawise account user name | | password | String | False | The Hydrawise account password | -| savePassword | Boolean | False | By default the password will be not be persisted after the first login attempt unless this is true, defaults to false | +| savePassword | Boolean | False | By default the password will not be persisted after the first login attempt unless this is true, defaults to false | | refresh | Integer | False | Defaults to a 60 second polling rate, more frequent polling may cause the service to deny requests | | refreshToken | Boolean | False | An oAuth refresh token, this will be automatically configured after the first login and updated as the token is refreshed | @@ -87,12 +87,12 @@ Use Cases #### Zone Channel Group -Up to 36 total zones are supported per Local or Cloud thing +Up to 36 total zones are supported per Local or Cloud Thing | channel group ID | Description | |------------------|---------------------------| | zone1 | Zone 1 channel group | -| zone2 | Zone 1 channel group | +| zone2 | Zone 2 channel group | | ... | Zone 3 - 35 channel group | | zone36 | Zone 36 channel group | diff --git a/bundles/org.openhab.binding.hyperion/README.md b/bundles/org.openhab.binding.hyperion/README.md index 125c5931446b1..943a53becbf30 100644 --- a/bundles/org.openhab.binding.hyperion/README.md +++ b/bundles/org.openhab.binding.hyperion/README.md @@ -14,13 +14,14 @@ The binding itself does not require any special configuration. ## Discovery -Automatic background discovery only works for Hyperion.ng servers as they advertise using mDNS. You must manually configure a Hyperion Server V1 either through a UI / REST or .things file. +Automatic background discovery only works for Hyperion.ng servers as they advertise using mDNS. You must manually configure a Hyperion Server V1 either through a UI/REST or `.things` file. ## Thing Configuration ### Hyperion Server (V1) -In order to use a Hyperion Server it must be properly configured. You can do this either through a UI / REST or through static .thing files. +In order to use a Hyperion Server, it must be properly configured. +You can do this either through a UI/REST or through static `.things` files. | Parameter | Data type | Required | Example | |----------------|-----------|----------|----------------| @@ -31,7 +32,7 @@ In order to use a Hyperion Server it must be properly configured. You can do th To manually configure a Hyperion Server you must specify the following parameters: host, port, priority and polling frequency. -In the thing file, this looks for e.g. like +In the Thing file, this looks for e.g. like ```java Thing hyperion:serverV1:myServer [ host="192.168.0.10", port=19444, priority=50, poll_frequency=15] @@ -39,7 +40,8 @@ Thing hyperion:serverV1:myServer [ host="192.168.0.10", port=19444, priority=50, ### Hyperion.ng Server -In order to use a Hyperion.ng Server it must be properly configured. You can do this either through a UI / REST or through static .thing files. +In order to use a Hyperion.ng Server, it must be properly configured. +You can do this either through a UI/REST or through static `.things` files. | Parameter | Data type | Required | Example | |----------------|-----------|----------|----------------| diff --git a/bundles/org.openhab.binding.iammeter/README.md b/bundles/org.openhab.binding.iammeter/README.md index dad6a225bdbf6..09c96408f094f 100644 --- a/bundles/org.openhab.binding.iammeter/README.md +++ b/bundles/org.openhab.binding.iammeter/README.md @@ -4,7 +4,7 @@ ## Use of the binding -The Iammeter is exposed as one thing with a number of channels that can be used to read the values for different aspects of your Iammeter devices. +The Iammeter is exposed as one Thing with a number of channels that can be used to read the values for different aspects of your Iammeter devices. ## Setup of the binding @@ -21,7 +21,7 @@ Single-phase energy meter (WEM3080/WEM3162) | voltage_a | V | Voltage | Number:ElectricPotential | | current_a | A | Current | Number:ElectricCurrent | | power_a | W | Active power | Number:Power | -| importenergy_a | kWh | Energy consumption from gird | Number:Energy | +| importenergy_a | kWh | Energy consumption from grid | Number:Energy | | exportgrid_a | kWh | Energy export to grid | Number:Energy | Three-phase energy meter (WEM3080T) @@ -33,22 +33,22 @@ Three-phase energy meter (WEM3080T) | power_a | W | A phase active power | Number:Power | | importenergy_a | kWh | A phase import energy | Number:Energy | | exportgrid_a | kWh | A phase export energy | Number:Energy | -| frequency_a | kWh | A phase frequency | Number:Frequency | -| pf_a | kWh | A phase power factor | Number | +| frequency_a | Hz | A phase frequency | Number:Frequency | +| pf_a | | A phase power factor | Number | | voltage_b | V | B phase voltage | Number:ElectricPotential | | current_b | A | B phase current | Number:ElectricCurrent | | power_b | W | B phase active power | Number:Power | | importenergy_b | kWh | B phase import energy | Number:Energy | | exportgrid_b | kWh | B phase export energy | Number:Energy | -| frequency_b | kWh | B phase frequency | Number:Frequency | -| pf_b | kWh | B phase power factor | Number | +| frequency_b | Hz | B phase frequency | Number:Frequency | +| pf_b | | B phase power factor | Number | | voltage_c | V | C phase voltage | Number:ElectricPotential | | current_c | A | C phase current | Number:ElectricCurrent | | power_c | W | C phase active power | Number:Power | | importenergy_c | kWh | C phase import energy | Number:Energy | | exportgrid_c | kWh | C phase export energy | Number:Energy | -| frequency_c | kWh | C phase frequency | Number:Frequency | -| pf_c | kWh | C phase power factor | Number | +| frequency_c | Hz | C phase frequency | Number:Frequency | +| pf_c | | C phase power factor | Number | ## More information diff --git a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/addon/addon.xml index 051aa1593438e..f200a95899bed 100644 --- a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/addon/addon.xml @@ -5,7 +5,7 @@ binding Iammeter Binding - The Iammeter binding pull your Iammeter power meter data from LAN. + The Iammeter binding pulls your Iammeter power meter data from LAN. local diff --git a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/i18n/iammeter.properties b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/i18n/iammeter.properties index 5d7ebd37562e3..020bfe2c8829e 100644 --- a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/i18n/iammeter.properties +++ b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/i18n/iammeter.properties @@ -1,14 +1,14 @@ # add-on addon.iammeter.name = Iammeter Binding -addon.iammeter.description = The Iammeter binding pull your Iammeter power meter data from LAN. +addon.iammeter.description = The Iammeter binding pulls your Iammeter power meter data from LAN. # thing types thing-type.iammeter.powermeter.label = Iammeter Power Meter 3162/3080 thing-type.iammeter.powermeter.description = Single phase PowerMeter for Iammeter Binding thing-type.iammeter.powermeter3080T.label = Iammeter Power Meter 3080T -thing-type.iammeter.powermeter3080T.description = 3 phases PowerMeter for Iammeter 3080T Binding +thing-type.iammeter.powermeter3080T.description = Three-phase power meter for Iammeter 3080T thing-type.iammeter.powermeter3080T.group.powerPhaseA.label = Power Phase A thing-type.iammeter.powermeter3080T.group.powerPhaseA.description = Power phase 1 for Iammeter device thing-type.iammeter.powermeter3080T.group.powerPhaseB.label = Power Phase B @@ -35,26 +35,26 @@ channel-group-type.iammeter.powerPhaseGroup.label = Power Phase # channel types channel-type.iammeter.current.label = Current -channel-type.iammeter.current.description = current for phase A +channel-type.iammeter.current.description = Current for phase A channel-type.iammeter.current.label = Current -channel-type.iammeter.current.description = current for phase A -channel-type.iammeter.exportgrid.label = Exportgrid -channel-type.iammeter.exportgrid.description = exportgrid for phase A -channel-type.iammeter.exportgrid.label = Exportgrid -channel-type.iammeter.exportgrid.description = exportgrid for phase A +channel-type.iammeter.current.description = Current for phase A +channel-type.iammeter.exportgrid.label = Export Energy +channel-type.iammeter.exportgrid.description = Export energy for phase A +channel-type.iammeter.exportgrid.label = Export Energy +channel-type.iammeter.exportgrid.description = Export energy for phase A channel-type.iammeter.frequency.label = Frequency -channel-type.iammeter.frequency.description = frequency for phase A -channel-type.iammeter.importenergy.label = ImportEnergy -channel-type.iammeter.importenergy.description = importenergy for phase A -channel-type.iammeter.importenergy.label = ImportEnergy -channel-type.iammeter.importenergy.description = importenergy for phase A +channel-type.iammeter.frequency.description = Frequency for phase A +channel-type.iammeter.importenergy.label = Import Energy +channel-type.iammeter.importenergy.description = Import energy for phase A +channel-type.iammeter.importenergy.label = Import Energy +channel-type.iammeter.importenergy.description = Import energy for phase A channel-type.iammeter.pf.label = Power Factor -channel-type.iammeter.pf.description = power factor for phase A +channel-type.iammeter.pf.description = Power factor for phase A channel-type.iammeter.power.label = Power -channel-type.iammeter.power.description = power for phase A +channel-type.iammeter.power.description = Power for phase A channel-type.iammeter.power.label = Power -channel-type.iammeter.power.description = power for phase A +channel-type.iammeter.power.description = Power for phase A channel-type.iammeter.voltage.label = Voltage -channel-type.iammeter.voltage.description = voltage for phase A +channel-type.iammeter.voltage.description = Voltage for phase A channel-type.iammeter.voltage.label = Voltage -channel-type.iammeter.voltage.description = voltage for phase A +channel-type.iammeter.voltage.description = Voltage for phase A diff --git a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080.xml b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080.xml index fe90aabb9bfcb..3f94c8c3e5d38 100644 --- a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080.xml +++ b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080.xml @@ -21,7 +21,7 @@ Number:ElectricPotential - voltage for phase A + Voltage for phase A Measurement Voltage @@ -31,7 +31,7 @@ Number:ElectricCurrent - current for phase A + Current for phase A Measurement Current @@ -41,7 +41,7 @@ Number:Power - power for phase A + Power for phase A Measurement Power @@ -50,8 +50,8 @@ Number:Energy - - importenergy for phase A + + Import energy for phase A Measurement Energy @@ -60,8 +60,8 @@ Number:Energy - - exportgrid for phase A + + Export energy for phase A Measurement Energy diff --git a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080T.xml b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080T.xml index d94c8860b7cb6..a212656aa0694 100644 --- a/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080T.xml +++ b/bundles/org.openhab.binding.iammeter/src/main/resources/OH-INF/thing/3080T.xml @@ -6,7 +6,7 @@ - 3 phases PowerMeter for Iammeter 3080T Binding + Three-phase power meter for Iammeter 3080T ElectricMeter @@ -39,7 +39,7 @@ Number:ElectricPotential - voltage for phase A + Voltage for phase A Measurement Voltage @@ -49,7 +49,7 @@ Number:ElectricCurrent - current for phase A + Current for phase A Measurement Current @@ -59,7 +59,7 @@ Number:Power - power for phase A + Power for phase A Measurement Power @@ -68,8 +68,8 @@ Number:Energy - - importenergy for phase A + + Import energy for phase A Measurement Energy @@ -78,8 +78,8 @@ Number:Energy - - exportgrid for phase A + + Export energy for phase A Measurement Energy @@ -89,13 +89,13 @@ Number:Frequency - frequency for phase A + Frequency for phase A Number - power factor for phase A + Power factor for phase A diff --git a/bundles/org.openhab.binding.iaqualink/README.md b/bundles/org.openhab.binding.iaqualink/README.md index 2bf91eec455cb..75b45a0a044b6 100644 --- a/bundles/org.openhab.binding.iaqualink/README.md +++ b/bundles/org.openhab.binding.iaqualink/README.md @@ -9,7 +9,7 @@ This binding supports: ## Binding Configuration The binding requires the iAquaLink user name and password. -If you have more then one pool system registered to an account, you may optionally specify the pool serial ID/Number to use, otherwise the first pool controller will be used. +If you have more than one pool system registered to an account, you may optionally specify the pool serial ID/Number to use, otherwise the first pool controller will be used. ## Manual Thing Configuration @@ -23,7 +23,7 @@ The following is a list of supported channels. Auxiliary and OneTouch channels will be dynamically added depending on what a system reports as being supported. Auxiliary channels that are of a number type represent lighting modes (typically 0-15). -Auxiliary channels that are dimmer types can set the light value in increments of 25 (0,25,50,750,100). +Auxiliary channels that are dimmer types can set the light value in increments of 25 (0,25,50,75,100). The Auxiliary channel type will be dynamically assigned based on the controller configuration. Heater status can be OFF (0), Enabled/ON (3), or Heating (1). @@ -106,7 +106,7 @@ Number:Temperature AquaLinkSpaSetpoint "Spa Setpoint [%d]" (Group_AquaLink) {cha Number:Temperature AquaLinkPoolSetpoint "Pool Setpoint [%d]" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_set_point"} Switch AquaLinkSpaPump "Spa Pump" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_pump"} -Switch AquaLinkPoolPump"Pool Pump" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_pump"} +Switch AquaLinkPoolPump "Pool Pump" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_pump"} Number AquaLinkSpaHeaterStatus "Spa Heater [%s]" (Group_AquaLink) {channel="iaqualink:controller:pool:spa_heater_status"} Number AquaLinkPoolHeaterStatus "Pool Heater [%s]" (Group_AquaLink) {channel="iaqualink:controller:pool:pool_heater_status"} diff --git a/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/addon/addon.xml b/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/addon/addon.xml index a07e14bd8828c..a7c16ad2af798 100644 --- a/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/addon/addon.xml +++ b/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/addon/addon.xml @@ -5,6 +5,6 @@ binding iAquaLink Binding - This is the binding for a iAquaLink pool controller. + This is the binding for an iAquaLink pool controller. cloud diff --git a/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/i18n/iaqualink.properties b/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/i18n/iaqualink.properties index d3dd4cadefbf3..6bd7956e187dc 100644 --- a/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/i18n/iaqualink.properties +++ b/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/i18n/iaqualink.properties @@ -18,7 +18,7 @@ thing-type.iaqualink.controller.channel.orp.description = Orp thing-type.iaqualink.controller.channel.ph.label = PH thing-type.iaqualink.controller.channel.ph.description = PH thing-type.iaqualink.controller.channel.pool_heater.label = Pool Heater Switch -thing-type.iaqualink.controller.channel.pool_heater.description = Pool heater Switch +thing-type.iaqualink.controller.channel.pool_heater.description = Pool heater switch thing-type.iaqualink.controller.channel.pool_heater_status.label = Pool Heater Status thing-type.iaqualink.controller.channel.pool_heater_status.description = Pool heater status thing-type.iaqualink.controller.channel.pool_pump.label = Pool Pump @@ -55,7 +55,7 @@ thing-type.config.iaqualink.controller.password.description = The password to us thing-type.config.iaqualink.controller.refresh.label = Refresh Interval thing-type.config.iaqualink.controller.refresh.description = Specifies the refresh interval in seconds thing-type.config.iaqualink.controller.serialId.label = Serial Number -thing-type.config.iaqualink.controller.serialId.description = Optionally specify the serial number of the controller which can be found on the iAquaLink Owner's Center. This is only useful if you have more then one controller (pool) associated with your account. Leave blank to have the first controller used. +thing-type.config.iaqualink.controller.serialId.description = Optionally specify the serial number of the controller which can be found on the iAquaLink Owner's Center. This is only useful if you have more than one controller (pool) associated with your account. Leave blank to have the first controller used. thing-type.config.iaqualink.controller.userName.label = User Name thing-type.config.iaqualink.controller.userName.description = The user name to use when connecting to an iAqualink Account diff --git a/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/thing/iAqualink.xml b/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/thing/iAqualink.xml index eec31f5e15394..a589dfac52356 100644 --- a/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/thing/iAqualink.xml +++ b/bundles/org.openhab.binding.iaqualink/src/main/resources/OH-INF/thing/iAqualink.xml @@ -62,7 +62,7 @@ - Pool heater Switch + Pool heater switch @@ -107,7 +107,7 @@ Optionally specify the serial number of the controller which can be found on the iAquaLink Owner's - Center. This is only useful if you have more then one controller (pool) associated with your account. Leave blank + Center. This is only useful if you have more than one controller (pool) associated with your account. Leave blank to have the first controller used. @@ -134,7 +134,7 @@ String - System Type + System Type diff --git a/bundles/org.openhab.binding.icalendar/README.md b/bundles/org.openhab.binding.icalendar/README.md index 0d3189e84f048..d24d99766c206 100644 --- a/bundles/org.openhab.binding.icalendar/README.md +++ b/bundles/org.openhab.binding.icalendar/README.md @@ -6,7 +6,7 @@ Furthermore it is possible to embed `command tags` in the calendar event descrip ## Supported Things -The primary thing type is the calendar. +The primary Thing type is the calendar. It is based on a single iCalendar file and implemented as bridge. There can be multiple things having different properties representing different calendars. @@ -17,7 +17,7 @@ Standard time-based filtering is done by each event's start, but it can also be ### Configuration for `calendar` -Each `calendar` thing requires the following configuration parameters: +Each `calendar` Thing requires the following configuration parameters: | parameter name | description | optional | |---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| @@ -31,7 +31,7 @@ Each `calendar` thing requires the following configuration parameters: ### Configuration for `eventfilter` -Each `eventfilter` thing requires a bridge of type `calendar` and has following configuration options: +Each `eventfilter` Thing requires a bridge of type `calendar` and has following configuration options: | parameter name | description | optional | |------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| @@ -115,13 +115,13 @@ See openHAB Core definitions for [command types](https://www.openhab.org/docs/co The `Authorization_Code` may _optionally_ be used as follows: -- When the thing configuration parameter `authorizationCode` is not blank, the binding will compare the `Authorization_Code` field against the `authorizationCode` configuration parameter, and it will only execute the command if the two strings are the same. +- When the Thing configuration parameter `authorizationCode` is not blank, the binding will compare the `Authorization_Code` field against the `authorizationCode` configuration parameter, and it will only execute the command if the two strings are the same. -- When the thing configuration parameter `authorizationCode` is blank, the binding will NOT check this `Authorization_Code` field, and so it will always execute the command. +- When the Thing configuration parameter `authorizationCode` is blank, the binding will NOT check this `Authorization_Code` field, and so it will always execute the command. ## Full Example -All required information must be provided in the thing definition, either via UI or in the `.things` file.. +All required information must be provided in the Thing definition, either via UI or in the `.things` file.. ```java Bridge icalendar:calendar:deadbeef "My calendar" @ "Internet" [ url="http://example.org/calendar.ical", refreshTime=60 ] diff --git a/bundles/org.openhab.binding.icloud/README.md b/bundles/org.openhab.binding.icloud/README.md index 339388777bb62..8e47c005c7e07 100644 --- a/bundles/org.openhab.binding.icloud/README.md +++ b/bundles/org.openhab.binding.icloud/README.md @@ -30,9 +30,9 @@ The account can be connected to multiple Apple devices which are represented as You may create multiple account Things for multiple accounts. If your Apple account has 2-factor-authentication enabled configuration requires two steps. -First start by adding the Apple ID and password to your account thing configuration. +First start by adding the Apple ID and password to your account Thing configuration. You will receive a notification with a code on one of your Apple devices then. -Add this code to the code parameter of the thing then and wait. +Add this code to the code parameter of the Thing then and wait. The binding should be reinitialized and perform the authentication. ### Device Thing diff --git a/bundles/org.openhab.binding.ihc/README.md b/bundles/org.openhab.binding.ihc/README.md index 58fcf4b6ed3a8..43197a8fab6d3 100644 --- a/bundles/org.openhab.binding.ihc/README.md +++ b/bundles/org.openhab.binding.ihc/README.md @@ -28,7 +28,7 @@ The `controller` Thing has the following configuration parameters: | timeout | Timeout in milliseconds to communicate to IHC / ELKO controller. | no | 5000 | | loadProjectFile | Load project file from controller. | no | true | | createChannelsAutomatically | Create channels automatically from project file. Project file loading parameter should be enabled as well. | no | true | -| tlsVersion | TLS version used for controller communication. Choose `TLSv1` for older firmware versions and `TLSv1.2` for never versions (since fall 2021). `AUTO` mode try to recognize correct version. | no | TLSv1 | +| tlsVersion | TLS version used for controller communication. Choose `TLSv1` for older firmware versions and `TLSv1.2` for newer versions (since fall 2021). `AUTO` mode try to recognize correct version. | no | TLSv1 | ## Channels @@ -207,4 +207,4 @@ end ### Thing status -Check thing status for errors. +Check Thing status for errors. diff --git a/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/i18n/ihc.properties b/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/i18n/ihc.properties index a5dad79eef9ec..51f3a17ea1cb8 100644 --- a/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/i18n/ihc.properties +++ b/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/i18n/ihc.properties @@ -19,8 +19,8 @@ thing-type.config.ihc.controller.password.label = Password thing-type.config.ihc.controller.password.description = Password to login to the IHC / ELKO controller. thing-type.config.ihc.controller.timeout.label = Timeout thing-type.config.ihc.controller.timeout.description = Timeout to communicate to IHC / ELKO controller. -thing-type.config.ihc.controller.tlsVersion.label = TLS version -thing-type.config.ihc.controller.tlsVersion.description = TLS version used for controller communication. Choose TLSv1 for older firmware versions and TLSv1.2 for never versions (since fall 2021). Auto mode try to recognize correct version. +thing-type.config.ihc.controller.tlsVersion.label = TLS Version +thing-type.config.ihc.controller.tlsVersion.description = TLS version used for controller communication. Choose TLSv1 for older firmware versions and TLSv1.2 for newer versions (since fall 2021). Auto mode try to recognize correct version. thing-type.config.ihc.controller.tlsVersion.option.TLSv1 = TLSv1 thing-type.config.ihc.controller.tlsVersion.option.TLSv1.2 = TLSv1.2 thing-type.config.ihc.controller.tlsVersion.option.AUTO = Auto diff --git a/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/thing/controller.xml b/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/thing/controller.xml index 46610894ff31b..1b1ae87afdcc2 100644 --- a/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/thing/controller.xml +++ b/bundles/org.openhab.binding.ihc/src/main/resources/OH-INF/thing/controller.xml @@ -59,9 +59,9 @@ true - + TLS version used for controller communication. Choose TLSv1 for older firmware versions and TLSv1.2 for - never versions (since fall 2021). Auto mode try to recognize correct version. + newer versions (since fall 2021). Auto mode try to recognize correct version. TLSv1 diff --git a/bundles/org.openhab.binding.insteon/README.md b/bundles/org.openhab.binding.insteon/README.md index f664a73c5b9d4..15cb0b0b6e5b9 100644 --- a/bundles/org.openhab.binding.insteon/README.md +++ b/bundles/org.openhab.binding.insteon/README.md @@ -26,8 +26,8 @@ If switching from a previous release, you will need to reconfigure your Insteon You can follow the [migration guide](#migration-guide). However, the new version is fully backward compatible by supporting the legacy things. -On the first start, existing `device` things connected to a `network` bridge will be migrated to the `legacy-device` thing type while still keeping the same ids to prevent any breakage. -For textual configuration with defined thing channels, the channel types must be manually updated to the new ones by adding the `legacy` prefix and capitalizing the first letter, as shown in [these examples](#full-example). +On the first start, existing `device` things connected to a `network` bridge will be migrated to the `legacy-device` Thing type while still keeping the same ids to prevent any breakage. +For textual configuration with defined Thing channels, the channel types must be manually updated to the new ones by adding the `legacy` prefix and capitalizing the first letter, as shown in [these examples](#full-example). It is important to note that once the migration has occurred, downgrading to an older version will not be possible. ## Supported Things @@ -690,7 +690,7 @@ Now do exactly the reverse: press and hold the "Set" button on the remote device Alternatively, the binding can link a device to the modem programmatically using the `insteon modem addDevice` console command. Based on the initial set button pressed event received, the device will be linked one or both ways. -Once the newly linked device is added as a thing, additional links for more complex devices can be added using the `insteon device addMissingLinks` console command. +Once the newly linked device is added as a Thing, additional links for more complex devices can be added using the `insteon device addMissingLinks` console command. ## Insteon Devices @@ -731,7 +731,7 @@ And percent commands will trigger what is defined in the Insteon protocol as ins As far as the previously known `manualChange` channel, it has been rolled into the `rollershutter` channel for [window covering](#window-coverings) using `UP`, `DOWN` and `STOP` commands. For the `dimmer` channel, the `INCREASE` and `DECREASE` commands can be used instead. -Ultimately, the `dimmer` channel parameters can be used to create custom channels via a thing file that can work as an alternative to having to configure an Insteon scene for a single device. +Ultimately, the `dimmer` channel parameters can be used to create custom channels via a Thing file that can work as an alternative to having to configure an Insteon scene for a single device. ```java Thing device 23b0d9 [address="23.B0.D9"] { @@ -1514,18 +1514,18 @@ Only one command per channel is queued, this mean that subsequent requests will ### Heartbeat Timeout Sensor devices that support heartbeats have a timeout. -If a broadcast message is not received within a specific interval, the associated thing's status will change to offline. +If a broadcast message is not received within a specific interval, the associated Thing's status will change to offline. This status persists until the binding receives a broadcast message from that device. While most sensor devices have a hardcoded heartbeat interval of 24 hours, some allow modification via the `heartbeat-interval` channel. This timeout feature is enabled by default on supporting devices and disabled on devices that can have their heartbeat turned off using the `heartbeat-on-off` channel. Proper linking of the heartbeat group (typically group 4) to the modem is crucial; use the `insteon device addMissingLinks` console command to ensure this. If the link is missing, the timeout feature will be disabled. -The heartbeat timeout can be manually reset, if necessary, by disabling and then re-enabling the associated device thing. +The heartbeat timeout can be manually reset, if necessary, by disabling and then re-enabling the associated device Thing. ### Response Timeout Non-battery powered devices have a response timeout. -If a successful response message is not received within a specific interval, the associated thing's status will change to offline. +If a successful response message is not received within a specific interval, the associated Thing's status will change to offline. While the device is offline, the binding will ignore commands sent to it. This status persists until a valid response is received. The response timeout can be increased from 30 minutes (default) up to 6 hours by updating the associated bridge parameter `deviceResponseTimeoutInMinutes`. diff --git a/bundles/org.openhab.binding.intesis/README.md b/bundles/org.openhab.binding.intesis/README.md index f8648ec8455ee..77f4c8a4df286 100644 --- a/bundles/org.openhab.binding.intesis/README.md +++ b/bundles/org.openhab.binding.intesis/README.md @@ -4,7 +4,7 @@ This binding connects to WiFi [IntesisHome](https://www.intesis.com/products/clo ## Supported Things -This binding only supports one thing type: +This binding only supports one Thing type: | Thing | Thing Type | Description | |-------------|------------|---------------------------------------------| @@ -44,8 +44,8 @@ The binding uses the following configuration parameters. Note that individual A/C units may not support all channels, or all possible values for those channels. -The binding will add all supported channels and possible values on first thing initialization and list them as thing properties. -If new channels or values might be supported after firmware upgrades, deleting the thing and re-adding is necessary. +The binding will add all supported channels and possible values on first Thing initialization and list them as Thing properties. +If new channels or values might be supported after firmware upgrades, deleting the Thing and re-adding is necessary. For example, not all A/C units have controllable vanes or fan speed may be limited to 1-4, instead of all of 1-9. The target temperature is also limited to a device specific range. For target temperature, sending an invalid value will cause it to choose the minimum/maximum allowable value as appropriate. The device will also round it to diff --git a/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/i18n/intesis.properties b/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/i18n/intesis.properties index ac1f243cd4a2e..a4dca69581529 100644 --- a/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/i18n/intesis.properties +++ b/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/i18n/intesis.properties @@ -1,19 +1,33 @@ # add-on + addon.intesis.name = Intesis Binding -addon.intesis.description = This binding integrates Intesis WiFi devices to control various air conditioners +addon.intesis.description = This is the binding for Intesis WiFi adapters used in various AC devices. # thing types -thing-type.intesis.intesisHome.label = IntesisHome -thing-type.intesis.sample.description = IntesisHome WIFI adapter + +thing-type.intesis.intesisBox.label = IntesisBox Adapter +thing-type.intesis.intesisBox.description = Represents a single IntesisBox WiFi adapter on the network, connected to an A/C unit. +thing-type.intesis.intesisHome.label = IntesisHome WiFi Adapter +thing-type.intesis.intesisHome.description = Represents a single IntesisHome WiFi adapter on the network, connected to an A/C unit. + +# thing types config + +thing-type.config.intesis.intesisBox.pollingInterval.label = Polling Interval +thing-type.config.intesis.intesisBox.pollingInterval.description = Defines the time in seconds to poll the state of the connected devices. The minimum is 45 seconds. +thing-type.config.intesis.intesisBox.port.label = Port +thing-type.config.intesis.intesisBox.port.description = The TCP port to the IntesisBox. +thing-type.config.intesis.intesisHome.pollingInterval.label = Polling Interval +thing-type.config.intesis.intesisHome.pollingInterval.description = Defines the time in seconds to poll the state of the connected devices. The minimum is 30 seconds. # thing type config description + thing-type.config.intesis.ipAddress.label = IP Address thing-type.config.intesis.ipAddress.description = IP Address of the Intesis device. thing-type.config.intesisHome.password.label = Password thing-type.config.intesisHome.password.description = Password to log into the IntesisHome device Web-Server. - # channel types + channel-type.intesis.power.label = Power channel-type.intesis.power.description = Turn power on/off channel-type.intesis.mode.label = Unit Mode diff --git a/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/thing/thing-types.xml index 007805996df99..5bbc25052426d 100644 --- a/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.intesis/src/main/resources/OH-INF/thing/thing-types.xml @@ -26,7 +26,7 @@ - Defines the time in seconds to pull the + Defines the time in seconds to poll the state of the connected devices. The minimum is 30 seconds. @@ -60,7 +60,7 @@ - Defines the time in seconds to pull the + Defines the time in seconds to poll the state of the connected devices. The minimum is 45 seconds. diff --git a/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/i18n/iotawatt.properties b/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/i18n/iotawatt.properties index 42aed58ac9061..bcddd4d6fb82c 100644 --- a/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/i18n/iotawatt.properties +++ b/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/i18n/iotawatt.properties @@ -6,7 +6,7 @@ addon.iotawatt.description = This is the binding for IoTaWatt. # thing types thing-type.iotawatt.iotawatt.label = IoTaWatt Binding Thing -thing-type.iotawatt.iotawatt.description = An IoTaWatt devices +thing-type.iotawatt.iotawatt.description = An IoTaWatt device # thing types config @@ -39,4 +39,5 @@ channel-type.iotawatt.watts.label = Power Consumption channel-type.iotawatt.watts.description = The current power consumption. # channel types + configuration-error = The configuration is wrong, please check if you configured a hostname/IP address and positive numbers for the timeout settings. diff --git a/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/thing/thing-types.xml index abc75be829fd1..60b442f6c6f10 100644 --- a/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.iotawatt/src/main/resources/OH-INF/thing/thing-types.xml @@ -7,7 +7,7 @@ - An IoTaWatt devices + An IoTaWatt device ElectricMeter diff --git a/bundles/org.openhab.binding.ipcamera/README.md b/bundles/org.openhab.binding.ipcamera/README.md index e3a18dde5a5bf..6ee87197749cc 100644 --- a/bundles/org.openhab.binding.ipcamera/README.md +++ b/bundles/org.openhab.binding.ipcamera/README.md @@ -32,7 +32,7 @@ Some cameras allow the key frame to be created every second or a different amoun ### ESP32 Cameras -These cameras do not have the ability to create H.264 streams and hence can not be used with HLS, however all other features should work. +These cameras do not have the ability to create H.264 streams and hence cannot be used with HLS, however all other features should work. Due to many custom firmwares available, you may need to ask the firmware developer what the URLs are for snapshots and MJPEG streams if they have changed the defaults from what the Arduino IDE sample code uses. Another limitation is that they can only provide a single stream at a time, so you need to setup the `ffmpegInput` to use the ipcamera.mjpeg feed from the openHAB server and change `ffmpegInputOptions` to "-f mjpeg" so FFmpeg knows the input is MJPEG format and not H.264. @@ -41,7 +41,6 @@ Example: ```java Thing ipcamera:generic:Esp32Cam [ - ipAddress="192.168.1.181", gifPreroll=1, snapshotUrl="http://192.168.1.181/capture", mjpegUrl="http://192.168.1.181:81/stream", @@ -53,7 +52,7 @@ Thing ipcamera:generic:Esp32Cam ### Amcrest -It is better to always setup your Amcrest camera as a `dahua` thing type. +It is better to always setup your Amcrest camera as a `dahua` Thing type. The old alarm polling based method is used if you setup as `amcrest`, and the newer/better event based method is used if you setup as `dahua` instead. All other features should be the same between the two. @@ -140,19 +139,19 @@ The binding needs to use UDP port 3702 to discover the cameras with, so this por To use the discovery, just press the `+` icon located in the Inbox, then select the IpCamera binding from the list of installed bindings. The binding will only search using openHAB's currently selected primary network address. If your camera is not found after a few searches, it may not be ONVIF and in this case you will need to manually add the camera via the UI. -Cameras that are not ONVIF should be added as a `generic` thing type and you will need to provide the URLs manually. +Cameras that are not ONVIF should be added as a `generic` Thing type and you will need to provide the URLs manually. ## Supported Things If using openHAB's textual configuration, or when needing to setup HABpanel/sitemaps, you may need to know what your camera is as a "thing type". -Example: The thing type for a camera with no ONVIF support is "generic". +Example: The Thing type for a camera with no ONVIF support is "generic". | Thing Type ID | Description | |-|-| | `generic` | For any camera that is not ONVIF compatible, yet has working RTSP or HTTP URLs. | | `onvif` | Use for all ONVIF cameras that do not have an API. | -| `amcrest` | Only use for if your Amcrest cameras wont work as a `dahua` thing. This uses an older polling based method for alarms that is not as efficient as the newer method used in `dahua`. Amcrest are made by Dahua and hence the API is similar. | +| `amcrest` | Only use for if your Amcrest cameras wont work as a `dahua` Thing. This uses an older polling based method for alarms that is not as efficient as the newer method used in `dahua`. Amcrest are made by Dahua and hence the API is similar. | | `dahua` | Use for all Dahua and Amcrest cameras that support the API. | | `doorbird` | Use for all current Doorbird cameras as they support an API as well as ONVIF. | | `foscam` | Use for all current Foscam HD cameras as they support an API as well as ONVIF. | @@ -397,7 +396,7 @@ This is always the best option if it works. - Request a snapshot with the URL `http://openhabIP:8080/ipcamera/{cameraUID}/ipcamera.jpg`. The IP is for your openHAB server not the camera. If you find the snapshot is old, you can set the `gifPreroll` to a number above 0 and this forces the camera to keep updating the stored JPG in RAM. -The ipcamera.jpg can also be cast, as most cameras can not directly cast their snapshots. +The ipcamera.jpg can also be cast, as most cameras cannot directly cast their snapshots. - Use the `http://openHAB:8080/ipcamera/{cameraUID}/snapshots.mjpeg` to request a stream of snapshots to be delivered in MJPEG format. - Use the record GIF action and use a `gifPreroll` value > 0. This creates a number of snapshots in the FFmpeg output folder called snapshotXXX.jpg where XXX starts at 0 and increases each `pollTime`. @@ -725,7 +724,7 @@ The widgets in the link above are the easiest way to get an advanced stream work ## Group Displays -The `group` thing allows up to 4 cameras to be displayed like they are a single camera that rotates from one to the next. +The `group` Thing allows up to 4 cameras to be displayed like they are a single camera that rotates from one to the next. The display order can be allowed to change if one or more of the cameras detects motion. Some additional checks to get it working are: diff --git a/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/i18n/ipcamera.properties b/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/i18n/ipcamera.properties index c7f520ac53406..a99c748ef0bf0 100644 --- a/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/i18n/ipcamera.properties +++ b/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/i18n/ipcamera.properties @@ -6,7 +6,7 @@ addon.ipcamera.description = This binding interfaces IP cameras of various vendo # thing types thing-type.ipcamera.amcrest.label = Amcrest Camera with API -thing-type.ipcamera.amcrest.description = Use for older Amcrest Cameras, that wont work as dahua thing type. +thing-type.ipcamera.amcrest.description = Use for older Amcrest cameras that won't work as a Dahua thing type. thing-type.ipcamera.dahua.label = Dahua Camera with API thing-type.ipcamera.dahua.description = Use for all current Dahua cameras, as they support an API as well as ONVIF. thing-type.ipcamera.doorbird.label = Doorbird Camera with API @@ -299,7 +299,7 @@ thing-type.config.ipcamera.generic.gifOutOptions.description = This gives you di thing-type.config.ipcamera.generic.gifPreroll.label = GIF Preroll thing-type.config.ipcamera.generic.gifPreroll.description = Store this many snapshots from BEFORE you trigger a GIF creation. thing-type.config.ipcamera.generic.group.FFmpeg Setup.label = FFmpeg Settings -thing-type.config.ipcamera.generic.group.FFmpeg Setup.description = Settings that setup or effect the video stream. +thing-type.config.ipcamera.generic.group.FFmpeg Setup.description = Settings that affect the video stream. thing-type.config.ipcamera.generic.group.Image ch Settings.label = Image channel settings thing-type.config.ipcamera.generic.group.Image ch Settings.description = Settings for the image channel features which is not recommended to be used. See readme for more info. thing-type.config.ipcamera.generic.group.Settings.label = Main Settings @@ -346,10 +346,10 @@ thing-type.config.ipcamera.group.ffmpegOutput.label = FFmpeg Output Folder thing-type.config.ipcamera.group.ffmpegOutput.description = Leave this blank and the binding will use the openHAB userdata folder. Alternatively, a unique path for each camera that ends with a slash and has write permissions can be entered. thing-type.config.ipcamera.group.firstCamera.label = First Camera ID thing-type.config.ipcamera.group.firstCamera.description = Enter the 'Unique ID' of the camera you wish to show first. -thing-type.config.ipcamera.group.forthCamera.label = Forth Camera ID -thing-type.config.ipcamera.group.forthCamera.description = Enter the 'Unique ID' of the camera you wish to show forth. Leave blank if the group is less than 4. +thing-type.config.ipcamera.group.forthCamera.label = Fourth Camera ID +thing-type.config.ipcamera.group.forthCamera.description = Enter the 'Unique ID' of the camera you wish to show fourth. Leave blank if the group is less than 4. thing-type.config.ipcamera.group.group.FFmpeg Setup.label = FFmpeg Settings -thing-type.config.ipcamera.group.group.FFmpeg Setup.description = Settings that setup or effect the video stream. +thing-type.config.ipcamera.group.group.FFmpeg Setup.description = Settings that affect the video stream. thing-type.config.ipcamera.group.group.Settings.label = Main Settings thing-type.config.ipcamera.group.group.Settings.description = Settings required to setup a group of cameras. thing-type.config.ipcamera.group.ipWhitelist.label = IP Whitelist @@ -503,7 +503,7 @@ thing-type.config.ipcamera.onvif.gifOutOptions.description = This gives you dire thing-type.config.ipcamera.onvif.gifPreroll.label = GIF Preroll thing-type.config.ipcamera.onvif.gifPreroll.description = Store this many snapshots from BEFORE you trigger a GIF creation. thing-type.config.ipcamera.onvif.group.FFmpeg Setup.label = FFmpeg Settings -thing-type.config.ipcamera.onvif.group.FFmpeg Setup.description = Settings that setup or effect the video stream. +thing-type.config.ipcamera.onvif.group.FFmpeg Setup.description = Settings that affect the video stream. thing-type.config.ipcamera.onvif.group.Image ch Settings.label = Image channel settings thing-type.config.ipcamera.onvif.group.Image ch Settings.description = Settings for the image channel features which is not recommended to be used. See readme for more info. thing-type.config.ipcamera.onvif.group.Settings.label = Main Settings @@ -522,16 +522,16 @@ thing-type.config.ipcamera.onvif.motionOptions.label = Motion Options thing-type.config.ipcamera.onvif.motionOptions.description = This gives you direct access to specify your own FFmpeg options to be used for detecting motion. thing-type.config.ipcamera.onvif.mp4OutOptions.label = MP4 Out Options thing-type.config.ipcamera.onvif.mp4OutOptions.description = This gives you direct access to specify your own FFmpeg options to be used for recording MP4 files. -thing-type.config.ipcamera.onvif.onvifMediaProfile.label = ONVIF Media Profile -thing-type.config.ipcamera.onvif.onvifMediaProfile.description = Cameras can supply more than one stream at different resolutions and formats. 0 selects the main-stream and 1 or above are the sub-streams. Sometimes you need to turn on sub-streams in the cameras setup before they can be used. -thing-type.config.ipcamera.onvif.onvifPort.label = ONVIF Port -thing-type.config.ipcamera.onvif.onvifPort.description = The port your camera uses for ONVIF connections. This is needed for PTZ movement, alarm events and auto discovery of RTSP and snapshot URLs. -thing-type.config.ipcamera.onvif.onvifEventServiceType.label = ONVIF event method +thing-type.config.ipcamera.onvif.onvifEventServiceType.label = ONVIF event method: thing-type.config.ipcamera.onvif.onvifEventServiceType.description = ONVIF event method to use. If camera does not report event capabilities, the event method can be forced here. thing-type.config.ipcamera.onvif.onvifEventServiceType.option.0 = Auto detect (0) thing-type.config.ipcamera.onvif.onvifEventServiceType.option.1 = Disabled (1) thing-type.config.ipcamera.onvif.onvifEventServiceType.option.2 = Force PullMessages (2) thing-type.config.ipcamera.onvif.onvifEventServiceType.option.3 = Force WSBaseSubscription (3) +thing-type.config.ipcamera.onvif.onvifMediaProfile.label = ONVIF Media Profile +thing-type.config.ipcamera.onvif.onvifMediaProfile.description = Cameras can supply more than one stream at different resolutions and formats. 0 selects the main-stream and 1 or above are the sub-streams. Sometimes you need to turn on sub-streams in the cameras setup before they can be used. +thing-type.config.ipcamera.onvif.onvifPort.label = ONVIF Port +thing-type.config.ipcamera.onvif.onvifPort.description = The port your camera uses for ONVIF connections. This is needed for PTZ movement, alarm events and auto discovery of RTSP and snapshot URLs. thing-type.config.ipcamera.onvif.password.label = Password thing-type.config.ipcamera.onvif.password.description = Enter the password for your camera. Leave blank if your camera does not use one. thing-type.config.ipcamera.onvif.pollTime.label = Poll Time @@ -592,16 +592,16 @@ thing-type.config.ipcamera.reolink.mp4OutOptions.label = MP4 Out Options thing-type.config.ipcamera.reolink.mp4OutOptions.description = This gives you direct access to specify your own FFmpeg options to be used for recording MP4 files. thing-type.config.ipcamera.reolink.nvrChannel.label = NVR Input Channel thing-type.config.ipcamera.reolink.nvrChannel.description = Set this to 0 if it is a stand alone camera, or to the input channel number of your NVR that the camera is connected to. -thing-type.config.ipcamera.reolink.onvifMediaProfile.label = ONVIF Media Profile -thing-type.config.ipcamera.reolink.onvifMediaProfile.description = Cameras can supply more than one stream at different resolutions and formats. 0 selects the main-stream and 1 or above are the sub-streams. Sometimes you need to turn on sub-streams in the cameras setup before they can be used. -thing-type.config.ipcamera.reolink.onvifPort.label = ONVIF Port -thing-type.config.ipcamera.reolink.onvifPort.description = The port your camera uses for ONVIF connections. This is needed for PTZ movement, alarm events and auto discovery of RTSP and snapshot URLs. -thing-type.config.ipcamera.reolink.onvifEventServiceType.label = ONVIF event method +thing-type.config.ipcamera.reolink.onvifEventServiceType.label = ONVIF Event Method thing-type.config.ipcamera.reolink.onvifEventServiceType.description = ONVIF event method to use. If camera does not report event capabilities, the event method can be forced here. thing-type.config.ipcamera.reolink.onvifEventServiceType.option.0 = Auto detect (0) thing-type.config.ipcamera.reolink.onvifEventServiceType.option.1 = Disabled (1) thing-type.config.ipcamera.reolink.onvifEventServiceType.option.2 = Force PullMessages (2) thing-type.config.ipcamera.reolink.onvifEventServiceType.option.3 = Force WSBaseSubscription (3) +thing-type.config.ipcamera.reolink.onvifMediaProfile.label = ONVIF Media Profile +thing-type.config.ipcamera.reolink.onvifMediaProfile.description = Cameras can supply more than one stream at different resolutions and formats. 0 selects the main-stream and 1 or above are the sub-streams. Sometimes you need to turn on sub-streams in the cameras setup before they can be used. +thing-type.config.ipcamera.reolink.onvifPort.label = ONVIF Port +thing-type.config.ipcamera.reolink.onvifPort.description = The port your camera uses for ONVIF connections. This is needed for PTZ movement, alarm events and auto discovery of RTSP and snapshot URLs. thing-type.config.ipcamera.reolink.password.label = Password thing-type.config.ipcamera.reolink.password.description = Enter the password for your camera. Leave blank if your camera does not use one. thing-type.config.ipcamera.reolink.pollTime.label = Poll Time @@ -651,6 +651,8 @@ channel-type.ipcamera.carAlarm.label = Car Alarm channel-type.ipcamera.carAlarm.description = A car has triggered the Vehicle Detection. channel-type.ipcamera.cellMotionAlarm.label = Cell Motion Alarm channel-type.ipcamera.cellMotionAlarm.description = Cell based motion has been detected. +channel-type.ipcamera.createSnapshots.label = Create Snapshots +channel-type.ipcamera.createSnapshots.description = This can be used to start and stop FFmpeg from creating snapshots from your RTSP source using your openHAB CPU. channel-type.ipcamera.doorBell.label = Door Bell channel-type.ipcamera.doorBell.description = The button has been pushed. channel-type.ipcamera.doorContact.label = Door Contact @@ -776,7 +778,7 @@ channel-type.ipcamera.parkingAlarm.description = A car has triggered the Parking channel-type.ipcamera.pirAlarm.label = PIR Alarm channel-type.ipcamera.pirAlarm.description = PIR motion has been detected. channel-type.ipcamera.pollImage.label = Poll Image -channel-type.ipcamera.pollImage.description = This can be used to trigger snapshot updates when an external PIR, button or other form of sensor turns this channel ON. +channel-type.ipcamera.pollImage.description = This can be used to update the image channel when this channel is ON. channel-type.ipcamera.recordingGif.label = GIF Recording channel-type.ipcamera.recordingGif.description = Indicates how long the recording will occur for and when the file is created, the channel will change to 0 by itself. channel-type.ipcamera.recordingMp4.label = MP4 Recording diff --git a/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/thing/thing-types.xml index 1490f7dcd14c6..85bea432ab52a 100644 --- a/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.ipcamera/src/main/resources/OH-INF/thing/thing-types.xml @@ -24,7 +24,7 @@ - Settings that setup or effect the video stream. + Settings that affect the video stream. false @@ -62,8 +62,8 @@ - - Enter the 'Unique ID' of the camera you wish to show forth. Leave blank if the group is less than 4. + + Enter the 'Unique ID' of the camera you wish to show fourth. Leave blank if the group is less than 4. @@ -134,7 +134,7 @@ - Settings that setup or effect the video stream. + Settings that affect the video stream. false @@ -387,7 +387,7 @@ - Settings that setup or effect the video stream. + Settings that affect the video stream. false @@ -624,7 +624,7 @@ - Use for older Amcrest Cameras, that wont work as dahua thing type. + Use for older Amcrest cameras that won't work as a Dahua thing type. Camera diff --git a/bundles/org.openhab.binding.ipobserver/README.md b/bundles/org.openhab.binding.ipobserver/README.md index d0d983e6606db..21be95f6e5020 100644 --- a/bundles/org.openhab.binding.ipobserver/README.md +++ b/bundles/org.openhab.binding.ipobserver/README.md @@ -16,7 +16,7 @@ If your weather station came with a LCD screen instead of the IP Observer, you c ## Supported Things -There is only one thing that can be added and is called `weatherstation`. +There is only one Thing that can be added and is called `weatherstation`. ## Discovery diff --git a/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/i18n/ipobserver.properties b/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/i18n/ipobserver.properties index 0285ee4b57f04..51b9f490aced8 100644 --- a/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/i18n/ipobserver.properties +++ b/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/i18n/ipobserver.properties @@ -15,11 +15,11 @@ thing-type.config.ipobserver.weatherstation.address.description = Hostname or IP thing-type.config.ipobserver.weatherstation.autoReboot.label = Auto Reboot thing-type.config.ipobserver.weatherstation.autoReboot.description = Time in milliseconds to wait for a reply before rebooting the IP Observer. A value of 0 disables this feature allowing you to manually trigger or use a rule to handle the reboots thing-type.config.ipobserver.weatherstation.id.label = Station ID -thing-type.config.ipobserver.weatherstation.id.description = The station ID used to connect to WeatherUnderGround. Leave blank if you wish to poll the livedata. +thing-type.config.ipobserver.weatherstation.id.description = The station ID used to connect to Weather Underground. Leave blank if you wish to poll the livedata. thing-type.config.ipobserver.weatherstation.password.label = Station Password -thing-type.config.ipobserver.weatherstation.password.description = The station password used to connect to WeatherUnderGround. Leave blank if you wish to poll the livedata. +thing-type.config.ipobserver.weatherstation.password.description = The station password used to connect to Weather Underground. Leave blank if you wish to poll the livedata. thing-type.config.ipobserver.weatherstation.pollTime.label = Poll Time -thing-type.config.ipobserver.weatherstation.pollTime.description = Time in seconds between each Scan of the livedata.htm from the ObserverIP +thing-type.config.ipobserver.weatherstation.pollTime.description = Time in seconds between each scan of the livedata.htm from the IP Observer # channel types diff --git a/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml index d2c3b73b752f8..3759086c04344 100644 --- a/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.ipobserver/src/main/resources/OH-INF/thing/thing-types.xml @@ -50,7 +50,7 @@ - Time in seconds between each Scan of the livedata.htm from the ObserverIP + Time in seconds between each scan of the livedata.htm from the IP Observer 20 @@ -61,12 +61,12 @@ - The station ID used to connect to WeatherUnderGround. Leave blank if you wish to poll the livedata. + The station ID used to connect to Weather Underground. Leave blank if you wish to poll the livedata. password - The station password used to connect to WeatherUnderGround. Leave blank if you wish to poll the + The station password used to connect to Weather Underground. Leave blank if you wish to poll the livedata. diff --git a/bundles/org.openhab.binding.ipp/README.md b/bundles/org.openhab.binding.ipp/README.md index 0b07a15c17841..f2bf3bf0b20c0 100644 --- a/bundles/org.openhab.binding.ipp/README.md +++ b/bundles/org.openhab.binding.ipp/README.md @@ -6,7 +6,7 @@ The main purpose is to check if there are waiting print jobs on a printer, which ## Supported Things The binding has been tested against a CUPS Server (which implements the Internet Printing Protocol). -So all printers in a CUPS envorinment should work fine. Many network printers also use IPP, +So all printers in a CUPS environment should work fine. Many network printers also use IPP, but there are many differences on which parts of IPP are supported. It is not guaranteed that every printer will work. diff --git a/bundles/org.openhab.binding.irtrans/README.md b/bundles/org.openhab.binding.irtrans/README.md index ab8938b53899a..7b42524930889 100644 --- a/bundles/org.openhab.binding.irtrans/README.md +++ b/bundles/org.openhab.binding.irtrans/README.md @@ -9,7 +9,7 @@ This binding supports the following Thing types | Thing | Thing Type | Description | |----------|------------|----------------------------------------------------------------------------| | ethernet | Bridge | Ethernet (PoE) IRtrans transceiver equipped with an on-board IRDB database | -| blaster | Thing | Child thing representing an IR Blaster | +| blaster | Thing | Child Thing representing an IR Blaster | ## Discovery diff --git a/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/i18n/irtrans.properties b/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/i18n/irtrans.properties index d5acf3b64cb76..c297eca270b0e 100644 --- a/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/i18n/irtrans.properties +++ b/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/i18n/irtrans.properties @@ -13,15 +13,15 @@ thing-type.irtrans.ethernet.description = This is an Ethernet (PoE) IRtrans tran # thing types config thing-type.config.irtrans.blaster.command.label = Command -thing-type.config.irtrans.blaster.command.description = The name of the command will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any command -thing-type.config.irtrans.blaster.led.label = Led -thing-type.config.irtrans.blaster.led.description = The Led on which infrared commands will be emitted +thing-type.config.irtrans.blaster.command.description = The name of the command that will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any command +thing-type.config.irtrans.blaster.led.label = LED +thing-type.config.irtrans.blaster.led.description = The LED on which infrared commands will be emitted thing-type.config.irtrans.blaster.remote.label = Remote -thing-type.config.irtrans.blaster.remote.description = The remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote +thing-type.config.irtrans.blaster.remote.description = The remote or manufacturer name whose commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote thing-type.config.irtrans.ethernet.bufferSize.label = Buffer Size thing-type.config.irtrans.ethernet.bufferSize.description = Buffer size used by the TCP socket when sending and receiving commands to the transceiver thing-type.config.irtrans.ethernet.ipAddress.label = Network Address -thing-type.config.irtrans.ethernet.ipAddress.description = Network address of the ethernet transceiver +thing-type.config.irtrans.ethernet.ipAddress.description = Network address of the Ethernet transceiver thing-type.config.irtrans.ethernet.pingTimeOut.label = Ping Time Out thing-type.config.irtrans.ethernet.pingTimeOut.description = Specifies the time milliseconds to wait for a response from the transceiver when pinging the device thing-type.config.irtrans.ethernet.portNumber.label = Port Number @@ -34,21 +34,21 @@ thing-type.config.irtrans.ethernet.responseTimeOut.description = Specifies the t # channel types channel-type.irtrans.blaster.label = Blaster Channel -channel-type.irtrans.blaster.description = The Blaster Channel allows to send (filtered) infrared commands over the specified blaster led of the transceiver +channel-type.irtrans.blaster.description = The Blaster channel allows sending (filtered) infrared commands over the specified blaster LED of the transceiver channel-type.irtrans.io.label = Input/Output channel-type.irtrans.io.description = Read commands received by the blaster, or write commands to be sent by the blaster channel-type.irtrans.receiver.label = Receiver Channel -channel-type.irtrans.receiver.description = The Receiver Channel allows to receive (filtered) infrared commands on the receiver led of the transceiver +channel-type.irtrans.receiver.description = The Receiver channel allows receiving (filtered) infrared commands on the receiver LED of the transceiver # channel types config channel-type.config.irtrans.blaster.command.label = Command -channel-type.config.irtrans.blaster.command.description = The name of the command will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any command -channel-type.config.irtrans.blaster.led.label = Led -channel-type.config.irtrans.blaster.led.description = The Led on which infrared commands will be emitted +channel-type.config.irtrans.blaster.command.description = The name of the command that will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any command +channel-type.config.irtrans.blaster.led.label = LED +channel-type.config.irtrans.blaster.led.description = The LED on which infrared commands will be emitted channel-type.config.irtrans.blaster.remote.label = Remote -channel-type.config.irtrans.blaster.remote.description = The remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote +channel-type.config.irtrans.blaster.remote.description = The remote or manufacturer name whose commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote channel-type.config.irtrans.receiver.command.label = Command -channel-type.config.irtrans.receiver.command.description = The name of the command will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any command +channel-type.config.irtrans.receiver.command.description = The name of the command that will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any command channel-type.config.irtrans.receiver.remote.label = Remote -channel-type.config.irtrans.receiver.remote.description = The remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote +channel-type.config.irtrans.receiver.remote.description = The remote or manufacturer name whose commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote diff --git a/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/blaster.xml b/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/blaster.xml index b8acb6f4ea18f..42716b7392039 100644 --- a/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/blaster.xml +++ b/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/blaster.xml @@ -20,19 +20,20 @@ - - The Led on which infrared commands will be emitted + + The LED on which infrared commands will be emitted - The remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server + The remote or manufacturer name whose commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote - The name of the command will be allowed, as defined in the IRtrans server database and flashed into the + The name of the command that will be allowed, as defined in the IRtrans server database and flashed + into the transceiver. Can be '*' for any command diff --git a/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/ethernetbridge.xml b/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/ethernetbridge.xml index 99cbc681ddc63..955340b1dbf6b 100644 --- a/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/ethernetbridge.xml +++ b/bundles/org.openhab.binding.irtrans/src/main/resources/OH-INF/thing/ethernetbridge.xml @@ -13,7 +13,7 @@ - Network address of the ethernet transceiver + Network address of the Ethernet transceiver network-address @@ -46,21 +46,22 @@ String - The Blaster Channel allows to send (filtered) infrared commands over the specified blaster led of the + The Blaster channel allows sending (filtered) infrared commands over the specified blaster LED of the transceiver - - The Led on which infrared commands will be emitted + + The LED on which infrared commands will be emitted - The remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server + The remote or manufacturer name whose commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote - The name of the command will be allowed, as defined in the IRtrans server database and flashed into the + The name of the command that will be allowed, as defined in the IRtrans server database and flashed + into the transceiver. Can be '*' for any command @@ -69,17 +70,18 @@ String - The Receiver Channel allows to receive (filtered) infrared commands on the receiver led of the + The Receiver channel allows receiving (filtered) infrared commands on the receiver LED of the transceiver - The remote or manufacturer name which's commands will be allowed, as defined in the IRtrans server + The remote or manufacturer name whose commands will be allowed, as defined in the IRtrans server database and flashed into the transceiver. Can be '*' for any remote - The name of the command will be allowed, as defined in the IRtrans server database and flashed into the + The name of the command that will be allowed, as defined in the IRtrans server database and flashed + into the transceiver. Can be '*' for any command diff --git a/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/i18n/ism8.properties b/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/i18n/ism8.properties index 828e2388c868b..60a16fdb49d94 100644 --- a/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/i18n/ism8.properties +++ b/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/i18n/ism8.properties @@ -58,56 +58,56 @@ channel-type.config.ism8.mode-rw.type.option.20.102 = DPT_HVACMode channel-type.config.ism8.mode-rw.type.option.20.103 = DPT_DHWMode channel-type.config.ism8.mode-rw.type.option.20.105 = DPT_HVACContrMode channel-type.config.ism8.number-r.id.label = DP ID -channel-type.config.ism8.number-r.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.number-r.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.number-r.type.label = Type -channel-type.config.ism8.number-r.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.number-r.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.number-r.type.option.5.010 = DPT_Value_1_Ucount channel-type.config.ism8.number-r.type.option.7.001 = DPT_Value_2_Ucount channel-type.config.ism8.percentage-r.id.label = DP ID -channel-type.config.ism8.percentage-r.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.percentage-r.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.percentage-r.type.label = Type -channel-type.config.ism8.percentage-r.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.percentage-r.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.percentage-r.type.option.5.001 = DPT_Scaling channel-type.config.ism8.percentage-rw.id.label = DP ID -channel-type.config.ism8.percentage-rw.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.percentage-rw.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.percentage-rw.type.label = Type -channel-type.config.ism8.percentage-rw.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.percentage-rw.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.percentage-rw.type.option.5.001 = DPT_Scaling channel-type.config.ism8.power-r.id.label = DP ID -channel-type.config.ism8.power-r.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.power-r.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.power-r.type.label = Type -channel-type.config.ism8.power-r.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.power-r.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.power-r.type.option.9.024 = DPT_Power channel-type.config.ism8.pressure-r.id.label = DP ID -channel-type.config.ism8.pressure-r.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.pressure-r.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.pressure-r.type.label = Type -channel-type.config.ism8.pressure-r.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.pressure-r.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.pressure-r.type.option.9.006 = DPT_Value_Pres channel-type.config.ism8.switch-r.id.label = DP ID -channel-type.config.ism8.switch-r.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.switch-r.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.switch-r.type.label = Type -channel-type.config.ism8.switch-r.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Switch / 1.001) +channel-type.config.ism8.switch-r.type.description = Put the KNX type of the data point (e.g., DPT_Switch / 1.001) channel-type.config.ism8.switch-r.type.option.1.001 = DPT_Switch channel-type.config.ism8.switch-r.type.option.1.002 = DPT_Bool channel-type.config.ism8.switch-r.type.option.1.003 = DPT_Enable channel-type.config.ism8.switch-r.type.option.1.009 = DPT_OpenClose channel-type.config.ism8.switch-rw.id.label = DP ID -channel-type.config.ism8.switch-rw.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.switch-rw.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.switch-rw.type.label = Type -channel-type.config.ism8.switch-rw.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Switch / 1.001) +channel-type.config.ism8.switch-rw.type.description = Put the KNX type of the data point (e.g., DPT_Switch / 1.001) channel-type.config.ism8.switch-rw.type.option.1.001 = DPT_Switch channel-type.config.ism8.switch-rw.type.option.1.002 = DPT_Bool channel-type.config.ism8.switch-rw.type.option.1.003 = DPT_Enable channel-type.config.ism8.switch-rw.type.option.1.009 = DPT_OpenClose channel-type.config.ism8.temperature-r.id.label = DP ID -channel-type.config.ism8.temperature-r.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.temperature-r.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.temperature-r.type.label = Type -channel-type.config.ism8.temperature-r.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.temperature-r.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.temperature-r.type.option.9.001 = DPT_Value_Temp channel-type.config.ism8.temperature-r.type.option.9.002 = DPT_Value_Tempd channel-type.config.ism8.temperature-rw.id.label = DP ID -channel-type.config.ism8.temperature-rw.id.description = Put the number of the DataPoint ID to be mapped from the heating sytem. +channel-type.config.ism8.temperature-rw.id.description = Put the number of the DataPoint ID to be mapped from the heating system. channel-type.config.ism8.temperature-rw.type.label = Type -channel-type.config.ism8.temperature-rw.type.description = Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) +channel-type.config.ism8.temperature-rw.type.description = Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) channel-type.config.ism8.temperature-rw.type.option.9.001 = DPT_Value_Temp channel-type.config.ism8.temperature-rw.type.option.9.002 = DPT_Value_Tempd diff --git a/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/thing/thing-types.xml index de75e176ebb40..aad996c5c8c08 100644 --- a/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.ism8/src/main/resources/OH-INF/thing/thing-types.xml @@ -27,11 +27,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Switch / 1.001) + Put the KNX type of the data point (e.g., DPT_Switch / 1.001) @@ -53,11 +53,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Switch / 1.001) + Put the KNX type of the data point (e.g., DPT_Switch / 1.001) @@ -79,11 +79,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) @@ -100,11 +100,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) @@ -123,11 +123,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) @@ -148,11 +148,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) @@ -172,11 +172,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) @@ -197,11 +197,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001) @@ -221,11 +221,11 @@ - Put the number of the DataPoint ID to be mapped from the heating sytem. + Put the number of the DataPoint ID to be mapped from the heating system. - Put the KNX-type of the DataPoint (e.g. DPT_Value_Temp / 9.001) + Put the KNX type of the data point (e.g., DPT_Value_Temp / 9.001)