indevolt-api 1.7.0__tar.gz → 1.7.2__tar.gz

{indevolt_api-1.7.0 → indevolt_api-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: indevolt-api
-Version: 1.7.0
+Version: 1.7.2
 Summary: Python API client for Indevolt devices
 Author: A. Gideonse
 License: MIT
@@ -329,6 +329,11 @@ Get system configuration from the device.
 
 - Dictionary with device system configuration
 
+**Raises:**
+
+- `TimeoutError`: If the request exceeds the configured timeout
+- `aiohttp.ClientError`: On network errors or non-200 HTTP responses
+
 **Example:**
 
 ```python
@@ -400,7 +405,7 @@ Discover Indevolt devices on the local network using UDP broadcast.
 
 **Parameters:**
 
-- `timeout` (float): Discovery timeout in seconds (default: 3.0)
+- `timeout` (float): Discovery timeout in seconds (default: 5.0)
 
 **Returns:**
 
@@ -436,15 +441,19 @@ if device.name:
 
 ## Exception Handling
 
-The library provides custom exceptions for API errors and limit violations.
+The library has two exception-handling behaviours depending on the method:
+
+**Methods that raise** (`fetch_data`, `get_config`): network and HTTP errors propagate to the caller.
 
-### `APIException`
+**Methods that return `False`** (`set_data`, `stop`, `charge`, `discharge`): all network, HTTP, and decoding errors are caught internally and logged at DEBUG level. These methods never raise on communication failure.
 
-Raised when there's a client error during API communication (network errors, HTTP errors).
+### `TimeoutError`
 
-### `TimeOutException`
+Built-in Python exception raised by `fetch_data` and `get_config` when a request exceeds the configured timeout (default: 10 seconds). Not raised by `set_data` or the convenience helpers.
 
-Raised when an API request times out (default timeout: 10 seconds).
+### `aiohttp.ClientError`
+
+Raised by `fetch_data` and `get_config` on network errors or non-200 HTTP responses. Not raised by `set_data` or the convenience helpers.
 
 ### `PowerExceedsMaxError`
 
@@ -461,14 +470,21 @@ Raised by `check_charge_limits()` or `check_discharge_limits()` when the target
 **Example:**
 
 ```python
-from indevolt_api import IndevoltAPI, APIException, TimeOutException
+import aiohttp
+from indevolt_api import IndevoltAPI
 
+# fetch_data and get_config raise on error
 try:
     data = await api.fetch_data("7101")
-except TimeOutException:
+except TimeoutError:
     print("Request timed out")
-except APIException as e:
-    print(f"API error: {e}")
+except aiohttp.ClientError as e:
+    print(f"Network/HTTP error: {e}")
+
+# set_data and helpers return False on error — no try/except needed
+succeeded = await api.set_data(IndevoltConfig.WRITE_DISCHARGE_LIMIT, 50)
+if not succeeded:
+    print("Command failed")
 ```
 
 **Note:** You can adjust the timeout when creating the API client:

{indevolt_api-1.7.0 → indevolt_api-1.7.2}/indevolt_api/__init__.py

@@ -1,14 +1,12 @@
 """Indevolt API - Python client for Indevolt devices."""
 
 from .client import (
-    APIException,
     ActiveDiscoveryProtocol,
     DiscoveredDevice,
     IndevoltAPI,
     PassiveDiscoveryProtocol,
     PowerExceedsMaxError,
     SocBelowMinimumError,
-    TimeOutException,
     async_discover,
 )
 from .const import (
@@ -29,11 +27,10 @@ from .const import (
     IndevoltSystem,
 )
 
-__version__ = "1.7.0"
+__version__ = "1.7.1"
 
 __all__ = [
     "IndevoltAPI",
-    "APIException",
     "ActiveDiscoveryProtocol",
     "DiscoveredDevice",
     "PassiveDiscoveryProtocol",
@@ -54,6 +51,5 @@ __all__ = [
     "IndevoltSystem",
     "PowerExceedsMaxError",
     "SocBelowMinimumError",
-    "TimeOutException",
     "async_discover",
 ]

{indevolt_api-1.7.0 → indevolt_api-1.7.2}/indevolt_api/client.py

@@ -22,14 +22,6 @@ from .const import (
 _LOGGER = logging.getLogger(__name__)
 
 
-class TimeOutException(Exception):
-    """Raised when an API call times out."""
-
-
-class APIException(Exception):
-    """Raised on client error during API call."""
-
-
 class PowerExceedsMaxError(Exception):
     """Raised when requested (dis)charge power exceeds the device maximum."""
 
@@ -293,14 +285,14 @@ class IndevoltAPI:
         try:
             async with self.session.post(url, timeout=self.timeout) as response:
                 if response.status != 200:
-                    raise APIException(f"HTTP status error: {response.status}")
+                    raise ClientError(f"HTTP status error: {response.status}")
                 return await response.json()
 
-        except TimeoutError as err:
-            raise TimeOutException(f"{endpoint} Request timed out") from err
+        except TimeoutError:
+            raise
 
         except aiohttp.ClientError as err:
-            raise APIException(f"{endpoint} Network error: {err}") from err
+            raise ClientError(f"{endpoint} Network error: {err}") from err
 
     async def fetch_data(self, t: str | list[str]) -> dict[str, Any]:
         """Fetch raw JSON data from the device.
@@ -342,25 +334,26 @@ class IndevoltAPI:
         t_int = int(t)
         v_int = [int(item) for item in v]
 
-        response = await self._request(
-            "Indevolt.SetData", {"f": 16, "t": t_int, "v": v_int}
-        )
+        try:
+            response = await self._request(
+                "Indevolt.SetData", {"f": 16, "t": t_int, "v": v_int}
+            )
 
-        return bool(response.get("result", False))
+            return bool(response.get("result", False))
+
+        except (OSError, ClientError, ValueError) as err:
+            _LOGGER.debug("SetData request failed for t=%s, v=%s: %s", t, v, err)
+            return False
 
     async def stop(self) -> bool:
         """Stop any active real-time charge or discharge action.
 
         Returns True on success, False if the command was rejected.
         """
-        try:
-            return await self.set_data(
-                SET_REALTIME_ACTION,
-                [IndevoltRealtimeAction.STOP, 0, 0],
-            )
-        except (TimeOutException, ClientError, ConnectionError, OSError) as err:
-            _LOGGER.debug("stop command failed: %s", err)
-            return False
+        return await self.set_data(
+            SET_REALTIME_ACTION,
+            [IndevoltRealtimeAction.STOP, 0, 0],
+        )
 
     async def charge(self, power: int, target_soc: int) -> bool:
         """Send a real-time charge command to the device.
@@ -368,14 +361,10 @@ class IndevoltAPI:
         Returns True on success, False if the command was rejected.
         Raises ValueError if power or target_soc are out of range.
         """
-        try:
-            return await self.set_data(
-                SET_REALTIME_ACTION,
-                [IndevoltRealtimeAction.CHARGE, power, target_soc],
-            )
-        except (TimeOutException, ClientError, ConnectionError, OSError) as err:
-            _LOGGER.debug("charge command failed: %s", err)
-            return False
+        return await self.set_data(
+            SET_REALTIME_ACTION,
+            [IndevoltRealtimeAction.CHARGE, power, target_soc],
+        )
 
     async def discharge(self, power: int, target_soc: int) -> bool:
         """Send a real-time discharge command to the device.
@@ -383,14 +372,10 @@ class IndevoltAPI:
         Returns True on success, False if the command was rejected.
         Raises ValueError if power or target_soc are out of range.
         """
-        try:
-            return await self.set_data(
-                SET_REALTIME_ACTION,
-                [IndevoltRealtimeAction.DISCHARGE, power, target_soc],
-            )
-        except (TimeOutException, ClientError, ConnectionError, OSError) as err:
-            _LOGGER.debug("discharge command failed: %s", err)
-            return False
+        return await self.set_data(
+            SET_REALTIME_ACTION,
+            [IndevoltRealtimeAction.DISCHARGE, power, target_soc],
+        )
 
     def check_charge_limits(self, power: int, target_soc: int, generation: int) -> None:
         """Check that charge parameters do not exceed device limits.
@@ -445,7 +430,7 @@ class IndevoltAPI:
         try:
             async with self.session.get(url, timeout=self.timeout) as response:
                 if response.status != 200:
-                    raise APIException(f"HTTP status error: {response.status}")
+                    raise ClientError(f"HTTP status error: {response.status}")
                 data = await response.json()
 
                 # Enrich response with device generation
@@ -467,7 +452,7 @@ class IndevoltAPI:
                 return data
 
         except TimeoutError as err:
-            raise TimeOutException("Sys.GetConfig Request timed out") from err
+            raise TimeoutError("Sys.GetConfig Request timed out") from err
 
         except aiohttp.ClientError as err:
-            raise APIException(f"Sys.GetConfig Network error: {err}") from err
+            raise ClientError(f"Sys.GetConfig Network error: {err}") from err

{indevolt_api-1.7.0 → indevolt_api-1.7.2}/indevolt_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: indevolt-api
-Version: 1.7.0
+Version: 1.7.2
 Summary: Python API client for Indevolt devices
 Author: A. Gideonse
 License: MIT
@@ -329,6 +329,11 @@ Get system configuration from the device.
 
 - Dictionary with device system configuration
 
+**Raises:**
+
+- `TimeoutError`: If the request exceeds the configured timeout
+- `aiohttp.ClientError`: On network errors or non-200 HTTP responses
+
 **Example:**
 
 ```python
@@ -400,7 +405,7 @@ Discover Indevolt devices on the local network using UDP broadcast.
 
 **Parameters:**
 
-- `timeout` (float): Discovery timeout in seconds (default: 3.0)
+- `timeout` (float): Discovery timeout in seconds (default: 5.0)
 
 **Returns:**
 
@@ -436,15 +441,19 @@ if device.name:
 
 ## Exception Handling
 
-The library provides custom exceptions for API errors and limit violations.
+The library has two exception-handling behaviours depending on the method:
+
+**Methods that raise** (`fetch_data`, `get_config`): network and HTTP errors propagate to the caller.
 
-### `APIException`
+**Methods that return `False`** (`set_data`, `stop`, `charge`, `discharge`): all network, HTTP, and decoding errors are caught internally and logged at DEBUG level. These methods never raise on communication failure.
 
-Raised when there's a client error during API communication (network errors, HTTP errors).
+### `TimeoutError`
 
-### `TimeOutException`
+Built-in Python exception raised by `fetch_data` and `get_config` when a request exceeds the configured timeout (default: 10 seconds). Not raised by `set_data` or the convenience helpers.
 
-Raised when an API request times out (default timeout: 10 seconds).
+### `aiohttp.ClientError`
+
+Raised by `fetch_data` and `get_config` on network errors or non-200 HTTP responses. Not raised by `set_data` or the convenience helpers.
 
 ### `PowerExceedsMaxError`
 
@@ -461,14 +470,21 @@ Raised by `check_charge_limits()` or `check_discharge_limits()` when the target
 **Example:**
 
 ```python
-from indevolt_api import IndevoltAPI, APIException, TimeOutException
+import aiohttp
+from indevolt_api import IndevoltAPI
 
+# fetch_data and get_config raise on error
 try:
     data = await api.fetch_data("7101")
-except TimeOutException:
+except TimeoutError:
     print("Request timed out")
-except APIException as e:
-    print(f"API error: {e}")
+except aiohttp.ClientError as e:
+    print(f"Network/HTTP error: {e}")
+
+# set_data and helpers return False on error — no try/except needed
+succeeded = await api.set_data(IndevoltConfig.WRITE_DISCHARGE_LIMIT, 50)
+if not succeeded:
+    print("Command failed")
 ```
 
 **Note:** You can adjust the timeout when creating the API client:

{indevolt_api-1.7.0 → indevolt_api-1.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "indevolt-api"
-version = "1.7.0"
+version = "1.7.2"
 description = "Python API client for Indevolt devices"
 readme = "readme.md"
 authors = [

{indevolt_api-1.7.0 → indevolt_api-1.7.2}/readme.md

@@ -303,6 +303,11 @@ Get system configuration from the device.
 
 - Dictionary with device system configuration
 
+**Raises:**
+
+- `TimeoutError`: If the request exceeds the configured timeout
+- `aiohttp.ClientError`: On network errors or non-200 HTTP responses
+
 **Example:**
 
 ```python
@@ -374,7 +379,7 @@ Discover Indevolt devices on the local network using UDP broadcast.
 
 **Parameters:**
 
-- `timeout` (float): Discovery timeout in seconds (default: 3.0)
+- `timeout` (float): Discovery timeout in seconds (default: 5.0)
 
 **Returns:**
 
@@ -410,15 +415,19 @@ if device.name:
 
 ## Exception Handling
 
-The library provides custom exceptions for API errors and limit violations.
+The library has two exception-handling behaviours depending on the method:
+
+**Methods that raise** (`fetch_data`, `get_config`): network and HTTP errors propagate to the caller.
 
-### `APIException`
+**Methods that return `False`** (`set_data`, `stop`, `charge`, `discharge`): all network, HTTP, and decoding errors are caught internally and logged at DEBUG level. These methods never raise on communication failure.
 
-Raised when there's a client error during API communication (network errors, HTTP errors).
+### `TimeoutError`
 
-### `TimeOutException`
+Built-in Python exception raised by `fetch_data` and `get_config` when a request exceeds the configured timeout (default: 10 seconds). Not raised by `set_data` or the convenience helpers.
 
-Raised when an API request times out (default timeout: 10 seconds).
+### `aiohttp.ClientError`
+
+Raised by `fetch_data` and `get_config` on network errors or non-200 HTTP responses. Not raised by `set_data` or the convenience helpers.
 
 ### `PowerExceedsMaxError`
 
@@ -435,14 +444,21 @@ Raised by `check_charge_limits()` or `check_discharge_limits()` when the target
 **Example:**
 
 ```python
-from indevolt_api import IndevoltAPI, APIException, TimeOutException
+import aiohttp
+from indevolt_api import IndevoltAPI
 
+# fetch_data and get_config raise on error
 try:
     data = await api.fetch_data("7101")
-except TimeOutException:
+except TimeoutError:
     print("Request timed out")
-except APIException as e:
-    print(f"API error: {e}")
+except aiohttp.ClientError as e:
+    print(f"Network/HTTP error: {e}")
+
+# set_data and helpers return False on error — no try/except needed
+succeeded = await api.set_data(IndevoltConfig.WRITE_DISCHARGE_LIMIT, 50)
+if not succeeded:
+    print("Command failed")
 ```
 
 **Note:** You can adjust the timeout when creating the API client: