weheat 2024.9.4rc2__py3-none-any.whl → 2024.9.10__py3-none-any.whl

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,48 +81,69 @@ 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
     def cop(self):
         """
@@ -110,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
@@ -146,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/abstractions/user.py

@@ -3,7 +3,7 @@ from weheat.api_client import ApiClient
 from weheat.api.user_api import UserApi
 
 
-def get_user_id_from_token(api_url: str, access_token: str):
+async def get_user_id_from_token(api_url: str, access_token: str):
     """ Get the user id from the current logged-in user. """
     try:
         config = Configuration(host=api_url, access_token=access_token)
@@ -11,8 +11,8 @@ def get_user_id_from_token(api_url: str, access_token: str):
         with ApiClient(configuration=config) as client:
             response = UserApi(
                 client
-            ).api_v1_users_me_get_with_http_info()
+            ).api_v1_users_me_get_with_http_info(async_req=True).get()
             if response.status_code == 200:
                 return response.data.id
     except Exception as e:
-        raise e
+        raise e

{weheat-2024.9.4rc2.dist-info → weheat-2024.9.10.dist-info}/METADATA

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

{weheat-2024.9.4rc2.dist-info → weheat-2024.9.10.dist-info}/RECORD

@@ -8,8 +8,8 @@ weheat/rest.py,sha256=hLgJ0CYAR1Dr_LppodDNNC_chj5hEQUmzDmbxvID1ao,13808
 weheat/abstractions/__init__.py,sha256=cRdA_kyTIooo39I13_mqShSfZMqdzNGHbmrnITqgx6A,161
 weheat/abstractions/auth.py,sha256=VCAxJ4OIj7bsYttqJl5-juU0VUlSd3xPu7kUjtHZr3U,979
 weheat/abstractions/discovery.py,sha256=0HEXdtIuw3FIATUwX0xpeUVRnk8i-HRL21pE6b1mej0,1679
-weheat/abstractions/heat_pump.py,sha256=kzi6B6oQ8hFYzxMBZqVwbFRY16vR9OFnlWPErBQ_8uA,4649
-weheat/abstractions/user.py,sha256=9p5GZft1Q4qy1dF-6ZkGe_dZYLHvRvRBQhtzVoRjDVA,621
+weheat/abstractions/heat_pump.py,sha256=RuUJJSGA2Zb8zg0HY-FbIQilIJQyCqTimthxcIgiN1Q,7469
+weheat/abstractions/user.py,sha256=n1gmPaLKXmRjF1jDuMQ0951RkbBKm-Cx3cgUU2nOA9U,648
 weheat/api/__init__.py,sha256=DQnnRs5Z29Nf5sGdFd3f96xM6p_FMym-_-dvQC2VzdU,243
 weheat/api/energy_log_api.py,sha256=yIIqd-C_xHSM_1eNoj2i04IDkJkzU0-a9iFGDSd2zLo,11374
 weheat/api/heat_pump_api.py,sha256=FAf7jxosIAginCom-aUuFdj7jZupv8134OI6rpkdK80,24368
@@ -29,8 +29,8 @@ weheat/models/read_all_heat_pump_dto.py,sha256=PDaWb-2qSzAnMoIsNceHavT1ybIZa3-lv
 weheat/models/read_heat_pump_dto.py,sha256=ufDbcHxtB8o2jmk00bMP_xol3uCdoTOqiHS6UUzRic4,4514
 weheat/models/read_user_dto.py,sha256=J1YlL-WsXArbirllI1fHZrguKy5Wv35NIck59ICBSGg,3465
 weheat/models/role.py,sha256=eF6nawkz8mmCGQEmJx26Y2MPFmlKdpOOtJ2Q70b-Qtc,938
-weheat-2024.9.4rc2.dist-info/LICENSE,sha256=rWmFUq0uth2jpet-RQ2QPd2VhZkcPSUs6Dxfmbqkbis,1068
-weheat-2024.9.4rc2.dist-info/METADATA,sha256=-jCE8eL1LiKb158kj2xqkwpUCBZcpsdH_M29XFaILHc,3903
-weheat-2024.9.4rc2.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
-weheat-2024.9.4rc2.dist-info/top_level.txt,sha256=hLzdyvGZ9rs4AqK7U48mdHx_-FcP5sDuTSleDUvGAZw,7
-weheat-2024.9.4rc2.dist-info/RECORD,,
+weheat-2024.9.10.dist-info/LICENSE,sha256=rWmFUq0uth2jpet-RQ2QPd2VhZkcPSUs6Dxfmbqkbis,1068
+weheat-2024.9.10.dist-info/METADATA,sha256=7pvOua4tvtcqaL44AnNJ4RxKQdGAnORuq2LZKeafG1M,3901
+weheat-2024.9.10.dist-info/WHEEL,sha256=cVxcB9AmuTcXqmwrtPhNK88dr7IR_b6qagTj0UvIEbY,91
+weheat-2024.9.10.dist-info/top_level.txt,sha256=hLzdyvGZ9rs4AqK7U48mdHx_-FcP5sDuTSleDUvGAZw,7
+weheat-2024.9.10.dist-info/RECORD,,

{weheat-2024.9.4rc2.dist-info → weheat-2024.9.10.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.1.1)
+Generator: setuptools (74.1.2)
 Root-Is-Purelib: true
 Tag: py3-none-any