Skip to content

Commit

Permalink
Merge pull request #410 from deployHuman/master
Browse files Browse the repository at this point in the history
Add Explanation for all the extra attributes
  • Loading branch information
Hellowlol authored Nov 11, 2024
2 parents 4421fd3 + 9d27343 commit 61f121f
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,30 @@ Add 21% tax and overhead cost stored in a helper

## Other

### Extra state attributes

- ```average```: An average of every today
- ```off_peak_1```: Off peak 1 refers to the average price of the time period from midnight to 8am
- ```off_peak_2```: Off peak 2 refers to the average price of the time period from 8pm to midnight
- ```peak```: Peak refers to the average price of the period from 8am to 8pm
- ```min```: Lowest value today
- ```max```: Highest value today
- ```mean```: Actually just median of all values
- ```unit```: what that of Unit, eg: kWh
- ```currency```: What type of Currency
- ```country```: What Country data is fetched for
- ```region```: The specific region of prices
- ```low_price```: If price is below low_price_threshold
- ```price_percent_to_average```:
- ```today```: List of all values
- ```tomorrow```: list of all values
- ```tomorrow_valid```: If tomorow´s values is in yet
- ```raw_today```: Array of all values
- ```raw_tomorrow```: Array of values
- ```current_price```: What the current price is
- ```additional_costs_current_hour```: If there is any additional costs this hour
- ```price_in_cents```: Boolean if prices is in cents

### One sensor per hour

By default, one sensor is created with the current energy price. The prices for other hours are stored in the attributes of this sensor. Most example code you will find uses the default one sensor option, but you can run the `create_template` script to create separate sensors for every hour. See the help options with ```python create_template --help```. You can run the script on any system where Python is installed (install the required packages `pyyaml` and `click` using `pip install pyyaml click`)
Expand Down

0 comments on commit 61f121f

Please sign in to comment.