Skip to content

Commit 9e3666b

Browse files
Update docs
1 parent 7ed921b commit 9e3666b

File tree

1 file changed

+42
-21
lines changed

1 file changed

+42
-21
lines changed

docs/faq.md

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,85 @@
11
# FAQ
22

3-
## Does a device have to be in the library?
3+
## Does a device have to be in the library?
4+
45
No, you can always add a device manually by going to Settings -> Integrations -> Battery Notes screen add a new device where you can enter the battery details manually.
56

6-
## Why is my device not being discovered?
7-
It could be missing from the [library](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/library.md) or does not exactly match the name that your integration has. ZHA and Z2M for example have different manufacturers/models for the same device, you can still add it manually or contribute to the library.
7+
## Why is my device not being discovered?
8+
9+
It could be missing from the [library](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/library.md) or does not exactly match the name that your integration has. ZHA and Z2M for example have different manufacturers/models for the same device, you can still add it manually or contribute to the library.
10+
11+
## When is the library updated?
812

9-
## When is the library updated?
1013
It updates when Home Assistant is restarted and approximately every 24 hours after that.
1114
It will pull the latest devices that have been merged into the main branch, if you have recently submitted a pull request for a new device it will not appear until it has been manually reviewed and merged.
1215

13-
## How do I remove a battery note on a device?
16+
## How do I remove a battery note on a device?
17+
1418
Go into the Settings -> Integrations -> Battery Notes, use the menu on the right of a device and select Delete, this will only delete the battery note, not the whole device.
1519

16-
## Can I edit a battery note?
20+
## Can I edit a battery note?
21+
1722
Go into Settings -> Integrations -> Battery Notes and click Configure on the device you want to edit.
1823

19-
## Why am I only able to see some of my devices when adding manually?
24+
## Why am I only able to see some of my devices when adding manually?
25+
2026
By default Battery Notes filters the device list to only devices with a battery, if you want to add a battery note to a random device then you can disable this filtering by adding the following configuration to your `configuration.yaml` and restart Home Assistant to see all devices.
27+
2128
```
2229
battery_notes:
2330
show_all_devices: True
2431
```
2532

26-
## I only want to add notes to a few devices, can I disable auto discovery?
33+
## I only want to add notes to a few devices, can I disable auto discovery?
34+
2735
If you want to disable this functionality you can add the following to your `configuration.yaml`, after a restart of Home Assistant you will not see discovered battery notes.
36+
2837
```
2938
battery_notes:
3039
enable_autodiscovery: False
3140
```
3241

33-
## I don't want to track battery replacement, can I disable this?
34-
Yes, you can add the following to your `configuration.yaml`, after a restart of Home Assistant *new* devices added to battery notes will have the battery replaced sensor and button disabled. Any devices you have previously added to Battery Notes you will have to disable/enable these sensors manually, which also means you can just enable specific sensors of important ones you want to track.
42+
## I don't want to track battery replacement, can I disable this?
43+
44+
Yes, you can add the following to your `configuration.yaml`, after a restart of Home Assistant _new_ devices added to battery notes will have the battery replaced sensor and button disabled. Any devices you have previously added to Battery Notes you will have to disable/enable these sensors manually, which also means you can just enable specific sensors of important ones you want to track.
45+
3546
```
3647
battery_notes:
3748
enable_replaced: False
3849
```
3950

40-
## My device doesn't show a Battery+ sensor
51+
## My device doesn't show a Battery+ sensor
52+
4153
This is usually because the device does not have a battery percentage, you can create one if your device has a voltage, low indicator or similar by following [these instructions](entities.md/#adding-a-battery-percentage)
4254

55+
## My device has is not picking up the proper battery percentage for Battery+
56+
57+
If your device has a different percentage, perhaps a max charge indicator Battery Notes cannot identify the correct battery percentage to monitor. You can either hide the entity you want Battery+ to ignore or you can remove the Battery Notes device, then re-add as an Entity Association Type manually and choose the correct battery percentage.
58+
59+
## How do I create a battery low template
4360

44-
## How do I create a battery low template
4561
The best way to do this is to test in the developer tools/template section for your sensor.
46-
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.
62+
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.
63+
4764
```
4865
{{ states('sensor.mysensor_battery_low') }}
4966
{{ states('sensor.mysensor_battery_level') == "Low" }}
5067
{{ states('sensor.mysensor_battery_voltage') | float(5) < 1 }}
5168
```
69+
5270
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.
5371

5472
## My Shelly device is not showing a Battery+
55-
There seems to have been an issue with the Shelly integration at some point where the battery entity was not created properly and therefore Battery Notes cannot find it. To fix this do the following:
56-
* Remove the battery note from the Shelly device
57-
* Remove the Shelly device from the Shelly integration
58-
* Re-Add the Shelly device
59-
* Add the battery note to the device
6073

74+
There seems to have been an issue with the Shelly integration at some point where the battery entity was not created properly and therefore Battery Notes cannot find it. To fix this do the following:
75+
76+
- Remove the battery note from the Shelly device
77+
- Remove the Shelly device from the Shelly integration
78+
- Re-Add the Shelly device
79+
- Add the battery note to the device
80+
81+
## How do I install pre-release versions via HACS
6182

62-
## How do I install pre-release versions via HACS
6383
Within Home Assistant go to Settings -> Integrations -> HACS
6484
Select Services
6585
Select Battery Notes
@@ -69,7 +89,8 @@ Select the cog icon
6989
Select Enable
7090
Select Update and wait for the entity to be enabled
7191
Turn on the Pre-release toggle
72-
HACS will now show updates available for pre-releases if there are any
92+
HACS will now show updates available for pre-releases if there are any
93+
94+
## How can I show my support?
7395

74-
## How can I show my support?
7596
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png)](https://www.buymeacoffee.com/codechimp)

0 commit comments

Comments
 (0)