PlcComm.KvHostLink 0.1.4

KV Host Link Protocol for .NET

Modern .NET library for KEYENCE KV series PLCs using the Host Link (Upper Link) protocol.

This README intentionally covers the recommended high-level API only:

• OpenAndConnectAsync
• ReadTypedAsync
• WriteTypedAsync
• WriteBitInWordAsync
• ReadNamedAsync
• PollAsync
• ReadWordsAsync
• ReadDWordsAsync

Low-level token-oriented methods and protocol details are kept in maintainer documentation.

Key Features

• Async-first .NET API
• High-level typed read/write helpers
• Mixed snapshots with ReadNamedAsync
• Polling with PollAsync
• Contiguous block helpers for ushort[] and uint[]
• Hardware-verified against KV-7500

Quick Start

Installation

• Package page: https://www.nuget.org/packages/PlcComm.KvHostLink/

dotnet add package PlcComm.KvHostLink

Or add a package reference directly:

<PackageReference Include="PlcComm.KvHostLink" Version="0.1.4" />

You can also reference src/PlcComm.KvHostLink/PlcComm.KvHostLink.csproj directly during local development.

High-level example

using PlcComm.KvHostLink;

await using var client = await KvHostLinkClientExtensions.OpenAndConnectAsync(
    "192.168.250.100",
    8501);

ushort dm0 = (ushort)await client.ReadTypedAsync("DM0", "U");
await client.WriteTypedAsync("DM10", "U", dm0);

var snapshot = await client.ReadNamedAsync(
    new[] { "DM0", "DM1:S", "DM2:D", "DM4:F", "DM10.0" });

Console.WriteLine(string.Join(", ", snapshot.Select(kv => $"{kv.Key}={kv.Value}")));

Common Workflows

Typed block reads:

ushort[] words = await client.ReadWordsAsync("DM100", 10);
uint[] dwords = await client.ReadDWordsAsync("DM200", 4);

Bit-in-word update:

await client.WriteBitInWordAsync("DM50", bitIndex: 3, value: true);

Polling:

await foreach (var snapshot in client.PollAsync(
    new[] { "DM100", "DM101:L", "DM50.3" },
    TimeSpan.FromSeconds(1)))
{
    Console.WriteLine(snapshot["DM100"]);
}

Sample Projects

Buildable sample projects are under samples/:

• PlcComm.KvHostLink.HighLevelSample
• PlcComm.KvHostLink.BasicReadWriteSample
• PlcComm.KvHostLink.NamedPollingSample

API and workflow to sample mapping:

Run examples:

dotnet run --project samples/PlcComm.KvHostLink.HighLevelSample -- 192.168.250.100 8501
dotnet run --project samples/PlcComm.KvHostLink.BasicReadWriteSample -- 192.168.250.100 8501
dotnet run --project samples/PlcComm.KvHostLink.NamedPollingSample -- 192.168.250.100 8501

Documentation

User documentation:

• User Guide
• Device Handling
• Sample Projects

Maintainer and QA documentation:

• QA Reports
• Protocol Specification
• API Unification Policy

Development and CI

run_ci.bat
release_check.bat

run_ci.bat builds the library, tests it, checks formatting, builds all user-facing sample projects, verifies XML docs coverage for the public high-level API, and checks sample references in the docs.

release_check.bat runs run_ci.bat and then rebuilds the published docs.

Pack the NuGet package locally:

dotnet pack src\PlcComm.KvHostLink\PlcComm.KvHostLink.csproj -c Release

License

Distributed under the MIT License.