[ezo_pmp] Use register_apply_action for the twelve ezo_pmp actions (#19663)

esphome/components/ezo_pmp/__init__.py

@@ -44,91 +44,18 @@ EZO_PMP_NO_ARGS_ACTION_SCHEMA = maybe_simple_id(
     }
 )
 
-# Actions that do not require more arguments
+for _name, _method in (
+    ("ezo_pmp.find", "find()"),
+    ("ezo_pmp.dose_continuously", "dose_continuously()"),
+    ("ezo_pmp.clear_total_volume_dosed", "clear_total_volume_dosed()"),
+    ("ezo_pmp.clear_calibration", "clear_calibration()"),
+    ("ezo_pmp.pause_dosing", "pause_dosing()"),
+    ("ezo_pmp.stop_dosing", "stop_dosing()"),
+):
+    automation.register_apply_action(
+        _name, EZO_PMP_NO_ARGS_ACTION_SCHEMA, automation.ApplyCall(_method)
+    )
 
-EzoPMPFindAction = ezo_pmp_ns.class_("EzoPMPFindAction", automation.Action)
-EzoPMPClearTotalVolumeDispensedAction = ezo_pmp_ns.class_(
-    "EzoPMPClearTotalVolumeDispensedAction", automation.Action
-)
-EzoPMPClearCalibrationAction = ezo_pmp_ns.class_(
-    "EzoPMPClearCalibrationAction", automation.Action
-)
-EzoPMPPauseDosingAction = ezo_pmp_ns.class_(
-    "EzoPMPPauseDosingAction", automation.Action
-)
-EzoPMPStopDosingAction = ezo_pmp_ns.class_("EzoPMPStopDosingAction", automation.Action)
-EzoPMPDoseContinuouslyAction = ezo_pmp_ns.class_(
-    "EzoPMPDoseContinuouslyAction", automation.Action
-)
-
-# Actions that require more arguments
-EzoPMPDoseVolumeAction = ezo_pmp_ns.class_("EzoPMPDoseVolumeAction", automation.Action)
-EzoPMPDoseVolumeOverTimeAction = ezo_pmp_ns.class_(
-    "EzoPMPDoseVolumeOverTimeAction", automation.Action
-)
-EzoPMPDoseWithConstantFlowRateAction = ezo_pmp_ns.class_(
-    "EzoPMPDoseWithConstantFlowRateAction", automation.Action
-)
-EzoPMPSetCalibrationVolumeAction = ezo_pmp_ns.class_(
-    "EzoPMPSetCalibrationVolumeAction", automation.Action
-)
-EzoPMPChangeI2CAddressAction = ezo_pmp_ns.class_(
-    "EzoPMPChangeI2CAddressAction", automation.Action
-)
-EzoPMPArbitraryCommandAction = ezo_pmp_ns.class_(
-    "EzoPMPArbitraryCommandAction", automation.Action
-)
-
-
-automation.register_simple_action(
-    "ezo_pmp.find",
-    EzoPMPFindAction,
-    EZO_PMP_NO_ARGS_ACTION_SCHEMA,
-    synchronous=True,
-)
-
-
-automation.register_simple_action(
-    "ezo_pmp.dose_continuously",
-    EzoPMPDoseContinuouslyAction,
-    EZO_PMP_NO_ARGS_ACTION_SCHEMA,
-    synchronous=True,
-)
-
-
-automation.register_simple_action(
-    "ezo_pmp.clear_total_volume_dosed",
-    EzoPMPClearTotalVolumeDispensedAction,
-    EZO_PMP_NO_ARGS_ACTION_SCHEMA,
-    synchronous=True,
-)
-
-
-automation.register_simple_action(
-    "ezo_pmp.clear_calibration",
-    EzoPMPClearCalibrationAction,
-    EZO_PMP_NO_ARGS_ACTION_SCHEMA,
-    synchronous=True,
-)
-
-
-automation.register_simple_action(
-    "ezo_pmp.pause_dosing",
-    EzoPMPPauseDosingAction,
-    EZO_PMP_NO_ARGS_ACTION_SCHEMA,
-    synchronous=True,
-)
-
-
-automation.register_simple_action(
-    "ezo_pmp.stop_dosing",
-    EzoPMPStopDosingAction,
-    EZO_PMP_NO_ARGS_ACTION_SCHEMA,
-    synchronous=True,
-)
-
-
-# Actions that require Multiple Args
 
 EZO_PMP_DOSE_VOLUME_ACTION_SCHEMA = cv.All(
     {
@@ -139,21 +66,11 @@ EZO_PMP_DOSE_VOLUME_ACTION_SCHEMA = cv.All(
     }
 )
 
-
-@automation.register_action(
+automation.register_apply_action(
     "ezo_pmp.dose_volume",
-    EzoPMPDoseVolumeAction,
     EZO_PMP_DOSE_VOLUME_ACTION_SCHEMA,
-    synchronous=True,
+    automation.ApplyField(CONF_VOLUME, "dose_volume", cg.double),
 )
-async def ezo_pmp_dose_volume_to_code(config, action_id, template_arg, args):
-    paren = await cg.get_variable(config[CONF_ID])
-    var = cg.new_Pvariable(action_id, template_arg, paren)
-
-    template_ = await cg.templatable(config[CONF_VOLUME], args, cg.double)
-    cg.add(var.set_volume(template_))
-
-    return var
 
 
 EZO_PMP_DOSE_VOLUME_OVER_TIME_ACTION_SCHEMA = cv.All(
@@ -168,24 +85,14 @@ EZO_PMP_DOSE_VOLUME_OVER_TIME_ACTION_SCHEMA = cv.All(
     }
 )
 
-
-@automation.register_action(
+automation.register_apply_action(
     "ezo_pmp.dose_volume_over_time",
-    EzoPMPDoseVolumeOverTimeAction,
     EZO_PMP_DOSE_VOLUME_OVER_TIME_ACTION_SCHEMA,
-    synchronous=True,
+    automation.ApplyCall(
+        "dose_volume_over_time({}, {})",
+        ((CONF_VOLUME, cg.double), (CONF_DURATION, cg.int_)),
+    ),
 )
-async def ezo_pmp_dose_volume_over_time_to_code(config, action_id, template_arg, args):
-    paren = await cg.get_variable(config[CONF_ID])
-    var = cg.new_Pvariable(action_id, template_arg, paren)
-
-    template_ = await cg.templatable(config[CONF_VOLUME], args, cg.double)
-    cg.add(var.set_volume(template_))
-
-    template_ = await cg.templatable(config[CONF_DURATION], args, cg.int_)
-    cg.add(var.set_duration(template_))
-
-    return var
 
 
 EZO_PMP_DOSE_WITH_CONSTANT_FLOW_RATE_ACTION_SCHEMA = cv.All(
@@ -200,26 +107,14 @@ EZO_PMP_DOSE_WITH_CONSTANT_FLOW_RATE_ACTION_SCHEMA = cv.All(
     }
 )
 
-
-@automation.register_action(
+automation.register_apply_action(
     "ezo_pmp.dose_with_constant_flow_rate",
-    EzoPMPDoseWithConstantFlowRateAction,
     EZO_PMP_DOSE_WITH_CONSTANT_FLOW_RATE_ACTION_SCHEMA,
-    synchronous=True,
+    automation.ApplyCall(
+        "dose_with_constant_flow_rate({}, {})",
+        ((CONF_VOLUME_PER_MINUTE, cg.double), (CONF_DURATION, cg.int_)),
+    ),
 )
-async def ezo_pmp_dose_with_constant_flow_rate_to_code(
-    config, action_id, template_arg, args
-):
-    paren = await cg.get_variable(config[CONF_ID])
-    var = cg.new_Pvariable(action_id, template_arg, paren)
-
-    template_ = await cg.templatable(config[CONF_VOLUME_PER_MINUTE], args, cg.double)
-    cg.add(var.set_volume(template_))
-
-    template_ = await cg.templatable(config[CONF_DURATION], args, cg.int_)
-    cg.add(var.set_duration(template_))
-
-    return var
 
 
 EZO_PMP_SET_CALIBRATION_VOLUME_ACTION_SCHEMA = cv.All(
@@ -231,21 +126,11 @@ EZO_PMP_SET_CALIBRATION_VOLUME_ACTION_SCHEMA = cv.All(
     }
 )
 
-
-@automation.register_action(
+automation.register_apply_action(
     "ezo_pmp.set_calibration_volume",
-    EzoPMPSetCalibrationVolumeAction,
     EZO_PMP_SET_CALIBRATION_VOLUME_ACTION_SCHEMA,
-    synchronous=True,
+    automation.ApplyField(CONF_VOLUME, "set_calibration_volume", cg.double),
 )
-async def ezo_pmp_set_calibration_volume_to_code(config, action_id, template_arg, args):
-    paren = await cg.get_variable(config[CONF_ID])
-    var = cg.new_Pvariable(action_id, template_arg, paren)
-
-    template_ = await cg.templatable(config[CONF_VOLUME], args, cg.double)
-    cg.add(var.set_volume(template_))
-
-    return var
 
 
 EZO_PMP_CHANGE_I2C_ADDRESS_ACTION_SCHEMA = cv.All(
@@ -255,21 +140,11 @@ EZO_PMP_CHANGE_I2C_ADDRESS_ACTION_SCHEMA = cv.All(
     }
 )
 
-
-@automation.register_action(
+automation.register_apply_action(
     "ezo_pmp.change_i2c_address",
-    EzoPMPChangeI2CAddressAction,
     EZO_PMP_CHANGE_I2C_ADDRESS_ACTION_SCHEMA,
-    synchronous=True,
+    automation.ApplyField(CONF_ADDRESS, "change_i2c_address", cg.int_),
 )
-async def ezo_pmp_change_i2c_address_to_code(config, action_id, template_arg, args):
-    paren = await cg.get_variable(config[CONF_ID])
-    var = cg.new_Pvariable(action_id, template_arg, paren)
-
-    template_ = await cg.templatable(config[CONF_ADDRESS], args, cg.int_)
-    cg.add(var.set_address(template_))
-
-    return var
 
 
 EZO_PMP_ARBITRARY_COMMAND_ACTION_SCHEMA = cv.All(
@@ -279,18 +154,8 @@ EZO_PMP_ARBITRARY_COMMAND_ACTION_SCHEMA = cv.All(
     }
 )
 
-
-@automation.register_action(
+automation.register_apply_action(
     "ezo_pmp.arbitrary_command",
-    EzoPMPArbitraryCommandAction,
     EZO_PMP_ARBITRARY_COMMAND_ACTION_SCHEMA,
-    synchronous=True,
+    automation.ApplyField(CONF_COMMAND, "exec_arbitrary_command", cg.std_string),
 )
-async def ezo_pmp_arbitrary_command_to_code(config, action_id, template_arg, args):
-    paren = await cg.get_variable(config[CONF_ID])
-    var = cg.new_Pvariable(action_id, template_arg, paren)
-
-    template_ = await cg.templatable(config[CONF_COMMAND], args, cg.std_string)
-    cg.add(var.set_command(template_))
-
-    return var

esphome/components/ezo_pmp/ezo_pmp.h

@@ -2,7 +2,6 @@
 
 #include "esphome/core/defines.h"
 #include "esphome/core/component.h"
-#include "esphome/core/automation.h"
 #include "esphome/components/i2c/i2c.h"
 
 #ifdef USE_BINARY_SENSOR
@@ -113,137 +112,4 @@ class EzoPMP final : public PollingComponent, public i2c::I2CDevice {
 #endif
 };
 
-// Action Templates
-template<typename... Ts> class EzoPMPFindAction final : public Action<Ts...> {
- public:
-  EzoPMPFindAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->find(); }
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPDoseContinuouslyAction final : public Action<Ts...> {
- public:
-  EzoPMPDoseContinuouslyAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->dose_continuously(); }
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPDoseVolumeAction final : public Action<Ts...> {
- public:
-  EzoPMPDoseVolumeAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->dose_volume(this->volume_.value(x...)); }
-  TEMPLATABLE_VALUE(double, volume)
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPDoseVolumeOverTimeAction final : public Action<Ts...> {
- public:
-  EzoPMPDoseVolumeOverTimeAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override {
-    this->ezopmp_->dose_volume_over_time(this->volume_.value(x...), this->duration_.value(x...));
-  }
-  TEMPLATABLE_VALUE(double, volume)
-  TEMPLATABLE_VALUE(int, duration)
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPDoseWithConstantFlowRateAction final : public Action<Ts...> {
- public:
-  EzoPMPDoseWithConstantFlowRateAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override {
-    this->ezopmp_->dose_with_constant_flow_rate(this->volume_.value(x...), this->duration_.value(x...));
-  }
-  TEMPLATABLE_VALUE(double, volume)
-  TEMPLATABLE_VALUE(int, duration)
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPSetCalibrationVolumeAction final : public Action<Ts...> {
- public:
-  EzoPMPSetCalibrationVolumeAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->set_calibration_volume(this->volume_.value(x...)); }
-  TEMPLATABLE_VALUE(double, volume)
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPClearTotalVolumeDispensedAction final : public Action<Ts...> {
- public:
-  EzoPMPClearTotalVolumeDispensedAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->clear_total_volume_dosed(); }
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPClearCalibrationAction final : public Action<Ts...> {
- public:
-  EzoPMPClearCalibrationAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->clear_calibration(); }
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPPauseDosingAction final : public Action<Ts...> {
- public:
-  EzoPMPPauseDosingAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->pause_dosing(); }
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPStopDosingAction final : public Action<Ts...> {
- public:
-  EzoPMPStopDosingAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->stop_dosing(); }
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPChangeI2CAddressAction final : public Action<Ts...> {
- public:
-  EzoPMPChangeI2CAddressAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->change_i2c_address(this->address_.value(x...)); }
-  TEMPLATABLE_VALUE(int, address)
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
-template<typename... Ts> class EzoPMPArbitraryCommandAction final : public Action<Ts...> {
- public:
-  EzoPMPArbitraryCommandAction(EzoPMP *ezopmp) : ezopmp_(ezopmp) {}
-
-  void play(const Ts &...x) override { this->ezopmp_->exec_arbitrary_command(this->command_.value(x...)); }
-  TEMPLATABLE_VALUE(std::string, command)
-
- protected:
-  EzoPMP *ezopmp_;
-};
-
 }  // namespace esphome::ezo_pmp

tests/components/ezo_pmp/common-actions.yaml

@@ -0,0 +1,20 @@
+button:
+  - platform: template
+    name: EZO PMP Actions
+    on_press:
+      - ezo_pmp.change_i2c_address:
+          id: hcl_pump
+          address: 104
+      - ezo_pmp.change_i2c_address:
+          id: hcl_pump
+          address: !lambda return 105;
+      - ezo_pmp.dose_volume:
+          id: hcl_pump
+          volume: !lambda return 2.5;
+      - ezo_pmp.dose_volume_over_time:
+          id: hcl_pump
+          volume: !lambda return 2.5;
+          duration: !lambda return 3;
+      - ezo_pmp.arbitrary_command:
+          id: hcl_pump
+          command: !lambda return "D,?";

tests/components/ezo_pmp/test-actions.esp8266-ard.yaml

@@ -0,0 +1,4 @@
+packages:
+  i2c: !include ../../test_build_components/common/i2c/esp8266-ard.yaml
+  ezo_pmp: !include common.yaml
+  actions: !include common-actions.yaml