Add support for Third Reality plug private cluster ID #3078

hwzolin · 2024-03-29T02:30:38Z

Proposed change

Add support for the "reset summation delivered" attribute for Third Reality plugs.

Additional information

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

Change-Id: I71ec608ad7ffec94719672fdf9016bf4e905b0ff

Change-Id: I1f256ba39952135fb5fdc47af8a05e282af01aa1

Change-Id: Ia82568ce4e96e049dfc3e0e4ca4c77ae3e700c2e

codecov · 2024-03-29T02:32:13Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.20%. Comparing base (9ccb69a) to head (15f4ed7).
Report is 18 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3078      +/-   ##
==========================================
+ Coverage   87.90%   88.20%   +0.29%     
==========================================
  Files         300      301       +1     
  Lines        9222     9412     +190     
==========================================
+ Hits         8107     8302     +195     
+ Misses       1115     1110       -5

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

Change-Id: Ie0c59078abd59d0337f85d80f580aab22b1fbc05

Change-Id: I80e87387f56ccbb1fb3be7257fdb99dc80dec958

Change-Id: I20507348a47fb94a2d28995eae0f374ca4573536

hwzolin · 2024-03-29T03:07:45Z

This code adds the private cluster ID to the Third Reality plug. Please help with it, thank you.

weihuan1111 · 2024-04-16T07:13:18Z

@dmulcahey @TheJulianJES Could you help to review the merge require, thanks.

TheJulianJES · 2024-04-21T23:46:47Z

zhaquirks/thirdreality/plug.py

+                PROFILE_ID: zha.PROFILE_ID,
+                DEVICE_TYPE: zha.DeviceType.SMART_PLUG,
+                INPUT_CLUSTERS: [
+                    Basic.cluster_id,  # 0x0000


Please remove all cluster id comments like # 0x0000.
It's inconsistent with most of our codebase.

TheJulianJES · 2024-04-21T23:47:52Z

zhaquirks/thirdreality/plug.py

+                PROFILE_ID: 0xA1E0,
+                DEVICE_TYPE: 0x0061,


There's a zgp profile for this.

PROFILE_ID: zgp.PROFILE_ID, DEVICE_TYPE: zgp.DeviceType.PROXY_BASIC,

TheJulianJES · 2024-04-21T23:48:03Z

zhaquirks/thirdreality/plug.py

+                PROFILE_ID: 0xA1E0,
+                DEVICE_TYPE: 0x0061,


Also use the zgp profile/constants here.

TheJulianJES · 2024-04-21T23:49:53Z

zhaquirks/thirdreality/plug.py

+        reset_summation_delivered: Final = ZCLAttributeDef(
+            id=RESET_SUMMATION_DELIVERED_ATTR_ID,
+            type=ControlMode,
+            is_manufacturer_specific=True,
+        )


Using a write_attr_button from quirks v2, a button would be added to HA that would set the attribute to CLEAR.
I'm assuming the plug automatically resets it back to NOT afterwards?

We only need to clear the summation delivered of PLUG to zero when the button is pressed.

Hello, is there any case of related projects that you mentioned in this functional code?

TheJulianJES · 2024-04-21T23:53:23Z

zhaquirks/thirdreality/plug.py

+RESET_SUMMATION_DELIVERED_ATTR_ID = 0x0000
+
+
+class ControlMode(t.uint8_t):


The NOT and CLEAR parts don't really have an effect, as this is not an enum.
There's a longer discussion here: #2723 (comment)

I'd just remove this section for now and set type=t.uint8_t for the attribute.
(When the button is later exposed to HA, it'll be clear that 1 means reset.)

hwzolin · 2024-04-26T09:31:05Z

Hello, please check it out again, thanks.

hwzolin · 2024-04-28T08:51:50Z

@TheJulianJES
Hello, what we added to our code this time is the ability to clear the summation delivered of the plug.
The cluster_id of this function is 0xFF03, and the attribute_id is 0x0000, and we need to send a value of 1 to achieve the effect of zeroing.
So far, I've taken care of some formatting issues as you've requested. As for what you said about implementing the function of a button through write_attr_button, I don't know how to call this function, can you please help me deal with it?

hwzolin · 2024-05-09T06:30:24Z

@TheJulianJES Hello, what we added to our code this time is the ability to clear the summation delivered of the plug. The cluster_id of this function is 0xFF03, and the attribute_id is 0x0000, and we need to send a value of 1 to achieve the effect of zeroing. So far, I've taken care of some formatting issues as you've requested. As for what you said about implementing the function of a button through write_attr_button, I don't know how to call this function, can you please help me deal with it?

@TheJulianJES @dmulcahey

TheJulianJES · 2024-05-09T20:20:04Z

There's an example in the quirks v2 docs PR and/or similar in the open Bosch PR.
I can help you better soon.

hwzolin · 2024-05-17T01:54:30Z

@TheJulianJES @dmulcahey
Hello, I would like to use the zha quirk v2 implementation to zero out the value of summation delivered by clicking the button on the page. But there are relatively few projects that can be referred to on the Internet, and I didn't find the open PR code you said earlier, so the result is as shown in the gif, although the button was clicked, but the program reported an error “Failed to call service button/press. 'reset_summation_delivered'”.

I put the code below. Could you please help me see if the code is written wrong? Thank you!

"""Third Reality Plug devices."""

from typing import Final

from zigpy.profiles import zha
from zigpy.quirks import CustomDevice
import zigpy.types as t
from zigpy.zcl.clusters.general import (
    Basic,
    GreenPowerProxy,
    Groups,
    Identify,
    OnOff,
    Ota,
    Scenes,
)
from zigpy.zcl.clusters.homeautomation import ElectricalMeasurement
from zigpy.zcl.clusters.smartenergy import Metering
from zigpy.zcl.foundation import BaseAttributeDefs, ZCLAttributeDef
from zigpy.quirks.v2 import add_to_registry_v2,CustomDeviceV2,EntityMetadata
from zigpy.quirks.registry import DeviceRegistry
from zhaquirks import CustomCluster
from zigpy.quirks.v2 import ClusterType
from zhaquirks.const import (
    DEVICE_TYPE,
    ENDPOINTS,
    INPUT_CLUSTERS,
    MODELS_INFO,
    OUTPUT_CLUSTERS,
    PROFILE_ID,
)
from zhaquirks.thirdreality import THIRD_REALITY

THIRD_REALITY_PLUG_CLUSTER_ID = 0xFF03
RESET_SUMMATION_DELIVERED_ATTR_ID = 0x0000

class ControlMode(t.uint8_t):
    """Reset mode for clear summation delivered."""

    CLEAR = 1


class ThirdRealityPlugCluster(CustomCluster):
    """ThirdReality Acceleration Cluster."""

    cluster_id = THIRD_REALITY_PLUG_CLUSTER_ID
    

    class AttributeDefs(BaseAttributeDefs):
        """Attribute definitions."""

        reset_summation_delivered: Final = ZCLAttributeDef(
            id=RESET_SUMMATION_DELIVERED_ATTR_ID,
            type=ControlMode,
            is_manufacturer_specific=True,
        )
    
registry = DeviceRegistry()
(
    add_to_registry_v2(
        THIRD_REALITY, "3RSP02028BZ"
    )
    .adds(ThirdRealityPlugCluster.cluster_id)
    .write_attr_button(
        attribute_name=ThirdRealityPlugCluster.AttributeDefs.reset_summation_delivered.name,
        attribute_value=RESET_SUMMATION_DELIVERED_ATTR_ID,
        cluster_id=ThirdRealityPlugCluster.cluster_id,
        cluster_type=ClusterType.Server,
        endpoint_id=1
    )
)

quirked_device = registry.get_device()
write_attribute_button: EntityMetadata = quirked_device.exposes_metadata[
    (1, ThirdRealityPlugCluster.cluster_id, ClusterType.Server)
][0]

puddly · 2024-05-21T15:10:16Z

Replacing .adds(ThirdRealityPlugCluster.cluster_id) with .adds(ThirdRealityPlugCluster) creates a button for me:

"""Third Reality Plug devices."""

from typing import Final

import zigpy.types as t
from zigpy.zcl.foundation import BaseAttributeDefs, ZCLAttributeDef
from zigpy.quirks.v2 import add_to_registry_v2
from zhaquirks import CustomCluster
from zigpy.quirks.v2 import ClusterType
from zhaquirks.thirdreality import THIRD_REALITY


class ThirdRealityPlugCluster(CustomCluster):
    cluster_id = 0xFF03

    class AttributeDefs(BaseAttributeDefs):
        reset_summation_delivered: Final = ZCLAttributeDef(
            id=0x0000,
            type=t.uint8_t,
            is_manufacturer_specific=True,
        )


(
    add_to_registry_v2(THIRD_REALITY, "3RSP02028BZ")
    .adds(ThirdRealityPlugCluster)
    .write_attr_button(
        attribute_name=ThirdRealityPlugCluster.AttributeDefs.reset_summation_delivered.name,
        attribute_value=0x01,
        cluster_id=ThirdRealityPlugCluster.cluster_id,
        cluster_type=ClusterType.Server,
        endpoint_id=1,
        translation_key="reset_summation_delivered"
    )
)

hwzolin · 2024-05-22T07:27:01Z

@puddly Thank you for your patience, now the code works. But I still have a question, that is, how to set the default name of the button control that appears on the page? As you can see, the current name is "Third Reality, Inc 3RSP0202...".

TheJulianJES · 2024-05-28T00:17:53Z

@hwzolin A translation key (default: attribute name) for Home Assistant/ZHA itself needs to be added.
This will be done when we merge the "quirks bump PR" into Home Assistant/ZHA. We just need to know the translation keys and default English translations.
As an example for another quirk, see: matt-sullivan/home-assistant-core@1dff881

hwzolin · 2024-05-28T02:50:34Z

@hwzolin A translation key (default: attribute name) for Home Assistant/ZHA itself needs to be added. This will be done when we merge the "quirks bump PR" into Home Assistant/ZHA. We just need to know the translation keys and default English translations. As an example for another quirk, see: matt-sullivan/home-assistant-core@1dff881

@TheJulianJES Do you mean like this: https://github.com/hwzolin/core/blob/dev/homeassistant/components/zha/strings.json?

hwzolin · 2024-05-28T07:08:05Z

@TheJulianJES Hello, I have updated the code about zha quirk v2, please check it out. If there is no problem, please merge it.

TheJulianJES · 2024-05-29T14:50:51Z

zhaquirks/thirdreality/plug.py

+
+
+(
+    add_to_registry_v2(THIRD_REALITY, "3RSP02028BZ")


You can use .also_applies_to(THIRD_REALITY, "3RSPE01044BZ") to make this quirk apply for both plugs.
The second quirk below can be removed then.

TheJulianJES · 2024-05-29T14:51:28Z

zhaquirks/thirdreality/plug.py

+        cluster_id=ThirdRealityPlugCluster.cluster_id,
+        cluster_type=ClusterType.Server,
+        endpoint_id=1,
+        translation_key="reset_summation_delivered"


I think ZHA should already use the attribute name as the translation key by default. Since it's the same, this isn't needed IIRC.

TheJulianJES · 2024-05-29T14:52:14Z

zhaquirks/thirdreality/plug.py

+        attribute_name=ThirdRealityPlugCluster.AttributeDefs.reset_summation_delivered.name,
+        attribute_value=0x01,
+        cluster_id=ThirdRealityPlugCluster.cluster_id,
+        cluster_type=ClusterType.Server,


The cluster_type is already Server by default, so this can be removed.

TheJulianJES · 2024-05-29T14:52:25Z

zhaquirks/thirdreality/plug.py

+        attribute_value=0x01,
+        cluster_id=ThirdRealityPlugCluster.cluster_id,
+        cluster_type=ClusterType.Server,
+        endpoint_id=1,


endpoint_id=1 is default, so this can be removed.

hwzolin added 3 commits March 29, 2024 10:04

Add support for Third Reality plug private cluster ID

753ebfd

Change-Id: I71ec608ad7ffec94719672fdf9016bf4e905b0ff

addAdditional notes

5528ba2

Change-Id: I1f256ba39952135fb5fdc47af8a05e282af01aa1

addAdditional Notes

20338a0

Change-Id: Ia82568ce4e96e049dfc3e0e4ca4c77ae3e700c2e

hwzolin added 3 commits March 29, 2024 10:33

add period

24dc534

Change-Id: Ie0c59078abd59d0337f85d80f580aab22b1fbc05

modify format

0113018

Change-Id: I80e87387f56ccbb1fb3be7257fdb99dc80dec958

modify format\3

fd91fa3

Change-Id: I20507348a47fb94a2d28995eae0f374ca4573536

TheJulianJES reviewed Apr 21, 2024

View reviewed changes

hwzolin added 2 commits April 26, 2024 17:24

modify format 2024.4.26

39ce767

Remove unnecessary code

88ad144

hwzolin added 4 commits May 28, 2024 14:52

Add code for zha quirk v2 that supports plug.

9ed6e51

Add code for zha quirk v2 that supports plug.

56e1d8c

Add code for zha quirk v2 that supports plug.

be1f947

Add code for zha quirk v2 that supports plug.

15f4ed7

TheJulianJES reviewed May 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Third Reality plug private cluster ID #3078

Add support for Third Reality plug private cluster ID #3078

hwzolin commented Mar 29, 2024 •

edited by TheJulianJES

codecov bot commented Mar 29, 2024 •

edited

hwzolin commented Mar 29, 2024

weihuan1111 commented Apr 16, 2024

TheJulianJES Apr 21, 2024

TheJulianJES Apr 21, 2024

TheJulianJES Apr 21, 2024

TheJulianJES Apr 21, 2024

hwzolin Apr 23, 2024

hwzolin Apr 25, 2024

TheJulianJES Apr 21, 2024

hwzolin Apr 22, 2024

hwzolin commented Apr 26, 2024

hwzolin commented Apr 28, 2024

hwzolin commented May 9, 2024

TheJulianJES commented May 9, 2024

hwzolin commented May 17, 2024

puddly commented May 21, 2024

hwzolin commented May 22, 2024

TheJulianJES commented May 28, 2024

hwzolin commented May 28, 2024

hwzolin commented May 28, 2024

TheJulianJES May 29, 2024

TheJulianJES May 29, 2024

TheJulianJES May 29, 2024

TheJulianJES May 29, 2024

		RESET_SUMMATION_DELIVERED_ATTR_ID = 0x0000


		class ControlMode(t.uint8_t):

Add support for Third Reality plug private cluster ID #3078

Are you sure you want to change the base?

Add support for Third Reality plug private cluster ID #3078

Conversation

hwzolin commented Mar 29, 2024 • edited by TheJulianJES

Proposed change

Additional information

Checklist

codecov bot commented Mar 29, 2024 • edited

Codecov Report

hwzolin commented Mar 29, 2024

weihuan1111 commented Apr 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwzolin commented Apr 26, 2024

hwzolin commented Apr 28, 2024

hwzolin commented May 9, 2024

TheJulianJES commented May 9, 2024

hwzolin commented May 17, 2024

puddly commented May 21, 2024

hwzolin commented May 22, 2024

TheJulianJES commented May 28, 2024

hwzolin commented May 28, 2024

hwzolin commented May 28, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hwzolin commented Mar 29, 2024 •

edited by TheJulianJES

codecov bot commented Mar 29, 2024 •

edited