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 1446)

pull/2077/head
openHAB Build Server 2023-04-13 05:34:36 +00:00
parent b05b5e6b0a
commit c345505dbb
4 changed files with 151 additions and 112 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

107
_addons_bindings/windcentrale/readme.md
View File

@ -3,7 +3,7 @@ id: windcentrale
label: Windcentrale
title: Windcentrale - Bindings
type: binding
description: "This Binding is used to display the details of a Windcentrale windmill."
description: "This Binding is used to display the details of Windcentrale windmills."
since: 3x
logo: images/addons/windcentrale.png
install: auto
@ -15,15 +15,20 @@ install: auto
# Windcentrale Binding
This Binding is used to display the details of a Windcentrale windmill.
This Binding is used to display the details of Windcentrale windmills.
## Supported Things
This Binding supports Windcentrale mill devices.
The binding supports the following Windcentrale Things:
| Thing Type | Description |
|------------|-------------------------------------------|
| account | An account for using the Windcentrale API |
| windmill | Windcentrale Windmill |
## Discovery
There is no discovery available for this binding.
After creating an account Thing the Binding can discover windmills based on the participations linked to the account.
## Binding Configuration
@ -31,62 +36,72 @@ No binding configuration required.
## Thing Configuration
| Configuration Parameter | Required | Default | Description |
|-------------------------|----------|---------|-----------------------------------------------------|
| millId | X | 131 | Identifies the windmill (see table below) |
| wd | | 1 | Number of wind shares ("Winddelen") |
| refreshInterval | | 30 | Refresh interval for refreshing the data in seconds |
### Account
| millId | Windmill name |
|--------|-------------------|
| 1 | De Grote Geert |
| 2 | De Jonge Held |
| 31 | Het Rode Hert |
| 41 | De Ranke Zwaan |
| 51 | De Witte Juffer |
| 111 | De Bonte Hen |
| 121 | De Trouwe Wachter |
| 131 | De Blauwe Reiger |
| 141 | De Vier Winden |
| 201 | De Boerenzwaluw |
| Configuration Parameter | Required |
|-------------------------|----------|
| username | X |
| password | X |
### Windmill
| Configuration Parameter | Required | Default | Description |
|-------------------------|----------|------------------|-----------------------------------------------------|
| name | X | De Blauwe Reiger | Identifies the windmill (see names list below) |
| shares | | 1 | Number of wind shares ("Winddelen") |
| refreshInterval | | 30 | Refresh interval for refreshing the data in seconds |
The following windmill names are supported:
- De Blauwe Reiger
- De Boerenzwaluw
- De Bonte Hen
- De Grote Geert
- De Jonge Held
- De Ranke Zwaan
- De Trouwe Wachter
- De Vier Winden
- De Witte Juffer
- Het Rode Hert
- Het Vliegend Hert
## Channels
| Channel Type ID | Item Type | Description |
|-----------------|----------------------|-------------------------------------|
| kwh | Number:Energy | Current energy |
| kwhForecast | Number:Energy | Energy forecast |
| powerAbsTot | Number:Power | Total power |
| powerAbsWd | Number:Power | Power provided for your wind shares |
| powerRel | Number:Dimensionless | Relative power |
| runPercentage | Number:Dimensionless | Run percentage this year |
| runTime | Number:Time | Run time this year |
| timestamp | DateTime | Timestamp of the last update |
| windDirection | String | Current wind direction |
| windSpeed | Number | Measured current wind speed (Bft) |
| Channel ID | Item Type | Description |
|----------------|----------------------|-------------------------------------|
| energy-total | Number:Energy | Total energy this year |
| power-relative | Number:Dimensionless | Relative power |
| power-shares | Number:Power | Power provided for your wind shares |
| power-total | Number:Power | Total power |
| run-percentage | Number:Dimensionless | Run percentage this year |
| run-time | Number:Time | Run time this year |
| timestamp | DateTime | Timestamp of the last update |
| wind-direction | String | Current wind direction |
| wind-speed | Number | Measured current wind speed (Bft) |
## Example
### demo.things
```java
Thing windcentrale:mill:geert [ millId=1 ]
Thing windcentrale:mill:reiger [ millId=131, wd=3, refreshInterval=60 ]
Bridge windcentrale:account:demo-account [ username="johndoe@acme.com", password="Mf!BU45LTF6X2Cf36zxt" ] {
Thing windmill de-grote-geert [ name="De Grote Geert" ]
Thing windmill de-blauwe-reiger [ name="De Blauwe Reiger", shares=3, refreshInterval=60 ]
}
```
### demo.items
```java
Group gReiger "Windcentrale Reiger" <wind>
Group gReiger "Windcentrale Reiger"
Number ReigerWindSpeed "Wind speed [%d Bft]" <wind> (gReiger) { channel="windcentrale:mill:reiger:windSpeed" }
String ReigerWindDirection "Wind direction [%s]" <wind> (gReiger) { channel="windcentrale:mill:reiger:windDirection" }
Number:Power ReigerPowerAbsTot "Total mill power [%.1f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:powerAbsTot" }
Number:Power ReigerPowerAbsWd "Wind shares power [%.1f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:powerAbsWd" }
Number:Dimensionless ReigerPowerRel "Relative power [%.1f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:powerRel" }
Number:Energy ReigerKwh "Current energy [%.0f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:kwh" }
Number:Energy ReigerKwhForecast "Energy forecast [%.0f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:kwhForecast" }
Number:Dimensionless ReigerRunPercentage "Run percentage [%.1f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:runPercentage" }
Number:Time ReigerRunTime "Run time [%.0f %unit%]" <wind> (gReiger) { channel="windcentrale:mill:reiger:runTime" }
DateTime ReigerTimestamp "Update timestamp [%1$ta %1$tR]" <wind> (gReiger) { channel="windcentrale:mill:reiger:timestamp" }
Number ReigerWindSpeed "Wind speed [%d Bft]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:wind-speed" }
String ReigerWindDirection "Wind direction [%s]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:wind-direction" }
Number:Power ReigerPowerTotal "Total windmill power [%.1f %unit%]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:power-total" }
Number:Power ReigerPowerShares "Wind shares power [%.1f %unit%]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:power-shares" }
Number:Dimensionless ReigerPowerRelative "Relative power [%.1f %unit%]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:power-relative" }
Number:Energy ReigerEnergyTotal "Total windmill energy [%.0f %unit%]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:energy-total" }
Number:Dimensionless ReigerRunPercentage "Run percentage [%.1f %unit%]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:run-percentage" }
Number:Time ReigerRunTime "Run time [%.0f %unit%]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:run-time" }
DateTime ReigerTimestamp "Update timestamp [%1$ta %1$tR]" (gReiger) { channel="windcentrale:windmill:demo-account:de-blauwe-reiger:timestamp" }
```

22
_thing_types/org.openhab.binding.windcentrale/src/main/resources/OH-INF/thing/account.xml Normal file
View File

@ -0,0 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="windcentrale"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<bridge-type id="account">
<label>Windcentrale Account</label>
<description>An account for using the Windcentrale API</description>
<config-description>
<parameter name="username" type="text" required="true">
<label>Username</label>
</parameter>
<parameter name="password" type="text" required="true">
<context>password</context>
<label>Password</label>
</parameter>
</config-description>
</bridge-type>
</thing:thing-descriptions>

132
_thing_types/org.openhab.binding.windcentrale/src/main/resources/OH-INF/thing/millThing.xml → _thing_types/org.openhab.binding.windcentrale/src/main/resources/OH-INF/thing/windmill.xml
View File

@ -4,19 +4,22 @@
xmlns:thing="https://openhab.org/schemas/thing-description/v1.0.0"
xsi:schemaLocation="https://openhab.org/schemas/thing-description/v1.0.0 https://openhab.org/schemas/thing-description-1.0.0.xsd">
<thing-type id="mill">
<thing-type id="windmill">
<supported-bridge-type-refs>
<bridge-type-ref id="account"/>
</supported-bridge-type-refs>
<label>Windcentrale Windmill</label>
<channels>
<channel id="windSpeed" typeId="windSpeed"/>
<channel id="windDirection" typeId="windDirection"/>
<channel id="powerAbsTot" typeId="powerAbsTot"/>
<channel id="powerAbsWd" typeId="powerAbsWd"/>
<channel id="powerRel" typeId="powerRel"/>
<channel id="kwh" typeId="kwh"/>
<channel id="kwhForecast" typeId="kwhForecast"/>
<channel id="runPercentage" typeId="runPercentage"/>
<channel id="runTime" typeId="runTime"/>
<channel id="power-shares" typeId="power-shares"/>
<channel id="power-total" typeId="power-total"/>
<channel id="power-relative" typeId="power-relative"/>
<channel id="energy-total" typeId="energy-total"/>
<channel id="run-time" typeId="run-time"/>
<channel id="run-percentage" typeId="run-percentage"/>
<channel id="wind-speed" typeId="wind-speed"/>
<channel id="wind-direction" typeId="wind-direction"/>
<channel id="timestamp" typeId="timestamp"/>
</channels>
@ -24,24 +27,27 @@
<property name="vendor">Windcentrale</property>
</properties>
<representation-property>projectCode</representation-property>
<config-description>
<parameter name="millId" type="integer" required="true">
<parameter name="name" type="text" required="true">
<label>Windmill</label>
<options>
<option value="1">De Grote Geert</option>
<option value="2">De Jonge Held</option>
<option value="31">Het Rode Hert</option>
<option value="41">De Ranke Zwaan</option>
<option value="51">De Witte Juffer</option>
<option value="111">De Bonte Hen</option>
<option value="121">De Trouwe Wachter</option>
<option value="131">De Blauwe Reiger</option>
<option value="141">De Vier Winden</option>
<option value="201">De Boerenzwaluw</option>
<option value="De Blauwe Reiger">De Blauwe Reiger</option>
<option value="De Boerenzwaluw">De Boerenzwaluw</option>
<option value="De Bonte Hen">De Bonte Hen</option>
<option value="De Grote Geert">De Grote Geert</option>
<option value="De Jonge Held">De Jonge Held</option>
<option value="De Ranke Zwaan">De Ranke Zwaan</option>
<option value="De Trouwe Wachter">De Trouwe Wachter</option>
<option value="De Vier Winden">De Vier Winden</option>
<option value="De Witte Juffer">De Witte Juffer</option>
<option value="Het Rode Hert">Het Rode Hert</option>
<option value="Het Vliegend Hert">Het Vliegend Hert</option>
</options>
<default>131</default>
<default>De Blauwe Reiger</default>
</parameter>
<parameter name="wd" type="integer" required="false">
<parameter name="shares" type="integer" min="0" max="11000" required="false">
<label>Wind Shares</label>
<description>Number of wind shares ("Winddelen")</description>
<default>1</default>
@ -55,63 +61,59 @@
</config-description>
</thing-type>
<channel-type id="windSpeed">
<item-type>Number</item-type>
<label>Wind Speed</label>
<category>Wind</category>
<state pattern="%d Bft" readOnly="true"/>
<channel-type id="energy-total">
<item-type>Number:Energy</item-type>
<label>Total Energy</label>
<description>Energy produced this year</description>
<category>Energy</category>
<state pattern="%.0f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="windDirection">
<item-type>String</item-type>
<label>Wind Direction</label>
<state pattern="%s" readOnly="true"/>
</channel-type>
<channel-type id="powerRel">
<channel-type id="power-relative">
<item-type>Number:Dimensionless</item-type>
<label>Relative Power</label>
<category>Energy</category>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="runPercentage">
<channel-type id="power-shares">
<item-type>Number:Power</item-type>
<label>Wind Shares Power</label>
<category>Energy</category>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="power-total">
<item-type>Number:Power</item-type>
<label>Total Power</label>
<category>Energy</category>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="run-time">
<item-type>Number:Time</item-type>
<label>Run Time</label>
<description>Run time this year</description>
<state pattern="%.0f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="run-percentage">
<item-type>Number:Dimensionless</item-type>
<label>Run Percentage</label>
<description>Run percentage this year</description>
<category>Energy</category>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="runTime">
<item-type>Number:Time</item-type>
<label>Run Time</label>
<description>Run time this year</description>
<state pattern="%.0f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="powerAbsWd">
<item-type>Number:Power</item-type>
<label>Wind Shares Power</label>
<category>Energy</category>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="powerAbsTot">
<item-type>Number:Power</item-type>
<label>Total Power</label>
<category>Energy</category>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="kwh">
<item-type>Number:Energy</item-type>
<label>Energy</label>
<category>Energy</category>
<state pattern="%.0f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="kwhForecast">
<item-type>Number:Energy</item-type>
<label>Energy Forecast</label>
<category>Energy</category>
<state pattern="%.0f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="timestamp">
<item-type>DateTime</item-type>
<label>Last Updated</label>
<state readOnly="true"/>
</channel-type>
<channel-type id="wind-direction">
<item-type>String</item-type>
<label>Wind Direction</label>
<state pattern="%s" readOnly="true"/>
</channel-type>
<channel-type id="wind-speed">
<item-type>Number</item-type>
<label>Wind Speed</label>
<category>Wind</category>
<state pattern="%d Bft" readOnly="true"/>
</channel-type>
</thing:thing-descriptions>