aioads 0.1.0.dev5__tar.gz → 0.1.0.dev6__tar.gz

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aioads
-Version: 0.1.0.dev5
+Version: 0.1.0.dev6
 Summary: An asynchronous Python library for communicating with Beckhoff TwinCAT PLCs
 Author-email: MkKiefer <102972583+MkKiefer@users.noreply.github.com>
 License: MIT

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_sum_read.py

@@ -5,13 +5,13 @@ sending multiple `AdsReadCommand` in a single command
 https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_adsdll2/124830987.html&id=
 """
 
-
 from struct import Struct
 from typing import Final
 from aioads.ads_error_codes import AdsErrorCode
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read import AdsReadCommand, AdsReadResponse
 from aioads.commands.ads_read_write import AdsReadWriteCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 from aioads.stream import AdsStream
 from aioads.transport import ITransport
@@ -19,7 +19,7 @@ from aioads.transport import ITransport
 
 class AdsSumRead(IAdsFunction[list[tuple[AdsReadResponse, AdsStream]]]):
     """
-    Ads sum read command that allows batching up to 500 `AdsReadCommand` in a single call    
+    Ads sum read command that allows batching up to 500 `AdsReadCommand` in a single call
     """
 
     ERROR_CODE_STRUCT_DEF: Final[Struct] = Struct("<I")
@@ -36,17 +36,15 @@ class AdsSumRead(IAdsFunction[list[tuple[AdsReadResponse, AdsStream]]]):
 
     def serialize(self) -> bytes:
         """
-        serialize all commands to bytes 
+        serialize all commands to bytes
         """
         return b"".join(command.serialize() for command in self.commands)
 
     async def execute(self) -> list[tuple[AdsReadResponse, AdsStream]]:
         if len(self.commands) == 0:
-            raise ValueError(
-                "At least one command is required for ADS Sum Read")
+            raise ValueError("At least one command is required for ADS Sum Read")
         if len(self.commands) > 500:
-            raise ValueError(
-                "Too many commands for ADS Sum Read, maximum is 500")
+            raise ValueError("Too many commands for ADS Sum Read, maximum is 500")
 
         payload = self.serialize()
         command = AdsReadWriteCommand(
@@ -60,20 +58,27 @@ class AdsSumRead(IAdsFunction[list[tuple[AdsReadResponse, AdsStream]]]):
             write_length=len(payload),
             write_data=payload,
         )
-        _, read_payload = await command.request()
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(header.error_code, "Failed to execute ADS Sum Read")
         error_stream = read_payload.sub_stream(
             # 4 bytes per error code
-            len(self.commands) * self.ERROR_CODE_STRUCT_DEF.size)
+            len(self.commands)
+            * self.ERROR_CODE_STRUCT_DEF.size
+        )
 
         response: list[tuple[AdsReadResponse, AdsStream]] = []
         for cmd in self.commands:
             error_code = AdsErrorCode(
-                error_stream.read_struct(self.ERROR_CODE_STRUCT_DEF)[0])
-            response.append((
-                AdsReadResponse(
-                    error_code=error_code,
-                    length=cmd.length,
-                ),
-                read_payload.sub_stream(cmd.length))
+                error_stream.read_struct(self.ERROR_CODE_STRUCT_DEF)[0]
+            )
+            response.append(
+                (
+                    AdsReadResponse(
+                        error_code=error_code,
+                        length=cmd.length,
+                    ),
+                    read_payload.sub_stream(cmd.length),
+                )
             )
         return response

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_sum_read_write.py

@@ -49,17 +49,17 @@ packet
 ```
 
 """
+
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read import AdsReadResponse
 from aioads.commands.ads_read_write import AdsReadWriteCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 from aioads.stream import AdsStream
 from aioads.transport import ITransport
 
 
-class AdsSumReadWrite(
-    IAdsFunction[list[tuple[AdsReadResponse, AdsStream]]]
-):
+class AdsSumReadWrite(IAdsFunction[list[tuple[AdsReadResponse, AdsStream]]]):
     """
     ADS Sum Read/Write function to send a READ/WRITE Command in batch.
     This function allows multiple read/write commands to be sent in a single request,
@@ -92,11 +92,9 @@ class AdsSumReadWrite(
         :return: An async generator yielding tuples of (AdsReadResponse, AdsStream) for each command.
         """
         if len(self.commands) == 0:
-            raise ValueError(
-                "At least one command is required for ADS Sum Read/Write")
+            raise ValueError("At least one command is required for ADS Sum Read/Write")
         if len(self.commands) > 500:
-            raise ValueError(
-                "Too many commands for ADS Sum Read/Write, maximum is 500")
+            raise ValueError("Too many commands for ADS Sum Read/Write, maximum is 500")
 
         payload = self.serialize()
         total_read_length = sum(
@@ -117,15 +115,19 @@ class AdsSumReadWrite(
             write_length=total_write_length,
             write_data=payload,
         )
-        _, read_payload = await command.request()
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(
+                header.error_code, "Failed to execute ADS Sum Read/Write"
+            )
         read_response_stream = read_payload.sub_stream(
-            len(self.commands) * AdsReadResponse.STRUCT_DEF.size)
+            len(self.commands) * AdsReadResponse.STRUCT_DEF.size
+        )
 
         response: list[tuple[AdsReadResponse, AdsStream]] = []
         for _ in self.commands:
             read_response = AdsReadResponse.deserialize(read_response_stream)
-            response.append((
-                read_response,
-                read_payload.sub_stream(read_response.length)
-            ))
+            response.append(
+                (read_response, read_payload.sub_stream(read_response.length))
+            )
         return response

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_symbol_datatype_by_name.py

@@ -36,11 +36,13 @@ packet
 
 
 """
+
 from dataclasses import dataclass
 from struct import Struct
 from typing import ClassVar
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read_write import AdsReadWriteCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 from aioads.functions.ads_symbol_info_by_name_ex import (
     AdsSymbolDataType,
@@ -75,8 +77,7 @@ class AdsDatatypeArrayInfo:
         """
         Create `AdsDatatypeArrayInfo` from the `AdsStream`
         """
-        l_bound, e_elements = data.read_struct(
-            AdsDatatypeArrayInfo.STRUCT_DEF)
+        l_bound, e_elements = data.read_struct(AdsDatatypeArrayInfo.STRUCT_DEF)
         return AdsDatatypeArrayInfo(
             l_bound=l_bound,
             e_elements=e_elements,
@@ -227,6 +228,10 @@ class AdsSymbolDataTypeByName(IAdsFunction[SymbolDataTypeResponse]):
             write_length=len(payload),
             read_length=0xFFFF,  # Max read length
         )
-        _, read_payload = await command.request()
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(
+                header.error_code, "Failed to read symbol datatype by name"
+            )
         symbol_datatype = SymbolDataTypeResponse.deserialize(read_payload)
         return symbol_datatype

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_symbol_datatype_upload.py

@@ -6,6 +6,7 @@ https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_adsdll2/124
 
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read import AdsReadCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 from aioads.functions.ads_symbol_datatype_by_name import SymbolDataTypeResponse
 from aioads.transport import ITransport
@@ -38,7 +39,9 @@ class AdsSymbolDataTypeUpload(IAdsFunction[list[SymbolDataTypeResponse]]):
             idx_offset=0,
             length=self.dt_size,
         )
-        _, read_payload = await command.request()
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(header.error_code, "Failed to read datatype info")
 
         symbol_datatypes = list[SymbolDataTypeResponse]()
         start = read_payload.tell()

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_symbol_info_by_name_ex.py

@@ -1,5 +1,5 @@
 """
-This module provides models and ads function to get the symbol info (symbol metadata) by the variable / symbol name. 
+This module provides models and ads function to get the symbol info (symbol metadata) by the variable / symbol name.
 """
 
 from dataclasses import dataclass
@@ -9,6 +9,7 @@ from typing import ClassVar
 from aioads.ads_error_codes import AdsErrorCode
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read_write import AdsReadWriteCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 from aioads.functions.ads_sum_read_write import AdsSumReadWrite
 from aioads.stream import AdsStream
@@ -113,10 +114,8 @@ class SymbolInfo:
             type_name_length,
             comment_length,
         ) = data.read_struct(SymbolInfo.FIXED_STRUCT)
-        symbol_name = data.read(symbol_name_length + 1).rstrip(
-            b"\x00").decode("cp1252")
-        type_name = data.read(type_name_length + 1).rstrip(
-            b"\x00").decode("cp1252")
+        symbol_name = data.read(symbol_name_length + 1).rstrip(b"\x00").decode("cp1252")
+        type_name = data.read(type_name_length + 1).rstrip(b"\x00").decode("cp1252")
         comment = data.read(comment_length + 1).rstrip(b"\x00").decode("cp1252")
 
         # Move the stream position to the end of the entry
@@ -133,6 +132,20 @@ class SymbolInfo:
             comment=comment,
         )
 
+    @classmethod
+    def void(cls) -> "SymbolInfo":
+        """A void symbol info that can be used as a placeholder"""
+        return cls(
+            idx_group=0,
+            idx_offset=0,
+            idx_length=0,
+            data_type=AdsSymbolDataType.VOID,
+            symbol_flags=AdsSymbolFlags(0),
+            symbol_name="",
+            type_name="",
+            comment="",
+        )
+
 
 class SymbolInfoByNameEx(IAdsFunction[SymbolInfo]):
     """
@@ -165,14 +178,14 @@ class SymbolInfoByNameEx(IAdsFunction[SymbolInfo]):
             read_length=0xFFFF,  # Max read length
             write_data=payload,
         )
-        _, read_payload = await command.request()
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(header.error_code, "Failed to read symbol info")
         symbol_info = SymbolInfo.deserialize(read_payload)
         return symbol_info
 
 
-class SymbolInfoByNameExSumRead(
-    IAdsFunction[list[tuple[AdsErrorCode, SymbolInfo]]]
-):
+class SymbolInfoByNameExSumRead(IAdsFunction[list[tuple[AdsErrorCode, SymbolInfo]]]):
     """
     This function utilizes the `AdsSumReadWrite` function to
     send multiple `SymbolInfoByNameEx` function calls in a batch.
@@ -219,9 +232,14 @@ class SymbolInfoByNameExSumRead(
             command = AdsSumReadWrite(
                 transport=self.transport,
                 ams_address=self.ams_address,
-                commands=commands[batch_start:batch_start + self.BATCH_SIZE],
+                commands=commands[batch_start : batch_start + self.BATCH_SIZE],
             )
-            for read_header, read_payload in await command.execute():
+            for header, read_payload in await command.execute():
+                # If we have an error and no payload we return a void symbol info
+                # we raise no exception to let the client handle the error for each symbol individually
+                if not header.error_code.ok and read_payload.length == 0:
+                    response.append((header.error_code, SymbolInfo.void()))
+                    continue
                 symbol_info = SymbolInfo.deserialize(read_payload)
-                response.append((read_header.error_code, symbol_info))
+                response.append((header.error_code, symbol_info))
         return response

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_symbol_table_version.py

@@ -2,7 +2,7 @@
 This module contains the ads function call for requesting the `SymbolTableVersion`.
 
 
-This can be used to monitoring, on change the index offsets in symbol metadata can change 
+This can be used to monitoring, on change the index offsets in symbol metadata can change
 and we need to re resolve the new address where we can read this symbol, if we don't do this
 we read a random memory array we most likely can't parse.
 https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_adsdll2/124830987.html&id=
@@ -42,8 +42,9 @@ class SymbolTableVersion(IAdsFunction[int]):
             idx_offset=0,
             length=1,
         )
-        read_resp, read_stream = await command.request()
-        if not read_resp.error_code.ok:
-            raise AdsCommandError(read_resp.error_code,
-                                  "Failed to read symbol table version")
+        header, read_stream = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(
+                header.error_code, "Failed to read symbol table version"
+            )
         return read_stream.read_struct(self.VERSION_STRUCT_DEF)[0]

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_symbol_upload.py

@@ -1,9 +1,10 @@
 """
-This module contains a ads function to acquire the symbol infos (metadata) of the global / root symbols.  
+This module contains a ads function to acquire the symbol infos (metadata) of the global / root symbols.
 """
 
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read import AdsReadCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 from aioads.functions.ads_symbol_info_by_name_ex import SymbolInfo
 from aioads.transport import ITransport
@@ -11,8 +12,8 @@ from aioads.transport import ITransport
 
 class AdsSymbolUpload(IAdsFunction[list[SymbolInfo]]):
     """
-    Ads Function to read all global symbols. 
-    Hint: 
+    Ads Function to read all global symbols.
+    Hint:
         Only the top most symbol information are returned, to get the full ads tree
         you need to resolve it from this over the datatypes that can be requested with `AdsSymbolDataTypeUpload`
     """
@@ -36,7 +37,12 @@ class AdsSymbolUpload(IAdsFunction[list[SymbolInfo]]):
             idx_offset=0,
             length=self.tree_size,
         )
-        _, read_payload = await command.request()
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(
+                header.error_code, "Failed to request symbol upload info"
+            )
+
         symbol_infos = list[SymbolInfo]()
 
         start = read_payload.tell()

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/aioads/functions/ads_symbol_upload_info.py

@@ -10,6 +10,7 @@ from typing import ClassVar
 
 from aioads.ams_address import AmsAddress
 from aioads.commands.ads_read import AdsReadCommand
+from aioads.commands.errors import AdsCommandError
 from aioads.functions.ads_function import AdsFunctionSymbolGroup, IAdsFunction
 
 from aioads.stream import AdsStream
@@ -46,11 +47,9 @@ class SymbolUploadInfo2Response:
     @classmethod
     def deserialize(cls, data: AdsStream) -> "SymbolUploadInfo2Response":
         """
-        Create `SymbolUploadInfo2Response` from the `AdsStream` 
+        Create `SymbolUploadInfo2Response` from the `AdsStream`
         """
-        parsed: tuple[
-            int, int, int, int, int, int
-        ] = data.read_struct(cls.STRUCT_DEF)
+        parsed: tuple[int, int, int, int, int, int] = data.read_struct(cls.STRUCT_DEF)
         return cls(
             symbol_cnt=parsed[0],
             symbol_size=parsed[1],
@@ -63,7 +62,7 @@ class SymbolUploadInfo2Response:
 
 class AdsSymbolUploadInfo2(IAdsFunction[SymbolUploadInfo2Response]):
     """
-    Function to acquire basic symbol information 
+    Function to acquire basic symbol information
     """
 
     def __init__(self, transport: ITransport, ams_address: AmsAddress) -> None:
@@ -83,7 +82,10 @@ class AdsSymbolUploadInfo2(IAdsFunction[SymbolUploadInfo2Response]):
             # 6 x 4 bytes (We expect a struct with 6x UINT32)
             length=SymbolUploadInfo2Response.STRUCT_DEF.size,
         )
-        _, read_payload = await command.request()
-        symbol_upload_info = SymbolUploadInfo2Response.deserialize(
-            read_payload)
+        header, read_payload = await command.request()
+        if not header.error_code.ok:
+            raise AdsCommandError(
+                header.error_code, "Failed to request symbol upload info"
+            )
+        symbol_upload_info = SymbolUploadInfo2Response.deserialize(read_payload)
         return symbol_upload_info

{aioads-0.1.0.dev5 → aioads-0.1.0.dev6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "aioads"
-version = "0.1.0.dev5"
+version = "0.1.0.dev6"
 description = "An asynchronous Python library for communicating with Beckhoff TwinCAT PLCs"
 authors = [
     { name = "MkKiefer", email = "102972583+MkKiefer@users.noreply.github.com" },