Skip to content

Commit

Permalink
docs: add state_of_charge options
Browse files Browse the repository at this point in the history
  • Loading branch information
flixlix authored May 29, 2023
1 parent 205f58f commit 62c7499
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,9 @@ At least one of _grid_, _battery_, or _solar_ is required. All entites (except _
| ----------- | ------- | -------- | ------------------------------------------------------------------------------------------------- |
| entity | `object` | `undefined` required | Object containing `production` and/or `consumption` properties with an Entity ID of a sensor supporting a state with positive values. Check [split entites](#split-entities) for more info. |
| state_of_charge | `string` | `undefined` required | Entity ID providing a state with the state of charge of the battery in percent (state of `100` for a full battery). |
| state_of_charge_unit | `string` | `%` | Unit of the state of charge. |
| state_of_charge_unit_white_space | `boolean` | `true` | If set to `false`, the unit of the state of charge will not have a white space in front of it. |
| state_of_charge_decimals | `number` | `0` | Number of decimals to show for the state of charge. |
| name | `string` | `Battery` | Label for the battery option. If you don't populate this option, the label will continue to update based on the language selected. |
| icon | `string` | `mdi:battery` or dynamic based on state of the battery | Icon path for the icon inside the Battery Circle. |
| color | `object` | | Check [Color Objects](#color-object) for more information. |
Expand Down

0 comments on commit 62c7499

Please sign in to comment.