python-openevse-http 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

openevsehttp/client.py

@@ -53,11 +53,16 @@ class OpenEVSE(CommandsMixin, ManagersMixin, SensorsMixin, PropertiesMixin):
         user: str | None = None,
         pwd: str | None = None,
         session: aiohttp.ClientSession | None = None,
+        ssl: bool = False,
+        ssl_verify: bool = True,
     ) -> None:
         """Connect to an OpenEVSE charger equipped with wifi or ethernet."""
         self._user = user or ""
         self._pwd = pwd or ""
-        self.url = f"http://{host}/"
+        self.ssl = ssl
+        self.ssl_verify = ssl_verify
+        scheme = "https" if ssl else "http"
+        self.url = f"{scheme}://{host}/"
         self._status: dict[str, Any] = {}
         self._config: dict[str, Any] = {}
         self._override: Any = None
@@ -134,6 +139,8 @@ class OpenEVSE(CommandsMixin, ManagersMixin, SensorsMixin, PropertiesMixin):
             kwargs = {"data": rapi, "auth": auth}
             if data is not None:
                 kwargs["json"] = data
+            if url.startswith("https://") and not self.ssl_verify:
+                kwargs["ssl"] = False
             async with http_method(url, **kwargs) as resp:
                 try:
                     raw = await resp.text()
@@ -285,6 +292,7 @@ class OpenEVSE(CommandsMixin, ManagersMixin, SensorsMixin, PropertiesMixin):
             self._user,
             self._pwd,
             self._session,
+            ssl_verify=self.ssl_verify,
         )
 
     def _validate_session_loop(self, loop: asyncio.AbstractEventLoop) -> None:

openevsehttp/commands.py

@@ -23,6 +23,8 @@ class CommandsMixin:
     """Mixin providing command methods for OpenEVSE."""
 
     url: str
+    ssl: bool
+    ssl_verify: bool
     _status: dict[str, Any]
     _config: dict[str, Any]
     _session: aiohttp.ClientSession | None
@@ -665,3 +667,23 @@ class CommandsMixin:
 
         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 UnknownError

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."""

openevsehttp/websocket.py

@@ -42,9 +42,11 @@ class OpenEVSEWebsocket:
         user: str | None = None,
         password: str | None = None,
         session: aiohttp.ClientSession | None = None,
+        ssl_verify: bool = True,
     ) -> None:
         """Initialize a OpenEVSEWebsocket instance."""
         self.session = session
+        self.ssl_verify = ssl_verify
         self.uri = self._get_uri(server)
         self._user = user
         self._password = password
@@ -133,10 +135,16 @@ class OpenEVSEWebsocket:
         try:
             # Narrow type for mypy since _ensure_session sets self.session
             assert self.session is not None
+            ws_kwargs: dict[str, Any] = {
+                "heartbeat": 15,
+                "auth": auth,
+            }
+            if self.uri.startswith("wss://") and not self.ssl_verify:
+                ws_kwargs["ssl"] = False
+
             async with self.session.ws_connect(
                 self.uri,
-                heartbeat=15,
-                auth=auth,
+                **ws_kwargs,
             ) as ws_client:
                 self._client = ws_client
                 await self._set_state(STATE_CONNECTED)

{python_openevse_http-1.3.0.dist-info → python_openevse_http-1.5.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python_openevse_http
-Version: 1.3.0
+Version: 1.5.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
@@ -84,6 +84,35 @@ async def main():
 if __name__ == "__main__":
     asyncio.run(main())
 ```
+### HTTPS and SSL Verification Options
+
+If your OpenEVSE WiFi/ethernet module uses HTTPS, you can configure the client to connect securely using the `ssl=True` parameter:
+
+```python
+        # Connect securely using HTTPS (validating SSL/TLS certificates)
+        charger = OpenEVSE(
+            "192.168.1.30",
+            session=session,
+            ssl=True,
+        )
+```
+
+#### Bypassing SSL Verification (Self-Signed Certificates)
+
+> [!WARNING]
+> Disabling SSL certificate validation (`ssl_verify=False`) disables TLS verification and exposes the connection to Man-in-the-Middle (MITM) attacks. Only use this configuration when connecting to an OpenEVSE module with a self-signed certificate over a trusted local network.
+
+To bypass certificate verification:
+
+```python
+        # Connect using HTTPS, and disable certificate verification
+        charger = OpenEVSE(
+            "192.168.1.30",
+            session=session,
+            ssl=True,
+            ssl_verify=False,
+        )
+```
 
 ## API Support Matrix
 

python_openevse_http-1.5.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+openevsehttp/__init__.py,sha256=I6a1mjOZHYiWb_qfCuDuFLOOncrkkB_7uwybtOIujfY,1165
+openevsehttp/__main__.py,sha256=EHmSdT7GjAVvHQxvLBTjZXsj_V5SB6B2_kpgUAT7mPM,146
+openevsehttp/client.py,sha256=bySzhJ9SKU0IN7-QQfW7_ZrKNw-EoPV4RvnRBXtmCQ8,19326
+openevsehttp/commands.py,sha256=G6KjZpwRhjhdxFBh5Sa8jm_jjGQdoFzSf9kTMZfBhGk,28162
+openevsehttp/const.py,sha256=-frkFduu8hxEBab9FnwA3D65XHrsyH0W7P9miYsWh90,1726
+openevsehttp/exceptions.py,sha256=bqz-tHTW1AYJMKcm0s5M6z5tA6XZgjnCiBLW1XrZ_70,672
+openevsehttp/managers.py,sha256=EtQMQziwhoZeqKe2zWY-0yS7zedhuYjYtL5j9xBBCZ0,5380
+openevsehttp/properties.py,sha256=9AJeKatU4fVknLigdrF2n6Ny3DpvOQgbZgc5qpHVbnA,18785
+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.5.0.dist-info/licenses/LICENSE,sha256=hSB6TOQ7rmwSGb6XzqRjDGMvmUj5_GlacqQin3tegtA,11341
+python_openevse_http-1.5.0.dist-info/METADATA,sha256=XvBR5zmlCjmOAg3TKzCnPoU_ekbRVA4sZq7MJLmcopo,5411
+python_openevse_http-1.5.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_openevse_http-1.5.0.dist-info/scm_file_list.json,sha256=KTMxbP5zijLSBJD3NZtpfxkBeLpQgSO29uMi_dGoiEQ,2264
+python_openevse_http-1.5.0.dist-info/scm_version.json,sha256=4_Kgqqqxd2ojwG9gdRVIBboF5UHJBn44SJHF9gqAcBw,160
+python_openevse_http-1.5.0.dist-info/top_level.txt,sha256=u8RUkoEIE33Cjn6gmqiEoVpZ0VZ59WJ3FXBwwOg0CPE,13
+python_openevse_http-1.5.0.dist-info/RECORD,,

python_openevse_http-1.5.0.dist-info/scm_file_list.json

@@ -0,0 +1,70 @@
+{
+  "files": [
+    ".pre-commit-config.yaml",
+    ".yamllint",
+    "README.md",
+    "EXTERNAL_SESSION.md",
+    "tox.ini",
+    "requirements_lint.txt",
+    "requirements_test.txt",
+    "LICENSE",
+    "setup.py",
+    "pyproject.toml",
+    "requirements.txt",
+    "codecov.yml",
+    ".gitignore",
+    "example_external_session.py",
+    "openevsehttp/py.typed",
+    "openevsehttp/__init__.py",
+    "openevsehttp/const.py",
+    "openevsehttp/exceptions.py",
+    "openevsehttp/utils.py",
+    "openevsehttp/client.py",
+    "openevsehttp/websocket.py",
+    "openevsehttp/managers.py",
+    "openevsehttp/properties.py",
+    "openevsehttp/sensors.py",
+    "openevsehttp/commands.py",
+    "openevsehttp/__main__.py",
+    "tests/__init__.py",
+    "tests/test_managers.py",
+    "tests/test_client.py",
+    "tests/test_main_edge_cases.py",
+    "tests/test_shaper.py",
+    "tests/test_commands.py",
+    "tests/conftest.py",
+    "tests/test_external_session.py",
+    "tests/test_mixins.py",
+    "tests/test_websocket.py",
+    "tests/test_properties.py",
+    "tests/test_sensors.py",
+    "tests/common.py",
+    "tests/fixtures/github_v4.json",
+    "tests/fixtures/github_v2.json",
+    "tests/fixtures/websocket.json",
+    "tests/fixtures/v2_json/config.json",
+    "tests/fixtures/v2_json/status.json",
+    "tests/fixtures/v4_json/config-broken-semver.json",
+    "tests/fixtures/v4_json/status-new.json",
+    "tests/fixtures/v4_json/status-broken.json",
+    "tests/fixtures/v4_json/config-broken.json",
+    "tests/fixtures/v4_json/config-dev.json",
+    "tests/fixtures/v4_json/schedule.json",
+    "tests/fixtures/v4_json/config.json",
+    "tests/fixtures/v4_json/config-unknown-semver.json",
+    "tests/fixtures/v4_json/config-new.json",
+    "tests/fixtures/v4_json/config-extra-version.json",
+    "tests/fixtures/v4_json/status.json",
+    ".github/release-drafter.yml",
+    ".github/pull_request_template.md",
+    ".github/dependabot.yml",
+    ".github/ISSUE_TEMPLATE/bug_report.yml",
+    ".github/ISSUE_TEMPLATE/config.yml",
+    ".github/ISSUE_TEMPLATE/feature_request.yml",
+    ".github/workflows/test.yml",
+    ".github/workflows/autolabeler.yml",
+    ".github/workflows/release-drafter.yml",
+    ".github/workflows/links.yml",
+    ".github/workflows/publish-to-pypi.yml"
+  ]
+}

python_openevse_http-1.5.0.dist-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.5.0",
+  "distance": 0,
+  "node": "g1f850ad2b147d75315538154ce50b42e8ad81319",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-06-23"
+}

python_openevse_http-1.3.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-openevsehttp/__init__.py,sha256=I6a1mjOZHYiWb_qfCuDuFLOOncrkkB_7uwybtOIujfY,1165
-openevsehttp/__main__.py,sha256=EHmSdT7GjAVvHQxvLBTjZXsj_V5SB6B2_kpgUAT7mPM,146
-openevsehttp/client.py,sha256=dSvlotG7xxgnDxkI_o2KtIddVw58y6ZgIdJa9gu-WnU,19013
-openevsehttp/commands.py,sha256=JGxjmGvE2-eUJ1gD76y_701Qk3Kzab-6XtGeaXXDSb0,27243
-openevsehttp/const.py,sha256=-frkFduu8hxEBab9FnwA3D65XHrsyH0W7P9miYsWh90,1726
-openevsehttp/exceptions.py,sha256=bqz-tHTW1AYJMKcm0s5M6z5tA6XZgjnCiBLW1XrZ_70,672
-openevsehttp/managers.py,sha256=EtQMQziwhoZeqKe2zWY-0yS7zedhuYjYtL5j9xBBCZ0,5380
-openevsehttp/properties.py,sha256=xbQfx256FZwNPPn9ryWWOMKliyCChq4ZaTH9NDQVR_8,17968
-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=dOSemvm7CM5pFb9RaoJSTIM6Tf5xtWMLEBEccKlBUKI,10517
-python_openevse_http-1.3.0.dist-info/licenses/LICENSE,sha256=hSB6TOQ7rmwSGb6XzqRjDGMvmUj5_GlacqQin3tegtA,11341
-python_openevse_http-1.3.0.dist-info/METADATA,sha256=wgNS8c8fRPdgKGP7odat0kkEWdiDXah7aUhB8b7ghLo,4417
-python_openevse_http-1.3.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_openevse_http-1.3.0.dist-info/top_level.txt,sha256=u8RUkoEIE33Cjn6gmqiEoVpZ0VZ59WJ3FXBwwOg0CPE,13
-python_openevse_http-1.3.0.dist-info/RECORD,,