Domoticz Homematic IP Workbook

[rwblinn]

To share my Domoticz Homematic IP Workbook (PDF, ~340 pages).

Guide on how to integrate eQ-3 Homematic CCU3 with selected Homematic IP Devices into the Domoticz Home Automation System.

Purpose
To integrate the HomeMatic Smart Home Central Control Unit (HmIP-CCU3) in the Domoticz Home Automation System.
The workbook is an addendum to the Domoticz Homeautomation Workbook.
It has been developed for personal use to explore, build, share and as a supplemental reference - use at your own risk.

Overview
Described are various ways how to integrate Homematic IP devices (connected to the CCU) in Domoticz.
Homematic offers a variety of devices. This document covers only the devices used by the author.
Whilst evolving, new devices will be added step-by-step or solutions reworked and captured in this document.
The examples are based on good-practice by the author. It does not mean that there are other and probably better ways.

There are two key chapters:

• Functions - describing dedicated solutions with Homematic IP devices.
• Explore - looking into ways of using API's & communication between the CCU and Domoticz.

Following Homematic IP devices are used (so far):

• Alert Indicator (HmIP-MOD-OC8, Receiver and switching module with 8 open-collector switching outputs, kit)
• Battery Check (All HmIP-Devices)
• Custom Pages (HmIP-CCU3, Various jQuery DataTables embedded in Domoticz custom pages, like device statelist, devicelist, statelist, roomlist)
• Duty-Cycle Monitor (HmIP-CCU3)
• E-Paper Status Display (HmIP-WRCD, Wall-mount Remote Control with status display, kit)
• Garage Door Monitor (HmIP-SWDM, Window / Door Contact - magnet)
• Heating Unit Gas Usage (HmIP-FCI1, Contact Interface flush-mount, 1 channel )
• Heating Unit Temperature (HmIP-STE2-PCB, 2-channel-Temperature Sensor )
• HM-RC-19 = CUx Daemon (CUx-D), interface between CCU-Logic (ReGa HSS) and external (incl. virtúal) devices
• Pluggable Switch and Meter (HmIP-PSM, Pluggable Switch and Meter)
• Postbox Notifier (HmIP-SWDO, Window / Door Contact optical)
• Remote Control (HmIP-RC8, Remote Control with 8 buttons)
• Statelist Node-RED (HmIP All Devices)
• Thermostat Control (HmIP-eTRV)
• Thermostat Custom Page (HmIP-eTRV, List all thermostats, change setpoint)

Domoticz

• Devices to control Homematic devices are mainly virtual devices (Hardware type "Dummy").
• Automation Events are developed in dzVents and Plugins (experimental) in Python 3.
• Communication between Domoticz and the CCU v.v. is handled via Remote Homematic Script API (embedded in dzVents) or HTTP XML- or REST-API requests with the CCU Addons XML-API, CCU-Jack (REST-API, MQTT-API) and CUx-Daemon. In addition explored the Homematic JSON-API and XML-RPC-API.

Other

• Node-RED used for tests and some tools.

Credits
A BIG THANK YOU, to the developers of Domoticz, Homematic, RaspberryMatic, Homematic addons, Tools and to all sharing information about Domoticz and/or Homematic.
Without these, it would not be possible to build this project and write this document.

Licence
GNU GENERAL PUBLIC LICENSE v3.0.

[multifluid]

Hi,

I just started with a Homematic IP Wall Thermostat and found out that to be able to control it with the app, I'd need at least a Homematic Access Point but not the CCU. Would the AP be sufficient for your project as well?

Thanks,
Multi

[rwblinn]

Thank for your request.
The workbook requirement is an HmIP-CCU3 with several add-ons. It does not support the Homematic Access Point (HmIP-HAP).

BUT as having, an unused, Homematic IP Access Point will put on my To-Do-List an action to explore how to communicate between the HmIP-HAP and Domoticz = not sure yet if possible.

Taken from the Homematic documentation:
While the Access Point establishes the connection to the free Homematic IP cloud and enables operation of the smart home system via a smartphone app, the Central Control Unit CCU3 works locally via a browser-based web interface (WebUI).

[rwblinn]

Update 20230122
See post #1.

• NEW: Function Heating Unit Gas Usage (HmIP-FCI1) - Measure the gas meter counter.
• NEW: Function Heating Unit Temperature (HmIP-STE2-PCB) - Measure heating flow and return temperatures.
• NEW: Tool Thermostat State Custom Page - View all Thermostats at a glance (Setpoint SP, Process Value PV, Diff SP-PV, Level, Battery voltage).
• UPD: RaspberryMatic CCU replaced by the Homematic Smart Home Central Control Unit CCU3.
• UPD: Function Battery Status - Renamed to Battery Check; Domoticz & Homematic Scripts reworked incl. Homematic Addon CCU-Jack REST-API.
• UPD: Function Garage Door Monitor - Reworked Homematic script & Domoticz event.
• UPD: Function Homematic Duty-Cycle Monitor - Replaced system variable solution by the new Homematic Device HmIP-CCU3; Corrected the recurring event "all day every 5 minutes".
• UPD: Function Remote-Control - RaspberryMatic to Homematic, Homematic script simplified.
• UPD: Some functions replaced Addon XML-API CCU by CCU-Jack REST-API for getting or settings Homematic values (uses JSON instead XML).
• UPD: Minor changes.

[rwblinn]

Update 20230211
See post #1.

• NEW: Function Battery Check - Remote Homematic Script solutions Timer (explored) / Push On Button (explored) / Selector Switch (in use) embedded in dzVents script.
• NEW: Function Radiator Thermostats (HmIP-eTRV) - Domoticz Automation Event dzVents to get thermostat attributes and to set setpoints using embedded Homematic Scripts which are submitted to the CCU.
• UPD: Explore XML-RPC API - Renamed to Explore Remote Homematic Script API.
• UPD: Explore Remote Homematic Script API - Reworked the chapter; Added Domoticz, Node-RED & Python examples.
• UPD: Polished up several chapters.

[rwblinn]

Update 20230605
See post #1.

• NEW: Function Custom Pages - Various jQuery DataTables embedded in Domoticz custom pages, like device statelist, devicelist, statelist, roomlist.
• NEW: Function Pluggable Switch and Meter (HmIP-PSM) - PSM Switch, PSM Power & Energy, PSM Power Monitor.
• NEW: Function Statelist Node-RED - Reworked using Node-RED v3.0.2, node-red-dashboard (3.0.2), node-red-node-ui-list (0.3.6).
• NEW: Appendix Reference Automation Script XML Parsing - Examples parsing XML tree structures from HTTP responses like CCU Addon XML-API, Homematic Remote Script API.
• NEW: GitHub folder src with Homematic scripts, Domoticz automation scripts dzVents, Custom pages.
• UPD: Function E-Paper_Status_Display-hmip-wrcd - Domoticz automation script added new pages for Gas & Power Usage; Removed Covid page; Updated Domoticz Selector Switch.
• UPD: Function Thermostat State Custom Page (HmIP-eTRV) - Reworked the page, uses the jQuery DataTables plug-in instead HTML table, column conditions for Level & Voltage.
• UPD: Reworked all chapters & scripts.
• DEL: Function Battery Check - Removed solutions not used: CCU-Jack, Remote Homematic Script, Push On Button.
• DEL: Function Coffee Machine Monitor - Removed as not used anymore. Use PSM Power Monitor instead.
• DEL: Function Duty Cycle Monitor - Removed solution not used: System Command.

Highlight of this update
jQuery DataTables embedded in Domoticz custom pages, like device statelist, devicelist, statelist, roomlist, thermostat control.