plugwise 1.5.1a3__py3-none-any.whl → 1.6.0__py3-none-any.whl

plugwise/__init__.py

@@ -69,6 +69,7 @@ class Smile(SmileComm):
         self._elga = False
         self._is_thermostat = False
         self._last_active: dict[str, str | None] = {}
+        self._loc_data: dict[str, ThermoLoc] = {}
         self._on_off_device = False
         self._opentherm_device = False
         self._schedule_old_states: dict[str, dict[str, str]] = {}
@@ -76,7 +77,6 @@ class Smile(SmileComm):
         self._stretch_v2 = False
         self._target_smile: str = NONE
         self.gateway_id: str = NONE
-        self.loc_data: dict[str, ThermoLoc] = {}
         self.smile_fw_version: Version | None = None
         self.smile_hostname: str = NONE
         self.smile_hw_version: str | None = None
@@ -134,11 +134,11 @@ class Smile(SmileComm):
             self._elga,
             self._is_thermostat,
             self._last_active,
+            self._loc_data,
             self._on_off_device,
             self._opentherm_device,
             self._schedule_old_states,
             self.gateway_id,
-            self.loc_data,
             self.smile_fw_version,
             self.smile_hostname,
             self.smile_hw_version,
@@ -155,11 +155,11 @@ class Smile(SmileComm):
             self._request,
             self._websession,
             self._is_thermostat,
+            self._loc_data,
             self._on_off_device,
             self._opentherm_device,
             self._stretch_v2,
             self._target_smile,
-            self.loc_data,
             self.smile_fw_version,
             self.smile_hostname,
             self.smile_hw_version,
@@ -173,7 +173,7 @@ class Smile(SmileComm):
         )
 
         # Update all endpoints on first connect
-        await self._smile_api.full_update_device()
+        await self._smile_api.full_xml_update()
 
         return self.smile_version
 
@@ -298,17 +298,17 @@ class Smile(SmileComm):
         self.smile_legacy = True
         return return_model
 
-    async def full_update_device(self) -> None:
+    async def full_xml_update(self) -> None:
         """Helper-function used for testing."""
-        await self._smile_api.full_update_device()
+        await self._smile_api.full_xml_update()
 
-    def get_all_devices(self) -> None:
+    def get_all_gateway_entities(self) -> None:
         """Helper-function used for testing."""
-        self._smile_api.get_all_devices()
+        self._smile_api.get_all_gateway_entities()
 
     async def async_update(self) -> PlugwiseData:
-        """Perform an incremental update for updating the various device states."""
-        data = PlugwiseData({}, {})
+        """Update the various entities and their states."""
+        data = PlugwiseData(devices={}, gateway={})
         try:
             data = await self._smile_api.async_update()
             self.gateway_id = data.gateway["gateway_id"]

plugwise/common.py

@@ -11,8 +11,8 @@ from plugwise.constants import (
     SPECIAL_PLUG_TYPES,
     SWITCH_GROUP_TYPES,
     ApplianceType,
-    DeviceData,
-    ModelData,
+    GwEntityData,
+    ModuleData,
     SensorType,
 )
 from plugwise.util import (
@@ -40,7 +40,7 @@ class SmileCommon:
         self._heater_id: str
         self._on_off_device: bool
         self._opentherm_device: bool
-        self.gw_devices: dict[str, DeviceData]
+        self.gw_entities: dict[str, GwEntityData]
         self.smile_name: str
         self.smile_type: str
 
@@ -73,13 +73,12 @@ class SmileCommon:
         appl.name = "OpenTherm"
         locator_1 = "./logs/point_log[type='flame_state']/boiler_state"
         locator_2 = "./services/boiler_state"
-        mod_type = "boiler_state"
         # xml_1: appliance
         # xml_3: self._modules for legacy, self._domain_objects for actual
         xml_3 = return_valid(xml_3, self._domain_objects)
-        module_data = self._get_module_data(xml_1, locator_1, mod_type, xml_3)
+        module_data = self._get_module_data(xml_1, locator_1, xml_3)
         if not module_data["contents"]:
-            module_data = self._get_module_data(xml_1, locator_2, mod_type, xml_3)
+            module_data = self._get_module_data(xml_1, locator_2, xml_3)
         appl.vendor_name = module_data["vendor_name"]
         appl.hardware = module_data["hardware_version"]
         appl.model_id = module_data["vendor_model"] if not legacy else None
@@ -94,22 +93,22 @@ class SmileCommon:
     def _appl_thermostat_info(self, appl: Munch, xml_1: etree, xml_2: etree = None) -> Munch:
         """Helper-function for _appliance_info_finder()."""
         locator = "./logs/point_log[type='thermostat']/thermostat"
-        mod_type = "thermostat"
         xml_2 = return_valid(xml_2, self._domain_objects)
-        module_data = self._get_module_data(xml_1, locator, mod_type, xml_2)
+        module_data = self._get_module_data(xml_1, locator, xml_2)
         appl.vendor_name = module_data["vendor_name"]
         appl.model = module_data["vendor_model"]
         if appl.model != "ThermoTouch":  # model_id for Anna not present as stand-alone device
             appl.model_id = appl.model
             appl.model = check_model(appl.model, appl.vendor_name)
 
+        appl.available = module_data["reachable"]
         appl.hardware = module_data["hardware_version"]
         appl.firmware = module_data["firmware_version"]
         appl.zigbee_mac = module_data["zigbee_mac_address"]
 
         return appl
 
-    def _collect_power_values(self, data: DeviceData, loc: Munch, tariff: str, legacy: bool = False) -> None:
+    def _collect_power_values(self, data: GwEntityData, loc: Munch, tariff: str, legacy: bool = False) -> None:
         """Something."""
         for loc.peak_select in ("nl_peak", "nl_offpeak"):
             loc.locator = (
@@ -132,6 +131,19 @@ class SmileCommon:
             key = cast(SensorType, loc.key_string)
             data["sensors"][key] = loc.f_val
 
+    def _count_data_items(self, data: GwEntityData) -> None:
+        """When present, count the binary_sensors, sensors and switches dict-items, don't count the dicts.
+
+        Also, count the remaining single data items, the amount of dicts present have already been pre-subtracted in the previous step.
+        """
+        if "binary_sensors" in data:
+            self._count += len(data["binary_sensors"]) - 1
+        if "sensors" in data:
+            self._count += len(data["sensors"]) - 1
+        if "switches" in data:
+            self._count += len(data["switches"]) - 1
+        self._count += len(data)
+
     def _power_data_peak_value(self, loc: Munch, legacy: bool) -> Munch:
         """Helper-function for _power_data_from_location() and _power_data_from_modules()."""
         loc.found = True
@@ -161,8 +173,8 @@ class SmileCommon:
         measurement: str,
         net_string: SensorType,
         f_val: float | int,
-        direct_data: DeviceData,
-    ) -> DeviceData:
+        data: GwEntityData,
+    ) -> GwEntityData:
         """Calculate differential energy."""
         if (
             "electricity" in measurement
@@ -172,10 +184,10 @@ class SmileCommon:
             diff = 1
             if "produced" in measurement:
                 diff = -1
-            if net_string not in direct_data["sensors"]:
+            if net_string not in data["sensors"]:
                 tmp_val: float | int = 0
             else:
-                tmp_val = direct_data["sensors"][net_string]
+                tmp_val = data["sensors"][net_string]
 
             if isinstance(f_val, int):
                 tmp_val += f_val * diff
@@ -183,15 +195,16 @@ class SmileCommon:
                 tmp_val += float(f_val * diff)
                 tmp_val = float(f"{round(tmp_val, 3):.3f}")
 
-            direct_data["sensors"][net_string] = tmp_val
+            data["sensors"][net_string] = tmp_val
 
-        return direct_data
+        return data
 
-    def _create_gw_devices(self, appl: Munch) -> None:
-        """Helper-function for creating/updating gw_devices."""
-        self.gw_devices[appl.dev_id] = {"dev_class": appl.pwclass}
+    def _create_gw_entities(self, appl: Munch) -> None:
+        """Helper-function for creating/updating gw_entities."""
+        self.gw_entities[appl.entity_id] = {"dev_class": appl.pwclass}
         self._count += 1
         for key, value in {
+            "available": appl.available,
             "firmware": appl.firmware,
             "hardware": appl.hardware,
             "location": appl.location,
@@ -204,30 +217,30 @@ class SmileCommon:
         }.items():
             if value is not None or key == "location":
                 appl_key = cast(ApplianceType, key)
-                self.gw_devices[appl.dev_id][appl_key] = value
+                self.gw_entities[appl.entity_id][appl_key] = value
                 self._count += 1
 
-    def _device_data_switching_group(
-        self, device: DeviceData, data: DeviceData
+    def _entity_switching_group(
+        self, entity: GwEntityData, data: GwEntityData
     ) -> None:
-        """Helper-function for _get_device_data().
+        """Helper-function for _get_device_zone_data().
 
         Determine switching group device data.
         """
-        if device["dev_class"] in SWITCH_GROUP_TYPES:
+        if entity["dev_class"] in SWITCH_GROUP_TYPES:
             counter = 0
-            for member in device["members"]:
-                if self.gw_devices[member]["switches"].get("relay"):
+            for member in entity["members"]:
+                if self.gw_entities[member]["switches"].get("relay"):
                     counter += 1
             data["switches"]["relay"] = counter != 0
             self._count += 1
 
-    def _get_group_switches(self) -> dict[str, DeviceData]:
-        """Helper-function for smile.py: get_all_devices().
+    def _get_group_switches(self) -> dict[str, GwEntityData]:
+        """Helper-function for smile.py: get_all_gateway_entities().
 
         Collect switching- or pump-group info.
         """
-        switch_groups: dict[str, DeviceData] = {}
+        switch_groups: dict[str, GwEntityData] = {}
         # P1 and Anna don't have switchgroups
         if self.smile_type == "power" or self.smile(ANNA):
             return switch_groups
@@ -240,25 +253,22 @@ class SmileCommon:
             group_appliances = group.findall("appliances/appliance")
             for item in group_appliances:
                 # Check if members are not orphaned - stretch
-                if item.attrib["id"] in self.gw_devices:
+                if item.attrib["id"] in self.gw_entities:
                     members.append(item.attrib["id"])
 
             if group_type in SWITCH_GROUP_TYPES and members:
-                switch_groups.update(
-                    {
-                        group_id: {
-                            "dev_class": group_type,
-                            "model": "Switchgroup",
-                            "name": group_name,
-                            "members": members,
-                        },
-                    },
-                )
+                switch_groups[group_id] = {
+                    "dev_class": group_type,
+                    "model": "Switchgroup",
+                    "name": group_name,
+                    "members": members,
+                    "vendor": "Plugwise",
+                }
                 self._count += 4
 
         return switch_groups
 
-    def _get_lock_state(self, xml: etree, data: DeviceData, stretch_v2: bool = False) -> None:
+    def _get_lock_state(self, xml: etree, data: GwEntityData, stretch_v2: bool = False) -> None:
         """Helper-function for _get_measurement_data().
 
         Adam & Stretches: obtain the relay-switch lock state.
@@ -278,15 +288,14 @@ class SmileCommon:
         self,
         xml_1: etree,
         locator: str,
-        mod_type: str,
         xml_2: etree = None,
         legacy: bool = False,
-    ) -> ModelData:
+    ) -> ModuleData:
         """Helper-function for _energy_device_info_finder() and _appliance_info_finder().
 
         Collect requested info from MODULES.
         """
-        model_data: ModelData = {
+        module_data: ModuleData = {
             "contents": False,
             "firmware_version": None,
             "hardware_version": None,
@@ -295,36 +304,35 @@ class SmileCommon:
             "vendor_model": None,
             "zigbee_mac_address": None,
         }
-        # xml_1: appliance
+
         if (appl_search := xml_1.find(locator)) is not None:
+            link_tag = appl_search.tag
             link_id = appl_search.attrib["id"]
-            loc = f".//services/{mod_type}[@id='{link_id}']...."
-            if legacy:
-                loc = f".//{mod_type}[@id='{link_id}']...."
+            loc = f".//services/{link_tag}[@id='{link_id}']...."
             # Not possible to walrus for some reason...
             # xml_2: self._modules for legacy, self._domain_objects for actual
             search = return_valid(xml_2, self._domain_objects)
             module = search.find(loc)
             if module is not None:  # pylint: disable=consider-using-assignment-expr
-                model_data["contents"] = True
-                get_vendor_name(module, model_data)
-                model_data["vendor_model"] = module.find("vendor_model").text
-                model_data["hardware_version"] = module.find("hardware_version").text
-                model_data["firmware_version"] = module.find("firmware_version").text
-                self._get_zigbee_data(module, model_data, legacy)
+                module_data["contents"] = True
+                get_vendor_name(module, module_data)
+                module_data["vendor_model"] = module.find("vendor_model").text
+                module_data["hardware_version"] = module.find("hardware_version").text
+                module_data["firmware_version"] = module.find("firmware_version").text
+                self._get_zigbee_data(module, module_data, legacy)
 
-        return model_data
+        return module_data
 
-    def _get_zigbee_data(self, module: etree, model_data: ModelData, legacy: bool) -> None:
-        """Helper-function for _get_model_data()."""
+    def _get_zigbee_data(self, module: etree, module_data: ModuleData, legacy: bool) -> None:
+        """Helper-function for _get_module_data()."""
         if legacy:
             # Stretches
             if (router := module.find("./protocols/network_router")) is not None:
-                model_data["zigbee_mac_address"] = router.find("mac_address").text
+                module_data["zigbee_mac_address"] = router.find("mac_address").text
             # Also look for the Circle+/Stealth M+
             if (coord := module.find("./protocols/network_coordinator")) is not None:
-                model_data["zigbee_mac_address"] = coord.find("mac_address").text
+                module_data["zigbee_mac_address"] = coord.find("mac_address").text
         # Adam
         elif (zb_node := module.find("./protocols/zig_bee_node")) is not None:
-                model_data["zigbee_mac_address"] = zb_node.find("mac_address").text
-                model_data["reachable"] = zb_node.find("reachable").text == "true"
+                module_data["zigbee_mac_address"] = zb_node.find("mac_address").text
+                module_data["reachable"] = zb_node.find("reachable").text == "true"

plugwise/constants.py

@@ -81,6 +81,7 @@ HW_MODELS: Final[dict[str, str]] = {
 
 MAX_SETPOINT: Final[float] = 30.0
 MIN_SETPOINT: Final[float] = 4.0
+MODULE_LOCATOR: Final = "./logs/point_log/*[@id]"
 NONE: Final = "None"
 OFF: Final = "off"
 
@@ -123,7 +124,7 @@ P1_LEGACY_MEASUREMENTS: Final[dict[str, UOM]] = {
 # radiator_valve: 'uncorrected_temperature', 'temperature_offset'
 
 DEVICE_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
-    "humidity": UOM(PERCENTAGE),  # Specific for a Jip
+    "humidity": UOM(NONE),  # Specific for a Jip
     "illuminance": UOM(UNIT_LUMEN),  # Specific for an Anna
     "temperature": UOM(TEMP_CELSIUS),  # HA Core thermostat current_temperature
     "thermostat": DATA("setpoint", TEMP_CELSIUS),  # HA Core thermostat setpoint
@@ -189,6 +190,14 @@ OBSOLETE_MEASUREMENTS: Final[tuple[str, ...]] = (
     "outdoor_temperature",
 )
 
+# Zone/climate related measurements
+ZONE_MEASUREMENTS: Final[dict[str, DATA | UOM]] = {
+    "electricity_consumed": UOM(POWER_WATT),
+    "electricity_produced": UOM(POWER_WATT),
+    "relay": UOM(NONE),
+    "temperature": UOM(TEMP_CELSIUS),  # HA Core thermostat current_temperature
+}
+
 # Literals
 SMILE_P1 = "Smile P1"
 POWER = "power"
@@ -396,8 +405,8 @@ class GatewayData(TypedDict, total=False):
     smile_name: str
 
 
-class ModelData(TypedDict):
-    """The ModelData class."""
+class ModuleData(TypedDict):
+    """The Module data class."""
 
     contents: bool
     firmware_version: str | None
@@ -425,44 +434,44 @@ class SmileBinarySensors(TypedDict, total=False):
 class SmileSensors(TypedDict, total=False):
     """Smile Sensors class."""
 
-    battery: float
+    battery: int
     cooling_activation_outdoor_temperature: float
     cooling_deactivation_threshold: float
     dhw_temperature: float
     domestic_hot_water_setpoint: float
     temperature: float
-    electricity_consumed: int
-    electricity_consumed_interval:int
+    electricity_consumed: float
+    electricity_consumed_interval: float
     electricity_consumed_off_peak_cumulative: float
-    electricity_consumed_off_peak_interval: int
-    electricity_consumed_off_peak_point: int
+    electricity_consumed_off_peak_interval: float
+    electricity_consumed_off_peak_point: float
     electricity_consumed_peak_cumulative: float
-    electricity_consumed_peak_interval: int
-    electricity_consumed_peak_point: int
-    electricity_consumed_point: int
-    electricity_phase_one_consumed: int
-    electricity_phase_two_consumed: int
-    electricity_phase_three_consumed: int
-    electricity_phase_one_produced: int
-    electricity_phase_two_produced: int
-    electricity_phase_three_produced: int
-    electricity_produced: int
-    electricity_produced_interval: int
+    electricity_consumed_peak_interval: float
+    electricity_consumed_peak_point: float
+    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
-    electricity_produced_off_peak_interval: int
-    electricity_produced_off_peak_point: int
+    electricity_produced_off_peak_interval: float
+    electricity_produced_off_peak_point: float
     electricity_produced_peak_cumulative: float
-    electricity_produced_peak_interval: int
-    electricity_produced_peak_point: int
-    electricity_produced_point: int
+    electricity_produced_peak_interval: float
+    electricity_produced_peak_point: float
+    electricity_produced_point: float
     gas_consumed_cumulative: float
     gas_consumed_interval: float
     humidity: float
     illuminance: float
     intended_boiler_temperature: float
-    modulation_level: float
+    modulation_level: int
     net_electricity_cumulative: float
-    net_electricity_point: int
+    net_electricity_point: float
     outdoor_air_temperature: float
     outdoor_temperature: float
     return_temperature: float
@@ -470,7 +479,7 @@ class SmileSensors(TypedDict, total=False):
     setpoint_high: float
     setpoint_low: float
     temperature_difference: float
-    valve_position: float
+    valve_position: int
     voltage_phase_one: float
     voltage_phase_two: float
     voltage_phase_three: float
@@ -491,9 +500,9 @@ class ThermoLoc(TypedDict, total=False):
     """Thermo Location class."""
 
     name: str
-    primary: str | None
+    primary: list[str]
     primary_prio: int
-    secondary: set[str]
+    secondary: list[str]
 
 
 class ActuatorData(TypedDict, total=False):
@@ -507,8 +516,11 @@ class ActuatorData(TypedDict, total=False):
     upper_bound: float
 
 
-class DeviceData(TypedDict, total=False):
-    """The Device Data class, covering the collected and ordered output-data per device."""
+class GwEntityData(TypedDict, total=False):
+    """The Gateway Entity data class.
+
+    Covering the collected output-data per device or location.
+    """
 
     # Appliance base data
     dev_class: str
@@ -543,13 +555,13 @@ class DeviceData(TypedDict, total=False):
     select_gateway_mode: str
     select_regulation_mode: str
 
-    # Master Thermostats
+    # Thermostat-related
+    thermostats: dict[str, list[str]]
     # Presets:
     active_preset: str | None
     preset_modes: list[str] | None
     # Schedules:
     available_schedules: list[str]
-    last_used: str | None
     select_schedule: str
 
     climate_mode: str
@@ -570,5 +582,6 @@ class DeviceData(TypedDict, total=False):
 class PlugwiseData:
     """Plugwise data provided as output."""
 
+    devices: dict[str, GwEntityData]
     gateway: GatewayData
-    devices: dict[str, DeviceData]
+