Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davedupplaw/ha-battery
Lovelace card for showing home battery SOC
https://github.com/davedupplaw/ha-battery
hacs home-assistant lovelace
Last synced: 1 day ago
JSON representation
Lovelace card for showing home battery SOC
- Host: GitHub
- URL: https://github.com/davedupplaw/ha-battery
- Owner: davedupplaw
- License: mit
- Created: 2024-04-22T16:34:19.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-04-25T14:51:32.000Z (7 months ago)
- Last Synced: 2024-04-25T20:04:16.602Z (7 months ago)
- Topics: hacs, home-assistant, lovelace
- Language: TypeScript
- Homepage:
- Size: 229 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Home Assistant Lovelace Battery Entity Card
[](https://github.com/hacs/integration)
This card is a custom lovelace entity card for Home Assistant that displays the state of a battery, including
the state of charge (SOC), discharge and charge power.
It's currently in a pretty early stage and it's my first foray into HA card creation, so it's a bit rough around the
edges and there's plenty to do.
## Installation
Can be installed via HACS by adding the repository URL to the custom repositories in HACS.
## Options
| Name | Type | Default | Description |
|----------------------|---------|--------------|--------------------------------------------------------------------------------------------------------------------|
| socEntity | sensor | **required** | The sensor that provides the state of charge of the battery in percentage |
| kWhEntity | sensor | | The sensor that provides the state of charge of the battery in kWh |
| dischargeWEntity | sensor | | The sensor that provides the discharge power of the battery in W. Use instead of the combined sensor. |
| chargeWEntity | sensor | | The sensor that provides the charge power of the battery in W. Use instead of the combined sensor. |
| combinedWEntity | sensor | | The sensor that provides a charge/discharge power (negative for discharge) in W. Use instead of the above sensors. |
| sizePx | number | 200 | The preferred height of the card in pixels |
| colours | string | | The colours to use for the battery states. See below for details |
| showSocInBattery | boolean | true | Whether to show the state of charge % in the battery itself |
| showSocLabel | boolean | true | Whether to show the state of charge underneath the battery |
| showChargeIndicators | boolean | true | Whether to show the small flashing triangular charge indicators in the battery |
### Battery State Colours
The colour option is a string that defines the colours to use for the battery states.
It's a comma separated list of pairs, where the pair is separated by a colon. The first
part of the pair is the maximum value that the colour will be shown, while the second
part of the pair is colour to show.
For example:
```
25:#aa0000
```
represents that a red colour (#aa0000) will be shown when the SOC is less than 25%.
The order is important and needs to be from lowest to highest.
The default is `25:#aa0000,50:#ffaa00,100:#008800` which represents
red up to 25%, orange up to 50% and green up to 100%.
## TODO:
* Add toggle options for some of the display elements
* Add option to have charge cable on the right or discharge cable on left
* Add colour configuration
* i18n
* Add sources/sinks for charge/discharge
## Credits
The original battery image is public domain sourced here https://freesvg.org/three-battery-levels
Also a shout out to the tutorials by Elmar Hinz which have been very useful: https://github.com/home-assistant-tutorials