pybluecurrent 0.0.2__tar.gz → 0.0.4__tar.gz

{pybluecurrent-0.0.2 → pybluecurrent-0.0.4}/.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 fail_fast: true
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.2.0
+    rev: v6.0.0
     hooks:
       - id: trailing-whitespace
         exclude: '\.(md|markdown)$'
@@ -27,7 +27,7 @@ repos:
       - id: isort
         exclude: __init__.py
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: 6e63c9e
+    rev: v1.18.2
     hooks:
     -   id: mypy
         additional_dependencies:

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pybluecurrent
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python client for BlueCurrent charge points.
 Author-email: Rogier van der Geer <rogier@vander-geer.nl>
 License: MIT
@@ -21,8 +21,9 @@ 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.4.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "dev"
+Dynamic: license-file
 
 # pybluecurrent
 
@@ -59,6 +60,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 +169,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 +230,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.4}/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.4}/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.4.2", "pytest-asyncio==1.2.0"]
 
 [project.urls]
 Repository = "https://github.com/rogiervandergeer/pybluecurrent"
@@ -53,3 +53,8 @@ profile = "black"
 [tool.ruff]
 line-length = 120
 target-version = "py310"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+asyncio_default_test_loop_scope = "session"

pybluecurrent-0.0.4/src/pybluecurrent/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.0.4'
+__version_tuple__ = version_tuple = (0, 0, 4)
+
+__commit_id__ = commit_id = 'gdbea48bcd'

{pybluecurrent-0.0.2 → pybluecurrent-0.0.4}/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,28 @@ 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. Defaults to None.
+                Setting the plug-and-charge card to None will result in plug-and-charge
+                transactions being started without a charge card. Note that the
+                charge point status will show "BCU_HOME_USE" as the charge card.
+                Setting the plug-and-charge card to "BCU_HOME_USE" has the same effect
+                as setting it to None.
+        """
+        token_uid = "BCU-APP" if uid is None or uid == "BCU_HOME_USE" else uid
+        await self._send(
+            dict(command="SET_PLUG_AND_CHARGE_CHARGE_CARD", evse_id=evse_id, token_uid=token_uid),
+            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.4}/src/pybluecurrent.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: pybluecurrent
-Version: 0.0.2
+Version: 0.0.4
 Summary: Python client for BlueCurrent charge points.
 Author-email: Rogier van der Geer <rogier@vander-geer.nl>
 License: MIT
@@ -21,8 +21,9 @@ 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.4.2; extra == "dev"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "dev"
+Dynamic: license-file
 
 # pybluecurrent
 
@@ -59,6 +60,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 +169,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 +230,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.4}/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.4.2
+pytest-asyncio==1.2.0

{pybluecurrent-0.0.2 → pybluecurrent-0.0.4}/tests/conftest.py

@@ -1,9 +1,7 @@
-from asyncio import get_event_loop_policy, run
 from os import environ
 from typing import AsyncGenerator
 
 from pytest import fixture, skip
-from pytest_asyncio import fixture as async_fixture
 
 from pybluecurrent import BlueCurrentClient
 
@@ -22,14 +20,6 @@ def client_with_auth() -> BlueCurrentClient | None:
 
 
 @fixture(scope="session")
-def event_loop():
-    policy = get_event_loop_policy()
-    loop = policy.new_event_loop()
-    yield loop
-    loop.close()
-
-
-@async_fixture(scope="session")
 async def connected_client() -> AsyncGenerator[BlueCurrentClient, None]:
     try:
         client = BlueCurrentClient(environ["BLUECURRENT_USERNAME"], environ["BLUECURRENT_PASSWORD"])
@@ -41,13 +31,8 @@ async def connected_client() -> AsyncGenerator[BlueCurrentClient, None]:
 
 
 @fixture(scope="session")
-def evse_id(client_with_auth: BlueCurrentClient) -> str:
-    async def _get_charge_points(client: BlueCurrentClient) -> list:
-        async with client:
-            charge_points = await client.get_charge_points()
-        return charge_points
-
-    result: list = run(_get_charge_points(client_with_auth))
-    if len(result) == 0:
+async def evse_id(connected_client: BlueCurrentClient) -> str:
+    charge_points = await connected_client.get_charge_points()
+    if not charge_points:
         skip("No charge points available.")
-    return result[0]["evse_id"]
+    return charge_points[0]["evse_id"]  # type: ignore

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

@@ -17,12 +17,10 @@ class TestHeaders:
 
 
 class TestAuthentication:
-    @mark.asyncio
     async def test_authenticate(self, client_with_auth: BlueCurrentClient):
         async with client_with_auth:
             assert client_with_auth.token is not None
 
-    @mark.asyncio
     async def test_authentication_failed(self, client: BlueCurrentClient):
         with raises(AuthenticationFailed):
             async with client:
@@ -34,13 +32,11 @@ class TestAuthentication:
 
 
 class TestSocketApi:
-    @mark.asyncio
     async def test_get_account(self, connected_client: BlueCurrentClient):
         account = await connected_client.get_account()
         assert "full_name" in account
         assert isinstance(account["first_login_app"], date)
 
-    @mark.asyncio
     async def test_get_charge_cards(self, connected_client: BlueCurrentClient):
         charge_cards = await connected_client.get_charge_cards()
         if len(charge_cards) == 0:
@@ -56,7 +52,6 @@ class TestSocketApi:
             ]
         )
 
-    @mark.asyncio
     async def test_get_charge_points(self, connected_client: BlueCurrentClient):
         charge_points = await connected_client.get_charge_points()
         if len(charge_points) == 0:
@@ -64,46 +59,67 @@ class TestSocketApi:
         for charge_point in charge_points:
             assert "evse_id" in charge_point
 
-    @mark.asyncio
     async def test_get_grid_status(self, connected_client: BlueCurrentClient, evse_id: str):
         status = await connected_client.get_grid_status(evse_id=evse_id)
         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)
         assert isinstance(settings, dict)
         assert settings["evse_id"] == evse_id
 
-    @mark.asyncio
     @mark.skip("Does not work")
     async def test_get_sessions(self, connected_client: BlueCurrentClient, evse_id: str):
         sessions = await connected_client.get_sessions(evse_id=evse_id)
         print(sessions)
 
-    @mark.asyncio
     async def test_get_sustainability_status(self, connected_client: BlueCurrentClient):
         sessions = await connected_client.get_sustainability_status()
         assert set(sessions.keys()) == {"trees", "co2"}
 
-    @mark.asyncio
     @mark.skip("Does not work.")
     async def test_unlock_connector(self, connected_client: BlueCurrentClient, evse_id: str):
         result = await connected_client.unlock_connector(evse_id=evse_id)
         print(result)
 
-    @mark.asyncio
     @mark.skip("Do not change chargepoint status.")
     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] + ["BCU_HOME_USE"]  # 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.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.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):
         before_status = connected_client.get_charge_point_status(evse_id=evse_id)
@@ -114,7 +130,6 @@ class TestSocketApi:
         await connected_client.set_status(evse_id=evse_id, enabled=True)
         assert connected_client.get_charge_point_status(evse_id=evse_id)["activity"] == "available"
 
-    @mark.asyncio
     async def test_error(self, connected_client: BlueCurrentClient):
         with raises(BlueCurrentException) as e:
             await connected_client.set_status("BCU123456", False)

pybluecurrent-0.0.2/src/pybluecurrent/_version.py

@@ -1,16 +0,0 @@
-# file generated by setuptools_scm
-# don't change, don't track in version control
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple, Union
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-else:
-    VERSION_TUPLE = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-
-__version__ = version = '0.0.2'
-__version_tuple__ = version_tuple = (0, 0, 2)