slmp-connect-python 0.1.4__tar.gz

slmp_connect_python-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 fa-yoshinobu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

slmp_connect_python-0.1.4/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: slmp-connect-python
+Version: 0.1.4
+Summary: SLMP Connect Python: client library for Mitsubishi SLMP binary communication
+Author: fa-yoshinobu
+Project-URL: Homepage, https://github.com/fa-yoshinobu/plc-comm-slmp-python
+Project-URL: Repository, https://github.com/fa-yoshinobu/plc-comm-slmp-python
+Project-URL: Issues, https://github.com/fa-yoshinobu/plc-comm-slmp-python/issues
+Keywords: slmp,melsec,mitsubishi,plc,3e,4e,binary
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: pre-commit>=3.7; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: twine>=5.1; extra == "dev"
+Dynamic: license-file
+
+[![CI](https://github.com/fa-yoshinobu/plc-comm-slmp-python/actions/workflows/ci.yml/badge.svg)](https://github.com/fa-yoshinobu/plc-comm-slmp-python/actions/workflows/ci.yml)
+[![Documentation](https://img.shields.io/badge/docs-GitHub_Pages-blue.svg)](https://fa-yoshinobu.github.io/plc-comm-slmp-python/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Static Analysis: Ruff](https://img.shields.io/badge/Lint-Ruff-black.svg)](https://github.com/astral-sh/ruff)
+
+# SLMP Protocol for Python
+
+![Illustration](docsrc/assets/melsec.png)
+
+High-level SLMP helpers for Mitsubishi PLC communication over Binary 3E and 4E frames.
+
+This repository now treats the high-level helper layer as the recommended user surface:
+
+- `AsyncSlmpClient`
+- `QueuedAsyncSlmpClient`
+- `SlmpClient`
+- `read_typed` / `write_typed`
+- `read_words` / `read_dwords`
+- `write_bit_in_word`
+- `read_named` / `write_named`
+- `poll`
+
+Low-level protocol methods still exist for maintainers and validation work, but they are not the primary user path.
+
+## Installation
+
+```bash
+pip install slmp-connect-python
+```
+
+## Quick Start
+
+Recommended async path:
+
+```python
+import asyncio
+
+from slmp import AsyncSlmpClient, read_named, write_typed
+
+
+async def main() -> None:
+    async with AsyncSlmpClient(
+        "192.168.250.100",
+        port=1025,
+        plc_series="iqr",
+        frame_type="4e",
+    ) as client:
+        before = await read_named(client, ["D100", "D200:F", "D50.3"])
+        print("before:", before)
+
+        await write_typed(client, "D100", "U", 42)
+
+        after = await read_named(client, ["D100", "D200:F", "D50.3"])
+        print("after:", after)
+
+
+asyncio.run(main())
+```
+
+Choose the connection profile explicitly:
+
+- `plc_series="iqr", frame_type="4e"` for iQ-R / iQ-F targets
+- `plc_series="ql", frame_type="3e"` for Q / L targets
+
+Recommended sync path:
+
+```python
+from slmp import SlmpClient, read_named_sync, write_typed_sync
+
+with SlmpClient(
+    "192.168.250.100",
+    port=1025,
+    plc_series="iqr",
+    frame_type="4e",
+) as client:
+    print(read_named_sync(client, ["D100", "D200:F", "D50.3"]))
+    write_typed_sync(client, "D100", "U", 42)
+```
+
+## High-Level API Guide
+
+### Single typed values
+
+```python
+from slmp import read_typed, write_typed
+
+temperature = await read_typed(client, "D200", "F")
+counter = await read_typed(client, "D300", "L")
+await write_typed(client, "D100", "U", 1234)
+```
+
+### Mixed reads with one call
+
+```python
+from slmp import read_named
+
+snapshot = await read_named(
+    client,
+    [
+        "D100",
+        "D200:F",
+        "D300:L",
+        "D50.3",
+    ],
+)
+```
+
+Use `.bit` notation only with word devices such as `D50.3`.
+Address bit devices directly as `M1000`, `M1001`, ... rather than `M1000.0`.
+
+For long-device families in the high-level helpers:
+
+- `LTN`, `LSTN`, and `LCN` default to 32-bit current-value reads and writes
+- `LTS`, `LTC`, `LSTS`, and `LSTC` are resolved through the corresponding `LTN` / `LSTN` helper-backed 4-word decode instead of direct state reads
+
+### Mixed writes with one call
+
+```python
+from slmp import write_named
+
+await write_named(
+    client,
+    {
+        "D100": 42,
+        "D200:F": 3.14,
+        "D300:L": -200,
+        "D50.3": True,
+    },
+)
+```
+
+The same default applies on writes: plain `LTN`, `LSTN`, and `LCN` addresses are treated as 32-bit current values in the high-level helper layer.
+
+### Chunked word and dword reads
+
+```python
+from slmp import read_words, read_dwords
+
+words = await read_words(client, "D0", 1000, allow_split=True)
+dwords = await read_dwords(client, "D200", 120, allow_split=True)
+```
+
+### Polling
+
+```python
+from slmp import poll
+
+async for snapshot in poll(client, ["D100", "D200:F", "D50.3"], interval=1.0):
+    print(snapshot)
+```
+
+### Shared connection for multiple coroutines
+
+```python
+from slmp import AsyncSlmpClient, QueuedAsyncSlmpClient
+
+inner = AsyncSlmpClient("192.168.250.100", port=1025, plc_series="iqr", frame_type="4e")
+async with QueuedAsyncSlmpClient(inner) as client:
+    first = await read_named(client, ["D100", "D200:F"])
+    second = await read_named(client, ["D300", "D50.3"])
+```
+
+## Sample Programs
+
+The buildable sample files with the richest high-level examples are:
+
+- [`samples/high_level_sync.py`](samples/high_level_sync.py)
+  - typed reads and writes
+  - chunked word and dword reads
+  - bit-in-word writes
+  - mixed `read_named_sync` / `write_named_sync`
+  - polling
+- [`samples/high_level_async.py`](samples/high_level_async.py)
+  - explicit `AsyncSlmpClient`
+  - typed reads and writes
+  - chunked reads
+  - `read_named` / `write_named`
+  - polling
+  - shared queued connection example
+
+Run them from the repository root:
+
+```bash
+python samples/high_level_sync.py --host 192.168.250.100 --port 1025 --series iqr
+python samples/high_level_async.py --host 192.168.250.100 --port 1025 --series iqr --frame-type 4e
+```
+
+More sample commands are listed in [docsrc/user/SAMPLES.md](docsrc/user/SAMPLES.md).
+
+## Documentation
+
+User-facing documents:
+
+- [User Guide](docsrc/user/USER_GUIDE.md)
+- [Samples](docsrc/user/SAMPLES.md)
+- [Error Codes](docsrc/user/ERROR_CODES.md)
+
+Maintainer and validation material remains in `docsrc/maintainer/` and `docsrc/validation/`.
+
+## Development
+
+```bash
+run_ci.bat
+build_docs.bat
+release_check.bat
+```
+
+`run_ci.bat` validates the package and also builds the single-file CLI tool in `publish/`.
+
+## License
+
+Distributed under the [MIT License](LICENSE).

slmp_connect_python-0.1.4/README.md

@@ -0,0 +1,213 @@
+[![CI](https://github.com/fa-yoshinobu/plc-comm-slmp-python/actions/workflows/ci.yml/badge.svg)](https://github.com/fa-yoshinobu/plc-comm-slmp-python/actions/workflows/ci.yml)
+[![Documentation](https://img.shields.io/badge/docs-GitHub_Pages-blue.svg)](https://fa-yoshinobu.github.io/plc-comm-slmp-python/)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Static Analysis: Ruff](https://img.shields.io/badge/Lint-Ruff-black.svg)](https://github.com/astral-sh/ruff)
+
+# SLMP Protocol for Python
+
+![Illustration](docsrc/assets/melsec.png)
+
+High-level SLMP helpers for Mitsubishi PLC communication over Binary 3E and 4E frames.
+
+This repository now treats the high-level helper layer as the recommended user surface:
+
+- `AsyncSlmpClient`
+- `QueuedAsyncSlmpClient`
+- `SlmpClient`
+- `read_typed` / `write_typed`
+- `read_words` / `read_dwords`
+- `write_bit_in_word`
+- `read_named` / `write_named`
+- `poll`
+
+Low-level protocol methods still exist for maintainers and validation work, but they are not the primary user path.
+
+## Installation
+
+```bash
+pip install slmp-connect-python
+```
+
+## Quick Start
+
+Recommended async path:
+
+```python
+import asyncio
+
+from slmp import AsyncSlmpClient, read_named, write_typed
+
+
+async def main() -> None:
+    async with AsyncSlmpClient(
+        "192.168.250.100",
+        port=1025,
+        plc_series="iqr",
+        frame_type="4e",
+    ) as client:
+        before = await read_named(client, ["D100", "D200:F", "D50.3"])
+        print("before:", before)
+
+        await write_typed(client, "D100", "U", 42)
+
+        after = await read_named(client, ["D100", "D200:F", "D50.3"])
+        print("after:", after)
+
+
+asyncio.run(main())
+```
+
+Choose the connection profile explicitly:
+
+- `plc_series="iqr", frame_type="4e"` for iQ-R / iQ-F targets
+- `plc_series="ql", frame_type="3e"` for Q / L targets
+
+Recommended sync path:
+
+```python
+from slmp import SlmpClient, read_named_sync, write_typed_sync
+
+with SlmpClient(
+    "192.168.250.100",
+    port=1025,
+    plc_series="iqr",
+    frame_type="4e",
+) as client:
+    print(read_named_sync(client, ["D100", "D200:F", "D50.3"]))
+    write_typed_sync(client, "D100", "U", 42)
+```
+
+## High-Level API Guide
+
+### Single typed values
+
+```python
+from slmp import read_typed, write_typed
+
+temperature = await read_typed(client, "D200", "F")
+counter = await read_typed(client, "D300", "L")
+await write_typed(client, "D100", "U", 1234)
+```
+
+### Mixed reads with one call
+
+```python
+from slmp import read_named
+
+snapshot = await read_named(
+    client,
+    [
+        "D100",
+        "D200:F",
+        "D300:L",
+        "D50.3",
+    ],
+)
+```
+
+Use `.bit` notation only with word devices such as `D50.3`.
+Address bit devices directly as `M1000`, `M1001`, ... rather than `M1000.0`.
+
+For long-device families in the high-level helpers:
+
+- `LTN`, `LSTN`, and `LCN` default to 32-bit current-value reads and writes
+- `LTS`, `LTC`, `LSTS`, and `LSTC` are resolved through the corresponding `LTN` / `LSTN` helper-backed 4-word decode instead of direct state reads
+
+### Mixed writes with one call
+
+```python
+from slmp import write_named
+
+await write_named(
+    client,
+    {
+        "D100": 42,
+        "D200:F": 3.14,
+        "D300:L": -200,
+        "D50.3": True,
+    },
+)
+```
+
+The same default applies on writes: plain `LTN`, `LSTN`, and `LCN` addresses are treated as 32-bit current values in the high-level helper layer.
+
+### Chunked word and dword reads
+
+```python
+from slmp import read_words, read_dwords
+
+words = await read_words(client, "D0", 1000, allow_split=True)
+dwords = await read_dwords(client, "D200", 120, allow_split=True)
+```
+
+### Polling
+
+```python
+from slmp import poll
+
+async for snapshot in poll(client, ["D100", "D200:F", "D50.3"], interval=1.0):
+    print(snapshot)
+```
+
+### Shared connection for multiple coroutines
+
+```python
+from slmp import AsyncSlmpClient, QueuedAsyncSlmpClient
+
+inner = AsyncSlmpClient("192.168.250.100", port=1025, plc_series="iqr", frame_type="4e")
+async with QueuedAsyncSlmpClient(inner) as client:
+    first = await read_named(client, ["D100", "D200:F"])
+    second = await read_named(client, ["D300", "D50.3"])
+```
+
+## Sample Programs
+
+The buildable sample files with the richest high-level examples are:
+
+- [`samples/high_level_sync.py`](samples/high_level_sync.py)
+  - typed reads and writes
+  - chunked word and dword reads
+  - bit-in-word writes
+  - mixed `read_named_sync` / `write_named_sync`
+  - polling
+- [`samples/high_level_async.py`](samples/high_level_async.py)
+  - explicit `AsyncSlmpClient`
+  - typed reads and writes
+  - chunked reads
+  - `read_named` / `write_named`
+  - polling
+  - shared queued connection example
+
+Run them from the repository root:
+
+```bash
+python samples/high_level_sync.py --host 192.168.250.100 --port 1025 --series iqr
+python samples/high_level_async.py --host 192.168.250.100 --port 1025 --series iqr --frame-type 4e
+```
+
+More sample commands are listed in [docsrc/user/SAMPLES.md](docsrc/user/SAMPLES.md).
+
+## Documentation
+
+User-facing documents:
+
+- [User Guide](docsrc/user/USER_GUIDE.md)
+- [Samples](docsrc/user/SAMPLES.md)
+- [Error Codes](docsrc/user/ERROR_CODES.md)
+
+Maintainer and validation material remains in `docsrc/maintainer/` and `docsrc/validation/`.
+
+## Development
+
+```bash
+run_ci.bat
+build_docs.bat
+release_check.bat
+```
+
+`run_ci.bat` validates the package and also builds the single-file CLI tool in `publish/`.
+
+## License
+
+Distributed under the [MIT License](LICENSE).

slmp_connect_python-0.1.4/pyproject.toml

@@ -0,0 +1,118 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "slmp-connect-python"
+version = "0.1.4"
+description = "SLMP Connect Python: client library for Mitsubishi SLMP binary communication"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = []
+authors = [{ name = "fa-yoshinobu" }]
+
+license-files = ["LICENSE"]
+keywords = ["slmp", "melsec", "mitsubishi", "plc", "3e", "4e", "binary"]
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Networking",
+]
+
+[project.urls]
+Homepage = "https://github.com/fa-yoshinobu/plc-comm-slmp-python"
+Repository = "https://github.com/fa-yoshinobu/plc-comm-slmp-python"
+Issues = "https://github.com/fa-yoshinobu/plc-comm-slmp-python/issues"
+
+[project.optional-dependencies]
+dev = [
+    "build>=1.2",
+    "mypy>=1.10",
+    "pre-commit>=3.7",
+    "pytest>=8.0",
+    "pytest-asyncio>=0.23",
+    "pytest-cov>=5.0",
+    "ruff>=0.6",
+    "twine>=5.1",
+]
+
+[project.scripts]
+slmp-connection-check = "slmp.cli:connection_check_main"
+slmp-compatibility-probe = "slmp.cli:compatibility_probe_main"
+slmp-compatibility-matrix-render = "slmp.cli:compatibility_matrix_render_main"
+slmp-device-range-probe = "slmp.cli:device_range_probe_main"
+slmp-register-boundary-probe = "slmp.cli:register_boundary_probe_main"
+slmp-other-station-check = "slmp.cli:other_station_check_main"
+slmp-open-items-recheck = "slmp.cli:open_items_recheck_main"
+slmp-g-hg-extended-device-recheck = "slmp.cli:g_hg_extended_device_recheck_main"
+slmp-g-hg-extended-device-coverage = "slmp.cli:g_hg_extended_device_coverage_main"
+slmp-extended-device-recheck = "slmp.cli:extended_device_recheck_main"
+slmp-pending-live-verification = "slmp.cli:pending_live_verification_main"
+slmp-init-model-docs = "slmp.cli:init_model_docs_main"
+slmp-device-access-matrix-sync = "slmp.cli:device_access_matrix_sync_main"
+slmp-manual-write-verification = "slmp.cli:manual_write_verification_main"
+slmp-manual-label-verification = "slmp.cli:manual_label_verification_main"
+slmp-read-soak = "slmp.cli:read_soak_main"
+slmp-mixed-read-load = "slmp.cli:mixed_read_load_main"
+slmp-tcp-concurrency = "slmp.cli:tcp_concurrency_main"
+slmp-regression-suite = "slmp.cli:regression_suite_main"
+
+[tool.setuptools.packages.find]
+include = ["slmp*"]
+exclude = ["tests*", "scripts*", "docsrc/maintainer*", "docsrc/validation*"]
+
+[tool.setuptools]
+include-package-data = true
+exclude-package-data = { "*" = ["TODO.md", ".pre-commit-config.yaml"] }
+
+[tool.setuptools.package-data]
+slmp = ["py.typed"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["slmp"]
+
+[tool.mypy]
+files = ["slmp"]
+warn_unused_configs = true
+disallow_untyped_defs = true
+check_untyped_defs = true
+disallow_incomplete_defs = true
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_return_any = true
+strict_equality = true
+
+[tool.coverage.run]
+source = ["slmp"]
+branch = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.coverage.report]
+show_missing = true
+
+
+
+
+
+
+
+

slmp_connect_python-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+