ZHA image_notify cluster command fails

[CHARL13is]

The problem

When attempting to issue the image_notify OTA cluster command via the UI I receive the error "Failed to call service zha/issue_zigbee_cluster_command. Value for field 'payload_type' is required"

Tested with an Ikea Tradfri device using a Sonoff Zigbee USB Dongle 3.0 controller. Rolling back to HA Core 2022.3.8 resolves the issue.

What version of Home Assistant Core has the issue?

2022.4.7

What was the last working version of Home Assistant Core?

2022.3.8

What type of installation are you running?

Home Assistant OS

Integration causing the issue

ZHA

Link to integration documentation on our website

https://www.home-assistant.io/integrations/zha/

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

2022-05-03 08:52:55 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection] [548039605024] Value for field 'payload_type' is required
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/websocket_api/commands.py", line 193, in handle_call_service
    await hass.services.async_call(
  File "/usr/src/homeassistant/homeassistant/core.py", line 1634, in async_call
    task.result()
  File "/usr/src/homeassistant/homeassistant/core.py", line 1671, in _execute_service
    await cast(Callable[[ServiceCall], Awaitable[None]], handler.job.target)(
  File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 747, in admin_handler
    await result
  File "/usr/src/homeassistant/homeassistant/components/zha/api.py", line 1149, in issue_zigbee_cluster_command
    response = await zha_device.issue_cluster_command(
  File "/usr/src/homeassistant/homeassistant/components/zha/core/device.py", line 647, in issue_cluster_command
    response = await cluster.client_command(command, *args)
  File "/usr/local/lib/python3.9/site-packages/zigpy/zcl/__init__.py", line 310, in reply
    payload = request.serialize()
  File "/usr/local/lib/python3.9/site-packages/zigpy/types/struct.py", line 209, in serialize
    for field, value in self.assigned_fields(strict=True):
  File "/usr/local/lib/python3.9/site-packages/zigpy/types/struct.py", line 177, in assigned_fields
    raise ValueError(f"Value for field {field.name!r} is required")
ValueError: Value for field 'payload_type' is required

Additional information

No response

[probot-home-assistant]

Hey there @dmulcahey, @Adminiuga, mind taking a look at this issue as it has been labeled with an integration (zha) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

---

zha documentation
zha source
_{^{(message by IssueLinks)}}

[puddly]

The image_notify command is required by the Zigbee spec to have at least two arguments:

• payload_type, which you can set to 0x00
• query_jitter, which you can set to 100

ZHA doesn't currently support named command arguments (though a PR would be very welcome!) so you just have to pass [0, 100].

[MattWestb]

Form developer tool -> service -> clicking "go to yaml mode" and pasting this in the editor and putting your device IEEE address instead of my CWS3 :

service: zha.issue_zigbee_cluster_command
data:
  ieee: ec:1b:bd:ff:fe:75:36:f2
  endpoint_id: 1
  cluster_id: 25
  cluster_type: out
  command: 0
  command_type: client
  args:
    - 0
    - 100

[CHARL13is]

@MattWestb your suggestion does work so it is a good work around.

[MattWestb]

One question Puddly is it not good updating ZHA GUI with the "new" / ZCLR 7.5 standard parameters so its possible sending the command from the device card Zigbee cluster panel ?
For the moment its have braking IKEA OTA that was working without them but if implanting it in the GUI is being better for our users and no need using HA services and yaml editing is not very user friendly.

[puddly]

It would be a good change. At the moment, however, I'm focusing on releasing the new radio library API and making database improvements in preparation for backup/restore. OTA is on the to-do list.

[MattWestb]

Your work is great and keep doing it well so our system can being better and better !!!
Is David having some some plans hotting the ZHA GUI with more of your ZCL updates like the OTA ?

[CHARL13is]

Thanks guys, I really appreciate the work you're doing.