python-openevse-http 0.3.5__tar.gz → 0.4.1__tar.gz

python_openevse_http-0.4.1/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,46 @@
+name: Publish releases to PyPI
+
+on:
+  release:
+    types: [published, prereleased]
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag/Ref to build and publish'
+        required: false
+        default: ''
+
+permissions:
+  contents: read
+
+jobs:
+  build-and-publish:
+    name: Builds and publishes releases to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
+        with:
+          ref: ${{ inputs.tag || github.ref }}
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@1edb52594c857e2b5b13128931090f0640537287  # v5.3.0
+        with:
+          enable-cache: true
+          version: "0.10.9"
+
+      - name: Set up Python
+        run: uv python install 3.14
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish release to PyPI
+        uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc  # v1.12.4

{python_openevse_http-0.3.5/python_openevse_http.egg-info → python_openevse_http-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_openevse_http
-Version: 0.3.5
+Version: 0.4.1
 Summary: Python wrapper for OpenEVSE HTTP API
 Home-page: https://github.com/firstof9/python-openevse-http
 Download-URL: https://github.com/firstof9/python-openevse-http

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1}/openevsehttp/client.py

@@ -337,6 +337,16 @@ class OpenEVSE(CommandsMixin, ManagersMixin, SensorsMixin, PropertiesMixin):
             # TODO: update specific endpoints based on _version prefix
             if any(key in keys for key in UPDATE_TRIGGERS):
                 await self.update()
+
+            if "ota" in keys:
+                ota_val = data["ota"]
+                if ota_val == "started":
+                    self._status["ota_update"] = 1
+                elif ota_val in ("completed", "failed"):
+                    self._status["ota_update"] = 0
+                    data.pop("ota_progress", None)
+                    self._status.pop("ota_progress", None)
+
             self._status.update(data)
 
             if self.callback is not None:

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1}/openevsehttp/commands.py

@@ -414,12 +414,83 @@ class CommandsMixin:
 
             if not isinstance(message, dict):
                 return None
+
+            # Match browser_download_url based on buildenv
+            download_url = None
+            buildenv = self._config.get("buildenv")
+            assets = message.get("assets", [])
+
+            if buildenv and assets:
+                target_filename = f"{buildenv}.bin"
+                for asset in assets:
+                    if asset.get("name") == target_filename:
+                        download_url = asset.get("browser_download_url")
+                        break
+
             return {
                 "latest_version": message.get("tag_name"),
                 "release_notes": message.get("body"),
                 "release_url": message.get("html_url"),
+                "browser_download_url": download_url,
             }
 
+    async def update_firmware(
+        self,
+        firmware_url: str | None = None,
+        firmware_bytes: bytes | None = None,
+        filename: str = "firmware.bin",
+    ) -> Mapping[str, Any] | list[Any] | str:
+        """Instruct the device to update its firmware.
+
+        You can either:
+        1. Pass firmware_bytes to perform a multipart upload of a local file.
+        2. Pass firmware_url to tell the device to download the file directly.
+        3. Pass neither to automatically resolve the latest matching binary URL from GitHub.
+        """
+        if not self._version_check("4.1.7"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        if firmware_bytes is not None and firmware_url is not None:
+            raise ValueError("Cannot specify both firmware_bytes and firmware_url")
+
+        if firmware_url is not None:
+            if not isinstance(firmware_url, str) or not firmware_url.strip():
+                raise ValueError("Invalid firmware_url")
+
+        url = f"{self.url}update"
+
+        # 1. Handle multipart binary upload
+        if firmware_bytes is not None:
+            form_data = aiohttp.FormData()
+            form_data.add_field(
+                name="file",
+                value=firmware_bytes,
+                filename=filename,
+                content_type="application/octet-stream",
+            )
+            _LOGGER.debug(
+                "Uploading firmware binary to %s (%d bytes)", url, len(firmware_bytes)
+            )
+            # Rapi is mapped to http request's data kwarg in process_request
+            return await self.process_request(url=url, method="post", rapi=form_data)
+
+        # 2. Resolve URL from GitHub if not specified
+        if firmware_url is None:
+            check_result = await self.firmware_check()
+            if not check_result or not check_result.get("browser_download_url"):
+                raise RuntimeError(
+                    "Could not resolve latest firmware download URL from GitHub."
+                )
+            firmware_url = check_result["browser_download_url"]
+
+        # 3. Post JSON URL payload
+        data = {"url": firmware_url}
+        _LOGGER.debug(
+            "Requesting OpenEVSE to download and update from: %s", firmware_url
+        )
+        return await self.process_request(url=url, method="post", data=data)
+
     async def set_led_brightness(self, level: int) -> None:
         """Set LED brightness level."""
         if isinstance(level, bool) or not isinstance(level, int):

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1}/openevsehttp/properties.py

@@ -341,7 +341,17 @@ class PropertiesMixin:
     @property
     def ota_update(self) -> bool:
         """Return if an OTA update is active."""
-        return self._status.get("ota_update", False)
+        return bool(self._status.get("ota_update", False))
+
+    @property
+    def ota_progress(self) -> int | None:
+        """Return the progress of the current OTA update."""
+        return self._status.get("ota_progress")
+
+    @property
+    def ota_state(self) -> str | None:
+        """Return the state of the current OTA update."""
+        return self._status.get("ota")
 
     @property
     def manual_override(self) -> bool:

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1/python_openevse_http.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_openevse_http
-Version: 0.3.5
+Version: 0.4.1
 Summary: Python wrapper for OpenEVSE HTTP API
 Home-page: https://github.com/firstof9/python-openevse-http
 Download-URL: https://github.com/firstof9/python-openevse-http

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1}/tests/test_client.py

@@ -1651,3 +1651,26 @@ async def test_update_status_non_mapping_data(caplog):
     with caplog.at_level(logging.WARNING):
         await charger._update_status("data", "not a dict", None)
     assert "Received non-Mapping websocket data: not a dict" in caplog.text
+
+
+async def test_update_status_ota():
+    """Test _update_status with ota websocket events."""
+    charger = OpenEVSE(SERVER_URL)
+    charger._status = {"ota_update": 0}
+
+    # 1. Started event
+    await charger._update_status("data", {"ota": "started"}, None)
+    assert charger.ota_update is True
+    assert charger.ota_state == "started"
+
+    # 2. Progress event
+    await charger._update_status("data", {"ota_progress": 25}, None)
+    assert charger.ota_progress == 25
+
+    # 3. Completed event (verifying ota_progress is cleared even if present in the data dict)
+    await charger._update_status(
+        "data", {"ota": "completed", "ota_progress": 100}, None
+    )
+    assert charger.ota_update is False
+    assert charger.ota_progress is None
+    assert charger.ota_state == "completed"

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1}/tests/test_commands.py

@@ -1040,3 +1040,146 @@ async def test_normalize_response(test_charger):
     assert test_charger._normalize_response({"msg": "OK"}) == {"msg": "OK"}
     # Test with string
     assert test_charger._normalize_response("OK") == {"msg": "OK"}
+
+
+# ── update_firmware ──────────────────────────────────────────────────
+
+
+async def test_update_firmware_bytes(test_charger, mock_aioclient, caplog):
+    """Test update_firmware with bytes upload."""
+    test_charger._config["version"] = "4.1.7"
+    mock_aioclient.post(
+        "http://openevse.test.tld/update",
+        status=200,
+        body="OK",
+    )
+    with caplog.at_level(logging.DEBUG):
+        response = await test_charger.update_firmware(firmware_bytes=b"fakebinarydata")
+        assert response == "OK"
+        assert (
+            "Uploading firmware binary to http://openevse.test.tld/update (14 bytes)"
+            in caplog.text
+        )
+
+
+async def test_update_firmware_url(test_charger, mock_aioclient, caplog):
+    """Test update_firmware with a direct URL."""
+    test_charger._config["version"] = "4.1.7"
+    mock_aioclient.post(
+        "http://openevse.test.tld/update",
+        status=200,
+        body='{"msg":"started"}',
+    )
+    with caplog.at_level(logging.DEBUG):
+        response = await test_charger.update_firmware(
+            firmware_url="http://github.com/release.bin"
+        )
+        assert response == {"msg": "started"}
+        assert (
+            "Requesting OpenEVSE to download and update from: http://github.com/release.bin"
+            in caplog.text
+        )
+
+
+async def test_update_firmware_auto(test_charger, mock_aioclient, caplog):
+    """Test update_firmware with auto-resolved URL from GitHub."""
+    # Setup config with a buildenv and version >= 4.1.7
+    test_charger._config = {"version": "4.1.7", "buildenv": "openevse_esp32-gateway"}
+
+    # Mock GitHub Releases API to return assets matching buildenv
+    github_response = {
+        "tag_name": "v4.1.2",
+        "body": "release notes",
+        "html_url": "https://github.com/OpenEVSE/releases/v4.1.2",
+        "assets": [
+            {
+                "name": "openevse_esp32-gateway.bin",
+                "browser_download_url": "https://github.com/OpenEVSE/releases/download/v4.1.2/openevse_esp32-gateway.bin",
+            },
+            {
+                "name": "other_env.bin",
+                "browser_download_url": "https://github.com/OpenEVSE/releases/download/v4.1.2/other_env.bin",
+            },
+        ],
+    }
+
+    mock_aioclient.get(
+        "https://api.github.com/repos/OpenEVSE/ESP32_WiFi_V4.x/releases/latest",
+        status=200,
+        body=json.dumps(github_response),
+    )
+
+    mock_aioclient.post(
+        "http://openevse.test.tld/update",
+        status=200,
+        body='{"msg":"started"}',
+    )
+
+    with caplog.at_level(logging.DEBUG):
+        response = await test_charger.update_firmware()
+        assert response == {"msg": "started"}
+        assert (
+            "Requesting OpenEVSE to download and update from: https://github.com/OpenEVSE/releases/download/v4.1.2/openevse_esp32-gateway.bin"
+            in caplog.text
+        )
+
+
+async def test_update_firmware_auto_missing_buildenv(test_charger, mock_aioclient):
+    """Test update_firmware raises RuntimeError when buildenv asset is missing."""
+    test_charger._config = {"version": "4.1.7", "buildenv": "openevse_esp32-gateway"}
+
+    # Mock GitHub releases but without the matching gateway asset
+    github_response = {
+        "tag_name": "v4.1.2",
+        "body": "release notes",
+        "html_url": "https://github.com/OpenEVSE/releases/v4.1.2",
+        "assets": [
+            {
+                "name": "other_env.bin",
+                "browser_download_url": "https://github.com/OpenEVSE/releases/download/v4.1.2/other_env.bin",
+            }
+        ],
+    }
+
+    mock_aioclient.get(
+        "https://api.github.com/repos/OpenEVSE/ESP32_WiFi_V4.x/releases/latest",
+        status=200,
+        body=json.dumps(github_response),
+    )
+
+    with pytest.raises(
+        RuntimeError,
+        match="Could not resolve latest firmware download URL from GitHub.",
+    ):
+        await test_charger.update_firmware()
+
+
+async def test_update_firmware_both_provided(test_charger):
+    """Test update_firmware raises ValueError when both bytes and URL are provided."""
+    test_charger._config["version"] = "4.1.7"
+    with pytest.raises(
+        ValueError, match="Cannot specify both firmware_bytes and firmware_url"
+    ):
+        await test_charger.update_firmware(
+            firmware_url="http://url", firmware_bytes=b"bytes"
+        )
+
+
+async def test_update_firmware_url_invalid(test_charger):
+    """Test update_firmware raises ValueError when firmware_url is empty or invalid type."""
+    test_charger._config["version"] = "4.1.7"
+    with pytest.raises(ValueError, match="Invalid firmware_url"):
+        await test_charger.update_firmware(firmware_url="")
+
+    with pytest.raises(ValueError, match="Invalid firmware_url"):
+        await test_charger.update_firmware(firmware_url="   ")
+
+    with pytest.raises(ValueError, match="Invalid firmware_url"):
+        await test_charger.update_firmware(firmware_url=123)  # type: ignore
+
+
+async def test_update_firmware_unsupported(test_charger):
+    """Test update_firmware raises UnsupportedFeature on older firmware."""
+    test_charger._config["version"] = "4.1.2"
+    with pytest.raises(UnsupportedFeature):
+        await test_charger.update_firmware(firmware_url="http://url")

{python_openevse_http-0.3.5 → python_openevse_http-0.4.1}/tests/test_properties.py

@@ -1040,17 +1040,31 @@ async def test_get_has_limit(fixture, expected, request):
 
 
 @pytest.mark.parametrize(
-    "fixture, expected", [("test_charger", 0), ("test_charger_v2", 0)]
+    "fixture, expected", [("test_charger", False), ("test_charger_v2", False)]
 )
 async def test_get_ota_update(fixture, expected, request):
     """Test ota_update property."""
     charger = request.getfixturevalue(fixture)
     await charger.update()
     status = charger.ota_update
-    assert status == expected
+    assert status is expected
     await charger.ws_disconnect()
 
 
+async def test_ota_properties():
+    """Test ota_progress and ota_state properties."""
+    charger = OpenEVSE(SERVER_URL)
+    charger._status = {"ota_update": 1, "ota_progress": 45, "ota": "started"}
+    assert charger.ota_update is True
+    assert charger.ota_progress == 45
+    assert charger.ota_state == "started"
+
+    charger._status = {"ota_update": 0}
+    assert charger.ota_update is False
+    assert charger.ota_progress is None
+    assert charger.ota_state is None
+
+
 # ── MQTT ────────────────────────────────────────────────────────────
 
 

python_openevse_http-0.3.5/.github/workflows/publish-to-pypi.yml

@@ -1,35 +0,0 @@
-name: Publish releases to PyPI
-
-on:
-  release:
-    types: [published, prereleased]
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  build-and-publish:
-    name: Builds and publishes releases to PyPI
-    runs-on: ubuntu-latest
-    steps:
-      - uses: step-security/harden-runner@fe104658747b27e96e4f7e80cd0a94068e53901d  # v2.16.1
-        with:
-          egress-policy: audit
-
-      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6
-      - name: Set up Python 3.9
-        uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405  # v6
-        with:
-          python-version: 3.9
-      - name: Install wheel
-        run: >-
-          pip install wheel
-      - name: Build
-        run: >-
-          python3 setup.py sdist bdist_wheel
-      - name: Publish release to PyPI
-        uses: pypa/gh-action-pypi-publish@cef221092ed1bacb1cc03d23a2d87d1d172e277b  # release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}