Openhab 2 Homematic Ip Ohne Ccu

# Homematic Binding

This is the binding for the eQ-3 Homematic Solution (opens new window) . This binding allows you to integrate, view, control and configure all Homematic devices in openHAB.

# Configuration of the CCU

Under Abode folio > Settings > Control panel with the bill of fare Configure Firewall the Firewall configurations have to be adapted. The CCU has to be configured to have "XML-RPC" fix to "Full Access" or "Restricted access". As well the "Remote Homematic-Script API" has to exist set to "Full Access" or "Restricted access". When the option "Restricted access" is used, some ports take to be added to the "Port opening" list.

Also the IP of the device running openHAB has to be set to the listing of "IP addresses for restricted access".

Also under Dwelling house page > Settings > Control panel with the menu Security the option Hallmark has to be disabled as the bounden does non support the configuration of username and passwordfor the XML-RPC API.

If this is non done the binding will not be able to connect to the CCU and the CCU Thing will stay uninitialized and sets a timeout exception:

# Supported Bridges

All gateways which provides the Homematic BIN- or XML-RPC API:

CCU one, 2 and three
RaspberryMatic (opens new window)
Homegear (opens new window) (>= 0.eight.0-1988)
piVCCU (opens new window)
YAHM (opens new window)
Windows BidCos service (opens new window) (included in "LAN Usersoftware" download)
OCCU (opens new window)

The Homematic IP Access Indicate does non support this API and and can't exist used with this binding.

Homematic IP support:

CCU2 with at to the lowest degree firmware ii.17.15
RaspberryMatic (opens new window) with the HM-MOD-RPI-PCB (opens new window) or RPI-RF-Modernistic (opens new window) RF module
piVCCU (opens new window)
YAHM (opens new window)

These ports are used by the binding by default to communicate TO the gateway:

RF components: 2001
WIRED components: 2000
HMIP components: 2010
CUxD: 8701
TclRegaScript: 8181
Groups: 9292

And FROM the gateway to the binding:

XML-RPC: 9125
BIN-RPC: 9126

CCU Autodiscovery:

UDP 43439

Note: The bounden 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.half-dozen required)
- Groups: XML-RPC
Homegear
- BIN-RPC
Other
- XML-RPC

# Supported Things

All devices connected to a Homematic gateway. All required metadata are generated during device discovery. With Homegear or a CCU, variables and scripts are supported too.

# Discovery

Gateway discovery is available:

CCU
RaspberryMatic >= ii.29.23.20171022
Homegear >= 0.half-dozen.x
piVCCU

For all other gateways you have to manually add a bridge in a things file. Device discovery is supported for all gateways.

The binding has a gateway type autodetection, simply sometimes a gateway does not conspicuously notify the type. If you are using a YAHM for instance, you lot have to manually set the gateway type in the bride configuration to CCU.

If autodetection can non identify the gateway, the binding uses the default gateway implementation. The deviation is, that variables, scripts and device names are not supported, everything else is the same.

# Automatic install fashion during discovery

Besides discovering devices that are already known by the gateway, it may be desired to connect new devices to your arrangement - which requires your gateway to be in install fashion. Starting the binding'due south DiscoveryService will automatically put your gateway(south) in install way for a specified period of time (see installModeDuration).

Notation: Enabling / disabling of install mode is also available via GATEWAY-EXTRAS. You may utilize this if you prefer.

Exception: If a gateway is non ONLINE, the install fashion will not be ready automatically. For case during initialization of the binding its DiscoveryService is started and will discover devices that are already connected. However, the install mode is not automatically enabled in this situation because the gateway is in the status INITIALIZING.

# Bridge Configuration

There are several settings for a bridge:

gatewayAddress (required) Network accost of the Homematic gateway
gatewayType Hint for the binding to identify the gateway blazon (auto|ccu|noccu) (default = "machine").
callbackHost Callback network accost of the system runtime, default is motorcar-discovery
xmlCallbackPort Callback port of the bounden's XML-RPC server, default is 9125 and counts upwards for each additional bridge
binCallbackPort Callback port of the binding's BIN-RPC server, default is 9126 and counts up for each additional bridge
timeout The timeout in seconds for connections to a Homematic gateway (default = 15)
discoveryTimeToLive The time to live in seconds for discovery results of a Homematic gateway (default = -1, which means infinite)
socketMaxAlive The maximum lifetime of a socket connection to and from a Homematic gateway in seconds (default = 900)
rfPort The port number of the RF daemon (default = 2001)
wiredPort The port number of the HS485 daemon (default = 2000)
hmIpPort 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 fourth dimension in seconds for callback registration in the Homematic gateway (default = 120s). For a CCU2, the value may need to exist increased to 180s.
installModeDuration Time in seconds that the controller will exist in install style 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 social club to avoid unpairing on deletion completely, both options need to be ready to simulated! (default = faux)
factoryResetOnDeletion If set up to truthful, devices are automatically factory reset when their corresponding things are removed. Due to the manufactory reset, the device will too be unpaired from the gateway, even if "unpairOnDeletion" is gear up to false! (default = false)
bufferSize If a large number of devices are connected to the gateway, the default buffersize of 2048 kB may be too small for communication with the gateway. In this case, e.g. the discovery fails. With this setting the buffer size can be adjusted. The value is specified in kB.

The syntax for a span is:

homematic the binding id, stock-still
bridge the type, fixed
name the proper noun of the span

# Example

Minimum configuration

With callback settings

Multiple bridges

# Thing Configuration

Things are all discovered automatically.

If y'all really like to manually configure a thing:

The showtime parameter after Thing is the device blazon, the second the serial number. If y'all are using Homegear, you have to add together the prefix HG- for each type. The HG- prefix is merely needed for Things, not for Items or channel configs. This is necessary, because the Homegear devices supports more datapoints than Homematic devices.

All channels take two configs:

filibuster: delays transmission of a command to the Homematic gateway, indistinguishable commands are filtered out
receiveDelay: delays a received event from the Homematic gateway, indistinguishable events are filtered out (OH 2.2)

The receiveDelay is handy for dimmers and roller shutters for example. If yous have a slider in a UI and you motility this slider to a new position, it jumps around because the gateway sends multiple events with dissimilar positions until the final has been reached. If you prepare the receiveDelay to some seconds, these events are filtered out and only the concluding position is distributed to the binding. The disadvantage is of course, that all events for this channel are delayed.

The Type is the device type, aqueduct number and Upper-case letter channel proper noun separated with an underscore. Notation that, for Homegear devices, in contrast to the specification of the Affair above no HG- prefix is needed for the specification of the Type of the Aqueduct.

The aqueduct configs are optional.

Example without aqueduct configs

# Items

In the items file, y'all can map the datapoints. The syntax is:

homematic: the binding id, fixed
type: the blazon of the Homematic device
span: the proper noun of the bridge
serial: the serial number of the Homematic device
channelnumber: the channel number of the Homematic datapoint
datapointname: the name of the Homematic datapoint

Note: don't forget to add the HG- type prefix for Homegear devices

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 manner to add new devices. If the gateway supports variables and scripts, y'all tin handle them with this device too.

The type is generated: GATEWAY-EXTRAS-[BRIDGE_ID]. Case: bridgeId=ccu -> type=GATEWAY-EXTRAS-CCU

The address of the virtual device must be the default value GWE00000000. Usage of a custom ID is not supported.

# RELOAD_ALL_FROM_GATEWAY

A virtual datapoint (Switch) to reload all values for all devices, available in aqueduct 0 in GATEWAY-EXTRAS

A virtual datapoint (Switch) to reload all RSSI values for all devices, available in channel 0 in GATEWAY-EXTRAS

# INSTALL_MODE

A virtual datapoint (Switch) to start the install mode on the gateway, available in channel 0 in GATEWAY-EXTRAS

# INSTALL_MODE_DURATION

A virtual datapoint (Integer) to hold the duration for the install mode, bachelor in channel 0 in GATEWAY-EXTRAS (max 300 seconds, default = lx)

# Virtual datapoints

Virtual datapoints are generated past the binding and provide special functionality for several device types.

A virtual datapoint (Number) with the unified RSSI value from RSSI_DEVICE and RSSI_PEER, bachelor 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 simply possible if DELETE_DEVICE_MODE is not LOCKED

# DELETE_DEVICE_MODE

A virtual datapoint (Enum) to configure the device deletion with DELETE_MODE, available in channel 0 for each device

LOCKED: (default) device can not exist deleted
RESET: device is reset to factory settings before deleting
FORCE: device is also deleted if it is not reachable
DEFER: if the device can non be reached, it is deleted at the adjacent opportunity

Note: if yous alter the value and don't delete the device, the virtual datapoints resets to LOCKED later on 30 seconds

# ON_TIME_AUTOMATIC

A virtual datapoint (Number) to automatically prepare the ON_TIME datapoint earlier the Country or LEVEL datapoint is sent to the gateway, bachelor for all devices which supports the ON_TIME datapoint. This is useful to automatically turn off the datapoint later the specified time.

# Button

A virtual datapoint (String) to simulate a primal press, bachelor on all channels that contains PRESS_ datapoints.

Bachelor values:

SHORT_PRESSED: triggered on a brusque key press
LONG_PRESSED: triggered on a key press longer than LONG_PRESS_TIME (variable configuration per cardinal, default is 0.four s)
LONG_REPEATED: triggered on long fundamental press repetition, that is, in LONG_PRESS_TIME intervals as long equally key is held
LONG_RELEASED: triggered when a key is released after beingness long pressed

Instance: to capture a brusk key press on the 19 push button remote control in a rule

# DISPLAY_OPTIONS (just HM-RC-19)

A virtual datapoint (String) to control the display of a 19 push button Homematic remote control (HM-RC-xix), available on channel 18

The remote control display is express to five characters, a longer text is truncated.

You accept several boosted options to control the display.

BEEP (TONE1, TONE2, TONE3) - allow the remote control beep
BACKLIGHT (BACKLIGHT_ON, BLINK_SLOW, BLINK_FAST) - control the brandish backlight
Unit of measurement (PERCENT, WATT, CELSIUS, FAHRENHEIT) - display one of these units
SYMBOL (Seedling, SWITCH, WINDOW, DOOR, BLIND, SCENE, PHONE, BELL, CLOCK, ARROW_UP, ARROW_DOWN) - display symbols, multiple symbols possible

You can combine any option, they must be separated by a comma. If yous specify more than one choice for BEEP, BACKLIGHT and UNIT, only the first one is taken into business relationship and all others are ignored. For SYMBOL you lot can specify multiple options.

Examples:

Causeless y'all mapped the virtual datapoint to a String detail called Display_Options.

evidence bulletin "TEST":

testify message "TEXT", beep once and plough backlight on:

show message "xv", beep in one case, plow backlight on and shows the celsius unit of measurement:

prove message "ALARM", beep iii times, let the backlight blink fast and shows a bell symbol:

Duplicate options: TONE3 is ignored, because TONE1 is specified previously.

# 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.

Note: The HM-Dis-EP-WM55 has merely a black and white display and therefore does not support datapoints for colored lines. In addition, only lines ane-3 tin be set.

# Example

Display text at line 1,three and v when the bottom push on the display is pressed

Items

Dominion

Available icons:

NONE
OFF
ON
OPEN
Closed
Mistake
OK
INFO
NEW_MESSAGE
SERVICE
SIGNAL_GREEN
SIGNAL_YELLOW
SIGNAL_RED

Available colors (just HM-Dis-WM55):

NONE(=WHITE)
WHITE
Ruddy
ORANGE
Xanthous
Greenish
BLUE

# HmIP-WRCD

The HmIP-WRCD display lines can be fix via a combined parameter:

# Prepare Display Lines

The combined parameter tin be used in a rule file similar this:

If you lot want to utilize the combined parameter in the console, you have to use ' instead of ", to preclude evaluation of curly braces:

Key translation:

DDBC: Background colour of this line. (WHITE, Black)
DDTC: Text colour of this line. (WHITE, BLACK)
DDI: Icon to be shown after text. (see icon listing below)
DDA: Alignment of this line. (LEFT, CENTER, Correct)
DDS: Text of this line. (String, but see special character listing beneath)
DDID: Line number. (i-5)
DDC: Commit, should exist set in the last line, otherwise leave unset. (true)

Each line can exist updated separately without changing the other lines.

Multiple lines tin can be updated inside one command, use comma to separate each line. Here an example for a rule file:

Special Characters:

[ -> Ä
# -> Ö
$ -> Ü
{ -> ä
| -> ö
} -> ü
_ -> ß
] -> &
' -> =
; -> Sand Glass
< -> Arrow Downward
= -> Pointer Up
> -> Arrow Up Right
@ -> Arrow Down Right

Icons:

0 - No Icon
1 - Low-cal off
two - Lite on
3 - Locked
iv - Unlocked
5 - X
6 - Check
vii - Information
8 - Envelope
nine - Spanner
x - Sunday
11 - Moon
12 - Wind
thirteen - Deject
14 - Cloud/Lightning
15 - Cloud/Light Pelting
16 - Deject/Moon
17 - Deject/Rain
18 - Deject/Snow
nineteen - Deject/Lord's day
20 - Cloud/Lord's day/Rain
21 - Cloud/Snowflake
22 - Cloud/Raindrop
23 - Flame
24 - Window Open
25 - Roller Shutter
26 - Eco
27 - ? (Rectangle in circle)
28 - House with person
29 - Firm empty
30 - Bell
31 - Clock

# Warning Beep

The display can likewise make short beep alarms:

Note, that a commit (DDC) is not necessary for sounds.

As with line configuration, this tin can be combined with other line updates, separated with a comma.

Key translations

R: Repetitions (0 to 15, xv=infinite)
IN: Interval (5 to 80 in steps of 5)
ANS: Beep sound (-1 to 7, run into beep table)

Beep Sounds This is the official mapping for the beep sounds

-i - No Sound
0 - Empty Battery
one - Alert Off
2 - External Alarm activated
3 - Internal Alarm activated
iv - External Alarm delayed activated
5 - Internal Alarm delayed activated
6 - Effect
7 - Mistake

# Troubleshooting

Curt & LONG_PRESS events of push buttons do not occur on the consequence coach

It seems buttons like the HM-PB-two-WM55 practice just ship these kind of events to the CCU if they are mentioned in a CCU programme. A elementary workaround to make them send these events is, to create a programme (rule within the CCU) that does merely accept a "When" part and no "So" role, in this "When" role each channel needs to be mentioned at least once. Equally the HM-Atomic number 82-ii-WM55 for example has two channels, information technology is enough to mention the SHORT_PRESS event of aqueduct 1 & 2. The LONG_PRESS events will work automatically every bit they are part of the same channels. After the creation of this plan, the push device will receive configuration data from the CCU which have to be accepted by pressing the config-button at the back of the device.

INSTALL_TEST

If a push button is still not working and y'all exercise not encounter any PRESS_LONG / Curt in your log file (log level DEBUG), it could be because of enabled security. Attempt to disable security of your buttons in the HomeMatic Web GUI and try once more. If y'all tin't disable security try to use central INSTALL_TEST which gets updated to ON for each primal press

-1 Failure

A device may return this failure while fetching the datapoint values. I take tested pretty much simply I did not notice the reason. The HM-ES-TX-WM device for example e'er returns this failure, it is impossible with the current CCU2 firmware (2.17.15) to fetch the values. I take implemented 2 workarounds, if a device returns the failure, workaround one is executed, if the device still returns the failure, workaround 2 is executed. This always works in my tests, but you may run into an OFFLINE, ONLINE bicycle for the device. Fetching values is only done at startup or if you trigger a REFRESH. I hope this will be fixed in one of the next CCU firmwares. With Homegear (opens new window) everything works as expected.

No variables and scripts in GATEWAY-EXTRAS

The gateway autodetection of the bounden can non conspicuously place the gateway and falls dorsum to the default implementation. Utilise the gatewayType=ccu config to force the binding to utilise the CCU implementation.

Variables out of sync

The CCU only sends an event if a datapoint of a device has changed. There is (currently) no style to receive an event automatically when a variable has inverse. To reload all variable values, send a REFRESH command to any variable. E.g you take an item linked to a variable with the name Var_1.

In the console:

In scripts:

Notation: adding new and removing deleted variables from the GATEWAY-EXTRAS thing is currently not supported. Y'all have to delete the thing, start a browse and add it once again.

openhab.log contains an exception with message: Buffering chapters 2097152 exceeded resp. discovery detects no devices

In case of bug in the discovery or if above mentioned error message appears in openhab.log, the size for the transmission buffer for the communication with the gateway is too small. The problem can exist solved by increasing the bufferSize value in the bridge configuration.

Rollershutters are inverted

openHAB and the CCU are using different values for the same state of a rollershutter. Examples: HmIP-BROLL, HmIP-FROLL, HmIP-BBL, HmIP-FBL and HmIP-DRBLI4

	Open	Closed
openHAB	0%	100%
CCU	100%	0%

** The binding does not receive whatsoever condition changes from the Homematic gateway**

Starting time of all, brand sure that none of the ports needed to receive status changes from the gateway are blocked by firewall settings.

If the estimator running openHAB has more than 1 IP accost, a wrong 1 may have been ready as receiver for status changes. In this case change the setting for callbackHost to the right address.

# Debugging and Tracing

If y'all want to see what'southward going on in the binding, switch the log level to DEBUG in the Karaf console

If you want to see fifty-fifty more, switch to TRACE to as well see the gateway asking/response data

Gear up the logging back to normal

To identify problems, a full startup TRACE log will be needed: