weheat 2024.9.10rc3__tar.gz → 2024.9.23__tar.gz

{weheat-2024.9.10rc3/weheat.egg-info → weheat-2024.9.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weheat
-Version: 2024.9.10rc3
+Version: 2024.9.23
 Summary: Weheat Backend client
 Home-page: https://github.com/wefabricate/wh-python
 Author: Jesper Raemaekers

{weheat-2024.9.10rc3 → weheat-2024.9.23}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "weheat"
-version = "2024.09.10rc3"
+version = "2024.09.23"
 description = "Weheat Backend"
 authors = ["Jesper Raemaekers <jesper.raemaekers@wefabricate.com>", "Kjell van Straaten <kjell.van.straaten@wefabricate.com>"]
 license = "MIT"

{weheat-2024.9.10rc3 → weheat-2024.9.23}/setup.py

@@ -21,7 +21,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "weheat"
-VERSION = "2024.09.10rc3"
+VERSION = "2024.09.23"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

{weheat-2024.9.10rc3 → weheat-2024.9.23}/weheat/abstractions/discovery.py

@@ -26,11 +26,21 @@ class HeatPumpDiscovery:
             response = HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info('', 0, 1000, DeviceState.NUMBER_3 ,async_req=True).get()
             if response.status_code == 200:
                 for pump in response.data:
-                    model_string = "BlackBird P80 heat pump"
+                    # Model of the heat pump
+                    # - BlackBirdP80: BlackBird P80 heat pump (0)
+                    # - BlackBirdP60: BlackBird P60 heat pump (1)
+                    # - SparrowP60Brown: Sparrow P60 heat pump, colour brown (default) (2)
+                    # - SparrowP60Green: Sparrow P60 heat pump, colour green (3)
+                    # - SparrowP60Grey: Sparrow P60 heat pump, colour grey (4)
+                    # - FlintP40: Flint P40 heat pump (5)
+                    model_string = "Blackbird P80 heat pump"
                     if pump.model == 1:
-                        model_string = "BlackBird P60 heat pump"
-                    elif pump.model == 2:
+                        model_string = "Blackbird P60 heat pump"
+                    elif 2 <= pump.model <= 4:
                         model_string = "Sparrow P60 heat pump"
+                    elif pump.model == 5:
+                        model_string = "Flint P40 heat pump"
+
 
                     dhw = False
                     if pump.dhw_type is not None and pump.dhw_type == 1:

{weheat-2024.9.10rc3 → weheat-2024.9.23}/weheat/abstractions/heat_pump.py

@@ -1,3 +1,4 @@
+"""Weheat heat pump abstraction from the API."""
 from enum import Enum, auto
 from weheat.configuration import Configuration
 from weheat.api_client import ApiClient
@@ -5,10 +6,12 @@ from weheat.api.heat_pump_log_api import HeatPumpLogApi
 from weheat.api.energy_log_api import EnergyLogApi
 from datetime import datetime, timedelta
 
-START_DATE = datetime(2024, 1, 1, 0, 0, 0)
+# before this date no energy logs are available, so start from this point onwards
+START_DATE = datetime(2023, 1, 1, 0, 0, 0)
 
 
 class HeatPump:
+    """Heat pump class representing a heat pump."""
     class State(Enum):
         STANDBY = auto()
         WATER_CHECK = auto()
@@ -27,6 +30,7 @@ class HeatPump:
         self._energy_consumption = None
 
     def get_status(self, access_token: str):
+        """Updates the heat pump instance with data from the API."""
         try:
             config = Configuration(host=self._api_url, access_token=access_token)
 
@@ -60,12 +64,11 @@ class HeatPump:
 
         except Exception as e:
             self._last_log = None
+            self._energy_consumption = None
             raise e
 
-    def _update_properties(self):
-        pass
-
     def _if_available(self, key):
+        """Returns the value from the last logged value if available. None otherwise."""
         if self._last_log is not None and hasattr(self._last_log, key):
             return getattr(self._last_log, key)
         return None
@@ -78,54 +81,67 @@ class HeatPump:
 
     @property
     def water_inlet_temperature(self):
+        """The heat pump water inlet temperature."""
         return self._if_available("t_water_in")
 
     @property
     def water_outlet_temperature(self):
+        """The heat pump water outlet temperature."""
         return self._if_available("t_water_out")
 
     @property
     def water_house_in_temperature(self):
+        """The water house in temperature."""
         return self._if_available("t_water_house_in")
 
     @property
     def air_inlet_temperature(self):
+        """The heat pump air inlet temperature."""
         return self._if_available("t_air_in")
 
     @property
     def air_outlet_temperature(self):
+        """The heat pump air outlet temperature."""
         return self._if_available("t_air_out")
 
     @property
     def thermostat_water_setpoint(self):
+        """The  thermostat water setpoint."""
         return self._if_available("t_thermostat_setpoint")
 
     @property
     def thermostat_room_temperature(self):
+        """The thermostat current room temperature."""
         return self._if_available("t_room")
 
     @property
     def thermostat_room_temperature_setpoint(self):
+        """The thermostat room temperature setpoint."""
         return self._if_available("t_room_target")
 
     @property
     def thermostat_on_off_state(self):
+        """The thermostat on/off state."""
         return self._if_available("on_off_thermostat_state")
 
     @property
     def power_input(self):
+        """The heat pumps power input."""
         return self._if_available("cm_mass_power_in")
 
     @property
     def power_output(self):
+        """The heat pumps hydraulic output power."""
         return self._if_available("cm_mass_power_out")
 
     @property
     def dhw_top_temperature(self):
+        """The DHW vessel top temperature."""
         return self._if_available("t1")
 
     @property
     def dhw_bottom_temperature(self):
+        """The DHW vessel bottom temperature."""
         return self._if_available("t2")
 
     @property
@@ -142,22 +158,27 @@ class HeatPump:
 
     @property
     def inside_unit_water_pump_state(self):
+        """Decoded water pump state."""
         return self._if_available("control_bridge_status_decoded_water_pump")
 
     @property
     def inside_unit_auxilary_pump_state(self):
+        """Decoded auxilary pump state."""
         return self._if_available("control_bridge_status_decoded_water_pump2")
 
     @property
     def inside_unit_dhw_valve_or_pump_state(self):
+        """Decoded DHW valve or pump state."""
         return self._if_available("control_bridge_status_decoded_dhw_valve")
 
     @property
     def inside_unit_gas_boiler_state(self):
+        """Decoded gas boiler state."""
         return self._if_available("control_bridge_status_decoded_gas_boiler")
 
     @property
     def heat_pump_state(self) -> State | None:
+        """The heat pump state."""
         numeric_state = self._if_available("state")
         if numeric_state is None:
             return None
@@ -182,4 +203,5 @@ class HeatPump:
 
     @property
     def energy_total(self):
+        """The total used energy in kWh from 2023 to now."""
         return self._energy_consumption

{weheat-2024.9.10rc3 → weheat-2024.9.23}/weheat/models/heat_pump_model.py

@@ -23,7 +23,7 @@ from aenum import Enum, no_arg
 
 class HeatPumpModel(int, Enum):
     """
-    Model of the heat pump   - BlackBirdP80: BlackBird P80 heat pump (0)   - BlackBirdP60: BlackBird P60 heat pump (1)   - SparrowP60: Sparrow P60 heat pump (2)
+    Model of the heat pump   - BlackBirdP80: BlackBird P80 heat pump (0)   - BlackBirdP60: BlackBird P60 heat pump (1)   - SparrowP60Brown: Sparrow P60 heat pump, colour brown (default) (2)   - SparrowP60Green: Sparrow P60 heat pump, colour green (3)   - SparrowP60Grey: Sparrow P60 heat pump, colour grey (4)   - FlintP40: Flint P40 heat pump (5)
     """
 
     """
@@ -32,6 +32,9 @@ class HeatPumpModel(int, Enum):
     NUMBER_0 = 0
     NUMBER_1 = 1
     NUMBER_2 = 2
+    NUMBER_3 = 3
+    NUMBER_4 = 4
+    NUMBER_5 = 5
 
     @classmethod
     def from_json(cls, json_str: str) -> HeatPumpModel:

{weheat-2024.9.10rc3 → weheat-2024.9.23/weheat.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: weheat
-Version: 2024.9.10rc3
+Version: 2024.9.23
 Summary: Weheat Backend client
 Home-page: https://github.com/wefabricate/wh-python
 Author: Jesper Raemaekers