feat: entities now inherit a common HAPEntity

a first attempt to a more cohesive entity implementation

Author: rednblkx

components/homekit/climate.hpp

@@ -7,15 +7,18 @@
 #include <hap_apple_servs.h>
 #include <hap_apple_chars.h>
 #include "const.h"
+#include "hap_entity.h"
+
 namespace esphome
 {
   namespace homekit
   {
-    class ClimateEntity
+    class ClimateEntity : public HAPEntity
     {
     private:
       static constexpr const char* TAG = "ClimateEntity";
-      void on_climate_update(climate::Climate& obj) {
+      climate::Climate* climatePtr;
+      static void on_climate_update(climate::Climate& obj) {
         ESP_LOGI(TAG, "%s Mode: %d Action: %d CTemp: %.2f TTemp: %.2f CHum: %.2f THum: %.2f", obj.get_name().c_str(), obj.mode, obj.action, obj.current_temperature, obj.target_temperature, obj.current_humidity, obj.target_humidity);
         hap_acc_t* acc = hap_acc_get_by_aid(hap_get_unique_aid(std::to_string(obj.get_object_id_hash()).c_str()));
         if (acc) {
@@ -122,8 +125,8 @@ namespace esphome
         return HAP_SUCCESS;
       }
     public:
-      ClimateEntity() {}
-      void setup(climate::Climate* climatePtr, TemperatureUnits units = CELSIUS) {
+      ClimateEntity(climate::Climate* climatePtr) : HAPEntity({{MODEL, "HAP-CLIMATE"}}), climatePtr(climatePtr) {}
+      void setup(TemperatureUnits units = CELSIUS) {
         hap_acc_cfg_t acc_cfg = {
             .model = "ESP-CLIMATE",
             .manufacturer = "rednblkx",
@@ -136,12 +139,12 @@ namespace esphome
         hap_acc_t* accessory = nullptr;
         hap_serv_t* service = nullptr;
         hap_serv_t* service_fan = nullptr;
-        std::string accessory_name = climatePtr->get_name();
+        std::string accessory_name = this->climatePtr->get_name();
         acc_cfg.name = accessory_name.data();
-        acc_cfg.serial_num = std::to_string(climatePtr->get_object_id_hash()).data();
-        climate::ClimateTraits climateTraits = climatePtr->get_traits();
-        climate::ClimateMode climateMode = climatePtr->mode;
-        climate::ClimateAction climateAction = climatePtr->action;
+        acc_cfg.serial_num = std::to_string(this->climatePtr->get_object_id_hash()).data();
+        climate::ClimateTraits climateTraits = this->climatePtr->get_traits();
+        climate::ClimateMode climateMode = this->climatePtr->mode;
+        climate::ClimateAction climateAction = this->climatePtr->action;
         uint8_t current_mode = 0;
         uint8_t target_mode = 0;
         switch (climateAction) {
@@ -181,22 +184,22 @@ namespace esphome
         default:
           break;
         }
-        ESP_LOGI(TAG, "CTemp: %.2f TTemp: %.2f CHum: %.2f THum: %.2f", climatePtr->current_temperature, climatePtr->target_temperature, climatePtr->current_humidity, climatePtr->target_humidity);
-        service = hap_serv_thermostat_create(current_mode, target_mode, climatePtr->current_temperature, climatePtr->target_temperature, units);
+        ESP_LOGI(TAG, "CTemp: %.2f TTemp: %.2f CHum: %.2f THum: %.2f", this->climatePtr->current_temperature, this->climatePtr->target_temperature, this->climatePtr->current_humidity, this->climatePtr->target_humidity);
+        service = hap_serv_thermostat_create(current_mode, target_mode, this->climatePtr->current_temperature, this->climatePtr->target_temperature, units);
         if (climateTraits.get_supports_current_humidity()) {
-          hap_serv_add_char(service, hap_char_current_relative_humidity_create(climatePtr->current_humidity));
+          hap_serv_add_char(service, hap_char_current_relative_humidity_create(this->climatePtr->current_humidity));
         }
         if (climateTraits.get_supports_target_humidity()) {
-          hap_serv_add_char(service, hap_char_target_relative_humidity_create(climatePtr->target_humidity));
+          hap_serv_add_char(service, hap_char_target_relative_humidity_create(this->climatePtr->target_humidity));
         }
-        // service_fan = hap_serv_fan_v2_create(!climatePtr->fan_mode ? 1 : 0);
+        // service_fan = hap_serv_fan_v2_create(!this->climatePtr->fan_mode ? 1 : 0);
         // hap_char_swing_mode_create();
         // hap_serv_link_serv()
         if (service) {
           /* Create accessory object */
           accessory = hap_acc_create(&acc_cfg);
-          ESP_LOGI(TAG, "ID HASH: %lu", climatePtr->get_object_id_hash());
-          hap_serv_set_priv(service, strdup(std::to_string(climatePtr->get_object_id_hash()).c_str()));
+          ESP_LOGI(TAG, "ID HASH: %lu", this->climatePtr->get_object_id_hash());
+          hap_serv_set_priv(service, strdup(std::to_string(this->climatePtr->get_object_id_hash()).c_str()));
 
           /* Set the write callback for the service */
           hap_serv_set_write_cb(service, climate_write);
@@ -207,7 +210,7 @@ namespace esphome
 
 
           /* Add the Accessory to the HomeKit Database */
-          hap_add_bridged_accessory(accessory, hap_get_unique_aid(std::to_string(climatePtr->get_object_id_hash()).c_str()));
+          hap_add_bridged_accessory(accessory, hap_get_unique_aid(std::to_string(this->climatePtr->get_object_id_hash()).c_str()));
         }
       }
     };

components/homekit/fan.hpp

@@ -5,17 +5,16 @@
 #include <hap.h>
 #include <hap_apple_servs.h>
 #include <hap_apple_chars.h>
-#include <map>
+#include "hap_entity.h"
 
 namespace esphome
 {
   namespace homekit
   {
-    class FanEntity
+    class FanEntity : public HAPEntity
     {
     private:
       static constexpr const char* TAG = "FanEntity";
-      std::map<AInfo, const char*> accessory_info = {{NAME, NULL}, {MODEL, "HAP-FAN"}, {SN, NULL}, {MANUFACTURER, "rednblkx"}, {FW_REV, "0.1"}};
       fan::Fan* fanPtr;
       static int fanwrite(hap_write_data_t write_data[], int count, void* serv_priv, void* write_priv) {
         fan::Fan* fanPtr = (fan::Fan*)serv_priv;
@@ -37,7 +36,7 @@ namespace esphome
         }
         return ret;
       }
-      void on_fanupdate(fan::Fan* obj) {
+      static void on_fanupdate(fan::Fan* obj) {
         ESP_LOGD(TAG, "%s state: %s", obj->get_name().c_str(), ONOFF(obj->state));
         hap_acc_t* acc = hap_acc_get_by_aid(hap_get_unique_aid(std::to_string(obj->get_object_id_hash()).c_str()));
         if (acc) {
@@ -53,13 +52,7 @@ namespace esphome
         return HAP_SUCCESS;
       }
     public:
-      FanEntity(fan::Fan* fanPtr) : fanPtr(fanPtr) {}
-      void setInfo(std::map<AInfo, const char*> info) {
-        std::map<AInfo, const char*> merged_info;
-        merged_info.merge(info);
-        merged_info.merge(this->accessory_info);
-        this->accessory_info.swap(merged_info);
-      }
+      FanEntity(fan::Fan* fanPtr) : HAPEntity({{MODEL, "HAP-FAN"}}), fanPtr(fanPtr) {}
       void setup() {
         hap_acc_cfg_t acc_cfg = {
             .model = strdup(accessory_info[MODEL]),
@@ -102,7 +95,7 @@ namespace esphome
         /* Add the Accessory to the HomeKit Database */
         hap_add_bridged_accessory(accessory, hap_get_unique_aid(std::to_string(fanPtr->get_object_id_hash()).c_str()));
         if (!fanPtr->is_internal())
-          fanPtr->add_on_state_callback([this]() { this->on_fanupdate(fanPtr); });
+          fanPtr->add_on_state_callback([this]() { FanEntity::on_fanupdate(fanPtr); });
         ESP_LOGI(TAG, "Fan '%s' linked to HomeKit", accessory_name.c_str());
       }
     };

components/homekit/hap_entity.h

@@ -0,0 +1,30 @@
+#pragma once
+#include "const.h"
+#include "esphome/core/entity_base.h"
+#include <esp_log.h>
+#include <map>
+
+namespace esphome
+{
+  namespace homekit
+  {
+    class HAPEntity
+    {
+    private:
+      static constexpr const char* TAG = "HAPEntity";
+    protected:
+      std::map<AInfo, const char*> accessory_info = { {NAME, NULL}, {MODEL, "HAP-GENERIC"}, {SN, NULL}, {MANUFACTURER, "rednblkx"}, {FW_REV, "0.1"} };
+    public:
+      HAPEntity(){ }
+      HAPEntity(std::map<AInfo, const char*> accessory_info) { setInfo(accessory_info); }
+      void setInfo(std::map<AInfo, const char*> info) {
+        for (const auto& pair : info) {
+          if (this->accessory_info.find(pair.first) != this->accessory_info.end()) {
+            this->accessory_info[pair.first] = pair.second;
+          }
+        }
+      }
+      void virtual setup() { ESP_LOGI(TAG, "Uninmplemented!"); }
+    };
+  }
+}

components/homekit/light.hpp

@@ -5,17 +5,16 @@
 #include <hap.h>
 #include <hap_apple_servs.h>
 #include <hap_apple_chars.h>
-#include <map>
+#include "hap_entity.h"
 
 namespace esphome
 {
   namespace homekit
   {
-    class LightEntity
+    class LightEntity : public HAPEntity
     {
     private:
       static constexpr const char* TAG = "LightEntity";
-      std::map<AInfo, const char*> accessory_info = {{NAME, NULL}, {MODEL, "HAP-LIGHT"}, {SN, NULL}, {MANUFACTURER, "rednblkx"}, {FW_REV, "0.1"}};
       light::LightState* lightPtr;
       static int light_write(hap_write_data_t write_data[], int count, void* serv_priv, void* write_priv) {
         light::LightState* lightPtr = (light::LightState*)serv_priv;
@@ -87,7 +86,7 @@ namespace esphome
         }
         return ret;
       }
-      void on_light_update(light::LightState* obj) {
+      static void on_light_update(light::LightState* obj) {
         bool rgb = obj->current_values.get_color_mode() & light::ColorCapability::RGB;
         bool level = obj->get_traits().supports_color_capability(light::ColorCapability::BRIGHTNESS);
         bool temperature = obj->current_values.get_color_mode() & (light::ColorCapability::COLOR_TEMPERATURE | light::ColorCapability::COLD_WARM_WHITE);
@@ -135,13 +134,7 @@ namespace esphome
         return HAP_SUCCESS;
       }
     public:
-      LightEntity(light::LightState* lightPtr) : lightPtr(lightPtr) {}
-      void setInfo(std::map<AInfo, const char*> info) {
-        std::map<AInfo, const char*> merged_info;
-        merged_info.merge(info);
-        merged_info.merge(this->accessory_info);
-        this->accessory_info.swap(merged_info);
-      }
+      LightEntity(light::LightState* lightPtr) : HAPEntity({{MODEL, "HAP-LIGHT"}}), lightPtr(lightPtr) {}
       void setup() {
         hap_acc_cfg_t acc_cfg = {
             .model = strdup(accessory_info[MODEL]),
@@ -197,7 +190,7 @@ namespace esphome
         /* Add the Accessory to the HomeKit Database */
         hap_add_bridged_accessory(accessory, hap_get_unique_aid(std::to_string(lightPtr->get_object_id_hash()).c_str()));
         if (!lightPtr->is_internal())
-          lightPtr->add_new_target_state_reached_callback([this]() { this->on_light_update(lightPtr); });
+          lightPtr->add_new_target_state_reached_callback([this]() { LightEntity::on_light_update(lightPtr); });
 
         ESP_LOGI(TAG, "Light '%s' linked to HomeKit", accessory_name.c_str());
       }