Skip to content

Commit

Permalink
Grammar
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-codechimp committed Feb 27, 2025
1 parent be22810 commit 931e12d
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,54 +1,56 @@
# Battery Notes for Home Assistant

Integration to add battery notes to a device or entity, with automatic discovery via a growing [battery library](library.md) 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.
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.

**Dashboard cards usage**

A battery+ sensor provides useful attributes for easy use in dashboards, the standard battery can optionally be hidden.
A battery+ sensor provides useful attributes for easy use in dashboards, the standard battery can optionally be hidden.

**Notifications and automations**

Battery low, replaced and not reported are all exposed via events and actions, using these you can create your own automations to generate notifications or other actions, there are some predefined ones in [community](https://andrew-codechimp.github.io/HA-Battery-Notes/community).
Battery low, replaced and not reported are all exposed via events and actions, using these you can create your own automations to generate notifications or other actions, there are some predefined ones in [community](https://andrew-codechimp.github.io/HA-Battery-Notes/community).


*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*
_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_

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)


## Features

The integration will add additional diagnostic entities to your device.

![device example](./assets/screenshot-device.png)

* [Entities](./entities.md)
* [Actions](./actions.md)
* [Events](./events.md)
- [Entities](./entities.md)
- [Actions](./actions.md)
- [Events](./events.md)

## How to use Battery Notes

Once you have [installed the integration](https://github.com/andrew-codechimp/HA-Battery-Notes#installation) 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](./assets/screenshot-discovery.png)

## 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.

- 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](https://github.com/andrew-codechimp/HA-Battery-Notes/issues/new?template=new_device_request.yml&title=[Device]%3A+) 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 battery low boolean (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.
You can specify a template that must return true when the battery is deemed low.

Example templates

Example templates
```
{{ states('sensor.mysensor_battery_low') }}
{{ states('sensor.mysensor_battery_level') == "Low" }}
Expand All @@ -57,18 +59,17 @@ Example templates

!!! info

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

## Filter Outliers
This is for advanced use when a device occasionally erroneously reports a very low battery level occasionally before going back to it's true value, which causes battery low events to be raised.

This is for advanced use when a device occasionally erroneously reports a very low battery level before going back to its true value, which causes battery low events to be raised.
If you switch this on for a device then that devices battery low events will be delayed until it has three consistently low states.

## Community Contributions

A collection of community contributions can be found on the [community contributions](./community.md) page.

A collection of community contributions can be found on the [community contributions](./community.md) page.

## FAQ

Before raising anything, please read through the [faq](./faq.md). If you have questions, then you can raise a [discussion](https://github.com/andrew-codechimp/HA-Battery-Notes/discussions). If you have found a bug or have a feature request please [raise it](https://github.com/andrew-codechimp/HA-Battery-Notes/issues) using the appropriate report template.

0 comments on commit 931e12d

Please sign in to comment.