From a4d024f43d20b93e2ec69935f5703be1ca128446 Mon Sep 17 00:00:00 2001
From: Chris Nussbaum <chrisnussbaum@gmail.com>
Date: Wed, 1 Sep 2021 19:16:11 -0500
Subject: [PATCH] Add is_on and is_off conditions for the fan component (#2225)

Co-authored-by: Chris Nussbaum <chris.nussbaum@protolabs.com>
---
 esphome/components/fan/__init__.py  | 26 ++++++++++++++++++++++++++
 esphome/components/fan/automation.h | 17 +++++++++++++++++
 tests/test1.yaml                    |  3 +++
 3 files changed, 46 insertions(+)

diff --git a/esphome/components/fan/__init__.py b/esphome/components/fan/__init__.py
index 27dee3271f..6bf0d1ca1a 100644
--- a/esphome/components/fan/__init__.py
+++ b/esphome/components/fan/__init__.py
@@ -42,6 +42,9 @@ ToggleAction = fan_ns.class_("ToggleAction", automation.Action)
 FanTurnOnTrigger = fan_ns.class_("FanTurnOnTrigger", automation.Trigger.template())
 FanTurnOffTrigger = fan_ns.class_("FanTurnOffTrigger", automation.Trigger.template())
 
+FanIsOnCondition = fan_ns.class_("FanIsOnCondition", automation.Condition.template())
+FanIsOffCondition = fan_ns.class_("FanIsOffCondition", automation.Condition.template())
+
 FAN_SCHEMA = cv.NAMEABLE_SCHEMA.extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA).extend(
     {
         cv.GenerateID(): cv.declare_id(FanState),
@@ -171,6 +174,29 @@ async def fan_turn_on_to_code(config, action_id, template_arg, args):
     return var
 
 
+@automation.register_condition(
+    "fan.is_on",
+    FanIsOnCondition,
+    automation.maybe_simple_id(
+        {
+            cv.Required(CONF_ID): cv.use_id(FanState),
+        }
+    ),
+)
+@automation.register_condition(
+    "fan.is_off",
+    FanIsOffCondition,
+    automation.maybe_simple_id(
+        {
+            cv.Required(CONF_ID): cv.use_id(FanState),
+        }
+    ),
+)
+async def fan_is_on_off_to_code(config, condition_id, template_arg, args):
+    paren = await cg.get_variable(config[CONF_ID])
+    return cg.new_Pvariable(condition_id, template_arg, paren)
+
+
 @coroutine_with_priority(100.0)
 async def to_code(config):
     cg.add_define("USE_FAN")
diff --git a/esphome/components/fan/automation.h b/esphome/components/fan/automation.h
index 29a8e8d992..abcad82569 100644
--- a/esphome/components/fan/automation.h
+++ b/esphome/components/fan/automation.h
@@ -50,6 +50,23 @@ template<typename... Ts> class ToggleAction : public Action<Ts...> {
   FanState *state_;
 };
 
+template<typename... Ts> class FanIsOnCondition : public Condition<Ts...> {
+ public:
+  explicit FanIsOnCondition(FanState *state) : state_(state) {}
+  bool check(Ts... x) override { return this->state_->state; }
+
+ protected:
+  FanState *state_;
+};
+template<typename... Ts> class FanIsOffCondition : public Condition<Ts...> {
+ public:
+  explicit FanIsOffCondition(FanState *state) : state_(state) {}
+  bool check(Ts... x) override { return !this->state_->state; }
+
+ protected:
+  FanState *state_;
+};
+
 class FanTurnOnTrigger : public Trigger<> {
  public:
   FanTurnOnTrigger(FanState *state) {
diff --git a/tests/test1.yaml b/tests/test1.yaml
index a3f7a97281..f26e441192 100644
--- a/tests/test1.yaml
+++ b/tests/test1.yaml
@@ -129,6 +129,8 @@ mqtt:
             - mqtt.connected:
             - light.is_on: kitchen
             - light.is_off: kitchen
+            - fan.is_on: fan_speed
+            - fan.is_off: fan_speed
           then:
             - lambda: |-
                 int data = x["my_data"];
@@ -1868,6 +1870,7 @@ fan:
     oscillation_output: gpio_19
     direction_output: gpio_26
   - platform: speed
+    id: fan_speed
     output: pca_6
     speed_count: 10
     name: 'Living Room Fan 2'