Merge pull request #241 from fersingb/update_kwh

Ugly quick fix to update the kwh values

Author: ic-dev21

pyhilo/api.py

@@ -385,7 +385,7 @@ async def _async_post_init(self) -> None:
         # instantiate differently
         self.websocket_devices = WebsocketClient(self.websocket_manager.devicehub)
 
-        # For backward compatibility during the transition to challengehub websocket 
+        # For backward compatibility during the transition to challengehub websocket
         self.websocket = self.websocket_devices
         self.websocket_challenges = WebsocketClient(self.websocket_manager.challengehub)
 

pyhilo/const.py

@@ -8,7 +8,7 @@
 LOG: Final = logging.getLogger(__package__)
 DEFAULT_STATE_FILE: Final = "hilo_state.yaml"
 REQUEST_RETRY: Final = 9
-PYHILO_VERSION: Final = "2025.2.01"
+PYHILO_VERSION: Final = "2025.2.02"
 # TODO: Find a way to keep previous line in sync with pyproject.toml automatically
 
 CONTENT_TYPE_FORM: Final = "application/x-www-form-urlencoded"

pyhilo/event.py

@@ -10,6 +10,7 @@
 
 
 class Event:
+    """This class is used to populate the data of a Hilo Challenge Event, contains datetime info and consumption data"""
     setting_deadline: datetime
     pre_cold_start: datetime
     pre_cold_end: datetime
@@ -62,13 +63,28 @@ def __init__(self, **event: dict[str, Any]):
             "last_update",
         ]
 
+    def update_wh(self, used_wH: float) -> None:
+        """This function is used to update the used_kWh attribute during a Hilo Challenge Event"""
+        LOG.debug(f"Updating Wh: {used_wH}")
+        self.used_kWh = round(used_wH / 1000, 2)
+        self.last_update = datetime.now(timezone.utc).astimezone()
+
+    def should_check_for_allowed_wh(self) -> bool:
+        """This function is used to authorize subscribing to a specific event in Hilo to receive the allowed_kWh
+        that is made available in the pre_heat phase"""
+        now = datetime.now(self.preheat_start.tzinfo)
+        time_since_preheat_start = (self.preheat_start - now).total_seconds()
+        already_has_allowed_wh = self.allowed_kWh > 0
+        return 1800 <= time_since_preheat_start <= 2700 and not already_has_allowed_wh
+
     def as_dict(self) -> dict[str, Any]:
         rep = {k: getattr(self, k) for k in self.dict_items}
         rep["phases"] = {k: getattr(self, k) for k in self.phases_list}
         rep["state"] = self.state
         return rep
 
     def _convert_phases(self, phases: dict[str, Any]) -> None:
+        """Formats phase times for later use"""
         self.phases_list = []
         for key, value in phases.items():
             phase_match = re.match(r"(.*)(DateUTC|Utc)", key)
@@ -89,6 +105,7 @@ def _convert_phases(self, phases: dict[str, Any]) -> None:
     def _create_phases(
         self, hours: int, phase_name: str, parent_phase: str
     ) -> datetime:
+        """Creates optional "appreciation" and "pre_cold" phases according to Hilo phases datetimes"""
         parent_start = getattr(self, f"{parent_phase}_start")
         phase_start = f"{phase_name}_start"
         phase_end = f"{phase_name}_end"
@@ -128,6 +145,7 @@ def current_phase_times(self) -> dict[str, datetime]:
 
     @property
     def state(self) -> str:
+        """Defines state in the next_event attribute"""
         now = datetime.now(self.preheat_start.tzinfo)
         if self.pre_cold_start and self.pre_cold_start <= now < self.pre_cold_end:
             return "pre_cold"

pyhilo/util/__init__.py

@@ -1,7 +1,6 @@
 """Define utility modules."""
 import asyncio
 from datetime import datetime, timedelta
-import logging
 import re
 from typing import Any, Callable
 
@@ -10,9 +9,6 @@
 
 from pyhilo.const import LOG  # noqa: F401
 
-LOG = logging.getLogger(__package__)
-
-
 CAMEL_REX_1 = re.compile("(.)([A-Z][a-z]+)")
 CAMEL_REX_2 = re.compile("([a-z0-9])([A-Z])")
 

pyproject.toml

@@ -40,7 +40,7 @@ exclude = ".venv/.*"
 
 [tool.poetry]
 name = "python-hilo"
-version = "2025.2.1"
+version = "2025.2.2"
 description = "A Python3, async interface to the Hilo API"
 readme = "README.md"
 authors = ["David Vallee Delisle <[email protected]>"]