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

80
bundles/org.openhab.binding.resol/README.md
View File

@@ -6,7 +6,6 @@ Resol Binding connects to Solar and System Controllers of RESOL - Elektronische
This binding is based on and includes the [Resol-VBUS-Java library](https://github.com/danielwippermann/resol-vbus-java), developed by Daniel Wippermann.
## Supported Things
### Bridge
@@ -19,55 +18,53 @@ In the binding might support USB-type bridges in future.
### Device
On top of the bridge things, which enable access to the VBUS, many - if not all - Resol Controllers and Modules like WMZ heat meters, HKM Heating circuit extensions etc. are supported including branded versions from different suppliers as thing type *device*.
On top of the bridge things, which enable access to the VBUS, many - if not all - Resol Controllers and Modules like WMZ heat meters, HKM Heating circuit extensions etc. are supported including branded versions from different suppliers as thing type _device_.
The supported devices include
* Solar controller DeltaSol® A/AX/AX HE
* Solar controller DeltaSol® AL E HE
* Solar controller DeltaSol® CS (Plus)
* Solar controller DeltaSol® B
* Solar controller DeltaSol® BS series
* Solar controller DeltaSol® SLL
* Solar controller DeltaSol® SL
* Solar controller DeltaSol® BX series
* System controller DeltaSol® SLT
* System controller DeltaSol® MX
* System controller DeltaSol® E
* DeltaSol Fresh®
* DeltaSol® Pool
* DeltaSol® Minipool
* DeltaSol® ES
* Frista
* DeltaTherm® HC
* DeltaTherm® FK
* Deltatherm® HT
* DeltaTherm® DH
* Sonnenkraft SKSC3
* Sonnenkraft STRG BX PLUS
* Sonnenkraft SKSC3+
* Sonnenkraft SKSC3HE
* Sonnenkraft SKSR 1/2/3
* Vitosolic 200
* COSMO Multi
* Drainback DeDietrich
* Diemasol C
- Solar controller DeltaSol® A/AX/AX HE
- Solar controller DeltaSol® AL E HE
- Solar controller DeltaSol® CS (Plus)
- Solar controller DeltaSol® B
- Solar controller DeltaSol® BS series
- Solar controller DeltaSol® SLL
- Solar controller DeltaSol® SL
- Solar controller DeltaSol® BX series
- System controller DeltaSol® SLT
- System controller DeltaSol® MX
- System controller DeltaSol® E
- DeltaSol Fresh®
- DeltaSol® Pool
- DeltaSol® Minipool
- DeltaSol® ES
- Frista
- DeltaTherm® HC
- DeltaTherm® FK
- Deltatherm® HT
- DeltaTherm® DH
- Sonnenkraft SKSC3
- Sonnenkraft STRG BX PLUS
- Sonnenkraft SKSC3+
- Sonnenkraft SKSC3HE
- Sonnenkraft SKSR 1/2/3
- Vitosolic 200
- COSMO Multi
- Drainback DeDietrich
- Diemasol C
A more complete list can be found in the doc of the [resol-vbus-java library](https://danielwippermann.github.io/resol-vbus/vbus-packets.html).
### Emulated Extension Module EM
Some controllers like the Deltasol MX can be connected to an extension module, which can be emulated by the thing type *emulatedEM*.
Some controllers like the Deltasol MX can be connected to an extension module, which can be emulated by the thing type _emulatedEM_.
The emulated EM is a virtual device, visible on the VBUS to a Resol controller and provides an interface between openHAB and the controller.
Relay channels are outputs from the controller point of view and therefore read-only in OH.
The sensor channels as inputs for the solar or system controller and intended to be written by OH.
## Discovery
Discovery is tested for VBus-LAN adapters DL2, DL3 and KM2 devices, it should also work for other devices providing a live data port.
After a bridge is detected in the local network the password needs to be given and the things on the VBUS will popup in the inbox.
## Bridge Configuration
The bridge is the device connecting the Resol VBUS to the network, usually a VBus-LAN adapter or integrated in some of the solar controllers like DL3.
@@ -89,13 +86,12 @@ For configuration in files you can enable the logging with at least DEBUG level
## Emulated EM Configuration
*emulatedEM* devices cannot be auto-discovered and require beside the bridge the following configuration:
_emulatedEM_ devices cannot be auto-discovered and require beside the bridge the following configuration:
| Parameter | Type | Required | Description |
|-----------|------|----------|-----------------------------------------------------------------------------------------------------------------|
| moduleID | int | yes | The module ID on the VBUS in range 0-15, but further restrictions might apply depending on the resol controller. |
## Device Channels
The channels of a thing are determined automatically based on the received VBUS data and are highly dependent on the used device.
@@ -128,20 +124,18 @@ The channels supported for your device can be seen in the UI or in the logs if D
| volume_month | Number:Volume | This months volume (of a HQM) |
| power | Number:Power | Current power (of a HQM) |
Channels are dynamically created dependent on the devices connected to the VBus.
So far only reading is supported.
The classical channels are for temperature sensors and the like, but also relay outputs with the output level (0-100%) are visible as numerical values with the corresponding unit.
String values are localized as far as possible, but only French, German and English are supported by the underlaying library which is based on the vbus-specification file from Resol.
## EmulatedEM Channels
The channels of an emulated EM modules are as for physical EMs 5 relay channels and 6 input channels.
The relays are virtual outputs and read-only in OH.
The sensors support different types like temperature input which are simulated by a PT1000 resistance value, a switch and the raw resistance value.
Additionally the virtual input device for adjusting the heating circuits as a *BAS* is supported by two different channels for temperature and mode adjustment.
Additionally the virtual input device for adjusting the heating circuits as a _BAS_ is supported by two different channels for temperature and mode adjustment.
The type of the sensor inputs must be configured in the Resol Controller accordingly.
From all possible sensor channels (temperatureX, switchX, etc.) only one shall be linked to an item at a time, except for BAS which emulates a RCP12 room control unit where both, BasTempAdjustmentX and BasModeX shall be written from OH.
@@ -154,15 +148,13 @@ From all possible sensor channels (temperatureX, switchX, etc.) only one shall b
| BasTempAdjustmentX | Number:Temperature | Writable temperature adjustment for the virtual room control module BAS on the for the virtual input for sensor 'x'. Use together with BasModeX, not effective if BasModeX is OFF or Party. |
| BasModeX | Number | Writable heating circuit mode for the virtual room control module BAS on the for the virtual input for sensor 'x'. Use together with BasTempAdjustmentX.|
## Full Example
For a DeltaSol MX system controller with on extension module EM you can use this example:
resol.things
```
```java
Bridge resol:vbuslan:VBUS "VBUSLAN" [ ipAddress="192.168.0.2", password="vbus", port=7053] {
Thing device DeltaSol_MX-Controller "DeltaSol MX [Controller]" []
Thing device DeltaSol_MX-Heating_circuit-1 "DeltaSol MX [Heating Circuit]" []
@@ -174,7 +166,7 @@ Bridge resol:vbuslan:VBUS "VBUSLAN" [ ipAddress="192.168.0.2", password="vbus",
resol.items
```
```java
/*************************************************/
/* Solar system */
/*************************************************/
@@ -227,7 +219,7 @@ String BrokenSensor "Broken Sensor [%s]" {channel="resol:device:VBUS:DeltaSol_MX
resol.sitemap
```
```perl
sitemap resol label="DeltaSol MX" {
Frame label="Solar" {
Text item=SolarTemperature valuecolor=[<0="white", <20="blue", <50="green", <80="orange", <120="red", >=120="black"]