fix: created generic parsing of fields

Author: hutcheb

acd/api.py

@@ -1,33 +1,31 @@
 from dataclasses import dataclass
 from os import PathLike
+from typing import List
 
 from acd.database.acd_database import AcdDatabase
-from acd.l5x.elements import Controller, DumpCompsRecords
+from acd.l5x.elements import Controller, DumpCompsRecords, RSLogix5000Content
 
 from acd.export_l5x import ExportL5x
 from acd.unzip import Unzip
 
 
 # Returned Project Structures
-@dataclass
-class Project:
-    """Controller Project"""
-    controller: Controller
+
 
 
 # Import Export Interfaces
 class ImportProject:
     """"Interface to import an PLC project"""
 
-    def import_project(self) -> Project:
+    def import_project(self) -> RSLogix5000Content:
         # Import Project Interface
         pass
 
 
 class ExportProject:
     """"Interface to export an PLC project"""
 
-    def export_project(self, project: Project):
+    def export_project(self, project: RSLogix5000Content):
         # Export Project Interface
         pass
 
@@ -38,18 +36,18 @@ class ImportProjectFromFile(ImportProject):
     """Import a Controller from an ACD stored on file"""
     filename: PathLike
 
-    def import_project(self) -> Project:
+    def import_project(self) -> RSLogix5000Content:
         # Import Project Interface
         export = ExportL5x(self.filename)
-        return Project(export.controller)
+        return export.project
 
 
 @dataclass
 class ExportProjectToFile(ExportProject):
     """Export a Controller to an ACD file"""
     filename: PathLike
 
-    def export_project(self, project: Project):
+    def export_project(self, project: RSLogix5000Content):
         # Concreate example of exporting a Project Object to an ACD file
         raise NotImplementedError
 

acd/export_l5x.py

@@ -4,12 +4,14 @@
 import struct
 import tempfile
 from dataclasses import dataclass, field
+from datetime import datetime
 from sqlite3 import Cursor
+import xml.etree.ElementTree as ET
 
 from acd.comments import CommentsRecord
 from acd.comps import CompsRecord
 from acd.dbextract import DbExtract
-from acd.l5x.elements import Controller, ControllerBuilder
+from acd.l5x.elements import Controller, ControllerBuilder, ProjectBuilder, RSLogix5000Content
 from acd.nameless import NamelessRecord
 from acd.sbregion import SbRegionRecord
 from acd.unzip import Unzip
@@ -21,6 +23,7 @@ class ExportL5x:
     input_filename: os.PathLike
     _temp_dir: str = "build" #tempfile.mkdtemp()
     _controller: Controller = None
+    _project: RSLogix5000Content = None
 
     def __post_init__(self):
         log.info("Creating temporary directory (if it doesn't exist to store ACD database files - " + self._temp_dir)
@@ -98,6 +101,13 @@ def controller(self):
             self._controller = ControllerBuilder(self._cur).build()
         return self._controller
 
+    @property
+    def project(self):
+        if self._project is None:
+            self._project = ProjectBuilder(os.path.join(self._temp_dir, 'QuickInfo.XML')).build()
+            self._project.controller = self.controller
+        return self._project
+
 
     def populate_region_map(self):
         self._cur.execute(

acd/generated/comps/rx_generic.py

@@ -0,0 +1,239 @@
+# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild
+
+import kaitaistruct
+from kaitaistruct import KaitaiStruct, KaitaiStream, BytesIO
+
+
+if getattr(kaitaistruct, 'API_VERSION', (0, 9)) < (0, 9):
+    raise Exception("Incompatible Kaitai Struct Python API: 0.9 or later is required, but you have %s" % (kaitaistruct.__version__))
+
+class RxGeneric(KaitaiStruct):
+    def __init__(self, _io, _parent=None, _root=None):
+        self._io = _io
+        self._parent = _parent
+        self._root = _root if _root else self
+        self._read()
+
+    def _read(self):
+        self.parent_id = self._io.read_u4le()
+        self.unique_tag_identifier = self._io.read_u4le()
+        self.record_format_version = self._io.read_u2le()
+        self.cip_type = self._io.read_u2le()
+        self.comment_id = self._io.read_u2le()
+        _on = self.cip_type
+        if _on == 107:
+            self._raw_main_record = self._io.read_bytes(60)
+            _io__raw_main_record = KaitaiStream(BytesIO(self._raw_main_record))
+            self.main_record = RxGeneric.RxTag(_io__raw_main_record, self, self._root)
+        else:
+            self._raw_main_record = self._io.read_bytes(60)
+            _io__raw_main_record = KaitaiStream(BytesIO(self._raw_main_record))
+            self.main_record = RxGeneric.Unknown(_io__raw_main_record, self, self._root)
+        self.len_record = self._io.read_u4le()
+        self.count_record = self._io.read_u4le()
+        self.extended_records = []
+        for i in range((self.count_record - 1)):
+            self.extended_records.append(RxGeneric.AttributeRecord(self._io, self, self._root))
+
+        self.last_extended_record = RxGeneric.LastAttributeRecord(self._io, self, self._root)
+
+    class Unknown(KaitaiStruct):
+        def __init__(self, _io, _parent=None, _root=None):
+            self._io = _io
+            self._parent = _parent
+            self._root = _root if _root else self
+            self._read()
+
+        def _read(self):
+            self.body = self._io.read_bytes(60)
+
+
+    class LastAttributeRecord(KaitaiStruct):
+        def __init__(self, _io, _parent=None, _root=None):
+            self._io = _io
+            self._parent = _parent
+            self._root = _root if _root else self
+            self._read()
+
+        def _read(self):
+            self.attribute_id = self._io.read_u4le()
+            self.record_length = self._io.read_u4le()
+            self.value = self._io.read_bytes((self.record_length - 4))
+
+
+    class RxMapDevice(KaitaiStruct):
+        def __init__(self, _io, _parent=None, _root=None):
+            self._io = _io
+            self._parent = _parent
+            self._root = _root if _root else self
+            self._read()
+
+        def _read(self):
+            pass
+
+        @property
+        def module_id(self):
+            if hasattr(self, '_m_module_id'):
+                return self._m_module_id
+
+            _pos = self._io.pos()
+            self._io.seek(36)
+            self._m_module_id = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_module_id', None)
+
+        @property
+        def product_type(self):
+            if hasattr(self, '_m_product_type'):
+                return self._m_product_type
+
+            _pos = self._io.pos()
+            self._io.seek(4)
+            self._m_product_type = self._io.read_u2le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_product_type', None)
+
+        @property
+        def vendor_id(self):
+            if hasattr(self, '_m_vendor_id'):
+                return self._m_vendor_id
+
+            _pos = self._io.pos()
+            self._io.seek(2)
+            self._m_vendor_id = self._io.read_u2le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_vendor_id', None)
+
+        @property
+        def slot_no(self):
+            if hasattr(self, '_m_slot_no'):
+                return self._m_slot_no
+
+            _pos = self._io.pos()
+            self._io.seek(32)
+            self._m_slot_no = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_slot_no', None)
+
+        @property
+        def product_code(self):
+            if hasattr(self, '_m_product_code'):
+                return self._m_product_code
+
+            _pos = self._io.pos()
+            self._io.seek(6)
+            self._m_product_code = self._io.read_u2le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_product_code', None)
+
+        @property
+        def parent_module(self):
+            if hasattr(self, '_m_parent_module'):
+                return self._m_parent_module
+
+            _pos = self._io.pos()
+            self._io.seek(22)
+            self._m_parent_module = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_parent_module', None)
+
+
+    class RxTag(KaitaiStruct):
+        def __init__(self, _io, _parent=None, _root=None):
+            self._io = _io
+            self._parent = _parent
+            self._root = _root if _root else self
+            self._read()
+
+        def _read(self):
+            pass
+
+        @property
+        def cip_data_type(self):
+            if hasattr(self, '_m_cip_data_type'):
+                return self._m_cip_data_type
+
+            _pos = self._io.pos()
+            self._io.seek(52)
+            self._m_cip_data_type = self._io.read_u2le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_cip_data_type', None)
+
+        @property
+        def data_type(self):
+            if hasattr(self, '_m_data_type'):
+                return self._m_data_type
+
+            _pos = self._io.pos()
+            self._io.seek(28)
+            self._m_data_type = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_data_type', None)
+
+        @property
+        def dimension_2(self):
+            if hasattr(self, '_m_dimension_2'):
+                return self._m_dimension_2
+
+            _pos = self._io.pos()
+            self._io.seek(16)
+            self._m_dimension_2 = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_dimension_2', None)
+
+        @property
+        def dimension_3(self):
+            if hasattr(self, '_m_dimension_3'):
+                return self._m_dimension_3
+
+            _pos = self._io.pos()
+            self._io.seek(20)
+            self._m_dimension_3 = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_dimension_3', None)
+
+        @property
+        def valid(self):
+            if hasattr(self, '_m_valid'):
+                return self._m_valid
+
+            self._m_valid = True
+            return getattr(self, '_m_valid', None)
+
+        @property
+        def dimension_1(self):
+            if hasattr(self, '_m_dimension_1'):
+                return self._m_dimension_1
+
+            _pos = self._io.pos()
+            self._io.seek(12)
+            self._m_dimension_1 = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_dimension_1', None)
+
+        @property
+        def data_table_instance(self):
+            if hasattr(self, '_m_data_table_instance'):
+                return self._m_data_table_instance
+
+            _pos = self._io.pos()
+            self._io.seek(36)
+            self._m_data_table_instance = self._io.read_u4le()
+            self._io.seek(_pos)
+            return getattr(self, '_m_data_table_instance', None)
+
+
+    class AttributeRecord(KaitaiStruct):
+        def __init__(self, _io, _parent=None, _root=None):
+            self._io = _io
+            self._parent = _parent
+            self._root = _root if _root else self
+            self._read()
+
+        def _read(self):
+            self.attribute_id = self._io.read_u4le()
+            self.record_length = self._io.read_u4le()
+            self.value = self._io.read_bytes(self.record_length)
+
+
+