这是indexloc提供的服务，不要输入任何密码
Skip to content

Fix documentation, grammar, and spelling in bindings O #19556

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix documentation, grammar, and spelling in bindings O #19556

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e64c96
O-bindings
lsiepel Oct 25, 2025
738651e
Update omnilink
lsiepel Oct 25, 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
16 changes: 8 additions & 8 deletions bundles/org.openhab.binding.oceanic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Oceanic Binding

This binding integrates the Oceanic water softener and management system (<www.oceanic.be>, but also distributed by Syr in Germany (<www.syr.de>)).
The binding supports the Limex IQ and Limex Pro water softeners and require the optional CAN-Serial gateway has to be installed
This binding integrates the Oceanic water softener and management system (<www.oceanic.be>, also distributed by Syr in Germany at <www.syr.de>).
The binding supports the Limex IQ and Limex Pro water softeners and requires the optional CAN-Serial gateway to be installed.

## Supported Things

- **serial** - A water softener connected to the openHAB host by means of a serial port
- **network** - A water softener that can be reached through a TCP proxy. See Known Issues below as when to use this kind of configuration
- **network** - A water softener that can be reached through a TCP proxy. See Known Issues below for when to use this configuration.

## Thing Configuration

The **serial** Thing configuration requires the name of the serial port that is used to connect openHAB with the Oceanic unit, and the interval period in seconds to poll the Oceanic unit
The **serial** Thing configuration requires the name of the serial port used to connect openHAB with the Oceanic unit, and the interval period in seconds to poll the Oceanic unit.

The **network** Thing configuration requires the hostname or ip address of the proxy, the TCP port number to connect to, and the interval period in seconds to poll the Oceanic unit
The **network** Thing configuration requires the hostname or IP address of the proxy, the TCP port number to connect to, and the interval period in seconds to poll the Oceanic unit.

## Channels

Expand Down Expand Up @@ -88,7 +88,7 @@ The Oceanic binding makes use of the nrjavaserial library, and unfortunately jav

Although some work is being done to improve things (<https://github.com/eclipse/smarthome/issues/4465>), the best thing is to avoid serial ports as much as possible, as some issues (<https://github.com/NeuronRobotics/nrjavaserial/issues/96>) are not resolved.

For example, On Ubuntu 17.10 nrjavaserial seems to return only HEX 00 characters through the InputStream of the SerialPort.
For example, on Ubuntu 17.10 nrjavaserial seems to return only HEX 00 characters through the InputStream of the SerialPort.

Within the Oceanic binding two routes are provided:

Expand All @@ -98,7 +98,7 @@ Within the Oceanic binding two routes are provided:
/usr/bin/socat -v TCP-LISTEN:9000 /dev/ttyUSB0,raw,echo=0
```

In the above example, the name of the host running socat, and the TCP port number 9000, will be part of the **network** Thing configuration
In the above example, the name of the host running socat and the TCP port number 9000 will be part of the **network** Thing configuration.
1. Connect to the Oceanic softener over a serial port on the openHAB host and use `socat` to pipe the data from that serial port to a pseudo tty, which has to be manipulated in a CommPortIdentifier.PORT_RAW manner.

```shell
Expand All @@ -120,7 +120,7 @@ Restart=always
RestartSec=10
```

However, in order to fix permissions at the OS level, one has to issue following commands in order to make /dev/ttyS1 accessible by the 'openhab' system user (that is used to start up the openHAB runtime), and to make the tty both readable and writable.
However, to fix permissions at the OS level, issue the following commands to make /dev/ttyS1 accessible by the 'openhab' system user (used to start the openHAB runtime), and to make the tty both readable and writable.

```shell
sudo useradd -G dialout openhab
Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.omnikinverter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ moment of writing the _Omniksol-3.0k-TL2_ has been tested.

## Discovery

No autodiscovery available
No auto-discovery available

## Thing Configuration

Expand All @@ -34,9 +34,9 @@ No autodiscovery available
| currentAC1 | Number:ElectricCurrent | The current for feed 1 to the grid, in ampere by default |
| currentAC2 | Number:ElectricCurrent | The current for feed 2 to the grid, in ampere by default |
| currentAC3 | Number:ElectricCurrent | The current for feed 3 to the grid, in ampere by default |
| frequencyAC1 | Number:Frequency | The frequrence of feed 1 of the grid, in hertz by default |
| frequencyAC2 | Number:Frequency | The frequrence of feed 2 of the grid, in hertz by default |
| frequencyAC3 | Number:Frequency | The frequrence of feed 3 of the grid, in hertz by default |
| frequencyAC1 | Number:Frequency | The frequency of feed 1 of the grid, in hertz by default |
| frequencyAC2 | Number:Frequency | The frequency of feed 2 of the grid, in hertz by default |
| frequencyAC3 | Number:Frequency | The frequency of feed 3 of the grid, in hertz by default |
| currentPV1 | Number:ElectricCurrent | The current generation for input string 1, in ampere by default |
| currentPV2 | Number:ElectricCurrent | The current generation for input string 2, in ampere by default |
| currentPV3 | Number:ElectricCurrent | The current generation for input string 3, in ampere by default |
Expand Down
2 changes: 1 addition & 1 deletion ...org.openhab.binding.omnikinverter/src/main/resources/OH-INF/i18n/omnikinverter.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ thing-type.config.omnikinverter.omnik.port.description = The TCP port of the Omn
thing-type.config.omnikinverter.omnik.refreshInterval.label = Refresh Interval
thing-type.config.omnikinverter.omnik.refreshInterval.description = Interval the device is polled in seconds.
thing-type.config.omnikinverter.omnik.serial.label = Serial
thing-type.config.omnikinverter.omnik.serial.description = The serial of the Omnik inverter's Wifi module. This the number part only.
thing-type.config.omnikinverter.omnik.serial.description = The serial of the Omnik inverter's Wi‑Fi module. This is the number part only.

# channel types

Expand Down
12 changes: 3 additions & 9 deletions bundles/org.openhab.binding.omnikinverter/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 @@ -102,7 +102,7 @@
</parameter>
<parameter name="serial" type="integer" required="true">
<label>Serial</label>
<description>The serial of the Omnik inverter's Wifi module. This the number part only.</description>
<description>The serial of the Omnik inverter's Wi‑Fi module. This is the number part only.</description>
</parameter>
<parameter name="refreshInterval" type="integer" unit="s" min="5">
<label>Refresh Interval</label>
Expand Down Expand Up @@ -202,18 +202,12 @@
<tag>Measurement</tag>
<tag>Temperature</tag>
</tags>
<state readOnly="true" pattern="%.f %unit%"/>
</channel-type>
<channel-type id="hoursTotal">
<item-type>Number:Time</item-type>
<label>Running Hours</label>
<description>The total amount of running hours</description>
<state readOnly="true" pattern="%.f %unit%"/>
<state readOnly="true" pattern="%.1f %unit%"/>
</channel-type>
<channel-type id="hoursTotal">
<item-type>Number:Time</item-type>
<label>Running Hours</label>
<description>The total amount of running hours</description>
<state readOnly="true" pattern="%.f %unit%"/>
<state readOnly="true" pattern="%.0f %unit%"/>
</channel-type>
</thing:thing-descriptions>
2 changes: 1 addition & 1 deletion bundles/org.openhab.binding.omnilink/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ The devices support some of the following trigger channels:
## Rule Actions

This binding includes a rule action, which allows synchronizing the controller time to match the openHAB system time with a user specified zone.
There is a separate instance for each contoller, which can be retrieved through:
There is a separate instance for each controller, which can be retrieved through:

:::: tabs

Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.ondilo/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This binding integrates Ondilo ICO pool monitoring devices with openHAB, allowin
- `ondilo:` Represents an individual Ondilo ICO device

Ondilo ICO Pool as well as Spa devices are supported.
Chlor as well as salt water.
Chlorine as well as salt water.

## Discovery

Expand All @@ -24,7 +24,7 @@ Each Ondilo ICO will appear as a new Thing in the inbox.

### `ondilo` Thing Configuration

- **id**: The Id of an Ondilo ICO device. Set via discovery service (e.g. `12345`)
- **id**: The ID of an Ondilo ICO device. Set via discovery service (e.g. `12345`)

Ondilo ICO takes measures every hour.
Higher polling will not increase the update interval.
Expand All @@ -37,7 +37,7 @@ The requests to the Ondilo Customer API are limited to the following per user qu

Example using default interval:

- `account` Thing performs 2 request per cycle - 8 requests per hour per Ondilo Account
- `account` Thing performs 2 requests per cycle - 8 requests per hour per Ondilo Account
- `ondilo` Thing performs 4 requests per cycle - 16 requests per hour per Ondilo ICO

## Channels
Expand All @@ -63,7 +63,7 @@ Example using default interval:
| tds | Number:Density | false | R | Total dissolved solids in the pool (chlor pools only) |
| tds-trend | Number:Density | true | R | Change in TDS since last measure |
| battery | Number:Dimensionless | false | R | Battery level of the device |
| rssi | Number:Dimensionless | false | R | Signal strength (RSSI) |
| rssi | Number | false | R | Signal strength (RSSI) |
| value-time | DateTime | true | R | Timestamp of the set of measures |

### Recommendations Channels
Expand Down
18 changes: 9 additions & 9 deletions bundles/org.openhab.binding.ondilo/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 @@ -22,7 +22,7 @@
<parameter name="url" type="text" required="true">
<label>openHAB URL</label>
<default>http://localhost:8080</default>
<description>The URL of the openHAB instance. Required for the redirect during oAuth2 flow</description>
<description>The URL of the openHAB instance. Required for the redirect during OAuth2 flow</description>
<context>network-address</context>
</parameter>
<parameter name="refreshInterval" type="integer" required="false" unit="s" min="1">
Expand Down Expand Up @@ -112,8 +112,8 @@
</channel>
<channel id="ph-low" typeId="ph-low-high"/>
<channel id="ph-high" typeId="ph-low-high">
<label>Maximum PH Level</label>
<description>Maximum PH level</description>
<label>Maximum pH Level</label>
<description>Maximum pH level</description>
</channel>
<channel id="orp-low" typeId="orp-low-high"/>
<channel id="orp-high" typeId="orp-low-high">
Expand Down Expand Up @@ -166,17 +166,17 @@
</channel-type>
<channel-type id="ph">
<item-type>Number</item-type>
<label>PH Level</label>
<description>PH level</description>
<label>pH Level</label>
<description>pH level</description>
<tags>
<tag>Measurement</tag>
</tags>
<state readOnly="true" pattern="%.2f"/>
</channel-type>
<channel-type id="ph-trend" advanced="true">
<item-type>Number</item-type>
<label>PH Level Delta</label>
<description>Change in PH level since last measure</description>
<label>pH Level Delta</label>
<description>Change in pH level since last measure</description>
<tags>
<tag>Measurement</tag>
</tags>
Expand Down Expand Up @@ -345,8 +345,8 @@
</channel-type>
<channel-type id="ph-low-high" advanced="true">
<item-type>Number</item-type>
<label>Minimum PH Level</label>
<description>Minimum PH level</description>
<label>Minimum pH Level</label>
<description>Minimum pH level</description>
<tags>
<tag>Setpoint</tag>
</tags>
Expand Down
8 changes: 4 additions & 4 deletions bundles/org.openhab.binding.onebusaway/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OneBusAway Binding

[OneBusAway](https://onebusaway.org/) is an open source, real-time, transit-information service. This binding allows you to get events based on transit arrival and departures, so you can create rules to do something based on that data.
[OneBusAway](https://onebusaway.org/) is an open source, real-time, transit-information service. This binding lets you get events based on transit arrivals and departures, so you can create rules to do something based on that data.

## Preparation

Expand Down Expand Up @@ -37,18 +37,18 @@ The following configuration options are available for a Route (which requires a

## Channels

The Route Thing supports the following state channels:
The Route Thing supports the following channels:

| Channel Type ID | Channel Kind | Item Type | Description |
|------------------|--------------|-----------|----------------------------------------------------------------------------------------------------------|
| arrival | state | DateTime | The arrival time of a Route at a Stop. |
| departure | state | DateTime | The departure time of a Route at a Stop. |
| update | state | DateTime | The last time this data was updated (per the data provider, not the last time openHAB updated the data). |
| arrivalDeparture | trigger | DateTime | Triggered when a Route arrives or departs a Stop. |
| routeEvent | trigger | — | Triggered when a Route arrives or departs a Stop (event values: `ARRIVAL`, `DEPARTURE`). |

### Channel Configurations

The `arrival`, `departure`, and `arrivalDeparture` channels can be configured with an `offset` specifying the number of seconds to move an event back in time.
The `arrival`, `departure`, and `routeEvent` channels can be configured with an `offset` specifying the number of seconds to move an event back in time.

## Full Example

Expand Down
12 changes: 6 additions & 6 deletions bundles/org.openhab.binding.onewire/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ Depending on the chip, either `present`, `temperature`, `digitalX` or `counterX`

### Multisensor (`ms-tx`)

The multisensor is build around the DS2438 or DS1923 chipset.
The multisensor is built around the DS2438 or DS1923 chipset.
It always provides a `temperature` channel.

Depnding on the actual sensor, additional channels (`current`, `humidity`, `light`, `voltage`, `supplyvoltage`) are added.
Depending on the actual sensor, additional channels (`current`, `humidity`, `light`, `voltage`, `supplyvoltage`) are added.
If the voltage input of the DS2438 is connected to a humidity sensor, several common types are supported (see below).

It has three parameters: sensor id `id`, refresh time `refresh` and `manualsensor` (advanced option).
Expand Down Expand Up @@ -115,7 +115,7 @@ Additional channels (`light`, `pressure`, `humidity`, `dewpoint`, `abshumidity`)
Currently this thing only supports BAE0910 sensors.
All functional pins of this sensor have multiple functions which can be configured individually.
For detailed information of each mode, please see the official documentation.
Each pin has the can be configured as `disabled`.
Each pin can be configured as `disabled`.
The necessary channels are automatically added.

Pin 1 (`pin1`) has only one function `counter` (channel `counter`).
Expand Down Expand Up @@ -186,13 +186,13 @@ It defaults to 300s.

### Temperature (`temperature`, `temperature-por`, `temperature-por-res`)

There are three temperature channel types: `temperature`, `temperature-por`and `temperature-por-res`.
There are three temperature channel types: `temperature`, `temperature-por` and `temperature-por-res`.
The correct channel-type is selected automatically by the thing handler depending on the sensor type.

If the channel-type is `temperature`, there is nothing else to configure.

Some sensors (e.g. DS18x20) report 85 °C as Power-On-Reset value.
In some installations this leads to errorneous temperature readings.
In some installations this leads to erroneous temperature readings.
If the `ignorepor` parameter is set to `true` 85 °C values will be filtered.
The default is `false` as correct reading of 85 °C will otherwise be filtered, too.
Please note that the parameter value must not be set in quotation marks (see example below).
Expand Down Expand Up @@ -221,7 +221,7 @@ The duty cycle can be set from 0-100%.
### BAE PIO (`bae-pio`)

The PIO channel (programmable I/O channel) has two configuration options: `mode` and `pulldevice`.
The `mode`can be set to `input`or `output`.
The `mode` can be set to `input` or `output`.
The default is `input`.

The `pulldevice` is only relevant for `input` mode.
Expand Down
16 changes: 7 additions & 9 deletions bundles/org.openhab.binding.onewiregpio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OneWire GPIO Binding

This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on Raspberry Pi.
This binding reads temperature values from OneWire bus sensors connected to the GPIO bus on a Raspberry Pi.

## Supported Things

Expand All @@ -9,18 +9,16 @@ Tested successfully with DS18B20 sensor on Raspberry Pi 3.

## Binding Configuration

The binding requires OneWire sensor to be properly connected to Raspberry Pi GPIO bus,
"w1_gpio" and "wire" kernel modules should be loaded.
Configuration is proper when /sys/bus/w1/devices folder is present, and contains sensor's data.
The binding requires a OneWire sensor properly connected to the Raspberry Pi GPIO bus; the "w1_gpio" and "wire" kernel modules must be loaded.
Configuration is correct when the `/sys/bus/w1/devices` folder is present and contains the sensor's data.

## Thing Configuration

The sensors are visible in the system as folders containing files with sensor data.
By default all OneWire GPIO devices are stored in /sys/bus/w1/devices/DEVICE_ID_FOLDER,
and the temperature value is available in the file "w1_slave". The Thing needs full path to the w1_slave file.
By default, all OneWire GPIO devices are stored in `/sys/bus/w1/devices/DEVICE_ID_FOLDER`, and the temperature value is available in the file `w1_slave`. The Thing needs the full path to the `w1_slave` file.
Note the values in sysfs are in Celsius.

Optional parameter precision makes it easier to lower precision of the sensor value, i.e. precision 1 makes sensor value to show only one digit after the floating point, precision 2 - shows 2 digits. It makes precision reduction with round up, i.e. 20.534C with precision 1 will be 20.5C, 20.555 with same precision will be 20.6C. Allowed values are from 0 to 3. Default value of parameter is 3(max precision).
The optional `precision` parameter lets you lower the precision of the sensor value, e.g., precision `1` shows one digit after the decimal point, precision `2` shows two digits. Rounding is applied (e.g., 20.534 °C with precision 1 becomes 20.5 °C; 20.555 °C with the same precision becomes 20.6 °C). Allowed values are from 0 to 3. The default is 3 (maximum precision).

In the thing file, this looks e.g. like

Expand All @@ -30,7 +28,7 @@ Thing onewiregpio:sensor:livingRoom "Living room" [gpio_bus_file="/sys/bus/w1/de

## Channels

The devices supports currently one channel - "temperature" which allows to read temperature from OneWire temperature sensor.
The device currently supports one channel, "temperature", which reads the temperature from the OneWire sensor.

## Full Example

Expand All @@ -42,7 +40,7 @@ Thing onewiregpio:sensor:livingroom "Living room" [gpio_bus_file="/sys/bus/w1/de

sample onewiregpio.items file content (implements QuantityType for unit conversion):

``` java
```java
Number:Temperature LivingRoomTemperature "Temperature: [%.2f %unit%]" <temperature> { channel="onewiregpio:sensor:livingroom:temperature" }
```

Expand Down
Loading