python-openevse-http 1.4.0__py3-none-any.whl → 1.6.0__py3-none-any.whl

openevsehttp/__init__.py

@@ -16,11 +16,15 @@ from .const import (
 from .exceptions import (
     AlreadyListening,
     AuthenticationError,
+    CommandFailedError,
+    FirmwareResolutionError,
     InvalidType,
     MissingMethod,
     MissingSerial,
+    OpenEVSEError,
     ParseJSONError,
     UnknownError,
+    UnknownStateError,
     UnsupportedFeature,
 )
 from .websocket import (
@@ -43,15 +47,19 @@ __all__ = [
     "UPDATE_TRIGGERS",
     "AlreadyListening",
     "AuthenticationError",
+    "CommandFailedError",
     "ContentTypeError",
+    "FirmwareResolutionError",
     "InvalidType",
     "MissingMethod",
     "MissingSerial",
     "OpenEVSE",
+    "OpenEVSEError",
     "OpenEVSEWebsocket",
     "ParseJSONError",
     "ServerTimeoutError",
     "UnknownError",
+    "UnknownStateError",
     "UnsupportedFeature",
     "divert_mode",
     "states",

openevsehttp/commands.py

@@ -13,7 +13,12 @@ from awesomeversion import AwesomeVersion
 from awesomeversion.exceptions import AwesomeVersionCompareException
 
 from .const import MAX_AMPS, MIN_AMPS, RAPI_ERRORS, SUCCESS_ANSWERS, divert_mode
-from .exceptions import UnknownError, UnsupportedFeature
+from .exceptions import (
+    CommandFailedError,
+    FirmwareResolutionError,
+    UnknownStateError,
+    UnsupportedFeature,
+)
 from .utils import get_awesome_version
 
 _LOGGER = logging.getLogger(__name__)
@@ -90,12 +95,12 @@ class CommandsMixin:
         msg = response.get("msg") if isinstance(response, Mapping) else None
         if msg not in SUCCESS_ANSWERS:
             _LOGGER.error("Problem issuing command: %s", response)
-            raise UnknownError
+            raise CommandFailedError(f"Problem issuing command: {response}")
 
     async def divert_mode(self) -> Mapping[str, Any] | list[Any]:
         """Set the divert mode to either Normal or Eco modes."""
         if not self._config:
-            raise RuntimeError("Missing configuration: self._config is required")
+            raise UnknownStateError("Missing configuration: self._config is required")
 
         if not self._version_check("2.9.1"):
             _LOGGER.debug("Feature not supported for older firmware.")
@@ -213,7 +218,7 @@ class CommandsMixin:
                 or response.get("msg") not in SUCCESS_ANSWERS
             ):
                 _LOGGER.error("Problem toggling override: %s", response)
-                raise RuntimeError(f"Failed to toggle override: {response}")
+                raise CommandFailedError(f"Failed to toggle override: {response}")
         else:
             # Older firmware use RAPI commands
             _LOGGER.debug("Toggling manual override via RAPI")
@@ -222,7 +227,9 @@ class CommandsMixin:
 
             if "state" not in self._status:
                 _LOGGER.error("Cannot toggle override: unknown charger state.")
-                raise RuntimeError("Cannot toggle override: unknown charger state.")
+                raise UnknownStateError(
+                    "Cannot toggle override: unknown charger state."
+                )
 
             command = "$FE" if self._status.get("state") == 254 else "$FS"
             response, msg = await self.send_command(command)
@@ -231,7 +238,7 @@ class CommandsMixin:
                 isinstance(msg, str) and (msg.startswith("$NK") or msg in RAPI_ERRORS)
             ):
                 _LOGGER.error("Problem toggling override via RAPI: %s", msg)
-                raise RuntimeError(f"Failed to toggle override via RAPI: {msg}")
+                raise CommandFailedError(f"Failed to toggle override via RAPI: {msg}")
 
     async def clear_override(self) -> None:
         """Clear the manual override status."""
@@ -247,7 +254,7 @@ class CommandsMixin:
         _LOGGER.debug("Clear override response: %s", msg)
         if msg not in SUCCESS_ANSWERS:
             _LOGGER.error("Problem clearing override: %s", response)
-            raise RuntimeError(f"Failed to clear override: {response}")
+            raise CommandFailedError(f"Failed to clear override: {response}")
 
     async def set_current(self, amps: int = 6) -> None:
         """Set the soft current limit."""
@@ -276,7 +283,7 @@ class CommandsMixin:
                 or response.get("msg") not in SUCCESS_ANSWERS
             ):
                 _LOGGER.error("Problem setting current limit: %s", response)
-                raise UnknownError
+                raise CommandFailedError(f"Problem setting current limit: {response}")
 
         else:
             # RAPI commands
@@ -291,7 +298,7 @@ class CommandsMixin:
                 isinstance(msg, str) and (msg.startswith("$NK") or msg in RAPI_ERRORS)
             ):
                 _LOGGER.error("Problem setting current via RAPI: %s", msg)
-                raise UnknownError
+                raise CommandFailedError(f"Problem setting current via RAPI: {msg}")
 
     async def set_service_level(self, level: int | str = 2) -> None:
         """Set the service level of the EVSE."""
@@ -311,7 +318,7 @@ class CommandsMixin:
         msg = response.get("msg") if isinstance(response, Mapping) else None
         if msg not in SUCCESS_ANSWERS:
             _LOGGER.error("Problem issuing command: %s", response)
-            raise UnknownError
+            raise CommandFailedError(f"Problem issuing command: {response}")
 
     # Restart OpenEVSE WiFi
     async def restart_wifi(self) -> None:
@@ -346,7 +353,7 @@ class CommandsMixin:
 
         if not success:
             _LOGGER.error("Problem restarting WiFi: %s", response)
-            raise RuntimeError(f"Failed to restart WiFi: {msg}")
+            raise CommandFailedError(f"Failed to restart WiFi: {msg}")
 
     # Restart EVSE module
     async def restart_evse(self) -> None:
@@ -364,7 +371,9 @@ class CommandsMixin:
                 or reply.get("error")
             ):
                 _LOGGER.error("Problem restarting EVSE module via HTTP: %s", reply)
-                raise RuntimeError(f"Failed to restart EVSE module via HTTP: {reply}")
+                raise CommandFailedError(
+                    f"Failed to restart EVSE module via HTTP: {reply}"
+                )
 
             response = (
                 reply.get("msg", "Unknown error")
@@ -381,7 +390,7 @@ class CommandsMixin:
                 and (response.startswith("$NK") or response in RAPI_ERRORS)
             ):
                 _LOGGER.error("Problem restarting EVSE module via RAPI: %s", response)
-                raise RuntimeError(
+                raise CommandFailedError(
                     f"Failed to restart EVSE module via RAPI: {response}"
                 )
 
@@ -563,7 +572,7 @@ class CommandsMixin:
                 _LOGGER.error(
                     "Could not resolve latest firmware download URL from GitHub."
                 )
-                raise RuntimeError(
+                raise FirmwareResolutionError(
                     "Could not resolve latest firmware download URL from GitHub."
                 )
             firmware_url = check_result["browser_download_url"]
@@ -605,7 +614,7 @@ class CommandsMixin:
         msg = response.get("msg") if isinstance(response, Mapping) else None
         if msg not in SUCCESS_ANSWERS:
             _LOGGER.error("Problem issuing command: %s", response)
-            raise UnknownError
+            raise CommandFailedError(f"Problem issuing command: {response}")
 
     async def set_divert_mode(self, mode: str = "fast") -> None:
         """Set the divert mode."""
@@ -630,7 +639,7 @@ class CommandsMixin:
 
         if not success:
             _LOGGER.error("Problem issuing command: %s", response)
-            raise UnknownError
+            raise CommandFailedError(f"Problem issuing command: {response}")
 
         self._status["divertmode"] = new_mode
 
@@ -650,7 +659,7 @@ class CommandsMixin:
         msg = response.get("msg") if isinstance(response, Mapping) else None
         if msg not in SUCCESS_ANSWERS and msg != "Current Shaper state changed":
             _LOGGER.error("Problem issuing command: %s", response)
-            raise UnknownError
+            raise CommandFailedError(f"Problem issuing command: {response}")
 
         self._status["shaper"] = mode
 
@@ -663,7 +672,49 @@ class CommandsMixin:
 
         if shaper_active is None:
             _LOGGER.error("Cannot toggle shaper: unknown shaper state.")
-            raise RuntimeError("Cannot toggle shaper: unknown shaper state.")
+            raise UnknownStateError("Cannot toggle shaper: unknown shaper state.")
 
         new_state = not bool(shaper_active)
         await self.set_shaper(new_state)
+
+    async def set_mqtt_vehicle_range_miles(self, enable: bool = True) -> None:
+        """Set mqtt_vehicle_range_miles configuration setting.
+
+        Dynamically changing this setting will affect future evaluations of
+        the vehicle_range_with_unit property.
+        """
+        if not isinstance(enable, bool):
+            raise TypeError("Value must be a boolean.")
+
+        url = f"{self.url}config"
+        data = {"mqtt_vehicle_range_miles": enable}
+
+        _LOGGER.debug("Setting mqtt_vehicle_range_miles to %s", enable)
+        response = await self.process_request(url=url, method="post", data=data)
+        response = self._normalize_response(response)
+        msg = response.get("msg") if isinstance(response, Mapping) else None
+        if msg not in SUCCESS_ANSWERS:
+            _LOGGER.error("Problem issuing command: %s", response)
+            raise CommandFailedError(f"Problem issuing command: {response}")
+
+    async def set_rfid_enabled(self, enable: bool = True) -> None:
+        """Enable or disable RFID access."""
+        if not self._version_check("4.1.4"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        if not isinstance(enable, bool):
+            raise TypeError("Value must be a boolean.")
+
+        url = f"{self.url}config"
+        data = {"rfid_enabled": enable}
+
+        _LOGGER.debug("Setting rfid_enabled to %s", enable)
+        response = await self.process_request(url=url, method="post", data=data)
+        response = self._normalize_response(response)
+        msg = response.get("msg") if isinstance(response, Mapping) else None
+        if msg not in SUCCESS_ANSWERS:
+            _LOGGER.error("Problem issuing command: %s", response)
+            raise CommandFailedError(f"Problem issuing command: {response}")
+
+        self._config["rfid_enabled"] = enable

openevsehttp/exceptions.py

@@ -1,33 +1,49 @@
 """Exceptions."""
 
 
-class AuthenticationError(Exception):
+class OpenEVSEError(Exception):
+    """Base exception for python-openevse-http."""
+
+
+class AuthenticationError(OpenEVSEError):
     """Exception for authentication errors."""
 
 
-class ParseJSONError(Exception):
+class ParseJSONError(OpenEVSEError):
     """Exception for JSON parsing errors."""
 
 
-class UnknownError(Exception):
+class UnknownError(OpenEVSEError):
     """Exception for Unknown errors."""
 
 
-class MissingMethod(Exception):
+class MissingMethod(OpenEVSEError):
     """Exception for missing method variable."""
 
 
-class AlreadyListening(Exception):
+class AlreadyListening(OpenEVSEError):
     """Exception for already listening websocket."""
 
 
-class MissingSerial(Exception):
+class MissingSerial(OpenEVSEError):
     """Exception for missing serial number."""
 
 
-class UnsupportedFeature(Exception):
+class UnsupportedFeature(OpenEVSEError):
     """Exception for firmware that is too old."""
 
 
-class InvalidType(Exception):
+class InvalidType(OpenEVSEError):
     """Exception for invalid types."""
+
+
+class CommandFailedError(OpenEVSEError):
+    """Exception for command rejections or failures."""
+
+
+class UnknownStateError(OpenEVSEError):
+    """Exception when charger state cannot be determined."""
+
+
+class FirmwareResolutionError(OpenEVSEError):
+    """Exception when firmware download URL cannot be resolved."""

openevsehttp/properties.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import logging
+import warnings
 from collections.abc import Mapping
 from datetime import datetime, timedelta, timezone
 from typing import Any, cast
@@ -458,11 +459,33 @@ class PropertiesMixin:
     @property
     def vehicle_range(self) -> int | None:
         """Return battery range."""
+        warnings.warn(
+            "vehicle_range is deprecated, use vehicle_range_with_unit instead",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return cast(
             "int | None",
             self._status.get("vehicle_range", self._status.get("battery_range", None)),
         )
 
+    @property
+    def vehicle_range_with_unit(self) -> tuple[int, str] | None:
+        """Return battery range and its unit."""
+        value = cast(
+            "int | None",
+            self._status.get("vehicle_range", self._status.get("battery_range", None)),
+        )
+        if value is None:
+            return None
+        unit = "miles" if self.mqtt_vehicle_range_miles else "km"
+        return (value, unit)
+
+    @property
+    def mqtt_vehicle_range_miles(self) -> bool:
+        """Return True if mqtt vehicle range is in miles, False if km."""
+        return bool(self._config.get("mqtt_vehicle_range_miles", False))
+
     @property
     def vehicle_eta(self) -> datetime | None:
         """Return time to full charge."""
@@ -545,3 +568,11 @@ class PropertiesMixin:
             _LOGGER.debug("Feature not supported for older firmware.")
             raise UnsupportedFeature
         return int(self._status.get("power", 0))
+
+    @property
+    def rfid_enabled(self) -> bool | None:
+        """Return charger RFID enabled state."""
+        if not self._version_check("4.1.4"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+        return self._config.get("rfid_enabled")

{python_openevse_http-1.4.0.dist-info → python_openevse_http-1.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_openevse_http
-Version: 1.4.0
+Version: 1.6.0
 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
@@ -65,6 +65,7 @@ import asyncio
 import aiohttp
 from openevsehttp import OpenEVSE
 
+
 async def main():
     async with aiohttp.ClientSession() as session:
         charger = OpenEVSE("192.168.1.30", session=session)
@@ -81,6 +82,7 @@ async def main():
         await charger.toggle_shaper()
         await charger.ws_disconnect()
 
+
 if __name__ == "__main__":
     asyncio.run(main())
 ```

{python_openevse_http-1.4.0.dist-info → python_openevse_http-1.6.0.dist-info}/RECORD

@@ -1,17 +1,17 @@
-openevsehttp/__init__.py,sha256=I6a1mjOZHYiWb_qfCuDuFLOOncrkkB_7uwybtOIujfY,1165
+openevsehttp/__init__.py,sha256=QeXl80ozsK6J9PN-jB_83Bde31YXFGgLuUdmArpZAMM,1363
 openevsehttp/__main__.py,sha256=EHmSdT7GjAVvHQxvLBTjZXsj_V5SB6B2_kpgUAT7mPM,146
 openevsehttp/client.py,sha256=bySzhJ9SKU0IN7-QQfW7_ZrKNw-EoPV4RvnRBXtmCQ8,19326
-openevsehttp/commands.py,sha256=OFPreBlsXUViwvjbVsD_0bmLv9ZSWqHnwdo2lBqdrSs,27278
+openevsehttp/commands.py,sha256=LzGGQbFnpLGwZ7mFgJ_xb08g6PV8-r-sqOmiMlqNlwY,29691
 openevsehttp/const.py,sha256=-frkFduu8hxEBab9FnwA3D65XHrsyH0W7P9miYsWh90,1726
-openevsehttp/exceptions.py,sha256=bqz-tHTW1AYJMKcm0s5M6z5tA6XZgjnCiBLW1XrZ_70,672
+openevsehttp/exceptions.py,sha256=FkU2v6LaZodUmZy78bOsF16der3M0T3y6pQXzTXwFg0,1106
 openevsehttp/managers.py,sha256=EtQMQziwhoZeqKe2zWY-0yS7zedhuYjYtL5j9xBBCZ0,5380
-openevsehttp/properties.py,sha256=xbQfx256FZwNPPn9ryWWOMKliyCChq4ZaTH9NDQVR_8,17968
+openevsehttp/properties.py,sha256=yFzpZQAzSNwiz2gAcqC3Spe9gQHa_orLyfgs7eZwL14,19093
 openevsehttp/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 openevsehttp/sensors.py,sha256=zhQSToY_Zp2rOhPnUXT40xS5ZnUavqNGLm4zAFiUUrY,5717
 openevsehttp/utils.py,sha256=fPUWL64gFTRw4TtV4WITDAFMJ75VjNhPBaU6diwVlv0,2019
 openevsehttp/websocket.py,sha256=yMuLNsB2qYZLtfYRW7-D7NH7rv-qaSTp7F79OajKm_0,10790
-python_openevse_http-1.4.0.dist-info/licenses/LICENSE,sha256=hSB6TOQ7rmwSGb6XzqRjDGMvmUj5_GlacqQin3tegtA,11341
-python_openevse_http-1.4.0.dist-info/METADATA,sha256=uQBdZBdNAnWvyuwoWpgJYjBDlxUAoDxot4LANe6TZTY,5411
-python_openevse_http-1.4.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_openevse_http-1.4.0.dist-info/top_level.txt,sha256=u8RUkoEIE33Cjn6gmqiEoVpZ0VZ59WJ3FXBwwOg0CPE,13
-python_openevse_http-1.4.0.dist-info/RECORD,,
+python_openevse_http-1.6.0.dist-info/licenses/LICENSE,sha256=hSB6TOQ7rmwSGb6XzqRjDGMvmUj5_GlacqQin3tegtA,11341
+python_openevse_http-1.6.0.dist-info/METADATA,sha256=t-5bsWNGUFccdXWSE67jI_68jQSoak7CzQXyIH8zhqk,5413
+python_openevse_http-1.6.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+python_openevse_http-1.6.0.dist-info/top_level.txt,sha256=u8RUkoEIE33Cjn6gmqiEoVpZ0VZ59WJ3FXBwwOg0CPE,13
+python_openevse_http-1.6.0.dist-info/RECORD,,

{python_openevse_http-1.4.0.dist-info → python_openevse_http-1.6.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (84.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any