Integration to add battery notes to a device, with automatic discovery via a growing battery library for devices.
Track both the battery type and also when the battery was replaced.

Please ⭐ this repo if you find it useful

This integration will set up the following platforms.

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"

battery_notes:

On the "Configuration" -> "Integrations" -> "Battery Notes" screen add a new device, pick your device with a battery and add the battery type. The battery type will then be displayed as a diagnostic sensor on the device.

• Does a device have to be in the library?
  No, you can always add a device manually by going to Settings -> Integrations -> Battery Notes screen add a new device where you can enter the battery details manually.

• Why is my device not being discovered?
  It could be missing from the library or does not exactly match the name that your integration has. ZHA and Z2M for example have different manufacturers/models for the same device, you can still add it manually or contribute to the library.

• When is the library updated?
  It updates when Home Assistant is restarted and approximately every 24 hours after that.
  It will pull the latest devices that have been merged into the main branch, if you have recently submitted a pull request for a new device it will not appear until it has been manually reviewed and merged.

• How do I remove a battery note on a device?
  Go into the Settings -> Integrations -> Battery Notes, use the menu on the right of a device and select Delete, this will only delete the battery note, not the whole device.

• Why does the device icon change?
  Unfortunately where there are multiple integrations associated with a device Home Assistant seems to choose an icon at random, I have no control over this.

• Can I edit a battery note?
  Go into Settings -> Integrations -> Battery Notes and click Configure on the device you want to edit.

• Why am I only able to see some of my devices when adding manually?
  By default Battery Notes filters the device list to only devices with a battery, if you want to add a battery note to a random device then you can disable this filtering by adding the following configuration to your configuration.yaml and restart Home Assistant to see all devices.

battery_notes:
  show_all_devices: True

• I only want to add notes to a few devices, can I disable auto discovery?
  If you want to disable this functionality you can add the following to your configuration.yaml, after a restart of Home Assistant you will not see discovered battery notes.

battery_notes:
  enable_autodiscovery: False

• I don't want to track battery replacement, can I disable this?
  Yes, you can add the following to your configuration.yaml, after a restart of Home Assistant new devices added to battery notes will have the battery replaced sensor and button disabled. Any devices you have previously added to Battery Notes you will have to disable/enable these sensors manually, which also means you can just enable specific sensors of important ones you want to track.

battery_notes:
  enable_replaced: False

• How can I show my support?
  

To add a device definition to the battery library so that it will be automatically configured there are two options:

To add a new device via GitHub Issues, fill out this form. Upon submission of the issue, GitHub will attempt to make the required code changes automatically.

{
    "manufacturer": "Philips",
    "model": "Hue motion sensor (9290012607)",
    "battery_type": "AAA",
    "battery_quantity": 2
},

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

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.