build: merge dev into main (#98)

* chore: add pre-commit config and linting (#70)

* chore: add pre-commit config and linting

* fix requirements for linting

* feat: add test_and_get function (#87)

* feat: add test_and_get function

* linting

* more test coverage

* fix: adjust power calculation function (#93)

* fix: adjust power calculation function

* adjust pylint config

* bump version

* Update publish-to-pypi.yml

* feat: add restart_wifi method to restart wifi module (#97)

Author: firstof9

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

@@ -22,8 +22,7 @@ jobs:
       - name: Build
         run: >-
           python3 setup.py sdist bdist_wheel
-      - name: Publish release to PyPI
-        uses: pypa/gh-action-pypi-publish@master
+      - name: Publish a Python distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
           password: ${{ secrets.PYPI_TOKEN }}

openevsehttp/__init__.py

@@ -16,6 +16,7 @@
     AlreadyListening,
     AuthenticationError,
     MissingMethod,
+    MissingSerial,
     ParseJSONError,
     UnknownError,
 )
@@ -287,6 +288,28 @@ async def update(self) -> None:
                 self.url, self._update_status, self._user, self._pwd
             )
 
+    async def test_and_get(self) -> dict:
+        """Test connection.
+
+        Return model serial number as dict
+        """
+        url = f"{self.url}config"
+        data = {}
+
+        response = await self.process_request(url, method="get")
+        if "wifi_serial" in response:
+            serial = response["wifi_serial"]
+        else:
+            _LOGGER.debug("Older firmware detected, missing serial.")
+            raise MissingSerial
+        if "buildenv" in response:
+            model = response["buildenv"]
+        else:
+            model = "unknown"
+
+        data = {"serial": serial, "model": model}
+        return data
+
     def ws_start(self):
         """Start the websocket listener."""
         if self._ws_listening:
@@ -503,6 +526,14 @@ async def set_current(self, amps: int = 6) -> None:
             response = await self.send_command(command)
             _LOGGER.debug("Set current response: %s", response[1])
 
+    # Restart OpenEVSE WiFi
+    async def restart_wifi(self) -> None:
+        """Restart OpenEVSE Wifi module."""
+        url = f"{self.url}restart"
+
+        response = await self.process_request(url=url, method="get")
+        _LOGGER.debug("Restart response: %s", response)
+
     @property
     def hostname(self) -> str:
         """Return charger hostname."""
@@ -793,14 +824,16 @@ def wifi_serial(self) -> str | None:
         return None
 
     @property
-    def charging_power(self) -> float:
+    def charging_power(self) -> float | None:
         """Return the charge power.
 
         Calculate Watts base on V*I
         """
-        assert self._status is not None
-        value = round(self._status["voltage"] * self._status["amp"], 2)
-        return value
+        if self._status is not None and any(
+            key in self._status for key in ["voltage", "amp"]
+        ):
+            return round(self._status["voltage"] * self._status["amp"], 2)
+        return None
 
     # There is currently no min/max amps JSON data
     # available via HTTP API methods

openevsehttp/exceptions.py

@@ -19,3 +19,7 @@ class MissingMethod(Exception):
 
 class AlreadyListening(Exception):
     """Exception for already listening websocket."""
+
+
+class MissingSerial(Exception):
+    """Exception for missing serial number."""

pylintrc

@@ -16,7 +16,6 @@ max-attributes=15
 # too-few-* - same as too-many-*
 # import-outside-toplevel - TODO
 disable=
-  bad-continuation,
   duplicate-code,
   fixme,
   import-outside-toplevel,
@@ -26,7 +25,6 @@ disable=
   too-many-public-methods,
   too-many-instance-attributes,
   too-many-branches,
-  no-self-use,
   too-many-statements
 
 [REPORTS]

setup.py

@@ -5,7 +5,7 @@
 
 PROJECT_DIR = Path(__file__).parent.resolve()
 README_FILE = PROJECT_DIR / "README.md"
-VERSION = "0.1.24"
+VERSION = "0.1.25"
 
 setup(
     name="python-openevse-http",

tests/test_init.py

@@ -9,13 +9,16 @@
 from aiohttp.client_exceptions import ContentTypeError, ServerTimeoutError
 
 import openevsehttp
+from tests.common import load_fixture
+from openevsehttp.exceptions import MissingSerial
 
 pytestmark = pytest.mark.asyncio
 
 TEST_URL_RAPI = "http://openevse.test.tld/r"
 TEST_URL_OVERRIDE = "http://openevse.test.tld/override"
 TEST_URL_CONFIG = "http://openevse.test.tld/config"
 TEST_URL_DIVERT = "http://openevse.test.tld/divertmode"
+TEST_URL_RESTART = "http://openevse.test.tld/restart"
 
 
 async def test_get_status_auth(test_charger_auth):
@@ -737,3 +740,32 @@ async def test_set_divertmode(test_charger_v2, mock_aioclient, caplog):
         await test_charger_v2.divert_mode("normal")
     assert "Setting charge mode to normal" in caplog.text
     assert "Non JSON response: Divert Mode changed" in caplog.text
+
+
+async def test_test_and_get(test_charger, test_charger_v2, mock_aioclient, caplog):
+    """Test v4 Status reply"""
+    data = await test_charger.test_and_get()
+    mock_aioclient.get(
+        TEST_URL_CONFIG,
+        status=200,
+        body=load_fixture("v4_json/config.json"),
+    )
+    assert data["serial"] == "1234567890AB"
+    assert data["model"] == "unknown"
+
+    with pytest.raises(MissingSerial):
+        with caplog.at_level(logging.DEBUG):
+            data = await test_charger_v2.test_and_get()
+    assert "Older firmware detected, missing serial." in caplog.text
+
+
+async def test_restart(test_charger_v2, mock_aioclient, caplog):
+    """Test v4 set divert mode."""
+    mock_aioclient.get(
+        TEST_URL_RESTART,
+        status=200,
+        body="1",
+    )
+    with caplog.at_level(logging.DEBUG):
+        await test_charger_v2.restart_wifi()
+    assert "Restart response: 1" in caplog.text

tox.ini

@@ -4,9 +4,9 @@ skip_missing_interpreters = True
 
 [gh-actions]
 python =
-  3.8: py38, lint, mypy
+  3.8: py38
   3.9: py39
-  3.10: py310
+  3.10: py310, lint, mypy
 
 [testenv]
 commands =