[opcuaclient] OpcUaClient — Per-tag advanced subscription tuning incl. deadband #332

dohertj2 · 2026-04-25T15:27:47-04:00

dohertj2 commented

2026-04-25 15:27:47 -04:00

Summary

Per-tag advanced subscription tuning on ISubscribable, with cross-driver back-compat preserved via default-impl.

Core.Abstractions/ISubscribable.cs:

New MonitoredTagSpec record: TagName + nullable SamplingIntervalMs / QueueSize / DiscardOldest / MonitoringMode / DataChangeFilter.
New DataChangeFilterSpec sub-record: Trigger + DeadbandType + DeadbandValue.
New SDK-free enums: DataChangeTrigger (Status / StatusValue / StatusValueTimestamp), DeadbandType (None / Absolute / Percent), SubscriptionMonitoringMode (Disabled / Sampling / Reporting).
Additive SubscribeAsync(IReadOnlyList<MonitoredTagSpec>, ...) overload with a default interface implementation that delegates to the legacy string-based overload. Modbus / S7 / TwinCAT / FOCAS / Galaxy.Proxy / AbCip / AbLegacy compile unchanged.

Driver.OpcUaClient/OpcUaClientDriver.cs:

Legacy SubscribeAsync(IReadOnlyList<string>, ...) now routes through the new overload.
Internal BuildMonitoredItem helper maps every per-tag knob onto the SDK's MonitoredItem options (Filter = new DataChangeFilter { Trigger, DeadbandType, DeadbandValue }).
PercentDeadband's BadFilterNotAllowed is caught around CreateItemsAsync so other items in the batch still create.

Disambiguated three pre-existing cref="ISubscribable.SubscribeAsync" doc comments to silence ambiguous-reference errors under TreatWarningsAsErrors.

Test plan

dotnet build — Core.Abstractions + OpcUaClient + 7 sibling drivers (Modbus/S7/TwinCAT/FOCAS/AbLegacy/AbCip/Galaxy.Proxy) all clean (0 / 0)
dotnet test tests/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Tests — 95 / 95 passed (12 new in OpcUaClientMonitoredTagSpecTests: defaults match legacy, sampling/queue/discard overrides, MonitoringMode mapping theory, absolute + percent deadband filter, trigger/deadband enum round-trips, default-impl routing through StubSubscribableDriver)
dotnet test tests/ZB.MOM.WW.OtOpcUa.Core.Abstractions.Tests — 37 / 37 passed
Integration tests — skipped (live UA server required)

🤖 Auto-generated by the Mode-B execution loop. Closes #274.

Closes #274

## Summary Per-tag advanced subscription tuning on `ISubscribable`, with cross-driver back-compat preserved via default-impl. **`Core.Abstractions/ISubscribable.cs`**: - New `MonitoredTagSpec` record: `TagName` + nullable `SamplingIntervalMs` / `QueueSize` / `DiscardOldest` / `MonitoringMode` / `DataChangeFilter`. - New `DataChangeFilterSpec` sub-record: `Trigger` + `DeadbandType` + `DeadbandValue`. - New SDK-free enums: `DataChangeTrigger` (Status / StatusValue / StatusValueTimestamp), `DeadbandType` (None / Absolute / Percent), `SubscriptionMonitoringMode` (Disabled / Sampling / Reporting). - Additive `SubscribeAsync(IReadOnlyList<MonitoredTagSpec>, ...)` overload with a **default interface implementation** that delegates to the legacy string-based overload. Modbus / S7 / TwinCAT / FOCAS / Galaxy.Proxy / AbCip / AbLegacy compile unchanged. **`Driver.OpcUaClient/OpcUaClientDriver.cs`**: - Legacy `SubscribeAsync(IReadOnlyList<string>, ...)` now routes through the new overload. - Internal `BuildMonitoredItem` helper maps every per-tag knob onto the SDK's `MonitoredItem` options (Filter = `new DataChangeFilter { Trigger, DeadbandType, DeadbandValue }`). - `PercentDeadband`'s `BadFilterNotAllowed` is caught around `CreateItemsAsync` so other items in the batch still create. Disambiguated three pre-existing `cref="ISubscribable.SubscribeAsync"` doc comments to silence ambiguous-reference errors under `TreatWarningsAsErrors`. ## Test plan - [x] `dotnet build` — Core.Abstractions + OpcUaClient + 7 sibling drivers (Modbus/S7/TwinCAT/FOCAS/AbLegacy/AbCip/Galaxy.Proxy) all clean (0 / 0) - [x] `dotnet test tests/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Tests` — **95 / 95 passed** (12 new in `OpcUaClientMonitoredTagSpecTests`: defaults match legacy, sampling/queue/discard overrides, MonitoringMode mapping theory, absolute + percent deadband filter, trigger/deadband enum round-trips, default-impl routing through StubSubscribableDriver) - [x] `dotnet test tests/ZB.MOM.WW.OtOpcUa.Core.Abstractions.Tests` — **37 / 37 passed** - [ ] Integration tests — skipped (live UA server required) 🤖 Auto-generated by the Mode-B execution loop. Closes #274. Closes #274

dohertj2 added 1 commit 2026-04-25 15:27:49 -04:00

Auto: opcuaclient-2 — per-tag advanced subscription tuning fae00749ca