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

pull/1265/head
openHAB Build Server 2020-01-21 00:03:18 +00:00
parent e1c996506c
commit 1b8a63f434
4 changed files with 154 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

155
_addons_bindings/homematic/readme.md
View File

@ -80,22 +80,22 @@ And **FROM** the gateway to the binding:
CCU Autodiscovery:
* UDP 43439
- UDP 43439
**Note:** The binding tries to identify the gateway with XML-RPC and uses henceforth:
- **CCU**
- **RF**: XML-RPC
- **WIRED**: XML-RPC
- **HMIP**: XML-RPC
- **CUxD**: BIN-RPC (CUxD version >= 1.6 required)
- **Groups**: XML-RPC
- **CCU**
- **RF**: XML-RPC
- **WIRED**: XML-RPC
- **HMIP**: XML-RPC
- **CUxD**: BIN-RPC (CUxD version >= 1.6 required)
- **Groups**: XML-RPC
- **Homegear**
- BIN-RPC
- **Homegear**
- BIN-RPC
- **Other**
- XML-RPC
- **Other**
- XML-RPC
## Supported Things
@ -107,10 +107,10 @@ With Homegear or a CCU, variables and scripts are supported too.
Gateway discovery is available:
* CCU
* RaspberryMatic >= 2.29.23.20171022
* Homegear >= 0.6.x
* piVCCU
- CCU
- RaspberryMatic >= 2.29.23.20171022
- Homegear >= 0.6.x
- piVCCU
For all other gateways you have to manually add a bridge in a things file. Device discovery is supported for all gateways.
@ -136,65 +136,65 @@ However, the install mode is not automatically enabled in this situation because
There are several settings for a bridge:
- **gatewayAddress** (required)
- **gatewayAddress** (required)
Network address of the Homematic gateway
- **gatewayType**
- **gatewayType**
Hint for the binding to identify the gateway type (auto|ccu|noccu) (default = "auto").
- **callbackHost**
- **callbackHost**
Callback network address of the system runtime, default is auto-discovery
- **bindAddress**
- **bindAddress**
The address the XML-/BINRPC server binds to, default is value of "callbackHost"
- **callbackPort** (DEPRECATED, use "binCallbackPort" resp. "xmlCallbackPort")
- **callbackPort** (DEPRECATED, use "binCallbackPort" resp. "xmlCallbackPort")
Callback port of the binding's server, default is 9125 and counts up for each additional bridge
- **xmlCallbackPort**
- **xmlCallbackPort**
Callback port of the binding's XML-RPC server, default is 9125 and counts up for each additional bridge
- **binCallbackPort**
- **binCallbackPort**
Callback port of the binding's BIN-RPC server, default is 9126 and counts up for each additional bridge
- **aliveInterval** (DEPRECATED, not necessary anymore)
- **aliveInterval** (DEPRECATED, not necessary anymore)
The interval in seconds to check if the communication with the Homematic gateway is still alive. If no message receives from the Homematic gateway, the RPC server restarts (default = 300)
- **reconnectInterval** (DEPRECATED, not necessary anymore)
- **reconnectInterval** (DEPRECATED, not necessary anymore)
The interval in seconds to force a reconnect to the Homematic gateway, disables "aliveInterval"! (0 = disabled, default = disabled).
If you have no sensors which sends messages in regular intervals and/or you have low communication, the "aliveInterval" may restart the connection to the Homematic gateway to often.
The "reconnectInterval" disables the "aliveInterval" and reconnects after a fixed period of time.
Think in hours when configuring (one hour = 3600)
- **timeout**
- **timeout**
The timeout in seconds for connections to a Homematic gateway (default = 15)
- **discoveryTimeToLive**
- **discoveryTimeToLive**
The time to live in seconds for discovery results of a Homematic gateway (default = -1, which means infinite)
- **socketMaxAlive**
- **socketMaxAlive**
The maximum lifetime of a socket connection to and from a Homematic gateway in seconds (default = 900)
- **rfPort**
- **rfPort**
The port number of the RF daemon (default = 2001)
- **wiredPort**
- **wiredPort**
The port number of the HS485 daemon (default = 2000)
- **hmIpPort**
- **hmIpPort**
The port number of the HMIP server (default = 2010)
- **cuxdPort**
- **cuxdPort**
The port number of the CUxD daemon (default = 8701)
- **installModeDuration**
- **installModeDuration**
Time in seconds that the controller will be in install mode when a device discovery is initiated (default = 60)
- **unpairOnDeletion**
If set to true, devices are automatically unpaired from the gateway when their corresponding things are deleted.
**Warning!** The option "factoryResetOnDeletion" also unpairs a device, so in order to avoid unpairing on deletion completely, both options need to be set to false! (default = false)
- **unpairOnDeletion**
If set to true, devices are automatically unpaired from the gateway when their corresponding things are deleted.
**Warning:** The option "factoryResetOnDeletion" also unpairs a device, so in order to avoid unpairing on deletion completely, both options need to be set to false! (default = false)
- **factoryResetOnDeletion**
- **factoryResetOnDeletion**
If set to true, devices are automatically factory reset when their corresponding things are removed.
Due to the factory reset, the device will also be unpaired from the gateway, even if "unpairOnDeletion" is set to false! (default = false)
@ -294,7 +294,7 @@ Example without channel configs
### Items
In the items file, you can map the datapoints, the syntax is:
In the items file, you can map the datapoints. The syntax is:
```java
homematic:TYPE:BRIDGE:SERIAL:CHANNELNUMBER#DATAPOINTNAME
@ -314,16 +314,11 @@ Dimmer Light "Light [%d %%]" { channel="homematic:HM-LC-Dim1T-Pl-2:cc
**Note:** don't forget to add the `HG-` type prefix for Homegear devices
## Virtual device and datapoints
The binding supports one virtual device and some virtual datapoints.
Virtual datapoints are generated by the binding and provides special functionality.
### GATEWAY-EXTRAS
## Virtual device GATEWAY-EXTRAX
The GATEWAY-EXTRAS is a virtual device which contains a switch to reload all values from all devices and also a switch to put the gateway in the install mode to add new devices.
If the gateway supports variables and scripts, you can handle them with this device too.
The type is generated: GATEWAY-EXTRAS-[BRIDGE_ID].
The type is generated: `GATEWAY-EXTRAS-[BRIDGE_ID]`.
**Example:** bridgeId=ccu, type=GATEWAY-EXTRAS-CCU
Address: fixed GWE00000000
@ -336,10 +331,6 @@ A virtual datapoint (Switch) to reload all values for all devices, available in
A virtual datapoint (Switch) to reload all RSSI values for all devices, available in channel 0 in GATEWAY-EXTRAS
### RSSI
A virtual datapoint (Number) with the unified RSSI value from RSSI_DEVICE and RSSI_PEER, available in channel 0 for all wireless devices
### INSTALL_MODE
A virtual datapoint (Switch) to start the install mode on the gateway, available in channel 0 in GATEWAY-EXTRAS
@ -348,6 +339,14 @@ A virtual datapoint (Switch) to start the install mode on the gateway, available
A virtual datapoint (Integer) to hold the duration for the install mode, available in channel 0 in GATEWAY-EXTRAS (max 300 seconds, default = 60)
## Virtual datapoints
Virtual datapoints are generated by the binding and provide special functionality for several device types.
### RSSI
A virtual datapoint (Number) with the unified RSSI value from RSSI_DEVICE and RSSI_PEER, available in channel 0 for all wireless devices
### DELETE_MODE
A virtual datapoint (Switch) to remove the device from the gateway, available in channel 0 for each device. Deleting a device is only possible if DELETE_DEVICE_MODE is not LOCKED
@ -368,7 +367,28 @@ A virtual datapoint (Enum) to configure the device deletion with DELETE_MODE, av
A virtual datapoint (Number) to automatically set the ON_TIME datapoint before the STATE or LEVEL datapoint is sent to the gateway, available for all devices which supports the ON_TIME datapoint.
This is useful to automatically turn off the datapoint after the specified time.
### DISPLAY_OPTIONS
### BUTTON
A virtual datapoint (String) to simulate a key press, available on all channels that contains PRESS_ datapoints.
Available values:
- `SHORT_PRESS`: triggered on a short key press
- `LONG_PRESS`: triggered on a key press longer than `LONG_PRESS_TIME` (variable configuration per key, default is 0.4 s)
- `DOUBLE_PRESS`: triggered on a short key press but only if the latest `SHORT_PRESS` or `DOUBLE_PRESS` event is not older than 2.0 s (not related to `DBL_PRESS_TIME` configuration, which is more like a key lock because if it is other than `0.0` single presses are not notified anymore)
**Example:** to capture a short key press on the 19 button remote control in a rule
```javascript
rule "example trigger rule"
when
Channel 'homematic:HM-RC-19-B:ccu:KEQ0012345:1#BUTTON' triggered SHORT_PRESS
then
...
end
```
### DISPLAY_OPTIONS (only HM-RC-19)
A virtual datapoint (String) to control the display of a 19 button Homematic remote control (HM-RC-19), available on channel 18
@ -386,7 +406,7 @@ If you specify more than one option for BEEP, BACKLIGHT and UNIT, only the first
**Examples:**
Assumed you mapped the virtual datapoint to a String item called Display_Options
Assumed you mapped the virtual datapoint to a String item called `Display_Options`.
```java
String Display_Options "Display_Options" { channel="homematic:HM-RC-19-B:ccu:KEQ0099999:18#DISPLAY_OPTIONS" }
@ -422,7 +442,7 @@ Duplicate options: TONE3 is ignored, because TONE1 is specified previously.
smarthome send Display_Options "TEXT, TONE1, BLINK_FAST, TONE3"
```
### DISPLAY_SUBMIT
### DISPLAY_SUBMIT (only HM-Dis-WM55 and HM-Dis-EP-WM55)
Adds multiple virtual datapoints to the HM-Dis-WM55 and HM-Dis-EP-WM55 devices to easily send (colored) text and icons to the display.
@ -473,28 +493,6 @@ then
Display_submit.sendCommand(ON)
end
```
### BUTTON
A virtual datapoint (String) to simulate a key press, available on all channels that contains PRESS_ datapoints.
Available values:
* `SHORT_PRESS`: triggered on a short key press
* `LONG_PRESS`: triggered on a key press longer than `LONG_PRESS_TIME` (variable configuration per key, default is 0.4 s)
* `DOUBLE_PRESS`: triggered on a short key press but only if the latest `SHORT_PRESS` or `DOUBLE_PRESS` event is not older than 2.0 s (not related to `DBL_PRESS_TIME` configuration, which is more like a key lock because if it is other than `0.0` single presses are not notified anymore)
**Example:** to capture a short key press on the 19 button remote control in a rule
```javascript
rule "example trigger rule"
when
Channel 'homematic:HM-RC-19-B:ccu:KEQ0012345:1#BUTTON' triggered SHORT_PRESS
then
...
end
```
## Troubleshooting
**SHORT & LONG_PRESS events of push buttons do not occur on the event bus**
@ -507,7 +505,7 @@ After the creation of this program, the button device will receive configuration
**INSTALL_TEST**
If a button is still not working and you do not see any PRESS_LONG / SHORT in your log file (loglevel DEBUG), it could be because of enabled security.
If a button is still not working and you do not see any PRESS_LONG / SHORT in your log file (log level DEBUG), it could be because of enabled security.
Try to disable security of your buttons in the HomeMatic Web GUI and try again.
If you can't disable security try to use key INSTALL_TEST which gets updated to ON for each key press
@ -532,7 +530,8 @@ Use the ```gatewayType=ccu``` config to force the binding to use the CCU impleme
The CCU only sends an event if a datapoint of a device has changed.
There is (currently) no way to receive an event automatically when a variable has changed.
To reload all variable values, send a REFRESH command to any variable.
e.g you have an item linked to a variable with the name Var_1
E.g you have an item linked to a variable with the name `Var_1`.
In the console:
```shell
@ -547,12 +546,12 @@ import org.eclipse.smarthome.core.types.RefreshType
Var_1.sendCommand(RefreshType.REFRESH)
```
**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS Thing is currently not supported.
You have to delete the Thing, start a scan and add it again.
**Note:** adding new and removing deleted variables from the GATEWAY-EXTRAS thing is currently not supported.
You have to delete the thing, start a scan and add it again.
### Debugging and Tracing
If you want to see what's going on in the binding, switch the loglevel to DEBUG in the Karaf console
If you want to see what's going on in the binding, switch the log level to DEBUG in the Karaf console
```shell
log:set DEBUG org.openhab.binding.homematic

17
_addons_bindings/mqtt.generic/readme.md
View File

@ -261,6 +261,23 @@ Here are a few examples:
- For an output of *May 23, 1995* use "%1$**tb** %1$**te**,%1$**tY**".
- For an output of *23.05.1995* use "%1$**td**.%1$**tm**.%1$**tY**".
- For an output of *23:15* use "%1$**tH**:%1$**tM**".
Default pattern applied for each type:
| Type | Parameter | Pattern | Comment |
| ---------------- | --------------------------------- | ------------------- | ------- |
| __string__ | String | "%s" |
| __number__ | BigDecimal | "%f" | The default will remove trailing zeros after the decimal point.
| __dimmer__ | BigDecimal | "%f" | The default will remove trailing zeros after the decimal point.
| __contact__ | String | -- | No pattern supported. Always **on** and **off** strings.
| __switch__ | String | -- | No pattern supported. Always **on** and **off** strings.
| __colorRGB__ | BigDecimal, BigDecimal, BigDecimal| "%1$d,%2$d,%3$d" | Parameters are **red**, **green** and **blue** components.
| __colorHSB__ | BigDecimal, BigDecimal, BigDecimal| "%1$d,%2$d,%3$d" | Parameters are **hue**, **saturation** and **brightness** components.
| __location__ | BigDecimal, BigDecimal | "%2$f,%3$f,%1$f" | Parameters are **altitude**, **latitude** and **longitude**, altitude is only in default pattern, if value is not '0'.
| __image__ | -- | -- | No publishing supported.
| __datetime__ | ZonedDateTime | "%1$tY-%1$tm-%1$tdT%1$tH:%1$tM:%1$tS.%1$tN" | Trailing zeros of the nanoseconds are removed.
| __rollershutter__| String | "%s" | No pattern supported. Always **up**, **down**, **stop** string or integer percent value.
Any outgoing value transformation will **always** result in a __string__ value.
## Troubleshooting

11
_addons_bindings/onewire/readme.md
View File

@ -35,16 +35,9 @@ The `owserver` is the bridge that connects to an existing OWFS installation.
There are different types of things: the simple one (`basic`), multisensors built around the DS1923/DS2438 chip (`ms-tx`) and more advanced sensors from Elaborated Networks (www.wiregate.de) (`ams`, `bms`), Embedded Data System (www.embeddeddatasystems.com)(`edsenv`) and Brain4Home (www.brain4home.eu) (`bae091x`).
** Important: Breaking Change with next release **
** Important: Breaking Change **
The thing types `ms-th` and `ms-tv` have been marked deprecated and will be updated to `ms-tx` automatically.
The thing types `counter2`, `digitalio`, `digitalio2`, `digitalio8`, `ibutton`, `temperature` have been marked deprecated and will be updated to `basic` automatically.
Please note that auto-upgraded things keep their thing UID _including the deprecated thing type_.
Manually (via textual configuration) defined things need to be changed to `ms-tx` or `basic` respectively.
The thing UID changes and the item links need to be adjusted to the new UID.
Deprecated thing types will will be removed with the next official release.
The thing types `ms-th`, `ms-tv`, `counter2`, `digitalio`, `digitalio2`, `digitalio8`, `ibutton`, `temperature` have been removed.
## Discovery

98
_addons_bindings/somfytahoma/readme.md
View File

@ -50,6 +50,7 @@ home automation systems.
- docks (battery info, siren control)
- sirens (battery status full/low/normal/verylow, siren control ON/OFF, setting memorized volume)
- action groups (scenarios which can execute predefined Tahoma group of steps, e.g. send to all roller shutters DOWN command, one by one)
- thermostats (read status and battery level)
Both Somfy Tahoma and Somfy Connexoon gateways have been confirmed working.
@ -76,52 +77,69 @@ Please see the example below.
| Thing | Channel | Note |
|-------------------------------------------------------------------------------|:---------------------:|------------------------------------------------------------------------------------------------------------------|
| bridge | N.A | bridge does not expose any channel |
| gateway | status | status of your Tahoma gateway |
| gate | gate_command | used for controlling your gate (open, close, stop, pedestrian) |
| gate | gate_state | get state of your gate |
| roller shutter, screen, venetian blind, garage door, awning, pergola, curtain | control | device controller which reacts to commands UP/DOWN/ON/OFF/OPEN/CLOSE/MY/STOP + closure 0-100 |
| window | control | device controller which reacts to commands UP/DOWN/ON/OFF/OPEN/CLOSE/STOP + closure 0-100 |
| venetian blind, adjustable slats roller shutter | orientation | percentual orientation of the blind's slats, it can have value 0-100). For IO Homecontrol devices only (non RTS) |
| adjustable slats roller shutter | rocker | used for setting the rocker position of the roller shutter, the only position allowing the slats control |
| action group | execute_action | switch which reacts to ON command and triggers the predefined Tahoma action |
| onoff, light | switch | reacts to standard ON/OFF commands |
| smoke sensor, occupancy sensor & contact sensor | contact | normal value is CLOSE, changes to OPEN when detection triggered |
| smoke sensor | short_check | triggering the smoke sensor's short check |
| smoke sensor | long_check | triggering the smoke sensor's long check |
| light sensor | luminance | light luminance value in luxes |
| electricity sensor | energy_consumption | energy consumption value in watts |
| dock | battery_status | indicates running on battery (yes/no) |
| dock | battery_level | remaining battery percentage |
| dock | siren_status | used for controlling and getting siren state (on, off, cyclic) |
| dock | short_beep | testing of dock's siren - short beep |
| dock | long_beep | testing of dock's siren - long beep |
| siren | battery | battery level full/low/normal/verylow |
| siren | onoff | controlling siren status ON/OFF |
| siren | memorized_volume | setting memorized volume (normal/highest) |
| pod | cyclic_button | pod cyclic button state |
| pod | battery_status | pod battery status state |
| pod | lighting_led_pod_mode | lighting LED pod mod state |
| interior alarm | alarm_command | used for sending commands to Somfy alarm device |
| interior alarm | intrusion_control | used for alarm external intrusion controlling |
| interior alarm | alarm_state | state of the Somfy alarm |
| interior alarm | target_alarm_state | target state of the Somfy alarm |
| interior alarm | intrusion_state | intrusion state of the Somfy alarm |
| external alarm | active_zones_state | state of external alarm active zones |
| door lock | lock | switch representing unlocked/locked state |
| door lock | open | switch representing open/close state |
| on/off heating system | target_heating_level | target heating level (off, eco, comfort, frostprotection) |
| heating system | current_temperature | current temperature of the heating system |
| heating system | current_state | current state of the heating system |
| heating system | target_temperature | target temperature of the heating system |
| heating system | battery_level | battery level of the heating system |
| temperature sensor | temperature | temperature reported by the sensor |
| bridge | N.A | bridge does not expose any channel |
| gateway | status | status of your Tahoma gateway |
| gate | gate_command | used for controlling your gate (open, close, stop, pedestrian) |
| gate | gate_state | get state of your gate |
| roller shutter, screen, venetian blind, garage door, awning, pergola, curtain | control | device controller which reacts to commands UP/DOWN/ON/OFF/OPEN/CLOSE/MY/STOP + closure 0-100 |
| window | control | device controller which reacts to commands UP/DOWN/ON/OFF/OPEN/CLOSE/STOP + closure 0-100 |
| silent roller shutter | silent_control | similar to control channel but in silent mode |
| venetian blind, adjustable slats roller shutter | orientation | percentual orientation of the blind's slats, it can have value 0-100). For IO Homecontrol devices only (non RTS) |
| adjustable slats roller shutter | rocker | used for setting the rocker position of the roller shutter, the only position allowing the slats control |
| action group | execute_action | switch which reacts to ON command and triggers the predefined Tahoma action |
| onoff, light | switch | reacts to standard ON/OFF commands |
| smoke sensor, occupancy sensor, contact sensor & water sensor | contact | normal value is CLOSE, changes to OPEN when detection triggered |
| smoke sensor | short_check | triggering the smoke sensor's short check |
| smoke sensor | long_check | triggering the smoke sensor's long check |
| light sensor | luminance | light luminance value in luxes |
| electricity sensor | energy_consumption | energy consumption value in watts |
| humidity sensor | humidity | current relative humidity |
| dock | battery_status | indicates running on battery (yes/no) |
| dock | battery_level | remaining battery percentage |
| dock | siren_status | used for controlling and getting siren state (on, off, cyclic) |
| dock | short_beep | testing of dock's siren - short beep |
| dock | long_beep | testing of dock's siren - long beep |
| siren | battery | battery level full/low/normal/verylow |
| siren | onoff | controlling siren status ON/OFF |
| siren | memorized_volume | setting memorized volume (normal/highest) |
| pod | cyclic_button | pod cyclic button state |
| pod | battery_status | pod battery status state |
| pod | lighting_led_pod_mode | lighting LED pod mod state |
| interior alarm | alarm_command | used for sending commands to Somfy alarm device |
| interior alarm | intrusion_control | used for alarm external intrusion controlling |
| interior alarm, myfox alarm | alarm_state | state of the Somfy alarm |
| interior alarm | target_alarm_state | target state of the Somfy alarm |
| interior alarm, myfox alarm | intrusion_state | intrusion state of the Somfy alarm |
| external alarm | active_zones_state | state of external alarm active zones |
| door lock | lock | switch representing unlocked/locked state |
| door lock | open | switch representing open/close state |
| on/off heating system | target_heating_level | target heating level (off, eco, comfort, frostprotection) |
| heating system | current_temperature | current temperature of the heating system |
| heating system | current_state | current state of the heating system |
| heating system, thermostat | target_temperature | target temperature of the heating system |
| heating system, thermostat | battery_level | battery level of the heating system |
| thermostat | heating_mode | standard heating mode of the thermostat (away, freeze, manual, ...) |
| thermostat | derogation_heating_mode | derogation heating mode of the thermostat (away, freeze, manual, ...) |
| thermostat | derogation_activation | derogation activation state (inactive, active) |
| temperature sensor | temperature | temperature reported by the sensor |
| myfox camera, myfox alarm | cloud_status | cloud connection status |
| myfox camera | shutter | controlling of the camera shutter |
| myfox alarm | myfox_alarm_command | used for sending commands to Somfy Myfox alarm device |
When a roller shutter-like thing receives STOP command, there are two possible behaviours
- when the roller shutter is idle then MY command is interpreted (the roller shutter/exterior screen/awning goes to your favourite position)
- when the roller shutter is moving then STOP command is interpreted (the roller shutter/exterior screen/awning stops)
If you want to set the MY position of a roller shutter and you don't care the possible movement, try sending the MOVE command (OH2 does not know MY, so it stands for "move to MY position")
```
sendCommand(ROLLERSHUTTER_THING, MOVE)
```
or
```
ROLLERSHUTTER_THING.sendCommand(MOVE)
```
## Full Example