Merge branch 'main' into storage

Author: andrew-codechimp

.github/ISSUE_TEMPLATE/bug.yml

@@ -6,20 +6,12 @@ body:
   - type: markdown
     attributes:
       value: Before you open a new issue, search through the existing issues to see if others have had the same problem.
-  - type: textarea
-    attributes:
-      label: "System Health details"
-      description: "Paste the data from the System Health card in Home Assistant (https://www.home-assistant.io/more-info/system-health)"
-    validations:
-      required: true
   - type: checkboxes
     attributes:
       label: Checklist
       options:
         - label: I have added `battery_notes:` to my configuration.yaml and restarted.
           required: true
-        - label: I am using the latest version of Battery Notes (if using the latest beta please mention this in the issue description).
-          required: true
         - label: I have read the [FAQ's](https://andrew-codechimp.github.io/HA-Battery-Notes/faq).
           required: true
         - label: I have enabled debug logging for my installation.
@@ -30,6 +22,12 @@ body:
           required: true
         - label: This issue is not a duplicate issue of any [previous issues](https://github.com/andrew-codechimp/ha-battery-notes/issues?q=is%3Aissue+label%3A%22Bug%22+)..
           required: true
+  - type: input
+    attributes:
+      label: "Battery Notes Version"
+      description: "Available from Settings/Devices & Services/Integrations/Battery Notes (you should be running the latest or pre-release)."
+    validations:
+      required: true
   - type: textarea
     attributes:
       label: "Describe the issue"
@@ -47,14 +45,19 @@ body:
         ...
     validations:
       required: true
+  - type: textarea
+    attributes:
+      label: "System Health details"
+      description: "Paste the data from the System Health card in Home Assistant (https://www.home-assistant.io/more-info/system-health)"
+    validations:
+      required: true
   - type: textarea
     attributes:
       label: "Debug logs"
       description: "To enable debug logs check this https://www.home-assistant.io/integrations/logger/, this **needs** to include _everything_ from startup of Home Assistant to the point where you encounter the issue."
       render: text
     validations:
       required: false
-
   - type: textarea
     attributes:
       label: "Diagnostics dump"

custom_components/battery_notes/translations/nl.json

@@ -190,12 +190,12 @@
     },
     "issues": {
         "missing_device": {
-            "title": "Orphaned Battery Note",
+            "title": "Verouderd Battery Note",
             "fix_flow": {
                 "step": {
                     "confirm": {
-                        "title": "Orphaned Battery Note",
-                        "description": "The associated device or entity no longer exists for the Battery Note entry {name}, the Battery Note should be deleted.\nSelect **Submit** to delete this Battery Note."
+                        "title": "Verouderd Battery Note",
+                        "description": "Het bijbehorende apparaat of entiteit bestaat niet langer voor de Battery Note {name}, de Battery Note moet worden verwijderd.\nSelecteer **Verzenden** om deze Battery Note te verwijderen."
                     }
                 }
             }

docs/events.md

@@ -19,6 +19,7 @@ You can use this to send notifications in your preferred method.  An example aut
 | `source_entity_id` | `string` | The entity id of the sensor associated with the battery note. |
 | `device_name` | `string` | The device name (or associated sensor name if no device). |
 | `battery_low` | `bool` | Returns true if the battery has gone below the threshold, false when the battery has returned above the threshold. **Your automations will almost certainly want to examine this value and set/clear notifications or other indicators.** |
+| `battery_low_threshold` | `string` | Battery low threshold (or global if 0). |
 | `battery_type_and_quantity` | `string` | Battery type & quantity. |
 | `battery_type` | `string` | Battery type. |
 | `battery_quantity` | `int` | Battery quantity. |
@@ -94,6 +95,7 @@ An example automation below shows how to update the battery_replaced.
 | `source_entity_id` | `string` | The entity id of the sensor associated with the battery note. |
 | `device_name` | `string` | The device name (or associated sensor name if no device). |
 | `battery_low` | `bool` | Returns true if the battery has gone below the threshold, false when the battery has returned above the threshold. |
+| `battery_low_threshold` | `string` | Battery low threshold (or global if 0). |
 | `battery_type_and_quantity` | `string` | Battery type & quantity. |
 | `battery_type` | `string` | Battery type. |
 | `battery_quantity` | `int` | Battery quantity. |

docs/faq.md

@@ -1,65 +1,85 @@
 # FAQ
 
-## Does a device have to be in the library?  
+## Does a device have to be in the library?
+
 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.
 
-## Why is my device not being discovered?  
-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.
+## Why is my device not being discovered?
+
+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.
+
+## When is the library updated?
 
-## When is the library updated?  
 It updates when Home Assistant is restarted and approximately every 24 hours after that.  
 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.
 
-## How do I remove a battery note on a device?  
+## How do I remove a battery note on a device?
+
 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.
 
-## Can I edit a battery note?  
+## Can I edit a battery note?
+
 Go into Settings -> Integrations -> Battery Notes and click Configure on the device you want to edit.
 
-## Why am I only able to see some of my devices when adding manually?  
+## Why am I only able to see some of my devices when adding manually?
+
 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.
+
 ```
 battery_notes:
   show_all_devices: True
 ```
 
-## I only want to add notes to a few devices, can I disable auto discovery?  
+## I only want to add notes to a few devices, can I disable auto discovery?
+
 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.
+
 ```
 battery_notes:
   enable_autodiscovery: False
 ```
 
-## I don't want to track battery replacement, can I disable this?  
-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.
+## I don't want to track battery replacement, can I disable this?
+
+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.
+
 ```
 battery_notes:
   enable_replaced: False
 ```
 
-## My device doesn't show a Battery+ sensor  
+## My device doesn't show a Battery+ sensor
+
 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)
 
+## My device is not picking up the proper battery percentage for Battery+
+
+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 to monitor.
+
+## How do I create a battery low template
 
-## 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.  
+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.
 
 ## My Shelly device is not showing a Battery+
-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:  
-* Remove the battery note from the Shelly device
-* Remove the Shelly device from the Shelly integration
-* Re-Add the Shelly device
-* Add the battery note to the device
 
+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:
+
+- Remove the battery note from the Shelly device
+- Remove the Shelly device from the Shelly integration
+- Re-Add the Shelly device
+- Add the battery note to the device
+
+## How do I install pre-release versions via HACS
 
-## How do I install pre-release versions via HACS  
 Within Home Assistant go to Settings -> Integrations -> HACS  
 Select Services  
 Select Battery Notes  
@@ -69,7 +89,8 @@ Select the cog icon
 Select Enable  
 Select Update and wait for the entity to be enabled  
 Turn on the Pre-release toggle  
-HACS will now show updates available for pre-releases if there are any  
+HACS will now show updates available for pre-releases if there are any
+
+## How can I show my support?
 
-## 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)