Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-codechimp committed Feb 25, 2024
1 parent fcbb72f commit 63c9e65
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@
[![hacs][hacsbadge]][hacs]

Integration to add battery notes to a device, with automatic discovery via a growing [battery library](library.md) for devices.
Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds.
Track the battery type, when the battery was replaced, when a battery is low based on device or global thresholds and also when a device hasn't reported a battery 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 services, 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.md).

*Please :star: this repo if you find it useful*
*If you want to show your support please*

Expand Down
3 changes: 2 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Battery Notes for Home Assistant

Integration to add battery notes to a device, with automatic discovery via a growing [battery library](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/library.md) for devices.
Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds.
Track the battery type, when the battery was replaced, when a battery is low based on device or global thresholds and also when a device hasn't reported a battery 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](./community.md).

*Please :star: this repo on [GitHub](https://github.com/andrew-codechimp/HA-Battery-Notes) if you find it useful*
*If you want to show your support please*
Expand Down

0 comments on commit 63c9e65

Please sign in to comment.