Add NodOn SIN-4-FP-21 quirk

[ikruglov]

Proposed change

This PR adds a quirk for SIN-4-FP-21 (PilotWire). The device reports itself as a SmartPlug but it has special manufacturer-specific cluster which allows setting the following modes:

        Off = 0x00
        Comfort = 0x01
        Eco = 0x02
        FrostProtection = 0x03
        ComfortMinus1 = 0x04
        ComfortMinus2 = 0x05

Additional information

The result look like this in Home Assitant:

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 88.74%. Comparing base (fa734ad) to head (606521e).

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3364      +/-   ##
==========================================
+ Coverage   88.71%   88.74%   +0.02%     
==========================================
  Files         306      308       +2     
  Lines        9820     9843      +23     
==========================================
+ Hits         8712     8735      +23     
  Misses       1108     1108              

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

[ikruglov]

@TheJulianJES I've re-pushed commits to use the v2 interface of QuirkBuilder().
Unfortunately, I didn't find an example of how to write tests for it. The tests that I wrote for the previous version didn't work due to compatibility issues, I believe.

If you think tests are necessary here, please give me an example of any test that uses the v2 interface.

[pounard]

Any news on this? I would love this to be merged, I myself own a bunch of those modules.

[lboue]

Please validate. I need this quirk as well

[ikruglov]

@TheJulianJES, I have a question. I didn't find a better place to ask it.

There is a slight problem with this quirk. An entity added to HA gets the '_none' suffix (see attached picture). I would expect it to get the '_pilot_wire_mode' suffix. Of course, one can rename the HA entity, but getting it right from the start is better.

I did a lot of debugging on my side but got lost, to be honest. I see that the ZHA objects receive the correct _unique_id_suffix value (which was my initial suspicion). But HA's entity still has '_none'.

This problem is not only with an enum but also with a configuration number. I'm preparing a PR to allow configuring impulse mode on NodOn switches (similar to this). My entity also has the _none suffix.

I'd appreciate your help or guidance.

P.S. With no success, I've tried setting translation_key and fallback_name attributes in quirks.

[TheJulianJES]

The none suffix is caused by the fact that HA doesn't have a value for the translation key. In future versions, HA will fall back to `fallback_name.
When your PR is merged, the quirks bump merged to ZHA, the ZHA bump merged to HA, we'd need to add the translation key to HA then.

[ikruglov]

The none suffix is caused by the fact that HA doesn't have a value for the translation key. In future versions, HA will fall back to `fallback_name.

When your PR is merged, the quirks bump merged to ZHA, the ZHA bump merged to HA, we'd need to add the translation key to HA then.

Thank you for the answer. Can you point out where I should add it in HA? I want to try it locally. I will change HA's code in my installation.