python-chargepoint 1.7.0__tar.gz → 1.9.2__tar.gz

python_chargepoint-1.9.2/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.1
+Name: python-chargepoint
+Version: 1.9.2
+Summary: A simple, Pythonic wrapper for the ChargePoint API.
+License: MIT
+Author: Marc Billow
+Author-email: mbillow@users.noreply.github.compoetry
+Requires-Python: >=3.9,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: requests (>=2.27.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+# python-chargepoint
+
+A simple Pythonic wrapper around the ChargePoint EV Charging Network API.
+
+## DISCLAIMER
+
+I, nor this project, are in _any way_ associated with ChargePoint. Use this project at your own risk.
+ChargePoint is a registered trademark of ChargePoint, Inc.
+
+I just wanted a way to retrieve and store charging data from my ChargePoint Home Flex
+in a way that is easy to model and query. This project is the first step in getting that data into a
+more robust time series database.
+
+## Use
+
+### Login
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+print(client.user_id)
+# 1234567890
+```
+
+### Home Chargers
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+chargers = client.get_home_chargers()
+print(chargers)
+# [12345678]
+
+for charger_id in chargers:
+    charger = client.get_home_charger_status(charger_id=charger_id)
+    print(charger)
+# HomeChargerStatus(
+#   brand='CP', 
+#   plugged_in=True, 
+#   connected=True, 
+#   charging_status='NOT_CHARGING', 
+#   last_connected_at=datetime.datetime(2022, 1, 30, 15, 14, 36), 
+#   reminder_enabled=False, 
+#   reminder_time='21:00', 
+#   model='CPH50-NEMA6-50-L23', 
+#   mac_address='0024B10000012345',
+#   amperage_limit=25,
+#   possible_amperage_limits=[20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32])
+```
+
+### Account Charging Status and Session
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+charging = client.get_user_charging_status()
+if charging:
+    print(charging)
+# UserChargingStatus(
+#   session_id=1234567890,
+#   start_time=datetime.datetime(2022, 1, 30, 13, 32, 45), 
+#   state='fully_charged', 
+#   stations=[
+#     ChargePointStation(
+#       id=12345678,  
+#       name='CP HOME ',
+#       latitude=30.0000000,
+#       longitude=-90.0000000)
+#     ])
+
+    session = client.get_charging_session(charging.session_id)
+    print(session)
+#  ChargingSession(
+#    session_id=1234567890, 
+#    start_time=datetime.datetime(2022, 1, 30, 13, 32, 45), 
+#    device_id=12345678, 
+#    device_name='CP HOME', 
+#    charging_state='fully_charged', 
+#    charging_time=2426000, 
+#    energy_kwh=4.3404, 
+#    miles_added=15.024461538461539, 
+#    miles_added_per_hour=0.0, 
+#    outlet_number=1, 
+#    port_level=2, 
+#    power_kw=0.0, 
+#    purpose='PERSONAL', 
+#    currency_iso_code='USD', 
+#    payment_completed=True, 
+#    payment_type='none', 
+#    pricing_spec_id=0, 
+#    total_amount=0.67, 
+#    api_flag=False, 
+#    enable_stop_charging=True, 
+#    has_charging_receipt=False, 
+#    has_utility_info=True, 
+#    is_home_charger=True, 
+#    is_purpose_finalized=True, 
+#    last_update_data_timestamp=datetime.datetime(2022, 1, 30, 15, 12, 48), 
+#    stop_charge_supported=True, 
+#    company_id=12345, 
+#    company_name='CP Home', 
+#    latitude=30.0000000, 
+#    longitude=-90.0000000, 
+#    address='Home Charger', 
+#    city='City', 
+#    state_name='State', 
+#    country='United States', 
+#    zipcode='12345', 
+#    update_data=[
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0,
+#        power_kw=0.0002, 
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 32, 57)),
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0001,
+#        power_kw=0.1568,
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 33, 9)),
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0025, 
+#        power_kw=3.7337, 
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 33, 12)),
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0161, 
+#        power_kw=1.3854, 
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 33, 33)),
+#      ...],
+#    update_period=300000, 
+#    utility=PowerUtility(
+#      id=0, 
+#      name='Energy Company', 
+#      plans=[
+#        PowerUtilityPlan(
+#          code='R', 
+#          id=12345, 
+#          is_ev_plan=False, 
+#          name='Residential')
+#      ]))
+```
+
+#### Starting or Stopping a Session
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+charging = client.get_user_charging_status()
+
+if charging:
+    session = client.get_charging_session(charging.session_id)
+    session.stop()
+
+    # If you wanted to charge again, you can start a new session.
+    session = client.start_charging_session(session.device_id)
+```
+
+You can also start a new session by providing any device ID you want to start charging on.
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+home_flex_id = client.get_home_chargers()[0]
+home_flex = client.get_home_charger_status(home_flex_id)
+
+if home_flex.charging_status == "AVAILABLE":
+    session = client.start_charging_session(home_flex_id)
+```
+
+#### Setting the amperage limit
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+home_flex_id = client.get_home_chargers()[0]
+
+# Print out valid amperage values.
+print(client.get_home_charger_status(home_flex_id).possible_amperage_limits)
+# [20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32]
+
+client.set_amperage_limit(home_flex_id, 23)
+print(client.get_home_charger_status(home_flex_id).amperage_limit)
+# 23
+```
+

python_chargepoint-1.9.2/README.md

@@ -0,0 +1,186 @@
+# python-chargepoint
+
+A simple Pythonic wrapper around the ChargePoint EV Charging Network API.
+
+## DISCLAIMER
+
+I, nor this project, are in _any way_ associated with ChargePoint. Use this project at your own risk.
+ChargePoint is a registered trademark of ChargePoint, Inc.
+
+I just wanted a way to retrieve and store charging data from my ChargePoint Home Flex
+in a way that is easy to model and query. This project is the first step in getting that data into a
+more robust time series database.
+
+## Use
+
+### Login
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+print(client.user_id)
+# 1234567890
+```
+
+### Home Chargers
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+chargers = client.get_home_chargers()
+print(chargers)
+# [12345678]
+
+for charger_id in chargers:
+    charger = client.get_home_charger_status(charger_id=charger_id)
+    print(charger)
+# HomeChargerStatus(
+#   brand='CP', 
+#   plugged_in=True, 
+#   connected=True, 
+#   charging_status='NOT_CHARGING', 
+#   last_connected_at=datetime.datetime(2022, 1, 30, 15, 14, 36), 
+#   reminder_enabled=False, 
+#   reminder_time='21:00', 
+#   model='CPH50-NEMA6-50-L23', 
+#   mac_address='0024B10000012345',
+#   amperage_limit=25,
+#   possible_amperage_limits=[20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32])
+```
+
+### Account Charging Status and Session
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+charging = client.get_user_charging_status()
+if charging:
+    print(charging)
+# UserChargingStatus(
+#   session_id=1234567890,
+#   start_time=datetime.datetime(2022, 1, 30, 13, 32, 45), 
+#   state='fully_charged', 
+#   stations=[
+#     ChargePointStation(
+#       id=12345678,  
+#       name='CP HOME ',
+#       latitude=30.0000000,
+#       longitude=-90.0000000)
+#     ])
+
+    session = client.get_charging_session(charging.session_id)
+    print(session)
+#  ChargingSession(
+#    session_id=1234567890, 
+#    start_time=datetime.datetime(2022, 1, 30, 13, 32, 45), 
+#    device_id=12345678, 
+#    device_name='CP HOME', 
+#    charging_state='fully_charged', 
+#    charging_time=2426000, 
+#    energy_kwh=4.3404, 
+#    miles_added=15.024461538461539, 
+#    miles_added_per_hour=0.0, 
+#    outlet_number=1, 
+#    port_level=2, 
+#    power_kw=0.0, 
+#    purpose='PERSONAL', 
+#    currency_iso_code='USD', 
+#    payment_completed=True, 
+#    payment_type='none', 
+#    pricing_spec_id=0, 
+#    total_amount=0.67, 
+#    api_flag=False, 
+#    enable_stop_charging=True, 
+#    has_charging_receipt=False, 
+#    has_utility_info=True, 
+#    is_home_charger=True, 
+#    is_purpose_finalized=True, 
+#    last_update_data_timestamp=datetime.datetime(2022, 1, 30, 15, 12, 48), 
+#    stop_charge_supported=True, 
+#    company_id=12345, 
+#    company_name='CP Home', 
+#    latitude=30.0000000, 
+#    longitude=-90.0000000, 
+#    address='Home Charger', 
+#    city='City', 
+#    state_name='State', 
+#    country='United States', 
+#    zipcode='12345', 
+#    update_data=[
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0,
+#        power_kw=0.0002, 
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 32, 57)),
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0001,
+#        power_kw=0.1568,
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 33, 9)),
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0025, 
+#        power_kw=3.7337, 
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 33, 12)),
+#      ChargingSessionUpdate(
+#        energy_kwh=0.0161, 
+#        power_kw=1.3854, 
+#        timestamp=datetime.datetime(2022, 1, 30, 13, 33, 33)),
+#      ...],
+#    update_period=300000, 
+#    utility=PowerUtility(
+#      id=0, 
+#      name='Energy Company', 
+#      plans=[
+#        PowerUtilityPlan(
+#          code='R', 
+#          id=12345, 
+#          is_ev_plan=False, 
+#          name='Residential')
+#      ]))
+```
+
+#### Starting or Stopping a Session
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+charging = client.get_user_charging_status()
+
+if charging:
+    session = client.get_charging_session(charging.session_id)
+    session.stop()
+
+    # If you wanted to charge again, you can start a new session.
+    session = client.start_charging_session(session.device_id)
+```
+
+You can also start a new session by providing any device ID you want to start charging on.
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+home_flex_id = client.get_home_chargers()[0]
+home_flex = client.get_home_charger_status(home_flex_id)
+
+if home_flex.charging_status == "AVAILABLE":
+    session = client.start_charging_session(home_flex_id)
+```
+
+#### Setting the amperage limit
+
+```python
+from python_chargepoint import ChargePoint
+
+client = ChargePoint(username="user", password="password")
+home_flex_id = client.get_home_chargers()[0]
+
+# Print out valid amperage values.
+print(client.get_home_charger_status(home_flex_id).possible_amperage_limits)
+# [20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32]
+
+client.set_amperage_limit(home_flex_id, 23)
+print(client.get_home_charger_status(home_flex_id).amperage_limit)
+# 23
+```

{python_chargepoint-1.7.0 → python_chargepoint-1.9.2}/pyproject.toml

@@ -1,12 +1,13 @@
 [tool.poetry]
 name = "python-chargepoint"
-version = "1.7.0"
+version = "1.9.2"
 description = "A simple, Pythonic wrapper for the ChargePoint API."
 authors = ["Marc Billow <mbillow@users.noreply.github.compoetry>"]
 license = "MIT"
 packages = [
     { include = "python_chargepoint" },
 ]
+readme = "README.md"
 
 [tool.poetry.dependencies]
 python = "^3.9"

{python_chargepoint-1.7.0 → python_chargepoint-1.9.2}/python_chargepoint/client.py

@@ -1,6 +1,7 @@
 from uuid import uuid4
 from typing import List, Optional
 from functools import wraps
+from time import sleep
 
 from requests import Session, codes, post
 
@@ -357,6 +358,48 @@ class ChargePoint:
 
         return UserChargingStatus.from_json(status["user_status"])
 
+    @_require_login
+    def set_amperage_limit(self, charger_id: int, amperage_limit: int, max_retry: int = 5) -> None:
+        _LOGGER.debug(f"Setting amperage limit for {charger_id} to {amperage_limit}")
+        request = {"deviceData": self._device_data, "chargeAmperageLimit": amperage_limit}
+        response = self._session.post(
+            f"{self._global_config.endpoints.internal_api}/driver/charger/{charger_id}/config/v1/charge-amperage-limit",
+            json=request
+        )
+
+        if response.status_code != codes.ok:
+            _LOGGER.error(
+                "Failed to set amperage limit! status_code=%s err=%s",
+                response.status_code,
+                response.text,
+            )
+            raise ChargePointCommunicationException(
+                response=response, message="Failed to set amperage limit."
+            )
+        status = response.json()
+        # The API can return 200 but still have a failure status.
+        if status["status"] != "success":
+            message = status.get("message", "empty message")
+            _LOGGER.error(
+                "Failed to set amperage limit! status=%s err=%s",
+                status["status"],
+                message,
+            )
+            raise ChargePointCommunicationException(
+                response=response, message=f"Failed to set amperage limit: {message}"
+            )
+
+        # This is eventually consistent so we wait until the new limit is reflected.
+        for _ in range(1, max_retry):  # pragma: no cover
+            charger_status = self.get_home_charger_status(charger_id)
+            if charger_status.amperage_limit == amperage_limit:
+                return
+            sleep(1)
+
+        raise ChargePointCommunicationException(
+            response=response, message="New amperage limit did not persist to charger after retries"
+        )
+
     @_require_login
     def get_charging_session(self, session_id: int) -> ChargingSession:
         return ChargingSession(session_id=session_id, client=self)

{python_chargepoint-1.7.0 → python_chargepoint-1.9.2}/python_chargepoint/global_config.py

@@ -18,10 +18,10 @@ class ChargePointZoomBounds:
     @classmethod
     def from_json(cls, json: dict):
         return cls(
-            ne_longitude=float(json["ne_lon"]),
-            sw_latitude=float(json["sw_lat"]),
-            ne_latitude=float(json["ne_lat"]),
-            sw_longitude=float(json["sw_lon"]),
+            ne_longitude=float(json.get("ne_lon", 0.0)),
+            sw_latitude=float(json.get("sw_lat", 0.0)),
+            ne_latitude=float(json.get("ne_lat", 0.0)),
+            sw_longitude=float(json.get("sw_lon", 0.0)),
         )
 
 
@@ -37,18 +37,23 @@ class ChargePointCountry:
     @classmethod
     def from_json(cls, json: dict):
         return cls(
-            id=json["id"],
-            name=json["name"],
-            code=json["code"],
+            id=json.get("id", 0),
+            name=json.get("name", ""),
+            code=json.get("code", ""),
             calling_code=json.get("callingCode", 1),
-            phone_format=json["phoneFormat"],
-            zoom_bounds=ChargePointZoomBounds.from_json(json["zoomBounds"]),
+            phone_format=json.get("phoneFormat", ""),
+            zoom_bounds=ChargePointZoomBounds.from_json(json.get("zoomBounds", {})),
         )
 
 
+def _safe_get_endpoint(json: dict, endpoint_key: str) -> str:
+    return json.get(endpoint_key, {}).get("value", "")
+
+
 @dataclass
 class ChargePointEndpoints:
     accounts: str
+    internal_api: str
     mapcache: str
     panda_websocket: str
     payment_java: str
@@ -62,16 +67,17 @@ class ChargePointEndpoints:
     @classmethod
     def from_json(cls, json: dict):
         return cls(
-            accounts=json["accounts_endpoint"]["value"],
-            mapcache=json["mapcache_endpoint"]["value"],
-            panda_websocket=json["panda_websocket_endpoint"]["value"],
-            payment_java=json["payment_java_endpoint"]["value"],
-            payment_php=json["payment_php_endpoint"]["value"],
-            portal_domain=json["portal_domain_endpoint"]["value"],
-            portal_subdomain=json["portal_subdomain"]["value"],
-            sso=json["sso_endpoint"]["value"],
-            webservices=json["webservices_endpoint"]["value"],
-            websocket=json["websocket_endpoint"]["value"],
+            accounts=_safe_get_endpoint(json, "accounts_endpoint"),
+            internal_api=_safe_get_endpoint(json, "internal_api_gateway_endpoint"),
+            mapcache=_safe_get_endpoint(json, "mapcache_endpoint"),
+            panda_websocket=_safe_get_endpoint(json, "panda_websocket_endpoint"),
+            payment_java=_safe_get_endpoint(json, "payment_java_endpoint"),
+            payment_php=_safe_get_endpoint(json, "payment_php_endpoint"),
+            portal_domain=_safe_get_endpoint(json, "portal_domain_endpoint"),
+            portal_subdomain=_safe_get_endpoint(json, "portal_subdomain"),
+            sso=_safe_get_endpoint(json, "sso_endpoint"),
+            webservices=_safe_get_endpoint(json, "webservices_endpoint"),
+            websocket=_safe_get_endpoint(json, "websocket_endpoint"),
         )
 
 
@@ -88,13 +94,13 @@ class ChargePointCurrency:
     @classmethod
     def from_json(cls, json: dict):
         return cls(
-            code=json["code"],
-            name=json["name"],
-            card_cost=json["cardCost"],
-            symbol=json["symbol"],
-            initial_deposit=json["initialDeposit"],
-            replenishment_threshold=json["replenishmentThreshold"],
-            max_decimal_places=json["maxDecimalPlaces"],
+            code=json.get("code", ""),
+            name=json.get("name", ""),
+            card_cost=json.get("cardCost", 0.0),
+            symbol=json.get("symbol", ""),
+            initial_deposit=json.get("initialDeposit", 0.0),
+            replenishment_threshold=json.get("replenishmentThreshold", 0.0),
+            max_decimal_places=json.get("maxDecimalPlaces", 0),
         )
 
 
@@ -112,20 +118,20 @@ class ChargePointGlobalConfiguration:
 
     @classmethod
     def from_json(cls, json: dict):
-        default_ctr = ChargePointCountry.from_json(json["defaultCountry"])
+        default_ctr = ChargePointCountry.from_json(json.get("defaultCountry", {}))
         supported_ctr = [
             ChargePointCountry.from_json(country)
             for country in json.get("supportedCountries", [])
         ]
-        default_cur = ChargePointCurrency.from_json(json["currency"])
+        default_cur = ChargePointCurrency.from_json(json.get("currency", {}))
         supported_cur = [
             ChargePointCurrency.from_json(currency)
             for currency in json.get("supportedCurrencies", [])
         ]
-        epts = ChargePointEndpoints.from_json(json["endPoints"])
+        epts = ChargePointEndpoints.from_json(json.get("endPoints", {}))
 
         return cls(
-            region=json["region"],
+            region=json.get("region", ""),
             default_country=default_ctr,
             supported_countries=supported_ctr,
             default_currency=default_cur,

{python_chargepoint-1.7.0 → python_chargepoint-1.9.2}/python_chargepoint/types.py

@@ -102,6 +102,8 @@ class HomeChargerStatus:
     reminder_time: str
     model: str
     mac_address: str
+    amperage_limit: int
+    possible_amperage_limits: List[int]
 
     @classmethod
     def from_json(cls, charger_id: int, json: dict):
@@ -118,6 +120,8 @@ class HomeChargerStatus:
             reminder_time=json.get("plug_in_reminder_time", ""),
             model=json.get("model", ""),
             mac_address=json.get("mac_address", "00:00:00:00:00:00"),
+            amperage_limit=json.get("charge_amperage_setting", {}).get("charge_limit", 0),
+            possible_amperage_limits=json.get("charge_amperage_setting", {}).get("possible_charge_limit", 0),
         )
 
 

python_chargepoint-1.7.0/PKG-INFO

@@ -1,14 +0,0 @@
-Metadata-Version: 2.1
-Name: python-chargepoint
-Version: 1.7.0
-Summary: A simple, Pythonic wrapper for the ChargePoint API.
-License: MIT
-Author: Marc Billow
-Author-email: mbillow@users.noreply.github.compoetry
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: requests (>=2.27.1,<3.0.0)

python_chargepoint-1.7.0/setup.py

@@ -1,30 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['python_chargepoint']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['requests>=2.27.1,<3.0.0']
-
-setup_kwargs = {
-    'name': 'python-chargepoint',
-    'version': '1.7.0',
-    'description': 'A simple, Pythonic wrapper for the ChargePoint API.',
-    'long_description': 'None',
-    'author': 'Marc Billow',
-    'author_email': 'mbillow@users.noreply.github.compoetry',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'None',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'python_requires': '>=3.9,<4.0',
-}
-
-
-setup(**setup_kwargs)