[climate] Build the on_state and on_control triggers with build_callback_automation (#19611)

esphome/components/climate/__init__.py

@@ -46,7 +46,6 @@ from esphome.const import (
     CONF_TARGET_TEMPERATURE_LOW_STATE_TOPIC,
     CONF_TARGET_TEMPERATURE_STATE_TOPIC,
     CONF_TEMPERATURE_STEP,
-    CONF_TRIGGER_ID,
     CONF_VISUAL,
     CONF_WEB_SERVER,
 )
@@ -164,14 +163,6 @@ def visual_temperature_step(value: Any) -> ConfigType:
     )
 
 
-# Actions
-StateTrigger = climate_ns.class_(
-    "StateTrigger", automation.Trigger.template(Climate.operator("ref"))
-)
-ControlTrigger = climate_ns.class_(
-    "ControlTrigger", automation.Trigger.template(ClimateCall.operator("ref"))
-)
-
 _CLIMATE_SCHEMA = (
     cv.ENTITY_BASE_SCHEMA.extend(web_server.WEBSERVER_SORTING_SCHEMA)
     .extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA)
@@ -250,16 +241,8 @@ _CLIMATE_SCHEMA = (
             cv.Optional(CONF_TARGET_HUMIDITY_STATE_TOPIC): cv.All(
                 cv.requires_component("mqtt"), cv.publish_topic
             ),
-            cv.Optional(CONF_ON_CONTROL): automation.validate_automation(
-                {
-                    cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(ControlTrigger),
-                }
-            ),
-            cv.Optional(CONF_ON_STATE): automation.validate_automation(
-                {
-                    cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(StateTrigger),
-                }
-            ),
+            cv.Optional(CONF_ON_CONTROL): automation.validate_automation(),
+            cv.Optional(CONF_ON_STATE): automation.validate_automation(),
         }
     )
 )
@@ -288,6 +271,16 @@ def climate_schema(
     return _CLIMATE_SCHEMA.extend(schema)
 
 
+_CALLBACK_AUTOMATIONS = (
+    automation.CallbackAutomation(
+        CONF_ON_STATE, "add_on_state_callback", [(Climate.operator("ref"), "x")]
+    ),
+    automation.CallbackAutomation(
+        CONF_ON_CONTROL, "add_on_control_callback", [(ClimateCall.operator("ref"), "x")]
+    ),
+)
+
+
 @setup_entity("climate")
 async def setup_climate_core_(var: MockObj, config: ConfigType) -> None:
     visual = config.get(CONF_VISUAL, {})
@@ -443,17 +436,7 @@ async def setup_climate_core_(var: MockObj, config: ConfigType) -> None:
                 )
             )
 
-    for conf in config.get(CONF_ON_STATE, []):
-        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
-        await automation.build_automation(
-            trigger, [(Climate.operator("ref"), "x")], conf
-        )
-
-    for conf in config.get(CONF_ON_CONTROL, []):
-        trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
-        await automation.build_automation(
-            trigger, [(ClimateCall.operator("ref"), "x")], conf
-        )
+    await automation.build_callback_automations(var, config, _CALLBACK_AUTOMATIONS)
 
     if web_server_config := config.get(CONF_WEB_SERVER):
         await web_server.add_entity_config(var, web_server_config)

esphome/components/climate/automation.h

@@ -1,22 +0,0 @@
-#pragma once
-
-#include "esphome/core/automation.h"
-#include "climate.h"
-
-namespace esphome::climate {
-
-class ControlTrigger final : public Trigger<ClimateCall &> {
- public:
-  ControlTrigger(Climate *climate) {
-    climate->add_on_control_callback([this](ClimateCall &x) { this->trigger(x); });
-  }
-};
-
-class StateTrigger final : public Trigger<Climate &> {
- public:
-  StateTrigger(Climate *climate) {
-    climate->add_on_state_callback([this](Climate &x) { this->trigger(x); });
-  }
-};
-
-}  // namespace esphome::climate

tests/components/climate/common-triggers.yaml

@@ -0,0 +1,25 @@
+# on_state and on_control on a thermostat.
+sensor:
+  - platform: template
+    id: climate_triggers_temperature
+
+climate:
+  - platform: thermostat
+    name: Climate Triggers
+    id: climate_triggers
+    sensor: climate_triggers_temperature
+    min_idle_time: 30s
+    min_heating_off_time: 300s
+    min_heating_run_time: 300s
+    heat_action:
+      - logger.log: heating
+    idle_action:
+      - logger.log: idle
+    on_state:
+      - logger.log:
+          format: "Climate mode %d"
+          args: [x.mode]
+    on_control:
+      - lambda: |-
+          if (x.get_mode().has_value())
+            ESP_LOGD("test", "Control mode %d", *x.get_mode());

tests/components/climate/test-triggers.esp32-idf.yaml

@@ -0,0 +1,3 @@
+packages:
+  climate: !include common.yaml
+  triggers: !include common-triggers.yaml