From 9b3212e12f8fac8a66c445fa72a7931ca0d28fa6 Mon Sep 17 00:00:00 2001 From: Marcel van der Veldt Date: Wed, 3 Jul 2024 15:20:16 +0200 Subject: [PATCH 1/2] Add custom cluster definition for ThirdReality Energy reporting --- matter_server/common/custom_clusters.py | 90 ++++++++++++++++++++++++- 1 file changed, 89 insertions(+), 1 deletion(-) diff --git a/matter_server/common/custom_clusters.py b/matter_server/common/custom_clusters.py index 0f20d2ae..aea86383 100644 --- a/matter_server/common/custom_clusters.py +++ b/matter_server/common/custom_clusters.py @@ -12,7 +12,7 @@ ClusterObjectDescriptor, ClusterObjectFieldDescriptor, ) -from chip.tlv import float32 +from chip.tlv import float32, uint from matter_server.common.helpers.util import parse_attribute_path @@ -357,6 +357,94 @@ def attribute_type(cls) -> ClusterObjectFieldDescriptor: value: float32 = 0 +@dataclass +class ThirdRealityMeteringCluster(Cluster, CustomClusterMixin): + """Custom (vendor-specific) PowerMetering cluster for ThirdReality.""" + + id: ClassVar[int] = 0x130DFC02 + + @ChipUtility.classproperty + def descriptor(cls) -> ClusterObjectDescriptor: + """Return descriptor for this cluster.""" + return ClusterObjectDescriptor( + Fields=[ + ClusterObjectFieldDescriptor( + Label="currentSummationDelivered", Tag=0x0000, Type=uint + ), + ClusterObjectFieldDescriptor( + Label="instantaneousDemand", Tag=0x0200, Type=uint + ), + ] + ) + + currentSummationDelivered: uint | None = None + instantaneousDemand: uint | None = None + + class Attributes: + """Attributes for the custom Cluster.""" + + @dataclass + class CurrentSummationDelivered( + ClusterAttributeDescriptor, CustomClusterAttributeMixin + ): + """CurrentSummationDelivered represents the most recent summed value of Energy consumed in the premise. + + CurrentSummationDelivered is updated continuously as new measurements are made. + This attribute is Read only. + Value is set to zero when leave command is received (beginning version 2.6.15), + or local factory reset(10s) is performed on the device.. + """ + + @ChipUtility.classproperty + def cluster_id(cls) -> int: + """Return cluster id.""" + return 0x130DFC02 + + @ChipUtility.classproperty + def attribute_id(cls) -> int: + """Return attribute id.""" + return 0x0000 + + @ChipUtility.classproperty + def attribute_type(cls) -> ClusterObjectFieldDescriptor: + """Return attribute type.""" + return ClusterObjectFieldDescriptor(Type=uint) + + value: uint = 0 + + @dataclass + class InstantaneousDemand( + ClusterAttributeDescriptor, CustomClusterAttributeMixin + ): + """ + InstantaneousDemand represents the current Demand of Energy delivered at the premise. + + Device is able measure only positive values indicate Demand delivered to the premise. + InstantaneousDemand is updated continuously as new measurements are made. + The frequency of updates to this field is specific to the metering device, + but should be within the range of once every second to once every 5 seconds. + The same multiplier and divisor values used for Current Summation Delivered (Energy) will be used. + If connected load is below 1W, this attribute is set to 0 and no accumulation of energy is done. + """ + + @ChipUtility.classproperty + def cluster_id(cls) -> int: + """Return cluster id.""" + return 0x130DFC02 + + @ChipUtility.classproperty + def attribute_id(cls) -> int: + """Return attribute id.""" + return 0x0400 + + @ChipUtility.classproperty + def attribute_type(cls) -> ClusterObjectFieldDescriptor: + """Return attribute type.""" + return ClusterObjectFieldDescriptor(Type=uint) + + value: uint = 0 + + def check_polled_attributes(node_data: MatterNodeData) -> set[str]: """Check if custom attributes are present in the node data that need to be polled.""" attributes_to_poll: set[str] = set() From a046b52e5a86fd3121dc141d727ca9ed930986c1 Mon Sep 17 00:00:00 2001 From: Marcel van der Veldt Date: Wed, 3 Jul 2024 15:31:56 +0200 Subject: [PATCH 2/2] Update matter_server/common/custom_clusters.py Co-authored-by: Stefan Agner --- matter_server/common/custom_clusters.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/matter_server/common/custom_clusters.py b/matter_server/common/custom_clusters.py index aea86383..f5aae331 100644 --- a/matter_server/common/custom_clusters.py +++ b/matter_server/common/custom_clusters.py @@ -372,7 +372,7 @@ def descriptor(cls) -> ClusterObjectDescriptor: Label="currentSummationDelivered", Tag=0x0000, Type=uint ), ClusterObjectFieldDescriptor( - Label="instantaneousDemand", Tag=0x0200, Type=uint + Label="instantaneousDemand", Tag=0x0400, Type=uint ), ] )