Skip to content

A Home Assistant integration to provide battery notes of devices

License

Notifications You must be signed in to change notification settings

JeffersonBledsoe/HA-Battery-Notes

 
 

Repository files navigation

Battery Notes for Home Assistant

GitHub Release GitHub Activity Downloads License hacs

Integration to add battery notes to a device, with automatic discovery via a growing battery library for devices.
Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds.
A battery+ sensor provides useful attributes for easy use in dashboards, the standard battery can optionally be hidden.

Please ⭐ this repo if you find it useful
If you want to show your support please

"Buy Me A Coffee"

Battery Notes

Discovery

Installation

HACS

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Or Search for Battery Notes in HACS and install it under the "Integrations" category.

Important

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"

Manual Installation

More Details
  • You should take the latest published release.
  • To install, place the contents of custom_components into the <config directory>/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, please visit the docs.

Contributing to the Battery Library

"New Device Request"

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 for adding via pull request.

Translations

To add a new language translation to Battery Notes see here

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines.

Acknowledgements

A lot of the inspiration for this integration came from the excellent PowerCalc by bramstroker, 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.

About

A Home Assistant integration to provide battery notes of devices

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.2%
  • Shell 0.8%