Sonoff SWV-BSP Smart Water Valve improvements

[micz]

I added these features to the Sonoff SWV-BSP Smart Water Valve (see #3298):

• Water Leakage binary sensor
• Water Shortage binary sensor
• on_time attribute, representing the number of seconds after opening before the valve automatically closes.
• A custom behaviour for the On command:
  1. If on_time == 0 it's a normal On command (0x01)
  2. If on_time != 0 it sends a on_with_timed_off (0x42), with the on_time numbers of seconds sets in the attribute

This is my first attempt at creating a Quirk.
Any advice on whether I'm following the correct way would be appreciated.
Thank you!

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 91.03%. Comparing base (b87ac89) to head (633ae03).
Report is 1 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3930      +/-   ##
==========================================
+ Coverage   91.00%   91.03%   +0.02%     
==========================================
  Files         328      328              
  Lines       10656    10687      +31     
==========================================
+ Hits         9698     9729      +31     
  Misses        958      958              

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

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[fgsch]

FWIW, I have a similar PR minus the on_time in #3910.

[micz]

Thank you @fgsch, I've updated the code.
The on_time is the feature I need as a failsafe if the Zigbee connection fails.
What do you think about it? Have you tried it?

I didn't see your PR, I'm sorry.
I saw that you changed the Cluster name, do you think it's better to change it here also?
Thank you!

[fgsch]

Thank you @fgsch, I've updated the code.

👍

The on_time is the feature I need as a failsafe if the Zigbee connection fails. What do you think about it? Have you tried it?

I haven't tried it yet.

IIUC you are using the attribute for the automatic valve close if there is no water together with the timing irrigation command for this purpose? Is this correct?

I didn't see your PR, I'm sorry. I saw that you changed the Cluster name, do you think it's better to change it here also? Thank you!

No worries. I changed the name to match other devices. Might as well do it here but really up to you.

[micz]

IIUC you are using the attribute for the automatic valve close if there is no water together with the timing irrigation command for this purpose? Is this correct?

I'm sorry I don't understand your question.

I added the on_time attribute to let the user decide how much time set for the auto close (0 = no autoclose).
Then, I use that attribute in the command to determine whether it needs to be changed to 0x42.

I added also the two alarms, because I found your PR #3346 that added the attributes and I read that the other PRs in ZHA needed for the attribute_converter were done, but I didn't found your last PR, so I added them here.

[fgsch]

[..]
I'm sorry I don't understand your question.

I added the on_time attribute to let the user decide how much time set for the auto close (0 = no autoclose). Then, I use that attribute in the command to determine whether it needs to be changed to 0x42.

That attribute, 0x5011, is used to turn the valve off if there is no water for the specified amount of time (as per https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/src/devices/sonoff.ts#L1447).

This PR uses this attribute as a timer, which is later used with command 0x42 for timed irrigation (as per https://github.com/Koenkk/zigbee-herdsman-converters/blob/master/src/devices/sonoff.ts#L329-L363).

Effectively, this is changing what 0x5011 is used for, assuming I understood correctly.
Maybe there is a better way to implement this that does not (ab)use existing attributes.

[micz]

Now I understand.
It's my first quirk so any help in more than appreciated! 😄

My idea was to keep a single switch but let the user set a timeout and then send a 42 instead of a 01.

I found no way to add and store that value. Trying to figure it out I found that parameter, but I didn't get it was used for water shortage.
I tried to find a solution in other quirks v2, but I didn't find anything.
In z2m you could send a different command issuing a 42, but in ZHA it's different. If I got it right.

Could you point me in the right direction of adding an optional timeout in the device config?
Thank you!

[fgsch]

[..]

Could you point me in the right direction of adding an optional timeout in the device config? Thank you!

I'm not sure. Perhaps one of the devs could help.

[micz]

@fgsch, are you the reviewer who needs to respond based on the label?
Thank you.

[TheJulianJES]

No, it's a label for me (or other reviewers) that an answer/review/help is needed.
I'll come back to this when I find some time.

[micz]

Ok, thank you.