Skip to content

Fix documentation, grammar, and spelling in bindings H-I #19534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlaur merged 8 commits into from
Nov 30, 2025
Merged

Fix documentation, grammar, and spelling in bindings H-I #19534

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d103718
H-bindings
lsiepel Oct 23, 2025
c9dc5ba
I-bindings
lsiepel Oct 23, 2025
5fd7499
Spotless haassohnpelletstove
lsiepel Oct 24, 2025
6af4b1b
More spotless
lsiepel Oct 24, 2025
de014f5
Update bundles/org.openhab.binding.huesync/README.md
lsiepel Oct 25, 2025
ce5d898
thing => Thing
lsiepel Nov 29, 2025
db9026b
Apply suggestions from code review
lsiepel Nov 29, 2025
c080b0c
Review comments.
lsiepel Nov 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions bundles/org.openhab.binding.haassohnpelletstove/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
# 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: <https://www.haassohn.com/de/ihr-plus/WLAN-Funktion>
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: <https://www.haassohn.com/de/ihr-plus/WLAN-Funktion>

## 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"]
```

## Channels

The following channels are yet supported:
The following channels are 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|
| 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

Expand All @@ -59,9 +59,9 @@ Number ZieltemperaturFeuer "ZieltemperaturFeuer" (g_FeuerThermostat) {ga="thermo
Number TemperaturFeuer "TemperaturFeuer" (g_FeuerThermostat) {ga="thermostatTemperatureAmbient"}
```

## Tested Hardware
## 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
6 changes: 3 additions & 3 deletions bundles/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/addon/addon.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
xsi:schemaLocation="https://openhab.org/schemas/addon/v1.0.0 https://openhab.org/schemas/addon-1.0.0.xsd">

<type>binding</type>
<name>Haas and Sohn Pelletstove Binding</name>
<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.</description>
<name>Haas+Sohn Pellet Stove Binding</name>
<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.</description>
<connection>local</connection>

</addon:addon>
46 changes: 23 additions & 23 deletions ...binding.haassohnpelletstove/src/main/resources/OH-INF/i18n/haassohnpelletstove.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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–999.

# 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.
53 changes: 27 additions & 26 deletions ...s/org.openhab.binding.haassohnpelletstove/src/main/resources/OH-INF/thing/thing-types.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@
<!-- Haas Sohn Thing Type -->
<thing-type id="oven">
<label>Haas+Sohn Oven</label>
<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.</description>
<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.</description>
<semantic-equipment-tag>Furnace</semantic-equipment-tag>

<channels>
Expand All @@ -29,7 +30,7 @@
<config-description>
<parameter name="hostIP" type="text" required="true">
<label>IP Address</label>
<description>Please add the IP Address of the WIFI Module of the Haas and Sohn oven here</description>
<description>Enter the IP address of the Haas+Sohn oven’s Wi‑Fi module.</description>
<context>network-address</context>
</parameter>
<parameter name="hostPIN" type="text" required="true" pattern="[0-9]{4}">
Expand All @@ -38,9 +39,9 @@
</parameter>
<parameter name="refreshRate" type="integer" unit="s" min="1" max="1000">
<label>Refresh Rate</label>
<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.
</description>
<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–999.</description>
<advanced>true</advanced>
<default>30</default>
</parameter>
Expand All @@ -49,8 +50,8 @@
</thing-type>
<channel-type id="isTemp">
<item-type>Number:Temperature</item-type>
<label>Is Temperature Stove</label>
<description>Receives the is temperature of the stove as number:temperature</description>
<label>Actual Stove Temperature</label>
<description>Current stove temperature.</description>
<tags>
<tag>Measurement</tag>
<tag>Temperature</tag>
Expand All @@ -60,8 +61,8 @@

<channel-type id="mode">
<item-type>String</item-type>
<label>Mode Stove</label>
<description>Receives the actual mode of the stove as string</description>
<label>Stove Mode</label>
<description>Current stove mode.</description>
<tags>
<tag>Status</tag>
<tag>Mode</tag>
Expand All @@ -71,8 +72,8 @@

<channel-type id="spTemp">
<item-type>Number:Temperature</item-type>
<label>Set Temperature Stove</label>
<description>Set the target temperature of the stove as number:temperature</description>
<label>Target Stove Temperature</label>
<description>Target stove temperature.</description>
<tags>
<tag>Setpoint</tag>
<tag>Temperature</tag>
Expand All @@ -81,8 +82,8 @@

<channel-type id="power">
<item-type>Switch</item-type>
<label>On/Off Stove</label>
<description>To turn the stove on/off as switch</description>
<label>Power</label>
<description>Turn the stove on/off.</description>
<tags>
<tag>Switch</tag>
<tag>Power</tag>
Expand All @@ -91,8 +92,8 @@

<channel-type id="ecoMode">
<item-type>Switch</item-type>
<label>On/Off Eco Mode</label>
<description>To turn the Eco Mode on/off for the stove as switch</description>
<label>Eco Mode</label>
<description>Enable or disable Eco Mode.</description>
<tags>
<tag>Switch</tag>
<tag>Mode</tag>
Expand All @@ -101,36 +102,36 @@

<channel-type id="ignitions">
<item-type>Number</item-type>
<label>Ignitions Stove</label>
<description>Receives the total amount of ignitions of the stove as string</description>
<label>Ignitions</label>
<description>Total number of ignitions.</description>
<state readOnly="true"/>
</channel-type>

<channel-type id="maintenanceIn">
<item-type>Number:Mass</item-type>
<label>Next Maintenance</label>
<description>Provides a pellet forecast when the stove need to be maintained next in kilogram as number:mass</description>
<description>Estimated pellet quantity until next maintenance (kg).</description>
<state readOnly="true"/>
</channel-type>

<channel-type id="cleaningIn">
<item-type>String</item-type>
<label>Next Cleaning Window</label>
<description>Provides a time forecast in hours:minutes when the stove need to be cleaned next as String</description>
<description>Estimated time until next cleaning (hh:mm).</description>
<state readOnly="true"/>
</channel-type>

<channel-type id="consumption">
<item-type>Number:Mass</item-type>
<label>Total Consumption Stove</label>
<description>Provides the information about the total consumption of pellets of the stove as number:mass</description>
<label>Total Pellet Consumption</label>
<description>Total pellet consumption.</description>
<state readOnly="true"/>
</channel-type>

<channel-type id="onTime">
<item-type>Number</item-type>
<label>Operation Hours Stove</label>
<description>Provides the information of the operating hours of stove as number</description>
<label>Operating Hours</label>
<description>Total operating hours.</description>
<state readOnly="true"/>
</channel-type>

Expand Down
20 changes: 10 additions & 10 deletions bundles/org.openhab.binding.harmonyhub/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"] {
Expand Down Expand Up @@ -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" }
Expand Down
Loading