Merge pull request #4 from distante/saninn/refactor-ventilation-controller-to-not-track-single-tasks

Saninn/refactor ventilation controller to not track single tasks

Author: distante

components/sec_touch/_definitions.h

@@ -10,11 +10,11 @@
 namespace esphome {
 namespace sec_touch {
 
-#define STX 0x02
-#define ETX 0x0A
-#define ACK 0x06
-#define NAK 0x15
-#define TAB 0x09
+#define STX 0x02    // Start of Text
+#define ETX 0x0A    // End of Text
+#define ACK 0x06    // Acknowledge
+#define NAK 0x15    // Not Acknowledge
+#define TAB 0x09    // Tab
 #define NOISE 0xFF  // 255
 
 constexpr const int COMMANDID_SET = 32;
@@ -111,17 +111,14 @@ template<typename T, size_t N> static bool contains(const std::array<T, N> &arr,
  */
 enum class TaskTargetType { LEVEL, LABEL };
 enum class TaskType {
-  MANUAL_SET,
-  AUTO_GET,
-  MANUAL_GET,
+  SET_DATA,
+  GET_DATA,
   /**
    * Used to indicate that no task is currently being processed
    */
   NONE
 };
 
-enum class TaskState { TO_BE_SENT, TO_BE_PROCESSED };
-
 class EnumToString {
  private:
   EnumToString() = default;
@@ -138,25 +135,12 @@ class EnumToString {
     }
   }
 
-  static const char *TaskState(TaskState v) {
-    switch (v) {
-      case TaskState::TO_BE_SENT:
-        return "TO_BE_SENT";
-
-      case TaskState::TO_BE_PROCESSED:
-        return "TO_BE_PROCESSED";
-      default:
-        return "UNKNOWN";
-    }
-  }
   static const char *TaskType(TaskType v) {
     switch (v) {
-      case TaskType::MANUAL_SET:
-        return "MANUAL_SET";
-      case TaskType::AUTO_GET:
-        return "AUTO_GET";
-      case TaskType::MANUAL_GET:
-        return "MANUAL_GET";
+      case TaskType::SET_DATA:
+        return "SET_DATA";
+      case TaskType::GET_DATA:
+        return "GET_DATA";
       case TaskType::NONE:
         return "NONE";
       default:
@@ -221,13 +205,15 @@ struct IncomingMessage {
   }
 };
 
-struct SetDataTask {
+struct BaseTask {
+  virtual ~BaseTask() = default;
+  virtual TaskType get_task_type() const = 0;
   TaskTargetType targetType;
   int property_id;
-  char value[8];
-  TaskState state = TaskState::TO_BE_SENT;
+};
 
-  const TaskType taskType = TaskType::MANUAL_SET;
+struct SetDataTask : public BaseTask {
+  char value[8];
 
   static std::unique_ptr<SetDataTask> create(TaskTargetType targetType, int property_id, const char *value) {
     if ((targetType == TaskTargetType::LEVEL && contains(FAN_LEVEL_IDS, property_id)) ||
@@ -237,20 +223,18 @@ struct SetDataTask {
     return nullptr;  // Null unique_ptr if validation fails
   }
 
+  TaskType get_task_type() const override { return TaskType::SET_DATA; }
+
  private:
-  SetDataTask(TaskTargetType targetType, int property_id, const char *value)
-      : targetType(targetType), property_id(property_id) {
+  SetDataTask(TaskTargetType targetType, int property_id, const char *value) {
+    this->targetType = targetType;
+    this->property_id = property_id;
     std::strncpy(this->value, value, sizeof(this->value) - 1);
     this->value[sizeof(this->value) - 1] = '\0';  // Ensure null termination
   }
 };
 
-struct GetDataTask {
-  TaskTargetType targetType;
-  int property_id;
-  TaskState state = TaskState::TO_BE_SENT;
-  const TaskType taskType = TaskType::AUTO_GET;
-
+struct GetDataTask : public BaseTask {
   static std::unique_ptr<GetDataTask> create(TaskTargetType targetType, int property_id) {
     if ((targetType == TaskTargetType::LEVEL && contains(FAN_LEVEL_IDS, property_id)) ||
         (targetType == TaskTargetType::LABEL && contains(FAN_LABEL_IDS, property_id))) {
@@ -259,8 +243,13 @@ struct GetDataTask {
     return nullptr;  // Null unique_ptr if validation fails
   }
 
+  TaskType get_task_type() const override { return TaskType::GET_DATA; }
+
  private:
-  GetDataTask(TaskTargetType targetType, int property_id) : targetType(targetType), property_id(property_id) {}
+  GetDataTask(TaskTargetType targetType, int property_id) {
+    this->targetType = targetType;
+    this->property_id = property_id;
+  }
 };
 
 }  // namespace sec_touch

components/sec_touch/button/program_text_update_button.cpp

@@ -3,7 +3,7 @@
 namespace esphome {
 namespace sec_touch {
 
-void ProgramTextUpdateButton::press_action() { this->parent_->add_manual_tasks_to_get_queue(); }
+void ProgramTextUpdateButton::press_action() { this->parent_->add_manual_tasks_to_queue(); }
 
 }  // namespace sec_touch
 }  // namespace esphome

components/sec_touch/fan/sec_touch_fan.cpp

@@ -56,7 +56,7 @@ SecTouchFan::SecTouchFan(SECTouchComponent *parent, int level_id, int label_id)
 
     const std::string &current_label = label_text_sensor->get_state();  // Get the current state of the text sensor
     if (current_label == new_label) {
-      ESP_LOGD(TAG, "Label is already up-to-date: %s", current_label);
+      ESP_LOGD(TAG, "Label is already up-to-date: %s", current_label.c_str());
       return;  // Do not publish if the value is the same
     }
 
@@ -209,8 +209,8 @@ void SecTouchFan::update_label_mode() {
 }
 
 // Print method for debugging
-void SecTouchFan::printConfig() {
-  ESP_LOGCONFIG(TAG, "Level ID: %d, Label ID: %d, Fan Level Value: %d", this->level_id, this->label_id, this->speed);
+void SecTouchFan::dump_config() {
+  ESP_LOGCONFIG(TAG, "Level ID: %d, Label ID: %d, Current Fan Level: %d", this->level_id, this->label_id, this->speed);
 }
 
 }  // namespace sec_touch

components/sec_touch/fan/sec_touch_fan.h

@@ -41,7 +41,7 @@ class SecTouchFan : public Component, public fan::Fan {
   fan::FanTraits get_traits() override { return this->traits_; }
 
   // Print method for debugging
-  void printConfig();
+  void dump_config() override;
 };
 
 }  // namespace sec_touch

components/sec_touch/readme.md

@@ -493,8 +493,8 @@ where:
 - `32` is the command id for a SET request.
 - `173` is the property id of the fan pair.
 - `5` is the value assigned to that id.
-- `42625` is the checksum.
-- 
+- `42625` is the checksum (probably).
+
 ### SET Response Message
 Sadly (IMHO) the SEC-TOUCH just sends an `ACK` message after receiving a SET message and sometimes it takes a couple of seconds for the SEC-TOUCH screen to update the new value, so the best we can do is to wait for the `ACK` message and then send a `GET` message to do a security sync of the new value.
 
@@ -504,11 +504,7 @@ Byte received: 6   // ACK 0x06
 Byte received: 10  // ETX 0x0A
 ```
 
-
-
-
-
-### Update submodules
+# Update submodules
 ```
 git submodule update --remote --merge
 ```