Add support for the Valve platform

[puddly]

This PR adds support for the Valve platform from Home Assistant.

This is a bit of a strange platform because the ZCL R8 spec does not actually support valves in any way. There are no clusters, there are no device types, nothing. So this functionality is again provided by an entity class relying on the existence of OnOff + (optional) LevelControl, accessible at the moment only with YAML platform overrides. It is a lower priority than the generic Switch entity and thus will never be discovered by default. This will be available for quirks to use in the near future.

[puddly]

These tests are sort of auto-generated and will be rewritten later.

[codecov]

Codecov Report

❌ Patch coverage is 87.58170% with 19 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.30%. Comparing base (a0d4782) to head (8663724).
⚠️ Report is 5 commits behind head on dev.

Files with missing lines	Patch %	Lines
zha/application/platforms/valve/__init__.py	85.92%	19 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev     #673      +/-   ##
==========================================
- Coverage   97.44%   97.30%   -0.14%     
==========================================
  Files          62       64       +2     
  Lines       10733    10883     +150     
==========================================
+ Hits        10459    10590     +131     
- Misses        274      293      +19     

☔ 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.

[dmulcahey]

I can provide diagnostic files for:

{
  "node_descriptor": {
    "logical_type": 2,
    "complex_descriptor_available": 0,
    "user_descriptor_available": 0,
    "reserved": 0,
    "aps_flags": 0,
    "frequency_band": 8,
    "mac_capability_flags": 128,
    "manufacturer_code": 4447,
    "maximum_buffer_size": 82,
    "maximum_incoming_transfer_size": 82,
    "server_mask": 11264,
    "maximum_outgoing_transfer_size": 82,
    "descriptor_capability_field": 0
  },
  "endpoints": {
    "1": {
      "profile_id": "0x0104",
      "device_type": "0x0000",
      "input_clusters": [
        "0x0000",
        "0x0001",
        "0x0003",
        "0x0006",
        "0xfcc0"
      ],
      "output_clusters": [
        "0x000a",
        "0x0019"
      ]
    }
  },
  "manufacturer": "Aqara",
  "model": "lumi.valve.agl001",
  "class": "zigpy.device.Device"
}

and

{
  "node_descriptor": {
    "logical_type": 2,
    "complex_descriptor_available": 0,
    "user_descriptor_available": 0,
    "reserved": 0,
    "aps_flags": 0,
    "frequency_band": 8,
    "mac_capability_flags": 128,
    "manufacturer_code": 4098,
    "maximum_buffer_size": 82,
    "maximum_incoming_transfer_size": 512,
    "server_mask": 11264,
    "maximum_outgoing_transfer_size": 512,
    "descriptor_capability_field": 0
  },
  "endpoints": {
    "1": {
      "profile_id": "0x0104",
      "device_type": "0x0100",
      "input_clusters": [
        "0x0000",
        "0x0004",
        "0x0005",
        "0x0006"
      ],
      "output_clusters": [
        "0x0019"
      ]
    }
  },
  "manufacturer": "_TYZB01_rifa0wlb",
  "model": "TS0011",
  "class": "zigpy.device.Device"
}

if they would be helpful.

[puddly]

Thanks! It looks like these are ON_OFF_SWITCH and ON_OFF_LIGHT, definitely valves 😅.

[Hedda]

I think merging this PR and matching device-specific quirks could close #528 (valve support feature request) however believe that matching device type support also needs to be added to the downstream zha component in Home Assistant’s core as well for valve entiry to be exposed in Home Assistant?

• Add full native support in zha for the Valve entity (device type exposed in Home Assistant)? #528

By the way, I think that this should probably also be kind of similar to the new PRs by @TheJulianJES that add siren entity by adding basic siren device support for Zigbee devices which often rely on OnOff as well?

• Add basic siren #665

• Remove non-ZCL siren select entities for basic sirens #666

• Add quirks v2 siren entity based on SwitchMetadata #667

• Add quirks v2 siren entity based on ZCLEnumMetadata #668

Also see related PR:

• Migrate all platforms to abstract base classes #662

And it could maybe also be of interest to be aware these two PRs for Home Assistant’s core:

• Add is_closed state attribute to valve home-assistant/core#165227

• Add valve.opened and valve.closed triggers home-assistant/core#165160

[Hedda]

Not sure if helpful but attached below is a diagnostic file from a SONOFF Zigbee Smart Water Valve (SONOFF SWV) device:

• SONOFF Zigbee Smart Water Valve ( SONOFF SWV).json

Also see these related Device Support Request in the zha-device-handlers repo:

• [Device Support Request] Sonoff SWV-BSP Smart Water Valve zha-device-handlers#3298

  • [Device Support Request] Sonoff SWV Smart Water Valve - timer function zha-device-handlers#4340

Update; Sonoff have also released four additional models of they Zigbee Smart Water Valve and all looks to expose same:

• https://www.zigbee2mqtt.io/devices/SWV.html
• https://www.zigbee2mqtt.io/devices/SWV-ZFE.html
• https://www.zigbee2mqtt.io/devices/SWV-ZFU.html
• https://www.zigbee2mqtt.io/devices/SWV-ZNE.html
• https://www.zigbee2mqtt.io/devices/SWV-ZNU.html

SONOFF SWV model is at least just exposed as an ON_OFF_SWITCH for controls:

[Hedda]

FYI, quickly looking through list of other water shutoff valves on Z2M supported devices it seems some expose it differently:

• https://www.zigbee2mqtt.io/supported-devices/#s=valve

  • https://www.zigbee2mqtt.io/devices/TS0601_water_switch.html

  • https://www.zigbee2mqtt.io/devices/ZVL-DUAL.html

  • https://www.zigbee2mqtt.io/devices/QT06_2.html

  • https://www.zigbee2mqtt.io/devices/GX02.html

  • https://www.zigbee2mqtt.io/devices/VA4220ZB.html