pybluecurrent 0.0.2__tar.gz → 0.0.3__tar.gz

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pybluecurrent
-Version: 0.0.2
+Version: 0.0.3
 Summary: Python client for BlueCurrent charge points.
 Author-email: Rogier van der Geer <rogier@vander-geer.nl>
 License: MIT
@@ -21,8 +21,8 @@ Requires-Dist: websockets>=11.0.3
 Provides-Extra: dev
 Requires-Dist: black==23.3.0; extra == "dev"
 Requires-Dist: pre-commit>=3.3.3; extra == "dev"
-Requires-Dist: pytest>=7.3.1; extra == "dev"
-Requires-Dist: pytest-asyncio>=0.21.1; extra == "dev"
+Requires-Dist: pytest==8.1.2; extra == "dev"
+Requires-Dist: pytest-asyncio==0.21.1; extra == "dev"
 
 # pybluecurrent
 
@@ -59,6 +59,7 @@ As a result, the `BlueCurrentClient` also exposes synchronous as well as asynchr
    - [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
    - [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
    - [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
+   - [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
    - [`set_status`](#setstatus---enable-or-disable-a-charge-point)
  - [Synchronous](#synchronous)
    - [`login`](#login---log-in)
@@ -167,7 +168,7 @@ All the information returned by this endpoint is already included
 in the response of [`get_charge_points`](#getchargepoints---get-your-charge-points).
 
 ```python
-async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict | str]
+async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict[str, Any] | str]
 ```
 
 ##### Arguments
@@ -228,6 +229,14 @@ async def get_sustainability_status(self) -> dict[str, float | int]
 ##### Returns
 A dictionary with two keys: `{"trees": 1, "co2": 12.345}`
 
+#### `set_plug_and_charge_charge_card` - Set the charge card for plug-and-charge
+
+```python
+async def set_plug_and_charge_charge_card(self, evse_id: str, uid: str | None = None) -> None
+```
+
+Sets the plug-and-charge card for the charge point. The uid must be a `uid` of one of your charge cards (see [`get_charge_cards`](#getchargecards---get-your-charge-cards)) or `None` to use no charge card.
+
 #### `set_status` - Enable or disable a charge point.
 
 ```python

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/README.md

@@ -33,6 +33,7 @@ As a result, the `BlueCurrentClient` also exposes synchronous as well as asynchr
    - [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
    - [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
    - [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
+   - [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
    - [`set_status`](#setstatus---enable-or-disable-a-charge-point)
  - [Synchronous](#synchronous)
    - [`login`](#login---log-in)
@@ -141,7 +142,7 @@ All the information returned by this endpoint is already included
 in the response of [`get_charge_points`](#getchargepoints---get-your-charge-points).
 
 ```python
-async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict | str]
+async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict[str, Any] | str]
 ```
 
 ##### Arguments
@@ -202,6 +203,14 @@ async def get_sustainability_status(self) -> dict[str, float | int]
 ##### Returns
 A dictionary with two keys: `{"trees": 1, "co2": 12.345}`
 
+#### `set_plug_and_charge_charge_card` - Set the charge card for plug-and-charge
+
+```python
+async def set_plug_and_charge_charge_card(self, evse_id: str, uid: str | None = None) -> None
+```
+
+Sets the plug-and-charge card for the charge point. The uid must be a `uid` of one of your charge cards (see [`get_charge_cards`](#getchargecards---get-your-charge-cards)) or `None` to use no charge card.
+
 #### `set_status` - Enable or disable a charge point.
 
 ```python

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
 dynamic = ["version"]
 
 [project.optional-dependencies]
-dev = ["black==23.3.0", "pre-commit>=3.3.3", "pytest>=7.3.1", "pytest-asyncio>=0.21.1"]
+dev = ["black==23.3.0", "pre-commit>=3.3.3", "pytest==8.1.2", "pytest-asyncio==0.21.1"]
 
 [project.urls]
 Repository = "https://github.com/rogiervandergeer/pybluecurrent"

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/src/pybluecurrent/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.2'
-__version_tuple__ = version_tuple = (0, 0, 2)
+__version__ = version = '0.0.3'
+__version_tuple__ = version_tuple = (0, 0, 3)

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/src/pybluecurrent/client.py

@@ -102,7 +102,7 @@ class BlueCurrentClient:
         Get a list of your charge points.
 
         Returns:
-            A list of dictionaries, each representing a charge card:
+            A list of dictionaries, each representing a charge point:
             {
                 "evse_id": "BCU123456",
                 "name": "",
@@ -133,7 +133,7 @@ class BlueCurrentClient:
         await self._send(dict(command="GET_CHARGE_POINTS"), token=True)
         return (await self._receive("CHARGE_POINTS"))["data"]
 
-    async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict | str]:
+    async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict[str, Any] | str]:
         """
         Get the settings of a charge point.
 
@@ -193,11 +193,6 @@ class BlueCurrentClient:
         await self._send(dict(command="GET_SESSIONS"), token=True)
         return await self._receive("SESSIONS")
 
-    async def get_status(self, evse_id: str):
-        """Returns a useless object with evse_id and your full name"""
-        await self._send(dict(command="GET_STATUS", evse_id=evse_id), token=True)
-        return await self._receive("STATUS")
-
     async def get_sustainability_status(self) -> dict[str, float | int]:
         """
         Get statistics on the sustainability of all your charge points.
@@ -211,6 +206,21 @@ class BlueCurrentClient:
         result.pop("object")
         return result
 
+    async def set_plug_and_charge_charge_card(self, evse_id: str, uid: str | None = None) -> None:
+        """
+        Set a plug-and-charge charge card for the charge point.
+
+        Args:
+            evse_id: A charge point ID.
+            uid: A charge card UID or None (for no charge card). Defaults to None.
+        """
+        await self._send(
+            dict(command="SET_PLUG_AND_CHARGE_CHARGE_CARD", evse_id=evse_id, token_uid=uid or "BCU-APP"), token=True
+        )
+        result = await self._receive("STATUS_SET_PLUG_AND_CHARGE_CHARGE_CARD")
+        if not result.get("success"):
+            raise BlueCurrentException(result)
+
     async def set_status(self, evse_id: str, enabled: bool) -> None:
         """
         Enable or disable a charge point.

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/src/pybluecurrent.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pybluecurrent
-Version: 0.0.2
+Version: 0.0.3
 Summary: Python client for BlueCurrent charge points.
 Author-email: Rogier van der Geer <rogier@vander-geer.nl>
 License: MIT
@@ -21,8 +21,8 @@ Requires-Dist: websockets>=11.0.3
 Provides-Extra: dev
 Requires-Dist: black==23.3.0; extra == "dev"
 Requires-Dist: pre-commit>=3.3.3; extra == "dev"
-Requires-Dist: pytest>=7.3.1; extra == "dev"
-Requires-Dist: pytest-asyncio>=0.21.1; extra == "dev"
+Requires-Dist: pytest==8.1.2; extra == "dev"
+Requires-Dist: pytest-asyncio==0.21.1; extra == "dev"
 
 # pybluecurrent
 
@@ -59,6 +59,7 @@ As a result, the `BlueCurrentClient` also exposes synchronous as well as asynchr
    - [`get_charge_point_settings`](#getchargepointsettings---get-the-settings-of-a-charge-point)
    - [`get_grid_status`](#getgridstatus---get-the-grid-status-associated-to-a-charge-point)
    - [`get_sustainability_status`](#getsustainabilitystatus---get-statistics-on-the-sustainability-of-all-your-charge-points)
+   - [`set_plug_and_charge_charge_card`](#setplugandchargechargecard---set-the-charge-card-for-plug-and-charge)
    - [`set_status`](#setstatus---enable-or-disable-a-charge-point)
  - [Synchronous](#synchronous)
    - [`login`](#login---log-in)
@@ -167,7 +168,7 @@ All the information returned by this endpoint is already included
 in the response of [`get_charge_points`](#getchargepoints---get-your-charge-points).
 
 ```python
-async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict | str]
+async def get_charge_point_settings(self, evse_id: str) -> dict[str, bool | dict[str, Any] | str]
 ```
 
 ##### Arguments
@@ -228,6 +229,14 @@ async def get_sustainability_status(self) -> dict[str, float | int]
 ##### Returns
 A dictionary with two keys: `{"trees": 1, "co2": 12.345}`
 
+#### `set_plug_and_charge_charge_card` - Set the charge card for plug-and-charge
+
+```python
+async def set_plug_and_charge_charge_card(self, evse_id: str, uid: str | None = None) -> None
+```
+
+Sets the plug-and-charge card for the charge point. The uid must be a `uid` of one of your charge cards (see [`get_charge_cards`](#getchargecards---get-your-charge-cards)) or `None` to use no charge card.
+
 #### `set_status` - Enable or disable a charge point.
 
 ```python

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/src/pybluecurrent.egg-info/requires.txt

@@ -6,5 +6,5 @@ websockets>=11.0.3
 [dev]
 black==23.3.0
 pre-commit>=3.3.3
-pytest>=7.3.1
-pytest-asyncio>=0.21.1
+pytest==8.1.2
+pytest-asyncio==0.21.1

{pybluecurrent-0.0.2 → pybluecurrent-0.0.3}/tests/test_client.py

@@ -70,11 +70,6 @@ class TestSocketApi:
         assert "grid_actual_p1" in status
         assert "id" in status
 
-    @mark.asyncio
-    async def test_get_status(self, connected_client: BlueCurrentClient, evse_id: str):
-        status = await connected_client.get_status(evse_id=evse_id)
-        assert status["evse_id"] == evse_id
-
     @mark.asyncio
     async def test_get_charge_point_settings(self, connected_client: BlueCurrentClient, evse_id: str):
         settings = await connected_client.get_charge_point_settings(evse_id=evse_id)
@@ -103,6 +98,41 @@ class TestSocketApi:
     async def test_soft_reset(self, connected_client: BlueCurrentClient, evse_id: str):
         _ = await connected_client.soft_reset(evse_id=evse_id)
 
+    @mark.asyncio
+    @mark.skipif(environ.get("BLUECURRENT_READ_ONLY", "TRUE") != "FALSE", reason="Running read-only tests.")
+    async def test_set_plug_and_charge_card(self, connected_client: BlueCurrentClient, evse_id: str):
+        async def _get_plug_and_charge_card_uid() -> str | None:
+            settings = await connected_client.get_charge_point_settings(evse_id=evse_id)
+            try:
+                return settings["plug_and_charge_charge_card"]["uid"]  # type: ignore
+            except KeyError:
+                return None
+
+        # Get the original card, if any
+        before_card = await _get_plug_and_charge_card_uid()
+
+        # Get all possible cards, including no card
+        charge_cards = await connected_client.get_charge_cards()
+        if len(charge_cards) == 0:
+            skip(reason="No charge cards.")
+        uids: list[str | None] = [charge_card["uid"] for charge_card in charge_cards] + [None]  # type: ignore
+        # Set each card as plug_and_charge_card
+        for uid in uids:
+            if uid != before_card:
+                await connected_client.set_plug_and_charge_charge_card(evse_id=evse_id, uid=uid)
+                assert await _get_plug_and_charge_card_uid() == uid
+        # Set the original card as plug_and_charge_card
+        await connected_client.set_plug_and_charge_charge_card(evse_id=evse_id, uid=before_card)
+        assert await _get_plug_and_charge_card_uid() == before_card
+
+    @mark.asyncio
+    @mark.skipif(environ.get("BLUECURRENT_READ_ONLY", "TRUE") != "FALSE", reason="Running read-only tests.")
+    async def test_set_invalid_plug_and_charge_card(self, connected_client: BlueCurrentClient, evse_id: str):
+        settings = await connected_client.get_charge_point_settings(evse_id=evse_id)
+        with raises(BlueCurrentException):
+            await connected_client.set_plug_and_charge_charge_card(evse_id=evse_id, uid="INVALID_CARD")
+        assert await connected_client.get_charge_point_settings(evse_id=evse_id) == settings
+
     @mark.asyncio
     @mark.skipif(environ.get("BLUECURRENT_READ_ONLY", "TRUE") != "FALSE", reason="Running read-only tests.")
     async def test_set_status(self, connected_client: BlueCurrentClient, evse_id: str):