simaticml-decoder 0.1.0__py3-none-any.whl

simaticml_decoder-0.1.0.dist-info/METADATA

@@ -0,0 +1,118 @@
+Metadata-Version: 2.4
+Name: simaticml-decoder
+Version: 0.1.0
+Summary: Translate exported SimaticML LAD/FBD blocks (TIA V21) into readable SCL plus a JSON metadata sidecar.
+Project-URL: Homepage, https://github.com/Czarnak/simaticml-decoder
+Project-URL: Issues, https://github.com/Czarnak/simaticml-decoder/issues
+Project-URL: Repository, https://github.com/Czarnak/simaticml-decoder
+Author: Czarnak
+Keywords: plc,scl,simatic,simaticml,tia-portal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Manufacturing
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# simaticml-decoder
+
+Translate exported **SimaticML LAD/FBD** blocks (Siemens TIA Portal **V21**) into
+readability-first **SCL** plus a **JSON metadata sidecar**.
+
+## Why
+
+A SimaticML export stores ladder logic as a `FlgNet` — a flat netlist of parts
+and wires, not line-shaped rungs. Reading that graph by hand (or by eye, from the
+editor) is token-heavy and error-prone: it is easy to connect the wrong variable
+in a large block, and a single contact's negation is one diagonal slash. This tool
+decodes the netlist deterministically, so what you analyse is folded logic with
+explicit negation and an exact write/read cross-reference — not a graph you have to
+trace yourself.
+
+## How it works
+
+Three cleanly separated, independently testable phases:
+
+| Phase | Module | Input → Output |
+|-------|--------|----------------|
+| 1. Parse | `parse.py` → `model.py` | XML → faithful syntactic mirror |
+| 2. Fold  | `fold.py` → `ir.py`     | model → boolean tree + assignments |
+| 3. Emit  | `emit.py`               | IR → SCL text + JSON sidecar |
+
+Supporting modules: `instructions.py` (the part catalog — data, not logic),
+`operand.py` (Access → display string), `scl_reconstruct.py` (SCL networks, which
+are reconstructed from their tokenised AST rather than folded).
+
+Two commitments run through the design: every IR node keeps the source `UId` it
+came from (so any rendered claim is traceable to a net), and anything the folder
+cannot interpret is surfaced **loudly** rather than dropped — a silent omission in
+authoritative-looking SCL is the worst possible failure.
+
+## Scope
+
+Covered: FC/FB blocks; LAD/FBD folding (series→AND, `O`→OR, fan-out, `Negated`→NOT,
+daisy-chained coils, structural latch detection); SCL network reconstruction;
+ground-truth interface types; cross-reference table; the instruction set seen in
+real V21 samples (Contact, Coil/SCoil/RCoil, `O`, Move/Add/Inc, comparisons,
+Rs/Sr, P/N edges, TON family, user FC/FB calls).
+
+Deferred (parsed losslessly, rendering flagged): GRAPH/SFC and STL networks;
+absolute-addressing / array / `Operation`-template rendering. Output is
+readability-first, **not** recompilable. Live TIA Openness integration is out of
+scope — the tool operates on already-exported XML.
+
+## Install
+
+```bash
+pip install simaticml-decoder
+```
+
+For local development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+Runtime dependencies: none (standard-library `xml.etree.ElementTree`). The `dev`
+extra pulls lint, test, coverage, build, and package-validation tools.
+
+## Usage
+
+```bash
+simaticml-decode BLOCK.xml --format both
+# one file at a time; --format {scl,json,both}; -o OUTDIR for output location
+```
+
+## Layout
+
+```
+src/simaticml_decoder/   parse · model · fold · ir · instructions · operand
+                         scl_reconstruct · emit · cli
+tests/                   authored separately; run by CI
+.github/workflows/ci.yml ruff + pytest on push / PR
+```
+
+## Release
+
+Publishing is handled by GitHub Actions and PyPI Trusted Publishing. A package is
+published only when a `vX.Y.Z` tag is pushed and the release workflow passes
+lint, tests, coverage, version checks, package build, and `twine check`.
+
+## Future
+
+Support for new YAML-like S7 PLCs export formats.
+
+---
+*Created with Claude AI*

simaticml_decoder-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+simaticml_decoder/__init__.py,sha256=j38Ncpx_cdZfljzkj_XTpPTHHWpkr30qv3u4MV8jP2U,529
+simaticml_decoder/cli.py,sha256=-2RIQzJ6NgXnnLjuo5RIjXxW3vHoE_t6jHx1c9XJHIE,4130
+simaticml_decoder/emit.py,sha256=giCmYVhGXKAQ2BlQ39LIMA-P3hmNXPyf8oMBdhQGx0I,13867
+simaticml_decoder/fold.py,sha256=adUyxLvx3BtzGYBI0eiZal1U-dCOf1zpR6F3_GUBM8k,26342
+simaticml_decoder/instructions.py,sha256=WaKC1tzA5yyoBwsG2eXNVcpcJsklDc49QGWIWkw5PLk,4850
+simaticml_decoder/ir.py,sha256=-n5ULWc2IzPco5_nTAot5Lm_ndyQyrh95TJcG7R7XDY,5856
+simaticml_decoder/model.py,sha256=yBH-oWgudS3ebZDaZKiuja2GQJOLDqWBU0UaQO8SMvE,9246
+simaticml_decoder/operand.py,sha256=-ERD8PHFNhEdqZiRuzQYq01CgtbQsxsz0swuu7EG5Is,5316
+simaticml_decoder/parse.py,sha256=nRwMCleJX5YhstGpfm5xmndP1d0JVfVoWr43L8yThOE,20555
+simaticml_decoder/scl_reconstruct.py,sha256=IY5zHlQ2odUU0d7WsgXjEzGzoe5EK3TJHd-c7UqJ6g0,2656
+simaticml_decoder-0.1.0.dist-info/METADATA,sha256=qFUi5AQKEbVn-dwIxquBkSewOCR9WEiXUaMnLiyi1DU,4429
+simaticml_decoder-0.1.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+simaticml_decoder-0.1.0.dist-info/entry_points.txt,sha256=7maZCkNU6nBe4wMePfwu82j4TBVOsQ4mvaPZV6ayL7M,64
+simaticml_decoder-0.1.0.dist-info/RECORD,,

simaticml_decoder-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

simaticml_decoder-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+simaticml-decode = simaticml_decoder.cli:main