Skip to content

Commit 931e12d

Browse files
Grammar
1 parent be22810 commit 931e12d

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

docs/index.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,56 @@
11
# Battery Notes for Home Assistant
22

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

66
**Dashboard cards usage**
77

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

1010
**Notifications and automations**
1111

12-
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).
12+
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).
1313

14-
15-
*Please :star: this repo on [GitHub](https://github.com/andrew-codechimp/HA-Battery-Notes) if you find it useful*
16-
*If you want to show your support please*
14+
_Please :star: this repo on [GitHub](https://github.com/andrew-codechimp/HA-Battery-Notes) if you find it useful_
15+
_If you want to show your support please_
1716

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

20-
2119
## Features
2220

2321
The integration will add additional diagnostic entities to your device.
2422

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

27-
* [Entities](./entities.md)
28-
* [Actions](./actions.md)
29-
* [Events](./events.md)
25+
- [Entities](./entities.md)
26+
- [Actions](./actions.md)
27+
- [Events](./events.md)
3028

3129
## How to use Battery Notes
30+
3231
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.
3332

3433
![device discovery](./assets/screenshot-discovery.png)
3534

3635
## To add a battery note manually
37-
* Go to Settings/Integrations and click Add Integration.
38-
* Select Battery Notes.
39-
* 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.
40-
* Choose your device or entity from the drop down and click next.
41-
* Enter the battery type and quantity and optionally a battery low threshold and click submit.
36+
37+
- Go to Settings/Integrations and click Add Integration.
38+
- Select Battery Notes.
39+
- 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.
40+
- Choose your device or entity from the drop down and click next.
41+
- Enter the battery type and quantity and optionally a battery low threshold and click submit.
4242

4343
!!! info
4444

4545
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.
4646

4747
## Battery Low Template
48+
4849
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.
49-
You can specify a template that must return true when the battery is deemed low.
50+
You can specify a template that must return true when the battery is deemed low.
51+
52+
Example templates
5053

51-
Example templates
5254
```
5355
{{ states('sensor.mysensor_battery_low') }}
5456
{{ states('sensor.mysensor_battery_level') == "Low" }}
@@ -57,18 +59,17 @@ Example templates
5759

5860
!!! info
5961

60-
If a template is specified then the battery percentage will be ignored when evaluating threshold and increased events.
62+
If a template is specified then the battery percentage will be ignored when evaluating threshold and increased events.
6163

6264
## Filter Outliers
63-
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.
65+
66+
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.
6467
If you switch this on for a device then that devices battery low events will be delayed until it has three consistently low states.
6568

6669
## Community Contributions
6770

68-
A collection of community contributions can be found on the [community contributions](./community.md) page.
69-
71+
A collection of community contributions can be found on the [community contributions](./community.md) page.
7072

7173
## FAQ
7274

7375
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.
74-

0 commit comments

Comments
 (0)