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

{slmp_connect_python-1.0.0/slmp_connect_python.egg-info → slmp_connect_python-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slmp-connect-python
-Version: 1.0.0
+Version: 1.1.0
 Summary: SLMP Connect Python: client library for MELSEC SLMP binary communication
 Author: fa-yoshinobu
 License-Expression: MIT
@@ -93,3 +93,9 @@ See that page for verified PLC models, transports, dates, limitations, and retai
 | License | [MIT](LICENSE) |
 | Registry | [PyPI](https://pypi.org/project/slmp-connect-python/) |
 | Package | `slmp-connect-python` |
+
+## Commercial support
+
+If you plan to embed this library in a paid or commercial product, please consider a separate support agreement or supporting the project as a sponsor.
+
+Contact: <https://fa-labo.com/contact.html>

{slmp_connect_python-1.0.0 → slmp_connect_python-1.1.0}/README.md

@@ -59,3 +59,9 @@ See that page for verified PLC models, transports, dates, limitations, and retai
 | License | [MIT](LICENSE) |
 | Registry | [PyPI](https://pypi.org/project/slmp-connect-python/) |
 | Package | `slmp-connect-python` |
+
+## Commercial support
+
+If you plan to embed this library in a paid or commercial product, please consider a separate support agreement or supporting the project as a sponsor.
+
+Contact: <https://fa-labo.com/contact.html>

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "slmp-connect-python"
-version = "1.0.0"
+version = "1.1.0"
 description = "SLMP Connect Python: client library for MELSEC SLMP binary communication"
 readme = "README.md"
 requires-python = ">=3.10"

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

@@ -10,7 +10,7 @@ The primary user-facing entry points are:
 - ``poll``
 """
 
-__version__ = "0.8.0"
+__version__ = "1.0.1"
 
 from .async_client import AsyncSlmpClient
 from .client import SlmpClient

{slmp_connect_python-1.0.0 → slmp_connect_python-1.1.0}/slmp/_operations.py

@@ -85,7 +85,7 @@ def _effective_series(series: PLCSeries | str | None, default_series: PLCSeries)
     return PLCSeries(series) if series is not None else default_series
 
 
-def _parse_device_for_family(device: str | DeviceRef, address_profile: object | None) -> DeviceRef:
+def _parse_device_for_address_profile(device: str | DeviceRef, address_profile: object | None) -> DeviceRef:
     ref = parse_device(device, plc_profile=address_profile)
     return _require_explicit_plc_profile_for_xy(device, address_profile, ref)
 
@@ -110,7 +110,7 @@ def build_read_devices_request(
 ) -> OperationRequest:
     _check_direct_device_points(points, bit_unit=bit_unit, name="read_devices")
     effective_series = _effective_series(series, default_series)
-    ref = _parse_device_for_family(device, address_profile)
+    ref = _parse_device_for_address_profile(device, address_profile)
     _validate_direct_read_device(ref, points=points, bit_unit=bit_unit)
     _check_temporarily_unsupported_device(ref)
     _warn_practical_device_path(ref, series=effective_series, access_kind="direct")
@@ -154,7 +154,7 @@ def build_write_devices_request(
         raise ValueError("values must not be empty")
     _check_direct_device_points(len(values), bit_unit=bit_unit, name="write_devices")
     effective_series = _effective_series(series, default_series)
-    ref = _parse_device_for_family(device, address_profile)
+    ref = _parse_device_for_address_profile(device, address_profile)
     _validate_direct_write_device(ref, bit_unit=bit_unit)
     _check_temporarily_unsupported_device(ref)
     _warn_practical_device_path(ref, series=effective_series, access_kind="direct")
@@ -188,7 +188,7 @@ def build_read_dwords_request(
 ) -> OperationRequest:
     if count < 1:
         raise ValueError("count must be >= 1")
-    ref = _parse_device_for_family(device, address_profile)
+    ref = _parse_device_for_address_profile(device, address_profile)
     _validate_direct_dword_read_device(ref)
     return build_read_devices_request(
         ref,
@@ -342,12 +342,12 @@ def build_register_monitor_devices_request(
     word_refs: list[DeviceRef] = []
     dword_refs: list[DeviceRef] = []
     for dev in word_devices:
-        ref = _parse_device_for_family(dev, address_profile)
+        ref = _parse_device_for_address_profile(dev, address_profile)
         _check_temporarily_unsupported_device(ref)
         payload += encode_device_spec(ref, series=effective_series)
         word_refs.append(ref)
     for dev in dword_devices:
-        ref = _parse_device_for_family(dev, address_profile)
+        ref = _parse_device_for_address_profile(dev, address_profile)
         _check_temporarily_unsupported_device(ref)
         payload += encode_device_spec(ref, series=effective_series)
         dword_refs.append(ref)
@@ -499,8 +499,8 @@ def build_read_random_request(
     )
     subcommand = resolve_device_subcommand(bit_unit=False, series=effective_series, extension=False)
 
-    words = [_parse_device_for_family(device, address_profile) for device in word_devices]
-    dwords = [_parse_device_for_family(device, address_profile) for device in dword_devices]
+    words = [_parse_device_for_address_profile(device, address_profile) for device in word_devices]
+    dwords = [_parse_device_for_address_profile(device, address_profile) for device in dword_devices]
     _validate_random_read_devices(words, dwords)
     _check_temporarily_unsupported_devices(words)
     _check_temporarily_unsupported_devices(dwords)
@@ -718,7 +718,7 @@ def build_read_block_request(
     normalized_bit: list[tuple[DeviceRef, int]] = []
     for device, points in word_blocks:
         _check_points_u16(points, "word_block points")
-        ref = _parse_device_for_family(device, address_profile)
+        ref = _parse_device_for_address_profile(device, address_profile)
         _check_temporarily_unsupported_device(ref)
         _warn_practical_device_path(ref, series=effective_series, access_kind="direct")
         normalized_word.append((ref, points))
@@ -726,7 +726,7 @@ def build_read_block_request(
         payload += points.to_bytes(2, "little")
     for device, points in bit_blocks:
         _check_points_u16(points, "bit_block points")
-        ref = _parse_device_for_family(device, address_profile)
+        ref = _parse_device_for_address_profile(device, address_profile)
         _check_temporarily_unsupported_device(ref)
         _warn_practical_device_path(ref, series=effective_series, access_kind="direct")
         normalized_bit.append((ref, points))
@@ -784,13 +784,13 @@ def build_write_block_request(
     word_refs: list[DeviceRef] = []
     bit_refs: list[DeviceRef] = []
     for device, values in word_blocks:
-        ref = _parse_device_for_family(device, address_profile)
+        ref = _parse_device_for_address_profile(device, address_profile)
         _check_temporarily_unsupported_device(ref)
         _warn_practical_device_path(ref, series=effective_series, access_kind="direct")
         _check_points_u16(len(values), "word block size")
         word_refs.append(ref)
     for device, values in bit_blocks:
-        ref = _parse_device_for_family(device, address_profile)
+        ref = _parse_device_for_address_profile(device, address_profile)
         _check_temporarily_unsupported_device(ref)
         _warn_practical_device_path(ref, series=effective_series, access_kind="direct")
         _check_points_u16(len(values), "bit block size")

{slmp_connect_python-1.0.0 → slmp_connect_python-1.1.0}/slmp/async_client.py

@@ -91,7 +91,7 @@ class AsyncSlmpClient:
 
         The standard async client route requires ``plc_profile`` and fixes the
         frame type, access profile, and address/range handling from that one
-        explicit family.
+        explicit PLC profile.
         """
         self.host = host
         self.transport_type = transport.lower()

{slmp_connect_python-1.0.0 → slmp_connect_python-1.1.0}/slmp/device_ranges.py

@@ -518,7 +518,7 @@ def normalize_plc_profile(value: SlmpPlcProfile | str) -> SlmpPlcProfile:
 
     if isinstance(value, SlmpPlcProfile):
         return value
-    normalized = str(value).strip().lower()
+    normalized = str(value).strip()
     if normalized in _CANONICAL_FAMILIES:
         return _CANONICAL_FAMILIES[normalized]
     supported = ", ".join(sorted(_CANONICAL_FAMILIES))

slmp_connect_python-1.1.0/slmp/error_codes.py

@@ -0,0 +1,45 @@
+"""SLMP end-code keys and categories."""
+
+from __future__ import annotations
+
+from typing import Literal
+
+SlmpEndCodeLanguage = Literal["en", "ja"]
+
+_REMOTE_PASSWORD_END_CODES = {
+    0xC200,
+    0xC201,
+    0xC202,
+    0xC203,
+    0xC204,
+    0xC205,
+    0xC810,
+    0xC811,
+    0xC812,
+    0xC813,
+    0xC814,
+    0xC815,
+    0xC816,
+}
+
+
+def get_end_code_name(end_code: int) -> str:
+    """Return the stable code-derived key for an SLMP end code."""
+    return f"slmp_end_code_{int(end_code) & 0xFFFF:04x}"
+
+
+def get_end_code_message(end_code: int, language: SlmpEndCodeLanguage = "en") -> str | None:
+    """Return a user-facing message for an SLMP end code.
+
+    Localized message text is not embedded in this package. Resolve
+    get_end_code_name(end_code) in an application-owned catalog when text is
+    required.
+    """
+    _ = end_code
+    _ = language
+    return None
+
+
+def is_remote_password_end_code(end_code: int) -> bool:
+    """Return True if the SLMP end code is related to remote password protection."""
+    return (int(end_code) & 0xFFFF) in _REMOTE_PASSWORD_END_CODES