ZHA: Sending cluster command fails with exception on response

[Sisylam]

The problem

I currently trying to create an IAS ACE alarm panel using an ESP32-C6 and general binding and communication with home-assistant works as expected and it shows up as an alarm panel inside of the dashboard.
I went into 'Manage Zigbee device' to directly send a cluster command which somehow works as I do receive the proper arm command.
However, in the HA dashboard I get an error 'Failed to perform the action...' and in the logs I see a stacktrace posted below.

Could someone please be so kind and take a look at it or advice me how to resolve the error?

What version of Home Assistant Core has the issue?

core-2025.1.0.dev202411280234

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant Supervised

Integration causing the issue

ZigBee Home Automation

Link to integration documentation on our website

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

Diagnostics information

As written above, I currently trying to create an IAS ACE alarm panel using an ESP32-C6 and general binding and communication with home-assistant works as expected and it shows up as an alarm panel inside of the dashboard.

I noticed that when I select the functionality in the dashboard to switch the state to arming

then it will only send me for whichever arming state always a panic event only

I (2156804) ZB_IAS_ACE_PANEL: ESP_ZB_CORE_IAS_ACE_PANIC_CB_ID : Receive Zigbee action(0x23) callback
I (2156804) ZB_IAS_ACE_PANEL: Panic message: endpoint(1), cluster(0x501), status(0) 

Maybe that is how it is supposed to work, but it was irritating, but not the issue at hand. Then I went into 'Manage Zigbee device' to directly send a cluster command via

which somehow works as I do receive the proper arm command on the ESP side:

I (4250924) ZB_IAS_ACE_PANEL: ESP_ZB_CORE_IAS_ACE_ARM_CB_ID : Receive Zigbee action(0x1f) callback
I (4250924) ZB_IAS_ACE_PANEL: Arm message: endpoint(1), cluster(0x501), status(0)
W (4251054) ZB_IAS_ACE_PANEL: arm_disarm_code: (1234)
W (4251064) ZB_IAS_ACE_PANEL: zone_id: 1
W (4251064) ZB_IAS_ACE_PANEL: ARM_MODE_DISARM

However, in the HA dashboard I get an error 'Failed to perform the action...' and in the logs I see the posted stacktrace.

Example YAML snippet

No response

Anything in the logs that might be useful for us?

2024-11-29 14:16:59.939 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Sending request header: ZCLHeader(frame_control=FrameControl<0x01>(frame_type=<FrameType.CLUSTER_COMMAND: 1>, is_manufacturer_specific=False, direction=<Direction.Client_to_Server: 0>, disable_default_response=0, reserved=0, *is_cluster=True, *is_general=False), tsn=41, command_id=0, *direction=<Direction.Client_to_Server: 0>)
2024-11-29 14:16:59.947 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Sending request: arm(arm_mode=<ArmMode.Disarm: 0>, arm_disarm_code='1234', zone_id=1)
2024-11-29 14:17:00.150 DEBUG (MainThread) [zigpy.application] Received a packet: ZigbeePacket(timestamp=datetime.datetime(2024, 11, 29, 13, 17, 0, 150493, tzinfo=datetime.timezone.utc), priority=0, src=AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x61B4), src_ep=1, dst=AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x0000), dst_ep=1, source_route=None, extended_timeout=False, tsn=0, profile_id=260, cluster_id=1281, data=Serialized[b'\x19)\x00\x00'], tx_options=<TransmitOptions.NONE: 0>, radius=29, non_member_radius=0, lqi=145, rssi=None)
2024-11-29 14:17:00.155 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Received ZCL frame: b'\x19)\x00\x00'
2024-11-29 14:17:00.160 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Decoded ZCL frame header: ZCLHeader(frame_control=FrameControl<0x19>(frame_type=<FrameType.CLUSTER_COMMAND: 1>, is_manufacturer_specific=0, direction=<Direction.Server_to_Client: 1>, disable_default_response=1, reserved=0, *is_cluster=True, *is_general=False), tsn=41, command_id=0, *direction=<Direction.Server_to_Client: 1>)
2024-11-29 14:17:00.164 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Decoded ZCL frame: IasAce:arm_response(arm_notification=<ArmNotification.All_Zones_Disarmed: 0>)
2024-11-29 14:17:00.171 ERROR (MainThread) [homeassistant.components.websocket_api.http.connection] [546683253472] Unexpected exception
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/websocket_api/commands.py", line 245, in handle_call_service
    response = await hass.services.async_call(
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    ...<7 lines>...
    )
    ^
  File "/usr/src/homeassistant/homeassistant/core.py", line 2802, in async_call
    response_data = await coro
                    ^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/core.py", line 2845, in _execute_service
    return await target(service_call)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/src/homeassistant/homeassistant/helpers/service.py", line 1110, in _async_admin_handler
    await result
  File "/usr/src/homeassistant/homeassistant/components/zha/websocket_api.py", line 1389, in issue_zigbee_cluster_command
    await zha_device.issue_cluster_command(
    ...<8 lines>...
    )
  File "/usr/local/lib/python3.13/site-packages/zha/zigbee/device.py", line 958, in issue_cluster_command
    if response[1] is not ZclStatus.SUCCESS:
       ~~~~~~~~^^^
  File "/usr/local/lib/python3.13/site-packages/zigpy/zcl/foundation.py", line 1192, in __getitem__
    return self.as_tuple()[item]
           ~~~~~~~~~~~~~~~^^^^^^
IndexError: tuple index out of range

Additional information

No response

[home-assistant]

Hey there @dmulcahey, @Adminiuga, @puddly, @TheJulianJES, 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!

Code owner commands

Code owners of zha can trigger bot actions by commenting:

• @home-assistant close Closes the issue.
• @home-assistant rename Awesome new title Renames the issue.
• @home-assistant reopen Reopen the issue.
• @home-assistant unassign zha Removes the current integration label and assignees on the issue, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

---

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

[Sisylam]

I looked a bit further into it, added some extra log output to:
/homeassistant/components/zha/websocket_api.py

1385:        if zha_device is not None:
1386:            if cluster_id >= MFG_CLUSTER_ID_START and manufacturer is None:
1387:                manufacturer = zha_device.manufacturer_code
1388:
1389:            _LOGGER.info(
1390:                (
1391:                    "Issuing command for: %s: [%s] %s: [%s] %s: [%s] %s: [%s] %s: [%s]"
1392:                    " %s: [%s] %s: [%s] %s: [%s]"
1393:                ),
1394:                ATTR_CLUSTER_ID, cluster_id,
1395:                ATTR_CLUSTER_TYPE, cluster_type,
1396:                ATTR_ENDPOINT_ID, endpoint_id,
1397:                ATTR_COMMAND, command,
1398:                ATTR_COMMAND_TYPE, command_type,
1399:                ATTR_ARGS, args,
1400:                ATTR_PARAMS, params,
1401:                ATTR_MANUFACTURER, manufacturer,
1402:            )
1403:            await zha_device.issue_cluster_command(
1404:                endpoint_id,
1405:                cluster_id,
1406:                command,
1407:                command_type,
1408:                args,
1409:                params,
1410:                cluster_type=cluster_type,
1411:                manufacturer=manufacturer,
1412:            )

as well as to return graceful if the result is not a tuple by changing:
/site-packages/zha/zigbee/device.py

938:        else:
939:            assert params is not None
940:            response = await getattr(cluster, commands[command].name)(
941:                **convert_to_zcl_values(params, commands[command].schema)
942:            )
943:        _LOGGER.info("Received response: %s", response)
944:        self.debug(
945:            "Issued cluster command: %s %s %s %s %s %s %s %s",
946:            f"{ATTR_CLUSTER_ID}: [{cluster_id}]",
947:            f"{ATTR_CLUSTER_TYPE}: [{cluster_type}]",
948:            f"{ATTR_ENDPOINT_ID}: [{endpoint_id}]",
949:            f"{ATTR_COMMAND}: [{command}]",
950:            f"{ATTR_COMMAND_TYPE}: [{command_type}]",
951:            f"{ATTR_ARGS}: [{args}]",
952:            f"{ATTR_PARAMS}: [{params}]",
953:            f"{ATTR_MANUFACTURER}: [{manufacturer}]",
954:        )
955:        if response is None:
956:            return  # client commands don't return a response
957:        if isinstance(response, Exception):
958:            raise ZHAException("Failed to issue cluster command") from response
959:        if not isinstance(response, tuple) or len(response) < 2:
960:            # either raise an ZHAException for malformed response from cluster command or ignore it
961:            return
962:        if response[1] is not ZclStatus.SUCCESS:
963:            raise ZHAException(
964:                f"Failed to issue cluster command with status: {response[1]}"
965:            )

which then produces this log output for the disarm command:

2024-12-08 15:40:13.381 INFO (MainThread) [homeassistant.components.zha.websocket_api] Issuing command for: cluster_id: [1281] cluster_type: [in] endpoint_id: [1] command: [0] command_type: [server] args: [None] params: [{'arm_mode': 'Disarm', 'arm_disarm_code': '1234', 'zone_id': 1}] manufacturer: [None]
2024-12-08 15:40:13.390 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Sending request header: ZCLHeader(frame_control=FrameControl<0x01>(frame_type=<FrameType.CLUSTER_COMMAND: 1>, is_manufacturer_specific=False, direction=<Direction.Client_to_Server: 0>, disable_default_response=0, reserved=0, *is_cluster=True, *is_general=False), tsn=5, command_id=0, *direction=<Direction.Client_to_Server: 0>)
2024-12-08 15:40:13.401 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Sending request: arm(arm_mode=<ArmMode.Disarm: 0>, arm_disarm_code='1234', zone_id=1)
2024-12-08 15:40:13.965 DEBUG (MainThread) [zigpy.application] Received a packet: ZigbeePacket(timestamp=datetime.datetime(2024, 12, 8, 14, 40, 13, 964896, tzinfo=datetime.timezone.utc), priority=0, src=AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x61B4), src_ep=1, dst=AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0x0000), dst_ep=1, source_route=None, extended_timeout=False, tsn=0, profile_id=260, cluster_id=1281, data=Serialized[b'\x19\x05\x00\x00'], tx_options=<TransmitOptions.NONE: 0>, radius=29, non_member_radius=0, lqi=149, rssi=None)
2024-12-08 15:40:13.969 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Received ZCL frame: b'\x19\x05\x00\x00'
2024-12-08 15:40:13.977 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Decoded ZCL frame header: ZCLHeader(frame_control=FrameControl<0x19>(frame_type=<FrameType.CLUSTER_COMMAND: 1>, is_manufacturer_specific=0, direction=<Direction.Server_to_Client: 1>, disable_default_response=1, reserved=0, *is_cluster=True, *is_general=False), tsn=5, command_id=0, *direction=<Direction.Server_to_Client: 1>)
2024-12-08 15:40:13.984 DEBUG (MainThread) [zigpy.zcl] [0x61B4:1:0x0501] Decoded ZCL frame: IasAce:arm_response(arm_notification=<ArmNotification.All_Zones_Disarmed: 0>)
2024-12-08 15:40:13.987 INFO (MainThread) [zha.zigbee.device] Received response: arm_response(arm_notification=<ArmNotification.All_Zones_Disarmed: 0>)

What I do not know if it should actually return something else, which could be interpreted as a tuple, but for me the return looks valid. If this is the case I would prepare a PR to have this part fixed.

[issue-triage-workflows]

There hasn't been any activity on this issue recently. Due to the high number of incoming GitHub notifications, we have to clean some of the old issues, as many of them have already been resolved with the latest updates.
Please make sure to update to the latest Home Assistant version and check if that solves the issue. Let us know if that works for you by adding a comment 👍
This issue has now been marked as stale and will be closed if no further activity occurs. Thank you for your contributions.