Support configuration of entity reporting for V2 quirks

[benbancroft]

Proposed change

This change hooks up the V2 Quirk report_config option to the cluster handler created for V2 quirks. It also 'claims' the cluster, which is required for reporting and binding hooks to work upon configuration of the cluster and previously wasn't being done for V2 Quirk clusters.

Additional information

Please refer to zigpy/zigpy#1490 for more information on the motivation behind this patch. This patch will need to be merged after that has been merged and zigpy dependency has been bumped.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.50%. Comparing base (2d15013) to head (69f6242).

Additional details and impacted files

@@           Coverage Diff           @@
##              dev     #254   +/-   ##
=======================================
  Coverage   96.50%   96.50%           
=======================================
  Files          61       61           
  Lines        9431     9439    +8     
=======================================
+ Hits         9101     9109    +8     
  Misses        330      330           

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

[dmulcahey]

needs a rebase

[benbancroft]

@dmulcahey I've just force pushed a rebase. The tests will continue to fail however, as this patch has dependeny on the zigpy PR, so this will require a further rebase once that merges.

[dmulcahey]

@dmulcahey I've just force pushed a rebase. The tests will continue to fail however, as this patch has dependeny on the zigpy PR, so this will require a further rebase once that merges.

My bad.. sorry for the unnecessary ping!!

[benbancroft]

I've just rebased against zigpy dependency update. All tests should now be passing.

[TheJulianJES]

Just noting (for myself) that claiming a cluster handler is what also makes ZHA configure and bind the cluster.

[TheJulianJES]

The attributes are also added to ZCL_INIT_ATTRS above this new code block.

If I'm looking at this correctly, we'll have them in both REPORT_CONFIG and ZCL_INIT_ATTRS and then have duplicates in uncached?

zha/zha/zigbee/cluster_handlers/__init__.py

Lines 458 to 460 in 11cf9ba

	cached = [a for a, cached in self.ZCL_INIT_ATTRS.items() if cached]
	uncached = [a for a, cached in self.ZCL_INIT_ATTRS.items() if not cached]
	uncached.extend([cfg["attr"] for cfg in self.REPORT_CONFIG])

We might want to move the new block before the ZCL_INIT_ATTRS block and then check in the ZCL_INIT_ATTRS block that they're not already in REPORT_CONFIG OR just remove them from ZCL_INIT_ATTRS in this line?

[ikruglov]

Hi.

Thanks for coming up with a proper solution for the problem of the Ikea VINDSTYRKA sensor's VOC index not being updated.

I want to say that this patch, together with my quirk (ikruglov/zha-device-handlers@c49d8e1), works well. I now have a properly updating VOC Index without workarounds, such as manually reading values.

I'd be happy to submit the PR for the quirk, but I thought you may already have one. So, I'll keep it to myself, meanwhile.

Thanks again.

[benbancroft]

Hi @TheJulianJES

Many thanks for reviewing this and catching the cacheablity issue - and apologies for my delay in getting back to you on this PR.

I've gone ahead and with the "just remove them from ZCL_INIT_ATTRS in this line" option, as arguably this is really a latent issue that is already possible to expose via old cluster API. I think the intention is for REPORT_CONFIG and ZCL_INIT_ATTRS to be mutually exclusive of each other anyway.

@ikruglov no worries. It certainly would be good to get that quirk in soon as I know it has been around in code review in various forms for a very long time now. Please do go ahead and submit your PR (I wasn't planning to myself).