https://github.com/andrew-codechimp/HA-Battery-Notes
A Home Assistant integration to provide battery notes of devices
https://github.com/andrew-codechimp/HA-Battery-Notes
hacktoberfest hacs hacs-integration home-assistant homeassistant homeassistant-custom-component homeassistant-integration
Last synced: 4 months ago
JSON representation
A Home Assistant integration to provide battery notes of devices
- Host: GitHub
- URL: https://github.com/andrew-codechimp/HA-Battery-Notes
- Owner: andrew-codechimp
- License: mit
- Created: 2023-08-17T13:02:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-28T13:01:55.000Z (4 months ago)
- Last Synced: 2024-10-29T17:28:38.168Z (4 months ago)
- Topics: hacktoberfest, hacs, hacs-integration, home-assistant, homeassistant, homeassistant-custom-component, homeassistant-integration
- Language: Python
- Homepage:
- Size: 4.99 MB
- Stars: 532
- Watchers: 4
- Forks: 92
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Battery Notes for Home Assistant
[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![Downloads][download-latest-shield]](Downloads)
[![License][license-shield]](LICENSE)
[![hacs][hacsbadge]][hacs]
Integration to add battery notes to a device or entity, with automatic discovery via a growing [battery library](library.md) for devices.
Track the battery type, when the battery was replaced, when a battery is low based on device or global thresholds and also when a battery hasn't been reported for a while.
A battery+ sensor provides useful attributes for easy use in dashboards, the standard battery can optionally be hidden.
Battery low, replaced and not reported are all via events and actions, you have the option of creating your own automations for these or using the predefined ones in [community](https://andrew-codechimp.github.io/HA-Battery-Notes/community).
*Please :star: this repo if you find it useful*
*If you want to show your support please*
[](https://www.buymeacoffee.com/codechimp)
## Installation
**Important**
Once you have installed battery notes using either HACS or manually as per the instructions below you must add the following entry to your `configuration.yaml`, then restart Home Assistant. This will enable discovery of your devices.
```
battery_notes:
```
If you need to add a device that is not automatically discovered from the library go to Settings -> Integrations click "+" and search for "Battery Notes"
### HACS Installation
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=andrew-codechimp&repository=HA-Battery-Notes&category=Integration)
Or
Search for `Battery Notes` in HACS and install it under the "Integrations" category.
### Manual Installation
More Details
* You should take the zip file from the latest [published release](https://github.com/andrew-codechimp/ha-battery-notes/releases).
* To install, place the contents of `custom_components` into the `/custom_components` folder of your Home Assistant installation.
* Add the following entry to your `configuration.yaml`
```
battery_notes:
```
* Restart Home Assistant
* In the HA UI go to Settings -> Integrations click "+" and search for "Battery Notes"
## Docs
To get full use of the integration, read the documentation. It contains community quick starts as well as details on all the actions, events and entities.
[](https://andrew-codechimp.github.io/HA-Battery-Notes/)
## Contributing to the Battery Library
[](https://github.com/andrew-codechimp/HA-Battery-Notes/issues/new?template=new_device_request.yml&title=[Device]%3A+)
To add a device definition to the battery library so that it will be automatically configured fill out the above form or see the [docs](https://andrew-codechimp.github.io/HA-Battery-Notes/library) for adding via pull request.
## Translations
To add a new language translation to Battery Notes see [here](https://andrew-codechimp.github.io/HA-Battery-Notes/translations)
## Contributions are welcome!
If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md).
## Acknowledgements
A lot of the inspiration for this integration came from the excellent [PowerCalc by bramstroker](https://github.com/bramstroker/homeassistant-powercalc), without adapting code from PowerCalc I'd never have worked out how to add additional sensors to a device.
Huge thanks to @bmos for creating the issue form & automations for adding new devices.
Thanks to everyone who has submitted devices to the library.
[battery_notes]: https://github.com/andrew-codechimp/HA-Battery-Notes
[commits-shield]: https://img.shields.io/github/commit-activity/y/andrew-codechimp/HA-Battery-Notes.svg?style=for-the-badge
[commits]: https://github.com/andrew-codechimp/HA-Battery-Notes/commits/main
[hacs]: https://github.com/hacs/integration
[hacsbadge]: https://img.shields.io/badge/HACS-Default-41BDF5.svg?style=for-the-badge
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[exampleimg]: example.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/t/custom-component-battery-notes/613821
[license-shield]: https://img.shields.io/github/license/andrew-codechimp/HA-Battery-Notes.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/andrew-codechimp/HA-Battery-Notes.svg?style=for-the-badge
[releases]: https://github.com/andrew-codechimp/HA-Battery-Notes/releases
[download-latest-shield]: https://img.shields.io/github/downloads/andrew-codechimp/ha-battery-notes/latest/total?style=for-the-badge