weheat 2024.9.5__tar.gz → 2024.9.10__tar.gz

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

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

{weheat-2024.9.5 → weheat-2024.9.10}/pyproject.toml

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

{weheat-2024.9.5 → weheat-2024.9.10}/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.05"
+VERSION = "2024.09.10"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",

{weheat-2024.9.5 → weheat-2024.9.10}/weheat/abstractions/heat_pump.py

@@ -1,12 +1,18 @@
+"""Weheat heat pump abstraction from the API."""
 from enum import Enum, auto
 from weheat.configuration import Configuration
 from weheat.api_client import ApiClient
 from weheat.api.heat_pump_log_api import HeatPumpLogApi
+from weheat.api.energy_log_api import EnergyLogApi
+from datetime import datetime, timedelta
+
+# 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):
-        UNDEFINED = auto()
         STANDBY = auto()
         WATER_CHECK = auto()
         HEATING = auto()
@@ -21,8 +27,10 @@ class HeatPump:
         self._api_url = api_url
         self._uuid = uuid
         self._last_log = None
+        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)
 
@@ -34,14 +42,33 @@ class HeatPump:
                 )
                 if response.status_code == 200:
                     self._last_log = response.data
+
+                # Also get all energy totals form past years and add them together
+                # As end time pick today + 1 day to avoid issues with timezones
+                response = EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=self._uuid,
+                                                                                start_time=START_DATE,
+                                                                                end_time=datetime.now() + timedelta(days=1),
+                                                                                interval='Year')
+
+                if response.status_code == 200:
+                    # aggregate the energy consumption
+                    self._energy_consumption = 0
+                    for year in response.data:
+                        self._energy_consumption += year.total_ein_cooling
+                        self._energy_consumption += year.total_ein_heating
+                        self._energy_consumption += year.total_ein_heating_defrost
+                        self._energy_consumption += year.total_ein_dhw
+                        self._energy_consumption += year.total_ein_dhw_defrost
+
+
+
         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
@@ -54,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
@@ -118,25 +158,30 @@ 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:
+    def heat_pump_state(self) -> State | None:
+        """The heat pump state."""
         numeric_state = self._if_available("state")
         if numeric_state is None:
-            return self.State.UNDEFINED
+            return None
 
         if numeric_state == 40:
             return self.State.STANDBY
@@ -154,5 +199,9 @@ class HeatPump:
             return self.State.MANUAL_CONTROL
         elif numeric_state == 200:
             return self.State.DEFROSTING
-        else:
-            return self.State.UNDEFINED
+        return None
+
+    @property
+    def energy_total(self):
+        """The total used energy in kWh from 2023 to now."""
+        return self._energy_consumption

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

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