pystuderxcom 3.6.0__tar.gz → 3.6.1__tar.gz

{pystuderxcom-3.6.0/src/pystuderxcom.egg-info → pystuderxcom-3.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pystuderxcom
-Version: 3.6.0
+Version: 3.6.1
 Summary: Python library to communicate with Studer-Innotec devices on the local network via Xcom protocol
 Author-email: Anko Hanse <anko_hanse@hotmail.com>
 Project-URL: Homepage, https://github.com/ankohanse/pystuderxcom

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pystuderxcom"
-version = "3.6.0"
+version = "3.6.1"
 authors = [
   { name="Anko Hanse", email="anko_hanse@hotmail.com" },
 ]

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/src/pystuderxcom/__init__.py

@@ -4,8 +4,9 @@ from .shared.studer_types import StuderParamException
 from .shared.studer_dataset import StuderDataset, StuderDatapoint, StuderDatapointUnknownException, StuderDatapointSyntaxException, StuderDatapointEnumNotFoundException
 from .shared.studer_families import StuderDeviceFamily, StuderDeviceFamilies, StuderDeviceFamilyUnknownException, StuderDeviceCodeUnknownException, StuderDeviceAddressUnknownException, StuderDeviceSlaveUnknownException
 from .shared.studer_messageset import StuderMessageSet, StuderMessageDef, StuderMessageUnknownException, StuderMessageSyntaxException
-from .shared.studer_interfaces_async import AsyncStuderDiscover, StuderDiscoverFlags
-from .shared.studer_interfaces_sync import StuderDiscover
+from .shared.studer_interfaces_async import AsyncStuderApi, AsyncStuderDiscover, StuderDiscoverFlags
+from .shared.studer_interfaces_sync import StuderApi, StuderDiscover
+from .shared.studer_valueset import StuderValueSet, StuderValueItem
 
 from .api_tcp import AsyncXcomApiTcp, XcomApiTcp
 from .api_udp import AsyncXcomApiUdp, XcomApiUdp

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/src/pystuderxcom/api_base_async.py

@@ -12,6 +12,7 @@ from .shared.studer_interfaces_async import AsyncStuderApi
 from .shared.studer_interfaces_sync import StuderApi
 from .shared.studer_types import StuderAccess, StuderDataType, StuderDiscoveredDevice, StuderTarget, StuderUserLevel
 from .shared.studer_dataset import StuderDatapoint
+from .shared.studer_valueset import StuderValueSet, StuderValueItem
 from .const import START_TIMEOUT, STOP_TIMEOUT, REQ_TIMEOUT, REQ_RETRIES, REQ_BURST_PERIOD
 from .const import ScomAddress, XcomAggregationType, ScomFrameFlag, ScomObjType, ScomObjId, ScomServiceId, ScomQspId
 from .const import XcomApiReadException, XcomApiWriteException, XcomApiUnpackException, XcomApiTimeoutException, XcomApiResponseIsError, XcomParamException
@@ -294,7 +295,7 @@ class AsyncXcomApiBase(AsyncStuderApi):
                 raise XcomApiUnpackException(msg) from None
 
 
-    async def request_values(self, request_data: XcomValueSet, retries = None, timeout = None, verbose=False) -> XcomValueSet:
+    async def request_values(self, request_data: StuderValueSet, retries = None, timeout = None, verbose=False) -> StuderValueSet:
         """
         Request multiple infos, params or virtuals in one call.
         Can only retrieve actual device values, NOT the average or sum over multiple devices.
@@ -319,6 +320,10 @@ class AsyncXcomApiBase(AsyncStuderApi):
         idx_last = safe_len(request_data.items)-1
 
         for idx,item in enumerate(request_data.items):
+
+            # If needed, cast StuderValueItem into XcomValueItem so that extra fields are resolved
+            if not isinstance(item, XcomValueItem) and isinstance(item, StuderValueItem):
+                item = XcomValueItem(datapoint=item.datapoint, device=item.code or item.address)
             
             match item.datapoint.target:
                 case StuderTarget.VIRTUAL:

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/src/pystuderxcom/api_base_sync.py

@@ -14,6 +14,7 @@ from .shared.studer_interfaces_async import AsyncStuderApi
 from .shared.studer_interfaces_sync import StuderApi
 from .shared.studer_types import StuderAccess, StuderDataType, StuderDiscoveredDevice, StuderTarget, StuderUserLevel
 from .shared.studer_dataset import StuderDatapoint
+from .shared.studer_valueset import StuderValueSet, StuderValueItem
 from .const import START_TIMEOUT, STOP_TIMEOUT, REQ_TIMEOUT, REQ_RETRIES, REQ_BURST_PERIOD
 from .const import ScomAddress, XcomAggregationType, ScomFrameFlag, ScomObjType, ScomObjId, ScomServiceId, ScomQspId
 from .const import XcomApiReadException, XcomApiWriteException, XcomApiUnpackException, XcomApiTimeoutException, XcomApiResponseIsError, XcomParamException
@@ -23,8 +24,8 @@ from .families import XcomDeviceFamilies
 from .messages import XcomMessage, XcomMessageSet
 from .protocol import XcomFrame, XcomHeader, XcomPackage
 from .values import XcomValueSet, XcomValueItem
-import time
 import threading
+import time
 
 
 _LOGGER = logging.getLogger(__name__)
@@ -298,7 +299,7 @@ class XcomApiBase(StuderApi):
                 raise XcomApiUnpackException(msg) from None
 
 
-    def request_values(self, request_data: XcomValueSet, retries = None, timeout = None, verbose=False) -> XcomValueSet:
+    def request_values(self, request_data: StuderValueSet, retries = None, timeout = None, verbose=False) -> StuderValueSet:
         """
         Request multiple infos, params or virtuals in one call.
         Can only retrieve actual device values, NOT the average or sum over multiple devices.
@@ -323,6 +324,10 @@ class XcomApiBase(StuderApi):
         idx_last = safe_len(request_data.items)-1
 
         for idx,item in enumerate(request_data.items):
+
+            # If needed, cast StuderValueItem into XcomValueItem so that extra fields are resolved
+            if not isinstance(item, XcomValueItem) and isinstance(item, StuderValueItem):
+                item = XcomValueItem(datapoint=item.datapoint, device=item.code or item.address)
             
             match item.datapoint.target:
                 case StuderTarget.VIRTUAL:
@@ -343,6 +348,7 @@ class XcomApiBase(StuderApi):
                                 req_multi_items.append(item)
 
                             elif item.address is not None:
+                                
                                 # Any others need to be done via an individual request_value cal
                                 req_singles.append(item)
 

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/src/pystuderxcom/const.py

@@ -13,6 +13,9 @@ from .shared.studer_types import (
 )
 
 
+class XcomApiConnectException(Exception):
+    """Exception to indicate failure to connect to the xcom client"""
+
 class XcomApiWriteException(Exception):
     """Exception to indicate failure while writing data to the xcom client"""
     

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/src/pystuderxcom/shared/studer_valueset.py

@@ -17,14 +17,24 @@ from .studer_dataset import StuderDatapoint
 _LOGGER = logging.getLogger(__name__)
 
 
-@dataclass
 class StuderValueItem():
     datapoint: StuderDatapoint                  # Both in request and response
-    code: str|None                              # Both in request and response
-    address_or_slave: int|None                  # Both in request and response
-    value: Any                                  # Only in response from request_values()
+    code: str                                   # Both in request and response
+    address_or_slave: int                       # Both in request and response
+    value: Any | None                           # Only in response from request_values()
     error: str|None                             # Only in response from request_values()
 
+    def __init__(self, datapoint: StuderDatapoint, code: str=None, address_or_slave: int=None, value: Any=None, error: str=None):
+
+        if code is None and address_or_slave is None:
+            raise StuderParamException(f"At least one of parameters 'code' or 'address_or_slave' must be specified")
+        
+        self.datapoint = datapoint
+        self.code = code
+        self.address_or_slave = address_or_slave
+        self.value = value
+        self.error = error
+
     @property
     def address(self):
         return self.address_or_slave
@@ -34,7 +44,10 @@ class StuderValueItem():
         return self.address_or_slave
 
 
-class StuderValueSet(list[StuderValueItem]):
+class StuderValueSet():
     items: Iterable[StuderValueItem]            # Both in request and response
 
+    def __init__(self, items: Iterable[StuderValueItem] ):
+        self.items = items
+
 

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1}/src/pystuderxcom/values.py

@@ -29,7 +29,6 @@ from .families import XcomDeviceFamilies
 _LOGGER = logging.getLogger(__name__)
 
 
-@dataclass
 class XcomValueItem(StuderValueItem):
     # From parent class:
     #    datapoint: StuderDatapoint                  # Both in request and response, for request_infos and request_values
@@ -77,7 +76,6 @@ class XcomValueItem(StuderValueItem):
         self.error = error
 
 
-@dataclass
 class XcomValueSet(StuderValueSet):
     # From parent
     #    items: Iterable[StuderValueItem] # Both in request and response

{pystuderxcom-3.6.0 → pystuderxcom-3.6.1/src/pystuderxcom.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pystuderxcom
-Version: 3.6.0
+Version: 3.6.1
 Summary: Python library to communicate with Studer-Innotec devices on the local network via Xcom protocol
 Author-email: Anko Hanse <anko_hanse@hotmail.com>
 Project-URL: Homepage, https://github.com/ankohanse/pystuderxcom