Emulates Hörmann UAP1-HCP board (HCP2= Hörmann communication protocol 2) using an ESP32 and a RS485 converter, and exposes garage door controls over web page and MQTT.
Compatible with the following motors (UAP1-HCP / HCP2-Bus / Modbus):
- SupraMatic E/P Serie 4
- ProMatic Serie 4
- Rollmatic v2
It is not compatible with E3 series motors. Previous generations have different protocol (HCP1), different pin layout, and already have another supporting project (see hgdo, hoermann_door or hormann-hcp).
- Get current status (door open/close/position, light on/off)
- Support for ESP32-S1/S2/S3
- Support multiple HCP Bridges for multiple garage doors
- HomeAssistant integration via MQTT-AutoDiscovery
- Trigger actions via Webinterface
- light on/off
- gate open, close, stop
- gate position: half, ventilation, custom (MQTT set_position compatible)
- Configuration (Wifi, MQTT, ...) via Web Interface
- Web Service API
- OTA Update (with username and password)
- First Use Hotspot for configuration
- External (optional) sensor support (threshold orientated MQTT messages):
- DS18X20 temperature sensor
- BME280 temperature and humidity sensor
- DHT22 temperature and humidity sensor
- HC-SR04 proximity sensor (car (below) detection)
- HC-SR501 PIR motion sensor
- Efficient MQTT traffic (send only MQTT Message if states changed)
http://[deviceip]
Buy a ready to use PCB on shop.tynet.eu 🚀
Step 1: Wiring
ESP32 powering requires a Step Down Module such as LM2596S DC-DC, but any 24VDC ==> 5VDC will do, even the tiny ones with 3 pin. Please note that the suggested serial pins for serial interfacing, on ESP32, are 16 RXD and 17 TXD.
It is possible to implement it with protoboard and underside soldering:
Details specific to Az-delivery ESP32 (ESP32-WROOM-32)
Note the pinout on this cheap but widespread ESP32 module is a bit different. The GND on the bottom left must not be used (it is actually wrongly labeled, it should be CMD). Use the top right instead. Moreover use the pin 16 as RXD and pin 17 as TXD to match the code on this repository (using UART2, not UART0).
Pinout RS485 Plug
📌 Pinout
- GND (Blue)
- GND (Yellow)
- B- (Green)
- A+ (Red)
- +24V (Black)
- +24V (White)
[!NOTE]
Pins A+ (Red) and B- (Green) need a 120 Ohm resistor between them for BUS termination. Some RS485 adapters provide termination pad to be soldered.
Step 2: Firmware upload
To use the board without any additional sensors (f.e. as showed in section wiring) you only need to upload the standard firmware binary.
To use additional sensors, you have also to build and upload the according firmware for the sensor. See flash instructions for further info.
DS18X20 Temperature Sensor
DS18X20 connected to GPIO4.
HC-SR501 PIR Motion sensor
Digital out connected to GPIO23.DHT22 Temperature and humudity Sensor
Digital out connected to GPIO27.BME280 Temperature and humudity Sensor
SDA connected to GPIO21
SCL/SCK connected to GPIO22
HC-SR04 Ultra sonic proximity sensor
Use the project task for HC-SR04. The wiring pins are:
SR04 Trigger pin is connected to GPIO5
SR04 ECHO pin is connected to GPIO18
It will send an mqtt discovery for two sensor one for the distance in cm available below the sensor and the other informing if the car park is available. It compare if the distance below is less than the maximal measured distance then car park is not available. The hcsr04_maxdistanceCm is defined with 150cm in configuration.h. This setting might not work for everyone. Change it to your needs.
Step 3: Configuration
At first boot the settings from the configuration.h file are taken over as user preferences. If you choose to make your own build you can setup your settings there. After first boot you can change your settings directly in the Web interface without the need to create a new build.
With the default configuration it will open a Wifi Hotspot you can connect to. When connected to it you can use the url http://192.168.4.1 in a webbrowser to access the Web Interface and configure the device.
Use the Basic Configuration section to set your wifi and MQTT credentials, after hitting the Save button your device will reboot. The Password fields are redacted if there are set with a *. If you don't want to change it just leave the * as it will be interpretet as no change.
The preferences will stay even after a OTA update. When the memory of your ESP get's deleted your ESP will again load the settings from the configuration.h file.
You can reset all preferences by pressing the BOOT button on the ESP for longer then 5 Seconds and releasing it. This will reset all preferences to the default values from configuration.h in the flashed firmware build.
Send commands
URL: http://[deviceip]/command?action=[id]
| id | Function | Other Parameters |
|---|---|---|
| 0 | Close | |
| 1 | Open | |
| 2 | Stop | |
| 3 | Ventilation | |
| 4 | Half Open | |
| 5 | Light toggle | |
| 6 | Restart | |
| 7 | Set Position | position=[0-100] |
Status report
URL: http://[deviceip]/status
Response:
{
"valid": true,
"doorstate": 64,
"doorposition": 0,
"doortarget": 0,
"lamp": false,
"temp": 19.94000053,
"lastresponse": 0,
"looptime": 1037,
"lastCommandTopic": "hormann/garage_door/command/door",
"lastCommandPayload": "close"
}
Wifi status
URL: http://[deviceip]/sysinfo
OTA Firmware update
URL: http://[deviceip]/update
Step 4: Installation and Bus Scan
- Connect the board to the BUS
- Run a BUS scan (differs on the following hardware version):
BUS scan is started through flipping (ON - OFF) last dip switch. Note that BUS power (+24v) is removed when no devices are detected. In case of issues, you may find useful to "jump start" the device using the +24V provision of other connectors of the motor control board.
With newer HW versions, the bus scan is carried out using the LC display in menu 37. For more see: Supramatic 4 Busscan
This is just a quick and dirty implementation and needs refactoring, but it is working. Using the Shutter Custom Card (from HACS) it is also possible to get a representation of the current position of the door, and slide it to custom position (through set_position MQTT command).
The switch for the venting position works with a small hack. Based on the analyses of dupas.me the motor should gave a status 0x0A in venting position. As this was not the case the variable VENT_POS in hciemulator.h was default with value '0x08' which correspond to the position when the garage door is in venting position (position available under http://[deviceip]/status). When the door is stopped in this position the doorstate is set as venting.
HomeAssistant shutter cards
Send commands
URL: http://[deviceip]/command?action=[id]
| id | Function | Other Parameters |
|---|---|---|
| 0 | Close | |
| 1 | Open | |
| 2 | Stop | |
| 3 | Ventilation | |
| 4 | Half Open | |
| 5 | Light toggle | |
| 6 | Restart | |
| 7 | Set Position | position=[0-100] |
Status report
URL: http://[deviceip]/status
Response:
{
"valid": true,
"doorstate": 64,
"doorposition": 0,
"doortarget": 0,
"lamp": false,
"temp": 19.94000053,
"lastresponse": 0,
"looptime": 1037,
"lastCommandTopic": "hormann/garage_door/command/door",
"lastCommandPayload": "close"
}
Wifi status
URL: http://[deviceip]/sysinfo
OTA Firmware update
URL: http://[deviceip]/update