slmp-connect-python 0.1.16__tar.gz → 1.0.0__tar.gz

slmp_connect_python-1.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+prune tests
+prune internal_docs

slmp_connect_python-1.0.0/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: slmp-connect-python
+Version: 1.0.0
+Summary: SLMP Connect Python: client library for MELSEC SLMP binary communication
+Author: fa-yoshinobu
+License-Expression: MIT
+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,plc,3e,4e,binary
+Classifier: Development Status :: 5 - Production/Stable
+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)
+[![PyPI](https://img.shields.io/pypi/v/slmp-connect-python.svg)](https://pypi.org/project/slmp-connect-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)
+
+# MELSEC SLMP for Python
+
+Python library for MELSEC SLMP (Binary 3E/4E) PLC communication.
+
+## Supported PLC profiles
+
+The maintained profile table is in [PLC profiles](docsrc/user/PROFILES.md). Choose one exact canonical PLC profile from that table.
+
+## Supported device types
+
+The maintained device and range tables are in [Supported registers](docsrc/user/SUPPORTED_REGISTERS.md). Use that page for supported device families, address syntax, and profile-specific notes.
+
+## Installation
+
+```bash
+pip install slmp-connect-python
+```
+
+## Quick example
+
+```python
+import asyncio
+from slmp import SlmpConnectionOptions, open_and_connect, read_typed
+
+async def main() -> None:
+    options = SlmpConnectionOptions(host="192.168.250.100", port=1025, plc_profile="melsec:iq-r")
+    async with await open_and_connect(options) as client:
+        value = await read_typed(client, "D100", "U")
+        print(f"D100={value}")
+
+asyncio.run(main())
+```
+
+## Documentation
+
+| Page | Use it for |
+| --- | --- |
+| [Full documentation site](https://fa-yoshinobu.github.io/plc-comm-docs-site/) | Unified docs for all PLC communication libraries. |
+| [Getting started](docsrc/user/GETTING_STARTED.md) | Install the package, connect to your PLC, and run your first SLMP read/write. |
+| [Usage guide](docsrc/user/USAGE_GUIDE.md) | Use the high-level API and common SLMP workflows. |
+| [Supported registers](docsrc/user/SUPPORTED_REGISTERS.md) | Check supported device families, address syntax, and numbering rules. |
+| [PLC profiles](docsrc/user/PROFILES.md) | Choose the canonical MELSEC profile and frame behavior. |
+| [Examples](samples/README.md) | Run maintained Python samples. |
+
+## Hardware verified
+
+Live-device verification is maintained in [Latest communication verification](docsrc/user/LATEST_COMMUNICATION_VERIFICATION.md).
+See that page for verified PLC models, transports, dates, limitations, and retained validation notes.
+
+## License and registry
+
+| Item | Value |
+| --- | --- |
+| License | [MIT](LICENSE) |
+| Registry | [PyPI](https://pypi.org/project/slmp-connect-python/) |
+| Package | `slmp-connect-python` |

slmp_connect_python-1.0.0/README.md

@@ -0,0 +1,61 @@
+[![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)
+[![PyPI](https://img.shields.io/pypi/v/slmp-connect-python.svg)](https://pypi.org/project/slmp-connect-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)
+
+# MELSEC SLMP for Python
+
+Python library for MELSEC SLMP (Binary 3E/4E) PLC communication.
+
+## Supported PLC profiles
+
+The maintained profile table is in [PLC profiles](docsrc/user/PROFILES.md). Choose one exact canonical PLC profile from that table.
+
+## Supported device types
+
+The maintained device and range tables are in [Supported registers](docsrc/user/SUPPORTED_REGISTERS.md). Use that page for supported device families, address syntax, and profile-specific notes.
+
+## Installation
+
+```bash
+pip install slmp-connect-python
+```
+
+## Quick example
+
+```python
+import asyncio
+from slmp import SlmpConnectionOptions, open_and_connect, read_typed
+
+async def main() -> None:
+    options = SlmpConnectionOptions(host="192.168.250.100", port=1025, plc_profile="melsec:iq-r")
+    async with await open_and_connect(options) as client:
+        value = await read_typed(client, "D100", "U")
+        print(f"D100={value}")
+
+asyncio.run(main())
+```
+
+## Documentation
+
+| Page | Use it for |
+| --- | --- |
+| [Full documentation site](https://fa-yoshinobu.github.io/plc-comm-docs-site/) | Unified docs for all PLC communication libraries. |
+| [Getting started](docsrc/user/GETTING_STARTED.md) | Install the package, connect to your PLC, and run your first SLMP read/write. |
+| [Usage guide](docsrc/user/USAGE_GUIDE.md) | Use the high-level API and common SLMP workflows. |
+| [Supported registers](docsrc/user/SUPPORTED_REGISTERS.md) | Check supported device families, address syntax, and numbering rules. |
+| [PLC profiles](docsrc/user/PROFILES.md) | Choose the canonical MELSEC profile and frame behavior. |
+| [Examples](samples/README.md) | Run maintained Python samples. |
+
+## Hardware verified
+
+Live-device verification is maintained in [Latest communication verification](docsrc/user/LATEST_COMMUNICATION_VERIFICATION.md).
+See that page for verified PLC models, transports, dates, limitations, and retained validation notes.
+
+## License and registry
+
+| Item | Value |
+| --- | --- |
+| License | [MIT](LICENSE) |
+| Registry | [PyPI](https://pypi.org/project/slmp-connect-python/) |
+| Package | `slmp-connect-python` |

{slmp_connect_python-0.1.16 → slmp_connect_python-1.0.0}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "slmp-connect-python"
-version = "0.1.16"
-description = "SLMP Connect Python: client library for Mitsubishi SLMP binary communication"
+version = "1.0.0"
+description = "SLMP Connect Python: client library for MELSEC SLMP binary communication"
 readme = "README.md"
 requires-python = ">=3.10"
 dependencies = []
@@ -13,9 +13,9 @@ authors = [{ name = "fa-yoshinobu" }]
 license = "MIT"
 
 license-files = ["LICENSE"]
-keywords = ["slmp", "melsec", "mitsubishi", "plc", "3e", "4e", "binary"]
+keywords = ["slmp", "melsec", "plc", "3e", "4e", "binary"]
 classifiers = [
-    "Development Status :: 3 - Alpha",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
@@ -55,8 +55,6 @@ slmp-g-hg-extended-device-coverage = "slmp.cli:g_hg_extended_device_coverage_mai
 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"
@@ -111,4 +109,3 @@ asyncio_mode = "auto"
 show_missing = true
 
 
-

{slmp_connect_python-0.1.16 → slmp_connect_python-1.0.0}/slmp/__init__.py

@@ -10,7 +10,7 @@ The primary user-facing entry points are:
 - ``poll``
 """
 
-__version__ = "0.1.16"
+__version__ = "0.8.0"
 
 from .async_client import AsyncSlmpClient
 from .client import SlmpClient
@@ -31,6 +31,7 @@ from .core import (
     LongTimerResult,
     MonitorResult,
     RandomReadResult,
+    SlmpPlcProfile,
     SlmpResponse,
     SlmpTarget,
     SlmpTraceFrame,
@@ -43,13 +44,12 @@ from .device_ranges import (
     SlmpDeviceRangeCatalog,
     SlmpDeviceRangeCategory,
     SlmpDeviceRangeEntry,
-    SlmpDeviceRangeFamily,
     SlmpDeviceRangeNotation,
-    build_device_range_catalog_for_family,
-    family_label,
-    normalize_device_range_family,
-    read_device_range_catalog_for_family,
-    read_device_range_catalog_for_family_sync,
+    build_device_range_catalog_for_plc_profile,
+    normalize_plc_profile,
+    plc_profile_label,
+    read_device_range_catalog_for_plc_profile,
+    read_device_range_catalog_for_plc_profile_sync,
 )
 from .error_codes import (
     SlmpEndCodeLanguage,
@@ -139,6 +139,7 @@ __all__ = [
     "SlmpClient",
     "SlmpBoundaryBehaviorWarning",
     "SlmpError",
+    "SlmpPlcProfile",
     "SlmpPracticalPathWarning",
     "SlmpUnsupportedDeviceError",
     "SlmpResponse",
@@ -153,10 +154,9 @@ __all__ = [
     "SlmpDeviceRangeCatalog",
     "SlmpDeviceRangeCategory",
     "SlmpDeviceRangeEntry",
-    "SlmpDeviceRangeFamily",
     "SlmpDeviceRangeNotation",
     "normalize_address",
-    "normalize_device_range_family",
+    "normalize_plc_profile",
     "open_and_connect",
     "open_and_connect_sync",
     "parse_address",
@@ -176,8 +176,8 @@ __all__ = [
     "read_named_sync",
     "read_typed",
     "read_typed_sync",
-    "read_device_range_catalog_for_family",
-    "read_device_range_catalog_for_family_sync",
+    "read_device_range_catalog_for_plc_profile",
+    "read_device_range_catalog_for_plc_profile_sync",
     "read_words",
     "read_words_chunked",
     "read_words_chunked_sync",
@@ -201,6 +201,6 @@ __all__ = [
     "write_words_single_request",
     "write_words_single_request_sync",
     "try_parse_address",
-    "build_device_range_catalog_for_family",
-    "family_label",
+    "build_device_range_catalog_for_plc_profile",
+    "plc_profile_label",
 ]