Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
badguy99 authored Mar 26, 2020
1 parent 4c909d9 commit 55b2601
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,23 @@ The module and class sections need to remain as above, other sections should be
| start_period | Yes | today |
You can have multiple blocks with different time periods (`hour` setting) or starting points (`start_period` setting) as needed. It will work with whole hour or half hour blocks in the `hour` setting.

`region` is the region letter from the end of `E-1R-AGILE-18-02-21-H` which can be found on the [Octopus Energy developer dashboard](https://octopus.energy/dashboard/developer/) webpage in the Unit Rates section for your account.

`start_period` is optional, it can be set to either `now` or `today`, and will default to `now`

`now` and `today` give subtly different results. `now` is reevaluated ever time the callback is run (once every 30 minutes), and `today` uses a start time of 00:00:00 with today's date.

This means that using `today` you will get the absolute cheapest block for today, even if that is in the past, and using `now` will get the cheapest block for the remainder of the day. `today` may be of more use with automated triggers, and `now` may be of use when you are wanting to display the cheapest time on a Lovelace UI card and use that information to turn on devices which cannot be automated, by hand.

This may be best illustrated with a couple of pictures:

![State information with now start period](https://github.com/badguy99/octoblock/blob/master/StartTimeNow.PNG)

Using `now` start_period this has turned on and off a few times within the day as it is reevaluated as the day goes on

![State information with today start period](https://github.com/badguy99/octoblock/blob/master/StartTimeToday.PNG)

Using `today` start_period this has only turned on once during the day

### Home Assistant Automation
Expand Down

0 comments on commit 55b2601

Please sign in to comment.