This is a esphome-based adaption of the HCPBridge. Credits for the initial development of the HCPBridge go to Gifford47, hkiam and all the other guys contributed.
substitutions:
name: "hcpbridge"
friendly_name: "Garage Door"
esphome:
name: "${name}"
friendly_name: "${friendly_name}"
libraries:
- emelianov/modbus-esp8266 # Required for communication with the modbus
platformio_options:
board_build.f_cpu: 240000000L
board_build.flash_mode: qio
monitor_speed: 9600
monitor_filters: esp32_exception_decoder
lib_ldf_mode: deep+
# board_build.f_flash: 40000000L
external_components:
source: github://14yannick/esphome-hcpbridge
refresh: 0s # Ensure you always get the latest version
esp32:
board: #adafruit_feather_esp32s3 #set your board
framework:
type: arduino
hcpbridge:
id: hcpbridge_id
rx_pin: 18 # optional, default=18
tx_pin: 17 # optional, default=17
#rts_pin : 1 # optional RTS pin to use if hardware automatic control flow is not available.
cover:
- platform: hcpbridge
name: ${friendly_name}
device_class: garage
id: garagedoor_cover
The component provides a cover component to control the garage door.
The component provides a Light component to turn the light off and on. The Output is needed to control the light.
output:
- platform: hcpbridge
id: output_light
light:
- platform: hcpbridge
id: gd_light
output: output_light
name: Garage Door Light
The component provides you two sensor.
is_connected
: Who indicated if there is a valid connection with the door.relay_state
: Give the status of the option relay (Menu 30) of the HCP.
binary_sensor:
- platform: hcpbridge
is_connected:
name: "HCPBridge Connected"
id: sensor_connected
relay_state:
name: "Garage Door Relay state"
id: sensor_relay
#on_state:
#create your automation based on Garage Door Relay state
This component provide you a detailed current state of the door. This text can be changed using the substitute functionality.
text_sensor:
- platform: hcpbridge
id: sensor_templ_state
name: "Garage Door State"
This component allows you to add three buttons to sond commands to the door.
button:
- platform: hcpbridge
vent_button:
id: button_vent
name: "Garage Door Vent"
impulse_button:
id: button_impulse
name: "Garage Door Impulse"
half_button:
id: button_half
name: "Half"
This component allows you to add two switch to sond commands to the door.
switch:
- platform: hcpbridge
vent_switch:
id: switch_vent
name: "Venting"
restore_mode: disabled
half_switch:
id: half_switch
name: "Open Half"
restore_mode: disabled
Additionally, when using the cover component, you can expose the following services to the API:
esphome.hcpbridge_go_to_close
: To close the garage dooresphome.hcpbridge_go_to_half
: To move the garage door to half positionesphome.hcpbridge_go_to_vent
: To move the garage door to the vent positionesphome.hcpbridge_go_to_open
: To open the garage dooresphome.hcpbridge_toggle
: Send an Impulse command to the doorThere are in the YAML and not directly in the Cover to remove the API dependency there. This give the possibility to use the Cover without the API Component for exemple only with the web_server or mqtt.
api:
encryption:
key: !secret api_key
services:
- service: go_to_open
then:
- lambda: |-
id(garagedoor_cover).on_go_to_open();
- service: go_to_close
then:
- lambda: |-
id(garagedoor_cover).on_go_to_close();
- service: go_to_half
then:
- lambda: |-
id(garagedoor_cover).on_go_to_half();
- service: go_to_vent
then:
- lambda: |-
id(garagedoor_cover).on_go_to_vent();
- service: toggle
then:
- cover.toggle: garagedoor_cover
Check out the example_hcpbridge.yaml for a complete yaml with all hcpbridge components.
Tysonpower
on an Hörmann Promatic 4
You can find more information on the project here: Hörmann garage door via MQTT
I am open for contribution. Just get in contact with me.
MIT License
Copyright (c) 2023 Jochen Scheib
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.