Allow setting rx and tx pin

README.md

@@ -11,11 +11,11 @@ This is a esphome-based adaption of the HCPBridge. Credits for the initial devel
 
 ### Example esphome configuration
 
-```
+```YAML
 esphome:
   name: hcpbridge
   libraries:
-    - emelianov/modbus-esp8266
+    - emelianov/modbus-esp8266 # Required for communication with the modbus
   platformio_options:
     board_build.f_cpu: 240000000L
     board_build.flash_mode: qio
@@ -26,14 +26,15 @@ esphome:
 
 external_components:
     source: github://mapero/esphome-hcpbridge
+    refresh: 0s # Ensure you always get the latest version
 
 esp32:
   board: adafruit_feather_esp32s3
   framework:
     type: arduino
 
 hcpbridge:
-  is_connected:
+  is_connected: # Sensor to display the connection status to the motor
     name: "HCPBridge Connected"
 
 cover:
@@ -44,21 +45,12 @@ switch:
   - platform: hcpbridge
     name: Garage Light
 
+# API to communicate with home assistant
 api:
+  encryption:
+    key: !secret api_key
 
-web_server:
-  port: 80
-
-wifi:
-  ssid: !secret wifi_ssid
-  password: !secret wifi_password
-
-# Enable logging
-logger:
-  level: DEBUG
-  baud_rate: 9600
-
-# Example configuration entry
+# Enable OTA updates
 ota:
   safe_mode: true
 ```
@@ -96,7 +88,7 @@ You can find more information on the project here: [Hörmann garage door via MQT
 - [ ] Use esphome modbus component instead of own code
 - [ ] Map additional functions to esphome
 - [ ] Use callbacks instead of pollingComponent
-- [ ] Expert options for the HCPBridge component (GPIOs ...)
+- [x] Expert options for the HCPBridge component (GPIOs ...)
 
 # Contribute
 

components/hcpbridge/__init__.py

@@ -2,15 +2,19 @@
 import esphome.codegen as cg
 import esphome.config_validation as cv
 from esphome.components import binary_sensor
+from esphome import pins
 from esphome.const import (
     CONF_ID,
     DEVICE_CLASS_CONNECTIVITY,
+    CONF_RX_PIN,
+    CONF_TX_PIN,
 )
 
 AUTO_LOAD = ["binary_sensor"]
 
 CONF_IS_CONNECTED = "is_connected"
 
+
 hcpbridge_ns = cg.esphome_ns.namespace("hcpbridge")
 HCPBridge = hcpbridge_ns.class_("HCPBridge", cg.Component)
 
@@ -22,6 +26,8 @@
     cv.Required(CONF_IS_CONNECTED): binary_sensor.binary_sensor_schema(
                 device_class=DEVICE_CLASS_CONNECTIVITY,
             ),
+    cv.Optional(CONF_RX_PIN): pins.gpio_input_pin_schema,
+    cv.Optional(CONF_TX_PIN): pins.gpio_output_pin_schema,
   })
 )
 
@@ -31,4 +37,10 @@ async def to_code(config):
 
   if CONF_IS_CONNECTED in config:
     sens = await binary_sensor.new_binary_sensor(config[CONF_IS_CONNECTED])
-    cg.add(var.set_is_connected(sens))
+    cg.add(var.set_is_connected(sens))
+  if CONF_RX_PIN in config:
+    rx_pin = await cg.gpio_pin_expression(config[CONF_RX_PIN])
+    cg.add(var.set_rx_pin(rx_pin))
+  if CONF_TX_PIN in config:
+    tx_pin = await cg.gpio_pin_expression(config[CONF_TX_PIN])
+    cg.add(var.set_tx_pin(tx_pin))

components/hcpbridge/hcpbridge.cpp

@@ -8,8 +8,12 @@ namespace esphome
     void HCPBridge::setup()
     {
       this->is_connected_->publish_state(false);
+
+      int8_t rx = this->rx_pin_ == nullptr ? 18 : this->rx_pin_->get_pin();
+      int8_t tx = this->tx_pin_ == nullptr ? 17 : this->tx_pin_->get_pin();
+
       this->engine = &HoermannGarageEngine::getInstance();
-      this->engine->setup();
+      this->engine->setup(rx, tx);
     }
 
     void HCPBridge::update() {

components/hcpbridge/hcpbridge.h

@@ -2,6 +2,8 @@
 
 #include "esphome/core/component.h"
 #include "esphome/components/binary_sensor/binary_sensor.h"
+#include "esphome/core/defines.h"
+#include "esphome/core/hal.h"
 
 #include "hoermann.h"
 
@@ -17,11 +19,16 @@ namespace esphome
         void update() override;
 
         void set_is_connected(binary_sensor::BinarySensor *is_connected) { this->is_connected_ = is_connected; }
+        void set_tx_pin(InternalGPIOPin *tx_pin) { this->tx_pin_ = tx_pin; }
+        void set_rx_pin(InternalGPIOPin *rx_pin) { this->rx_pin_ = rx_pin; }
+
 
         HoermannGarageEngine* engine;
 
       protected:
         binary_sensor::BinarySensor *is_connected_;
+        InternalGPIOPin *tx_pin_;
+        InternalGPIOPin *rx_pin_;
     };
   }
 }

components/hcpbridge/hoermann.cpp

@@ -36,9 +36,9 @@ HoermannGarageEngine &HoermannGarageEngine::getInstance()
   return instance;
 }
 
-void HoermannGarageEngine::setup()
+void HoermannGarageEngine::setup(int8_t rx, int8_t tx)
 {
-  RS485.begin(57600, SERIAL_8E1, PIN_RXD, PIN_TXD);
+  RS485.begin(57600, SERIAL_8E1, rx, tx);
   mb.begin(&RS485);
   mb.slave(SLAVE_ID);
 

components/hcpbridge/hoermann.h

@@ -19,7 +19,7 @@
 #define PIN_RXD 18
 #else
 #define PIN_TXD 17 // UART 2 TXT - G17
-#define PIN_RXD 16 // UART 2 RXD - G16
+#define PIN_RXD 16 // UART 2 RXD - G16 
 #endif
 
 // workaround as my Supramatic did not Report the Status 0x0A when it's en vent Position
@@ -108,7 +108,7 @@ class HoermannGarageEngine
 
     static HoermannGarageEngine& getInstance();
 
-    void setup();
+    void setup(int8_t rx, int8_t tx);
     void handleModbus();
     Modbus::ResultCode onRequest(Modbus::FunctionCode fc, const Modbus::RequestData data);
     void setCommandValuesToRead();

example_hcpbridge.yaml

@@ -12,6 +12,7 @@ esphome:
 
 external_components:
     source: github://mapero/esphome-hcpbridge
+    refresh: 0s
 
 esp32:
   board: adafruit_feather_esp32s3
@@ -21,6 +22,8 @@ esp32:
 hcpbridge:
   is_connected:
     name: "HCPBridge Connected"
+  rx_pin: 18 # optional, default=18
+  tx_pin: 17 # optional, default=17
 
 cover:
   - platform: hcpbridge
@@ -31,6 +34,8 @@ switch:
     name: Garage Light
 
 api:
+  encryption:
+    key: !secret api_key
 
 web_server:
   port: 80

secrets.yaml.example

@@ -1,2 +1,3 @@
 wifi_ssid: "<your wifi ssid>"
 wifi_password: "<your wifi password>"
+api_key: "<your key>"