Add eco mode to tuya climate component (#1860)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

esphome/components/tuya/climate/__init__.py

@@ -23,6 +23,8 @@ CONF_CURRENT_TEMPERATURE_DATAPOINT = "current_temperature_datapoint"
 CONF_TEMPERATURE_MULTIPLIER = "temperature_multiplier"
 CONF_CURRENT_TEMPERATURE_MULTIPLIER = "current_temperature_multiplier"
 CONF_TARGET_TEMPERATURE_MULTIPLIER = "target_temperature_multiplier"
+CONF_ECO_DATAPOINT = "eco_datapoint"
+CONF_ECO_TEMPERATURE = "eco_temperature"
 
 TuyaClimate = tuya_ns.class_("TuyaClimate", climate.Climate, cg.Component)
 
@@ -90,6 +92,14 @@ def validate_active_state_values(value):
     return value
 
 
+def validate_eco_values(value):
+    if CONF_ECO_TEMPERATURE in value and CONF_ECO_DATAPOINT not in value:
+        raise cv.Invalid(
+            f"{CONF_ECO_DATAPOINT} required if using {CONF_ECO_TEMPERATURE}"
+        )
+    return value
+
+
 CONFIG_SCHEMA = cv.All(
     climate.CLIMATE_SCHEMA.extend(
         {
@@ -108,6 +118,8 @@ CONFIG_SCHEMA = cv.All(
             cv.Optional(CONF_TEMPERATURE_MULTIPLIER): cv.positive_float,
             cv.Optional(CONF_CURRENT_TEMPERATURE_MULTIPLIER): cv.positive_float,
             cv.Optional(CONF_TARGET_TEMPERATURE_MULTIPLIER): cv.positive_float,
+            cv.Optional(CONF_ECO_DATAPOINT): cv.uint8_t,
+            cv.Optional(CONF_ECO_TEMPERATURE): cv.temperature,
         }
     ).extend(cv.COMPONENT_SCHEMA),
     cv.has_at_least_one_key(CONF_TARGET_TEMPERATURE_DATAPOINT, CONF_SWITCH_DATAPOINT),
@@ -115,6 +127,7 @@ CONFIG_SCHEMA = cv.All(
     validate_active_state_values,
     cv.has_at_most_one_key(CONF_ACTIVE_STATE_DATAPOINT, CONF_HEATING_STATE_PIN),
     cv.has_at_most_one_key(CONF_ACTIVE_STATE_DATAPOINT, CONF_COOLING_STATE_PIN),
+    validate_eco_values,
 )
 
 
@@ -179,3 +192,7 @@ async def to_code(config):
                 config[CONF_TARGET_TEMPERATURE_MULTIPLIER]
             )
         )
+    if CONF_ECO_DATAPOINT in config:
+        cg.add(var.set_eco_id(config[CONF_ECO_DATAPOINT]))
+        if CONF_ECO_TEMPERATURE in config:
+            cg.add(var.set_eco_temperature(config[CONF_ECO_TEMPERATURE]))

esphome/components/tuya/climate/tuya_climate.cpp

@@ -43,8 +43,9 @@ void TuyaClimate::setup() {
   }
   if (this->target_temperature_id_.has_value()) {
     this->parent_->register_listener(*this->target_temperature_id_, [this](const TuyaDatapoint &datapoint) {
-      this->target_temperature = datapoint.value_int * this->target_temperature_multiplier_;
+      this->manual_temperature_ = datapoint.value_int * this->target_temperature_multiplier_;
-      ESP_LOGV(TAG, "MCU reported target temperature is: %.1f", this->target_temperature);
+      ESP_LOGV(TAG, "MCU reported manual target temperature is: %.1f", this->manual_temperature_);
+      this->compute_target_temperature_();
       this->compute_state_();
       this->publish_state();
     });
@@ -57,6 +58,15 @@ void TuyaClimate::setup() {
       this->publish_state();
     });
   }
+  if (this->eco_id_.has_value()) {
+    this->parent_->register_listener(*this->eco_id_, [this](const TuyaDatapoint &datapoint) {
+      this->eco_ = datapoint.value_bool;
+      ESP_LOGV(TAG, "MCU reported eco is: %s", ONOFF(this->eco_));
+      this->compute_preset_();
+      this->compute_target_temperature_();
+      this->publish_state();
+    });
+  }
 }
 
 void TuyaClimate::loop() {
@@ -100,16 +110,29 @@ void TuyaClimate::control(const climate::ClimateCall &call) {
     this->parent_->set_integer_datapoint_value(*this->target_temperature_id_,
                                                (int) (target_temperature / this->target_temperature_multiplier_));
   }
+
+  if (call.get_preset().has_value()) {
+    const climate::ClimatePreset preset = *call.get_preset();
+    if (this->eco_id_.has_value()) {
+      const bool eco = preset == climate::CLIMATE_PRESET_ECO;
+      ESP_LOGV(TAG, "Setting eco: %s", ONOFF(eco));
+      this->parent_->set_boolean_datapoint_value(*this->eco_id_, eco);
+    }
+  }
 }
 
 climate::ClimateTraits TuyaClimate::traits() {
   auto traits = climate::ClimateTraits();
+  traits.set_supports_action(true);
   traits.set_supports_current_temperature(this->current_temperature_id_.has_value());
   if (supports_heat_)
     traits.add_supported_mode(climate::CLIMATE_MODE_HEAT);
   if (supports_cool_)
     traits.add_supported_mode(climate::CLIMATE_MODE_COOL);
-  traits.set_supports_action(true);
+  if (this->eco_id_.has_value()) {
+    traits.add_supported_preset(climate::CLIMATE_PRESET_NONE);
+    traits.add_supported_preset(climate::CLIMATE_PRESET_ECO);
+  }
   return traits;
 }
 
@@ -125,6 +148,24 @@ void TuyaClimate::dump_config() {
     ESP_LOGCONFIG(TAG, "  Current Temperature has datapoint ID %u", *this->current_temperature_id_);
   LOG_PIN("  Heating State Pin: ", this->heating_state_pin_);
   LOG_PIN("  Cooling State Pin: ", this->cooling_state_pin_);
+  if (this->eco_id_.has_value())
+    ESP_LOGCONFIG(TAG, "  Eco has datapoint ID %u", *this->eco_id_);
+}
+
+void TuyaClimate::compute_preset_() {
+  if (this->eco_) {
+    this->preset = climate::CLIMATE_PRESET_ECO;
+  } else {
+    this->preset = climate::CLIMATE_PRESET_NONE;
+  }
+}
+
+void TuyaClimate::compute_target_temperature_() {
+  if (this->eco_ && this->eco_temperature_.has_value()) {
+    this->target_temperature = *this->eco_temperature_;
+  } else {
+    this->target_temperature = this->manual_temperature_;
+  }
 }
 
 void TuyaClimate::compute_state_() {

esphome/components/tuya/climate/tuya_climate.h

@@ -32,15 +32,24 @@ class TuyaClimate : public climate::Climate, public Component {
   void set_target_temperature_multiplier(float temperature_multiplier) {
     this->target_temperature_multiplier_ = temperature_multiplier;
   }
+  void set_eco_id(uint8_t eco_id) { this->eco_id_ = eco_id; }
+  void set_eco_temperature(float eco_temperature) { this->eco_temperature_ = eco_temperature; }
 
   void set_tuya_parent(Tuya *parent) { this->parent_ = parent; }
 
  protected:
   /// Override control to change settings of the climate device.
   void control(const climate::ClimateCall &call) override;
+
   /// Return the traits of this controller.
   climate::ClimateTraits traits() override;
 
+  /// Re-compute the active preset of this climate controller.
+  void compute_preset_();
+
+  /// Re-compute the target temperature of this climate controller.
+  void compute_target_temperature_();
+
   /// Re-compute the state of this climate controller.
   void compute_state_();
 
@@ -61,9 +70,13 @@ class TuyaClimate : public climate::Climate, public Component {
   float current_temperature_multiplier_{1.0f};
   float target_temperature_multiplier_{1.0f};
   float hysteresis_{1.0f};
+  optional<uint8_t> eco_id_{};
+  optional<float> eco_temperature_{};
   uint8_t active_state_;
   bool heating_state_{false};
   bool cooling_state_{false};
+  float manual_temperature_;
+  bool eco_;
 };
 
 }  // namespace tuya