Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-codechimp authored Dec 31, 2023
1 parent 16c4cbe commit 8d29c66
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![BuyMeACoffee](https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee&style=for-the-badge)](https://www.buymeacoffee.com/codechimp)


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

*Please :star: this repo if you find it useful*
Expand Down Expand Up @@ -73,7 +73,7 @@ The battery type will then be displayed as a diagnostic sensor on the device.
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.
It could be missing from the [library](library.md) 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.
Expand Down Expand Up @@ -129,7 +129,6 @@ Do not enable GitHub Actions (disabled by default) on your fork as this will mes

* The manufacturer and model should be exactly what is displayed on the Device screen within Home Assistant.
* The make & model names may be different between integrations such as Zigbee2MQTT and ZHA, if you see a similar device please duplicate the entry rather than changing it.
* Please keep devices in alphabetical order by manufacturer/model.
* The `battery_quantity` data is numeric (no quotes) and optional. If a device only requires a single battery, it should be omitted.
* The `battery_type` data should follow the most common naming for general batteries (ex. AAA, D) and the IEC naming for battery cells (ex. CR2032, 18650) according to [Wikipedia](https://en.wikipedia.org/wiki/List_of_battery_sizes)
* If a device has a bespoke rechargeable battery you can use `"battery_type": "Rechargeable"`
Expand Down

0 comments on commit 8d29c66

Please sign in to comment.