Skip to content

Commit

Permalink
πŸ“š Some corrections to README
Browse files Browse the repository at this point in the history
πŸ“š Some corrections to README
  • Loading branch information
TheFes authored Apr 20, 2023
2 parents 5d09061 + def10f7 commit 6fc7610
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ sensor, hours, start, end, time_key, value_key, include_today, include_tomorrow,
|`end`|string|`none`|"23:00"|End time to take into consideration for the value selection, if `include_tomorrow` is set to `true` this will be the time tomorrow|
|`value_key`|string|`"start"`|`"datetime"`|The key used in the attributes of your integration for the start times of the hours|
|`value_key`|string|`"value"`|`"price"`|The key used in the attributes of your integration for the price values|
|`include today`|boolean|`true`|`false`|Boolean to select if todays values should be included|
|`include tomorrow`|boolean|`false`|`true`|Boolean to select if tomorrows values should be included|
|`include_today`|boolean|`true`|`false`|Boolean to select if todays values should be included|
|`includ_tomorrow`|boolean|`false`|`true`|Boolean to select if tomorrows values should be included|
|`lowest`|boolean|`true`|`false`|Boolean to select if the marco should find the lowest price, set to `false` to find the highest price|
|`mode`|string|`"start"`|`"average"`|You can choose what to output, these values are accepted: 'min' (lowest price in hours found), 'max' (highest price in hours found), 'average' (average price in hours found), 'start' (start of the hours found), 'end' (end of the hours found), 'list' (list with the prices in hours found)|
|`mode`|string|`"start"`|`"average"`|You can choose what to output, these values are accepted: `min` (lowest price in hours found), `max` (highest price in hours found), `average` (average price in hours found), `start` (start of the hours found), `end` (end of the hours found), `list` (list with the prices in hours found)|
|`top_hour`|integer|1|2|The most important hour in your hour range. Eg if hour device uses most energy in the 2nd hour, you can set this to `2` to give more weight to that energy price|
|`hour_weight`|float|2|2.5|The weight to add to the `top_hour` setting. If no `top_hour` is provided all hours have equal weight, when a `top_hour` is provided the default for this setting is `2`. Values below `1` will decrease the weight of the selected `top_hour`|

Expand Down

0 comments on commit 6fc7610

Please sign in to comment.