feat: allow state in set_override to be None (#178)

* feat: allow `state` in `set_override` to be None

* update tests

* add test for new code

* linting

* fix typing

* formatting

* more linting

Author: firstof9

openevsehttp/__main__.py

@@ -5,7 +5,7 @@
 import datetime
 import json
 import logging
-from typing import Any, Callable
+from typing import Any, Callable, Union, Dict
 
 import aiohttp  # type: ignore
 from aiohttp.client_exceptions import ContentTypeError, ServerTimeoutError
@@ -73,7 +73,7 @@ async def process_request(
         method: str = "",
         data: Any = None,
         rapi: Any = None,
-    ) -> Any:
+    ) -> dict[str, str] | dict[str, Any]:
         """Return result of processed HTTP request."""
         auth = None
         if method is None:
@@ -123,7 +123,7 @@ async def process_request(
 
             return message
 
-    async def send_command(self, command: str) -> tuple | None:
+    async def send_command(self, command: str) -> tuple:
         """Send a RAPI command to the charger and parses the response."""
         url = f"{self.url}r"
         data = {"json": 1, "rapi": command}
@@ -134,7 +134,7 @@ async def send_command(self, command: str) -> tuple | None:
             if "msg" in value:
                 return False, value["msg"]
             return False, ""
-        return value["cmd"], value["ret"]
+        return (value["cmd"], value["ret"])
 
     async def update(self) -> None:
         """Update the values."""
@@ -251,7 +251,7 @@ def ws_state(self) -> Any:
         assert self.websocket
         return self.websocket.state
 
-    async def get_schedule(self) -> list:
+    async def get_schedule(self) -> Union[Dict[str, str], Dict[str, Any]]:
         """Return the current schedule."""
         url = f"{self.url}schedule"
 
@@ -277,7 +277,9 @@ async def set_charge_mode(self, mode: str = "fast") -> None:
             _LOGGER.error("Problem issuing command: %s", response["msg"])
             raise UnknownError
 
-    async def divert_mode(self, mode: str = "normal") -> None:
+    async def divert_mode(
+        self, mode: str = "normal"
+    ) -> Union[Dict[str, str], Dict[str, Any]]:
         """Set the divert mode to either Normal or Eco modes."""
         url = f"{self.url}divertmode"
 
@@ -299,7 +301,7 @@ async def divert_mode(self, mode: str = "normal") -> None:
         _LOGGER.debug("divert_mode response: %s", response)
         return response
 
-    async def get_override(self) -> None:
+    async def get_override(self) -> Union[Dict[str, str], Dict[str, Any]]:
         """Get the manual override status."""
         if not self._version_check("4.0.0"):
             _LOGGER.debug("Feature not supported for older firmware.")
@@ -312,7 +314,7 @@ async def get_override(self) -> None:
 
     async def set_override(
         self,
-        state: str,
+        state: str | None = None,
         charge_current: int | None = None,
         max_current: int | None = None,
         energy_limit: int | None = None,
@@ -325,22 +327,23 @@ async def set_override(
             raise UnsupportedFeature
         url = f"{self.url}override"
 
-        if state not in ["active", "disabled"]:
+        data: dict[str, Any] = {}
+
+        if state not in ["active", "disabled", None]:
             _LOGGER.error("Invalid override state: %s", state)
             raise ValueError
 
-        data = {
-            "state": state,
-            "auto_release": auto_release,
-        }
+        data["auto_release"] = auto_release
 
-        if charge_current:
+        if state is not None:
+            data["state"] = state
+        if charge_current is not None:
             data["charge_current"] = charge_current
-        if max_current:
+        if max_current is not None:
             data["max_current"] = max_current
-        if energy_limit:
+        if energy_limit is not None:
             data["energy_limit"] = energy_limit
-        if time_limit:
+        if time_limit is not None:
             data["time_limit"] = time_limit
 
         _LOGGER.debug("Override data: %s", data)
@@ -364,8 +367,8 @@ async def toggle_override(self) -> None:
             # Older firmware use RAPI commands
             _LOGGER.debug("Toggling manual override via RAPI")
             command = "$FE" if self._status["state"] == 254 else "$FS"
-            response = await self.send_command(command)
-            _LOGGER.debug("Toggle response: %s", response[1])
+            response, msg = await self.send_command(command)
+            _LOGGER.debug("Toggle response: %s", msg)
 
     async def clear_override(self) -> None:
         """Clear the manual override status."""
@@ -400,13 +403,14 @@ async def set_current(self, amps: int = 6) -> None:
             response = await self.process_request(
                 url=url, method="post", data=data
             )  # noqa: E501
+            _LOGGER.debug("Set current response: %s", response)
 
         else:
             # RAPI commands
             _LOGGER.debug("Setting current via RAPI")
             command = f"$SC {amps} N"
-            response = await self.send_command(command)
-            _LOGGER.debug("Set current response: %s", response[1])
+            response, msg = await self.send_command(command)
+            _LOGGER.debug("Set current response: %s", msg)
 
     # Restart OpenEVSE WiFi
     async def restart_wifi(self) -> None:

tests/test_main.py

@@ -984,7 +984,7 @@ async def test_set_override(test_charger, test_charger_v2, mock_aioclient, caplo
     with caplog.at_level(logging.DEBUG):
         status = await test_charger.set_override("active")
         assert status == {"msg": "OK"}
-        assert "Override data: {'state': 'active', 'auto_release': True}" in caplog.text
+        assert "Override data: {'auto_release': True, 'state': 'active'}" in caplog.text
 
         mock_aioclient.post(
             TEST_URL_OVERRIDE,
@@ -993,17 +993,26 @@ async def test_set_override(test_charger, test_charger_v2, mock_aioclient, caplo
         )
         status = await test_charger.set_override("active", 30)
         assert (
-            "Override data: {'state': 'active', 'auto_release': True, 'charge_current': 30}"
+            "Override data: {'auto_release': True, 'state': 'active', 'charge_current': 30}"
             in caplog.text
         )
         mock_aioclient.post(
             TEST_URL_OVERRIDE,
             status=200,
             body='{"msg": "OK"}',
         )
+        status = await test_charger.set_override(charge_current=30)
+        assert (
+            "Override data: {'auto_release': True, 'charge_current': 30}" in caplog.text
+        )
+        mock_aioclient.post(
+            TEST_URL_OVERRIDE,
+            status=200,
+            body='{"msg": "OK"}',
+        )
         status = await test_charger.set_override("active", 30, 32)
         assert (
-            "Override data: {'state': 'active', 'auto_release': True, 'charge_current': 30, 'max_current': 32}"
+            "Override data: {'auto_release': True, 'state': 'active', 'charge_current': 30, 'max_current': 32}"
             in caplog.text
         )
         mock_aioclient.post(
@@ -1013,7 +1022,7 @@ async def test_set_override(test_charger, test_charger_v2, mock_aioclient, caplo
         )
         status = await test_charger.set_override("active", 30, 32, 2000)
         assert (
-            "Override data: {'state': 'active', 'auto_release': True, 'charge_current': 30, 'max_current': 32, 'energy_limit': 2000}"
+            "Override data: {'auto_release': True, 'state': 'active', 'charge_current': 30, 'max_current': 32, 'energy_limit': 2000}"
             in caplog.text
         )
         mock_aioclient.post(
@@ -1023,7 +1032,7 @@ async def test_set_override(test_charger, test_charger_v2, mock_aioclient, caplo
         )
         status = await test_charger.set_override("active", 30, 32, 2000, 5000)
         assert (
-            "Override data: {'state': 'active', 'auto_release': True, 'charge_current': 30, 'max_current': 32, 'energy_limit': 2000, 'time_limit': 5000}"
+            "Override data: {'auto_release': True, 'state': 'active', 'charge_current': 30, 'max_current': 32, 'energy_limit': 2000, 'time_limit': 5000}"
             in caplog.text
         )