Skip to content

Commit 7490dc0

Browse files
Docs (#1147)
1 parent 738f67f commit 7490dc0

File tree

5 files changed

+16
-6
lines changed

5 files changed

+16
-6
lines changed

docs/community.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ action:
8989
mode: queued
9090
```
9191
92-
### Check Battery Last Reported Daily (Beta Only)
92+
### Check Battery Last Reported Daily
9393
Call the check battery last reported service every day to raise events for those not reported in the last two days.
9494
To be used in conjunction with a Battery Not Reported automation.
9595
@@ -107,7 +107,7 @@ action:
107107
mode: single
108108
```
109109
110-
### Battery Not Reported (Beta Only)
110+
### Battery Not Reported
111111
Respond to events raised by the check_battery_last_reported service and create notifications.
112112
113113
```yaml
@@ -161,7 +161,7 @@ It is extended from the example Battery Low Notification automation yaml above f
161161
This blueprint will automatically update the battery replaced sensor and custom actions to be performed when the battery increases.
162162
It is extended from the example Battery Replaced automation yaml above for those who'd prefer an easy way to get started.
163163
164-
### Battery Not Reported (Beta Only)
164+
### Battery Not Reported
165165
[Install blueprint](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fraw.githubusercontent.com%2Fandrew-codechimp%2FHA-Battery-Notes%2Fmain%2Fdocs%2Fblueprints%2Fbattery_notes_battery_not_reported.yaml) | [Source](./blueprints/battery_notes_battery_not_reported.yaml)
166166
167167
This blueprint will allow notifications to be raised and/or custom actions to be performed when the battery not reported event is fired.

docs/events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ action:
106106
mode: queued
107107
```
108108

109-
## Battery Not Reported (Beta Only)
109+
## Battery Not Reported
110110
`battery_notes_battery_not_reported`
111111

112112
This is fired from the [check_battery_last_reported](./services/check_battery_last_reported) service call for each device that has not reported its battery level for the number of days specified in the service call.

docs/faq.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,5 +40,15 @@ battery_notes:
4040
enable_replaced: False
4141
```
4242

43+
* How do I create a battery low template
44+
The best way to do this is to test in the developer tools/template section for your sensor.
45+
Be aware that Home Assistant shows friendly alternatives for some sensors, so when you are seeing Normal/Low this may really be a bool, testing in the template tool will allow you to determine the correct template to use. Start by adapting one of these.
46+
```
47+
{{ states('sensor.mysensor_battery_low') }}
48+
{{ states('sensor.mysensor_battery_level') == "Low" }}
49+
{{ states('sensor.mysensor_battery_voltage') | float(5) < 1 }}
50+
```
51+
Once you have got your template correct you can copy/paste it into the battery notes configuration section for that device and it will use that for detecting the battery is low and raising the battery notes event.
52+
4353
* How can I show my support?
4454
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Once you have [installed the integration](https://github.com/andrew-codechimp/HA
3434

3535
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.
3636

37-
## Battery Low Template (Beta Only)
37+
## Battery Low Template
3838
This is for advanced use where a device does not have a typical battery percentage (or it is innacurate) but still provides an indication of the level, such as a string, boolean or voltage.
3939
You can specify a template that must return true when the battery is deemed low.
4040

docs/services.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ See how to use this service in the [community contributions](./community.md)
1111
| `data.device_id` | `no` | The device id that you want to change the battery replaced date for. |
1212
| `data.datetime_replaced` | `yes` | The optional datetime that you want to set the battery replaced to, if omitted the current date/time will be used. |
1313

14-
## battery_notes.check_battery_last_reported (Beta Only)
14+
## battery_notes.check_battery_last_reported
1515

1616
For raising events for devices that haven't reported their battery level.
1717

0 commit comments

Comments
 (0)