Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Heberling <[email protected]>
  • Loading branch information
tisoft committed Dec 4, 2023
1 parent 8ea88fa commit 5b2c705
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 27 deletions.
20 changes: 16 additions & 4 deletions bundles/org.openhab.binding.bluetooth.grundfosalpha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,22 @@ All readers are auto-detected as soon as Bluetooth is configured in openHAB and
| flow-rate | Number:VolumetricFlowRate | R | The flow rate of the pump |
| pump-head | Number:Length | R | The water head above the pump |
| pump-temperature | Number:Temperature | R | The temperature of the pump |
| battery-level | Number:Percent | R | The battery level of the reader |
| battery-level | Number:Dimensionless | R | The battery level of the reader |

## Full Example

_Provide a full usage example based on textual configuration files._
_*.things, *.items examples are mandatory as textual configuration is well used by many users._
_*.sitemap examples are optional._
grundfos_alpha.things (assuming you have a Bluetooth bridge with the ID `bluetooth:bluegiga:adapter1`:

```
bluetooth:mi401:hci0:sensor1 "Grundfos Alpha Reader 1" (bluetooth:bluegiga:adapter1) [ address="12:34:56:78:9A:BC" ]
```

grundfos_alpha.items:

```
Number RSSI "RSSI [%.1f dBm]" <QualityOfService> { channel="bluetooth:mi401:hci0:sensor1:rssi" }
Number:VolumetricFlowRate Flow_rate "Flowrate [%.1f %unit%]" <flow> { channel="bluetooth:mi401:hci0:sensor1:flow-rate" }
Number:Length Pump_Head "Pump head [%.1f %unit%]" <water> { channel="bluetooth:mi401:hci0:sensor1:pump-head" }
Number:Temperature Pump_Temperature "Temperature [%.1f %unit%]" <temperature> { channel="bluetooth:mi401:hci0:sensor1:pump-temperature" }
Number:Dimensionless Battery_Level "Battery Level [%d %%]" <Battery> { channel="bluetooth:mi401:hci0:sensor1:battery-level" }
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# thing types

thing-type.bluetooth.mi401.label = Grundfos Alpha Reader MI401
thing-type.bluetooth.mi401.description = A Grundfos Alpha Reader MI401

# thing types config

thing-type.config.bluetooth.mi401.address.label = Address
thing-type.config.bluetooth.mi401.address.description = Bluetooth address in XX:XX:XX:XX:XX:XX format

# channel types

channel-type.bluetooth.grundfos-flow.label = Current Flow
channel-type.bluetooth.grundfos-flow.description = Current flow
channel-type.bluetooth.grundfos-head.label = Current Head
channel-type.bluetooth.grundfos-head.description = Current head
channel-type.bluetooth.grundfos-temperature.label = Current Pump Temperature
channel-type.bluetooth.grundfos-temperature.description = Current pump temperature

This file was deleted.

0 comments on commit 5b2c705

Please sign in to comment.