KcpX 0.1.0

KcpX

<p> <img alt="Version" src="https://img.shields.io/badge/version-0.1.0-blue" /> <img alt=".NET 7.0+" src="https://img.shields.io/badge/.NET-7.0+-blueviolet" /> <img alt=".NET 8.0+" src="https://img.shields.io/badge/.NET-8.0+-purple" /> <img alt=".NET 9.0+" src="https://img.shields.io/badge/.NET-9.0+-indigo" /> <img alt=".NET Core 2.0+" src="https://img.shields.io/badge/.NET_Core-2.0+-darkgreen" /> <img alt=".NET Framework 4.6.1+" src="https://img.shields.io/badge/.NET_Framework-4.6.1+-teal?logo=windows" /> <img alt="License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg" /> </p>

<p> <a href="README_JA.md">日本語</a> | <a href="README.md">English</a> </p>

KcpX is a library for communicating with KEYENCE KV series PLCs using the host link protocol (上位リンク).
It has the same simple API as McpX, so you can communicate without worrying about host link details.
It runs on various platforms, including Linux, Windows, and macOS.

Installation

.NET CLI

dotnet add package KcpX

Package Manager(Visual Studio)

PM> NuGet\Install-Package KcpX

Example Usage

using KcpXLib;
using KcpXLib.Enums;

// Connect to the PLC (host link port 8501, TCP)
using (var kcpx = new KcpX("192.168.12.89", 8501, series: PlcSeries.KV7000))
{
    // Read 3000 points starting from MR0 (split into requests of up to 1000 points)
    bool[] mrArr = kcpx.BatchRead<bool>(Prefix.MR, "0", 3000);

    // Read 2000 words starting from DM1000
    short[] dmArr = kcpx.BatchRead<short>(Prefix.DM, "1000", 2000);

    // Write 1234 to DM0-DM1 and 5678 to DM2-DM3 as signed 32-bit integers
    kcpx.BatchWrite<int>(Prefix.DM, "0", [1234, 5678]);

    // Read ranges and single devices together
    short[] block = [];
    int total = 0;
    kcpx.Read(b => b
        .Add<short>(Prefix.DM, "400", 100, v => block = v)
        .Add<int>(Prefix.DM, "2000", v => total = v));

    // Timer contact, current value and set value
    TimerCounterValue t0 = kcpx.ReadTimerCounter(Prefix.T, "0");
}

C# samples are available here.

Connecting to the KV STUDIO simulator

KcpXSimulator connects to the KV STUDIO simulator over host link (TCP). (Verified with KV STUDIO Ver.12.41)

using var sim = new KcpXSimulator();
using var remote = new KcpXSimulator("192.168.12.90");  // Simulator running on another PC

• Target PLCs are KV-8000 / KV-X500 projects.
• Only one simulator can be connected (when several are running, the first one started is connected).
• The simulator listens on 127.0.0.1 only. To connect from another PC, forward port 8501 to 127.0.0.1 on the simulator PC (e.g. netsh interface portproxy).
• TCP only. Monitor commands (MBS / MBR / MWS / MWR) are not supported (NotSupportedException).

Supported Commands

Typed methods such as ReadInt16, BatchReadDouble and WriteUInt32Async are also available.

Supported types

Supported Devices

R, B, MR, LR, CR, VB, DM, EM, FM, ZF, W, TM, Z, T, TC, TS, C, CC, CS, CTH, CTC, AT, CM, VM

• R, MR, LR, CR are specified as channel + 2-digit bit number (e.g. "1015" = channel 10, bit 15). B, VB, W are hexadecimal.
• T / C numbers that are not used in the ladder program return error E0.

Supported Protocols

• TCP
• UDP

Changelog

• CHANGELOG.md

Related

• McpX A library for communicating with Mitsubishi Electric PLCs using the MC protocol.