python-openevse-http 0.1.54__tar.gz → 0.1.59__tar.gz

{python-openevse-http-0.1.54 → python-openevse-http-0.1.59}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-openevse-http
-Version: 0.1.54
+Version: 0.1.59
 Summary: Python wrapper for OpenEVSE HTTP API
 Home-page: https://github.com/firstof9/python-openevse-http
 Author: firstof9
@@ -14,6 +14,7 @@ Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 

{python-openevse-http-0.1.54 → python-openevse-http-0.1.59}/openevsehttp/__main__.py

@@ -1,10 +1,12 @@
 """Main librbary functions for python-openevse-http."""
+
 from __future__ import annotations
 
 import asyncio
 import datetime
 import json
 import logging
+import re
 from typing import Any, Callable, Dict, Union
 
 import aiohttp  # type: ignore
@@ -12,10 +14,24 @@ from aiohttp.client_exceptions import ContentTypeError, ServerTimeoutError
 from awesomeversion import AwesomeVersion
 from awesomeversion.exceptions import AwesomeVersionCompareException
 
-from .const import MAX_AMPS, MIN_AMPS
+from .const import (
+    BAT_LVL,
+    BAT_RANGE,
+    CLIENT,
+    GRID,
+    MAX_AMPS,
+    MIN_AMPS,
+    RELEASE,
+    SOLAR,
+    TTF,
+    TYPE,
+    VALUE,
+    VOLTAGE,
+)
 from .exceptions import (
     AlreadyListening,
     AuthenticationError,
+    InvalidType,
     MissingMethod,
     MissingSerial,
     ParseJSONError,
@@ -120,13 +136,17 @@ class OpenEVSE:
                         _LOGGER.warning("Non JSON response: %s", message)
 
                     if resp.status == 400:
-                        _LOGGER.error("Error 400: %s", message["msg"])
+                        if "msg" in message.keys():
+                            index = "msg"
+                        elif "error" in message.keys():
+                            index = "error"
+                        _LOGGER.error("Error 400: %s", message[index])
                         raise ParseJSONError
                     if resp.status == 401:
                         _LOGGER.error("Authentication error: %s", message)
                         raise AuthenticationError
                     if resp.status in [404, 405, 500]:
-                        _LOGGER.error("%s", message)
+                        _LOGGER.warning("%s", message)
 
                     if method == "post" and "config_version" in message:
                         await self.update()
@@ -552,7 +572,16 @@ class OpenEVSE:
         if max_version != "":
             limit = AwesomeVersion(max_version)
 
+        firmware_filtered = None
+
+        try:
+            firmware_search = re.search("\\d\\.\\d\\.\\d", self._config["version"])
+            if firmware_search is not None:
+                firmware_filtered = firmware_search[0]
+        except Exception:  # pylint: disable=broad-exception-caught
+            _LOGGER.warning("Non-standard versioning string.")
         _LOGGER.debug("Detected firmware: %s", self._config["version"])
+        _LOGGER.debug("Filtered firmware: %s", firmware_filtered)
 
         if "dev" in self._config["version"]:
             value = self._config["version"]
@@ -562,7 +591,7 @@ class OpenEVSE:
         elif "master" in self._config["version"]:
             value = "dev"
         else:
-            value = self._config["version"]
+            value = firmware_filtered
 
         current = AwesomeVersion(value)
 
@@ -581,24 +610,214 @@ class OpenEVSE:
             _LOGGER.debug("Non-semver firmware version detected.")
         return False
 
+    # HTTP Posting of grid voltage
+
+    async def grid_voltage(self, voltage: int | None = None) -> None:
+        """Send pushed sensor data to grid voltage."""
+        if not self._version_check("4.0.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}status"
+        data = {}
+
+        if voltage is not None:
+            data[VOLTAGE] = voltage
+
+        if not data:
+            _LOGGER.info("No sensor data to send to device.")
+        else:
+            _LOGGER.debug("Posting voltage: %s", data)
+            response = await self.process_request(url=url, method="post", data=data)
+            _LOGGER.debug("Voltage posting response: %s", response)
+
     # Self production HTTP Posting
 
-    async def self_production(self, grid: int, solar: int, invert: bool = True) -> None:
+    async def self_production(
+        self,
+        grid: int | None = None,
+        solar: int | None = None,
+        invert: bool = True,
+        voltage: int | None = None,
+    ) -> None:
         """Send pushed sensor data to self-prodcution."""
         if not self._version_check("4.0.0"):
             _LOGGER.debug("Feature not supported for older firmware.")
             raise UnsupportedFeature
 
         # Invert the sensor -import/+export
-        if invert:
+        if invert and grid is not None:
             grid = grid * -1
 
         url = f"{self.url}status"
-        data = {"solar": solar, "grid_ie": grid}
+        data = {}
+
+        # Prefer grid sensor data
+        if grid is not None:
+            data[GRID] = grid
+        elif solar is not None:
+            data[SOLAR] = solar
+        if voltage is not None:
+            data[VOLTAGE] = voltage
+
+        if not data:
+            _LOGGER.info("No sensor data to send to device.")
+        else:
+            _LOGGER.debug("Posting self-production: %s", data)
+            response = await self.process_request(url=url, method="post", data=data)
+            _LOGGER.debug("Self-production response: %s", response)
+
+    # State of charge HTTP posting
+    async def soc(
+        self,
+        battery_level: int | None = None,
+        battery_range: int | None = None,
+        time_to_full: int | None = None,
+        voltage: int | None = None,
+    ) -> None:
+        """Send pushed sensor data to self-prodcution."""
+        if not self._version_check("4.1.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}status"
+        data = {}
+
+        # Build post data
+        if battery_level is not None:
+            data[BAT_LVL] = battery_level
+        if battery_range is not None:
+            data[BAT_RANGE] = battery_range
+        if time_to_full is not None:
+            data[TTF] = time_to_full
+        if voltage is not None:
+            data[VOLTAGE] = voltage
+
+        if not data:
+            _LOGGER.info("No SOC data to send to device.")
+        else:
+            _LOGGER.debug("Posting SOC data: %s", data)
+            response = await self.process_request(url=url, method="post", data=data)
+            _LOGGER.debug("SOC response: %s", response)
+
+    # Limit endpoint
+    async def set_limit(
+        self, limit_type: str, value: int, release: bool | None = None
+    ) -> Any:
+        """Set charge limit."""
+        if not self._version_check("5.0.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}limit"
+        data: Dict[str, Any] = {}
+        valid_types = ["time", "energy", "soc", "range"]
+
+        if limit_type not in valid_types:
+            raise InvalidType
+
+        data[TYPE] = limit_type
+        data[VALUE] = value
+        if release is not None:
+            data[RELEASE] = release
 
-        _LOGGER.debug("Posting self-production: %s", data)
-        response = await self.process_request(url=url, method="post", data=data)
-        _LOGGER.debug("Self-production response: %s", response)
+        _LOGGER.debug("Limit data: %s", data)
+        _LOGGER.debug("Setting limit config on %s", url)
+        response = await self.process_request(
+            url=url, method="post", data=data
+        )  # noqa: E501
+        return response
+
+    async def clear_limit(self) -> Any:
+        """Clear charge limit."""
+        if not self._version_check("5.0.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}limit"
+        data: Dict[str, Any] = {}
+
+        _LOGGER.debug("Clearing limit config on %s", url)
+        response = await self.process_request(
+            url=url, method="delete", data=data
+        )  # noqa: E501
+        return response
+
+    async def get_limit(self) -> Any:
+        """Get charge limit."""
+        if not self._version_check("5.0.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}limit"
+        data: Dict[str, Any] = {}
+
+        _LOGGER.debug("Getting limit config on %s", url)
+        response = await self.process_request(
+            url=url, method="get", data=data
+        )  # noqa: E501
+        return response
+
+    async def make_claim(
+        self,
+        state: str | None = None,
+        charge_current: int | None = None,
+        max_current: int | None = None,
+        auto_release: bool = True,
+        client: int = CLIENT,
+    ) -> Any:
+        """Make a claim."""
+        if not self._version_check("4.1.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        if state not in ["active", "disabled", None]:
+            _LOGGER.error("Invalid claim state: %s", state)
+            raise ValueError
+
+        url = f"{self.url}claims/{client}"
+
+        data: dict[str, Any] = {}
+
+        data["auto_release"] = auto_release
+
+        if state is not None:
+            data["state"] = state
+        if charge_current is not None:
+            data["charge_current"] = charge_current
+        if max_current is not None:
+            data["max_current"] = max_current
+
+        _LOGGER.debug("Claim data: %s", data)
+        _LOGGER.debug("Setting up claim on %s", url)
+        response = await self.process_request(
+            url=url, method="post", data=data
+        )  # noqa: E501
+        return response
+
+    async def release_claim(self, client: int = CLIENT) -> Any:
+        """Delete a claim."""
+        if not self._version_check("4.1.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}claims/{client}"
+
+        _LOGGER.debug("Releasing claim on %s", url)
+        response = await self.process_request(url=url, method="delete")  # noqa: E501
+        return response
+
+    async def list_claims(self) -> Any:
+        """List all claims."""
+        if not self._version_check("4.1.0"):
+            _LOGGER.debug("Feature not supported for older firmware.")
+            raise UnsupportedFeature
+
+        url = f"{self.url}claims"
+
+        _LOGGER.debug("Getting claims on %s", url)
+        response = await self.process_request(url=url, method="get")  # noqa: E501
+        return response
 
     @property
     def hostname(self) -> str:

python-openevse-http-0.1.59/openevsehttp/const.py

@@ -0,0 +1,17 @@
+"""Constants for the OpenEVSE HTTP python library."""
+
+USER_AGENT = "python-openevse-http"
+MIN_AMPS = 6
+MAX_AMPS = 48
+
+SOLAR = "solar"
+GRID = "grid_ie"
+BAT_LVL = "battery_level"
+BAT_RANGE = "battery_range"
+TTF = "time_to_full_charge"
+VOLTAGE = "voltage"
+SHAPER_LIVE = "shaper_live_pwr"
+TYPE = "type"
+VALUE = "value"
+RELEASE = "release"
+CLIENT = 4

{python-openevse-http-0.1.54 → python-openevse-http-0.1.59}/openevsehttp/exceptions.py

@@ -27,3 +27,7 @@ class MissingSerial(Exception):
 
 class UnsupportedFeature(Exception):
     """Exception for firmware that is too old."""
+
+
+class InvalidType(Exception):
+    """Exception for invalid types."""

{python-openevse-http-0.1.54 → python-openevse-http-0.1.59}/openevsehttp/websocket.py

@@ -1,4 +1,5 @@
 """Websocket class for OpenEVSE HTTP."""
+
 import asyncio
 import logging
 

{python-openevse-http-0.1.54 → python-openevse-http-0.1.59}/python_openevse_http.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-openevse-http
-Version: 0.1.54
+Version: 0.1.59
 Summary: Python wrapper for OpenEVSE HTTP API
 Home-page: https://github.com/firstof9/python-openevse-http
 Author: firstof9
@@ -14,6 +14,7 @@ Classifier: Natural Language :: English
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 

{python-openevse-http-0.1.54 → python-openevse-http-0.1.59}/setup.py

@@ -1,11 +1,12 @@
 """Setup module for python-openevse-http."""
+
 from pathlib import Path
 
 from setuptools import find_packages, setup
 
 PROJECT_DIR = Path(__file__).parent.resolve()
 README_FILE = PROJECT_DIR / "README.md"
-VERSION = "0.1.54"
+VERSION = "0.1.59"
 
 setup(
     name="python-openevse-http",
@@ -30,5 +31,6 @@ setup(
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
     ],
 )

python-openevse-http-0.1.54/openevsehttp/const.py

@@ -1,4 +0,0 @@
-"""Constants for the OpenEVSE HTTP python library."""
-USER_AGENT = "python-openevse-http"
-MIN_AMPS = 6
-MAX_AMPS = 48