[Device Support Request] Ikea E2123: Symfonisk sound remote Gen2

[MrDodojo]

Is your feature request related to a problem? Please describe.
Ikea released a new Symfonisk sound remote (gen2) and it is not yet supported by ZHA. The device when added to homeassistant does not have triggers for pressing the various buttons seperately. The only triggers it has are: Device offline, has been pressed and battery level changed(while the battery level does not indicate correctly either).

Describe the solution you'd like
Support for all the buttons: Volume up & down, next & previous, play/pause and 2 custom "shortcut" buttons.

Device signature

{
  "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.EndDevice: 2>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress: 128>, manufacturer_code=4476, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False)",
  "endpoints": {
    "1": {
      "profile_id": 260,
      "device_type": "0x0006",
      "in_clusters": [
        "0x0000",
        "0x0001",
        "0x0003",
        "0x0020",
        "0x1000",
        "0xfc57"
      ],
      "out_clusters": [
        "0x0003",
        "0x0004",
        "0x0006",
        "0x0008",
        "0x0019",
        "0x1000",
        "0xfc7f"
      ]
    }
  },
  "manufacturer": "IKEA of Sweden",
  "model": "SYMFONISK sound remote gen2",
  "class": "zigpy.device.Device"
}

Diagnostic information

{
  "home_assistant": {
    "installation_type": "Home Assistant OS",
    "version": "2023.2.1",
    "dev": false,
    "hassio": true,
    "virtualenv": false,
    "python_version": "3.10.7",
    "docker": true,
    "arch": "aarch64",
    "timezone": "Europe/Amsterdam",
    "os_name": "Linux",
    "os_version": "5.15.84-v8",
    "supervisor": "2023.01.1",
    "host_os": "Home Assistant OS 9.5",
    "docker_version": "20.10.22",
    "chassis": "embedded",
    "run_as_root": true
  },
  "custom_components": {
    "adaptive_lighting": {
      "version": "1.4.1",
      "requirements": []
    },
    "localtuya": {
      "version": "5.0.0",
      "requirements": []
    },
    "hacs": {
      "version": "1.30.1",
      "requirements": [
        "aiogithubapi>=22.10.1"
      ]
    }
  },
  "integration_manifest": {
    "domain": "zha",
    "name": "Zigbee Home Automation",
    "config_flow": true,
    "documentation": "https://www.home-assistant.io/integrations/zha",
    "requirements": [
      "bellows==0.34.7",
      "pyserial==3.5",
      "pyserial-asyncio==0.6",
      "zha-quirks==0.0.92",
      "zigpy-deconz==0.19.2",
      "zigpy==0.53.0",
      "zigpy-xbee==0.16.2",
      "zigpy-zigate==0.10.3",
      "zigpy-znp==0.9.2"
    ],
    "usb": [
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*2652*",
        "known_devices": [
          "slae.sh cc2652rb stick"
        ]
      },
      {
        "vid": "1A86",
        "pid": "55D4",
        "description": "*sonoff*plus*",
        "known_devices": [
          "sonoff zigbee dongle plus v2"
        ]
      },
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*sonoff*plus*",
        "known_devices": [
          "sonoff zigbee dongle plus"
        ]
      },
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*tubeszb*",
        "known_devices": [
          "TubesZB Coordinator"
        ]
      },
      {
        "vid": "1A86",
        "pid": "7523",
        "description": "*tubeszb*",
        "known_devices": [
          "TubesZB Coordinator"
        ]
      },
      {
        "vid": "1A86",
        "pid": "7523",
        "description": "*zigstar*",
        "known_devices": [
          "ZigStar Coordinators"
        ]
      },
      {
        "vid": "1CF1",
        "pid": "0030",
        "description": "*conbee*",
        "known_devices": [
          "Conbee II"
        ]
      },
      {
        "vid": "10C4",
        "pid": "8A2A",
        "description": "*zigbee*",
        "known_devices": [
          "Nortek HUSBZB-1"
        ]
      },
      {
        "vid": "0403",
        "pid": "6015",
        "description": "*zigate*",
        "known_devices": [
          "ZiGate+"
        ]
      },
      {
        "vid": "10C4",
        "pid": "EA60",
        "description": "*zigate*",
        "known_devices": [
          "ZiGate"
        ]
      },
      {
        "vid": "10C4",
        "pid": "8B34",
        "description": "*bv 2010/10*",
        "known_devices": [
          "Bitron Video AV2010/10"
        ]
      }
    ],
    "codeowners": [
      "@dmulcahey",
      "@adminiuga",
      "@puddly"
    ],
    "zeroconf": [
      {
        "type": "_esphomelib._tcp.local.",
        "name": "tube*"
      },
      {
        "type": "_zigate-zigbee-gateway._tcp.local.",
        "name": "*zigate*"
      },
      {
        "type": "_zigstar_gw._tcp.local.",
        "name": "*zigstar*"
      },
      {
        "type": "_slzb-06._tcp.local.",
        "name": "slzb-06*"
      }
    ],
    "dependencies": [
      "file_upload"
    ],
    "after_dependencies": [
      "onboarding",
      "usb",
      "zeroconf"
    ],
    "iot_class": "local_polling",
    "loggers": [
      "aiosqlite",
      "bellows",
      "crccheck",
      "pure_pcapy3",
      "zhaquirks",
      "zigpy",
      "zigpy_deconz",
      "zigpy_xbee",
      "zigpy_zigate",
      "zigpy_znp"
    ],
    "is_built_in": true
  },
  "data": {
    "ieee": "**REDACTED**",
    "nwk": 10838,
    "manufacturer": "IKEA of Sweden",
    "model": "SYMFONISK sound remote gen2",
    "name": "IKEA of Sweden SYMFONISK sound remote gen2",
    "quirk_applied": false,
    "quirk_class": "zigpy.device.Device",
    "manufacturer_code": 4476,
    "power_source": "Battery or Unknown",
    "lqi": 159,
    "rssi": null,
    "last_seen": "2023-02-24T15:07:16",
    "available": true,
    "device_type": "EndDevice",
    "signature": {
      "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.EndDevice: 2>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress: 128>, manufacturer_code=4476, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False)",
      "endpoints": {
        "1": {
          "profile_id": 260,
          "device_type": "0x0006",
          "in_clusters": [
            "0x0000",
            "0x0001",
            "0x0003",
            "0x0020",
            "0x1000",
            "0xfc57"
          ],
          "out_clusters": [
            "0x0003",
            "0x0004",
            "0x0006",
            "0x0008",
            "0x0019",
            "0x1000",
            "0xfc7f"
          ]
        }
      }
    },
    "active_coordinator": false,
    "entities": [
      {
        "entity_id": "sensor.ikea_of_sweden_symfonisk_sound_remote_gen2_battery",
        "name": "IKEA of Sweden SYMFONISK sound remote gen2"
      },
      {
        "entity_id": "button.ikea_of_sweden_symfonisk_sound_remote_gen2_identify",
        "name": "IKEA of Sweden SYMFONISK sound remote gen2"
      }
    ],
    "neighbors": [],
    "routes": [],
    "endpoint_names": [
      {
        "name": "REMOTE_CONTROL"
      }
    ],
    "user_given_name": null,
    "device_reg_id": "58a64db01f3b9ead5ee6417d4fe2f240",
    "area_id": "kitchen",
    "cluster_details": {
      "1": {
        "device_type": {
          "name": "REMOTE_CONTROL",
          "id": 6
        },
        "profile_id": 260,
        "in_clusters": {
          "0x0000": {
            "endpoint_attribute": "basic",
            "attributes": {
              "0x0004": {
                "attribute_name": "manufacturer",
                "value": "IKEA of Sweden"
              },
              "0x0005": {
                "attribute_name": "model",
                "value": "SYMFONISK sound remote gen2"
              }
            },
            "unsupported_attributes": {}
          },
          "0x0001": {
            "endpoint_attribute": "power",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0003": {
            "endpoint_attribute": "identify",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0020": {
            "endpoint_attribute": "poll_control",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x1000": {
            "endpoint_attribute": "lightlink",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0xfc57": {
            "endpoint_attribute": "manufacturer_specific",
            "attributes": {},
            "unsupported_attributes": {}
          }
        },
        "out_clusters": {
          "0x0003": {
            "endpoint_attribute": "identify",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0004": {
            "endpoint_attribute": "groups",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0006": {
            "endpoint_attribute": "on_off",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0008": {
            "endpoint_attribute": "level",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x0019": {
            "endpoint_attribute": "ota",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0x1000": {
            "endpoint_attribute": "lightlink",
            "attributes": {},
            "unsupported_attributes": {}
          },
          "0xfc7f": {
            "endpoint_attribute": "manufacturer_specific",
            "attributes": {},
            "unsupported_attributes": {}
          }
        }
      }
    }
  }
}

Additional logs

No Debug logs

Additional context

^This is the device, it has a lot of buttons and would be quite nice to use with homeassistant.

[MattWestb]

Where did you geeing it ??
I hope its being released iin EU very soon then its have being CSA-certified over one year now.

Edit: Its coming next week to Westbahnhoff in Vienna :-(((

[MrDodojo]

Where did you geeing it ?? I hope its being released iin EU very soon then its have being CSA-certified over one year now.

Edit: Its coming next week to Westbahnhoff in Vienna :-(((

Got it at an Ikea in the Netherlands which is in the EU, they didn't have a lot of them so I was sure to grab one. 2 extra buttons for a total of 7 is nice to have

[MattWestb]

Its looks very standard of the cluster and is clean but we must getting all the commands its sending.
I think its prity easy getting all Device Automatons (DA) but its needs little work getting it right and testing all is working OK.
Its only 2 IKEAs in Austria that having it on the homepage and no inside Vienna but i going and looking tomorrow if its some is having it.

One interesting thing its only Dirigera compatible and TF but shall testing that 2.

[MattWestb]

Do you having ZHA-Toolkit https://github.com/mdeweerd/zha-toolkit installed ??

If yes bind the cluster Id: 0xfc80 on endpoint 2 and 3 to the coordinator (0x0000) and i think you shall getting the commands from the 2 shortcut buttons then its wot IKEA is doing in Dirigera then pairing it.

[MrDodojo]

No I haven't. I just did, don't know how to use it yet. I'd appreciate if you could spoon-feed/help me what to do. Otherwise it will take me a while to understand the docs

Are you asking me to zha_toolkit.bind_ieee like this? I don't know what to set as ieee as the remote only has battery and identify as entities

service: zha_toolkit.bind_ieee
data:
  dst_endpoint: 2
  ieee: ????????
  command_data: 0
  cluster: 0xfc80

[SamDeBlock]

I have the same device, these are the debug logs for the 'dot' buttons:

1 dot button

DEBUG (MainThread) [zigpy_znp.api] Received command: AF.IncomingMsg.Callback(GroupId=0x0000, ClusterId=64639, SrcAddr=0xD1BF, SrcEndpoint=1, DstEndpoint=1, WasBroadcast=<Bool.false: 0>, LQI=63, SecurityUse=<Bool.false: 0>, TimeStamp=1453435, TSN=0, Data=b'\x15\x7C\x11\x42\x01\x01\x01', MacSrcAddr=0xD1BF, MsgResultRadius=29)
DEBUG (MainThread) [zigpy.application] Received a packet: ZigbeePacket(src=AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0xD1BF), 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=64639, data=Serialized[b'\x15|\x11B\x01\x01\x01'], tx_options=<TransmitOptions.NONE: 0>, radius=29, non_member_radius=0, lqi=63, rssi=None)
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Received ZCL frame: b'\x15|\x11B\x01\x01\x01'
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Decoded ZCL frame header: ZCLHeader(frame_control=FrameControl(frame_type=<FrameType.CLUSTER_COMMAND: 1>, is_manufacturer_specific=True, direction=<Direction.Server_to_Client: 0>, disable_default_response=1, reserved=0, *is_cluster=True, *is_general=False, *is_reply=False), manufacturer=4476, tsn=66, command_id=1, *direction=<Direction.Server_to_Client: 0>, *is_reply=False)
WARNING (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Unknown cluster command 1 b'\x01\x01'
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Received command 0x01 (TSN 66): b'\x01\x01'
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] No explicit handler for cluster command 0x01: b'\x01\x01'

2 dot button

DEBUG (MainThread) [zigpy_znp.api] Received command: AF.IncomingMsg.Callback(GroupId=0x0000, ClusterId=64639, SrcAddr=0xD1BF, SrcEndpoint=1, DstEndpoint=1, WasBroadcast=<Bool.false: 0>, LQI=57, SecurityUse=<Bool.false: 0>, TimeStamp=2806217, TSN=0, Data=b'\x15\x7C\x11\x43\x01\x02\x01', MacSrcAddr=0xD1BF, MsgResultRadius=29)
DEBUG (MainThread) [zigpy.application] Received a packet: ZigbeePacket(src=AddrModeAddress(addr_mode=<AddrMode.NWK: 2>, address=0xD1BF), 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=64639, data=Serialized[b'\x15|\x11C\x01\x02\x01'], tx_options=<TransmitOptions.NONE: 0>, radius=29, non_member_radius=0, lqi=57, rssi=None)
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Received ZCL frame: b'\x15|\x11C\x01\x02\x01'
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Decoded ZCL frame header: ZCLHeader(frame_control=FrameControl(frame_type=<FrameType.CLUSTER_COMMAND: 1>, is_manufacturer_specific=True, direction=<Direction.Server_to_Client: 0>, disable_default_response=1, reserved=0, *is_cluster=True, *is_general=False, *is_reply=False), manufacturer=4476, tsn=67, command_id=1, *direction=<Direction.Server_to_Client: 0>, *is_reply=False)
WARNING (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Unknown cluster command 1 b'\x02\x01'
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] Received command 0x01 (TSN 67): b'\x02\x01'
DEBUG (MainThread) [zigpy.zcl] [0xD1BF:1:0xfc7f] No explicit handler for cluster command 0x01: b'\x02\x01'

[MattWestb]

For both is the remote on original / factory firmware or is it updated by Dirigera ?
I have looking little and my have more endpoints and cluster but i was updating it and its now 0x01000032.
Signature:

  },
  "data": {
    "ieee": "**REDACTED**",
    "nwk": 43256,
    "manufacturer": "IKEA of Sweden",
    "model": "SYMFONISK sound remote gen2",
    "name": "IKEA of Sweden SYMFONISK sound remote gen2",
    "quirk_applied": false,
    "quirk_class": "zigpy.device.Device",
    "manufacturer_code": 4476,
    "power_source": "Battery or Unknown",
    "lqi": 206,
    "rssi": -54,
    "last_seen": "2023-02-27T13:52:48",
    "available": true,
    "device_type": "EndDevice",
    "signature": {
      "node_descriptor": "NodeDescriptor(logical_type=<LogicalType.EndDevice: 2>, complex_descriptor_available=0, user_descriptor_available=0, reserved=0, aps_flags=0, frequency_band=<FrequencyBand.Freq2400MHz: 8>, mac_capability_flags=<MACCapabilityFlags.AllocateAddress: 128>, manufacturer_code=4476, maximum_buffer_size=82, maximum_incoming_transfer_size=82, server_mask=11264, maximum_outgoing_transfer_size=82, descriptor_capability_field=<DescriptorCapability.NONE: 0>, *allocate_address=True, *is_alternate_pan_coordinator=False, *is_coordinator=False, *is_end_device=True, *is_full_function_device=False, *is_mains_powered=False, *is_receiver_on_when_idle=False, *is_router=False, *is_security_capable=False)",
      "endpoints": {
        "1": {
          "profile_id": 260,
          "device_type": "0x0006",
          "in_clusters": [
            "0x0000",
            "0x0001",
            "0x0003",
            "0x0020",
            "0x1000",
            "0xfc7c"
          ],
          "out_clusters": [
            "0x0003",
            "0x0004",
            "0x0006",
            "0x0008",
            "0x0019",
            "0x1000"
          ]
        },
        "2": {
          "profile_id": 260,
          "device_type": "0x0006",
          "in_clusters": [
            "0x0000",
            "0x0003",
            "0xfc80"
          ],
          "out_clusters": [
            "0x0003",
            "0x0004",
            "0xfc80"
          ]
        },
        "3": {
          "profile_id": 260,
          "device_type": "0x0006",
          "in_clusters": [
            "0x0000",
            "0x0003",
            "0xfc80"
          ],
          "out_clusters": [
            "0x0003",
            "0x0004",
            "0xfc80"
          ]
        }
      }
    },
  }
}

[SamDeBlock]

Mine has definitely been updated to the latest firmware. I first connected it to the dirigera hub and then it automatically started updating.

[MrDodojo]

I did not connect it to a dirigera hub since I don't have one.

[MattWestb]

OK then its logic way @MrDodojo is having different configuration.
We must doing 2 device classes so both updated and not updated devices is working OK.
@MrDodojo pleas dont updating your device we need it for doing testing then IKEA have locking the chip so its not possible dumping the original firmware (that i normally doing) and flashing it back for doing firmware downgrading.

[MattWestb]

@TheJulianJES I have getting the signature working OK and the quirk is loading for both device classes.
The V1 is using only EP1 for all commands and V2 is using EP1 for Light commands and EP2 for button 1 and EP3 for button 2 extra commands from cluster V1 0xFC7F / V20xFC80.

From the V1 log:

[0x0664:1:0xfc7f] Unknown cluster command 1 b'\x01\x01' = B1 Short
[0x0664:1:0xfc7f] Unknown cluster command 1 b'\x02\x01' = B2 Short
[0x0664:1:0xfc7f] Unknown cluster command 1 b'\x01\x02' = B1 Duble
[0x0664:1:0xfc7f] Unknown cluster command 1 b'\x02\x03' = B2 Held

The V2 is not reporting then its need EP 2 and 3 being bound and i dont knowing how to do that.

The next problems is the DA is crazy dim up is not triggered and left and right is triggered for both.

Can you taking one look if you can see what i have doing wrong ?

symfonisk2.zip

Thanks in advance !

[MichelBrodatzki]

I've just opened a pull request with a basic implementation for the E2123 with (probably) V1. Every button should work as a trigger for automations (and some buttons even with long press and double press).
Currently I'm struggling a bit with passing arguments as both ARGS and PARAMS (or with passing the at all as PARAMS) with the listener_event(...) approach.

@MattWestb I'm quite new to creating device handlers and I don't have an updated E2123 at hand to test my theories, but maybe the event listener approach might be a way to make implementing V2 easier? (i.e. passing the command actions from EP2 and 3 to the custom LevelControlCluster)

[MattWestb]

Great thanks for working on the quirk for our devices @MichelBrodatzki !!

I have not testing it only looking how you have doing things and im not one code warier so i cant saying it its working or how good / bad it is only testing and see if its working OK or not.
First is better putting Ver1 for version in the device class name so not need renaming it later and remaking the tests and then its easy adding the variant 2 and so on.
Also put the firmware version in the device class dock string is good.

You is having WWAH_CLUSTER_ID in the signature and replacing it with IKEA_CLUSTER_ID that is not making any sense and can making problem if we need using the cluster in the future.

In the INIT you is making one device class ShortcutCluster for cluster 0xFC7F = OK but the Ver 2 is using cluster 0xfc80 for chortcut function on EP 2 and 3 (i must paring it with Dirigera and sniffing it for verifying it). Its very likely we need making 2 different device classes for getting it working but wait until i have sniffing the functions how Dirigera is doing it.

The device automatons shall working with only putting one of more args / parms but my test DAs is spinning completely but i getting the right events from the device and its likely we is hitting one bug in HA that braking some functions (very deep and not oft seen but its there) so take it with "little salt" for the moment until we have testing it more or finding other versions that working OK.

I starting sniffing Dirigera an then i installing your quirk and testing the V1 functions.