Skip to content

Commit

Permalink
docs: 📔 added docs for megawatt hours
Browse files Browse the repository at this point in the history
  • Loading branch information
flixlix committed Aug 11, 2023
1 parent a5a2061 commit c528d98
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,13 @@ Else, if you prefer the graphical editor, use the menu to add the resource:
| energy_date_selection | `boolean` | true | If set to `true`, will follow the energy date picker (that is in the same dashboard) and get entities information from the statistics. |
| dashboard_link | `string` | | Shows a link to an Energy Dashboard. Should be a url path to location of your choice. If you wanted to link to the built-in dashboard you would enter `/energy` for example. |
| inverted_entities | `string` | | Comma seperated list of entities that should be inverted (negative for consumption and positive for production). Example: `inverted_entities: battery, grid` |
| kwh_decimals | `number` | 1 | Number of decimals rounded to when kilowatthours are displayed. |
| wh_decimals | `number` | 1 | Number of decimals rounded to when watthours are displayed. |
| kwh_decimals | `number` | 1 | Number of decimals rounded to when kilowatthours are displayed. |
| mwh_decimals | `number` | 1 | Number of decimals rounded to when megawatthours are displayed. |
| min_flow_rate | `number` | .75 | Represents how much time it takes for the quickest dot to travel from one end to the other in seconds. |
| max_flow_rate | `number` | 6 | Represents how much time it takes for the slowest dot to travel from one end to the other in seconds. |
| wh_kwh_threshold | `number` | 1000 | The number of watthours to display before converting to and displaying kilowatthours. Setting of 0 will always display in kilowatthours. |
| kwh_mwh_threshold | `number` | 1000 | The number of kilowatthours to display before converting to and displaying megawatthours. Setting of 0 will always display in megawatthours. |
| clickable_entities | `boolean` | false | If true, clicking on the entity will open the entity's more info dialog. |
| min_expected_energy | `number` | 0.01 | Represents the minimum amount of energy (in Watthours) expected to flow through the system at a given moment. Only used in the [New Flow Formula](#new-flow-formula). |
| max_expected_energy | `number` | 2000 | Represents the maximum amount of energy (in Watthours) expected to flow through the system at a given moment. Only used in the [New Flow Formula](#new-flow-formula). |
Expand Down

0 comments on commit c528d98

Please sign in to comment.