public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[Documentation] Markdown improvements n to s (#13948)

Browse Source 
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
This commit is contained in:
Jerome Luckenbach
2022-12-14 16:52:43 +01:00
committed by GitHub
parent d73218d882
commit 1ca9baf157
106 changed files with 4506 additions and 4729 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
bundles/org.openhab.binding.networkupstools/README.md
View File

@@ -21,16 +21,15 @@ Some of these could change, like of 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:
| Property | Description
|------------------|----------------------------------------
| ups.firmware | UPS firmware
| ups.firmware.aux | Auxiliary device firmware
| ups.id | UPS system identifier
| ups.mfr | UPS manufacturer
| ups.mfr.date | UPS manufacturing date
| ups.model | UPS model
| ups.serial | UPS serial number
| Property | Description |
| ---------------- | ------------------------- |
| ups.firmware | UPS firmware |
| ups.firmware.aux | Auxiliary device firmware |
| ups.id | UPS system identifier |
| ups.mfr | UPS manufacturer |
| ups.mfr.date | UPS manufacturing date |
| ups.model | UPS model |
| ups.serial | UPS serial number |
## Discovery
@@ -42,41 +41,41 @@ The thing configuration requires the name of the UPS device as configured on the
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.
| Parameter | Default | Mandatory | Description
|-----------|-----------|----------|-------------
| device | | Yes | UPS device name, `ups` for example
| host | localhost | Yes | UPS server hostname
| port | 3493 | No | UPS server port, 3493 for example
| username | | No | UPS server username
| password | | No | UPS server password
| refresh | 60 | No | Refresh interval for channel updates in seconds
| Parameter | Default | Mandatory | Description |
| --------- | --------- | --------- | ----------------------------------------------- |
| device | | Yes | UPS device name, `ups` for example |
| host | localhost | Yes | UPS server hostname |
| port | 3493 | No | UPS server port, 3493 for example |
| username | | No | UPS server username |
| password | | No | UPS server password |
| refresh | 60 | No | Refresh interval for channel updates in seconds |
## Channels
The following channels are available:
| Channel Name | Item Type | Unit | Description | Advanced |
|----------------------------|--------------------------|------|------------------------------------------------------------------------------------|---------------|
| upsAlarm | String | | UPS alarms | no |
| 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 |
| 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 |
| inputCurrentStatus | String | | Status relative to the thresholds | yes |
| inputLoad | Number:Dimensionless | % | Load on (ePDU) input (percent of full) | no |
| inputRealpower | Number:Power | W | Current sum value of all (ePDU) phases real power (W) | yes |
| inputQuality | String | | Input power quality (*** opaque) | yes |
| inputTransferReason | String | | Reason for last transfer to battery (*** opaque) | yes |
| inputVoltage | Number:ElectricPotential | V | Input voltage (V) | yes |
| inputVoltageStatus | String | | Status relative to the thresholds | yes |
| outputCurrent | Number:ElectricCurrent | A | Output current (A) | yes |
| outputVoltage | Number:ElectricPotential | V | Output voltage (V) | yes |
| batteryCharge | Number:Dimensionless | % | Battery charge (percent) | no |
| batteryRuntime | Number:Time | s | Battery runtime (seconds) | no |
| batteryVoltage | Number:ElectricPotential | V | Battery voltage (V) | yes |
| Channel Name | Item Type | Unit | Description | Advanced |
| ------------------- | ------------------------ | ---- | ------------------------------------------------------------------- | -------- |
| upsAlarm | String | | UPS alarms | no |
| 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 |
| 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 |
| inputCurrentStatus | String | | Status relative to the thresholds | yes |
| inputLoad | Number:Dimensionless | % | Load on (ePDU) input (percent of full) | no |
| inputRealpower | Number:Power | W | Current sum value of all (ePDU) phases real power (W) | yes |
| inputQuality | String | | Input power quality (*** opaque) | yes |
| inputTransferReason | String | | Reason for last transfer to battery (*** opaque) | yes |
| inputVoltage | Number:ElectricPotential | V | Input voltage (V) | yes |
| inputVoltageStatus | String | | Status relative to the thresholds | yes |
| outputCurrent | Number:ElectricCurrent | A | Output current (A) | yes |
| outputVoltage | Number:ElectricPotential | V | Output voltage (V) | yes |
| batteryCharge | Number:Dimensionless | % | Battery charge (percent) | no |
| batteryRuntime | Number:Time | s | Battery runtime (seconds) | no |
| batteryVoltage | Number:ElectricPotential | V | Battery voltage (V) | yes |
### Dynamic Channels
@@ -86,23 +85,22 @@ Channels can be created with as type: `Number`, `Number:<Quantity>`, `String` or
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"`
| Property | Description | Example |
| --------------- | ------------------------------ | --------------------------------------------- |
| networkupstools | Links to NUT variable | `networkupstools="input.voltage.low.warning"` |
| unit | The unit of Quantity Type data | `unit="V"` |
## Full Example
ups.things:
```
```java
Thing networkupstools:ups:ups1 [ device="ups", host="localhost", refresh=60 ]
```
ups-with-channels.things:
```
```java
Thing networkupstools:ups:ups2 [ device="ups", host="localhost", refresh=60 ] {
Channels:
String : testResult "Test Result" [networkupstools="ups.test.result"]
@@ -114,7 +112,7 @@ Thing networkupstools:ups:ups2 [ device="ups", host="localhost", refresh=60 ] {
ups.items
```
```java
Number:Dimensionless ups_battery_charge "Battery Charge [%d %%]" {channel="networkupstools:ups:ups1:batteryCharge"}
Number:ElectricCurrent ups_current "Input Current [%d mA]"{channel="networkupstools:ups:ups1:inputCurrent"}