Add quirk for Schneider Electric 1GANG/SHUTTER/1 (MEG5113-0300)

[cspurk]

Proposed change

Add a quirk for Schneider Electric 1GANG/SHUTTER/1 (MEG5113-0300) to

• correct the lift percentage (which is inverted).
• add some manufacturer-specific features.

Additional information

This PR is based on @axellebot’s work in #1705. As the latter is incomplete, I have removed the code of which I don’t know whether it works.

I have successfully tested the quirk with a real device connected to Home Assistant via ZHA.

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 ✅

Comparison is base (0df6f2b) 87.72% compared to head (a7ddd34) 87.81%.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #2928      +/-   ##
==========================================
+ Coverage   87.72%   87.81%   +0.09%     
==========================================
  Files         298      300       +2     
  Lines        9119     9187      +68     
==========================================
+ Hits         8000     8068      +68     
  Misses       1119     1119              

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

[TheJulianJES]

The changes mostly seem fine. However, I don't know if we want to ship a 6000 line readme file in the source.

Also, the cover implementation in ZHA is currently being reworked a bit:

• Clean up ZHA cover entity and add support for inverting cover entities derived from the window covering cluster home-assistant/core#108238

That might land in HA Core 2024.2.0 (betas). Since these quirks also invert the covers somewhat, it would be nice if they could be tested (with and without(?) quirk) whenever that PR is merged and released to HA Core.

[cspurk]

Thanks for the positive review, @TheJulianJES!

Fair enough, I’ve removed the README. Is there maybe a better place to put it? I suppose @axellebot’s idea behind the file was to have something similar to Zigbee2MQTT’s devices DB, just for zigpy. I thought about a wiki, but zha-device-handlers doesn’t have one.

Regarding home-assistant/core#108238: I can certainly test my device with/without the quirk once this has landed in a HA release. I doubt, though, that the new inversion logic will help here, as it mostly seems to be based on reversing the motor direction. I had tested that manually before implementing the quirk, and it just resulted in a swapping of the up/down push buttons – interestingly both on the wall and in the HA GUI. The opened/closed states in HA were still wrong.

[MattWestb]

I think device / vendor things is the best place in the Wiki https://github.com/zigpy/zigpy/wiki.

[TheJulianJES]

I thought about a wiki, but zha-device-handlers doesn’t have one.

I think putting quirks-related stuff in a quirks wiki would be good.

[TheJulianJES]

To stay consistent, can you remove the comments with the cluster IDs "everywhere"?
(not the SimpleDescriptor comments above though)

[TheJulianJES]

Also, to structure it like the rest of our repo, I'd get rid of the devices and clusters folders/package.
Just have zhaquirks/schneiderelectric and put the shared code/clusters/constants in __init__.py.
The shutters.py can go into that folder/package too.

[cspurk]

@MattWestb, @TheJulianJES, thanks for your feedback regarding the wiki. Should I maybe just create an initial structure for a zigpy/zha-device-handlers wiki?

@TheJulianJES, thanks again for the review. I’ve made the changes you requested.

[TheJulianJES]

Should I maybe just create an initial structure for a zigpy/zha-device-handlers wiki?

Yup, I think that's fine.

[cspurk]

Should I maybe just create an initial structure for a zigpy/zha-device-handlers wiki?

Yup, I think that's fine.

Ok, I’ve created a wiki home page and added a Schneider-specific page with the deleted “README” (mostly as in a4d596c).

[cspurk]

@TheJulianJES, as promised, I’ve tested HA 2024.2.0 (and hence home-assistant/core#108238) with and without the quirk from this PR:

• Without the quirk, the lift percentage is still inverted (just like before).
• The quirk continues to fix this (just like before).
• I can see the new invert switch in the GUI (with and without the quirk), however, it behaves like I described in a previous comment (and which is not useful for this Schneider Electric device).

[TheJulianJES]

LGTM, thanks!