You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+23-22Lines changed: 23 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,54 +1,56 @@
1
1
# Battery Notes for Home Assistant
2
2
3
3
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.
5
5
6
6
**Dashboard cards usage**
7
7
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.
9
9
10
10
**Notifications and automations**
11
11
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).
13
13
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_
17
16
18
17
[](https://www.buymeacoffee.com/codechimp)
19
18
20
-
21
19
## Features
22
20
23
21
The integration will add additional diagnostic entities to your device.
24
22
25
23

26
24
27
-
*[Entities](./entities.md)
28
-
*[Actions](./actions.md)
29
-
*[Events](./events.md)
25
+
-[Entities](./entities.md)
26
+
-[Actions](./actions.md)
27
+
-[Events](./events.md)
30
28
31
29
## How to use Battery Notes
30
+
32
31
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.
* 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.
42
42
43
43
!!! info
44
44
45
45
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.
46
46
47
47
## Battery Low Template
48
+
48
49
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.
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.
61
63
62
64
## 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.
64
67
If you switch this on for a device then that devices battery low events will be delayed until it has three consistently low states.
65
68
66
69
## Community Contributions
67
70
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.
70
72
71
73
## FAQ
72
74
73
75
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 commit comments