Add hvac_action support

Author: Drafteed

README.rst

@@ -116,9 +116,10 @@ Configuration variables:
 - **alternative_swing_control** (*Optional*, boolean): (supported by smartAir2 only) If ``true`` - use alternative values to control swing mode. Use only if the original control method is not working for your AC.
 - **status_message_header_size** (*Optional*, int): (supported only by hOn) Define the header size of the status message. Can be used to handle some protocol variations. Use only if you are sure what you are doing. The default value: ``0``.
 - **control_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the control packet. Can help with some newer models of ACs that use bigger packets. The default value: ``10``.
-- **sensors_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the sensor packet of the status message. Can help with some models of ACs that have bigger sensor packet. The default value: ``22``, minimum value: ``18``.
-- **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: ``MONITOR_ONLY`` - no control, just monitor status, ``SET_GROUP_PARAMETERS`` - set all AC parameters with one command (default method), ``SET_SINGLE_PARAMETER`` - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
-- **display** (*Optional*, boolean): Can be used to set the AC display off.
+- **sensors_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the sensor packet of the status message. Can help with some models of ACs that have bigger sensor packet. The default value: ``22``, minimum value: ``18``.
+- **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: ``MONITOR_ONLY`` - no control, just monitor status, ``SET_GROUP_PARAMETERS`` - set all AC parameters with one command (default method), ``SET_SINGLE_PARAMETER`` - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
+- **hvac_action** (*Optional*, boolean): (supported only by hOn) If ``true`` - expose the current HVAC action.
+- **display** (*Optional*, boolean): Can be used to set the AC display off.
 - **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
 - **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: ``'OFF'``, ``HEAT_COOL``, ``COOL``, ``HEAT``, ``DRY``, ``FAN_ONLY``.
 - **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: ``'OFF'``, ``VERTICAL``, ``HORIZONTAL``, ``BOTH``.

components/haier/climate.py

@@ -46,6 +46,7 @@
 CONF_CONTROL_METHOD = "control_method"
 CONF_CONTROL_PACKET_SIZE = "control_packet_size"
 CONF_HORIZONTAL_AIRFLOW = "horizontal_airflow"
+CONF_HVAC_ACTION = "hvac_action"
 CONF_ON_ALARM_START = "on_alarm_start"
 CONF_ON_ALARM_END = "on_alarm_end"
 CONF_ON_STATUS_MESSAGE = "on_status_message"
@@ -231,6 +232,7 @@ def _base_config_schema(class_: MockObjClass) -> cv.Schema:
                         CONF_STATUS_MESSAGE_HEADER_SIZE,
                         default=PROTOCOL_STATUS_MESSAGE_HEADER_SIZE,
                     ): cv.int_range(min=PROTOCOL_STATUS_MESSAGE_HEADER_SIZE),
+                    cv.Optional(CONF_HVAC_ACTION, default=False): cv.boolean,
                     cv.Optional(
                         CONF_SUPPORTED_PRESETS,
                         default=["BOOST", "SLEEP"],  # No AWAY by default
@@ -483,6 +485,8 @@ async def to_code(config):
     cg.add(var.set_send_wifi(config[CONF_WIFI_SIGNAL]))
     if CONF_CONTROL_METHOD in config:
         cg.add(var.set_control_method(config[CONF_CONTROL_METHOD]))
+    if CONF_HVAC_ACTION in config:
+        cg.add(var.set_hvac_action(config[CONF_HVAC_ACTION]))
     if CONF_BEEPER in config:
         cg.add(var.set_beeper_state(config[CONF_BEEPER]))
     if CONF_DISPLAY in config:

components/haier/hon_climate.cpp

@@ -58,6 +58,13 @@ HonClimate::HonClimate()
 
 HonClimate::~HonClimate() {}
 
+void HonClimate::set_hvac_action(bool state) {
+  this->hvac_action_enabled_ = state;
+  if (state) {
+    this->traits_.add_feature_flags(climate::CLIMATE_SUPPORTS_ACTION);
+  }
+}
+
 void HonClimate::set_beeper_state(bool state) {
   if (state != this->settings_.beeper_state) {
     this->settings_.beeper_state = state;
@@ -970,6 +977,52 @@ void HonClimate::update_horizontal_airflow_select_state_() {
 }
 #endif  // USE_SELECT
 
+bool HonClimate::update_hvac_action_(const hon_protocol::HaierPacketBigData *bd_packet) {
+  if ((this->mode != CLIMATE_MODE_OFF) && (bd_packet == nullptr)) {
+    return false;
+  }
+
+  ClimateAction new_action = CLIMATE_ACTION_OFF;
+  if ((this->mode != CLIMATE_MODE_OFF) && (bd_packet->compressor_status < 2)) {
+    const bool compressor_on = bd_packet->compressor_status == 1;
+
+    switch (this->mode) {
+      case CLIMATE_MODE_COOL:
+        new_action = compressor_on ? CLIMATE_ACTION_COOLING : CLIMATE_ACTION_IDLE;
+        break;
+      case CLIMATE_MODE_DRY:
+        new_action = compressor_on ? CLIMATE_ACTION_DRYING : CLIMATE_ACTION_IDLE;
+        break;
+      case CLIMATE_MODE_HEAT:
+        new_action = (bd_packet->defrost_status == 1) ? CLIMATE_ACTION_DEFROSTING
+                                                      : (compressor_on ? CLIMATE_ACTION_HEATING : CLIMATE_ACTION_IDLE);
+        break;
+      case CLIMATE_MODE_FAN_ONLY:
+        new_action = CLIMATE_ACTION_FAN;
+        break;
+      case CLIMATE_MODE_HEAT_COOL:
+        if (bd_packet->defrost_status == 1) {
+          new_action = CLIMATE_ACTION_DEFROSTING;
+        } else if (!compressor_on) {
+          new_action = CLIMATE_ACTION_IDLE;
+        } else if (bd_packet->indoor_coil_temperature == 0xFF) {
+          new_action = CLIMATE_ACTION_OFF;
+        } else {
+          float indoor_coil_temperature = bd_packet->indoor_coil_temperature / 2.0f - 20.0f;
+          new_action =
+              (this->current_temperature > indoor_coil_temperature) ? CLIMATE_ACTION_COOLING : CLIMATE_ACTION_HEATING;
+        }
+        break;
+      default:
+        break;
+    }
+  }
+
+  bool changed = this->action != new_action;
+  this->action = new_action;
+  return changed;
+}
+
 haier_protocol::HandlerError HonClimate::process_status_message_(const uint8_t *packet_buffer, uint8_t size) {
   size_t expected_size =
       2 + this->status_message_header_size_ + this->real_control_packet_size_ + this->real_sensors_packet_size_;
@@ -978,10 +1031,10 @@ haier_protocol::HandlerError HonClimate::process_status_message_(const uint8_t *
     return haier_protocol::HandlerError::WRONG_MESSAGE_STRUCTURE;
   }
   uint16_t subtype = (((uint16_t) packet_buffer[0]) << 8) + packet_buffer[1];
+  const hon_protocol::HaierPacketBigData *bd_packet = nullptr;
   if ((subtype == 0x7D01) && (size >= expected_size + sizeof(hon_protocol::HaierPacketBigData))) {
     // Got BigData packet
-    const hon_protocol::HaierPacketBigData *bd_packet =
-        (const hon_protocol::HaierPacketBigData *) (&packet_buffer[expected_size]);
+    bd_packet = (const hon_protocol::HaierPacketBigData *) (&packet_buffer[expected_size]);
 #ifdef USE_SENSOR
     this->update_sub_sensor_(SubSensorType::INDOOR_COIL_TEMPERATURE, bd_packet->indoor_coil_temperature / 2.0 - 20);
     this->update_sub_sensor_(SubSensorType::OUTDOOR_COIL_TEMPERATURE, bd_packet->outdoor_coil_temperature - 64);
@@ -1161,6 +1214,9 @@ haier_protocol::HandlerError HonClimate::process_status_message_(const uint8_t *
     }
     should_publish = should_publish || (old_mode != this->mode);
   }
+  if (this->hvac_action_enabled_) {
+    should_publish = this->update_hvac_action_(bd_packet) || should_publish;
+  }
   {
     // Quiet mode, should be after climate mode
     if ((this->mode != CLIMATE_MODE_FAN_ONLY) && (this->mode != CLIMATE_MODE_OFF) &&
@@ -1561,7 +1617,7 @@ void HonClimate::process_protocol_reset() {
 }
 
 bool HonClimate::should_get_big_data_() {
-  if (this->big_data_sensors_ > 0) {
+  if ((this->big_data_sensors_ > 0) || this->hvac_action_enabled_) {
     this->big_data_counter_ = (this->big_data_counter_ + 1) % 3;
     return this->big_data_counter_ == 1;
   }

components/haier/hon_climate.h

@@ -142,6 +142,7 @@ class HonClimate : public HaierClimateBase {
   void set_extra_sensors_packet_bytes_size(size_t size) { this->extra_sensors_packet_bytes_ = size; };
   void set_status_message_header_size(size_t size) { this->status_message_header_size_ = size; };
   void set_control_method(HonControlMethod method) { this->control_method_ = method; };
+  void set_hvac_action(bool state);
   template<typename F> void add_alarm_start_callback(F &&callback) {
     this->alarm_start_callback_.add(std::forward<F>(callback));
   }
@@ -181,6 +182,7 @@ class HonClimate : public HaierClimateBase {
   // Helper functions
   haier_protocol::HandlerError process_status_message_(const uint8_t *packet, uint8_t size);
   void process_alarm_message_(const uint8_t *packet, uint8_t size, bool check_new);
+  bool update_hvac_action_(const hon_protocol::HaierPacketBigData *bd_packet);
   void fill_control_messages_queue_();
   void clear_control_messages_queue_();
 
@@ -212,6 +214,7 @@ class HonClimate : public HaierClimateBase {
   std::chrono::steady_clock::time_point last_alarm_request_;
   int big_data_sensors_{0};
   uint8_t big_data_counter_{0};
+  bool hvac_action_enabled_{false};
   esphome::optional<hon_protocol::VerticalSwingMode> current_vertical_swing_{};
   esphome::optional<hon_protocol::HorizontalSwingMode> current_horizontal_swing_{};
   esphome::optional<std::chrono::steady_clock::time_point> vertical_direction_set_time_{};

docs/esphome-docs/climate/haier.rst

@@ -116,9 +116,10 @@ Configuration variables:
 - **alternative_swing_control** (*Optional*, boolean): (supported by smartAir2 only) If ``true`` - use alternative values to control swing mode. Use only if the original control method is not working for your AC.
 - **status_message_header_size** (*Optional*, int): (supported only by hOn) Define the header size of the status message. Can be used to handle some protocol variations. Use only if you are sure what you are doing. The default value: ``0``.
 - **control_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the control packet. Can help with some newer models of ACs that use bigger packets. The default value: ``10``.
-- **sensors_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the sensor packet of the status message. Can help with some models of ACs that have bigger sensor packet. The default value: ``22``, minimum value: ``18``.
-- **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: ``MONITOR_ONLY`` - no control, just monitor status, ``SET_GROUP_PARAMETERS`` - set all AC parameters with one command (default method), ``SET_SINGLE_PARAMETER`` - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
-- **display** (*Optional*, boolean): Can be used to set the AC display off.
+- **sensors_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the sensor packet of the status message. Can help with some models of ACs that have bigger sensor packet. The default value: ``22``, minimum value: ``18``.
+- **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: ``MONITOR_ONLY`` - no control, just monitor status, ``SET_GROUP_PARAMETERS`` - set all AC parameters with one command (default method), ``SET_SINGLE_PARAMETER`` - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
+- **hvac_action** (*Optional*, boolean): (supported only by hOn) If ``true`` - expose the current HVAC action.
+- **display** (*Optional*, boolean): Can be used to set the AC display off.
 - **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
 - **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: ``'OFF'``, ``HEAT_COOL``, ``COOL``, ``HEAT``, ``DRY``, ``FAN_ONLY``.
 - **supported_swing_modes** (*Optional*, list): Can be used to disable some swing modes if your AC does not support it. Possible values: ``'OFF'``, ``VERTICAL``, ``HORIZONTAL``, ``BOTH``.

docs/examples/climate_haier.rst

@@ -69,6 +69,7 @@ Configuration variables:
 - **control_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the control packet. Can help with some newer models of ACs that use bigger packets. The default value: ``10``.
 - **sensors_packet_size** (*Optional*, int): (supported only by hOn) Define the size of the sensor packet of the status message. Can help with some models of ACs that have bigger sensor packet. The default value: ``22``, minimum value: ``18``.
 - **control_method** (*Optional*, list): (supported only by hOn) Defines control method (should be supported by AC). Supported values: ``MONITOR_ONLY`` - no control, just monitor status, ``SET_GROUP_PARAMETERS`` - set all AC parameters with one command (default method), ``SET_SINGLE_PARAMETER`` - set each parameter individually (this method is supported by some new ceiling ACs like AD71S2SM3FA)
+- **hvac_action** (*Optional*, boolean): (supported only by hOn) If ``true`` - expose the current HVAC action.
 - **display** (*Optional*, boolean): Can be used to set the AC display off.
 - **beeper** (*Optional*, boolean): Can be used to disable beeping on commands from AC. Supported only by hOn protocol.
 - **supported_modes** (*Optional*, list): Can be used to disable some of AC modes. Possible values: ``'OFF'``, ``HEAT_COOL``, ``COOL``, ``HEAT``, ``DRY``, ``FAN_ONLY``.