OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external content (Jenkins build 788)

pull/1839/head
openHAB Build Server 2022-02-10 03:35:09 +00:00
parent 0d0cea956c
commit 1cebe7e440
5 changed files with 187 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.vuepress/thing-types.json
View File

File diff suppressed because one or more lines are too long

70
_addons_bindings/guntamatic/readme.md
View File

@ -20,39 +20,41 @@ The Guntamatic Binding can be used to monitor and control [Guntamatic Heating Sy
## Supported Things
The Guntamatic Binding was developed and tested using Guntamatic Biostar 15kW Pellets Heating System, running Firmware 3.2d.
It should work for all other Guntamatic Heating Systems as well, that support the same web interface.
It should work for all other Guntamatic Heating Systems as well, that support the same web interface (Pellets, WoodChips, EnergyGrain as well as Log Heating Systems).
## Things
Guntamatic Heating Systems supported as Thing Types:
| Name | Thing Type ID | Status |
|---------------|---------------|-----------------------------------|
| Biostar | `biostar` | tested via 15kW, firmware 3.2d |
| Powerchip | `powerchip` | untested |
| Powercorn | `powercorn` | untested |
| Biocom | `biocom` | untested |
| Pro | `pro` | untested |
| Therm | `therm` | untested |
| Name | Thing Type ID | Heating System Type | Binding Development Status |
|---------------|---------------|----------------------|--------------------------------------------------|
| Biostar | `biostar` | Pellets | tested via 15kW, firmware 3.2d, German & English |
| Biosmart | `biosmart` | Logs | tested via 22kW, firmware 3.2f, German |
| Powerchip | `powerchip` | WoodChips | tested via 100kW, firmware 3.2d, French |
| Powercorn | `powercorn` | EnergyGrain | untested |
| Biocom | `biocom` | Pellets | untested |
| Pro | `pro` | Pellets or WoodChips | untested |
| Therm | `therm` | Pellets | untested |
| Generic | `generic` | - | use, if none from above |
### Thing Configuration
| Parameter | Description | Default |
|------------------|-----------------------------------------------------------------------------|-----------------|
| `hostname` | Hostname or IP address of the Guntamatic Heating System | |
| `key` | Optional, but required to read protected parameters and to control the Guntamatic Heating System.<br/>The key needs to be requested from Guntamatic support, e.g. via https://www.guntamatic.com/en/contact/. | |
| `refreshInterval` | Interval the Guntamatic Heating System is polled in seconds | `60` |
| `encoding` | Code page used by the Guntamatic Heating System | `windows-1252` |
| Parameter | Description | Default |
|--------------------|-----------------------------------------------------------------------------|-----------------|
| `hostname` | Hostname or IP address of the Guntamatic Heating System | |
| `key` | Optional, but required to read protected parameters and to control the Guntamatic Heating System.<br/>The key needs to be requested from Guntamatic support, e.g. via https://www.guntamatic.com/en/contact/. | |
| `refreshInterval` | Interval the Guntamatic Heating System is polled in seconds | `60` |
| `encoding` | Code page used by the Guntamatic Heating System | `windows-1252` |
### Properties
| Property | Description |
|---------------------|---------------------------------------------------------------|
| `extraWwHeat` | Parameter used by `controlExtraWwHeat` channels |
| `boilerApproval` | Parameter used by `controlBoilerApproval` channel |
| `heatCircProgram` | Parameter used by `controlHeatCircProgram` channels |
| `program` | Parameter used by `controlProgram` channel |
| `wwHeat` | Parameter used by `controlWwHeat` channels |
| Property | Description | Supported |
|---------------------|---------------------------------------------------------------|---------------------------------------------------|
| `extraWwHeat` | Parameter used by `controlExtraWwHeat` channels | all |
| `boilerApproval` | Parameter used by `controlBoilerApproval` channel | Biostar, Powerchip, Powercorn, Biocom, Pro, Therm |
| `heatCircProgram` | Parameter used by `controlHeatCircProgram` channels | all |
| `program` | Parameter used by `controlProgram` channel | all |
| `wwHeat` | Parameter used by `controlWwHeat` channels | all |
## Channels
@ -60,10 +62,10 @@ Guntamatic Heating Systems supported as Thing Types:
The Guntamatic Heating System can be controlled using the following channels:
| Channel | Description | Type | Unit | Security Access Level | ReadOnly | Advanced |
|-----------------------|-----------------------------------------------------------|-------|:---------:|:-------------------------:|:--------:|:--------:|
| `controlBoilerApproval` | Set Boiler Approval (`AUTO`, `OFF`, `ON`) | `String` | | 🔐 W1 | R/W | true |
| `controlProgram` | Set Program (`OFF`, `NORMAL`, `WARMWATER`, `MANUAL`) | `String` | | 🔐 W1 | R/W | false |
| Channel | Description | Type | Unit | Security Access Level | ReadOnly | Advanced |
|-----------------------|---------------------------------------------------------------------------|-------|:---------:|:-------------------------:|:--------:|:--------:|
| `controlBoilerApproval` | Set Boiler Approval (`AUTO`, `OFF`, `ON`) | `String` | | 🔐 W1 | R/W | true |
| `controlProgram` | Set Program (`OFF`, `NORMAL`, `WARMWATER`, `MANUAL`<sup id="a1">[1](#f1)</sup>) | `String` | | 🔐 W1 | R/W | false |
| `controlHeatCircProgram0` | Set Heat Circle 0 Program (`OFF`, `NORMAL`, `HEAT`, `LOWER`) | `String` | | 🔐 W1 | R/W | true |
| `controlHeatCircProgram1` | Set Heat Circle 1 Program (`OFF`, `NORMAL`, `HEAT`, `LOWER`) | `String` | | 🔐 W1 | R/W | true |
| `controlHeatCircProgram2` | Set Heat Circle 2 Program (`OFF`, `NORMAL`, `HEAT`, `LOWER`) | `String` | | 🔐 W1 | R/W | true |
@ -73,18 +75,22 @@ The Guntamatic Heating System can be controlled using the following channels:
| `controlHeatCircProgram6` | Set Heat Circle 6 Program (`OFF`, `NORMAL`, `HEAT`, `LOWER`) | `String` | | 🔐 W1 | R/W | true |
| `controlHeatCircProgram7` | Set Heat Circle 7 Program (`OFF`, `NORMAL`, `HEAT`, `LOWER`) | `String` | | 🔐 W1 | R/W | true |
| `controlHeatCircProgram8` | Set Heat Circle 8 Program (`OFF`, `NORMAL`, `HEAT`, `LOWER`) | `String` | | 🔐 W1 | R/W | true |
| `controlWwHeat0` | Trigger Warm Water Circle 0 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlWwHeat1` | Trigger Warm Water Circle 1 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlWwHeat2` | Trigger Warm Water Circle 2 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlExtraWwHeat0` | Trigger Extra Warm Water Circle 0 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlExtraWwHeat1` | Trigger Extra Warm Water Circle 1 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlExtraWwHeat2` | Trigger Extra Warm Water Circle 2 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlWwHeat0` | Trigger Warm Water Circle 0 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlWwHeat1` | Trigger Warm Water Circle 1 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlWwHeat2` | Trigger Warm Water Circle 2 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlExtraWwHeat0` | Trigger Extra Warm Water Circle 0 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlExtraWwHeat1` | Trigger Extra Warm Water Circle 1 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
| `controlExtraWwHeat2` | Trigger Extra Warm Water Circle 2 (`RECHARGE`) | `String` | | 🔐 W1 | R/W | true |
- <b id="f1">1)</b> ... `MANUAL` is supported by Biostar, Powerchip, Powercorn, Biocom, Pro as well as Therm only [↩](#a1)
#### Response of Control Channels
- `{"ack":"confirmation message"}` ... in case of success
- `{"err":"error message"}` ... in case of error
The reaction of the Guntamatic Heating System can be monitored via the corresponding data channel. E.g. `programHc1` if you triggered `controlHeatCircProgram1`. The data channel gets updated with the next cyclic update (according to the `refreshInterval` configuration).
### Monitoring Channels
The Binding dynamically generates Channels, derived from the data provided from the actual Guntamatic Heating System.

4
_addons_bindings/omnilink/readme.md
View File

@ -103,7 +103,7 @@ The devices support some of the following channels:
| `zone_volume` | Dimmer | Volume level of this audio zone. | `audio_zone` |
| `zone_source` | Number | Source for this audio zone. | `audio_zone` |
| `zone_control` | Player | Control the audio zone, e.g. start/stop/next/previous. | `audio_zone` |
| `sysdate` | DateTime | Set controller date/time. | `controller` |
| `system_date` | DateTime | Set controller date/time. | `controller` |
| `last_log` | String | Last log message on the controller, represented in JSON. | `controller` |
| `enable_disable_beeper` | Switch | Enable/Disable the beeper for this/all console(s). | `controller`, `console` |
| `beep` | Switch | Send a beep command to this/all console(s). | `controller`, `console` |
@ -268,7 +268,7 @@ Switch MainButton "Toggle button [%s]" <switch> {channel="omnilink:butto
/*
* Other OmniPro items
*/
DateTime OmniProTime "Last Time Update [%1$ta %1$tR]" <time> {channel="omnilink:controller:home:sysdate"}
DateTime OmniProTime "Last Time Update [%1$ta %1$tR]" <time> {channel="omnilink:controller:home:system_date"}
```
### Example `therm-status.map`

150
_thing_types/org.openhab.binding.guntamatic/src/main/resources/OH-INF/thing/thing-types.xml
View File

@ -7,7 +7,7 @@
<thing-type id="biostar">
<label>Guntamatic Biostar</label>
<description>Guntamatic Biostar Heating System</description>
<description>Guntamatic Biostar Pellets Heating System</description>
<channels>
<channel id="controlBoilerApproval" typeId="controlBoilerApproval">
@ -71,10 +71,73 @@
</properties>
<config-description-ref uri="thing-type:guntamatic:heatingsystem"/>
</thing-type>
<thing-type id="biosmart">
<label>Guntamatic Biosmart</label>
<description>Guntamatic Biosmart Log Heating System</description>
<channels>
<channel id="controlProgram" typeId="controlProgramWOManu">
<label>Set Program</label>
</channel>
<channel id="controlHeatCircProgram0" typeId="controlHeatCircProgram">
<label>Set Heat Circle 0 Program</label>
</channel>
<channel id="controlHeatCircProgram1" typeId="controlHeatCircProgram">
<label>Set Heat Circle 1 Program</label>
</channel>
<channel id="controlHeatCircProgram2" typeId="controlHeatCircProgram">
<label>Set Heat Circle 2 Program</label>
</channel>
<channel id="controlHeatCircProgram3" typeId="controlHeatCircProgram">
<label>Set Heat Circle 3 Program</label>
</channel>
<channel id="controlHeatCircProgram4" typeId="controlHeatCircProgram">
<label>Set Heat Circle 4 Program</label>
</channel>
<channel id="controlHeatCircProgram5" typeId="controlHeatCircProgram">
<label>Set Heat Circle 5 Program</label>
</channel>
<channel id="controlHeatCircProgram6" typeId="controlHeatCircProgram">
<label>Set Heat Circle 6 Program</label>
</channel>
<channel id="controlHeatCircProgram7" typeId="controlHeatCircProgram">
<label>Set Heat Circle 7 Program</label>
</channel>
<channel id="controlHeatCircProgram8" typeId="controlHeatCircProgram">
<label>Set Heat Circle 8 Program</label>
</channel>
<channel id="controlWwHeat0" typeId="controlWwHeat">
<label>Trigger Warm Water Circle 0</label>
</channel>
<channel id="controlWwHeat1" typeId="controlWwHeat">
<label>Trigger Warm Water Circle 1</label>
</channel>
<channel id="controlWwHeat2" typeId="controlWwHeat">
<label>Trigger Warm Water Circle 2</label>
</channel>
<channel id="controlExtraWwHeat0" typeId="controlExtraWwHeat">
<label>Trigger Extra Warm Water Circle 0</label>
</channel>
<channel id="controlExtraWwHeat1" typeId="controlExtraWwHeat">
<label>Trigger Extra Warm Water Circle 1</label>
</channel>
<channel id="controlExtraWwHeat2" typeId="controlExtraWwHeat">
<label>Trigger Extra Warm Water Circle 2</label>
</channel>
</channels>
<properties>
<property name="program">PR001</property>
<property name="heatCircProgram">HKx01</property>
<property name="wwHeat">BKx06</property>
<property name="extraWwHeat">ZKx06</property>
</properties>
<config-description-ref uri="thing-type:guntamatic:heatingsystem"/>
</thing-type>
<thing-type id="powerchip">
<label>Guntamatic Powerchip</label>
<description>Guntamatic Powerchip Heating System. Untested! Please provide Feedback!</description>
<description>Guntamatic Powerchip WoodChip Heating System</description>
<channels>
<channel id="controlBoilerApproval" typeId="controlBoilerApproval">
@ -141,7 +204,7 @@
<thing-type id="powercorn">
<label>Guntamatic Powercorn</label>
<description>Guntamatic Powercorn Heating System. Untested! Please provide Feedback!</description>
<description>Guntamatic Powercorn EnergyGrain Heating System. Untested! Please provide Feedback!</description>
<channels>
<channel id="controlBoilerApproval" typeId="controlBoilerApproval">
@ -208,7 +271,7 @@
<thing-type id="biocom">
<label>Guntamatic Biocom</label>
<description>Guntamatic Biocom Heating System. Untested! Please provide Feedback!</description>
<description>Guntamatic Biocom Pellets Heating System. Untested! Please provide Feedback!</description>
<channels>
<channel id="controlBoilerApproval" typeId="controlBoilerApproval">
@ -275,7 +338,7 @@
<thing-type id="pro">
<label>Guntamatic Pro</label>
<description>Guntamatic Pro Heating System. Untested! Please provide Feedback!</description>
<description>Guntamatic Pro Pellets or WoodChip Heating System. Untested! Please provide Feedback!</description>
<channels>
<channel id="controlBoilerApproval" typeId="controlBoilerApproval">
@ -342,7 +405,7 @@
<thing-type id="therm">
<label>Guntamatic Therm</label>
<description>Guntamatic Therm Heating System. Untested! Please provide Feedback!</description>
<description>Guntamatic Therm Pellets Heating System. Untested! Please provide Feedback!</description>
<channels>
<channel id="controlBoilerApproval" typeId="controlBoilerApproval">
@ -406,7 +469,70 @@
</properties>
<config-description-ref uri="thing-type:guntamatic:heatingsystem"/>
</thing-type>
<thing-type id="generic">
<label>Guntamatic Generic</label>
<description>Generic Guntamatic Heating System. Use this type, if your Heating System is none of the others. Please
provide Feedback!</description>
<channels>
<channel id="controlProgram" typeId="controlProgramWOManu">
<label>Set Program</label>
</channel>
<channel id="controlHeatCircProgram0" typeId="controlHeatCircProgram">
<label>Set Heat Circle 0 Program</label>
</channel>
<channel id="controlHeatCircProgram1" typeId="controlHeatCircProgram">
<label>Set Heat Circle 1 Program</label>
</channel>
<channel id="controlHeatCircProgram2" typeId="controlHeatCircProgram">
<label>Set Heat Circle 2 Program</label>
</channel>
<channel id="controlHeatCircProgram3" typeId="controlHeatCircProgram">
<label>Set Heat Circle 3 Program</label>
</channel>
<channel id="controlHeatCircProgram4" typeId="controlHeatCircProgram">
<label>Set Heat Circle 4 Program</label>
</channel>
<channel id="controlHeatCircProgram5" typeId="controlHeatCircProgram">
<label>Set Heat Circle 5 Program</label>
</channel>
<channel id="controlHeatCircProgram6" typeId="controlHeatCircProgram">
<label>Set Heat Circle 6 Program</label>
</channel>
<channel id="controlHeatCircProgram7" typeId="controlHeatCircProgram">
<label>Set Heat Circle 7 Program</label>
</channel>
<channel id="controlHeatCircProgram8" typeId="controlHeatCircProgram">
<label>Set Heat Circle 8 Program</label>
</channel>
<channel id="controlWwHeat0" typeId="controlWwHeat">
<label>Trigger Warm Water Circle 0</label>
</channel>
<channel id="controlWwHeat1" typeId="controlWwHeat">
<label>Trigger Warm Water Circle 1</label>
</channel>
<channel id="controlWwHeat2" typeId="controlWwHeat">
<label>Trigger Warm Water Circle 2</label>
</channel>
<channel id="controlExtraWwHeat0" typeId="controlExtraWwHeat">
<label>Trigger Extra Warm Water Circle 0</label>
</channel>
<channel id="controlExtraWwHeat1" typeId="controlExtraWwHeat">
<label>Trigger Extra Warm Water Circle 1</label>
</channel>
<channel id="controlExtraWwHeat2" typeId="controlExtraWwHeat">
<label>Trigger Extra Warm Water Circle 2</label>
</channel>
</channels>
<properties>
<property name="program">PR001</property>
<property name="heatCircProgram">HKx01</property>
<property name="wwHeat">BKx06</property>
<property name="extraWwHeat">ZKx06</property>
</properties>
<config-description-ref uri="thing-type:guntamatic:heatingsystem"/>
</thing-type>
<channel-type id="controlProgram" advanced="false">
<item-type>String</item-type>
@ -421,6 +547,18 @@
</options>
</state>
</channel-type>
<channel-type id="controlProgramWOManu" advanced="false">
<item-type>String</item-type>
<label>Set Program</label>
<description>Set Program of the Guntamatic Heating System (OFF, NORMAL, WARMWATER)</description>
<state>
<options>
<option value="0">OFF</option>
<option value="1">NORMAL</option>
<option value="2">WARMWATER</option>
</options>
</state>
</channel-type>
<channel-type id="controlBoilerApproval" advanced="true">
<item-type>String</item-type>
<label>Set Boiler Approval</label>

4
_thing_types/org.openhab.binding.omnilink/src/main/resources/OH-INF/thing/bridge.xml
View File

@ -9,7 +9,7 @@
<label>OmniLink Controller</label>
<description>An OmniLink controller.</description>
<channels>
<channel id="sysdate" typeId="sysDate"/>
<channel id="system_date" typeId="system_date"/>
<channel id="enable_disable_beeper" typeId="console_enable_disable_beeper">
<label>Console Beepers</label>
</channel>
@ -55,7 +55,7 @@
<!-- Controller Channels -->
<channel-type id="sysDate">
<channel-type id="system_date">
<item-type>DateTime</item-type>
<label>Date/Time</label>
<description>Set controller date/time.</description>