python-hilo 2025.12.4__tar.gz → 2026.1.1__tar.gz

{python_hilo-2025.12.4 → python_hilo-2026.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-hilo
-Version: 2025.12.4
+Version: 2026.1.1
 Summary: A Python3, async interface to the Hilo API
 License: MIT
 License-File: LICENSE

{python_hilo-2025.12.4 → python_hilo-2026.1.1}/pyhilo/api.py

@@ -153,6 +153,9 @@ class API:
     @property
     def urn(self) -> str | None:
         """Extract URN from the JWT access token."""
+        if self._urn is not None:
+            return self._urn
+
         try:
             if not self._oauth_session.valid_token:
                 return None
@@ -170,7 +173,7 @@ class API:
                 self._urn = urn_claim[0]  # Get the first URN from the array
             else:
                 self._urn = None
-                
+
             return self._urn
         except (IndexError, json.JSONDecodeError, KeyError):
             LOG.error("Failed to extract URN from access token")
@@ -299,11 +302,12 @@ class API:
     def _get_url(
         self,
         endpoint: Union[str, None],
-        location_id: int,
         gd: bool = False,
         drms: bool = False,
         events: bool = False,
         challenge: bool = False,
+        location_id: Union[int, None] = None,
+        urn: Union[str, None] = None,
     ) -> str:
         """Generate a path to the requested endpoint.
 
@@ -329,9 +333,12 @@ class API:
             base = API_EVENTS_ENDPOINT + API_NOTIFICATIONS_ENDPOINT
         if challenge:
             base = API_CHALLENGE_ENDPOINT
-        url = base + "/Locations/" + str(location_id)
+
+        url = base + (f"/Locations/{urn}" if urn else f"/Locations/{location_id}")
+
         if endpoint:
-            url += "/" + str(endpoint)
+            url += f"/{endpoint}"
+
         return url
 
     async def _async_handle_on_backoff(self, _: dict[str, Any]) -> None:
@@ -537,7 +544,7 @@ class API:
 
     async def get_devices(self, location_id: int) -> list[dict[str, Any]]:
         """Get list of all devices"""
-        url = self._get_url("Devices", location_id)
+        url = self._get_url("Devices", location_id=location_id)
         LOG.debug("Devices URL is %s", url)
         devices: list[dict[str, Any]] = await self.async_request("get", url)
         devices.append(await self.get_gateway(location_id))
@@ -554,7 +561,9 @@ class API:
         value: Union[str, float, int, None],
     ) -> None:
         """Sets device attributes"""
-        url = self._get_url(f"Devices/{device.id}/Attributes", device.location_id)
+        url = self._get_url(
+            f"Devices/{device.id}/Attributes", location_id=device.location_id
+        )
         LOG.debug("Device Attribute URL is %s", url)
         await self.async_request("put", url, json={key.hilo_attribute: value})
 
@@ -582,7 +591,7 @@ class API:
           "notificationDataJSON": "{\"NotificationType\":null,\"Title\":\"\",\"SubTitle\":null,\"Body\":\"Test manuel de l’alarme détecté.\",\"Badge\":0,\"Sound\":null,\"Data\":null,\"Tags\":null,\"Type\":\"TestDetected\",\"DeviceId\":324236,\"LocationId\":4051}",
           "viewed": false
         }"""
-        url = self._get_url(None, location_id, events=True)
+        url = self._get_url(None, events=True, location_id=location_id)
         LOG.debug("Event Notifications URL is %s", url)
         return cast(dict[str, Any], await self.async_request("get", url))
 
@@ -650,7 +659,7 @@ class API:
         }
         """
         # ic-dev21 need to check but this is probably dead code
-        url = self._get_url("Events", location_id, True)
+        url = self._get_url("Events", True, location_id=location_id)
         if not event_id:
             url += "?active=true"
         else:
@@ -659,7 +668,8 @@ class API:
         LOG.debug("get_gd_events URL is %s", url)
         return cast(dict[str, Any], await self.async_request("get", url))
 
-    async def get_seasons(self, location_id: int) -> dict[str, Any]:
+    # keep location_id for now for backward compatibility with existing hilo branch
+    async def get_seasons(self, location_id: int) -> list[dict[str, Any]]:
         """This will return the rewards and current season total
         https://api.hiloenergie.com/challenge/v1/api/Locations/XXXX/Seasons
         [
@@ -678,13 +688,34 @@ class API:
           }
         ]
         """
-        url = self._get_url("Seasons", location_id, challenge=True)
+        url = self._get_url("seasonssummary", challenge=True, urn=self.urn)
         LOG.debug("Seasons URL is %s", url)
-        return cast(dict[str, Any], await self.async_request("get", url))
+
+        seasons = await self.async_request("get", url)
+        LOG.debug("Seasons API response: %s", seasons)
+
+        all_seasons: list[dict[str, Any]] = []
+
+        for season_data in seasons:
+            season = season_data.get("season")
+            ratePlan = season_data.get("ratePlan")
+            periodId = season_data.get("periodId")
+
+            url = self._get_url(
+                f"rates/{ratePlan}/seasons/{season}/events?periodId={periodId}",
+                challenge=True,
+                urn=self.urn,
+            )
+            LOG.debug("Seasons Events URL is %s", url)
+            season_events = await self.async_request("get", url)
+            LOG.debug("Season %s Events API response: %s", season, season_events)
+            all_seasons.append(season_events)
+
+        return all_seasons
 
     async def get_gateway(self, location_id: int) -> dict[str, Any]:
         """Gets info about the Hilo hub (gateway)"""
-        url = self._get_url("Gateways/Info", location_id)
+        url = self._get_url("Gateways/Info", location_id=location_id)
         LOG.debug("Gateway URL is %s", url)
         req = await self.async_request("get", url)
         saved_attrs = [
@@ -727,7 +758,7 @@ class API:
           }
         ]
         """
-        url = self._get_url("Weather", location_id)
+        url = self._get_url("Weather", location_id=location_id)
         LOG.debug("Weather URL is %s", url)
         response = await self.async_request("get", url)
         LOG.debug("Weather API response: %s", response)

{python_hilo-2025.12.4 → python_hilo-2026.1.1}/pyhilo/const.py

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

{python_hilo-2025.12.4 → python_hilo-2026.1.1}/pyhilo/event.py

@@ -1,4 +1,5 @@
-"""Event object """
+"""Event object"""
+
 from datetime import datetime, timedelta, timezone
 import logging
 import re
@@ -26,7 +27,7 @@ class Event:
 
     def __init__(self, **event: dict[str, Any]):
         """Initialize."""
-        self._convert_phases(cast(dict[str, Any], event.get("phases")))
+        self._convert_phases(cast(dict[str, Any], event.get("phases", {})))
         params: dict[str, Any] = event.get("parameters") or {}
         devices: list[dict[str, Any]] = params.get("devices", [])
         consumption: dict[str, Any] = event.get("consumption", {})
@@ -34,7 +35,7 @@ class Event:
         used_wH: int = consumption.get("currentWh", 0) or 0
         self.participating: bool = cast(bool, event.get("isParticipating", False))
         self.configurable: bool = cast(bool, event.get("isConfigurable", False))
-        self.period: str = cast(str, event.get("period", ""))
+        self.period: str = (cast(str, event.get("period", "")) or "").lower()
         self.event_id: int = cast(int, event["id"])
         self.total_devices: int = len(devices)
         self.opt_out_devices: int = len([x for x in devices if x["optOut"]])
@@ -44,6 +45,7 @@ class Event:
         self.allowed_kWh: float = round(allowed_wH / 1000, 2)
         self.used_kWh: float = round(used_wH / 1000, 2)
         self.used_percentage: float = 0
+        self.reward = cast(float, event.get("reward", 0.0))
         self.last_update = datetime.now(timezone.utc).astimezone()
         if allowed_wH > 0:
             self.used_percentage = round(used_wH / allowed_wH * 100, 2)
@@ -63,6 +65,7 @@ class Event:
             "used_kWh",
             "used_percentage",
             "last_update",
+            "reward",
         ]
 
     def update_wh(self, used_wH: float) -> None:
@@ -70,12 +73,21 @@ class Event:
         LOG.debug("Updating Wh: %s", used_wH)
         self.used_kWh = round(used_wH / 1000, 2)
         self.last_update = datetime.now(timezone.utc).astimezone()
+        self._recalculate_percentage()
 
     def update_allowed_wh(self, allowed_wH: float) -> None:
         """This function is used to update the allowed_kWh attribute during a Hilo Challenge Event"""
         LOG.debug("Updating allowed Wh: %s", allowed_wH)
         self.allowed_kWh = round(allowed_wH / 1000, 2)
         self.last_update = datetime.now(timezone.utc).astimezone()
+        self._recalculate_percentage()
+
+    def _recalculate_percentage(self) -> None:
+        """Recalculate used percentage based on current values"""
+        if self.allowed_kWh > 0:
+            self.used_percentage = round(self.used_kWh / self.allowed_kWh * 100, 2)
+        else:
+            self.used_percentage = 0
 
     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

{python_hilo-2025.12.4 → python_hilo-2026.1.1}/pyproject.toml

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