Skip to content

Repository files navigation

CI PyPI Python 3.10+ License: MIT

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 for protocol, language, registry, and install-command mapping.

Supported PLC profiles

The maintained profile table is in PLC profiles. 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 page. Use that page for supported device families, address syntax, and profile-specific notes.

Installation

pip install plc-comm-kv-hostlink

The PyPI wheel and source distribution contain the files needed to install and use the library; they do not carry the maintained sample tree or documentation source. Use the GitHub repository for current samples and the shared documentation site for user guides. GitHub source archives include the test suite and fixtures so their standard build and test commands are self-contained.

Quick example

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-8000")
    options = HostLinkConnectionOptions(
        host="192.168.250.100",
        plc_profile="keyence:kv-8000",
        port=8501,
        transport="tcp",
    )
    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 Unified docs for all PLC communication libraries.
Getting started Install the package, connect to your PLC, and run your first read/write.
Usage guide Use the high-level API and common Host Link workflows.
API reference Find public client methods, helpers, profile APIs, and error types.
PLC profiles Choose the canonical profile that matches your PLC model and device ranges.
KV Host Link Device Ranges Check shared device families, address notation, and range tables.
KV Host Link Troubleshooting & Codes Troubleshoot common port, profile, address, write-permission, and PLC error-code symptoms.
Gotchas Check whether this library has any current library-specific caveats.
Performance See measured latency, throughput, and long-run soak results from real PLC hardware.
Choosing a Language Compare the .NET, Python, Rust, C++, and Node-RED implementations before you pick one.
Examples Run maintained Python samples: samples/high_level_async.py, samples/high_level_sync.py, samples/basic_high_level_rw.py, samples/named_read_collection.py, samples/polling_monitor.py.

For a zero-code connectivity check, see PLC Scope (Windows).

License and registry

Item Value
License MIT
Registry PyPI
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

About

Reliable Python client for KEYENCE KV series PLCs using the Host Link (Upper Link) protocol. Supports KV-8000, KV-7500, and KV-5500.

Topics

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages