b2065f8730
Second + third of the four driver test clients. Both follow the same shape as otopcua-modbus-cli (#249) and consume Driver.Cli.Common for DriverCommandBase + SnapshotFormatter. New projects: - src/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/ — otopcua-abcip-cli. AbCipCommandBase carries gateway (ab://host[:port]/cip-path) + family (ControlLogix/CompactLogix/Micro800/GuardLogix) + timeout. Commands: probe, read, write, subscribe. Value parser covers every AbCipDataType atomic type (Bool, SInt..LInt, USInt..ULInt, Real, LReal, String, Dt); Structure writes refused as out-of-scope for the CLI. - src/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Cli/ — otopcua-ablegacy-cli. AbLegacyCommandBase carries gateway + plc-type (Slc500/MicroLogix/Plc5/ LogixPccc) + timeout. Commands: probe (default address N7:0), read, write, subscribe. Value parser covers Bit, Int, Long, Float, AnalogInt, String, and the three sub-element types (TimerElement / CounterElement / ControlElement all land on int32 at the wire). Tests (35 new, 73 cumulative across the driver CLI family): - AB CIP: 17 tests — ParseValue happy-paths for every Logix atomic type, failure cases (non-numeric / bool garbage), tag-name synthesis. - AB Legacy: 18 tests — ParseValue coverage (Bit / Int / AnalogInt / Long / Float / String / sub-elements), PCCC address round-trip in tag names including bit-within-word + sub-element syntax. Docs: - docs/Driver.AbCip.Cli.md — family ↔ CIP-path cheat sheet + examples per command + typical workflows. - docs/Driver.AbLegacy.Cli.md — PCCC address primer (file letters → CLI --type) + known ab_server upstream gap cross-ref to #224 close-out. Wiring: - ZB.MOM.WW.OtOpcUa.slnx grew 4 entries (2 src + 2 tests). Full-solution build clean. `otopcua-abcip-cli --help` + `otopcua-ablegacy-cli --help` verified end-to-end. Next up (#251): S7 + TwinCAT CLIs, same pattern. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
60 lines
2.4 KiB
C#
60 lines
2.4 KiB
C#
using CliFx.Attributes;
|
|
using ZB.MOM.WW.OtOpcUa.Driver.Cli.Common;
|
|
|
|
namespace ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli;
|
|
|
|
/// <summary>
|
|
/// Base for every AB CIP CLI command. Carries the libplctag endpoint options
|
|
/// (<c>--gateway</c> + <c>--family</c>) and exposes <see cref="BuildOptions"/> so each
|
|
/// command can synthesise an <see cref="AbCipDriverOptions"/> from CLI flags + its own
|
|
/// tag list.
|
|
/// </summary>
|
|
public abstract class AbCipCommandBase : DriverCommandBase
|
|
{
|
|
[CommandOption("gateway", 'g', Description =
|
|
"Canonical AB CIP gateway: ab://host[:port]/cip-path. Port defaults to 44818 " +
|
|
"(EtherNet/IP). cip-path is family-specific: ControlLogix / CompactLogix need " +
|
|
"'1,0' to reach slot 0 of the CPU chassis; Micro800 takes an empty path; " +
|
|
"GuardLogix typically '1,0' same as ControlLogix.",
|
|
IsRequired = true)]
|
|
public string Gateway { get; init; } = default!;
|
|
|
|
[CommandOption("family", 'f', Description =
|
|
"ControlLogix / CompactLogix / Micro800 / GuardLogix (default ControlLogix).")]
|
|
public AbCipPlcFamily Family { get; init; } = AbCipPlcFamily.ControlLogix;
|
|
|
|
[CommandOption("timeout-ms", Description = "Per-operation timeout in ms (default 5000).")]
|
|
public int TimeoutMs { get; init; } = 5000;
|
|
|
|
/// <inheritdoc />
|
|
public override TimeSpan Timeout
|
|
{
|
|
get => TimeSpan.FromMilliseconds(TimeoutMs);
|
|
init { /* driven by TimeoutMs */ }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Build an <see cref="AbCipDriverOptions"/> with the device + tag list a subclass
|
|
/// supplies. Probe + alarm projection are disabled — CLI runs are one-shot; the
|
|
/// probe loop would race the operator's own reads.
|
|
/// </summary>
|
|
protected AbCipDriverOptions BuildOptions(IReadOnlyList<AbCipTagDefinition> tags) => new()
|
|
{
|
|
Devices = [new AbCipDeviceOptions(
|
|
HostAddress: Gateway,
|
|
PlcFamily: Family,
|
|
DeviceName: $"cli-{Family}")],
|
|
Tags = tags,
|
|
Timeout = Timeout,
|
|
Probe = new AbCipProbeOptions { Enabled = false },
|
|
EnableControllerBrowse = false,
|
|
EnableAlarmProjection = false,
|
|
};
|
|
|
|
/// <summary>
|
|
/// Short instance id used in Serilog output so operators running the CLI against
|
|
/// multiple gateways in parallel can distinguish the logs.
|
|
/// </summary>
|
|
protected string DriverInstanceId => $"abcip-cli-{Gateway}";
|
|
}
|