Merge branch 'feature/services'

.vscode/settings.json

@@ -36,6 +36,30 @@
     "xstring": "cpp",
     "xtr1common": "cpp",
     "xutility": "cpp",
-    "xlocbuf": "cpp"
+    "xlocbuf": "cpp",
+    "array": "cpp",
+    "clocale": "cpp",
+    "deque": "cpp",
+    "ios": "cpp",
+    "istream": "cpp",
+    "iterator": "cpp",
+    "locale": "cpp",
+    "map": "cpp",
+    "ostream": "cpp",
+    "queue": "cpp",
+    "regex": "cpp",
+    "set": "cpp",
+    "stdexcept": "cpp",
+    "streambuf": "cpp",
+    "system_error": "cpp",
+    "xfacet": "cpp",
+    "xiosbase": "cpp",
+    "xlocale": "cpp",
+    "xlocinfo": "cpp",
+    "xlocmes": "cpp",
+    "xlocmon": "cpp",
+    "xlocnum": "cpp",
+    "xloctime": "cpp",
+    "xtree": "cpp"
   }
 }

README.md

@@ -9,6 +9,8 @@ This is a esphome-based adaption of the HCPBridge. Credits for the initial devel
 
 ## Usage
 
+### Example esphome configuration
+
 ```
 esphome:
   name: hcpbridge
@@ -31,6 +33,8 @@ esp32:
     type: arduino
 
 hcpbridge:
+  is_connected:
+    name: "HCPBridge Connected"
 
 cover:
   - platform: hcpbridge
@@ -59,6 +63,27 @@ ota:
   safe_mode: true
 ```
 
+### Home Assistant
+
+![Home Assistant Device Overview](docs/device_overview.png)
+
+### Cover
+
+The component provides a cover component to control the garage door.
+
+### Switch
+
+The component provides a switch component to turn the light off and on.
+
+### Services
+
+Additionally, when using the cover component, you can use the following services:
+
+- `esphome.hcpbridge_go_to_close`: To close the garage door
+- `esphome.hcpbridge_go_to_half`: To move the garage door to half position
+- `esphome.hcpbridge_go_to_vent`: To move the garage door to the vent position
+- `esphome.hcpbridge_go_to_open`: To open the garage door
+
 # Project
 
 - HCPBridge from `Tysonpower` on an `Hörmann Promatic 4`
@@ -70,6 +95,7 @@ You can find more information on the project here: [Hörmann garage door via MQT
 - [x] Initial working version
 - [ ] 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 ...)
 
 # Contribute

components/hcpbridge/__init__.py

@@ -1,10 +1,16 @@
 
 import esphome.codegen as cg
 import esphome.config_validation as cv
+from esphome.components import binary_sensor
 from esphome.const import (
     CONF_ID,
+    DEVICE_CLASS_CONNECTIVITY,
 )
 
+AUTO_LOAD = ["binary_sensor"]
+
+CONF_IS_CONNECTED = "is_connected"
+
 hcpbridge_ns = cg.esphome_ns.namespace("hcpbridge")
 HCPBridge = hcpbridge_ns.class_("HCPBridge", cg.Component)
 
@@ -13,9 +19,16 @@
 CONFIG_SCHEMA = (
   cv.Schema({
     cv.GenerateID(): cv.declare_id(HCPBridge),
+    cv.Required(CONF_IS_CONNECTED): binary_sensor.binary_sensor_schema(
+                device_class=DEVICE_CLASS_CONNECTIVITY,
+            ),
   })
 )
 
 async def to_code(config):
   var = cg.new_Pvariable(config[CONF_ID])
-  await cg.register_component(var, config)
+  await cg.register_component(var, 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))

components/hcpbridge/cover/hcpbridge_cover.cpp

@@ -6,6 +6,38 @@ namespace esphome
   {
     static const char *const TAG = "hcpbridge.cover";
 
+    void HCPBridgeCover::setup()
+    {
+      register_service(&HCPBridgeCover::on_go_to_open, "go_to_open");
+      register_service(&HCPBridgeCover::on_go_to_close, "go_to_close");
+      register_service(&HCPBridgeCover::on_go_to_half, "go_to_half");
+      register_service(&HCPBridgeCover::on_go_to_vent, "go_to_vent");
+    }
+
+    void HCPBridgeCover::on_go_to_open()
+    {
+      ESP_LOGD(TAG, "HCPBridgeCover::on_go_to_open() - opening");
+      this->parent_->engine->openDoor();
+    }
+
+    void HCPBridgeCover::on_go_to_close()
+    {
+      ESP_LOGD(TAG, "HCPBridgeCover::on_go_to_close() - closing");
+      this->parent_->engine->closeDoor();
+    }
+
+    void HCPBridgeCover::on_go_to_half()
+    {
+      ESP_LOGD(TAG, "HCPBridgeCover::on_go_to_half() - half opening");
+      this->parent_->engine->halfPositionDoor();
+    }
+
+    void HCPBridgeCover::on_go_to_vent()
+    {
+      ESP_LOGD(TAG, "HCPBridgeCover::on_go_to_vent() - venting");
+      this->parent_->engine->ventilationPositionDoor();
+    }
+
     cover::CoverTraits HCPBridgeCover::get_traits()
     {
       auto traits = cover::CoverTraits();
@@ -31,7 +63,8 @@ namespace esphome
         {
           this->parent_->engine->closeDoor();
         }
-        else {
+        else
+        {
           this->parent_->engine->setPosition((int)call.get_position().value() * 100.0f);
         }
       }
@@ -41,34 +74,36 @@ namespace esphome
     {
       if (!this->parent_->engine->state->valid)
       {
-        ESP_LOGD(TAG, "HCPBridgeCover::update() - state is invalid");
-        this->status_set_warning();
+        if (!this->status_has_warning())
+        {
+          ESP_LOGD(TAG, "HCPBridgeCover::update() - state is invalid");
+          this->status_set_warning();
+        }
         return;
       }
-      ESP_LOGD(TAG, "HCPBridgeCover::update() - state is valid");
       if (this->status_has_warning())
       {
         ESP_LOGD(TAG, "HCPBridgeCover::update() - clearing warning");
         this->status_clear_warning();
       }
 
-      switch (this->parent_->engine->state->state) 
+      switch (this->parent_->engine->state->state)
       {
-        case HoermannState::OPENING:
-        case HoermannState::MOVE_VENTING:
-        case HoermannState::MOVE_HALF:
-          this->current_operation = cover::COVER_OPERATION_OPENING;
-          break;
-        case HoermannState::CLOSING:
-          this->current_operation = cover::COVER_OPERATION_CLOSING;
-          break;
-        case HoermannState::OPEN:
-        case HoermannState::CLOSED:
-        case HoermannState::STOPPED:
-        case HoermannState::HALFOPEN:
-        case HoermannState::VENT:
-          this->current_operation = cover::COVER_OPERATION_IDLE;
-          break;
+      case HoermannState::OPENING:
+      case HoermannState::MOVE_VENTING:
+      case HoermannState::MOVE_HALF:
+        this->current_operation = cover::COVER_OPERATION_OPENING;
+        break;
+      case HoermannState::CLOSING:
+        this->current_operation = cover::COVER_OPERATION_CLOSING;
+        break;
+      case HoermannState::OPEN:
+      case HoermannState::CLOSED:
+      case HoermannState::STOPPED:
+      case HoermannState::HALFOPEN:
+      case HoermannState::VENT:
+        this->current_operation = cover::COVER_OPERATION_IDLE;
+        break;
       }
       this->position = this->parent_->engine->state->currentPosition;
       if (this->previousPosition_ != this->position || this->previousOperation_ != this->current_operation)

components/hcpbridge/cover/hcpbridge_cover.h

@@ -2,24 +2,32 @@
 
 #include "esphome/core/component.h"
 #include "esphome/components/cover/cover.h"
+#include "esphome/components/api/custom_api_device.h"
 #include "../hcpbridge.h"
 
 namespace esphome
 {
   namespace hcpbridge
   {
-    class HCPBridgeCover : public cover::Cover, public PollingComponent
+    class HCPBridgeCover : public cover::Cover, public PollingComponent, public api::CustomAPIDevice
     {
-      public:
-        cover::CoverTraits get_traits() override;
-        void control(const cover::CoverCall &call) override;
-        void set_hcpbridge_parent(HCPBridge *parent) { this->parent_ = parent; }
-        void update() override;
+    public:
+      cover::CoverTraits get_traits() override;
+      void control(const cover::CoverCall &call) override;
+      void set_hcpbridge_parent(HCPBridge *parent) { this->parent_ = parent; }
+      void update() override;
+      void setup() override;
 
-      private:
-        HCPBridge *parent_;
-        float previousPosition_ = 0.0f;
-        cover::CoverOperation previousOperation_ = cover::COVER_OPERATION_IDLE;
+      // Home Assistant service handler
+      void on_go_to_half();
+      void on_go_to_open();
+      void on_go_to_close();
+      void on_go_to_vent();
+
+    private:
+      HCPBridge *parent_;
+      float previousPosition_ = 0.0f;
+      cover::CoverOperation previousOperation_ = cover::COVER_OPERATION_IDLE;
     };
   }
 }

components/hcpbridge/hcpbridge.cpp

@@ -7,9 +7,22 @@ namespace esphome
 
     void HCPBridge::setup()
     {
+      this->is_connected_->publish_state(false);
       this->engine = &HoermannGarageEngine::getInstance();
       this->engine->setup();
     }
 
+    void HCPBridge::update() {
+      if (this->engine->state->valid) {
+        if (this->is_connected_->state != true) {
+          this->is_connected_->publish_state(true);
+        }
+      } else {
+        if (this->is_connected_->state != false) {
+          this->is_connected_->publish_state(false);
+        }
+      }
+    }
+
   }
 }

components/hcpbridge/hcpbridge.h

@@ -1,19 +1,27 @@
 #pragma once
 
 #include "esphome/core/component.h"
+#include "esphome/components/binary_sensor/binary_sensor.h"
+
 #include "hoermann.h"
 
 namespace esphome
 {
   namespace hcpbridge
   {
 
-    class HCPBridge : public Component
+    class HCPBridge : public PollingComponent
     {
       public:
         void setup() override;
+        void update() override;
+
+        void set_is_connected(binary_sensor::BinarySensor *is_connected) { this->is_connected_ = is_connected; }
+
         HoermannGarageEngine* engine;
-    };
 
+      protected:
+        binary_sensor::BinarySensor *is_connected_;
+    };
   }
 }

components/hcpbridge/switch/hcpbridge_switch.cpp

@@ -23,12 +23,11 @@ namespace esphome
         ESP_LOGD(TAG, "HCPBridgeSwitch::update() - clearing warning");
         this->status_clear_warning();
       }
-      this->state = this->parent_->engine->state->lightOn;
-      if (this->previousState_ != this->state)
+      if (this->previousState_ != this->parent_->engine->state->lightOn)
       {
         ESP_LOGD(TAG, "HCPBridgeSwitch::update() - state changed");
-        this->publish_state(false);
-        this->previousState_ = this->state;
+        this->publish_state(this->parent_->engine->state->lightOn);
+        this->previousState_ = this->parent_->engine->state->lightOn;
       }
     }
 

example_hcpbridge.yaml

@@ -19,6 +19,8 @@ esp32:
     type: arduino
 
 hcpbridge:
+  is_connected:
+    name: "HCPBridge Connected"
 
 cover:
   - platform: hcpbridge