5dac2e9375
Mirrors the v1 otopcua-cli value prop (ad-hoc shell-level PLC validation) for
the Modbus-TCP driver, and lays down the shared scaffolding that AB CIP, AB
Legacy, S7, and TwinCAT CLIs will build on.
New projects:
- src/ZB.MOM.WW.OtOpcUa.Driver.Cli.Common/ — DriverCommandBase (verbose
flag + Serilog config) + SnapshotFormatter (single-tag + table +
write-result renders with invariant-culture value formatting + OPC UA
status-code shortnames + UTC-normalised timestamps).
- src/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli/ — otopcua-modbus-cli executable.
Commands: probe, read, write, subscribe. ModbusCommandBase carries the
host/port/unit-id flags + builds ModbusDriverOptions with Probe.Enabled
=false (CLI runs are one-shot; driver-internal keep-alive would race).
Commands + coverage:
- probe single FC03 + GetHealth() + pretty-print
- read region × address × type synth into one driver tag
- write same shape + --value parsed per --type
- subscribe polled-subscription stream until Ctrl+C
Tests (38 total):
- 16 SnapshotFormatterTests covering: status-code shortnames, unknown
codes fall back to hex, null value + timestamp placeholders, bool
lowercase, float invariant culture, string quoting, write-result shape,
aligned table columns, mismatched-length rejection, UTC normalisation.
- 22 Modbus CLI tests:
· ReadCommandTests.SynthesiseTagName (5 theory cases)
· WriteCommandParseValueTests (17 cases: bool aliases, unknown rejected,
Int16 bounds, UInt16/Bcd16 type, Float32/64 invariant culture,
String passthrough, BitInRegister, Int32 MinValue, non-numeric reject)
Wiring:
- ZB.MOM.WW.OtOpcUa.slnx grew 4 entries (2 src + 2 tests).
- docs/Driver.Modbus.Cli.md — operator-facing runbook with examples per
command + output format + typical workflows.
Regression: full-solution build clean; shared-lib tests 16/0, Modbus CLI tests
22/0.
Next up: repeat the pattern for AB CIP (shares ~40% more with Modbus via
libplctag), then AB Legacy, S7, TwinCAT. The shared base stays as-is unless
one of those exposes a gap the Modbus-first pass missed.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
56 lines
2.3 KiB
C#
56 lines
2.3 KiB
C#
using CliFx.Attributes;
|
|
using CliFx.Infrastructure;
|
|
using ZB.MOM.WW.OtOpcUa.Driver.Cli.Common;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli.Commands;
|
|
|
|
/// <summary>
|
|
/// Probes a Modbus-TCP endpoint: opens a socket via <see cref="ModbusDriver"/>'s
|
|
/// <c>InitializeAsync</c>, issues a single FC03 at the configured probe address, and
|
|
/// prints the driver's <c>GetHealth()</c>. Fastest way to answer "is the PLC up + talking
|
|
/// Modbus on this host:port?".
|
|
/// </summary>
|
|
[Command("probe", Description = "Verify the Modbus-TCP endpoint is reachable and speaks Modbus.")]
|
|
public sealed class ProbeCommand : ModbusCommandBase
|
|
{
|
|
[CommandOption("probe-address", Description =
|
|
"Holding-register address used as the cheap-read probe (default 0). Some PLCs lock " +
|
|
"register 0 — set this to a known-good address on your device.")]
|
|
public ushort ProbeAddress { get; init; }
|
|
|
|
public override async ValueTask ExecuteAsync(IConsole console)
|
|
{
|
|
ConfigureLogging();
|
|
var ct = console.RegisterCancellationHandler();
|
|
|
|
// Build with one probe tag + Probe.Enabled=false so InitializeAsync connects the
|
|
// transport, we issue a single read to verify the device responds, then shut down.
|
|
var probeTag = new ModbusTagDefinition(
|
|
Name: "__probe",
|
|
Region: ModbusRegion.HoldingRegisters,
|
|
Address: ProbeAddress,
|
|
DataType: ModbusDataType.UInt16);
|
|
var options = BuildOptions([probeTag]);
|
|
|
|
await using var driver = new ModbusDriver(options, DriverInstanceId);
|
|
try
|
|
{
|
|
await driver.InitializeAsync("{}", ct);
|
|
var snapshot = await driver.ReadAsync(["__probe"], ct);
|
|
var health = driver.GetHealth();
|
|
|
|
await console.Output.WriteLineAsync($"Host: {Host}:{Port} (unit {UnitId})");
|
|
await console.Output.WriteLineAsync($"Health: {health.State}");
|
|
if (health.LastError is { } err)
|
|
await console.Output.WriteLineAsync($"Last error: {err}");
|
|
await console.Output.WriteLineAsync();
|
|
await console.Output.WriteLineAsync(
|
|
SnapshotFormatter.Format($"HR[{ProbeAddress}]", snapshot[0]));
|
|
}
|
|
finally
|
|
{
|
|
await driver.ShutdownAsync(CancellationToken.None);
|
|
}
|
|
}
|
|
}
|