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

pull/1698/head
openHAB Build Server 2021-12-12 03:40:12 +00:00
parent 2bafbddd25
commit 47a4bb1920
10 changed files with 466 additions and 7 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

114
_addons_bindings/dominoswiss/readme.md Normal file
View File

@ -0,0 +1,114 @@
---
id: dominoswiss
label: Dominoswiss
title: Dominoswiss - Bindings
type: binding
description: "This binding allows the control of rollershutters, using an eGate as gateway and Dominoswiss radio receivers."
since: 3x
install: manual
---
<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->
{% include base.html %}
# Dominoswiss Binding
This binding allows the control of rollershutters, using an eGate as gateway and Dominoswiss radio receivers.
The eGate-gateway is connected via ethernet to openHAB and sends its commands via radio to all rollershutters.
See https://www.brelag.com/ for more information.
## Supported Things
eGate: Dominoswiss eGate Server. The eGate is the gateway which sends the commands to the connected rollershutters. The bridge-type ID is egate.
Blind: represents one rollershutter, that can be controlled via eGate. The thing-type ID is blind.
## Discovery
Unfortunately no automatic discovery is possible due to protocol restrictions.
Every rollershutter must be known by eGate and can be called by it's number of storage-place on eGate gateway.
## Thing Configuration
The bridge "eGate" has one channel "getconfig" which returns the config of this bridge.
The eGate is configured with both an `ipAddress` and a port.
|Property|Default|Required|Description|
|--------|-------|--------|-----------|
|ipAddress|none|Yes|The IP or host name of the Dominoswiss EGate Serve|
|port|1318|Yes|Port interface of the Dominoswiss EGate Server|
```
Bridge dominoswiss:egate:myeGate "My eGate Server" @ "Home" [ ipAddres="localhost", port=5700 ]
```
The thing blind represents one blind on the eGate. Each blind is represented by an id set on your eGate.
```
Thing blind officeBlind "Office" @ "1stFloor" [ id="1"]
```
The blind-Thing has the following channels:
|Channel Type ID|Item Type|Description|
|---------------|---------|-----------|
|pulseUp|Rollershutter|sends one pulse up to this blind.|
|pulseDown|Rollershutter|sends one pulse down to this blind|
|continuousUp|Rollershutter|sends a continuous up to this blind. The blind will automatically stop as it is fully up.|
|continuousDown|Rollershutter|send a continous down to this blind. The blind will automatically stop as it is fully down.|
|stop|Rollershutter|stop the action of the blind. The command will be imadiatly sent to the blind.|
|shutter|Rollershutter|this is used to bind the channel to the shutter item. There are no further rules needed this channel will handel the up/down/stop commands. See example for usage.|
|tilt|Rollershutter|same as shutter, this will handel all up/down/stop - tilt commands to be used with the shutter-item.|
|tiltUp|Rollershutter|sends 3 pulse-up commands to this blind to tilt the blind. If your blind needs more than 3 pulse-up, create a rule yourself with three pluse-up commands. Between each pulse-up you should wait 150ms to let the command be processed.
|tiltDown|Rollershutter|sends 3 pulse-down commands to this blind to tilt the blind. If your blind needs more than 3 pulse-down, create a rule yourself with three pluse-down commands. Between each pulse-down you should wait 150ms to let the command be processed. |
## Full Example
Sample things file:
```
Bridge dominoswiss:egate:myeGate "My eGate Server" @ "Home" [ ipAddres="localhost", port="5500" ]
{
Thing blind officeBlind "Office" @ "1stFloor" [ id="1"]
Thing blind diningRoomBlind "Dining Room" @ "EG" [id="2"]
Thing blind kitchenBlind "Kitchen" @ "EG" [id="12"]
}
```
Sample items file:
```
Rollershutter OfficeBlindShutter "Office blind" <rollershutter> (g_blinds) { channel="dominoswiss:blind:myeGate:officeBlind:shutter"}
Rollershutter OfficeBlindShutterTilt "Tilt Office" <rollershutter> (g_blinds_tilt) { channel="dominoswiss:blind:meGgate:bueroBlind:tilt"}
```
Sample sitemap file
```
Switch item=OfficeBlindShutter
Switch item=OfficeBlindShutterTilt
```
Sample rule file
This example moves the blind of the office up as the sun passed 110 azimuth (so the sun is no longer shining directly into the office).
```
rule "OneSide up"
when
Item Azimuth changed
then
val azimuth = Math::round((Azimuth.state as DecimalType).intValue)
if (azimuth == 110)
{
OfficeBlindShutter.sendCommand(UP)
}
end
```

14
_addons_bindings/hdpowerview/readme.md
View File

@ -75,13 +75,15 @@ However, the configuration parameters are described below:
### Channels for PowerView Hub
Scene and scene group channels will be added dynamically to the binding as they are discovered in the hub.
Each scene/scene group channel will have an entry in the hub as shown below, whereby different scenes/scene groups
Scene, scene group and automation channels will be added dynamically to the binding as they are discovered in the hub.
Each will have an entry in the hub as shown below, whereby different scenes, scene groups and automations
have different `id` values:
| Channel | Item Type | Description |
|----------|-----------| ------------|
| id | Switch | Turning this to ON will activate the scene/scene group. Scenes/scene groups are stateless in the PowerView hub; they have no on/off state. Note: include `{autoupdate="false"}` in the item configuration to avoid having to reset it to off after use. |
| Channel Group | Channel | Item Type | Description |
|---------------|---------|-----------|-------------|
| scenes | id | Switch | Setting this to ON will activate the scene. Scenes are stateless in the PowerView hub; they have no on/off state. Note: include `{autoupdate="false"}` in the item configuration to avoid having to reset it to off after use. |
| sceneGroups | id | Switch | Setting this to ON will activate the scene group. Scene groups are stateless in the PowerView hub; they have no on/off state. Note: include `{autoupdate="false"}` in the item configuration to avoid having to reset it to off after use. |
| automations | id | Switch | Setting this to ON will enable the automation, while OFF will disable it. |
### Channels for PowerView Shade
@ -196,7 +198,7 @@ Switch Living_Room_Shade_Battery_Low_Alarm "Living Room Shade Battery Low Alarm
Scene items:
```
Switch Living_Room_Shades_Scene_Heart "Living Room Shades Scene Heart" <blinds> (g_Shades_Scene_Trigger) {channel="hdpowerview:hub:g24:22663", autoupdate="false"}
Switch Living_Room_Shades_Scene_Heart "Living Room Shades Scene Heart" <blinds> (g_Shades_Scene_Trigger) {channel="hdpowerview:hub:g24:scenes#22663", autoupdate="false"}
```
### `demo.sitemap` File

14
_addons_bindings/homematic/readme.md
View File

@ -172,6 +172,13 @@ The port number of the HMIP server (default = 2010)
- **cuxdPort**
The port number of the CUxD daemon (default = 8701)
- **groupPort**
The port number of the Group daemon (default = 9292)
- **callbackRegTimeout**
Maximum time in seconds for callback registration in the Homematic gateway (default = 120s).
For a CCU2, the value may need to be increased to 180s.
- **installModeDuration**
Time in seconds that the controller will be in install mode when a device discovery is initiated (default = 60)
@ -691,6 +698,13 @@ Examples: HmIP-BROLL, HmIP-FROLL, HmIP-BBL, HmIP-FBL and HmIP-DRBLI4
| openHAB | 0% | 100% |
| CCU | 100% | 0% |
** The binding does not receive any status changes from the Homematic gateway**
First of all, make sure that none of the ports needed to receive status changes from the gateway are blocked by firewall settings.
If the computer running openHAB has more than one IP address, a wrong one may have been set as receiver for status changes.
In this case change the setting for `callbackHost` to the correct address.
### Debugging and Tracing
If you want to see what's going on in the binding, switch the log level to DEBUG in the Karaf console

117
_addons_bindings/zwave/doc/eco/dtls2-zwave5_0_0.md Normal file
View File

@ -0,0 +1,117 @@
---
layout: documentation
title: DTLS2-ZWAVE5 - ZWave
---
{% include base.html %}
# DTLS2-ZWAVE5 Z-Wave Plus Smart Switch Dual Toggle
This describes the Z-Wave device *DTLS2-ZWAVE5*, manufactured by *Ecolink* with the thing type UID of ```eco_dtls2-zwave5_00_000```.
The device is in the category of *Wall Switch*, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.
![DTLS2-ZWAVE5 product image](https://opensmarthouse.org/zwavedatabase/1443/image/)
The DTLS2-ZWAVE5 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.
## Overview
Automates wall switch without replacing existing switches. Battery-powered
### Inclusion Information
The Z-Wave Plus Toggle Light Switch must be added to a Z-Wave Plus network prior to use. To include the device in a network both the device and the network controller must be in inclusion mode at the same time. Refer to the instructions provided by the manufacturer of your specific controller for details on initiating the controller’s inclusion mode.
Verify that the Z-Wave Plus controller you are using is compatible with the Z-Wave Plus Toggle Light Switch.
Locate the light switch desired to be used with the Z-Wave Plus Toggle Light Switch.
Put your Z-Wave Plus Controller into add (inclusion) mode.
Press the inclusion / exclusion button on the Z-Wave Plus Toggle Light Switch. (Figure 1)
The LED on the front of the unit will turn off if successful included into a network.
### Exclusion Information
Any Z-Wave Plus Device can be removed from any Z-Wave Plus controller. Follow the directions to put your Z-Wave Plus Controller into exclusion mode.
Press the inclusion / exclusion button on the Z-Wave Plus Toggle Light Switch.
### General Usage Information
## Channels
The following table summarises the channels available for the DTLS2-ZWAVE5 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Battery Level
Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.
The ```system.battery-level``` channel is of type ```system.battery-level``` and supports the ```Number``` item and is in the ```Battery``` category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
## Device Configuration
The device has no configuration parameters defined.
## Association Groups
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The DTLS2-ZWAVE5 supports 2 association groups.
### Group 1: Lifeline
The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation.
Association group 1 supports 1 node.
### Group 2: Basic Reports
Association group 2 supports 1 node.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
### Documentation Links
* [Product Manual](https://opensmarthouse.org/zwavedatabase/1443/reference/DTLS2-ZWAVE5_Prod_Rev06.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1443).

1
_addons_persistences/jdbc/readme.md
View File

@ -31,6 +31,7 @@ The following databases are currently supported and tested:
| [MySQL](https://www.mysql.com/) | [mysql-connector-java-5.1.39.jar](https://mvnrepository.com/artifact/mysql/mysql-connector-java) |
| [PostgreSQL](https://www.postgresql.org/) | [postgresql-9.4.1209.jre7.jar](https://mvnrepository.com/artifact/org.postgresql/postgresql) |
| [SQLite](https://www.sqlite.org/) | [sqlite-jdbc-3.16.1.jar](https://mvnrepository.com/artifact/org.xerial/sqlite-jdbc) |
| [TimescaleDB](https://www.timescale.com/) | [postgresql-9.4.1209.jre7.jar](https://mvnrepository.com/artifact/org.postgresql/postgresql) |
## Table of Contents

114
_thing_types/org.openhab.binding.dominoswiss/src/main/resources/OH-INF/thing/thing-types.xml Normal file
View File

@ -0,0 +1,114 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="dominoswiss"
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="egate">
<label>Dominoswiss EGate Server</label>
<description>This is a Dominoswiss EGate Server instance.</description>
<config-description>
<parameter name="ipAddress" type="text" required="true">
<label>IP or Host Name</label>
<context>network-address</context>
<description>The IP or host name of the Dominoswiss EGate Server (192.168.1.100, localhost)</description>
</parameter>
<parameter name="port" type="integer" required="true" min="1" max="65335">
<label>Web Port</label>
<description>Port interface of the Dominoswiss EGate Server, default 1318</description>
<default>1318</default>
</parameter>
</config-description>
</bridge-type>
<thing-type id="blind">
<supported-bridge-type-refs>
<bridge-type-ref id="egate"/>
</supported-bridge-type-refs>
<label>Blind</label>
<description>Provides various control commands for Dominoswiss receivers</description>
<channels>
<channel id="pulseUp" typeId="pulseUp"/>
<channel id="pulseDown" typeId="pulseDown"/>
<channel id="continuousUp" typeId="continuousUp"/>
<channel id="continuousDown" typeId="continuousDown"/>
<channel id="stop" typeId="stop"/>
<channel id="shutter" typeId="shutter"/>
<channel id="shutterTilt" typeId="shutterTilt"/>
<channel id="tiltUp" typeId="tiltUp"/>
<channel id="tiltDown" typeId="tiltDown"/>
</channels>
<properties>
<property name="vendor">Dominoswiss</property>
</properties>
<config-description>
<parameter name="id" type="text" required="true">
<label>ID Address</label>
<description>Blinds are identified by their ID address</description>
</parameter>
</config-description>
</thing-type>
<channel-type id="pulseUp">
<item-type>Rollershutter</item-type>
<label>Pulse Up</label>
<description>Send one pulse up</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="pulseDown">
<item-type>Rollershutter</item-type>
<label>Pulse Down</label>
<description>Send one pulse down</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="continuousUp">
<item-type>Rollershutter</item-type>
<label>Continuous Up</label>
<description>Send continuous up command to blind</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="continuousDown">
<item-type>Rollershutter</item-type>
<label>Continuous Down</label>
<description>Send continuous down command to blind</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="stop">
<item-type>Rollershutter</item-type>
<label>Stop</label>
<description>Send stop impulse to stop the blinds</description>
<state readOnly="true"/>
</channel-type>
<channel-type id="shutter">
<item-type>Rollershutter</item-type>
<label>Shutter</label>
<description>Handle the commands up/down/stop </description>
<state readOnly="true"/>
</channel-type>
<channel-type id="shutterTilt">
<item-type>Rollershutter</item-type>
<label>Shutter Tilt Up Down</label>
<description>Handle the commands tiltUp/tiltDown/stop </description>
<state readOnly="true"/>
</channel-type>
<channel-type id="tiltUp">
<item-type>Rollershutter</item-type>
<label>Tilt Up</label>
<description>Handle the command for 3 tilts up </description>
<state readOnly="true"/>
</channel-type>
<channel-type id="tiltDown">
<item-type>Rollershutter</item-type>
<label>Tilt Down</label>
<description>Handle the command for 3 tilts down </description>
<state readOnly="true"/>
</channel-type>
</thing:thing-descriptions>

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

@ -8,6 +8,12 @@
<label>PowerView Hub</label>
<description>Hunter Douglas (Luxaflex) PowerView Hub</description>
<channel-groups>
<channel-group id="scenes" typeId="scenes"/>
<channel-group id="sceneGroups" typeId="sceneGroups"/>
<channel-group id="automations" typeId="automations"/>
</channel-groups>
<properties>
<property name="vendor">Hunter Douglas (Luxaflex)</property>
<property name="modelId">PowerView Hub</property>
@ -96,6 +102,11 @@
<label>Activate</label>
</channel-type>
<channel-type id="automation-enabled">
<item-type>Switch</item-type>
<label>Enable</label>
</channel-type>
<channel-type id="battery-voltage" advanced="true">
<item-type>Number:ElectricPotential</item-type>
<label>Battery Voltage</label>
@ -103,4 +114,16 @@
<state pattern="%.1f %unit%" readOnly="true"/>
</channel-type>
<channel-group-type id="scenes">
<label>Scenes</label>
</channel-group-type>
<channel-group-type id="sceneGroups">
<label>Scene Groups</label>
</channel-group-type>
<channel-group-type id="automations">
<label>Automations</label>
</channel-group-type>
</thing:thing-descriptions>

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

@ -95,6 +95,12 @@
<advanced>true</advanced>
<default>9292</default>
</parameter>
<parameter name="callbackRegTimeout" type="integer" min="30">
<label>Callback Reg. Timeout</label>
<description>Maximum time in seconds for callback registration in the Homematic gateway.</description>
<advanced>true</advanced>
<default>120</default>
</parameter>
<parameter name="installModeDuration" type="integer" min="10" max="300" unit="s">
<label>Install Mode Duration</label>
<description>Time in seconds that the controller will be in install mode when a device discovery is initiated</description>

68
_thing_types/org.openhab.binding.zwave/src/main/resources/OH-INF/thing/eco/dtls2-zwave5_0_0.xml Normal file
View File

@ -0,0 +1,68 @@
<?xml version="1.0" encoding="UTF-8"?>
<thing:thing-descriptions bindingId="zwave"
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/v1.0.0">
<thing-type id="eco_dtls2-zwave5_00_000" listed="false">
<label>DTLS2-ZWAVE5 Z-Wave Plus Smart Switch Dual Toggle</label>
<description><![CDATA[
Z-Wave Plus Smart Switch Dual Toggle<br /> <h1>Overview</h1><p>Automates wall switch without replacing existing switches. Battery-powered<br /></p> <br /> <h2>Inclusion Information</h2><p>The Z-Wave Plus Toggle Light Switch must be added to a Z-Wave Plus network prior to use. To include the device in a network both the device and the network controller must be in inclusion mode at the same time. Refer to the instructions provided by the manufacturer of your specific controller for details on initiating the controller’s inclusion mode.<br /></p><p>Verify that the Z-Wave Plus controller you are using is compatible with the Z-Wave Plus Toggle Light Switch.</p><p>Locate the light switch desired to be used with the Z-Wave Plus Toggle Light Switch.</p><p>Put your Z-Wave Plus Controller into add (inclusion) mode.</p><p>Press the inclusion / exclusion button on the Z-Wave Plus Toggle Light Switch. (Figure 1)</p><p>The LED on the front of the unit will turn off if successful included into a network.</p> <br /> <h2>Exclusion Information</h2><p>Any Z-Wave Plus Device can be removed from any Z-Wave Plus controller. Follow the directions to put your Z-Wave Plus Controller into exclusion mode.<br /></p><p>Press the inclusion / exclusion button on the Z-Wave Plus Toggle Light Switch.</p> <br /> <h2>Wakeup Information</h2><p><br /></p>
]]></description>
<category>WallSwitch</category>
<!-- CHANNEL DEFINITIONS -->
<channels>
<channel id="switch_binary" typeId="switch_binary">
<label>Switch</label>
<properties>
<property name="binding:*:OnOffType">COMMAND_CLASS_SWITCH_BINARY</property>
</properties>
</channel>
<channel id="battery-level" typeId="system.battery-level">
<properties>
<property name="binding:*:PercentType">COMMAND_CLASS_BATTERY</property>
</properties>
</channel>
</channels>
<!-- DEVICE PROPERTY DEFINITIONS -->
<properties>
<property name="vendor">Ecolink</property>
<property name="modelId">DTLS2-ZWAVE5</property>
<property name="manufacturerId">014A</property>
<property name="manufacturerRef">0006:0004</property>
<property name="dbReference">1443</property>
<property name="defaultAssociations">1</property>
</properties>
<!-- CONFIGURATION DESCRIPTIONS -->
<config-description>
<!-- GROUP DEFINITIONS -->
<parameter-group name="association">
<context>link</context>
<label>Association Groups</label>
</parameter-group>
<!-- ASSOCIATION DEFINITIONS -->
<parameter name="group_1" type="text" groupName="association">
<label>1: Lifeline</label>
</parameter>
<parameter name="group_2" type="text" groupName="association">
<label>2: Basic Reports</label>
</parameter>
<!-- STATIC DEFINITIONS -->
<parameter name="node_id" type="integer" min="1" max="232" readOnly="true" required="true">
<label>Node ID</label>
<advanced>true</advanced>
</parameter>
</config-description>
</thing-type>
</thing:thing-descriptions>