Merge pull request #201 from vincentwolsink/net_consumption

Expose net consumption sensors

Author: vincentwolsink

custom_components/enphase_envoy/const.py

@@ -104,7 +104,7 @@ def get_model_name(model, hardware_id):
 SENSORS = (
     SensorEntityDescription(
         key="production",
-        name="Current Power Production",
+        name="Power Production",
         native_unit_of_measurement=UnitOfPower.WATT,
         state_class=SensorStateClass.MEASUREMENT,
         device_class=SensorDeviceClass.POWER,
@@ -127,7 +127,15 @@ def get_model_name(model, hardware_id):
     ),
     SensorEntityDescription(
         key="consumption",
-        name="Current Power Consumption",
+        name="Power Consumption",
+        native_unit_of_measurement=UnitOfPower.WATT,
+        state_class=SensorStateClass.MEASUREMENT,
+        device_class=SensorDeviceClass.POWER,
+        suggested_display_precision=0,
+    ),
+    SensorEntityDescription(
+        key="net_consumption",
+        name="Net Power Consumption",
         native_unit_of_measurement=UnitOfPower.WATT,
         state_class=SensorStateClass.MEASUREMENT,
         device_class=SensorDeviceClass.POWER,
@@ -345,14 +353,14 @@ def get_model_name(model, hardware_id):
     ),
     SensorEntityDescription(
         key="voltage",
-        name="Current Voltage",
+        name="Voltage",
         native_unit_of_measurement=UnitOfElectricPotential.VOLT,
         state_class=SensorStateClass.MEASUREMENT,
         device_class=SensorDeviceClass.VOLTAGE,
     ),
     SensorEntityDescription(
         key="ampere",
-        name="Current Amps",
+        name="Amperes",
         native_unit_of_measurement=UnitOfElectricCurrent.AMPERE,
         state_class=SensorStateClass.MEASUREMENT,
         device_class=SensorDeviceClass.CURRENT,
@@ -479,7 +487,7 @@ def get_model_name(model, hardware_id):
         [
             SensorEntityDescription(
                 key=f"production_{phase}",
-                name=f"Current Power Production {phase.upper()}",
+                name=f"Power Production {phase.upper()}",
                 native_unit_of_measurement=UnitOfPower.WATT,
                 state_class=SensorStateClass.MEASUREMENT,
                 device_class=SensorDeviceClass.POWER,
@@ -503,14 +511,14 @@ def get_model_name(model, hardware_id):
             ),
             SensorEntityDescription(
                 key=f"voltage_{phase}",
-                name=f"Current Voltage {phase.upper()}",
+                name=f"Voltage {phase.upper()}",
                 native_unit_of_measurement=UnitOfElectricPotential.VOLT,
                 state_class=SensorStateClass.MEASUREMENT,
                 device_class=SensorDeviceClass.VOLTAGE,
             ),
             SensorEntityDescription(
                 key=f"ampere_{phase}",
-                name=f"Current Amps {phase.upper()}",
+                name=f"Amperes {phase.upper()}",
                 native_unit_of_measurement=UnitOfElectricCurrent.AMPERE,
                 state_class=SensorStateClass.MEASUREMENT,
                 device_class=SensorDeviceClass.CURRENT,
@@ -550,7 +558,7 @@ def get_model_name(model, hardware_id):
             #
             SensorEntityDescription(
                 key=f"consumption_{phase}",
-                name=f"Current Power Consumption {phase.upper()}",
+                name=f"Power Consumption {phase.upper()}",
                 native_unit_of_measurement=UnitOfPower.WATT,
                 state_class=SensorStateClass.MEASUREMENT,
                 device_class=SensorDeviceClass.POWER,
@@ -572,6 +580,30 @@ def get_model_name(model, hardware_id):
                 device_class=SensorDeviceClass.ENERGY,
                 suggested_display_precision=0,
             ),
+            SensorEntityDescription(
+                key=f"net_consumption_{phase}",
+                name=f"Net Power Consumption {phase.upper()}",
+                native_unit_of_measurement=UnitOfPower.WATT,
+                state_class=SensorStateClass.MEASUREMENT,
+                device_class=SensorDeviceClass.POWER,
+                suggested_display_precision=0,
+            ),
+            SensorEntityDescription(
+                key=f"daily_net_consumption_{phase}",
+                name=f"Today's Net Energy Consumption {phase.upper()}",
+                native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
+                state_class=SensorStateClass.TOTAL,
+                device_class=SensorDeviceClass.ENERGY,
+                suggested_display_precision=0,
+            ),
+            SensorEntityDescription(
+                key=f"lifetime_net_consumption_{phase}",
+                name=f"Lifetime Net Energy Consumption {phase.upper()}",
+                native_unit_of_measurement=UnitOfEnergy.WATT_HOUR,
+                state_class=SensorStateClass.TOTAL,
+                device_class=SensorDeviceClass.ENERGY,
+                suggested_display_precision=0,
+            ),
         ]
     )
     ADDITIONAL_METRICS.extend(

custom_components/enphase_envoy/envoy_reader.py

@@ -593,6 +593,18 @@ def __new__(cls, *a, **kw):
                 full_path = f"{ct_path}.lines[{i}]{path}"
                 setattr(cls, f"{attr}_{phase}_value", full_path)
 
+        for attr, path in {
+            "net_consumption": ".wNow",
+            "daily_net_consumption": ".whToday",
+            "lifetime_net_consumption": ".whLifetime",
+        }.items():
+            ct_path = cls._net_consumption_ct
+            setattr(cls, f"{attr}_value", ct_path + path)
+
+            for i, phase in enumerate(["l1", "l2", "l3"]):
+                full_path = f"{ct_path}.lines[{i}]{path}"
+                setattr(cls, f"{attr}_{phase}_value", full_path)
+
         return EnvoyStandard.__new__(cls)
 
     _production = "endpoint_production_json.production[?(@.type=='inverters')]"
@@ -615,6 +627,7 @@ def lifetime_production(self):
         "endpoint_production_json.production[?(@.type=='eim' && @.activeCount > 0)]"
     )
     _consumption_ct = "endpoint_production_json.consumption[?(@.measurementType == 'total-consumption' && @.activeCount > 0)]"
+    _net_consumption_ct = "endpoint_production_json.consumption[?(@.measurementType == 'net-consumption' && @.activeCount > 0)]"
     voltage_value = _production_ct + ".rmsVoltage"
 
 

custom_components/enphase_envoy/envoy_test_data.py

@@ -70,6 +70,12 @@
         "installer_required": False,
         "optional": False,
     },
+    "device_data": {
+        "url": TEST_DATA + "endpoint_device_data.json",
+        "cache": 0,
+        "installer_required": False,
+        "optional": True,
+    },
     "devstatus": {
         "url": TEST_DATA + "endpoint_devstatus.json",
         "cache": 20,