plc-comm-kv-hostlink 2.0.0__tar.gz

plc_comm_kv_hostlink-2.0.0/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.

plc_comm_kv_hostlink-2.0.0/MANIFEST.in

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

plc_comm_kv_hostlink-2.0.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.4
+Name: plc-comm-kv-hostlink
+Version: 2.0.0
+Summary: Python library for KEYENCE KV series Host Link (Upper Link) communication.
+Author: fa-yoshinobu
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/fa-yoshinobu/plc-comm-hostlink-python
+Project-URL: Repository, https://github.com/fa-yoshinobu/plc-comm-hostlink-python
+Project-URL: Issues, https://github.com/fa-yoshinobu/plc-comm-hostlink-python/issues
+Keywords: plc-comm,keyence,kv,hostlink,upper-link,plc,tcp,udp
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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: 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-hostlink-python/actions/workflows/test.yml/badge.svg)](https://github.com/fa-yoshinobu/plc-comm-hostlink-python/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/plc-comm-kv-hostlink.svg)](https://pypi.org/project/plc-comm-kv-hostlink/)
+[![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)
+
+# KEYENCE KV Host Link for Python
+
+Python library for KEYENCE KV Host Link PLC communication.
+
+## PLC Comm Family
+
+This library is part of the plc-comm family. See the [package matrix](https://fa-yoshinobu.github.io/plc-comm-docs-site/package-matrix/) for protocol, language, registry, and install-command mapping.
+
+## 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 shared device and range tables are in the [KV Host Link Device Ranges](https://fa-yoshinobu.github.io/plc-comm-docs-site/plc-setup/kv/device-ranges/) page. Use that page for supported device families, address syntax, and profile-specific notes.
+
+## Installation
+
+```bash
+pip install plc-comm-kv-hostlink
+```
+
+## Quick example
+
+```python
+import asyncio
+from hostlink import HostLinkConnectionOptions, device_range_catalog_for_plc_profile, open_and_connect, read_typed
+
+async def main() -> None:
+    catalog = device_range_catalog_for_plc_profile("keyence:kv-7000")
+    options = HostLinkConnectionOptions(host="192.168.250.100", plc_profile="keyence:kv-8000", port=8501)
+    async with await open_and_connect(options) as client:
+        dm0 = await read_typed(client, "DM0", "U")
+        print(f"DM0 = {dm0}")
+
+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 read/write. |
+| [Usage guide](docsrc/user/USAGE_GUIDE.md) | Use the high-level API and common Host Link workflows. |
+| [API reference](docsrc/user/API_REFERENCE.md) | Find public client methods, helpers, profile APIs, and error types. |
+| [PLC profiles](docsrc/user/PROFILES.md) | Choose the canonical profile that matches your PLC model and device ranges. |
+| [KV Host Link Device Ranges](https://fa-yoshinobu.github.io/plc-comm-docs-site/plc-setup/kv/device-ranges/) | Check shared device families, address notation, and range tables. |
+| [KV Host Link Troubleshooting & Codes](https://fa-yoshinobu.github.io/plc-comm-docs-site/plc-setup/kv/troubleshooting-codes/) | Troubleshoot common port, profile, address, write-permission, and PLC error-code symptoms. |
+| [Gotchas](docsrc/user/GOTCHAS.md) | Check whether this library has any current library-specific caveats. |
+| [Examples](samples/README.md) | Run maintained Python samples: `samples/high_level_async.py`, `samples/high_level_sync.py`, `samples/basic_high_level_rw.py`, `samples/named_snapshot.py`, `samples/polling_monitor.py`. |
+
+## License and registry
+
+| Item | Value |
+| --- | --- |
+| License | [MIT](LICENSE) |
+| Registry | [PyPI](https://pypi.org/project/plc-comm-kv-hostlink/) |
+| Package | `plc-comm-kv-hostlink` |
+
+## 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>

plc_comm_kv_hostlink-2.0.0/README.md

@@ -0,0 +1,70 @@
+[![CI](https://github.com/fa-yoshinobu/plc-comm-hostlink-python/actions/workflows/test.yml/badge.svg)](https://github.com/fa-yoshinobu/plc-comm-hostlink-python/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/plc-comm-kv-hostlink.svg)](https://pypi.org/project/plc-comm-kv-hostlink/)
+[![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)
+
+# KEYENCE KV Host Link for Python
+
+Python library for KEYENCE KV Host Link PLC communication.
+
+## PLC Comm Family
+
+This library is part of the plc-comm family. See the [package matrix](https://fa-yoshinobu.github.io/plc-comm-docs-site/package-matrix/) for protocol, language, registry, and install-command mapping.
+
+## 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 shared device and range tables are in the [KV Host Link Device Ranges](https://fa-yoshinobu.github.io/plc-comm-docs-site/plc-setup/kv/device-ranges/) page. Use that page for supported device families, address syntax, and profile-specific notes.
+
+## Installation
+
+```bash
+pip install plc-comm-kv-hostlink
+```
+
+## Quick example
+
+```python
+import asyncio
+from hostlink import HostLinkConnectionOptions, device_range_catalog_for_plc_profile, open_and_connect, read_typed
+
+async def main() -> None:
+    catalog = device_range_catalog_for_plc_profile("keyence:kv-7000")
+    options = HostLinkConnectionOptions(host="192.168.250.100", plc_profile="keyence:kv-8000", port=8501)
+    async with await open_and_connect(options) as client:
+        dm0 = await read_typed(client, "DM0", "U")
+        print(f"DM0 = {dm0}")
+
+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 read/write. |
+| [Usage guide](docsrc/user/USAGE_GUIDE.md) | Use the high-level API and common Host Link workflows. |
+| [API reference](docsrc/user/API_REFERENCE.md) | Find public client methods, helpers, profile APIs, and error types. |
+| [PLC profiles](docsrc/user/PROFILES.md) | Choose the canonical profile that matches your PLC model and device ranges. |
+| [KV Host Link Device Ranges](https://fa-yoshinobu.github.io/plc-comm-docs-site/plc-setup/kv/device-ranges/) | Check shared device families, address notation, and range tables. |
+| [KV Host Link Troubleshooting & Codes](https://fa-yoshinobu.github.io/plc-comm-docs-site/plc-setup/kv/troubleshooting-codes/) | Troubleshoot common port, profile, address, write-permission, and PLC error-code symptoms. |
+| [Gotchas](docsrc/user/GOTCHAS.md) | Check whether this library has any current library-specific caveats. |
+| [Examples](samples/README.md) | Run maintained Python samples: `samples/high_level_async.py`, `samples/high_level_sync.py`, `samples/basic_high_level_rw.py`, `samples/named_snapshot.py`, `samples/polling_monitor.py`. |
+
+## License and registry
+
+| Item | Value |
+| --- | --- |
+| License | [MIT](LICENSE) |
+| Registry | [PyPI](https://pypi.org/project/plc-comm-kv-hostlink/) |
+| Package | `plc-comm-kv-hostlink` |
+
+## 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>

plc_comm_kv_hostlink-2.0.0/pyproject.toml

@@ -0,0 +1,96 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "plc-comm-kv-hostlink"
+version = "2.0.0"
+description = "Python library for KEYENCE KV series Host Link (Upper Link) communication."
+authors = [{ name = "fa-yoshinobu" }]
+license = "MIT"
+requires-python = ">=3.10"
+dependencies = []
+readme = "README.md"
+
+license-files = ["LICENSE"]
+keywords = ["plc-comm", "keyence", "kv", "hostlink", "upper-link", "plc", "tcp", "udp"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: System :: Networking",
+]
+
+[project.urls]
+Homepage = "https://github.com/fa-yoshinobu/plc-comm-hostlink-python"
+Repository = "https://github.com/fa-yoshinobu/plc-comm-hostlink-python"
+Issues = "https://github.com/fa-yoshinobu/plc-comm-hostlink-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",
+]
+[tool.setuptools]
+package-dir = { "" = "src" }
+packages = ["hostlink"]
+include-package-data = true
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+
+[tool.setuptools.exclude-package-data]
+"*" = [
+    "TODO.md",
+    "internal_docs/*",
+    "internal_docs/**/*",
+    "tests/*",
+    "scripts/*",
+    "samples/*"
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+extend-exclude = ["dist"]
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP"]
+
+[tool.mypy]
+files = ["src/hostlink"]
+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 = ["hostlink"]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+
+
+

plc_comm_kv_hostlink-2.0.0/setup.cfg

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

plc_comm_kv_hostlink-2.0.0/src/hostlink/__init__.py

@@ -0,0 +1,135 @@
+"""KEYENCE KV Host Link communication library.
+
+The user-facing surface of this package is the high-level helper API exported
+from :mod:`hostlink.utils`:
+
+- :func:`open_and_connect`
+- :class:`HostLinkConnectionOptions`
+- :class:`HostLinkAddress`
+- :class:`TimerCounterValue`
+- :func:`parse_address`
+- :func:`try_parse_address`
+- :func:`format_address`
+- :func:`normalize_address`
+- :func:`read_typed`
+- :func:`read_timer_counter`
+- :func:`read_timer`
+- :func:`read_counter`
+- :func:`write_typed`
+- :func:`read_comments`
+- :func:`read_words_single_request`
+- :func:`read_dwords_single_request`
+- :func:`read_words_chunked`
+- :func:`read_dwords_chunked`
+- :func:`read_expansion_unit_buffer`
+- :func:`write_expansion_unit_buffer`
+- :func:`write_bit_in_word`
+- :func:`read_named`
+- :func:`poll`
+
+The low-level clients remain part of the package for advanced and maintainer
+workflows, but the helpers above are the recommended entry points for normal
+application code and generated user documentation.
+"""
+
+__version__ = "2.0.0"
+
+from .client import AsyncHostLinkClient, HostLinkClient, HostLinkTraceDirection, HostLinkTraceFrame, ModelInfo
+from .device_ranges import (
+    KvDeviceRangeCatalog,
+    KvDeviceRangeCategory,
+    KvDeviceRangeEntry,
+    KvDeviceRangeNotation,
+    KvDeviceRangeSegment,
+    available_plc_profiles,
+    device_range_catalog_for_plc_profile,
+    display_name,
+)
+from .errors import (
+    HostLinkBaseError,
+    HostLinkConnectionError,
+    HostLinkError,
+    HostLinkProtocolError,
+    decode_error_code,
+)
+from .utils import (
+    HostLinkAddress,
+    HostLinkConnectionOptions,
+    TimerCounterValue,
+    format_address,
+    normalize_address,
+    open_and_connect,
+    parse_address,
+    poll,
+    read_comments,
+    read_counter,
+    read_dwords,
+    read_dwords_chunked,
+    read_dwords_single_request,
+    read_expansion_unit_buffer,
+    read_named,
+    read_timer,
+    read_timer_counter,
+    read_typed,
+    read_words,
+    read_words_chunked,
+    read_words_single_request,
+    try_parse_address,
+    write_bit_in_word,
+    write_dwords_chunked,
+    write_dwords_single_request,
+    write_expansion_unit_buffer,
+    write_typed,
+    write_words_chunked,
+    write_words_single_request,
+)
+
+__all__ = [
+    "HostLinkClient",
+    "AsyncHostLinkClient",
+    "ModelInfo",
+    "HostLinkTraceDirection",
+    "HostLinkTraceFrame",
+    "HostLinkBaseError",
+    "HostLinkConnectionError",
+    "HostLinkError",
+    "HostLinkProtocolError",
+    "decode_error_code",
+    "KvDeviceRangeCatalog",
+    "KvDeviceRangeCategory",
+    "KvDeviceRangeEntry",
+    "KvDeviceRangeNotation",
+    "KvDeviceRangeSegment",
+    "available_plc_profiles",
+    "device_range_catalog_for_plc_profile",
+    "display_name",
+    "HostLinkAddress",
+    "HostLinkConnectionOptions",
+    "TimerCounterValue",
+    "format_address",
+    "normalize_address",
+    "open_and_connect",
+    "parse_address",
+    "poll",
+    "read_comments",
+    "read_counter",
+    "read_dwords",
+    "read_dwords_chunked",
+    "read_dwords_single_request",
+    "read_named",
+    "read_timer",
+    "read_timer_counter",
+    "read_typed",
+    "read_words",
+    "read_words_chunked",
+    "read_words_single_request",
+    "read_expansion_unit_buffer",
+    "try_parse_address",
+    "write_bit_in_word",
+    "write_dwords_chunked",
+    "write_dwords_single_request",
+    "write_expansion_unit_buffer",
+    "write_typed",
+    "write_words_chunked",
+    "write_words_single_request",
+]