|
1 | 1 | # Configuration |
2 | 2 |
|
3 | | -Global configuration settings can be changed by selecting the configuration cog on the main Battery Notes service. |
4 | | - |
5 | | -| Name | Description | |
6 | | -| ---------------- | ---------------------------------------------------------------------------------------- | |
7 | | -| Show all devices | Will show all devices in the manual add dropdown, rather than just those with batteries. | |
8 | | -| Hide battery | Hide the standard battery when adding Battery+. This will not effect existing dashboards, automations etc.| |
9 | | -| Round battery | Round battery+ to whole percentages.| |
10 | | -| Default battery low threshold | The default threshold where a devices battery_low entity is set to true and the battery_notes_battery_threshold event is fired, can be overriden per device in device configuration. | |
11 | | -|Battery increase threshold | The threshold where the battery_notes_battery_increased event is fired, use this event for battery replaced automations. The threshold is the difference in increase between previous and current battery level. | |
12 | | -| Auto discovery | Will automatically match devices against the library and create a setup flow within the integrations page, this occurs at instegration startup and repeats every 24 hours. | |
13 | | -| Enable battery replaced | New battery notes will have a battery replaced sensor and butoon. If disabled new devices added to battery notes will have the battery replaced sensor and button disabled. Any battery notes you have previously added you will have to disable/re-enable these sensors manually, which also means you can enable specific sensors of important ones you want to track. | |
14 | | -| User library | If specified then a user library file will be searched prior to the main library, the user library must be in the same format as the library and placed in the same folder (config/.storage/battery_notes). Only really used for dev purposes. | |
| 3 | +You can add these options to change the default behaviour of Battery Notes by adding them to your Home Assistant configuration.yaml under the battery_notes: property, like so: |
| 4 | + |
| 5 | +``` |
| 6 | +battery_notes: |
| 7 | + enable_autodiscovery: true |
| 8 | + show_all_devices: false |
| 9 | + enable_replaced: true |
| 10 | + default_battery_low_threshold: 10 |
| 11 | + battery_increase_threshold: 25 |
| 12 | + hide_battery: false |
| 13 | + round_battery: false |
| 14 | +``` |
| 15 | + |
| 16 | +A restart of Home Assistant is required for the changed to take effect. |
| 17 | + |
| 18 | +Name | Type | Requirement | Default | Description | |
| 19 | +-- | -- | -- | -- | -- | |
| 20 | +enable_autodiscovery | Boolean | Optional | True | If set to true will automatically match devices against the library and create a setup flow within the integrations page. | |
| 21 | +show_all_devices | Boolean | Optional | False | If set to true will show all devices in the manual add dropdown, rather than just those with batteries. | |
| 22 | +enable_replaced | Boolean | Optional | True | If set to false 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 these sensors manually, which also means you can enable specific sensors of important ones you want to track. | |
| 23 | +default_battery_low_threshold | Int | Optional | 10 | The default threshold where a devices battery_low entity is set to true and the battery_notes_battery_threshold event is fired, can be overriden per device in device configuration. | |
| 24 | +battery_increase_threshold | Int | Optional | 25 | The threshold where the battery_notes_battery_increased event is fired, use this event for battery replaced automations. The threshold is the difference in increase between previous and current battery level. | |
| 25 | +hide_battery | Boolean | Optional | False | Hide the standard battery when adding Battery+. This will not effect existing dashboards, automations etc.| |
| 26 | +round_battery | Boolean | Optional | False | Round battery+ to whole percentages.| |
| 27 | +user_library | String | Optional | | If specified then a user library file will be searched prior to the main library, the user library must be in the same format as the library and placed in the same folder (config/.storage/battery_notes). Only really used for dev purposes. | |
15 | 28 |
|
16 | 29 | # Debug Logging |
17 | 30 |
|
|
0 commit comments