Skip to main content

Python library for KEYENCE KV series Host Link (Upper Link) communication.

Project description

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

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-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 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.
Examples 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
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plc_comm_kv_hostlink-2.0.0.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plc_comm_kv_hostlink-2.0.0-py3-none-any.whl (31.7 kB view details)

Uploaded Python 3

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page