Skip to content

Commit

Permalink
Docs (#1147)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrew-codechimp authored Feb 22, 2024
1 parent 738f67f commit 7490dc0
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 6 deletions.
6 changes: 3 additions & 3 deletions docs/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ action:
mode: queued
```
### Check Battery Last Reported Daily (Beta Only)
### Check Battery Last Reported Daily
Call the check battery last reported service every day to raise events for those not reported in the last two days.
To be used in conjunction with a Battery Not Reported automation.
Expand All @@ -107,7 +107,7 @@ action:
mode: single
```
### Battery Not Reported (Beta Only)
### Battery Not Reported
Respond to events raised by the check_battery_last_reported service and create notifications.
```yaml
Expand Down Expand Up @@ -161,7 +161,7 @@ It is extended from the example Battery Low Notification automation yaml above f
This blueprint will automatically update the battery replaced sensor and custom actions to be performed when the battery increases.
It is extended from the example Battery Replaced automation yaml above for those who'd prefer an easy way to get started.
### Battery Not Reported (Beta Only)
### Battery Not Reported
[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)
This blueprint will allow notifications to be raised and/or custom actions to be performed when the battery not reported event is fired.
Expand Down
2 changes: 1 addition & 1 deletion docs/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ action:
mode: queued
```

## Battery Not Reported (Beta Only)
## Battery Not Reported
`battery_notes_battery_not_reported`

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.
Expand Down
10 changes: 10 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,15 @@ battery_notes:
enable_replaced: False
```

* How do I create a battery low template
The best way to do this is to test in the developer tools/template section for your sensor.
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.
```
{{ states('sensor.mysensor_battery_low') }}
{{ states('sensor.mysensor_battery_level') == "Low" }}
{{ states('sensor.mysensor_battery_voltage') | float(5) < 1 }}
```
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.

* How can I show my support?
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Once you have [installed the integration](https://github.com/andrew-codechimp/HA

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 (Beta Only)
## Battery Low Template
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.
You can specify a template that must return true when the battery is deemed low.

Expand Down
2 changes: 1 addition & 1 deletion docs/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ See how to use this service in the [community contributions](./community.md)
| `data.device_id` | `no` | The device id that you want to change the battery replaced date for. |
| `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. |

## battery_notes.check_battery_last_reported (Beta Only)
## battery_notes.check_battery_last_reported

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

Expand Down

0 comments on commit 7490dc0

Please sign in to comment.