Skip to content

Commit 8e61f45

Browse files
Update faq.md
1 parent 79d37b7 commit 8e61f45

File tree

1 file changed

+23
-11
lines changed

1 file changed

+23
-11
lines changed

docs/faq.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
11
# FAQ
22

3-
* Does a device have to be in the library?
3+
## Does a device have to be in the library?
44
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.
55

6-
* Why is my device not being discovered?
6+
## Why is my device not being discovered?
77
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.
88

9-
* When is the library updated?
9+
## When is the library updated?
1010
It updates when Home Assistant is restarted and approximately every 24 hours after that.
1111
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.
1212

13-
* How do I remove a battery note on a device?
13+
## How do I remove a battery note on a device?
1414
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.
1515

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

19-
* Why am I only able to see some of my devices when adding manually?
19+
## Why am I only able to see some of my devices when adding manually?
2020
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.
2121
```
2222
battery_notes:
2323
show_all_devices: True
2424
```
2525

26-
* I only want to add notes to a few devices, can I disable auto discovery?
26+
## I only want to add notes to a few devices, can I disable auto discovery?
2727
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.
2828
```
2929
battery_notes:
3030
enable_autodiscovery: False
3131
```
3232

33-
* I don't want to track battery replacement, can I disable this?
33+
## I don't want to track battery replacement, can I disable this?
3434
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.
3535
```
3636
battery_notes:
3737
enable_replaced: False
3838
```
3939

40-
* My device doesn't show a Battery+ sensor
40+
## My device doesn't show a Battery+ sensor
4141
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)
4242

4343

44-
* How do I create a battery low template
44+
## How do I create a battery low template
4545
The best way to do this is to test in the developer tools/template section for your sensor.
4646
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.
4747
```
@@ -51,5 +51,17 @@ Be aware that Home Assistant shows friendly alternatives for some sensors, so wh
5151
```
5252
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.
5353

54-
* How can I show my support?
54+
## How do I install pre-release versions via HACS
55+
Within Home Assistant go to Settings -> Integrations -> HACS
56+
Select Services
57+
Select Battery Notes
58+
In the Diagnostics panel select the +1 entity not shown
59+
Select Pre-release
60+
Select the cog icon
61+
Select Enable
62+
Select Update and wait for the entity to be enabled
63+
Turn on the Pre-release toggle
64+
HACS will now show updates available for pre-releases if there are any
65+
66+
## How can I show my support?
5567
[!["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)