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

pull/2077/head
openHAB Build Server 2023-03-25 05:36:18 +00:00
parent 879c3ef956
commit 2464fcd2e4
14 changed files with 207 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
_addons_bindings/boschshc/readme.md
View File

@ -220,12 +220,15 @@ The smoke detector warns you in case of fire.
## Limitations
- Discovery of Things
- Discovery of Bridge
No major limitation known.
Check list of [openhab issues with "boshshc"](https://github.com/openhab/openhab-addons/issues?q=is%3Aissue+boschshc+)
## Discovery
Configuration via configuration files or UI (see below).
Bridge discovery is supported via mDNS.
Things discovery is started after successful pairing.
Configuration via configuration files or UI supported too (see below).
## Bridge Configuration
@ -253,19 +256,10 @@ Alternatively, the log can be viewed using the OpenHab Log Viewer (frontail) via
Example:
```bash
2020-08-11 12:42:49.490 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.495 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-RoomClimateControl- id=roomClimateControl_hz_1
2020-08-11 12:42:49.497 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-VentilationService- id=ventilationService
2020-08-11 12:42:49.498 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Großes Fenster id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.501 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-IntrusionDetectionSystem- id=intrusionDetectionSystem
2020-08-11 12:42:49.502 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.502 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.503 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Heizung Haus id=hdm:ICom:819410185:HC1
2020-08-11 12:42:49.503 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=-RoomClimateControl- id=roomClimateControl_hz_6
2020-08-11 12:42:49.504 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=PhilipsHueBridgeManager id=hdm:PhilipsHueBridge:PhilipsHueBridgeManager
2020-08-11 12:42:49.505 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.506 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Rollladen id=hdm:HomeMaticIP:3014F711A000XXXXXXXXXXXX
2020-08-11 12:42:49.507 [INFO ] [chshc.internal.BoschSHCBridgeHandler] - Found device: name=Central Heating id=hdm:ICom:819410185
2023-03-20 20:30:48.026 [INFO ] [g.discovery.internal.PersistentInbox] - Added new thing 'boschshc:security-camera-eyes:yourBridgeName:hdm_Cameras_XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' to inbox.
2023-03-20 20:30:48.026 [INFO ] [g.discovery.internal.PersistentInbox] - Added new thing 'boschshc:smoke-detector:yourBridgeName:hdm_HomeMaticIP_XXXXXXXXXXXXXXXXXXXXXXXX' to inbox.
2023-03-20 20:30:48.027 [INFO ] [g.discovery.internal.PersistentInbox] - Added new thing 'boschshc:twinguard:yourBridgeName:hdm_ZigBee_XXXXXXXXXXXXXXXX' to inbox.
2023-03-20 20:30:48.028 [INFO ] [g.discovery.internal.PersistentInbox] - Added new thing 'boschshc:smart-bulb:yourBridgeName:hdm_PhilipsHueBridge_HueLight_XXXXXXXXXXXXXXXX-XX_XXXXXXXXXXXX' to inbox.
```
## Thing Configuration

9
_addons_bindings/mielecloud/readme.md
View File

@ -166,6 +166,8 @@ Channel ID and channel type ID match unless noted.
| plate_power_step_raw | Number | The raw power level of the heating plate. | Yes |
| door_state | Switch | Indicates if the door of the device is open. | Yes |
| door_alarm | Switch | Indicates if the door alarm of the device is active. | Yes |
| water_consumption_current | Number | The amount of water used by the current running program up to the present moment. | Yes |
| energy_consumption_current | Number | The amount of energy used by the current running program up to the present moment. | Yes |
| battery_level | Number | The battery level of the robotic vacuum cleaner. | Yes |
### Coffee System
@ -230,6 +232,8 @@ Channel ID and channel type ID match unless noted.
- error_state
- info_state
- door_state
- water_consumption_current
- energy_consumption_current
### Tumble Dryer
@ -257,6 +261,7 @@ Channel ID and channel type ID match unless noted.
- light_switch
- light_can_be_controlled
- door_state
- energy_consumption_current
### Freezer
@ -402,6 +407,8 @@ Channel ID and channel type ID match unless noted.
- light_switch
- light_can_be_controlled
- door_state
- water_consumption_current
- energy_consumption_current
### Washing Machine
@ -430,6 +437,8 @@ Channel ID and channel type ID match unless noted.
- light_switch
- light_can_be_controlled
- door_state
- water_consumption_current
- energy_consumption_current
### Wine Storage

31
_addons_bindings/radiothermostat/readme.md
View File

@ -21,6 +21,7 @@ Thermostats using a Z-Wave module are not supported but can be used via the open
The binding retrieves and periodically updates all basic system information from the thermostat.
The main thermostat functions such as thermostat mode, fan mode, temperature set point and hold mode can be controlled.
System run-time information and humidity readings are polled less frequently and can be disabled completely if not desired.
The heating and cooling program schedules on the thermostat can also be configured.
## Supported Things
@ -33,10 +34,6 @@ Multiple Things can be added if more than one thermostat is to be controlled.
Auto-discovery is supported if the thermostat can be located on the local network using SSDP.
Otherwise the thing must be manually added.
## Binding Configuration
The binding has no configuration options, all configuration is done at Thing level.
## Thing Configuration
The thing has a few configuration parameters:
@ -49,9 +46,31 @@ The thing has a few configuration parameters:
| isCT80 | Flag to enable additional features only available on the CT80 thermostat. Optional, the default is false. |
| disableLogs | Disable retrieval of run-time logs from the thermostat. Optional, the default is false. |
| setpointMode | Controls temporary or absolute setpoint mode. In "temporary" mode the thermostat will temporarily maintain the given setpoint until the next scheduled setpoint time period. In "absolute" mode the thermostat will ignore its program and maintain the given setpoint indefinitely. Optional, the default is "temporary". |
| clockSync | Flag to enable the binding to sync the internal clock on the thermostat to match the openHAB host's system clock. Use if the thermostat is not setup to connect to the manufacturer's cloud server. Sync occurs at binding startup and every hour thereafter. Optional, the default is false. |
| clockSync | Flag to enable the binding to sync the internal clock on the thermostat to match the openHAB host's system clock. Sync occurs at binding startup and every hour thereafter. Optional, the default is **true**. |
Some notes:
### Schedule Configuration
The heating and cooling program schedules that persist on the thermostat can be configured by the binding.
Click the 'Show advanced' checkbox on the Thing configuration page to display the schedule.
For both the heating and cooling programs, the 7-day repeating schedule has 4 setpoint periods per day (Morning, Day, Evening, Night).
In order for the heating or cooling program to be valid, all time and setpoint fields must be populated.
The time is expressed in 24-hour (HH:mm) format and the time value for each successive period within a day must be greater than the previous period.
Once the schedule is populated and the configuration saved, the new schedule will be sent to the thermostat during binding initialization, overwriting its existing schedule.
If one or more time or setpoint fields are left blank in a given schedule and the configuration saved, the Thing will display a configuration error until the entries are corrected.
A heating or cooling schedule with all fields left blank will be ignored by the binding.
In that case, the existing schedule on the thermostat will remain untouched.
If the thermostat schedule is to be managed by openHAB, the thermostat should be de-provisioned from the MyRadioThermostat/EnergyHub cloud service to prevent the openHAB schedule from being overridden.
The thermostat can de-provisioned from the cloud by issuing the following `curl` commands:
```shell
curl http://$THERMOSTAT_IP/cloud -d '{"enabled":0}' -X POST
curl http://$THERMOSTAT_IP/cloud -d '{"authkey":""}' -X POST
```
### Some notes
- The main caveat for using this binding is to keep in mind that the web server in the thermostat is very slow. Do not over load it with excessive amounts of simultaneous commands.
- When changing the thermostat mode, the current temperature set point is cleared and a refresh of the thermostat data is done to get the new mode's set point.

29
_addons_bindings/tapocontrol/readme.md
View File

@ -79,20 +79,21 @@ The thing has the following configuration parameters:
All devices support some of the following channels:
| group | channel | type | description | things supporting this channel |
|-----------|----------------- |------------------------|------------------------------|------------------------------------------------------------------|
| actuator | output | Switch | Power device on or off | P100, P105, P110, P115, L510, L530, L610, L630, L900, L920, L930 |
| | output1 | Switch | Power socket 1 on or off | P300 |
| | output2 | Switch | Power socket 2 on or off | P300 |
| | output3 | Switch | Power socket 3 on or off | P300 |
| | brightness | Dimmer | Brightness 0-100% | L510, L530, L610, L630, L900 |
| | colorTemperature | Number | White-Color-Temp 2500-6500K | L510, L530, L610, L630, L900 |
| | color | Color | Color | L530, L630, L900 |
| device | wifiSignal | Number | WiFi-quality-level | P100, P105, P110, P115, L510, L530, L610, L630, L900, L920, L930 |
| | onTime | Number:Time | seconds output is on | P100, P105, P110, P115, L510, L530, L900, L920, L930 |
| energy | actualPower | Number:Power | actual Power (Watt) | P110, P115 |
| | todayEnergyUsage | Number:Energy | used energy today (Wh) | P110, P115 |
| | todayRuntime | Number:Time | seconds output was on today | P110, P115 |
| group | channel | type | description | things supporting this channel |
|-----------|----------------- |------------------------|-------------------------------------|------------------------------------------------------------------|
| actuator | output | Switch | Power device on or off | P100, P105, P110, P115, L510, L530, L610, L630, L900, L920, L930 |
| | output1 | Switch | Power socket 1 on or off | P300 |
| | output2 | Switch | Power socket 2 on or off | P300 |
| | output3 | Switch | Power socket 3 on or off | P300 |
| | brightness | Dimmer | Brightness 0-100% | L510, L530, L610, L630, L900 |
| | colorTemperature | Number | White-Color-Temp 2500-6500K | L510, L530, L610, L630, L900 |
| | color | Color | Color | L530, L630, L900 |
| effects | fxName | String | Active lightning effect (readonly) | L530 |
| device | wifiSignal | Number | WiFi-quality-level | P100, P105, P110, P115, L510, L530, L610, L630, L900, L920, L930 |
| | onTime | Number:Time | seconds output is on | P100, P105, P110, P115, L510, L530, L900, L920, L930 |
| energy | actualPower | Number:Power | actual Power (Watt) | P110, P115 |
| | todayEnergyUsage | Number:Energy | used energy today (Wh) | P110, P115 |
| | todayRuntime | Number:Time | seconds output was on today | P110, P115 |
## Channel Refresh

24
_thing_types/org.openhab.binding.mielecloud/src/main/resources/OH-INF/thing/channelTypes.xml
View File

@ -438,6 +438,30 @@
<state readOnly="true"/>
</channel-type>
<channel-type id="water_consumption_current">
<item-type>Number:Volume</item-type>
<label>@text/channel-type.mielecloud.water_consumption_current.label</label>
<description>@text/channel-type.mielecloud.water_consumption_current.description</description>
<category>Water</category>
<tags>
<tag>Measurement</tag>
<tag>Water</tag>
</tags>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="energy_consumption_current">
<item-type>Number:Energy</item-type>
<label>@text/channel-type.mielecloud.energy_consumption_current.label</label>
<description>@text/channel-type.mielecloud.energy_consumption_current.description</description>
<category>Energy</category>
<tags>
<tag>Measurement</tag>
<tag>Energy</tag>
</tags>
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-type id="battery_level">
<item-type>Number</item-type>
<label>@text/channel-type.mielecloud.battery_level.label</label>

3
_thing_types/org.openhab.binding.mielecloud/src/main/resources/OH-INF/thing/dishwasherDevice.xml
View File

@ -34,9 +34,12 @@
<channel id="error_state" typeId="error_state"/>
<channel id="info_state" typeId="info_state"/>
<channel id="door_state" typeId="door_state"/>
<channel id="water_consumption_current" typeId="water_consumption_current"/>
<channel id="energy_consumption_current" typeId="energy_consumption_current"/>
</channels>
<properties>
<property name="thingTypeVersion">1</property>
<property name="vendor">Miele</property>
</properties>

2
_thing_types/org.openhab.binding.mielecloud/src/main/resources/OH-INF/thing/dryerDevice.xml
View File

@ -38,9 +38,11 @@
<channel id="light_switch" typeId="light_switch"/>
<channel id="light_can_be_controlled" typeId="light_can_be_controlled"/>
<channel id="door_state" typeId="door_state"/>
<channel id="energy_consumption_current" typeId="energy_consumption_current"/>
</channels>
<properties>
<property name="thingTypeVersion">1</property>
<property name="vendor">Miele</property>
</properties>

3
_thing_types/org.openhab.binding.mielecloud/src/main/resources/OH-INF/thing/washerDryer.xml
View File

@ -41,9 +41,12 @@
<channel id="light_switch" typeId="light_switch"/>
<channel id="light_can_be_controlled" typeId="light_can_be_controlled"/>
<channel id="door_state" typeId="door_state"/>
<channel id="water_consumption_current" typeId="water_consumption_current"/>
<channel id="energy_consumption_current" typeId="energy_consumption_current"/>
</channels>
<properties>
<property name="thingTypeVersion">1</property>
<property name="vendor">Miele</property>
</properties>

3
_thing_types/org.openhab.binding.mielecloud/src/main/resources/OH-INF/thing/washingMachine.xml
View File

@ -39,9 +39,12 @@
<channel id="light_switch" typeId="light_switch"/>
<channel id="light_can_be_controlled" typeId="light_can_be_controlled"/>
<channel id="door_state" typeId="door_state"/>
<channel id="water_consumption_current" typeId="water_consumption_current"/>
<channel id="energy_consumption_current" typeId="energy_consumption_current"/>
</channels>
<properties>
<property name="thingTypeVersion">1</property>
<property name="vendor">Miele</property>
</properties>

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

@ -33,47 +33,8 @@
<channel id="yesterday_cool_runtime" typeId="yesterday_cool_runtime"/>
</channels>
<config-description>
<parameter name="hostName" type="text" required="true">
<context>network-address</context>
<label>Thermostat Host Name/IP Address</label>
<description>Host Name or IP Address of the Thermostat</description>
</parameter>
<parameter name="refresh" type="integer" min="1" required="false" unit="min">
<label>Refresh Interval</label>
<description>Specifies the Refresh Interval in Minutes</description>
<default>2</default>
</parameter>
<parameter name="logRefresh" type="integer" min="5" required="false" unit="min">
<label>Run-time Log Refresh Interval</label>
<description>Specifies the Run-time Log and Humidity Refresh Interval in Minutes</description>
<default>10</default>
</parameter>
<parameter name="isCT80" type="boolean">
<label>Enable CT80 Thermostat Options</label>
<description>Optional Flag to Enable Additional Features Only Available on the CT80 Thermostat</description>
<default>false</default>
</parameter>
<parameter name="disableLogs" type="boolean">
<label>Disable Retrieval of Run-time Data</label>
<description>Optional Flag to Disable the Retrieval of Run-time Data from the Thermostat</description>
<default>false</default>
</parameter>
<parameter name="setpointMode" type="text">
<label>Setpoint Mode</label>
<description>Run in absolute or temporary setpoint mode</description>
<default>temporary</default>
<options>
<option value="absolute">Absolute</option>
<option value="temporary">Temporary</option>
</options>
</parameter>
<parameter name="clockSync" type="boolean">
<label>Enable Thermostat Clock Sync</label>
<description>Optional Flag to snyc the thermostat's clock with the host system clock</description>
<default>false</default>
</parameter>
</config-description>
<config-description-ref uri="thing-type:radiothermostat:thermostatconfig"/>
</thing-type>
<channel-type id="temp-temperature">

25
_thing_types/org.openhab.binding.tapocontrol/src/main/resources/OH-INF/thing/L530.xml
View File

@ -14,10 +14,35 @@
<description>Tapo Smart Multicolor Light-Bulb</description>
<channel-groups>
<channel-group id="actuator" typeId="colorBulb"/>
<channel-group id="effects" typeId="lightEffectL530"/>
<channel-group id="device" typeId="deviceState"/>
</channel-groups>
<representation-property>macAddress</representation-property>
<config-description-ref uri="thing-type:tapo:device"/>
</thing-type>
<!-- Lightning Effect -->
<channel-group-type id="lightEffectL530">
<label>Lightning Effect</label>
<description>Tapo Lightning Effects</description>
<channels>
<channel id="fxName" typeId="l530fxList"/>
</channels>
</channel-group-type>
<!-- effect name -->
<channel-type id="l530fxList">
<item-type>String</item-type>
<label>Light Effect Theme</label>
<description>Name of active lightning effect</description>
<state readOnly="true">
<options>
<option value="">None (No FX)</option>
<option value="custom">Custom</option>
<option value="L1">Party</option>
<option value="L2">Relax</option>
</options>
</state>
</channel-type>
</thing:thing-descriptions>

43
_thing_types/org.openhab.binding.tapocontrol/src/main/resources/OH-INF/thing/L920.xml
View File

@ -20,4 +20,47 @@
<config-description-ref uri="thing-type:tapo:device"/>
</thing-type>
<!-- Lightning Effect -->
<channel-group-type id="lightEffectL920">
<label>Lightning Effect</label>
<description>Tapo Lightning Effects</description>
<channels>
<channel id="fxBrightness" typeId="dimmerChannel"/>
<channel id="fxName" typeId="l920fxList"/>
<channel id="fxColor1" typeId="colorChannel"/>
<channel id="fxColor2" typeId="colorChannel"/>
<channel id="fxColor3" typeId="colorChannel"/>
<channel id="fxColor4" typeId="colorChannel"/>
</channels>
</channel-group-type>
<!-- effect name -->
<channel-type id="l920fxList">
<item-type>String</item-type>
<label>Light Effect Theme</label>
<description>Name of lightning effect</description>
<state readOnly="false">
<options>
<option value="">None (No FX)</option>
<option value="aurora">Aurora</option>
<option value="bubbling_calderon">Bubbling Calderon</option>
<option value="christmas">Christmas</option>
<option value="christmas_light">Christmas Light</option>
<option value="candy_cane">Candy</option>
<option value="flicker">Flicker</option>
<option value="hanukkah">Hanukkah</option>
<option value="haunted_mansion">Haunted Mansion</option>
<option value="icicle">Icicle</option>
<option value="lightning">Lightning</option>
<option value="ocean">Ocean</option>
<option value="rainbow">Rainbow</option>
<option value="raindrop">Raindrop</option>
<option value="spring">Spring</option>
<option value="sunrise">Sunrise</option>
<option value="sunset">Sunset</option>
<option value="valentines">Valentines</option>
</options>
</state>
</channel-type>
</thing:thing-descriptions>

43
_thing_types/org.openhab.binding.tapocontrol/src/main/resources/OH-INF/thing/L930.xml
View File

@ -20,4 +20,47 @@
<config-description-ref uri="thing-type:tapo:device"/>
</thing-type>
<!-- Lightning Effect -->
<channel-group-type id="lightEffectL920">
<label>Lightning Effect</label>
<description>Tapo Lightning Effects</description>
<channels>
<channel id="fxBrightness" typeId="dimmerChannel"/>
<channel id="fxName" typeId="l930fxList"/>
<channel id="fxColor1" typeId="colorChannel"/>
<channel id="fxColor2" typeId="colorChannel"/>
<channel id="fxColor3" typeId="colorChannel"/>
<channel id="fxColor4" typeId="colorChannel"/>
</channels>
</channel-group-type>
<!-- effect name -->
<channel-type id="l930fxList">
<item-type>String</item-type>
<label>Light Effect Theme</label>
<description>Name of lightning effect</description>
<state readOnly="false">
<options>
<option value="">None (No FX)</option>
<option value="aurora">Aurora</option>
<option value="bubbling_calderon">Bubbling Calderon</option>
<option value="christmas">Christmas</option>
<option value="christmas_light">Christmas Light</option>
<option value="candy_cane">Candy</option>
<option value="flicker">Flicker</option>
<option value="hanukkah">Hanukkah</option>
<option value="haunted_mansion">Haunted Mansion</option>
<option value="icicle">Icicle</option>
<option value="lightning">Lightning</option>
<option value="ocean">Ocean</option>
<option value="rainbow">Rainbow</option>
<option value="raindrop">Raindrop</option>
<option value="spring">Spring</option>
<option value="sunrise">Sunrise</option>
<option value="sunset">Sunset</option>
<option value="valentines">Valentines</option>
</options>
</state>
</channel-type>
</thing:thing-descriptions>

46
_thing_types/org.openhab.binding.tapocontrol/src/main/resources/OH-INF/thing/channels.xml
View File

@ -102,23 +102,6 @@
</channels>
</channel-group-type>
<!-- Lightning Effect -->
<channel-group-type id="lightEffect">
<label>Lightning Effect</label>
<description>Tapo Lightning Effects</description>
<channels>
<channel id="enable" typeId="effectOn"/>
<channel id="brightness" typeId="dimmerChannel"/>
<channel id="name" typeId="effectName"/>
<channel id="custom" typeId="customEffect"/>
<channel id="displayColor1" typeId="colorChannel"/>
<channel id="displayColor2" typeId="colorChannel"/>
<channel id="displayColor3" typeId="colorChannel"/>
<channel id="displayColor4" typeId="colorChannel"/>
</channels>
</channel-group-type>
<!-- ############################### CHANNELS ############################### -->
<!-- ACTOR CHANNEL TYPES -->
@ -216,35 +199,6 @@
<state readOnly="true" pattern="%.0f %unit%"></state>
</channel-type>
<!-- LIGHTNING EFFECT CHANNEL TYPES -->
<!-- effect on -->
<channel-type id="effectOn">
<item-type>Switch</item-type>
<label>Lightning Effect Enable</label>
<description>Switches the lightning effect on/off</description>
<category>LightBulb</category>
<state readOnly="false"/>
</channel-type>
<!-- effect name -->
<channel-type id="effectName">
<item-type>String</item-type>
<label>Effect Name</label>
<description>Name of LightningEffect</description>
<state readOnly="false"/>
</channel-type>
<!-- custom effect -->
<channel-type id="customEffect">
<item-type>Switch</item-type>
<label>Custom Effect</label>
<description>Use custom lightning effect</description>
<category>LightBulb</category>
<state readOnly="false"/>
</channel-type>
<!-- ADVANCED SETTING CHANNELS -->
<!-- device led -->
<channel-type id="led" advanced="true">