3c75db7eb6
- Driver.TwinCAT-004: corrected the IEC time-type inline comments; documented that the driver currently surfaces them as raw UInt32 counters. - Driver.TwinCAT-006: ResolveHost returns a documented UnresolvedHost sentinel when no devices are configured instead of returning the logical DriverInstanceId (which never matches GetHostStatuses). - Driver.TwinCAT-014: wired Probe.Timeout into the probe-loop call and added a NotificationMaxDelayMs config knob threaded through AddNotificationAsync. - Driver.TwinCAT-015: Dispose() runs a genuinely synchronous teardown with bounded waits (no sync-over-async deadlock pattern). - Driver.TwinCAT-016: pinned the Structure-tag rejection and the probe-loop vs read disposal race with regression tests. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
73 lines
3.6 KiB
C#
73 lines
3.6 KiB
C#
namespace ZB.MOM.WW.OtOpcUa.Driver.TwinCAT;
|
|
|
|
/// <summary>
|
|
/// TwinCAT ADS driver configuration. One instance supports N targets (each identified by
|
|
/// an AMS Net ID + port). Compiles + runs without a local AMS router but every wire call
|
|
/// fails with <c>BadCommunicationError</c> until a router is reachable.
|
|
/// </summary>
|
|
public sealed class TwinCATDriverOptions
|
|
{
|
|
public IReadOnlyList<TwinCATDeviceOptions> Devices { get; init; } = [];
|
|
public IReadOnlyList<TwinCATTagDefinition> Tags { get; init; } = [];
|
|
public TwinCATProbeOptions Probe { get; init; } = new();
|
|
public TimeSpan Timeout { get; init; } = TimeSpan.FromSeconds(2);
|
|
|
|
/// <summary>
|
|
/// When <c>true</c> (default), <c>SubscribeAsync</c> registers native ADS notifications
|
|
/// via <c>AddDeviceNotificationExAsync</c> — the PLC pushes changes on its own cycle
|
|
/// rather than the driver polling. Strictly better for latency + CPU when the target
|
|
/// supports it (TC2 + TC3 PLC runtimes always do; some soft-PLC / third-party ADS
|
|
/// implementations may not). When <c>false</c>, the driver falls through to the shared
|
|
/// <see cref="Core.Abstractions.PollGroupEngine"/> — same semantics as the other
|
|
/// libplctag-backed drivers. Set <c>false</c> for deployments where the AMS router has
|
|
/// notification limits you can't raise.
|
|
/// </summary>
|
|
public bool UseNativeNotifications { get; init; } = true;
|
|
|
|
/// <summary>
|
|
/// When <c>true</c>, <c>DiscoverAsync</c> walks each device's symbol table via the
|
|
/// TwinCAT <c>SymbolLoaderFactory</c> (flat mode) + surfaces controller-resident
|
|
/// globals / program locals under a <c>Discovered/</c> sub-folder. Pre-declared tags
|
|
/// from <see cref="Tags"/> always emit regardless. Default <c>false</c> to preserve
|
|
/// the strict-config path for deployments where only declared tags should appear.
|
|
/// </summary>
|
|
public bool EnableControllerBrowse { get; init; }
|
|
|
|
/// <summary>
|
|
/// Maximum batching delay in milliseconds for ADS device notifications. Passed to
|
|
/// <c>NotificationSettings</c> as the max-delay value: TwinCAT may coalesce notifications
|
|
/// up to this delay before pushing them. <c>0</c> (default) = no batching, push
|
|
/// immediately. Useful for high-churn signals where the OPC UA subscriber tolerates a
|
|
/// small delay in exchange for fewer wire round-trips. Listed in <c>docs/v2/driver-specs.md</c>
|
|
/// section 6 — was previously hard-coded to 0 (Driver.TwinCAT-014).
|
|
/// </summary>
|
|
public int NotificationMaxDelayMs { get; init; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// One TwinCAT target. <paramref name="HostAddress"/> must parse via
|
|
/// <see cref="TwinCATAmsAddress.TryParse"/>; misconfigured devices fail driver initialisation.
|
|
/// </summary>
|
|
public sealed record TwinCATDeviceOptions(
|
|
string HostAddress,
|
|
string? DeviceName = null);
|
|
|
|
/// <summary>
|
|
/// One TwinCAT-backed OPC UA variable. <paramref name="SymbolPath"/> is the full TwinCAT
|
|
/// symbolic name (e.g. <c>MAIN.bStart</c>, <c>GVL.Counter</c>, <c>Motor1.Status.Running</c>).
|
|
/// </summary>
|
|
public sealed record TwinCATTagDefinition(
|
|
string Name,
|
|
string DeviceHostAddress,
|
|
string SymbolPath,
|
|
TwinCATDataType DataType,
|
|
bool Writable = true,
|
|
bool WriteIdempotent = false);
|
|
|
|
public sealed class TwinCATProbeOptions
|
|
{
|
|
public bool Enabled { get; init; } = true;
|
|
public TimeSpan Interval { get; init; } = TimeSpan.FromSeconds(5);
|
|
public TimeSpan Timeout { get; init; } = TimeSpan.FromSeconds(2);
|
|
}
|