New feature: Allow optional boolean input helper to enable/disable motion activation, so we can activate proper ON/OFF scene based on motion at the time of enabling/disabling.

(also rename an input variable)

motion-activated-light.yaml

@@ -4,6 +4,8 @@
 ### Blueprint definition
 ########################
 
+mode: queued
+max: 10
 blueprint:
 
   name: "Mike's Motion Activated Light"
@@ -41,6 +43,30 @@ blueprint:
           mode: box
 
 
+    delay_seconds_multiplier:
+      name: "Delay seconds multiplier"
+      description: "When the off sequence gets interrupted by new motion, multiply the delay seconds by this number. A decent value might be 2."
+      default: 2.0
+      selector:
+        number:
+          min: 1.0
+          max: 1000.0
+          step: 0.1
+          mode: box
+
+
+    delay_seconds_max:
+      name: "Maximum delay seconds"
+      description: "The maximum delay during no motion before the motion-off sequence begins."
+      default: 3600
+      selector:
+        number:
+          min: 5
+          max: 3000000
+          step: 1
+          mode: box
+
+
     notice_seconds:
       name: "Notice seconds"
       description: "The number of seconds to wait in the Prep1 (Notice) scene."
@@ -97,9 +123,40 @@ blueprint:
           domain: scene
 
 
-    on_just_before_off:
-      name: "Use On scene just before Off scene."
-      description: "Toggle this to \"on\" if you would like the \"On\" scene to trigger just before the \"Off\" scene. This is sometimes helpful to mitigate an issue where the \"On\" scene doesn't apply all colors and settings correctly from an \"Off\" state."
+    on_just_before_off_seconds:
+      name: "\"On\" just before \"Off\""
+      description: >
+        When the "Off" scene is about to be shown, you may wish to quickly show the "On" scene for a number of seconds just before.
+        This is sometimes helpful to mitigate an issue where the "On" scene doesn't apply all colors and settings correctly from an "Off" state.
+        Set this to a value greater than 0 to enable.
+        A value of 0 will disable this feature.
+        Note that sometimes, a value that is too short (e.g., 1) may also cause issues.
+
+      default: 1
+      selector:
+        number:
+          min: 1
+          max: 86400
+          step: 1
+          mode: box
+
+
+    enabled_helper:
+      name: "Enabled helper"
+      description: >
+        Helper variable that will control whether motion activation is enabled or disabled.
+        This will allow this blueprint to correctly select the "On" or "Off" scene, based on whether motion is currently detected when disabled.
+        An example would be a "Toggle" helper.
+      default:  # Allows no selection
+      selector:
+        entity:
+          domain: input_boolean
+
+
+    debug_mode:
+      name: "Debug mode."
+      description: "Enable debug mode, which increases logging."
+      default: false
       selector:
         boolean: {}
 
@@ -110,12 +167,20 @@ blueprint:
 
 variables:
 
-  motion_sensor:          !input motion_sensor
-  delay_seconds:          !input delay_seconds_helper
-  delay_seconds_default:  !input delay_seconds_default
-  notice_seconds:         !input notice_seconds
-  warning_seconds:        !input warning_seconds
-  on_just_before_off:     !input on_just_before_off
+  motion_sensor:               !input motion_sensor
+  delay_seconds_helper:        !input delay_seconds_helper
+  delay_seconds_default:       !input delay_seconds_default
+  delay_seconds_multiplier:    !input delay_seconds_multiplier
+  delay_seconds_max:           !input delay_seconds_max
+  notice_seconds:              !input notice_seconds
+  warning_seconds:             !input warning_seconds
+  on_just_before_off_seconds:  !input on_just_before_off_seconds
+  enabled_helper:              !input enabled_helper
+  debug_mode:                  !input debug_mode
+
+
+trigger_variables:
+  enabled_helper:              !input enabled_helper
 
 
 ############
@@ -125,36 +190,138 @@ variables:
 trigger:
 
   - platform: state
+    id: Motion changed
     entity_id:
       - !input motion_sensor
     to:
       - "on"
       - "off"
 
+  - platform: template
+    id: "Enabled helper is on"
+    value_template: "{{ (enabled_helper != None) and is_state( enabled_helper, 'on' ) }}"
+
+  - platform: template
+    id: "Enabled helper is off"
+    value_template: "{{ (enabled_helper != None) and is_state( enabled_helper, 'off' ) }}"
+
+
 ###########
 ### Actions
 ###########
 
 action:
 
-  - service: logbook.log
-    data:
-      name: "First log"
-      message: "Motion automation has started. Delay counter is: {{ states[delay_seconds].state }}"
+  - alias: "Debug log whether the enabled_helper was set"
+    if:
+      - condition: template
+        value_template: "{{ debug_mode == true or true }}"
+    then:
+      - if:
+        - condition: template
+          value_template: "{{ not enabled_helper == None }}"
+        then:
+          - service: logbook.log
+            data:
+              name: "Enabled helper"
+              message: "Enabled helper is: {{ enabled_helper }}"
+        else:
+          - service: logbook.log
+            data:
+              name: "Enabled helper"
+              message: "Enabled helper is not set."
 
-  - alias: "Debug log the on_just_before_off bool"
-    enabled: false
-    service: logbook.log
-    data:
-      name: "Debug: On just before off?"
-      message: "On just before off is: {{ on_just_before_off }} "
+  - alias: "Debug log the enabled_helper name"
+    if:
+      - condition: template
+        value_template: "{{ debug_mode == true }}"
+    then:
+      - service: logbook.log
+        data:
+          name: "Enabled helper"
+          message: "Enabled helper name is: {{ enabled_helper }}"
+
+  - alias: "Debug log the current delay_seconds value"
+    if:
+      - condition: template
+        value_template: "{{ debug_mode == true  }}"
+    then:
+      - service: logbook.log
+        data:
+          name: "Delay seconds"
+          message: "Delay seconds is: {{ states[delay_seconds_helper].state }}"
+
+  - alias: "Debug log the on_just_before_off_seconds value"
+    if:
+      - condition: template
+        value_template: "{{ debug_mode == true  }}"
+    then:
+      service: logbook.log
+      data:
+        name: "Debug: On just before off seconds"
+        message: "On just before off is: {{ on_just_before_off_seconds }} "
+
+
+  # Take actions based on whether the "Enabled helper" was just toggled on or off
+  - if:
+      - condition: trigger
+        id:
+          - Enabled helper is on
+          - Enabled helper is off
+    then:
+    
+      # Debug log
+      - alias: "Debug log"
+        if:
+        - condition: template
+          value_template: "{{ debug_mode == true }}"
+        then:
+          - service: logbook.log
+            data:
+              name: "Debug: Trigger"
+              message: "Enabled helper was toggled, and has triggered this automation"
+ 
+ 
+      # Activate the "On" scene, if motion is currently detected
+      - alias: "Activate ON scene, if motion is currently detected, otherwise activate the OFF scene"
+        if:
+          - condition: state
+            entity_id: !input motion_sensor
+            state: "on"
+        then:
+          - parallel:
+            - alias: "Activate the ON scene"
+              service: scene.turn_on
+              target:
+                entity_id: !input scene_on
+        else:
+          - parallel:
+            - alias: "Activate the OFF scene"
+              service: scene.turn_on
+              target:
+                entity_id: !input scene_off
+      - stop: "Done handling enabled helper"
+
+
+
+
+  # Take actions based on whether Motion is detected
+  - alias: "Refuse to do anything if the enabled-helper says we're OFF."
+    if: 
+      - condition: template
+        value_template: "{{ enabled_helper != None }}"
+      - condition: template
+        value_template: "{{ not is_state( enabled_helper, 'on' ) }}"
+    then:
+      stop: "Refusing to continue because the enabled-helper is OFF."
 
   - if:
-      - condition: state
-        entity_id: !input motion_sensor
-        state: "on"
+    - condition: state
+      entity_id: !input motion_sensor
+      state: "on"
 
-    # Take actions based on Motion being detected!
+
+    # Motion is detected
     then:
 
       - alias: "Log that motion was detected."
@@ -170,7 +337,7 @@ action:
             entity_id: !input scene_on
 
 
-    # Take actions based on Motion being undetected
+    # Motion is not detected
     else:
 
       - alias: "Log that the motion-off sequence will run, due to motion no longer detected."
@@ -180,10 +347,10 @@ action:
           message: "Initiating motion-off sequence, because motion no longer detected."
 
 
-    # Initial period where nothing happens
+      # Initial period where nothing happens
       - alias: "Delay appropriately before doing anything"
         wait_template: "{{ states[motion_sensor].state == 'on' }}"
-        timeout: "{{ states[delay_seconds].state }}"
+        timeout: "{{ states[delay_seconds_helper].state }}"
       - if:
         - condition: state
           entity_id: !input motion_sensor
@@ -222,11 +389,37 @@ action:
               service: scene.turn_on
               target:
                 entity_id: !input scene_on
-          - alias: "Double countdown timer when user interrupts the notice period."
+          - alias: "Increase countdown timer when user interrupts the notice period."
             service: input_number.set_value
             data:
               entity_id: !input delay_seconds_helper
-              value: "{{ states[delay_seconds].state | int * 2 }}"
+              value: "{{ states[delay_seconds_helper].state | int * delay_seconds_multiplier }}"
+          - alias: "Limit delay seconds to its defined maximum"
+            if:
+              - condition: template
+                value_template: "{{ states[delay_seconds_helper].state | int > delay_seconds_max | int }}"
+            then:
+              - service: input_number.set_value
+                data:
+                  entity_id: !input delay_seconds_helper
+                  value: "{{ delay_seconds_max | int }}"
+              - if:
+                - condition: template
+                  value_template: "{{ debug_mode == true  }}"
+                then:
+                  - service: logbook.log
+                    data:
+                      name: "Limiting delay seconds"
+                      message: "Delay limited to max: {{ states[delay_seconds_helper].state }}"
+          - alias: "Log new delay"
+            if:
+              - condition: template
+                value_template: "{{ debug_mode == true  }}"
+            then:
+              - service:  logbook.log
+                data:
+                  name: "New delay"
+                  message: "New delay is {{ states[delay_seconds_helper].state }} seconds"
           - stop: "Motion detected during notice period."
       - service: logbook.log
         data:
@@ -262,7 +455,33 @@ action:
             service: input_number.set_value
             data:
               entity_id: !input delay_seconds_helper
-              value: "{{ states[delay_seconds].state | int * 2 }}"
+              value: "{{ states[delay_seconds_helper].state | int * delay_seconds_multiplier }}"
+          - alias: "Limit delay seconds to its defined maximum"
+            if:
+              - condition: template
+                value_template: "{{ states[delay_seconds_helper].state | int > delay_seconds_max | int }}"
+            then:
+              - service: input_number.set_value
+                data:
+                  entity_id: !input delay_seconds_helper
+                  value: "{{ delay_seconds_max | int }}"
+              - if:
+                - condition: template
+                  value_template: "{{ debug_mode == true  }}"
+                then:
+                  - service: logbook.log
+                    data:
+                      name: "Limiting delay seconds"
+                      message: "Delay limited to max: {{ states[delay_seconds_helper].state }}"
+          - alias: "Log new delay seconds"
+            if:
+              - condition: template
+                value_template: "{{ debug_mode == true  }}"
+            then:
+              - service: logbook.log
+                data:
+                  name: "New delay seconds"
+                  message: "New delay is {{ states[delay_seconds_helper].state }} seconds."
           - stop: "Motion detected during the warning period."
       - service: logbook.log
         data:
@@ -275,20 +494,32 @@ action:
       # Maybe turn on the "On" scene just before the "Off" scene, if the user enabled this option
       - if:
         - condition: template
-          value_template: "{{ on_just_before_off == true  }}"
+          value_template: "{{ on_just_before_off_seconds > 0 }}"
         then:
-          - alias: "Do a debug log"
-            enabled: false
-            service: logbook.log
-            data:
-              name: "DEBUG: Will turn on before off?"
-              message: "Yes, will turn on just before off!"
+          - alias: "Log the number of on-before-off seconds"
+            if:
+              - condition: template
+                value_template: "{{ debug_mode == true }}"
+            then:
+              service: logbook.log
+              data:
+                name: "On-Before-Off seconds"
+                message: "Will turn on for {{ on_just_before_off_seconds  }} seconds before off."
           - service: scene.turn_on
             target:
               entity_id: !input scene_on
           - alias: "Wait a second to set the \"On\" scene."
             delay:
-              seconds: 1
+              seconds: "{{ on_just_before_off_seconds  }}"
+        else:
+          - if:
+            - condition: template
+              value_template: "{{ debug_mode == true }}"
+            then:
+              - service: logbook.log
+                data:
+                  name: "Won't run on-before-off"
+                  message: "Won't run on-before-off because seconds was less than 1"
 
       - parallel:
         - alias: "Activate Scene: Off (Done)"