Error with "Battery Replaced" Community Automation

sockmonkey0223 commented 3 weeks ago

System Health details

System Information

version	core-2024.6.1
installation_type	Home Assistant OS
dev	false
hassio	true
docker	true
user	root
virtualenv	false
python_version	3.12.2
os_name	Linux
os_version	6.6.29-haos
arch	x86_64
timezone	America/New_York
config_dir	/config

Home Assistant Community Store

AccuWeather

can_reach_server | ok -- | -- remaining_requests | 19

Home Assistant Cloud

Home Assistant Supervisor

Dashboards

Recorder

Checklist

[X] I have added battery_notes: to my configuration.yaml and restarted.
[X] I have read the FAQ's.
[X] I have enabled debug logging for my installation.
[X] I have filled out the issue template to the best of my ability.
[X] This issue only contains 1 issue (if you have multiple issues, open one issue for each issue).
[X] This issue is not a duplicate issue of any previous issues..

Describe the issue

I set up the Community "Battery Replaced" automation. When I replaced a battery today (0% --> 100%) the automation triggered but failed with an error:

Error: string value is None for dictionary value @ data['source_entity_id']
Result:
params:
  domain: battery_notes
  service: set_battery_replaced
  service_data:
    device_id: 137380e2ebf12df13f892a64ba50fc7d
    source_entity_id: null
  target: {}
running_script: false

Full automation YAML:

alias: "Action: Set Battery Replaced"
description: ""
trigger:
  - platform: event
    event_type: battery_notes_battery_increased
    alias: Battery Notes "Battery Increased" Event is Fired
condition: []
action:
  - service: battery_notes.set_battery_replaced
    data:
      device_id: "{{ trigger.event.data.device_id }}"
      source_entity_id: "{{ trigger.event.data.source_entity_id }}"
    alias: Call "Set Battery Replaced" Service
  - service: persistent_notification.create
    data:
      title: |
        {{ trigger.event.data.device_name }} Battery Replaced
      message: |
        Battery level increased past threshold and has been marked as replaced.
    alias: Create Persistent Notification that Battery Replaced
mode: queued

configuration.yaml:

battery_notes:
  default_battery_low_threshold: 10
  battery_increase_threshold: 40
  hide_battery: true

Reproduction steps

Replace low battery with new battery
Check automation traces
Observe error

Debug logs

Not enabled at time of battery replacement.

Diagnostics dump

Cannot download, diagnostics error:

Logger: aiohttp.server
Source: /usr/local/lib/python3.12/site-packages/aiohttp/web_protocol.py:421
First occurred: 8:42:21 AM (5 occurrences)
Last logged: 8:57:10 AM

Error handling request
Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/aiohttp/web_protocol.py", line 452, in _handle_request
    resp = await request_handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/aiohttp/web_app.py", line 543, in _handle
    resp = await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/aiohttp/web_middlewares.py", line 114, in impl
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/http/security_filter.py", line 92, in security_filter_middleware
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/http/forwarded.py", line 83, in forwarded_middleware
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/http/request_context.py", line 26, in request_context_middleware
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/http/ban.py", line 85, in ban_middleware
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/http/auth.py", line 242, in auth_middleware
    return await handler(request)
           ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/http/headers.py", line 32, in headers_middleware
    response = await handler(request)
               ^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/helpers/http.py", line 73, in handle
    result = await handler(request, **request.match_info)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/components/diagnostics/__init__.py", line 280, in get
    data = await info.config_entry_diagnostics(hass, config_entry)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: async_get_config_entry_diagnostics() takes 1 positional argument but 2 were given

andrew-codechimp commented 3 weeks ago

I've been able to replicate this, rather than try and kludge a change to the automation I'll fix this as a new release on the battery replaced service itself.

andrew-codechimp commented 3 weeks ago

This is now fixed in the 2.3.6 release, thanks for reporting it.

sambarlick commented 1 week ago

Hi,

I realise this issue is closed, but I am experiencing this same issue, the source_entity_id is empty.

I am running Battery Notes v2.3.9 HA: 2024.6.4

I have attached the log from my automation. I have tested the event data on multiple devices all with the same issue.

If I can provide any more information please let me know.

This is the event data:

event_type: battery_notes_battery_increased data: device_id: f86a43d6399a8335de1e51a0d1e0992b source_entity_id: "" device_name: Bedroom Window battery_low: false battery_type_and_quantity: Rechargeable battery_type: Rechargeable battery_quantity: 1 battery_level: 100 previous_battery_level: 10 origin: LOCAL time_fired: "2024-06-25T09:59:26.093334+00:00" context: id: 01J17DC04D44FYRSPCKY6DMPVA parent_id: null user_id: null

Home Assistant 2024-06-25 19_59_50.json

sambarlick commented 1 week ago

source_entity_id is also empty in the event battery_notes_battery_threshold.

event_type: battery_notes_battery_threshold data: device_id: f86a43d6399a8335de1e51a0d1e0992b source_entity_id: "" device_name: Bedroom Window battery_low: true battery_type_and_quantity: Rechargeable battery_type: Rechargeable battery_quantity: 1 battery_level: 5 previous_battery_level: 100 reminder: false origin: LOCAL time_fired: "2024-06-25T10:25:50.137025+00:00" context: id: 01J17EWB1S6S6Q6V5X008KKCXB parent_id: null user_id: null

andrew-codechimp commented 1 week ago

Hi @sambarlick it looks like this is a different issue. source_entity_id can be "", it was previously NULL and that caused the original issue.

I've just found one area of the documentation where the parameter was wrongly named, assuming you have your own automation the action should look like this, I can see from the error it's trying to call the service with entity_id instead of source_entity_id.

action:
  - service: battery_notes.set_battery_replaced
    data:
      device_id: "{{ trigger.event.data.device_id }}"
      source_entity_id: "{{ trigger.event.data.source_entity_id }}"

andrew-codechimp / HA-Battery-Notes