dohertj2/lmxopcua
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

v3(b1-modbus): RawPath identity seam — RawTagEntry-driven Modbus driver

Browse Source 
Wave-B EXEMPLAR. Retire the pre-declared/blob-parse tag model; the driver now
builds its RawPath -> definition table from the artifact's RawTagEntry set via a
pure mapper.

- Contracts: rename ModbusEquipmentTagParser -> ModbusTagDefinitionFactory;
  TryParse(reference) -> FromTagConfig(tagConfig, rawPath) (def.Name = rawPath,
  no leading-brace heuristic); add inverse ToTagConfig(def) serializer; keep all
  strict-enum reads + guards; also read stringByteOrder/deadband/coalesceProhibited
  so a RawTagEntry round-trips the full authored def. Inspect() unchanged.
- Options: Tags(IReadOnlyList<ModbusTagDefinition>) -> RawTags(IReadOnlyList<RawTagEntry>).
- Driver: _tagsByName -> _tagsByRawPath (Ordinal); resolver byRawPath-only; build
  the table from RawTags at Initialize threading entry.WriteIdempotent onto each def;
  Discover/Teardown updated.
- Factory: remove ModbusTagDto/BuildTag/ValidateStringLength + ConfigDto.Tags; bind
  RawTags from driver-config JSON.
- CLI ModbusCommandBase.BuildOptions: serialise typed defs -> RawTagEntry via ToTagConfig.
- Tests: migrate Tags= -> RawTags via ModbusRawTags.Entries helper; parser tests ->
  FromTagConfig(rawPath); factory String-length/enum tests re-seated on the mapper seam.
- Propagated rename to ControlPlane EquipmentTagConfigInspector (outside Modbus projects).

Modbus.Tests 315/315, Addressing.Tests 161/161, Cli.Tests 72/72 green.
Docker-gated Driver.Modbus.IntegrationTests left untouched (won't compile against
the new API; expected).
This commit is contained in:
Joseph Doherty
2026-07-15 19:50:10 -04:00
parent 906800abc0
commit aafb9d4929
27 changed files with 362 additions and 362 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Tests/ModbusArrayTests.cs
+13 -13
View File
@@ -16,7 +16,7 @@ public sealed class ModbusArrayTests
private static (ModbusDriver driver, ModbusDriverTests.FakeTransport fake) NewDriver(params ModbusTagDefinition[] tags)
{
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = tags };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = ModbusRawTags.Entries(tags)};
var drv = new ModbusDriver(opts, "modbus-array", _ => fake);
return (drv, fake);
}
@@ -274,14 +274,14 @@ public sealed class ModbusArrayTests
{
var json = """{"region":"HoldingRegisters","address":20,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":3}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/arr20", json, false)] };
var drv = new ModbusDriver(opts, "modbus-eq-arr", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[20] = 100;
fake.HoldingRegisters[21] = 200;
fake.HoldingRegisters[22] = 300;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync(["cell/modbus/arr20"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
var arr = r[0].Value.ShouldBeOfType<short[]>();
@@ -297,12 +297,12 @@ public sealed class ModbusArrayTests
{
var json = """{"region":"HoldingRegisters","address":30,"dataType":"UInt16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/scalar30", json, false)] };
var drv = new ModbusDriver(opts, "modbus-eq-scalar", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[30] = 1234;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync(["cell/modbus/scalar30"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
r[0].Value.ShouldBe((ushort)1234);
@@ -316,7 +316,7 @@ public sealed class ModbusArrayTests
public void Equipment_Tag_Parser_Threads_ArrayLength_Into_ArrayCount()
{
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":5}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBe(5);
}
@@ -328,7 +328,7 @@ public sealed class ModbusArrayTests
public void Equipment_Tag_Parser_No_ArrayLength_Leaves_ArrayCount_Null()
{
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBeNull();
}
@@ -345,7 +345,7 @@ public sealed class ModbusArrayTests
{
// isArray:false, arrayLength:8 → must be scalar (ArrayCount == null).
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":false,"arrayLength":8}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBeNull();
}
@@ -359,12 +359,12 @@ public sealed class ModbusArrayTests
// isArray:false, arrayLength:8 → scalar read; only register[40] is consumed.
var json = """{"region":"HoldingRegisters","address":40,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":false,"arrayLength":8}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/c1scalar40", json, false)] };
var drv = new ModbusDriver(opts, "modbus-c1-scalar", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[40] = 9999;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync(["cell/modbus/c1scalar40"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
// Must be a scalar short, NOT a short[].
@@ -380,7 +380,7 @@ public sealed class ModbusArrayTests
public void Parser_IsArrayTrue_ArrayLength1_Gives_ArrayCount_1()
{
var json = """{"region":"HoldingRegisters","address":0,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":1}""";
ModbusEquipmentTagParser.TryParse(json, out var def).ShouldBeTrue();
ModbusTagDefinitionFactory.FromTagConfig(json, "cell/modbus/arr", out var def).ShouldBeTrue();
def!.ArrayCount.ShouldBe(1);
}
@@ -393,12 +393,12 @@ public sealed class ModbusArrayTests
{
var json = """{"region":"HoldingRegisters","address":50,"dataType":"Int16","byteOrder":"BigEndian","bitIndex":0,"stringLength":0,"isArray":true,"arrayLength":1}""";
var fake = new ModbusDriverTests.FakeTransport();
var opts = new ModbusDriverOptions { Host = "fake", Tags = [] };
var opts = new ModbusDriverOptions { Host = "fake", RawTags = [new RawTagEntry("cell/modbus/c1arr50", json, false)] };
var drv = new ModbusDriver(opts, "modbus-c1-arr1", _ => fake);
await drv.InitializeAsync("{}", CancellationToken.None);
fake.HoldingRegisters[50] = 777;
var r = await drv.ReadAsync([json], CancellationToken.None);
var r = await drv.ReadAsync(["cell/modbus/c1arr50"], CancellationToken.None);
r[0].StatusCode.ShouldBe(0u);
// Must be a short[] of length 1, NOT a scalar short.