diff --git a/docs/assets/screenshot-attributes.png b/docs/assets/screenshot-attributes.png new file mode 100644 index 000000000..3c8fa9b71 Binary files /dev/null and b/docs/assets/screenshot-attributes.png differ diff --git a/docs/assets/screenshot-device.png b/docs/assets/screenshot-device.png index 5650ea654..050add6de 100644 Binary files a/docs/assets/screenshot-device.png and b/docs/assets/screenshot-device.png differ diff --git a/docs/community.md b/docs/community.md index 5cc61f37d..743961147 100644 --- a/docs/community.md +++ b/docs/community.md @@ -2,8 +2,7 @@ ## UI -### Battery State Card (Beta Only) - +### Battery State Card Using the excellent [Battery State Card](https://github.com/maxwroc/battery-state-card) by maxwroc you can easily display devices with their batteries required where the devices battery threshold indicates it's low and show be replaced. ```yaml @@ -25,8 +24,7 @@ sort: ## Automations -### Battery Low Notification (Beta Only) - +### Battery Low Notification Raise a persistent notification when a battery is low, dismiss when it's not low ```yaml @@ -74,8 +72,7 @@ action: mode: queued ``` -### Battery Replaced (Beta Only) - +### Battery Replaced Mark a battery as replaced when there is an increase in battery level. ```yaml @@ -107,16 +104,14 @@ action: [Blueprints](https://www.home-assistant.io/docs/automation/using_blueprints/) are an excellent way to get you up and running with the integration quickly. They can also be used as a guide for setting up new automations which you can tailor to your needs. -### Battery Threshold (Beta Only) - +### Battery Threshold [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_threshold.yaml) | [Source](./blueprints/battery_notes_battery_threshold.yaml) This blueprint will allow notifications to be raised and/or custom actions to be performed when the battery threshold is met. It is extended from the example Battery Low Notification automation yaml above for those who'd prefer an easy way to get started. -### Battery Replaced (Beta Only) - +### Battery Replaced [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_replaced.yaml) | [Source](./blueprints/battery_notes_battery_replaced.yaml) This blueprint will automatically update the battery replaced sensor and custom actions to be performed when the battery increases. diff --git a/docs/configuration.md b/docs/configuration.md index 12feb3b1e..e41d6fcfd 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -19,9 +19,9 @@ Name | Type | Requirement | Default | Description | 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. | 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. | 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. | -default_battery_low_threshold (Beta Only)| 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. | -battery_increase_threshold (Beta Only) | 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. | -hide_battery (Beta Only)| Boolean | Optional | False | Hide the standard battery when adding Battery+. This will not effect existing dashboards, automations etc.| +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. | +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. | +hide_battery | Boolean | Optional | False | Hide the standard battery when adding Battery+. This will not effect existing dashboards, automations etc.| 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. Only really used for dev purposes. | # Debug Logging diff --git a/docs/entities.md b/docs/entities.md index 72752cbeb..06c2be33f 100644 --- a/docs/entities.md +++ b/docs/entities.md @@ -2,7 +2,7 @@ You'll get the following entities for each device you have added to battery notes. -## Battery+ (Beta Only) +## Battery+ `sensor.{{device_name}}_battery_plus` An enhanced battery sensor that duplicates the normal battery but with additional attributes specific to battery notes. @@ -40,7 +40,7 @@ The last time the battery of the device was replaced. A button to set the battery_last_replaced entity to now. -## Battery Low (Beta Only) +## Battery Low `sensor.{{device_name}}_battery_low` A boolean sensor indicating if the battery is low, true when the battery is below the device or global threshold. diff --git a/docs/events.md b/docs/events.md index 72788765e..20d0505fd 100644 --- a/docs/events.md +++ b/docs/events.md @@ -2,8 +2,7 @@ The following events are raised by the integration. These events can be used within automations. -## Battery Threshold (Beta Only) - +## Battery Threshold `battery_notes_battery_threshold` This is fired when any device within Battery Notes has a battery level changed to either below or above the device specific or global threshold. @@ -70,8 +69,7 @@ action: mode: queued ``` -## Battery Increased (Beta Only) - +## Battery Increased `battery_notes_battery_increased` This is fired when any device within Battery Notes has a battery level increased above the battery_increase_threshold (default 25%) if not changed within [configuration setting](./configuration.md). diff --git a/docs/index.md b/docs/index.md index f2c6db2a7..dc33467bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ # Battery Notes for Home Assistant Integration to add battery notes to a device, with automatic discovery via a growing [battery library](https://github.com/andrew-codechimp/HA-Battery-Notes/blob/main/library.md) for devices. -Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds (battery low in beta). +Track the battery type, when the battery was replaced and also when a battery is low based on device or global thresholds. *Please :star: this repo on [GitHub](https://github.com/andrew-codechimp/HA-Battery-Notes) if you find it useful* *If you want to show your support please*