diff --git a/README.md b/README.md index 9eee413..d75052e 100644 --- a/README.md +++ b/README.md @@ -4,23 +4,25 @@ I created my own script and automation to bypass the frustations above. It is no ![image|690x196](images/demo.png) -The second component is an blueprint that executes the script 3 times in series with different values for each execution. +The second component is an automation that executes the script 3 times in series with different values for each execution. -## Detailed Explaination of Script Blueprint -The script expects to be kicked off with parameters defined. For the script to work, the target light needs to be and set to starting Kelvin values. The starting brightnes is always 1%. The automation blueprint handles the inital turning on of the light. The kelvin value of the light will be used as the starting value. +## Detailed Explaination of Script +The script expects to be kicked off with parameters defined. For the script to work, the target light needs to be and set to starting Kelvin values. The starting brightnes is always 1%. The automation handles the inital turning on of the light. The kelvin value of the light will be used as the starting value. If you turn off the light at any point while the script is running, the script and blueprint will end. The script also allows for defining how long to take to get from start to finish values and how many steps per minute to take to get there. The script will also turn off the light after the 'Light Timeout' period. Setting this value to 0 will disable the timeout, and this is how you can chain executions of the script together to get the desired parabolic curve effect. -## Detailed Explaination of Bluebrint +## Detailed Explaination of Automation -The bluebrint is much simpler. Execute the script 3 to get the desired parabolic curve. All executions of the script (except for the last one) have the 'Light Timeout' set to 0 so that the script will continue from current values. It also checks light is off (for all executions but the first one) so that if you turn the light off, the subsequent executions of the script in the currently running automation will not turn it back on. +The automation is much simpler. Execute the script 3 to get the desired parabolic curve. All executions of the script (except for the last one) have the 'Light Timeout' set to 0 so that the script will continue from current values. It also checks light is off (for all executions but the first one) so that if you turn the light off, the subsequent executions of the script in the currently running automation will not turn it back on. When setting up start time for the trigger you will need to take into account when you want it to finish. In my example below I want it to finish by 7:00 am, so I do the math backwards and start it at 6:35. The total time is solved by adding up all the 'Alarm Length' fields of all executions of the script. In my automation I'm using the Workday Integration and its binary sensor to only execute on days I have configured in that integration. ## Installation -1. Copy and paste the script as is into a new script on your system when editing in YAML mode. -1. Import the blueprint \ No newline at end of file +1. Import the script blueprint +1. Create a script from the script blueprint (Only needs to be done once. Can be reused in many automations) +1. Import the automation blueprint +1. Create the automation from the automation blueprint and use the script created above in the automation \ No newline at end of file