Skip to content

Battery Notes for Home Assistant#

Integration to add battery notes to a device or entity, with automatic discovery via a growing battery library 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.
Battery low, replaced and not reported are all via events and services, you have the option of creating your own automations for these or using the predefined ones in community.

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

"Buy Me A Coffee"

Features#

The integration will add additional diagnostic entities to your device.

device example

How to use Battery Notes#

Once you have installed the integration you will hopefully have some devices discovered and you can follow the Notification to confirm their details and add them, if you don't have devices discovered you can add them manually.

device discovery

To add a battery note manually#

  • Go to Settings/Integrations and click Add Integration.
  • Select Battery Notes.
  • Choose Device or Entity and click next. Device will automatically detect a battery and will work for most common devices, you should use entity if your device has multiple batteries or when an entity does not have a device.
  • Choose your device or entity from the drop down and click next.
  • Enter the battery type and quantity and optionally a battery low threshold and click submit.

Info

The library is updated automatically with new devices approximately every 24 hours from starting Home Assistant, if you have added a device to the library using this form then this will take about a day to be discovered once it's approved and added.

Battery Low Template#

This is for advanced use where a device does not have a typical battery percentage (or it is innacurate) but still provides an indication of the level, such as a string, boolean or voltage.
You can specify a template that must return true when the battery is deemed low.

Example templates

{{ states('sensor.mysensor_battery_low') }}
{{ states('sensor.mysensor_battery_level') == "Low" }}
{{ states('sensor.mysensor_battery_voltage') | float(5) < 1 }}

Info

If a template is specified then the battery percentage will be ignored when evaluating threshold and increased events.

Community Contributions#

A collection of community contributions can be found on the community contributions page.

FAQ#

Before raising anything, please read through the faq. If you have questions, then you can raise a discussion. If you have found a bug or have a feature request please raise it using the appropriate report template.