l5x-toolkit 1.2.1__py3-none-any.whl

l5x_agent_toolkit/__init__.py

@@ -0,0 +1,99 @@
+"""
+L5X Agent Toolkit - AI-driven manipulation of Rockwell Automation L5X files.
+
+This toolkit provides validated, atomic operations for reading and modifying
+Studio 5000 Logix Designer L5X project files. It is designed to be invoked
+by an AI agent (via MCP or direct function calls) to ensure hyper-accurate
+L5X file manipulation.
+
+Core Design Principle:
+    The AI agent never touches raw XML. Instead, it invokes validated tool
+    functions that produce structurally correct XML every time.
+
+Usage:
+    from l5x_agent_toolkit import L5XProject
+
+    # Load a project
+    project = L5XProject('path/to/project.L5X')
+
+    # Query operations
+    programs = project.list_programs()
+    tags = project.list_controller_tags()
+    summary = project.get_project_summary()
+
+    # Tag operations
+    from l5x_agent_toolkit import tags
+    tags.create_tag(project, 'MyTag', 'DINT', description='A counter')
+    tags.set_tag_value(project, 'MyTag', 42)
+
+    # Program/routine operations
+    from l5x_agent_toolkit import programs
+    programs.create_program(project, 'ConveyorControl', description='Conveyor logic')
+    programs.add_rung(project, 'ConveyorControl', 'MainRoutine',
+                      'XIC(StartPB)OTE(MotorRun);', comment='Start motor')
+
+    # Rung operations
+    from l5x_agent_toolkit import rungs
+    errors = rungs.validate_rung_syntax('XIC(tag1)OTE(tag2);')
+    new_text = rungs.substitute_tags('XIC(OldTag)OTE(OldOut);',
+                                      {'OldTag': 'NewTag', 'OldOut': 'NewOut'})
+
+    # Import operations
+    from l5x_agent_toolkit import aoi, udt, modules
+    aoi.import_from_file(project, 'path/to/MyAOI.L5X')
+    udt.import_from_file(project, 'path/to/MyUDT.L5X')
+    modules.import_module(project, 'path/to/module_template.L5X',
+                          name='VFD01', address='192.168.1.100')
+
+    # Validation
+    from l5x_agent_toolkit import validator
+    result = validator.validate_project(project)
+    if not result.is_valid:
+        print(result)
+
+    # Write the modified project
+    project.write('path/to/output.L5X')
+"""
+
+__version__ = "1.2.1"
+
+
+def __getattr__(name):
+    """Lazy import to avoid circular/missing module errors during development."""
+    if name == "L5XProject":
+        from .project import L5XProject
+
+        return L5XProject
+    if name in ("L5XPlugin", "PluginContext"):
+        from .plugin import L5XPlugin, PluginContext
+
+        return L5XPlugin if name == "L5XPlugin" else PluginContext
+    if name in ("core", "model", "query", "ops", "validate"):
+        import importlib
+
+        return importlib.import_module(f"{__name__}.{name}")
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+from l5x_agent_toolkit.refactor import aoi_ops, udt_ops  # noqa: E402
+from l5x_agent_toolkit.refactor.types import (  # noqa: E402
+    BindingRequirement,
+    RefactorAction,
+    RefactorPlan,
+)
+
+__all__ = [
+    "L5XProject",
+    "L5XPlugin",
+    "PluginContext",
+    "aoi_ops",
+    "udt_ops",
+    "RefactorAction",
+    "RefactorPlan",
+    "BindingRequirement",
+    "core",
+    "model",
+    "query",
+    "ops",
+    "validate",
+]