python-chargepoint 2.2.0__tar.gz → 2.3.0__tar.gz

{python_chargepoint-2.2.0 → python_chargepoint-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-chargepoint
-Version: 2.2.0
+Version: 2.3.0
 Summary: A simple, Pythonic wrapper for the ChargePoint API.
 License: MIT
 License-File: LICENSE
@@ -172,6 +172,29 @@ await client.set_led_brightness(charger_id, 3)  # 60%
 await client.restart_home_charger(charger_id)
 ```
 
+#### Charging schedule
+
+```python
+schedule = await client.get_home_charger_schedule(charger_id)
+print(schedule.schedule_enabled)  # False
+if schedule.default_schedule:
+    print(schedule.default_schedule.weekdays.start_time)  # "23:00"
+    print(schedule.default_schedule.weekdays.end_time)    # "07:00"
+    print(schedule.default_schedule.weekends.start_time)  # "19:00"
+    print(schedule.default_schedule.weekends.end_time)    # "15:00"
+
+# Enable a schedule
+schedule = await client.set_home_charger_schedule(
+    charger_id,
+    weekday_start="23:00", weekday_end="07:00",
+    weekend_start="19:00", weekend_end="15:00",
+)
+print(schedule.schedule_enabled)  # True
+
+# Disable the schedule
+await client.disable_home_charger_schedule(charger_id)
+```
+
 ---
 
 ### Charging Status and Sessions
@@ -327,6 +350,9 @@ chargepoint charger config <charger_id>
 chargepoint charger set-amperage <charger_id> <amps>
 chargepoint charger set-led <charger_id> <level>   # 0=off 1=20% 2=40% 3=60% 4=80% 5=100%
 chargepoint charger restart <charger_id>
+chargepoint charger schedule <charger_id>
+chargepoint charger set-schedule <charger_id> --weekday-start 23:00 --weekday-end 07:00 --weekend-start 19:00 --weekend-end 15:00
+chargepoint charger disable-schedule <charger_id>
 
 # Sessions
 chargepoint session get <session_id>

{python_chargepoint-2.2.0 → python_chargepoint-2.3.0}/README.md

@@ -151,6 +151,29 @@ await client.set_led_brightness(charger_id, 3)  # 60%
 await client.restart_home_charger(charger_id)
 ```
 
+#### Charging schedule
+
+```python
+schedule = await client.get_home_charger_schedule(charger_id)
+print(schedule.schedule_enabled)  # False
+if schedule.default_schedule:
+    print(schedule.default_schedule.weekdays.start_time)  # "23:00"
+    print(schedule.default_schedule.weekdays.end_time)    # "07:00"
+    print(schedule.default_schedule.weekends.start_time)  # "19:00"
+    print(schedule.default_schedule.weekends.end_time)    # "15:00"
+
+# Enable a schedule
+schedule = await client.set_home_charger_schedule(
+    charger_id,
+    weekday_start="23:00", weekday_end="07:00",
+    weekend_start="19:00", weekend_end="15:00",
+)
+print(schedule.schedule_enabled)  # True
+
+# Disable the schedule
+await client.disable_home_charger_schedule(charger_id)
+```
+
 ---
 
 ### Charging Status and Sessions
@@ -306,6 +329,9 @@ chargepoint charger config <charger_id>
 chargepoint charger set-amperage <charger_id> <amps>
 chargepoint charger set-led <charger_id> <level>   # 0=off 1=20% 2=40% 3=60% 4=80% 5=100%
 chargepoint charger restart <charger_id>
+chargepoint charger schedule <charger_id>
+chargepoint charger set-schedule <charger_id> --weekday-start 23:00 --weekday-end 07:00 --weekend-start 19:00 --weekend-end 15:00
+chargepoint charger disable-schedule <charger_id>
 
 # Sessions
 chargepoint session get <session_id>

{python_chargepoint-2.2.0 → python_chargepoint-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-chargepoint"
-version = "2.2.0"
+version = "2.3.0"
 description = "A simple, Pythonic wrapper for the ChargePoint API."
 authors = ["Marc Billow <mbillow@users.noreply.github.compoetry>"]
 license = "MIT"

{python_chargepoint-2.2.0 → python_chargepoint-2.3.0}/python_chargepoint/__main__.py

@@ -519,6 +519,115 @@ async def charger_restart(ctx, charger_id: int) -> None:
         await client.close()
 
 
+@charger.command("schedule")
+@click.argument("charger_id", type=int)
+@click.pass_context
+@async_cmd
+async def charger_schedule(ctx, charger_id: int) -> None:
+    """Show the charging schedule for a home charger."""
+    client = await _make_client(ctx.obj["debug"])
+    try:
+        schedule = await client.get_home_charger_schedule(charger_id)
+        if ctx.obj["as_json"]:
+            _dump_json(schedule)
+        else:
+            click.echo(f"Enabled:  {schedule.schedule_enabled}")
+            for label, window in [
+                (
+                    "Weekdays",
+                    (
+                        schedule.default_schedule.weekdays
+                        if schedule.default_schedule
+                        else None
+                    ),
+                ),
+                (
+                    "Weekends",
+                    (
+                        schedule.default_schedule.weekends
+                        if schedule.default_schedule
+                        else None
+                    ),
+                ),
+            ]:
+                if window:
+                    click.echo(f"{label}: {window.start_time} – {window.end_time}")
+    except CommunicationError as e:
+        click.echo(f"Error: {e.message}", err=True)
+        sys.exit(1)
+    finally:
+        await client.close()
+
+
+@charger.command("set-schedule")
+@click.argument("charger_id", type=int)
+@click.option(
+    "--weekday-start", required=True, help='Weekday charge start time, e.g. "23:00"'
+)
+@click.option(
+    "--weekday-end", required=True, help='Weekday charge end time, e.g. "07:00"'
+)
+@click.option(
+    "--weekend-start", required=True, help='Weekend charge start time, e.g. "19:00"'
+)
+@click.option(
+    "--weekend-end", required=True, help='Weekend charge end time, e.g. "15:00"'
+)
+@click.pass_context
+@async_cmd
+async def charger_set_schedule(
+    ctx,
+    charger_id: int,
+    weekday_start: str,
+    weekday_end: str,
+    weekend_start: str,
+    weekend_end: str,
+) -> None:
+    """Set the charging schedule for a home charger."""
+    client = await _make_client(ctx.obj["debug"])
+    try:
+        schedule = await client.set_home_charger_schedule(
+            charger_id, weekday_start, weekday_end, weekend_start, weekend_end
+        )
+        if ctx.obj["as_json"]:
+            _dump_json(schedule)
+        else:
+            click.echo(f"Schedule enabled: {schedule.schedule_enabled}")
+            if schedule.user_schedule:
+                click.echo(
+                    f"Weekdays: {schedule.user_schedule.weekdays.start_time} – {schedule.user_schedule.weekdays.end_time}"
+                )
+                click.echo(
+                    f"Weekends: {schedule.user_schedule.weekends.start_time} – {schedule.user_schedule.weekends.end_time}"
+                )
+    except CommunicationError as e:
+        click.echo(f"Error: {e.message}", err=True)
+        sys.exit(1)
+    finally:
+        await client.close()
+
+
+@charger.command("disable-schedule")
+@click.argument("charger_id", type=int)
+@click.confirmation_option(prompt="Disable the charging schedule?")
+@click.pass_context
+@async_cmd
+async def charger_disable_schedule(ctx, charger_id: int) -> None:
+    """Disable the charging schedule for a home charger."""
+    client = await _make_client(ctx.obj["debug"])
+    try:
+        schedule = await client.disable_home_charger_schedule(charger_id)
+        if ctx.obj["as_json"]:
+            _dump_json(schedule)
+        else:
+            click.echo(f"Schedule enabled: {schedule.schedule_enabled}")
+    except CommunicationError as e:
+        click.echo(f"Error: {e.message}", err=True)
+        sys.exit(1)
+    finally:
+        await client.close()
+
+
 # ---------------------------------------------------------------------------
 # session subgroup
 # ---------------------------------------------------------------------------

{python_chargepoint-2.2.0 → python_chargepoint-2.3.0}/python_chargepoint/client.py

@@ -13,6 +13,7 @@ from .types import (
     Account,
     ElectricVehicle,
     HomeChargerConfiguration,
+    HomeChargerSchedule,
     HomeChargerStatus,
     HomeChargerTechnicalInfo,
     MapFilter,
@@ -150,6 +151,18 @@ class ChargePoint:
 
         return response
 
+    async def _raise_for_status(
+        self, response: aiohttp.ClientResponse, message: str
+    ) -> None:
+        if response.status != 200:
+            text = await response.text()
+            _LOGGER.error(
+                "status_code=%s err=%s",
+                response.status,
+                text,
+            )
+            raise CommunicationError(response=response, message=message)
+
     async def _init_account_parameters(self):
         account: Account = await self.get_account()
         self._user_id = account.user.user_id
@@ -231,13 +244,7 @@ class ChargePoint:
             self._global_config.endpoints.sso_endpoint / "v1/user/logout",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to log out! status_code=%s err=%s", response.status, text
-            )
-            raise CommunicationError(response=response, message="Failed to log out!")
-
+        await self._raise_for_status(response, "Failed to log out!")
         await response.release()
         self._session.cookie_jar.clear()
         self._user_id = None
@@ -246,17 +253,9 @@ class ChargePoint:
         _LOGGER.debug("Discovering account region for username %s", username)
         request = {"username": username}
         response = await self._request("POST", DISCOVERY_API, json=request)
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to discover region! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response,
-                message="Failed to discover region for provided username!",
-            )
+        await self._raise_for_status(
+            response, "Failed to discover region for provided username!"
+        )
         config = GlobalConfiguration.model_validate(await response.json())
         _LOGGER.debug(
             "Discovered account region: %s / %s (%s)",
@@ -274,17 +273,7 @@ class ChargePoint:
             self._global_config.endpoints.accounts_endpoint / "v1/driver/profile/user",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get account information! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get user information."
-            )
-
+        await self._raise_for_status(response, "Failed to get user information.")
         return Account.model_validate(await response.json())
 
     @_require_login
@@ -295,17 +284,7 @@ class ChargePoint:
             self._global_config.endpoints.accounts_endpoint / "v1/driver/vehicle",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to list vehicles! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to retrieve EVs."
-            )
-
+        await self._raise_for_status(response, "Failed to retrieve EVs.")
         evs = await response.json()
         return [ElectricVehicle.model_validate(ev) for ev in evs]
 
@@ -318,17 +297,7 @@ class ChargePoint:
             / f"api/v1/configuration/users/{self.user_id}/chargers",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get home chargers! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to retrieve Home Flex chargers."
-            )
-
+        await self._raise_for_status(response, "Failed to retrieve Home Flex chargers.")
         data = (await response.json())["data"]
         chargers = [int(item["id"]) for item in data]
         _LOGGER.debug(
@@ -347,17 +316,7 @@ class ChargePoint:
             / f"api/v1/configuration/users/{self.user_id}/chargers/{charger_id}/status",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to determine home charger status! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get home charger status."
-            )
-
+        await self._raise_for_status(response, "Failed to get home charger status.")
         status = await response.json()
         _LOGGER.debug(status)
         return HomeChargerStatus.model_validate({"charger_id": charger_id, **status})
@@ -373,17 +332,7 @@ class ChargePoint:
             / f"api/v1/configuration/users/{self.user_id}/chargers/{charger_id}/technical-info",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get home charger tech info! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get home charger tech info."
-            )
-
+        await self._raise_for_status(response, "Failed to get home charger tech info.")
         return HomeChargerTechnicalInfo.model_validate(await response.json())
 
     @_require_login
@@ -394,17 +343,7 @@ class ChargePoint:
             "POST", self._global_config.endpoints.mapcache_endpoint / "v2", json=request
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get account charging status! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get user charging status."
-            )
-
+        await self._raise_for_status(response, "Failed to get user charging status.")
         status = await response.json()
         if not status["user_status"]:
             _LOGGER.debug("No user status returned, assuming not charging.")
@@ -423,17 +362,7 @@ class ChargePoint:
             json={"chargeAmperageLimit": amperage_limit},
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to set amperage limit! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to set amperage limit."
-            )
-
+        await self._raise_for_status(response, "Failed to set amperage limit.")
         await response.release()
 
     @_require_login
@@ -452,17 +381,7 @@ class ChargePoint:
             json={"ledBrightnessLevel": level},
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to set LED brightness! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to set LED brightness."
-            )
-
+        await self._raise_for_status(response, "Failed to set LED brightness.")
         await response.release()
 
     @_require_login
@@ -474,17 +393,7 @@ class ChargePoint:
             / f"api/v1/configuration/users/{self.user_id}/chargers/{charger_id}/restart",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to restart charger! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to restart charger."
-            )
-
+        await self._raise_for_status(response, "Failed to restart charger.")
         await response.release()
 
     @_require_login
@@ -498,19 +407,61 @@ class ChargePoint:
             / f"api/v1/configuration/users/{self.user_id}/chargers/{charger_id}/configurations",
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get charger configuration! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get charger configuration."
-            )
-
+        await self._raise_for_status(response, "Failed to get charger configuration.")
         return HomeChargerConfiguration.model_validate(await response.json())
 
+    @_require_login
+    async def get_home_charger_schedule(self, charger_id: int) -> HomeChargerSchedule:
+        _LOGGER.debug("Getting schedule for charger: %s", charger_id)
+        response = await self._request(
+            "GET",
+            self._global_config.endpoints.hcpo_hcm_endpoint
+            / f"api/v1/schedule/charger/{charger_id}/schedule",
+        )
+
+        await self._raise_for_status(response, "Failed to get charger schedule.")
+        return HomeChargerSchedule.model_validate(await response.json())
+
+    @_require_login
+    async def set_home_charger_schedule(
+        self,
+        charger_id: int,
+        weekday_start: str,
+        weekday_end: str,
+        weekend_start: str,
+        weekend_end: str,
+    ) -> HomeChargerSchedule:
+        _LOGGER.debug("Setting schedule for charger: %s", charger_id)
+        response = await self._request(
+            "PUT",
+            self._global_config.endpoints.hcpo_hcm_endpoint
+            / f"api/v1/schedule/charger/{charger_id}/schedule",
+            json={
+                "schedule": {
+                    "weekdays": {"startTime": weekday_start, "endTime": weekday_end},
+                    "weekends": {"startTime": weekend_start, "endTime": weekend_end},
+                }
+            },
+        )
+
+        await self._raise_for_status(response, "Failed to set charger schedule.")
+        return HomeChargerSchedule.model_validate(await response.json())
+
+    @_require_login
+    async def disable_home_charger_schedule(
+        self, charger_id: int
+    ) -> HomeChargerSchedule:
+        _LOGGER.debug("Disabling schedule for charger: %s", charger_id)
+        response = await self._request(
+            "PUT",
+            self._global_config.endpoints.hcpo_hcm_endpoint
+            / f"api/v1/schedule/charger/{charger_id}/schedule",
+            json={},
+        )
+
+        await self._raise_for_status(response, "Failed to disable charger schedule.")
+        return HomeChargerSchedule.model_validate(await response.json())
+
     @_require_login
     async def get_charging_session(self, session_id: int) -> ChargingSession:
         session = ChargingSession(session_id=session_id)
@@ -530,17 +481,7 @@ class ChargePoint:
         ).update_query({"deviceId": str(device_id), "use_cache": "false"})
         response = await self._request("GET", url)
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get station info! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get station info."
-            )
-
+        await self._raise_for_status(response, "Failed to get station info.")
         data = await response.json()
         return StationInfo.model_validate(data)
 
@@ -576,17 +517,7 @@ class ChargePoint:
             "POST", self._global_config.endpoints.mapcache_endpoint / "v2", json=request
         )
 
-        if response.status != 200:
-            text = await response.text()
-            _LOGGER.error(
-                "Failed to get nearby stations! status_code=%s err=%s",
-                response.status,
-                text,
-            )
-            raise CommunicationError(
-                response=response, message="Failed to get nearby stations."
-            )
-
+        await self._raise_for_status(response, "Failed to get nearby stations.")
         data = await response.json()
         stations = data["map_data"].get("stations", [])
         return [MapStation.model_validate(s) for s in stations]

{python_chargepoint-2.2.0 → python_chargepoint-2.3.0}/python_chargepoint/types.py

@@ -166,6 +166,28 @@ class HomeChargerConfiguration(_CamelModel):
         return {**settings, "led_brightness": led_brightness}
 
 
+class ChargeScheduleWindow(_CamelModel):
+    start_time: str = ""
+    end_time: str = ""
+    start_weekday: Optional[int] = None
+    end_weekday: Optional[int] = None
+
+
+class ChargeSchedule(_CamelModel):
+    weekdays: ChargeScheduleWindow = Field(default_factory=ChargeScheduleWindow)
+    weekends: ChargeScheduleWindow = Field(default_factory=ChargeScheduleWindow)
+
+
+class HomeChargerSchedule(_CamelModel):
+    has_tou_pricing: bool = False
+    schedule_enabled: bool = False
+    has_utility_info: bool = False
+    based_on_utility: Optional["PowerUtility"] = None
+    default_schedule: Optional[ChargeSchedule] = None
+    user_schedule: Optional[ChargeSchedule] = None
+    utility_schedule: Optional[ChargeSchedule] = None
+
+
 class Station(_BaseModel):
     id: int = Field(0, alias="deviceId")
     name: str = ""