Merge pull request #19 from claudegel/sedna-flow-meeter

Sedna flow meeter

Author: claudegel

README.md

@@ -402,7 +402,62 @@ Following are the cluster/attributes set for reproting in Neviweb:
 |ActivePower|0x0B04|0x050B|0x29|30|600|0x64|
 |Energy reading|0x0702|0x0000|0x29|299|1799|int|
 |Safety water temp reporting|0xFF01|0x0076|DataType.UINT8|0|86400|null|
-  
+
+# Setting the flow meter model for your VA422xZB valve 2n gen.
+To add your flow meter to your valve, you need to use the service ZHA Toolkit: Write Attribute. The data to set the flow meter is written in an attr_type array. The command is different for each type of flow meter:
+- FS4220: (3/4 inch)
+```
+service: zha_toolkit.attr_write
+data:
+  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
+  endpoint: 1
+  cluster: 0xff01
+  attribute: 0x0240
+  attr_type: 0x48
+  attr_val: [32, 12, 0, 194, 17, 0, 0, 136, 119, 0, 0, 1, 0, 0, 0]
+  read_before_write: true
+  read_after_write: true
+```
+- FS4221: (one inch)
+```
+service: zha_toolkit.attr_write
+data:
+  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
+  endpoint: 1
+  cluster: 0xff01
+  attribute: 0x0240
+  attr_type: 0x48
+  attr_val: [32, 12, 0, 159, 38, 0, 0, 76, 85, 1, 0, 1, 0, 0, 0]
+  read_before_write: true
+  read_after_write: true
+```
+- FS4222: (1.5 inch)
+```
+service: zha_toolkit.attr_write
+data:
+  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
+  endpoint: 1
+  cluster: 0xff01
+  attribute: 0x0240
+  attr_type: 0x48
+  attr_val: [32, 12, 0, 1, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0]
+  read_before_write: true
+  read_after_write: true
+```
+- No flow meter:
+```
+service: zha_toolkit.attr_write
+data:
+  ieee: 50:0b:91:40:00:03:ed:b0 <-- your valve ieee
+  endpoint: 1
+  cluster: 0xff01
+  attribute: 0x0240
+  attr_type: 0x48
+  attr_val: [32, 12, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0]
+  read_before_write: true
+  read_after_write: true
+```
+
 ## Light switch and dimmer double tap, long press reporting : 
 Sinopé light switches (SW2500ZB), dimmer (DM2500ZB and DM2550ZB) supports single, double and long click, but requires to enable device reporting on attribute 0x0054, cluster 0xff01 to get the action fired in ZHA. To proceed use zha_toolkit services and follow the example bellow : 
 

switch.py

@@ -1,7 +1,8 @@
 """Module to handle quirks of the Sinopé Technologies switches.
 
 Supported devices, SP2600ZB, SP2610ZB, RM3250ZB, RM3500ZB,
-VA4200WZ, VA4201WZ, VA4200ZB, VA4201ZB, VA4220ZB, VA4221ZB and MC3100ZB.
+VA4200WZ, VA4201WZ, VA4200ZB, VA4201ZB, VA4220ZB, VA4221ZB and MC3100ZB,
+2nd gen VA4220ZB, VA4221ZB with flow meeter FS4220, FS4221.
 """
 
 import zigpy.profiles.zha as zha_p
@@ -22,10 +23,12 @@
 )
 from zigpy.zcl.clusters.homeautomation import Diagnostic, ElectricalMeasurement
 from zigpy.zcl.clusters.lightlink import LightLink
-from zigpy.zcl.clusters.measurement import RelativeHumidity, TemperatureMeasurement
+from zigpy.zcl.clusters.measurement import RelativeHumidity, TemperatureMeasurement, FlowMeasurement
 from zigpy.zcl.clusters.security import IasZone
 from zigpy.zcl.clusters.smartenergy import Metering
 
+from zigpy.zcl.foundation import Array
+
 from zhaquirks.const import (
     DEVICE_TYPE,
     ENDPOINTS,
@@ -38,6 +41,7 @@
 
 SINOPE_MANUFACTURER_CLUSTER_ID = 0xFF01
 CURTEMP = 0x0000
+FLOWMETER = 0x0000
 
 
 class SinopeManufacturerCluster(CustomCluster):
@@ -49,6 +53,41 @@ class KeypadLock(t.enum8):
         Unlocked = 0x00
         Locked = 0x01
 
+    class FlowAlarm(t.enum8):
+        """Alarm abnormal flow."""
+
+        Off = 0x00
+        On = 0x01
+
+    class AlarmAction(t.enum8):
+        """Flow alarm action."""
+
+        Nothing = 0x00
+        Notify = 0x01
+        Close = 0x02
+        Close_notify = 0x03
+
+    class PowerSource(t.uint32_t):
+        """Valve power souce types."""
+
+        Battery = 0x00000000
+        ACUPS_01 = 0x00000001
+        DC_power = 0x0001d4c0
+
+    class EmergencyPower(t.uint32_t):
+        """Valve emergency power souce types."""
+
+        Battery = 0x00000000
+        ACUPS_01 = 0x00000001
+        Battery_ACUPS_01 = 0x0000003c
+
+    class AbnormalAction(t.bitmap16):
+        """Action in case of abnormal flow detected."""
+
+        Nothing = 0x0000
+        Notify = 0x0001
+        Close_notify = 0x0003
+
     class ColdStatus(t.enum8):
         """cold_load_pickup_status values."""
 
@@ -63,6 +102,20 @@ class TankSize(t.enum8):
         Gal_60 = 0x03
         Gal_80 = 0x04
 
+    class FlowDuration(t.uint32_t):
+        """tank_size values."""
+
+        M_15 = 0x0384
+        M_30 = 0x0708
+        M_45 = 0x0A8C
+        M_60 = 0x0E10
+        M_75 = 0x1194
+        M_90 = 0x1518
+        H_3 = 0x2A30
+        H_6 = 0x5460
+        H_12 = 0xA8C0
+        H_24 = 0x15180
+
     cluster_id = SINOPE_MANUFACTURER_CLUSTER_ID
     name = "Sinopé Manufacturer specific"
     ep_attribute = "sinope_manufacturer_specific"
@@ -71,27 +124,97 @@ class TankSize(t.enum8):
         0x0002: ("keypad_lockout", KeypadLock, True),
         0x0003: ("firmware_number", t.uint16_t, True),
         0x0004: ("firmware_version", t.CharacterString, True),
+        0x0010: ("outdoor_temp", t.int16s, True),
         0x0013: ("tank_size", TankSize, True),
         0x0030: ("unknown_attr_2", t.uint8_t, True),
         0x0060: ("connected_load", t.uint16_t, True),
-        0x0070: ("currentLoad", t.bitmap8, True),
+        0x0070: ("current_load", t.bitmap8, True),
         0x0076: ("dr_config_water_temp_min", t.uint8_t, True),
         0x0077: ("dr_config_water_temp_time", t.uint8_t, True),
         0x0078: ("dr_wt_time_on", t.uint16_t, True),
+        0x0080: ("unknown_attr_4", t.uint32_t, True),
+        0x0090: ("current_summation_delivered", t.uint32_t, True),
         0x00A0: ("timer", t.uint32_t, True),
         0x00A1: ("timer_countdown", t.uint32_t, True),
+        0x0101: ("unknown_attr_9", Array, True),
         0x0200: ("status", t.bitmap32, True),
+        0x0221: ("unknown_attr_3", t.bitmap16, True),
+        0x0230: ("alarm_flow_threshold", FlowAlarm, True),
+        0x0231: ("alarm_options", AlarmAction, True),
+        0x0240: ("flow_meter_config", Array, True),
+        0x0241: ("countdown", t.uint32_t, True),
+        0x0250: ("power_source", PowerSource, True),
+        0x0251: ("emergency_power_source", EmergencyPower, True),
+        0x0252: ("abnormal_flow_duration", FlowDuration, True),
+        0x0253: ("abnormal_flow_action", AbnormalAction, True),
         0x0283: ("cold_load_pickup_status", ColdStatus, True),
         0xFFFD: ("cluster_revision", t.uint16_t, True),
     }
 
 
+class CustomBasicCluster(CustomCluster, Basic):
+    """Custom Basic Cluster."""
+
+    class PowerSource(t.enum8):
+        """Power source."""
+
+        Unknown = 0x0000
+        Battery = 0x0003
+        DC_source = 0x0004
+        ACUPS_01 = 0x0081
+        ACUPS01 = 0x0082
+
+    attributes = Basic.attributes.copy()
+    attributes.update(
+        {
+            0x0007: ("power_source", PowerSource, True),
+        }
+    )
+
+    
 class CustomMeteringCluster(CustomCluster, Metering):
     """Custom Metering Cluster."""
 
+    class ValveStatus(t.bitmap8):
+        """valve_status."""
+
+        Off = 0x00
+        Off_armed = 0x01
+        On = 0x02
+
+    class UnitOfMeasure(t.enum8):
+        """unit_of_measure."""
+
+        KWh = 0x00
+        Lh = 0x07
+
     DIVISOR = 0x0302
     _CONSTANT_ATTRIBUTES = {DIVISOR: 1000}
 
+    attributes = Metering.attributes.copy()
+    attributes.update(
+        {
+            0x0200: ("status", ValveStatus, True),
+            0x0300: ("unit_of_measure", UnitOfMeasure, True),
+        }
+    )
+
+
+class CustomDeviceTemperatureCluster(CustomCluster, DeviceTemperature):
+    """Custom DeviceTemperature Cluster."""
+
+    def _update_attribute(self, attrid, value):
+        if attrid == CURTEMP:
+            super()._update_attribute(attrid, value*100)
+
+
+class CustomFlowMeasurementCluster(CustomCluster, FlowMeasurement):
+    """Custom FlowMeasurement Cluster."""
+
+    def _update_attribute(self, attrid, value):
+        if attrid == FLOWMETER:
+            super()._update_attribute(attrid, value/10)
+
 
 class CustomDeviceTemperatureCluster(CustomCluster, DeviceTemperature):
     """Custom DeviceTemperature Cluster."""
@@ -248,6 +371,42 @@ class SinopeTechnologiesValve(CustomDevice):
     replacement = {
         ENDPOINTS: {
             1: {
+                INPUT_CLUSTERS: [
+                    CustomBasicCluster,
+                    PowerConfiguration.cluster_id,
+                    Identify.cluster_id,
+                    Groups.cluster_id,
+                    Scenes.cluster_id,
+                    OnOff.cluster_id,
+                    LevelControl.cluster_id,
+                    Diagnostic.cluster_id,
+                    SinopeManufacturerCluster,
+                ],
+                OUTPUT_CLUSTERS: [
+                    Identify.cluster_id,
+                    Ota.cluster_id,
+                ],
+            }
+        }
+    }
+
+
+class SinopeTechnologiesValveG2(CustomDevice):
+    """SinopeTechnologiesValveG2 custom device."""
+
+    signature = {
+        # <SimpleDescriptor(endpoint=1, profile=260,
+        # device_type=3, device_version=0,
+        # input_clusters=[0, 1, 3, 4, 5, 6, 8, 1026, 1280, 1794, 2821, 65281]
+        # output_clusters=[3, 6, 25]>
+        MODELS_INFO: [
+            (SINOPE, "VA4220ZB"),
+            (SINOPE, "VA4221ZB"),
+        ],
+        ENDPOINTS: {
+            1: {
+                PROFILE_ID: zha_p.PROFILE_ID,
+                DEVICE_TYPE: zha_p.DeviceType.LEVEL_CONTROLLABLE_OUTPUT,
                 INPUT_CLUSTERS: [
                     Basic.cluster_id,
                     PowerConfiguration.cluster_id,
@@ -256,11 +415,42 @@ class SinopeTechnologiesValve(CustomDevice):
                     Scenes.cluster_id,
                     OnOff.cluster_id,
                     LevelControl.cluster_id,
+                    TemperatureMeasurement.cluster_id,
+                    IasZone.cluster_id,
+                    Metering.cluster_id,
+                    Diagnostic.cluster_id,
+                    SINOPE_MANUFACTURER_CLUSTER_ID,
+                ],
+                OUTPUT_CLUSTERS: [
+                    Identify.cluster_id,
+                    OnOff.cluster_id,
+                    Ota.cluster_id,
+                ],
+            }
+        },
+    }
+
+    replacement = {
+        ENDPOINTS: {
+            1: {
+                INPUT_CLUSTERS: [
+                    CustomBasicCluster,
+                    PowerConfiguration.cluster_id,
+                    Identify.cluster_id,
+                    Groups.cluster_id,
+                    Scenes.cluster_id,
+                    OnOff.cluster_id,
+                    LevelControl.cluster_id,
+                    TemperatureMeasurement.cluster_id,
+                    CustomFlowMeasurementCluster,
+                    IasZone.cluster_id,
+                    CustomMeteringCluster,
                     Diagnostic.cluster_id,
                     SinopeManufacturerCluster,
                 ],
                 OUTPUT_CLUSTERS: [
                     Identify.cluster_id,
+                    OnOff.cluster_id,
                     Ota.cluster_id,
                 ],
             }