Sprinkler controller component (#2249)

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

CODEOWNERS

@@ -193,6 +193,7 @@ esphome/components/smt100/* @piechade
 esphome/components/socket/* @esphome/core
 esphome/components/sonoff_d1/* @anatoly-savchenkov
 esphome/components/spi/* @esphome/core
+esphome/components/sprinkler/* @kbx81
 esphome/components/sps30/* @martgras
 esphome/components/ssd1322_base/* @kbx81
 esphome/components/ssd1322_spi/* @kbx81

esphome/components/sprinkler/automation.h

@@ -0,0 +1,169 @@
+#pragma once
+
+#include "esphome/core/automation.h"
+#include "esphome/core/component.h"
+#include "esphome/components/sprinkler/sprinkler.h"
+
+namespace esphome {
+namespace sprinkler {
+
+template<typename... Ts> class SetMultiplierAction : public Action<Ts...> {
+ public:
+  explicit SetMultiplierAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  TEMPLATABLE_VALUE(float, multiplier)
+
+  void play(Ts... x) override { this->sprinkler_->set_multiplier(this->multiplier_.optional_value(x...)); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class QueueValveAction : public Action<Ts...> {
+ public:
+  explicit QueueValveAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  TEMPLATABLE_VALUE(size_t, valve_number)
+  TEMPLATABLE_VALUE(uint32_t, valve_run_duration)
+
+  void play(Ts... x) override {
+    this->sprinkler_->queue_valve(this->valve_number_.optional_value(x...),
+                                  this->valve_run_duration_.optional_value(x...));
+  }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class ClearQueuedValvesAction : public Action<Ts...> {
+ public:
+  explicit ClearQueuedValvesAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->clear_queued_valves(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class SetRepeatAction : public Action<Ts...> {
+ public:
+  explicit SetRepeatAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  TEMPLATABLE_VALUE(uint32_t, repeat)
+
+  void play(Ts... x) override { this->sprinkler_->set_repeat(this->repeat_.optional_value(x...)); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class SetRunDurationAction : public Action<Ts...> {
+ public:
+  explicit SetRunDurationAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  TEMPLATABLE_VALUE(size_t, valve_number)
+  TEMPLATABLE_VALUE(uint32_t, valve_run_duration)
+
+  void play(Ts... x) override {
+    this->sprinkler_->set_valve_run_duration(this->valve_number_.optional_value(x...),
+                                             this->valve_run_duration_.optional_value(x...));
+  }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class StartFromQueueAction : public Action<Ts...> {
+ public:
+  explicit StartFromQueueAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->start_from_queue(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class StartFullCycleAction : public Action<Ts...> {
+ public:
+  explicit StartFullCycleAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->start_full_cycle(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class StartSingleValveAction : public Action<Ts...> {
+ public:
+  explicit StartSingleValveAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  TEMPLATABLE_VALUE(size_t, valve_to_start)
+
+  void play(Ts... x) override { this->sprinkler_->start_single_valve(this->valve_to_start_.optional_value(x...)); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class ShutdownAction : public Action<Ts...> {
+ public:
+  explicit ShutdownAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->shutdown(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class NextValveAction : public Action<Ts...> {
+ public:
+  explicit NextValveAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->next_valve(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class PreviousValveAction : public Action<Ts...> {
+ public:
+  explicit PreviousValveAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->previous_valve(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class PauseAction : public Action<Ts...> {
+ public:
+  explicit PauseAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->pause(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class ResumeAction : public Action<Ts...> {
+ public:
+  explicit ResumeAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->resume(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+template<typename... Ts> class ResumeOrStartAction : public Action<Ts...> {
+ public:
+  explicit ResumeOrStartAction(Sprinkler *a_sprinkler) : sprinkler_(a_sprinkler) {}
+
+  void play(Ts... x) override { this->sprinkler_->resume_or_start_full_cycle(); }
+
+ protected:
+  Sprinkler *sprinkler_;
+};
+
+}  // namespace sprinkler
+}  // namespace esphome

tests/test3.yaml

@@ -1128,6 +1128,49 @@ climate:
       ki: 0.0
       kd: 0.0
 
+sprinkler:
+  - id: yard_sprinkler_ctrlr
+    main_switch: "Yard Sprinklers"
+    auto_advance_switch: "Yard Sprinklers Auto Advance"
+    reverse_switch: "Yard Sprinklers Reverse"
+    pump_start_pump_delay: 2s
+    pump_stop_valve_delay: 4s
+    pump_switch_off_during_valve_open_delay: true
+    valve_open_delay: 5s
+    valves:
+      - valve_switch: "Yard Valve 0"
+        enable_switch: "Enable Yard Valve 0"
+        pump_switch_id: gpio_switch1
+        run_duration: 10s
+        valve_switch_id: gpio_switch2
+      - valve_switch: "Yard Valve 1"
+        enable_switch: "Enable Yard Valve 1"
+        pump_switch_id: gpio_switch1
+        run_duration: 10s
+        valve_switch_id: gpio_switch2
+      - valve_switch: "Yard Valve 2"
+        enable_switch: "Enable Yard Valve 2"
+        pump_switch_id: gpio_switch1
+        run_duration: 10s
+        valve_switch_id: gpio_switch2
+  - id: garden_sprinkler_ctrlr
+    main_switch: "Garden Sprinklers"
+    auto_advance_switch: "Garden Sprinklers Auto Advance"
+    reverse_switch: "Garden Sprinklers Reverse"
+    valve_overlap: 5s
+    valves:
+      - valve_switch: "Garden Valve 0"
+        enable_switch: "Enable Garden Valve 0"
+        pump_switch_id: gpio_switch1
+        run_duration: 10s
+        valve_switch_id: gpio_switch2
+      - valve_switch: "Garden Valve 1"
+        enable_switch: "Enable Garden Valve 1"
+        pump_switch_id: gpio_switch1
+        run_duration: 10s
+        valve_switch_id: gpio_switch2
+
+
 cover:
   - platform: endstop
     name: Endstop Cover