Add Awox Remote 99099 (EGLO Remote 2.0)

[vampubus]

Proposed change

I've added a quirk for the Awox 99099 remote (sold as EGLO Remote 2.0 or CONNECT-Z Remote), a cheap zigbee remote available in Europe. (https://www.eglo.com/de/fernbedienung-connect-z-99099.html)

Additional information

All buttons are mapped as short and long presses, except:

• On some buttons the device doesn't send anything on a long press so these are omitted.
• The device also doesn't transmit any packet on pressing the buttons '1', '2' and '3' as these are only for directly connecting the remote to other end devices.

There is still one issue remaining. On quite a few buttons the remote also sends an 'on' command in addition to the pressed button's command, so it's hard to write an automation that is triggered only by the 'on' button but not by the other buttons. I don't know if this can be resolved on a quirk level, you would have to filter out 'on' events that are received just before or after another button press event.

I'm completely new to python, zha and zigbee, so there are no tests yet.

Checklist

• The changes are tested and work correctly
• pre-commit checks pass / the code has been formatted using Black
• Tests have been added to verify that the new code works

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.65%. Comparing base (28da816) to head (7433fb9).
Report is 276 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #2646      +/-   ##
==========================================
+ Coverage   86.62%   86.65%   +0.03%     
==========================================
  Files         279      280       +1     
  Lines        8551     8575      +24     
==========================================
+ Hits         7407     7431      +24     
  Misses       1144     1144              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[BuddhaOhneHals]

I'd love to see this PR merged. Is there anything I can do to support this PR?

[jeino19]

@voxelcat
Thanks for your work. I have this remote (was bundled with an led-lamp).

I have downloaded your custom quirk, copied it to the folder configured in home assistant and restartet home assistant.
I can pair the remote but only "Identify" is available on "Diagnostic"-page.

Zigbee-Info shows the following:
IEEE: ** removed **
Nwk: 0x6667
Device Type: EndDevice
LQI: Unknown
RSSI: Unknown
Last seen: 2023-12-12T12:09:41
Power source: Battery or Unknown

No entry for "Quirk" (while the info for an Aqara-sensor shows "Quirk: zhaquirks.xiaomi.aqara.tvoc.TVOCMonitor2")

In configuration.yaml I have the following entry:
zha:
enable_quirks: true
custom_quirks_path: /config/custom_zha_quirks/
database_path: /config/zigbee.db

Version of home assistant is the current (2023.12.3), running in Docker on a Raspberry Pi 4.
Can anyone point me to what I am missing? Am I doing something wrong?

[macaholik]

@voxelcat
Thank you for the work, i have this remote and was looking for a way to get it working reliably in zha. I had to change the device identifier to ERCU_3groups_Zm but there are no events generated in zha. On what firmware version is your remote?

[BuddhaOhneHals]

@voxelcat Thank you for the work, i have this remote and was looking for a way to get it working reliably in zha. I had to change the device identifier to ERCU_3groups_Zm but there are no events generated in zha. On what firmware version is your remote?

I have the same issues.

[Xilonz]

My remote identifies as ECRU_3groups_Zm
I've added it to the models_info and now it kinda works.

There's a no way to pair groups to the devices group buttons is there?

[R00S]

My ECRU_3groups_Zm happily joins zha but nothing happens when i press the buttons even when assigning automations to them.

[R00S]

@voxelcat Thank you for the work, i have this remote and was looking for a way to get it working reliably in zha. I had to change the device identifier to ERCU_3groups_Zm but there are no events generated in zha. On what firmware version is your remote?

I have the same issues.

Me too. Also with the ERCU_3groups_Zm identifier. Did anyone manage to solve this?
My firmware is 2.7.3_1387, but i also had the exact same result with the firmware it was delivered with.

[Bluscream]

Ima drop this here in case someone wants to look at it

• https://community.home-assistant.io/t/how-to-listen-for-button-presses-on-zigbee-remote-control/722016
• https://gist.github.com/Bluscream/fd5f6502a372e7080c55107f7c029056

Apparently also Zigbee2MQTT has the same issue for some https://community.home-assistant.io/t/eglo-connect-z-with-home-assistent-cant-find-a-way-to-make-them-usable-with-my-home-assistent/378439/9

[Bluscream]

My remote identifies as ECRU_3groups_Zm I've added it to the models_info and now it kinda works.

There's a no way to pair groups to the devices group buttons is there?

@Xilonz you said you got it partially working? I can't even get it to show any buttons as entities when i add the model to the models_info array:

        MODELS_INFO: [
            ("AwoX", "TLSR82xx"),
            ("AwoX", "ERCU_3groups_Zm")
        ],

(also created a PR to accompany this small change vampubus#1)

Addendum: Just found out that i can create automatitions for the different buttons:

but they will never trigger

[ChristophCaina]

Hi, just saw this PR here and remembered, that I also have this remote laying around here for quite a while now...
Would love to see the PR merged :)

Unitl then, I will try to use the custom quirk and play around with it...

[Xilonz]

Pairing the device is really hard (takes several tries), once added it will sometimes work, but usually not.
With this quirk the group buttons won't work, there's no documented way to know what group is selected.

My next attempt would be to trigger the light link pairing on the light (if that's even possible) that I want to pair to the remote so they'll still be available in HA, and just accept that the remote doesn't communicate to HA.

[Bluscream]

just accept that the remote doesn't communicate to HA.

I just got a second zigbee stick and paired the remote to Zigbee2MQTT through there. It works flawlessly so far and i even created a automation for all the buttons and multiple profiles

https://community.home-assistant.io/t/how-to-listen-for-button-presses-on-zigbee-remote-control/722016/5?u=bluscream

[jayjayseal]

This remote works with the edge Version of zigbee2mqtt {it then also shows button presses i believe. If not, then work with the MQTT messages) . Switch MQTT output type to attributes and json, So all events get captured in multiple MQTT messages instead of 1 long json string and you can then work with the different messages it sends in the automations settings in HA.

Do not use the on function because the remote Almost Always sends the ON signaal before it sends the regular Blue, Green, red etc message.

It currently works with firmware 2.7.3 (2.7.5 is out too but not sure this the still works)