Merge pull request #281 from plugwise/p1-v1

P1 legacy: collect data from /core/modules

Author: bouwew

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
 
-## Ongoing
+## v0.27.9: P1 legacy: collect data from /core/modules
 
+- Collect P1 legacy data from /core/modules - fix for [#368](https://github.com/plugwise/plugwise-beta/issues/368)
 - `Dependencies`: Default to python 3.11
 - `Development`
   - Improved markdown (i.e. markup and contents), added linter for markdown & added code owners
@@ -41,7 +42,7 @@
 
 ## v0.25.14: Improve, bugfix
 
-- Anna+Elga: final solution for [#312](https://github.com/plugwise/plugwise-beta/issues/320)
+- Anna+Elga: final solution for [#320](https://github.com/plugwise/plugwise-beta/issues/320)
 - Related to [Core Issue 83068](https://github.com/home-assistant/core/issues/83068): handle actuator_functionality or sensor depending on which one is present
 
 ## v0.25.13: Anna+Elga, OnOff device: base heating_state, cooling_state on central_heating_state key only

plugwise/constants.py

@@ -456,6 +456,11 @@
     "voltage_phase_two": UOM(ELECTRIC_POTENTIAL_VOLT),
     "voltage_phase_three": UOM(ELECTRIC_POTENTIAL_VOLT),
 }
+P1_LEGACY_MEASUREMENTS: Final[dict[str, UOM]] = {
+    "electricity_consumed": UOM(POWER_WATT),
+    "electricity_produced": UOM(POWER_WATT),
+    "gas_consumed": UOM(VOLUME_CUBIC_METERS),
+}
 # Thermostat and Plug/Stretch related measurements
 # Excluded:
 # zone_thermosstat: 'temperature_offset'

plugwise/helper.py

@@ -39,6 +39,7 @@
     LOCATIONS,
     LOGGER,
     NONE,
+    P1_LEGACY_MEASUREMENTS,
     P1_MEASUREMENTS,
     POWER_WATT,
     SENSORS,
@@ -1182,35 +1183,50 @@ def _heating_valves(self) -> int | None:
         return None if loc_found == 0 else open_valve_count
 
     def _power_data_peak_value(self, direct_data: DeviceData, loc: Munch) -> Munch:
-        """Helper-function for _power_data_from_location()."""
+        """Helper-function for _power_data_from_location() and _power_data_from_modules()."""
         loc.found = True
-        no_tariffs = False
+        # If locator not found look for P1 gas_consumed or phase data (without tariff)
+        # or for P1 legacy electricity_point_meter or gas_*_meter data
+        if loc.logs.find(loc.locator) is None:
+            if "log" in loc.log_type and (
+                "gas" in loc.measurement or "phase" in loc.measurement
+            ):
+                # Avoid double processing by skipping one peak-list option
+                if loc.peak_select == "nl_offpeak":
+                    loc.found = False
+                    return loc
 
-        # Only once try to find P1 Legacy values
-        if loc.logs.find(loc.locator) is None and self.smile_type == "power":
-            no_tariffs = True
-            # P1 Legacy: avoid doubling the net_electricity_..._point value by skipping one peak-list option
-            if loc.peak_select == "nl_offpeak":
+                loc.locator = (
+                    f'./{loc.log_type}[type="{loc.measurement}"]/period/measurement'
+                )
+                if loc.logs.find(loc.locator) is None:
+                    loc.found = False
+                    return loc
+            # P1 legacy point_meter has no tariff_indicator
+            elif "meter" in loc.log_type and (
+                "point" in loc.log_type or "gas" in loc.measurement
+            ):
+                # Avoid double processing by skipping one peak-list option
+                if loc.peak_select == "nl_offpeak":
+                    loc.found = False
+                    return loc
+
+                loc.locator = (
+                    f"./{loc.meas_list[0]}_{loc.log_type}/"
+                    f'measurement[@directionality="{loc.meas_list[1]}"]'
+                )
+                if loc.logs.find(loc.locator) is None:
+                    loc.found = False
+                    return loc
+            else:
                 loc.found = False
                 return loc
 
-            loc.locator = (
-                f'./{loc.log_type}[type="{loc.measurement}"]/period/measurement'
-            )
-
-        # Locator not found
-        if loc.logs.find(loc.locator) is None:
-            loc.found = False
-            return loc
-
         if (peak := loc.peak_select.split("_")[1]) == "offpeak":
             peak = "off_peak"
         log_found = loc.log_type.split("_")[0]
         loc.key_string = f"{loc.measurement}_{peak}_{log_found}"
-        # P1 with fw 2.x does not have tariff indicators for point_log values
-        if no_tariffs:
-            loc.key_string = f"{loc.measurement}_{log_found}"
-        if "gas" in loc.measurement:
+        if "gas" in loc.measurement or loc.log_type == "point_meter":
             loc.key_string = f"{loc.measurement}_{log_found}"
         if "phase" in loc.measurement:
             loc.key_string = f"{loc.measurement}"
@@ -1227,19 +1243,16 @@ def _power_data_from_location(self, loc_id: str) -> DeviceData:
         """
         direct_data: DeviceData = {}
         loc = Munch()
-
-        search = self._locations
         log_list: list[str] = ["point_log", "cumulative_log", "interval_log"]
         peak_list: list[str] = ["nl_peak", "nl_offpeak"]
         t_string = "tariff"
-        if self._smile_legacy:
-            t_string = "tariff_indicator"
 
+        search = self._locations
         loc.logs = search.find(f'./location[@id="{loc_id}"]/logs')
-        # meter_string = ".//{}[type='{}']/"
         for loc.measurement, loc.attrs in P1_MEASUREMENTS.items():
             for loc.log_type in log_list:
                 for loc.peak_select in peak_list:
+                    # meter_string = ".//{}[type='{}']/"
                     loc.locator = (
                         f'./{loc.log_type}[type="{loc.measurement}"]/period/'
                         f'measurement[@{t_string}="{loc.peak_select}"]'
@@ -1255,6 +1268,39 @@ def _power_data_from_location(self, loc_id: str) -> DeviceData:
 
         return direct_data
 
+    def _power_data_from_modules(self) -> DeviceData:
+        """Helper-function for smile.py: _get_device_data().
+
+        Collect the power-data from MODULES (P1 legacy only).
+        """
+        direct_data: DeviceData = {}
+        loc = Munch()
+        mod_list: list[str] = ["interval_meter", "cumulative_meter", "point_meter"]
+        peak_list: list[str] = ["nl_peak", "nl_offpeak"]
+        t_string = "tariff_indicator"
+
+        search = self._modules
+        mod_logs = search.findall("./module/services")
+        for loc.measurement, loc.attrs in P1_LEGACY_MEASUREMENTS.items():
+            loc.meas_list = loc.measurement.split("_")
+            for loc.logs in mod_logs:
+                for loc.log_type in mod_list:
+                    for loc.peak_select in peak_list:
+                        loc.locator = (
+                            f"./{loc.meas_list[0]}_{loc.log_type}/measurement"
+                            f'[@directionality="{loc.meas_list[1]}"][@{t_string}="{loc.peak_select}"]'
+                        )
+                        loc = self._power_data_peak_value(direct_data, loc)
+                        if not loc.found:
+                            continue
+
+                        direct_data = power_data_energy_diff(
+                            loc.measurement, loc.net_string, loc.f_val, direct_data
+                        )
+                        direct_data[loc.key_string] = loc.f_val  # type: ignore [literal-required]
+
+        return direct_data
+
     def _preset(self, loc_id: str) -> str | None:
         """Helper-function for smile.py: device_data_climate().
 

plugwise/smile.py

@@ -287,9 +287,12 @@ def _get_device_data(self, dev_id: str) -> DeviceData:
         if details["dev_class"] == "heater_central" and self._dhw_allowed_modes:
             device_data["dhw_modes"] = self._dhw_allowed_modes
 
-        # Get P1 smartmeter data from LOCATIONS
+        # Get P1 smartmeter data from LOCATIONS or MODULES
         if details["dev_class"] == "smartmeter":
-            device_data.update(self._power_data_from_location(details["location"]))
+            if not self._smile_legacy:
+                device_data.update(self._power_data_from_location(details["location"]))
+            else:
+                device_data.update(self._power_data_from_modules())
 
         # Check availability of non-legacy wired-connected devices
         if not self._smile_legacy:
@@ -484,11 +487,6 @@ async def _full_update_device(self) -> None:
             self._appliances = await self._request(APPLIANCES)
             await self._update_domain_objects()
 
-        if self.smile_type != "power":
-            await self._update_domain_objects()
-            if not self._smile_legacy:
-                self._appliances = await self._request(APPLIANCES)
-
     async def _update_domain_objects(self) -> None:
         """Helper-function for smile.py: full_update_device() and async_update().
 
@@ -515,8 +513,10 @@ async def async_update(self) -> tuple[GatewayData, dict[str, DeviceData]]:
         """Perform an incremental update for updating the various device states."""
         if self.smile_type != "power":
             await self._update_domain_objects()
-        else:
+        elif not self._smile_legacy:
             self._locations = await self._request(LOCATIONS)
+        else:
+            self._modules = await self._request(MODULES)
 
         # P1 legacy has no appliances
         if not (self.smile_type == "power" and self._smile_legacy):

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "plugwise"
-version         = "0.27.8"
+version         = "0.27.9"
 license         = {file = "LICENSE"}
 description     = "Plugwise Smile (Adam/Anna/P1), Stretch and USB (Stick) module for Python 3."
 readme          = "README.md"

tests/test_smile.py

@@ -876,20 +876,20 @@ async def test_connect_smile_p1_v2(self):
                 "name": "P1",
                 "vendor": "Ene5\\T210-DESMR5.0",
                 "sensors": {
-                    "net_electricity_point": 456,
-                    "electricity_consumed_point": 456,
-                    "net_electricity_cumulative": 1019.161,
-                    "electricity_consumed_peak_cumulative": 1155.155,
+                    "net_electricity_point": 458,
+                    "electricity_consumed_point": 458,
+                    "net_electricity_cumulative": 1019.201,
+                    "electricity_consumed_peak_cumulative": 1155.195,
                     "electricity_consumed_off_peak_cumulative": 1642.74,
-                    "electricity_consumed_peak_interval": 210,
+                    "electricity_consumed_peak_interval": 250,
                     "electricity_consumed_off_peak_interval": 0,
                     "electricity_produced_point": 0,
                     "electricity_produced_peak_cumulative": 1296.136,
                     "electricity_produced_off_peak_cumulative": 482.598,
                     "electricity_produced_peak_interval": 0,
                     "electricity_produced_off_peak_interval": 0,
-                    "gas_consumed_cumulative": 584.431,
-                    "gas_consumed_interval": 0.014,
+                    "gas_consumed_cumulative": 584.433,
+                    "gas_consumed_interval": 0.016,
                 },
             },
         }
@@ -934,20 +934,20 @@ async def test_connect_smile_p1_v2_2(self):
                 "name": "P1",
                 "vendor": "Ene5\\T210-DESMR5.0",
                 "sensors": {
-                    "net_electricity_point": 456,
-                    "electricity_consumed_point": 456,
-                    "net_electricity_cumulative": 1019.161,
-                    "electricity_consumed_peak_cumulative": 1155.155,
+                    "net_electricity_point": 458,
+                    "electricity_consumed_point": 458,
+                    "net_electricity_cumulative": 1019.201,
+                    "electricity_consumed_peak_cumulative": 1155.195,
                     "electricity_consumed_off_peak_cumulative": 1642.74,
-                    "electricity_consumed_peak_interval": 210,
+                    "electricity_consumed_peak_interval": 250,
                     "electricity_consumed_off_peak_interval": 0,
                     "electricity_produced_point": 0,
                     "electricity_produced_peak_cumulative": 1296.136,
                     "electricity_produced_off_peak_cumulative": 482.598,
                     "electricity_produced_peak_interval": 0,
                     "electricity_produced_off_peak_interval": 0,
-                    "gas_consumed_cumulative": 584.431,
-                    "gas_consumed_interval": 0.014,
+                    "gas_consumed_cumulative": 584.433,
+                    "gas_consumed_interval": 0.016,
                 },
             },
         }
@@ -3554,7 +3554,6 @@ async def test_connect_p1v3(self):
                     "electricity_consumed_peak_cumulative": 7702.167,
                     "electricity_consumed_off_peak_cumulative": 10263.159,
                     "electricity_consumed_peak_interval": 179,
-                    "electricity_produced_point": 0,
                     "electricity_produced_off_peak_point": 0,
                     "electricity_produced_peak_cumulative": 0.0,
                     "electricity_produced_off_peak_cumulative": 0.0,
@@ -3577,7 +3576,7 @@ async def test_connect_p1v3(self):
 
         await self.device_test(smile, testdata)
         assert smile.gateway_id == "a455b61e52394b2db5081ce025a430f3"
-        assert self.device_items == 28
+        assert self.device_items == 27
         assert not self.notifications
 
         await smile.close_connection()
@@ -3613,7 +3612,6 @@ async def test_connect_p1v3solarfake(self):
                     "electricity_consumed_peak_cumulative": 7702.167,
                     "electricity_consumed_off_peak_cumulative": 10263.159,
                     "electricity_consumed_peak_interval": 179,
-                    "electricity_produced_point": 0,
                     "electricity_produced_off_peak_point": 0,
                     "electricity_produced_peak_cumulative": 20.0,
                     "electricity_produced_off_peak_cumulative": 3.0,
@@ -3636,7 +3634,7 @@ async def test_connect_p1v3solarfake(self):
         assert not smile._smile_legacy
 
         await self.device_test(smile, testdata)
-        assert self.device_items == 28
+        assert self.device_items == 27
         assert not self.notifications
 
         await smile.close_connection()