demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/danieldemus/openhab-addons synced 2026-07-31 13:34:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation, grammar, and spelling in bindings N (#19549)

Browse Source 
Signed-off-by: Leo Siepel <leosiepel@gmail.com>
This commit is contained in:
lsiepel
2025-12-25 16:41:53 +01:00
committed by GitHub
parent 67de44c1f9
commit 2fc036812e
43 changed files with 531 additions and 513 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bundles/org.openhab.binding.networkupstools/README.md
+16 -16
View File
@@ -3,23 +3,23 @@
The primary goal of the [Network UPS Tools](https://networkupstools.org/) (NUT) project is to provide support for power devices, such as uninterruptible power supplies (UPS), Power Distribution Units and Solar Controllers.
Network UPS Tools (NUT) provides many control and monitoring features, with a uniform control and management interface.
More than 100 different manufacturers, and several thousands of models are compatible.
More than 100 different manufacturers and several thousand models are compatible.
This binding lets you integrate NUT servers with openHAB.
## Supported Things
The binding can connect to multiple NUT instances.
The thing is an `ups` thing.
The thing supports a number of NUT features out-of-the-box and supports the option to configure additional channels to get other NUT variables.
The thing queries the NUT server for the status of the UPS approximate every 3 seconds and updates the status when a change happens.
When a change of the UPS status happens it will query the NUT server to update all linked channels.
Outside the status change updates, all linked channels are updated at the user configured refresh time.
The Thing is an `ups` Thing.
The Thing supports a number of NUT features out-of-the-box and supports the option to configure additional channels to get other NUT variables.
The Thing queries the NUT server for the status of the UPS approximately every 3 seconds and updates the status when a change happens.
When a change to the UPS status occurs, it will query the NUT server to update all linked channels.
Outside of status changes, all linked channels are updated at the user-configured refresh interval.
Some NUT variables are static in nature and are not suited for a channel.
Some of these could change, like of firmware version.
Some of these could change, like the firmware version.
Therefore these properties are updated with a 1 hour frequency.
The following NUT variables are read and added to the thing as properties:
The following NUT variables are read and added to the Thing as properties:
| Property | Description |
| ---------------- | ------------------------- |
@@ -37,9 +37,9 @@ Discovery is not supported.
## Thing Configuration
The thing configuration requires the name of the UPS device as configured on the NUT server.
If the NUT service isn't running locally the ip address or domain name (FDQN) of the server running NUT must be configured.
Optional, port, username and password might need to be configured if required.
The Thing configuration requires the name of the UPS device as configured on the NUT server.
If the NUT service isn't running locally, the IP address or domain name (FQDN) of the server running NUT must be configured.
Optionally, the port, username, and password might need to be configured if required.
| Parameter | Default | Mandatory | Description |
| --------- | --------- | --------- | ----------------------------------------------- |
@@ -60,7 +60,7 @@ The following channels are available:
| upsLoad | Number:Dimensionless | % | Load on UPS (percent) | yes |
| upsPower | Number:Power | VA | Current value of apparent power (Volt-Amps) | yes |
| upsRealpower | Number:Power | W | Current value of real power (Watts) | no |
| upsStatus | String | | Status of the UPS: OFF, OL,OB,LB,RB,OVER,TRIM,BOOST,CAL,BYPASS,NULL | no |
| upsStatus | String | | Status flags for the UPS. | no |
| upsTemperature | Number:Temperature | °C | UPS temperature (degrees C) | yes |
| upsTestResult | String | | Results of last self test (opaque string) | yes |
| inputCurrent | Number:ElectricCurrent | A | Input current (A) | yes |
@@ -80,16 +80,16 @@ The following channels are available:
### Dynamic Channels
Because there is a lot of variation in UPS features, the binding supports dynamically adding channels for features, not supported out-of-the-box.
To get data from another NUT variable the channel needs to configured.
Channels can be created with as type: `Number`, `Number:<Quantity>`, `String` or `Switch`.
Because there is a lot of variation in UPS features, the binding supports dynamically adding channels for features not supported out of the box.
To get data from another NUT variable, the channel needs to be configured.
Channels can be created with the types: `Number`, `Number:<Quantity>`, `String`, or `Switch`.
The following channel properties are needed:
| Property | Description | Example |
| --------------- | ------------------------------ | --------------------------------------------- |
| networkupstools | Links to NUT variable | `networkupstools="input.voltage.low.warning"` |
| unit | The unit of Quantity Type data | `unit="V"` |
| unit | The unit for QuantityType data | `unit="V"` |
## Full Example
bundles/org.openhab.binding.networkupstools/src/main/resources/OH-INF/i18n/networkupstools.properties
+1 -1
View File
@@ -78,7 +78,7 @@ channel-type.networkupstools.ups-power.description = Current value of apparent p
channel-type.networkupstools.ups-realpower.label = UPS Realpower
channel-type.networkupstools.ups-realpower.description = Current value of real power (Watts)
channel-type.networkupstools.ups-status.label = UPS Status
channel-type.networkupstools.ups-status.description = Status of the UPS: OFF, OL,OB,LB,RB,OVER,TRIM,BOOST,CAL,BYPASS,NULL
channel-type.networkupstools.ups-status.description = Status flags for the UPS.
channel-type.networkupstools.ups-status.state.option.OFF = Off
channel-type.networkupstools.ups-status.state.option.OL = Online
channel-type.networkupstools.ups-status.state.option.OB = On battery
bundles/org.openhab.binding.networkupstools/src/main/resources/OH-INF/thing/channels.xml
+1 -1
View File
@@ -42,7 +42,7 @@
<channel-type id="ups-status">
<item-type>String</item-type>
<label>UPS Status</label>
<description>Status of the UPS: OFF, OL,OB,LB,RB,OVER,TRIM,BOOST,CAL,BYPASS,NULL</description>
<description>Status flags for the UPS.</description>
<tags>
<tag>Status</tag>
<tag>Mode</tag>