Merge pull request #239 from plugwise/p1-3ph

P1: add 3-phase support

Author: bouwew

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+# v0.26.0: Smile P1: add support for 3-phase DSMR
+- Add support for the P1 4.4.0-beta firmware
+
 # v0.26.9: Hide cooling-related switch, binary_sensors when there is no cooling present
 - This fixes the unexpected appearance of new entities after the Adam 3.7.1 firmware-update
 - Properly handle an empty schedule, should fix #313

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.25.9"
+__version__ = "0.26.0"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/constants.py

@@ -15,6 +15,7 @@
 ATTR_STATE_CLASS: Final = "state_class"
 ATTR_UNIT_OF_MEASUREMENT: Final = "unit_of_measurement"
 DEGREE: Final = "°"
+ELECTRIC_POTENTIAL_VOLT: Final = "V"
 ENERGY_KILO_WATT_HOUR: Final = "kWh"
 ENERGY_WATT_HOUR: Final = "Wh"
 PERCENTAGE: Final = "%"
@@ -444,7 +445,16 @@
 P1_MEASUREMENTS: Final[dict[str, UOM]] = {
     "electricity_consumed": UOM(POWER_WATT),
     "electricity_produced": UOM(POWER_WATT),
+    "electricity_phase_one_consumed": UOM(POWER_WATT),
+    "electricity_phase_two_consumed": UOM(POWER_WATT),
+    "electricity_phase_three_consumed": UOM(POWER_WATT),
+    "electricity_phase_one_produced": UOM(POWER_WATT),
+    "electricity_phase_two_produced": UOM(POWER_WATT),
+    "electricity_phase_three_produced": UOM(POWER_WATT),
     "gas_consumed": UOM(VOLUME_CUBIC_METERS),
+    "voltage_phase_one": UOM(ELECTRIC_POTENTIAL_VOLT),
+    "voltage_phase_two": UOM(ELECTRIC_POTENTIAL_VOLT),
+    "voltage_phase_three": UOM(ELECTRIC_POTENTIAL_VOLT),
 }
 # Thermostat and Plug/Stretch related measurements
 # Excluded:
@@ -558,6 +568,12 @@
     "electricity_consumed_peak_interval",
     "electricity_consumed_peak_point",
     "electricity_consumed_point",
+    "electricity_phase_one_consumed",
+    "electricity_phase_two_consumed",
+    "electricity_phase_three_consumed",
+    "electricity_phase_one_produced",
+    "electricity_phase_two_produced",
+    "electricity_phase_three_produced",
     "electricity_produced",
     "electricity_produced_interval",
     "electricity_produced_off_peak_cumulative",
@@ -583,6 +599,9 @@
     "setpoint_low",
     "temperature_difference",
     "valve_position",
+    "voltage_phase_one",
+    "voltage_phase_two",
+    "voltage_phase_three",
     "water_pressure",
     "water_temperature",
 )
@@ -662,6 +681,12 @@ class SmileSensors(TypedDict, total=False):
     electricity_consumed_peak_interval: int
     electricity_consumed_peak_point: int
     electricity_consumed_point: float
+    electricity_phase_one_consumed: float
+    electricity_phase_two_consumed: float
+    electricity_phase_three_consumed: float
+    electricity_phase_one_produced: float
+    electricity_phase_two_produced: float
+    electricity_phase_three_produced: float
     electricity_produced: float
     electricity_produced_interval: float
     electricity_produced_off_peak_cumulative: float
@@ -687,6 +712,9 @@ class SmileSensors(TypedDict, total=False):
     setpoint_high: float
     setpoint_low: float
     temperature_difference: float
+    voltage_phase_one: float
+    voltage_phase_two: float
+    voltage_phase_three: float
     valve_position: float
     water_pressure: float
     water_temperature: float

plugwise/helper.py

@@ -174,7 +174,11 @@ def power_data_energy_diff(
     measurement: str, net_string: str, f_val: float | int, direct_data: DeviceData
 ) -> DeviceData:
     """Calculate differential energy."""
-    if "electricity" in measurement and "interval" not in net_string:
+    if (
+        "electricity" in measurement
+        and "phase" not in measurement
+        and "interval" not in net_string
+    ):
         diff = 1
         if "produced" in measurement:
             diff = -1
@@ -1141,6 +1145,8 @@ def _power_data_peak_value(self, direct_data: DeviceData, loc: Munch) -> Munch:
             loc.key_string = f"{loc.measurement}_{log_found}"
         if "gas" in loc.measurement:
             loc.key_string = f"{loc.measurement}_{log_found}"
+        if "phase" in loc.measurement:
+            loc.key_string = f"{loc.measurement}"
         loc.net_string = f"net_electricity_{log_found}"
         val = loc.logs.find(loc.locator).text
         loc.f_val = power_data_local_format(loc.attrs, loc.key_string, val)

plugwise/util.py

@@ -14,6 +14,7 @@
 
 from .constants import (
     ARBITRARY_DATE,
+    ELECTRIC_POTENTIAL_VOLT,
     ENERGY_KILO_WATT_HOUR,
     HW_MODELS,
     LOGADDR_OFFSET,
@@ -118,6 +119,8 @@ def format_measure(measure: str, unit: str) -> float | int | bool:
 
             if unit in SPECIAL_FORMAT:
                 result = float(f"{round(float_measure, 3):.3f}")
+            elif unit == ELECTRIC_POTENTIAL_VOLT:
+                result = float(f"{round(float_measure, 1):.1f}")
             else:
                 if abs(float_measure) < 10:
                     result = float(f"{round(float_measure, 2):.2f}")

tests/test_smile.py

@@ -5067,6 +5067,141 @@ async def test_connect_p1v4(self):
         await smile.close_connection()
         await self.disconnect(server, client)
 
+    @pytest.mark.asyncio
+    async def test_connect_p1v4_440beta_single(self):
+        """Test a P1 firmware 4 setup."""
+        testdata = {
+            "a455b61e52394b2db5081ce025a430f3": {
+                "dev_class": "gateway",
+                "firmware": "4.4.0",
+                "hardware": "AME Smile 2.0 board",
+                "location": "a455b61e52394b2db5081ce025a430f3",
+                "mac_address": "012345670001",
+                "model": "Gateway",
+                "name": "Smile P1",
+                "vendor": "Plugwise",
+                "binary_sensors": {"plugwise_notification": False},
+            },
+            "ba4de7613517478da82dd9b6abea36af": {
+                "dev_class": "smartmeter",
+                "location": "a455b61e52394b2db5081ce025a430f3",
+                "model": "KFM5KAIFA-METER",
+                "name": "P1",
+                "vendor": "SHENZHEN KAIFA TECHNOLOGY （CHENGDU） CO., LTD.",
+                "available": True,
+                "sensors": {
+                    "net_electricity_point": 581,
+                    "electricity_consumed_peak_point": 581,
+                    "electricity_consumed_off_peak_point": 0,
+                    "net_electricity_cumulative": 30718.064,
+                    "electricity_consumed_peak_cumulative": 13523.584,
+                    "electricity_consumed_off_peak_cumulative": 17194.48,
+                    "electricity_consumed_peak_interval": 9,
+                    "electricity_consumed_off_peak_interval": 0,
+                    "electricity_produced_peak_point": 0,
+                    "electricity_produced_off_peak_point": 0,
+                    "electricity_produced_peak_cumulative": 0.0,
+                    "electricity_produced_off_peak_cumulative": 0.0,
+                    "electricity_produced_peak_interval": 0,
+                    "electricity_produced_off_peak_interval": 0,
+                    "electricity_phase_one_consumed": 0,
+                    "electricity_phase_one_produced": 581,
+                },
+            },
+        }
+
+        self.smile_setup = "p1v4_440beta_single"
+        server, smile, client = await self.connect_wrapper()
+        assert smile.smile_hostname == "smile000000"
+
+        _LOGGER.info("Basics:")
+        _LOGGER.info(" # Assert type = power")
+        assert smile.smile_type == "power"
+        _LOGGER.info(" # Assert version")
+        assert smile.smile_version[0] == "4.4.0"
+        _LOGGER.info(" # Assert legacy")
+        assert not smile._smile_legacy
+
+        await self.device_test(smile, testdata)
+        assert smile.gateway_id == "a455b61e52394b2db5081ce025a430f3"
+        assert self.device_items == 31
+        assert not self.notifications
+
+        await smile.close_connection()
+        await self.disconnect(server, client)
+
+    @pytest.mark.asyncio
+    async def test_connect_p1v4_440beta_triple(self):
+        """Test a P1 firmware 4 setup."""
+        testdata = {
+            "03e65b16e4b247a29ae0d75a78cb492e": {
+                "dev_class": "gateway",
+                "firmware": "4.4.0",
+                "hardware": "AME Smile 2.0 board",
+                "location": "03e65b16e4b247a29ae0d75a78cb492e",
+                "mac_address": "012345670001",
+                "model": "Gateway",
+                "name": "Smile P1",
+                "vendor": "Plugwise",
+                "binary_sensors": {"plugwise_notification": False},
+            },
+            "b82b6b3322484f2ea4e25e0bd5f3d61f": {
+                "dev_class": "smartmeter",
+                "location": "03e65b16e4b247a29ae0d75a78cb492e",
+                "model": "XMX5LGF0010453051839",
+                "name": "P1",
+                "vendor": "XEMEX NV",
+                "available": True,
+                "sensors": {
+                    "net_electricity_point": 2422,
+                    "electricity_consumed_peak_point": 2422,
+                    "electricity_consumed_off_peak_point": 0,
+                    "net_electricity_cumulative": 220806.738,
+                    "electricity_consumed_peak_cumulative": 154585.221,
+                    "electricity_consumed_off_peak_cumulative": 66221.517,
+                    "electricity_consumed_peak_interval": 0,
+                    "electricity_consumed_off_peak_interval": 0,
+                    "electricity_produced_peak_point": 0,
+                    "electricity_produced_off_peak_point": 0,
+                    "electricity_produced_peak_cumulative": 0.0,
+                    "electricity_produced_off_peak_cumulative": 0.0,
+                    "electricity_produced_peak_interval": 0,
+                    "electricity_produced_off_peak_interval": 0,
+                    "electricity_phase_one_consumed": 0,
+                    "electricity_phase_two_consumed": 0,
+                    "electricity_phase_three_consumed": 0,
+                    "electricity_phase_one_produced": 1737,
+                    "electricity_phase_two_produced": 200,
+                    "electricity_phase_three_produced": 486,
+                    "gas_consumed_cumulative": 15263.4,
+                    "gas_consumed_interval": 0.0,
+                    "voltage_phase_one": 230.3,
+                    "voltage_phase_two": 232.8,
+                    "voltage_phase_three": 232.6,
+                },
+            },
+        }
+
+        self.smile_setup = "p1v4_440beta_triple"
+        server, smile, client = await self.connect_wrapper()
+        assert smile.smile_hostname == "smile000000"
+
+        _LOGGER.info("Basics:")
+        _LOGGER.info(" # Assert type = power")
+        assert smile.smile_type == "power"
+        _LOGGER.info(" # Assert version")
+        assert smile.smile_version[0] == "4.4.0"
+        _LOGGER.info(" # Assert legacy")
+        assert not smile._smile_legacy
+
+        await self.device_test(smile, testdata)
+        assert smile.gateway_id == "03e65b16e4b247a29ae0d75a78cb492e"
+        assert self.device_items == 40
+        assert not self.notifications
+
+        await smile.close_connection()
+        await self.disconnect(server, client)
+
     @pytest.mark.asyncio
     async def test_fail_legacy_system(self):
         """Test erroneous legacy stretch system."""

userdata/p1v4_440beta_single/core.domain_objects.xml

@@ -269,8 +269,8 @@
 		<vendor_model>smile</vendor_model>
 		<hardware_version>AME Smile 2.0 board</hardware_version>
 		<firmware_version>4.4.0</firmware_version>
-		<mac_address>C49300136E15</mac_address>
-		<wifi_mac_address>C49300136E13</wifi_mac_address>
+		<mac_address>012345670001</mac_address>
+		<wifi_mac_address>012345670002</wifi_mac_address>
 		<short_id>abcdefgh</short_id>
 		<send_data>true</send_data>
 		<anonymous>false</anonymous>

userdata/p1v4_440beta_triple/core.domain_objects.xml

@@ -112,8 +112,8 @@
 		<vendor_model>smile</vendor_model>
 		<hardware_version>AME Smile 2.0 board</hardware_version>
 		<firmware_version>4.4.0</firmware_version>
-		<mac_address>C49300137E71</mac_address>
-		<wifi_mac_address>C49300137E6F</wifi_mac_address>
+		<mac_address>012345670001</mac_address>
+		<wifi_mac_address>012345670002</wifi_mac_address>
 		<short_id>abcdefgh</short_id>
 		<send_data>false</send_data>
 		<anonymous>false</anonymous>