pystuderxcom 3.6.0__tar.gz → 3.6.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pystuderxcom
-Version: 3.6.0
+Version: 3.6.2
 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.2}/pyproject.toml

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

{pystuderxcom-3.6.0 → pystuderxcom-3.6.2}/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.2}/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.2}/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.2}/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.2}/src/pystuderxcom/shared/studer_dataset.py

@@ -10,14 +10,14 @@ import logging
 
 from dataclasses import dataclass
 
-from .studer_types import (
+from ..shared.studer_types import (
     StuderAccess,
     StuderDataType,
     StuderTarget, 
     StuderUserLevel,
     StuderParamException,
 )
-from .studer_families import (
+from ..shared.studer_families import (
     StuderDeviceFamilies,
     StuderDeviceFamily,
     StuderDeviceFamilyUnknownException,

{pystuderxcom-3.6.0 → pystuderxcom-3.6.2}/src/pystuderxcom/shared/studer_families.py

@@ -10,7 +10,7 @@ import logging
 
 from dataclasses import dataclass
 
-from .studer_types import (
+from ..shared.studer_types import (
     StuderAccess,
     StuderDataType,
     StuderTarget, 

{pystuderxcom-3.6.0 → pystuderxcom-3.6.2}/src/pystuderxcom/shared/studer_messageset.py

@@ -10,14 +10,14 @@ import logging
 
 from dataclasses import dataclass
 
-from .studer_types import (
+from ..shared.studer_types import (
     StuderAccess,
     StuderDataType,
     StuderTarget, 
     StuderUserLevel,
     StuderParamException,
 )
-from .studer_families import (
+from ..shared.studer_families import (
     StuderDeviceFamilies,
     StuderDeviceFamily,
     StuderDeviceFamilyUnknownException,

pystuderxcom-3.6.2/src/pystuderxcom/shared/studer_valueset.py

@@ -0,0 +1,63 @@
+"""
+Shared Data Types 
+
+Note that this file is shared as is between pystuderxcom and pystudernext.
+Do not place code that is specific to only one of these libraries in here!
+"""
+
+import logging
+
+from dataclasses import dataclass
+from enum import IntEnum, StrEnum
+from typing import Any, Iterable
+
+from ..shared.studer_dataset import StuderDatapoint
+from ..shared.studer_types import StuderDiscoveredDevice, StuderParamException
+
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class StuderValueItem():
+    datapoint: StuderDatapoint      # Both in request and response
+    code: str                       # Both in request and response
+    address_or_slave: int           # Both in request and response (Xcom uses address, Next uses slave)
+    value: Any | None               # Only in response from request_values()
+    error: str|None                 # Only in response from request_values()
+
+    def __init__(self, datapoint: StuderDatapoint, device: StuderDiscoveredDevice|int|str, value: Any=None, error: str=None):
+
+        self.datapoint = datapoint
+
+        # Fill the code, address or slave properties we know, rest will be determined from family in derived class
+        if isinstance(device, StuderDiscoveredDevice):
+            self.code = device.code
+            self.address_or_slave = device.address or device.slave
+        elif isinstance(device, int):
+            self.address_or_slave = device
+            self.code = None
+        elif isinstance(device, str):
+            self.code = device
+            self.address_or_slave = None
+        else:
+            raise StuderParamException(f"Parameter 'device' must be a StuderDiscoveredDevice, device address or a device code")
+        
+        self.value = value
+        self.error = error
+
+    @property
+    def address(self):
+        return self.address_or_slave
+
+    @property
+    def slave(self):
+        return self.address_or_slave
+
+
+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.2}/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.2/src/pystuderxcom.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pystuderxcom
-Version: 3.6.0
+Version: 3.6.2
 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.2}/tests/test_api_base_async.py

@@ -11,6 +11,7 @@ from pystuderxcom import XcomValueSet, XcomValueItem
 from pystuderxcom import XcomVoltage, XcomAggregationType, ScomServiceId, ScomServiceFlag, ScomFrameFlag, ScomObjType, ScomObjId, ScomQspId, ScomAddress, ScomErrorCode
 from pystuderxcom import XcomDataMessageRsp
 from pystuderxcom import StuderDataType
+from pystuderxcom import StuderValueItem, StuderValueSet
 
 from . import AsyncTestApi, TestApi
 from . import AsyncTaskHelper, TaskHelper
@@ -439,6 +440,35 @@ async def data_infos_virt_aggr(dataset):
     )
     yield req_data, rsp_multi, rsp_single
 
+@pytest_asyncio.fixture
+async def data_studer_dev(dataset):
+    info_3021 = dataset.get_by_nr(3021)
+    info_3022 = dataset.get_by_nr(3022)
+    param_1107 = dataset.get_by_nr(1107)
+
+    req_data = StuderValueSet([
+        StuderValueItem(datapoint=info_3021, device="XT1"),
+        StuderValueItem(datapoint=param_1107, device=101),
+        StuderValueItem(datapoint=info_3022, device=101),
+    ])
+    rsp_multi = XcomValueSet(
+        flags = 0x00, 
+        datetime = 0, 
+        items=[
+            XcomValueItem(datapoint=info_3021, aggregation_type=XcomAggregationType.MASTER, value=12.3),
+            XcomValueItem(datapoint=info_3022, aggregation_type=XcomAggregationType.DEVICE1, value=45.6),
+        ]
+    )
+    rsp_single = XcomValueSet(
+        flags = 0x00, 
+        datetime = 0, 
+        items=[
+            XcomValueItem(datapoint=param_1107, aggregation_type=XcomAggregationType.DEVICE1, value=1234.0),
+        ]
+    )
+    yield req_data, rsp_multi, rsp_single
+
+
 
 @pytest.mark.asyncio
 @pytest.mark.usefixtures("dataset", "data_infos_dev", "data_infos_aggr", "data_infos_params_dev", "data_infos_params_aggr", "data_infos_virt_dev", "data_infos_virt_aggr")
@@ -521,7 +551,7 @@ async def test_request_infos(name, values_fixture, run_receive, exp_src_addr, ex
 
 
 @pytest.mark.asyncio
-@pytest.mark.usefixtures("dataset", "data_infos_dev", "data_infos_aggr", "data_infos_params_dev", "data_infos_params_aggr", "data_infos_virt_dev", "data_infos_virt_aggr")
+@pytest.mark.usefixtures("dataset", "data_infos_dev", "data_infos_aggr", "data_infos_params_dev", "data_infos_params_aggr", "data_infos_virt_dev", "data_infos_virt_aggr", "data_studer_dev")
 @pytest.mark.parametrize(
     "name, values_fixture, run_receive, rsp_flags, exp_value, exp_error, exp_except",
     [
@@ -533,6 +563,7 @@ async def test_request_infos(name, values_fixture, run_receive, exp_src_addr, ex
         ("request values params aggr",    "data_infos_params_aggr", False, 0x02, False, False, XcomParamException),
         ("request values virt ok",        "data_infos_virt_dev",    True,  0x02, True,  False, None),
         ("request values virt aggr",      "data_infos_virt_aggr",   False, 0x02, False, False, XcomParamException),
+        ("request values studer ok",      "data_studer_dev",        True,  0x02, True,  False, None),
     ]
 )
 async def test_request_values(name, values_fixture, run_receive, rsp_flags, exp_value, exp_error, exp_except, request):

{pystuderxcom-3.6.0 → pystuderxcom-3.6.2}/tests/test_api_base_sync.py

@@ -13,6 +13,7 @@ from pystuderxcom import XcomValueSet, XcomValueItem
 from pystuderxcom import XcomVoltage, XcomAggregationType, ScomServiceId, ScomServiceFlag, ScomFrameFlag, ScomObjType, ScomObjId, ScomQspId, ScomAddress, ScomErrorCode
 from pystuderxcom import XcomDataMessageRsp
 from pystuderxcom import StuderDataType
+from pystuderxcom import StuderValueItem, StuderValueSet
 
 from . import AsyncTestApi, TestApi
 from . import AsyncTaskHelper, TaskHelper
@@ -441,6 +442,35 @@ def data_infos_virt_aggr(dataset):
     )
     yield req_data, rsp_multi, rsp_single
 
+@pytest.fixture
+def data_studer_dev(dataset):
+    info_3021 = dataset.get_by_nr(3021)
+    info_3022 = dataset.get_by_nr(3022)
+    param_1107 = dataset.get_by_nr(1107)
+
+    req_data = StuderValueSet([
+        StuderValueItem(datapoint=info_3021, device="XT1"),
+        StuderValueItem(datapoint=param_1107, device=101),
+        StuderValueItem(datapoint=info_3022, device=101),
+    ])
+    rsp_multi = XcomValueSet(
+        flags = 0x00, 
+        datetime = 0, 
+        items=[
+            XcomValueItem(datapoint=info_3021, aggregation_type=XcomAggregationType.MASTER, value=12.3),
+            XcomValueItem(datapoint=info_3022, aggregation_type=XcomAggregationType.DEVICE1, value=45.6),
+        ]
+    )
+    rsp_single = XcomValueSet(
+        flags = 0x00, 
+        datetime = 0, 
+        items=[
+            XcomValueItem(datapoint=param_1107, aggregation_type=XcomAggregationType.DEVICE1, value=1234.0),
+        ]
+    )
+    yield req_data, rsp_multi, rsp_single
+
+
 
 @pytest.mark.asyncio
 @pytest.mark.usefixtures("dataset", "data_infos_dev", "data_infos_aggr", "data_infos_params_dev", "data_infos_params_aggr", "data_infos_virt_dev", "data_infos_virt_aggr")
@@ -523,7 +553,7 @@ def test_request_infos(name, values_fixture, run_receive, exp_src_addr, exp_dst_
 
 
 @pytest.mark.asyncio
-@pytest.mark.usefixtures("dataset", "data_infos_dev", "data_infos_aggr", "data_infos_params_dev", "data_infos_params_aggr", "data_infos_virt_dev", "data_infos_virt_aggr")
+@pytest.mark.usefixtures("dataset", "data_infos_dev", "data_infos_aggr", "data_infos_params_dev", "data_infos_params_aggr", "data_infos_virt_dev", "data_infos_virt_aggr", "data_studer_dev")
 @pytest.mark.parametrize(
     "name, values_fixture, run_receive, rsp_flags, exp_value, exp_error, exp_except",
     [
@@ -535,6 +565,7 @@ def test_request_infos(name, values_fixture, run_receive, exp_src_addr, exp_dst_
         ("request values params aggr",    "data_infos_params_aggr", False, 0x02, False, False, XcomParamException),
         ("request values virt ok",        "data_infos_virt_dev",    True,  0x02, True,  False, None),
         ("request values virt aggr",      "data_infos_virt_aggr",   False, 0x02, False, False, XcomParamException),
+        ("request values studer ok",      "data_studer_dev",        True,  0x02, True,  False, None),
     ]
 )
 def test_request_values(name, values_fixture, run_receive, rsp_flags, exp_value, exp_error, exp_except, request):

pystuderxcom-3.6.0/src/pystuderxcom/shared/studer_valueset.py

@@ -1,40 +0,0 @@
-"""
-Shared Data Types 
-
-Note that this file is shared as is between pystuderxcom and pystudernext.
-Do not place code that is specific to only one of these libraries in here!
-"""
-
-import logging
-
-from dataclasses import dataclass
-from enum import IntEnum, StrEnum
-from typing import Any, Iterable
-
-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()
-    error: str|None                             # Only in response from request_values()
-
-    @property
-    def address(self):
-        return self.address_or_slave
-
-    @property
-    def slave(self):
-        return self.address_or_slave
-
-
-class StuderValueSet(list[StuderValueItem]):
-    items: Iterable[StuderValueItem]            # Both in request and response
-
-