diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI/CommandBase.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI/CommandBase.cs
index 7aca25ff..e2f3f788 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI/CommandBase.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.CLI/CommandBase.cs
@@ -67,11 +67,13 @@ public abstract class CommandBase : ICommand
/// Executes the command-specific workflow against the configured OPC UA endpoint.
///
/// The CLI console used for output and cancellation handling.
+ /// A value task that represents the asynchronous command execution.
public abstract ValueTask ExecuteAsync(IConsole console);
///
/// Creates a from the common command options.
///
+ /// A populated from the current command option values.
protected ConnectionSettings CreateConnectionSettings()
{
var securityMode = SecurityModeMapper.FromString(Security);
@@ -97,6 +99,7 @@ public abstract class CommandBase : ICommand
/// and returns both the service and the connection info.
///
/// The cancellation token that aborts connection setup for the command.
+ /// A tuple of the connected and the resulting .
protected async Task<(IOpcUaClientService Service, ConnectionInfo Info)> CreateServiceAndConnectAsync(
CancellationToken ct)
{
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultApplicationConfigurationFactory.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultApplicationConfigurationFactory.cs
index 18e683a7..3165f322 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultApplicationConfigurationFactory.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultApplicationConfigurationFactory.cs
@@ -12,9 +12,7 @@ internal sealed class DefaultApplicationConfigurationFactory : IApplicationConfi
{
private static readonly ILogger Logger = Log.ForContext();
- /// Creates an OPC UA application configuration from the provided connection settings.
- /// The connection settings to use.
- /// Token to cancel the operation.
+ ///
public async Task CreateAsync(ConnectionSettings settings, CancellationToken ct)
{
// Resolve the canonical PKI path lazily on first use so constructing a
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultEndpointDiscovery.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultEndpointDiscovery.cs
index a8719460..687fbd63 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultEndpointDiscovery.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/DefaultEndpointDiscovery.cs
@@ -11,10 +11,7 @@ internal sealed class DefaultEndpointDiscovery : IEndpointDiscovery
{
private static readonly ILogger Logger = Log.ForContext();
- /// Selects an OPC UA endpoint matching the requested security mode.
- /// The application configuration.
- /// The endpoint URL to query.
- /// The requested message security mode.
+ ///
public EndpointDescription SelectEndpoint(ApplicationConfiguration config, string endpointUrl,
MessageSecurityMode requestedMode)
{
@@ -53,6 +50,7 @@ internal static class EndpointSelector
/// Thrown when no endpoint matches ; the message lists the
/// security mode + policy combinations the server returned so operators can diagnose mismatches.
///
+ /// The best matching with its URL rewritten to the requested host.
public static EndpointDescription SelectBest(
IEnumerable allEndpoints,
string endpointUrl,
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IApplicationConfigurationFactory.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IApplicationConfigurationFactory.cs
index 29d8ae30..0a350cda 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IApplicationConfigurationFactory.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IApplicationConfigurationFactory.cs
@@ -13,5 +13,6 @@ internal interface IApplicationConfigurationFactory
///
/// The connection settings to configure.
/// Cancellation token for the operation.
+ /// A task that resolves to the validated .
Task CreateAsync(ConnectionSettings settings, CancellationToken ct = default);
}
\ No newline at end of file
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IEndpointDiscovery.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IEndpointDiscovery.cs
index 4f802729..816c3c18 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IEndpointDiscovery.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/IEndpointDiscovery.cs
@@ -14,6 +14,7 @@ internal interface IEndpointDiscovery
/// The OPC UA application configuration.
/// The endpoint URL to discover.
/// The requested message security mode.
+ /// The best matching endpoint description for the requested security mode.
EndpointDescription SelectEndpoint(ApplicationConfiguration config, string endpointUrl,
MessageSecurityMode requestedMode);
}
\ No newline at end of file
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISessionAdapter.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISessionAdapter.cs
index d19a285c..1f9a84b7 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISessionAdapter.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISessionAdapter.cs
@@ -58,6 +58,7 @@ internal interface ISessionAdapter : IDisposable
///
/// The node whose current runtime value should be read.
/// The cancellation token that aborts the server read if the client cancels the request.
+ /// A task that resolves to the current for the node.
Task ReadValueAsync(NodeId nodeId, CancellationToken ct = default);
///
@@ -66,6 +67,7 @@ internal interface ISessionAdapter : IDisposable
/// The node whose value should be updated.
/// The typed OPC UA data value to write to the server.
/// The cancellation token that aborts the write if the client cancels the request.
+ /// A task that resolves to the OPC UA for the write operation.
Task WriteValueAsync(NodeId nodeId, DataValue value, CancellationToken ct = default);
///
@@ -75,6 +77,7 @@ internal interface ISessionAdapter : IDisposable
/// The starting node for the hierarchical browse.
/// The node classes that should be returned to the caller.
/// The cancellation token that aborts the browse request.
+ /// A task that resolves to a tuple of an optional continuation point and the returned references.
Task<(byte[]? ContinuationPoint, ReferenceDescriptionCollection References)> BrowseAsync(
NodeId nodeId, uint nodeClassMask = 0, CancellationToken ct = default);
@@ -83,6 +86,7 @@ internal interface ISessionAdapter : IDisposable
///
/// The continuation token returned by a prior browse result page.
/// The cancellation token that aborts the browse-next request.
+ /// A task that resolves to a tuple of an optional next continuation point and the returned references.
Task<(byte[]? ContinuationPoint, ReferenceDescriptionCollection References)> BrowseNextAsync(
byte[] continuationPoint, CancellationToken ct = default);
@@ -91,6 +95,7 @@ internal interface ISessionAdapter : IDisposable
///
/// The node to inspect for child objects or variables.
/// The cancellation token that aborts the child lookup.
+ /// A task that resolves to if the node has at least one child; otherwise .
Task HasChildrenAsync(NodeId nodeId, CancellationToken ct = default);
///
@@ -101,6 +106,7 @@ internal interface ISessionAdapter : IDisposable
/// The inclusive end of the requested history window.
/// The maximum number of raw samples to return to the client.
/// The cancellation token that aborts the history read.
+ /// A task that resolves to the ordered list of raw historical data values.
Task> HistoryReadRawAsync(NodeId nodeId, DateTime startTime, DateTime endTime,
int maxValues, CancellationToken ct = default);
@@ -113,6 +119,7 @@ internal interface ISessionAdapter : IDisposable
/// The OPC UA aggregate function to evaluate over the history window.
/// The processing interval, in milliseconds, for each aggregate bucket.
/// The cancellation token that aborts the aggregate history read.
+ /// A task that resolves to the ordered list of processed aggregate data values.
Task> HistoryReadAggregateAsync(NodeId nodeId, DateTime startTime, DateTime endTime,
NodeId aggregateId, double intervalMs, CancellationToken ct = default);
@@ -121,6 +128,7 @@ internal interface ISessionAdapter : IDisposable
///
/// The requested publishing interval for monitored items on the new subscription.
/// The cancellation token that aborts subscription creation.
+ /// A task that resolves to the newly created .
Task CreateSubscriptionAsync(int publishingIntervalMs, CancellationToken ct = default);
///
@@ -130,11 +138,13 @@ internal interface ISessionAdapter : IDisposable
/// The method node to invoke.
/// The ordered input arguments supplied to the server method call.
/// The cancellation token that aborts the method invocation.
+ /// A task that resolves to the list of output arguments returned by the method, or if none.
Task?> CallMethodAsync(NodeId objectId, NodeId methodId, object[] inputArguments, CancellationToken ct = default);
///
/// Closes the underlying session gracefully before the adapter is disposed or replaced during failover.
///
/// The cancellation token that aborts the close request.
+ /// A task that represents the asynchronous operation.
Task CloseAsync(CancellationToken ct = default);
}
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISubscriptionAdapter.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISubscriptionAdapter.cs
index 21aeeb0c..afedf4c7 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISubscriptionAdapter.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/Adapters/ISubscriptionAdapter.cs
@@ -28,6 +28,7 @@ internal interface ISubscriptionAdapter : IDisposable
///
/// The client handle returned when the monitored item was created.
/// The cancellation token that aborts the monitored-item removal.
+ /// A task that represents the asynchronous operation.
Task RemoveMonitoredItemAsync(uint clientHandle, CancellationToken ct = default);
///
@@ -46,11 +47,13 @@ internal interface ISubscriptionAdapter : IDisposable
/// Requests a condition refresh for this subscription.
///
/// The cancellation token that aborts the condition refresh request.
+ /// A task that represents the asynchronous operation.
Task ConditionRefreshAsync(CancellationToken ct = default);
///
/// Removes all monitored items and deletes the subscription.
///
/// The cancellation token that aborts subscription deletion.
+ /// A task that represents the asynchronous operation.
Task DeleteAsync(CancellationToken ct = default);
}
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/ClientStoragePaths.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/ClientStoragePaths.cs
index d1309527..9efc28f8 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/ClientStoragePaths.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/ClientStoragePaths.cs
@@ -28,6 +28,7 @@ public static class ClientStoragePaths
/// one-shot legacy-folder migration before returning so callers that depend on this
/// path (PKI store, settings file) find their existing state at the canonical name.
///
+ /// The absolute path to the client's top-level folder under LocalApplicationData.
public static string GetRoot()
{
var localAppData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
@@ -37,6 +38,7 @@ public static class ClientStoragePaths
}
/// Subfolder for the application's PKI store — used by both CLI + UI.
+ /// The absolute path to the PKI store subfolder.
public static string GetPkiPath() => Path.Combine(GetRoot(), "pki");
///
@@ -45,6 +47,7 @@ public static class ClientStoragePaths
/// folder existed + was moved to canonical, false when no migration was needed or
/// canonical was already present.
///
+ /// when the legacy folder was found and moved; when no migration was needed.
public static bool TryRunLegacyMigration()
{
var localAppData = Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData);
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/IOpcUaClientService.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/IOpcUaClientService.cs
index 6990dde4..7659d27c 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/IOpcUaClientService.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/IOpcUaClientService.cs
@@ -24,12 +24,14 @@ public interface IOpcUaClientService : IDisposable
///
/// The endpoint, security, and authentication settings used to establish the session.
/// The cancellation token that aborts the connect workflow.
+ /// A describing the active session after a successful connect.
Task ConnectAsync(ConnectionSettings settings, CancellationToken ct = default);
///
/// Disconnects from the active OPC UA endpoint and tears down subscriptions owned by the client.
///
/// The cancellation token that aborts disconnect cleanup.
+ /// A task that represents the asynchronous operation.
Task DisconnectAsync(CancellationToken ct = default);
///
@@ -37,6 +39,7 @@ public interface IOpcUaClientService : IDisposable
///
/// The node whose value should be retrieved.
/// The cancellation token that aborts the read request.
+ /// The current including value, status code, and timestamps.
Task ReadValueAsync(NodeId nodeId, CancellationToken ct = default);
///
@@ -45,6 +48,7 @@ public interface IOpcUaClientService : IDisposable
/// The node whose value should be updated.
/// The raw value supplied by the CLI or UI workflow.
/// The cancellation token that aborts the write request.
+ /// The OPC UA returned by the server for the write operation.
Task WriteValueAsync(NodeId nodeId, object value, CancellationToken ct = default);
///
@@ -52,6 +56,7 @@ public interface IOpcUaClientService : IDisposable
///
/// The node to browse, or when omitted.
/// The cancellation token that aborts the browse request.
+ /// The list of child nodes discovered under the specified parent.
Task> BrowseAsync(NodeId? parentNodeId = null, CancellationToken ct = default);
///
@@ -60,6 +65,7 @@ public interface IOpcUaClientService : IDisposable
/// The node whose value changes should be monitored.
/// The monitored-item sampling and publishing interval in milliseconds.
/// The cancellation token that aborts subscription creation.
+ /// A task that represents the asynchronous operation.
Task SubscribeAsync(NodeId nodeId, int intervalMs = 1000, CancellationToken ct = default);
///
@@ -67,6 +73,7 @@ public interface IOpcUaClientService : IDisposable
///
/// The node whose live-data subscription should be removed.
/// The cancellation token that aborts the unsubscribe request.
+ /// A task that represents the asynchronous operation.
Task UnsubscribeAsync(NodeId nodeId, CancellationToken ct = default);
///
@@ -75,18 +82,21 @@ public interface IOpcUaClientService : IDisposable
/// The event source to monitor, or the server object when omitted.
/// The publishing interval in milliseconds for the alarm subscription.
/// The cancellation token that aborts alarm subscription creation.
+ /// A task that represents the asynchronous operation.
Task SubscribeAlarmsAsync(NodeId? sourceNodeId = null, int intervalMs = 1000, CancellationToken ct = default);
///
/// Removes the active alarm subscription.
///
/// The cancellation token that aborts alarm subscription cleanup.
+ /// A task that represents the asynchronous operation.
Task UnsubscribeAlarmsAsync(CancellationToken ct = default);
///
/// Requests retained alarm conditions again so a client can repopulate its alarm list after reconnecting.
///
/// The cancellation token that aborts the condition refresh request.
+ /// A task that represents the asynchronous operation.
Task RequestConditionRefreshAsync(CancellationToken ct = default);
///
@@ -111,6 +121,7 @@ public interface IOpcUaClientService : IDisposable
/// The inclusive end of the requested history range.
/// The maximum number of raw values to return.
/// The cancellation token that aborts the history read.
+ /// The raw historical samples in the requested range.
Task> HistoryReadRawAsync(NodeId nodeId, DateTime startTime, DateTime endTime,
int maxValues = 1000, CancellationToken ct = default);
@@ -123,6 +134,7 @@ public interface IOpcUaClientService : IDisposable
/// The aggregate function the operator selected for processed history.
/// The processing interval, in milliseconds, for each aggregate bucket.
/// The cancellation token that aborts the processed history request.
+ /// The processed historical samples computed by the requested aggregate.
Task> HistoryReadAggregateAsync(NodeId nodeId, DateTime startTime, DateTime endTime,
AggregateType aggregate, double intervalMs = 3600000, CancellationToken ct = default);
@@ -130,6 +142,7 @@ public interface IOpcUaClientService : IDisposable
/// Reads redundancy status data such as redundancy mode, service level, and partner endpoint URIs.
///
/// The cancellation token that aborts redundancy inspection.
+ /// A snapshot containing redundancy mode, service level, and partner endpoint URIs.
Task GetRedundancyInfoAsync(CancellationToken ct = default);
///
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/OpcUaClientService.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/OpcUaClientService.cs
index 57a6ac70..6df7eb85 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/OpcUaClientService.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.Shared/OpcUaClientService.cs
@@ -73,13 +73,13 @@ public sealed class OpcUaClientService : IOpcUaClientService
{
}
- ///
+ /// Raised when subscribed node values change.
public event EventHandler? DataChanged;
- ///
+ /// Raised when an alarm event is received from the server.
public event EventHandler? AlarmEvent;
- ///
+ /// Raised when the connection state changes.
public event EventHandler? ConnectionStateChanged;
///
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/AvaloniaUiDispatcher.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/AvaloniaUiDispatcher.cs
index 13275830..e74c0cb2 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/AvaloniaUiDispatcher.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/AvaloniaUiDispatcher.cs
@@ -7,8 +7,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.UI.Services;
///
public sealed class AvaloniaUiDispatcher : IUiDispatcher
{
- /// Posts an action to the Avalonia UI thread for execution.
- /// The action to execute on the UI thread.
+ ///
public void Post(Action action)
{
Dispatcher.UIThread.Post(action);
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/ISettingsService.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/ISettingsService.cs
index f95c56c0..90cb9516 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/ISettingsService.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/ISettingsService.cs
@@ -6,6 +6,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.UI.Services;
public interface ISettingsService
{
/// Loads user settings from persistent storage.
+ /// The persisted , or a default instance if none are saved.
UserSettings Load();
/// Saves user settings to persistent storage.
/// The settings to save.
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/JsonSettingsService.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/JsonSettingsService.cs
index 2f793cad..97764de9 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/JsonSettingsService.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/JsonSettingsService.cs
@@ -19,8 +19,7 @@ public sealed class JsonSettingsService : ISettingsService
WriteIndented = true
};
- /// Loads user settings from the settings file.
- /// The loaded user settings, or a new default instance if load fails.
+ ///
public UserSettings Load()
{
try
@@ -37,8 +36,7 @@ public sealed class JsonSettingsService : ISettingsService
}
}
- /// Saves user settings to the settings file.
- /// The user settings to save.
+ ///
public void Save(UserSettings settings)
{
try
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/SynchronousUiDispatcher.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/SynchronousUiDispatcher.cs
index 06c5f6bc..7744cc3e 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/SynchronousUiDispatcher.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/Services/SynchronousUiDispatcher.cs
@@ -6,8 +6,7 @@ namespace ZB.MOM.WW.OtOpcUa.Client.UI.Services;
///
public sealed class SynchronousUiDispatcher : IUiDispatcher
{
- /// Executes the action synchronously on the calling thread.
- /// The action to execute.
+ ///
public void Post(Action action)
{
action();
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/AlarmsViewModel.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/AlarmsViewModel.cs
index f7033901..3589793e 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/AlarmsViewModel.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/AlarmsViewModel.cs
@@ -195,6 +195,7 @@ public partial class AlarmsViewModel : ObservableObject
///
/// Returns the monitored node ID for persistence, or null if not subscribed.
///
+ /// The monitored node ID string, or null if not currently subscribed.
public string? GetAlarmSourceNodeId()
{
return IsSubscribed ? MonitoredNodeIdText : null;
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/BrowseTreeViewModel.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/BrowseTreeViewModel.cs
index 6ca20cbf..c3c60b8e 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/BrowseTreeViewModel.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/BrowseTreeViewModel.cs
@@ -30,6 +30,7 @@ public class BrowseTreeViewModel : ObservableObject
///
/// Loads root nodes by browsing with a null parent.
///
+ /// A task that represents the asynchronous operation.
public async Task LoadRootsAsync()
{
var results = await _service.BrowseAsync();
diff --git a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/SubscriptionsViewModel.cs b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/SubscriptionsViewModel.cs
index 612ed752..c21bfd8f 100644
--- a/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/SubscriptionsViewModel.cs
+++ b/src/Client/ZB.MOM.WW.OtOpcUa.Client.UI/ViewModels/SubscriptionsViewModel.cs
@@ -143,6 +143,7 @@ public partial class SubscriptionsViewModel : ObservableObject
///
/// The node ID to subscribe to from the browse tree or persisted settings.
/// The monitored-item interval, in milliseconds, for the subscription.
+ /// A task that represents the asynchronous operation.
public async Task AddSubscriptionForNodeAsync(string nodeIdStr, int intervalMs = 1000)
{
if (!IsConnected || string.IsNullOrWhiteSpace(nodeIdStr)) return;
@@ -176,6 +177,7 @@ public partial class SubscriptionsViewModel : ObservableObject
/// The root node whose variables should be subscribed recursively.
/// The node class of the starting node so variables can be subscribed immediately.
/// The monitored-item interval, in milliseconds, used for created subscriptions.
+ /// A task that represents the asynchronous operation.
public Task AddSubscriptionRecursiveAsync(string nodeIdStr, string nodeClass, int intervalMs = 1000)
{
return AddSubscriptionRecursiveAsync(nodeIdStr, nodeClass, intervalMs, maxDepth: 10, currentDepth: 0);
@@ -211,6 +213,7 @@ public partial class SubscriptionsViewModel : ObservableObject
///
/// Returns the node IDs of all active subscriptions for persistence.
///
+ /// The list of node ID strings for all currently active subscriptions.
public List GetSubscribedNodeIds()
{
return ActiveSubscriptions.Select(s => s.NodeId).ToList();
@@ -220,6 +223,7 @@ public partial class SubscriptionsViewModel : ObservableObject
/// Restores subscriptions from a saved list of node IDs.
///
/// The node IDs persisted from a prior UI session.
+ /// A task that represents the asynchronous operation.
public async Task RestoreSubscriptionsAsync(IEnumerable nodeIds)
{
foreach (var nodeId in nodeIds)
@@ -232,6 +236,7 @@ public partial class SubscriptionsViewModel : ObservableObject
///
/// The node ID the operator wants to write.
/// The raw text value entered by the operator.
+ /// A tuple of (success flag, operator-readable message) describing the outcome of the write.
public async Task<(bool Success, string Message)> ValidateAndWriteAsync(string nodeIdStr, string rawValue)
{
try
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ClusterRoleInfo.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ClusterRoleInfo.cs
index 512be105..0861220d 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ClusterRoleInfo.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ClusterRoleInfo.cs
@@ -43,20 +43,16 @@ public sealed class ClusterRoleInfo : IClusterRoleInfo, IDisposable
_subscriber = system.ActorOf(Props.Create(() => new SubscriberActor(this)), "clusterroleinfo-subscriber");
}
- /// Gets the local cluster node identifier.
+ ///
public CommonsNodeId LocalNode => _localNode;
- /// Gets the set of roles assigned to the local node.
+ ///
public IReadOnlySet LocalRoles => _localRoles;
- /// Checks if the local node has a specific role.
- /// The role name to check.
- /// True if the local node has the specified role; otherwise false.
+ ///
public bool HasRole(string role) => _localRoles.Contains(role);
- /// Gets all cluster members that have a specific role.
- /// The role name.
- /// A read-only list of node IDs with the specified role.
+ ///
public IReadOnlyList MembersWithRole(string role)
{
lock (_lock)
@@ -68,9 +64,7 @@ public sealed class ClusterRoleInfo : IClusterRoleInfo, IDisposable
}
}
- /// Gets the current leader node for a specific role.
- /// The role name.
- /// The node ID of the current role leader, or null if no leader is elected.
+ ///
public CommonsNodeId? RoleLeader(string role)
{
lock (_lock)
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/RoleParser.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/RoleParser.cs
index a2de2290..ff6a52a8 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/RoleParser.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/RoleParser.cs
@@ -9,6 +9,7 @@ public static class RoleParser
/// Parses a comma-separated string of role names into a validated array.
/// The raw role string to parse.
+ /// An array of validated, distinct, lower-cased role names; empty array when the input is null or whitespace.
public static string[] Parse(string? raw)
{
if (string.IsNullOrWhiteSpace(raw)) return Array.Empty();
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ServiceCollectionExtensions.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ServiceCollectionExtensions.cs
index e2bab992..c4c6b348 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ServiceCollectionExtensions.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Cluster/ServiceCollectionExtensions.cs
@@ -18,6 +18,7 @@ public static class ServiceCollectionExtensions
///
/// The service collection to configure.
/// The application configuration containing cluster options.
+ /// The same for chaining.
public static IServiceCollection AddOtOpcUaCluster(this IServiceCollection services, IConfiguration configuration)
{
services.AddOptions()
@@ -45,6 +46,7 @@ public static class ServiceCollectionExtensions
///
/// The Akka configuration builder to configure.
/// The service provider for resolving cluster options.
+ /// The same for chaining.
public static AkkaConfigurationBuilder WithOtOpcUaClusterBootstrap(
this AkkaConfigurationBuilder builder,
IServiceProvider serviceProvider)
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IBrowseSession.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IBrowseSession.cs
index a470b7e2..38326b0f 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IBrowseSession.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IBrowseSession.cs
@@ -16,14 +16,22 @@ public interface IBrowseSession : IAsyncDisposable
DateTime LastUsedUtc { get; }
/// Returns the top-level browse nodes.
+ /// Cancellation token for the operation.
+ /// A task that resolves to the list of top-level browse nodes.
Task> RootAsync(CancellationToken cancellationToken);
/// Returns the direct children of the node identified by
/// .
+ /// The identifier of the node whose children to expand.
+ /// Cancellation token for the operation.
+ /// A task that resolves to the list of direct child nodes.
Task> ExpandAsync(string nodeId, CancellationToken cancellationToken);
/// Returns the attributes of the node identified by .
/// Empty for drivers whose tree is uniform (OPC UA Client). Galaxy uses this to populate
/// the attribute side-panel after the user selects an object.
+ /// The identifier of the node whose attributes to retrieve.
+ /// Cancellation token for the operation.
+ /// A task that resolves to the list of attribute descriptors for the node.
Task> AttributesAsync(string nodeId, CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IDriverBrowser.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IDriverBrowser.cs
index 80f80375..44a396f1 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IDriverBrowser.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Browsing/IDriverBrowser.cs
@@ -15,5 +15,6 @@ public interface IDriverBrowser
/// Driver options serialized as JSON; same shape the runtime
/// driver would consume.
/// Cancellation for the connect phase only.
+ /// A task containing the opened browse session.
Task OpenAsync(string configJson, CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IAlarmActorStateStore.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IAlarmActorStateStore.cs
index 56b195a4..3528d989 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IAlarmActorStateStore.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IAlarmActorStateStore.cs
@@ -18,6 +18,7 @@ public interface IAlarmActorStateStore
/// Saves the alarm actor state snapshot.
/// The state snapshot to persist.
/// Cancellation token.
+ /// A task that represents the asynchronous operation.
Task SaveAsync(AlarmActorStateSnapshot snapshot, CancellationToken ct);
}
@@ -41,14 +42,10 @@ public sealed class NullAlarmActorStateStore : IAlarmActorStateStore
{
public static readonly NullAlarmActorStateStore Instance = new();
private NullAlarmActorStateStore() { }
- /// Always returns null, indicating no persisted state.
- /// The alarm identifier (unused).
- /// Cancellation token (unused).
+ ///
public Task LoadAsync(string alarmId, CancellationToken ct) =>
Task.FromResult(null);
- /// Completes immediately without persisting anything.
- /// The state snapshot (ignored).
- /// Cancellation token (unused).
+ ///
public Task SaveAsync(AlarmActorStateSnapshot snapshot, CancellationToken ct) =>
Task.CompletedTask;
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IVirtualTagEvaluator.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IVirtualTagEvaluator.cs
index 023b48cf..78d5ff4a 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IVirtualTagEvaluator.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Engines/IVirtualTagEvaluator.cs
@@ -43,11 +43,7 @@ public sealed class NullVirtualTagEvaluator : IVirtualTagEvaluator
{
public static readonly NullVirtualTagEvaluator Instance = new();
private NullVirtualTagEvaluator() { }
- /// Returns for every evaluation.
- /// The virtual tag identifier (ignored).
- /// The expression string (ignored).
- /// The variable dependencies (ignored).
- /// Always returns .
+ ///
public VirtualTagEvalResult Evaluate(string virtualTagId, string expression, IReadOnlyDictionary dependencies)
=> VirtualTagEvalResult.NoChange;
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IAdminOperationsClient.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IAdminOperationsClient.cs
index be992f84..5ce41bb8 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IAdminOperationsClient.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IAdminOperationsClient.cs
@@ -23,5 +23,6 @@ public interface IAdminOperationsClient
/// Expected reply type.
/// The message to send.
/// Cancellation token (caller-controlled timeout).
+ /// A task that resolves to the reply of type .
Task AskAsync(object message, CancellationToken ct);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IFleetDiagnosticsClient.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IFleetDiagnosticsClient.cs
index 262cf795..db6fda4e 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IFleetDiagnosticsClient.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Interfaces/IFleetDiagnosticsClient.cs
@@ -11,5 +11,6 @@ public interface IFleetDiagnosticsClient
/// Gets diagnostics for the specified node.
/// The node ID to retrieve diagnostics for.
/// The cancellation token.
+ /// A task that resolves to the diagnostics snapshot for the specified node.
Task GetDiagnosticsAsync(NodeId nodeId, CancellationToken ct);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Observability/OtOpcUaTelemetry.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Observability/OtOpcUaTelemetry.cs
index 1a284860..fa5a2552 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Observability/OtOpcUaTelemetry.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Observability/OtOpcUaTelemetry.cs
@@ -69,6 +69,7 @@ public static class OtOpcUaTelemetry
/// null when no listener is attached so the call site stays cheap on undecorated builds.
///
/// The deployment identifier to tag the span with.
+ /// The started , or null when no listener is attached.
public static Activity? StartDeployApplySpan(string deploymentId)
{
var activity = ActivitySource.StartActivity("otopcua.deploy.apply", ActivityKind.Internal);
@@ -77,6 +78,7 @@ public static class OtOpcUaTelemetry
}
/// Span wrapping a full OPC UA address-space rebuild (Phase7 plan → apply).
+ /// The started , or null when no listener is attached.
public static Activity? StartAddressSpaceRebuildSpan()
=> ActivitySource.StartActivity("otopcua.opcua.address_space_rebuild", ActivityKind.Internal);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredAddressSpaceSink.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredAddressSpaceSink.cs
index 3bb7e934..6f3ecea8 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredAddressSpaceSink.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredAddressSpaceSink.cs
@@ -22,37 +22,22 @@ public sealed class DeferredAddressSpaceSink : IOpcUaAddressSpaceSink
public void SetSink(IOpcUaAddressSpaceSink? sink) =>
_inner = sink ?? NullOpcUaAddressSpaceSink.Instance;
- /// Writes a value to the OPC UA address space through the inner sink.
- /// The node ID of the variable.
- /// The value to write.
- /// The OPC UA quality value.
- /// The source timestamp in UTC.
+ ///
public void WriteValue(string nodeId, object? value, OpcUaQuality quality, DateTime sourceTimestampUtc)
=> _inner.WriteValue(nodeId, value, quality, sourceTimestampUtc);
- /// Writes an alarm state through the inner sink.
- /// The node ID of the alarm condition.
- /// Whether the alarm is active.
- /// Whether the alarm has been acknowledged.
- /// The source timestamp in UTC.
+ ///
public void WriteAlarmState(string alarmNodeId, bool active, bool acknowledged, DateTime sourceTimestampUtc)
=> _inner.WriteAlarmState(alarmNodeId, active, acknowledged, sourceTimestampUtc);
- /// Ensures a folder exists in the address space through the inner sink.
- /// The node ID of the folder.
- /// The node ID of the parent folder, or null for root.
- /// The display name of the folder.
+ ///
public void EnsureFolder(string folderNodeId, string? parentNodeId, string displayName)
=> _inner.EnsureFolder(folderNodeId, parentNodeId, displayName);
- /// Ensures a variable exists in the address space through the inner sink.
- /// The node ID of the variable.
- /// The node ID of the parent folder, or null for root.
- /// The display name of the variable.
- /// The OPC UA data type of the variable.
+ ///
public void EnsureVariable(string variableNodeId, string? parentFolderNodeId, string displayName, string dataType)
=> _inner.EnsureVariable(variableNodeId, parentFolderNodeId, displayName, dataType);
- /// Rebuilds the address space through the inner sink.
+ ///
public void RebuildAddressSpace() => _inner.RebuildAddressSpace();
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredServiceLevelPublisher.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredServiceLevelPublisher.cs
index eb227979..f567d9ec 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredServiceLevelPublisher.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/OpcUa/DeferredServiceLevelPublisher.cs
@@ -16,7 +16,6 @@ public sealed class DeferredServiceLevelPublisher : IServiceLevelPublisher
public void SetInner(IServiceLevelPublisher? inner) =>
_inner = inner ?? NullServiceLevelPublisher.Instance;
- /// Publishes a service level value to the inner publisher.
- /// The service level to publish.
+ ///
public void Publish(byte serviceLevel) => _inner.Publish(serviceLevel);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Types/CorrelationId.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Types/CorrelationId.cs
index fbf9dc06..6cc827a1 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Types/CorrelationId.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Commons/Types/CorrelationId.cs
@@ -3,15 +3,18 @@ namespace ZB.MOM.WW.OtOpcUa.Commons.Types;
public readonly record struct CorrelationId(Guid Value)
{
/// Creates a new CorrelationId with a randomly generated GUID.
+ /// A new backed by a random GUID.
public static CorrelationId NewId() => new(Guid.NewGuid());
///
public override string ToString() => Value.ToString("N");
/// Parses a lowercase hex string without hyphens into a CorrelationId.
/// The string to parse.
+ /// A parsed from the supplied string.
public static CorrelationId Parse(string s) => new(Guid.ParseExact(s, "N"));
/// Attempts to parse a lowercase hex string without hyphens into a CorrelationId.
/// The string to parse, or null.
/// The resulting CorrelationId if parsing succeeds.
+ /// if parsing succeeded; otherwise .
public static bool TryParse(string? s, out CorrelationId id)
{
if (Guid.TryParseExact(s, "N", out var g)) { id = new CorrelationId(g); return true; }
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/ILocalConfigCache.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/ILocalConfigCache.cs
index fc92d9ec..c1618321 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/ILocalConfigCache.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/ILocalConfigCache.cs
@@ -21,10 +21,12 @@ public interface ILocalConfigCache
/// Stores a generation snapshot in the local cache.
/// The generation snapshot to store.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
Task PutAsync(GenerationSnapshot snapshot, CancellationToken ct = default);
/// Removes old generations, keeping only the most recent N.
/// The cluster identifier.
/// The number of latest generations to keep.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
Task PruneOldGenerationsAsync(string clusterId, int keepLatest = 10, CancellationToken ct = default);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/LiteDbConfigCache.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/LiteDbConfigCache.cs
index 39e5dfb4..12deb1eb 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/LiteDbConfigCache.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/LocalCache/LiteDbConfigCache.cs
@@ -45,9 +45,7 @@ public sealed class LiteDbConfigCache : ILocalConfigCache, IDisposable
}
}
- /// Gets the most recent snapshot for the specified cluster.
- /// The cluster ID.
- /// Cancellation token.
+ ///
public Task GetMostRecentAsync(string clusterId, CancellationToken ct = default)
{
ct.ThrowIfCancellationRequested();
@@ -58,9 +56,7 @@ public sealed class LiteDbConfigCache : ILocalConfigCache, IDisposable
return Task.FromResult(snapshot);
}
- /// Stores a snapshot in the cache.
- /// The snapshot to store.
- /// Cancellation token.
+ ///
public async Task PutAsync(GenerationSnapshot snapshot, CancellationToken ct = default)
{
ct.ThrowIfCancellationRequested();
@@ -89,10 +85,7 @@ public sealed class LiteDbConfigCache : ILocalConfigCache, IDisposable
}
}
- /// Removes old generation snapshots, keeping only the latest ones.
- /// The cluster ID.
- /// Number of latest generations to keep.
- /// Cancellation token.
+ ///
public Task PruneOldGenerationsAsync(string clusterId, int keepLatest = 10, CancellationToken ct = default)
{
ct.ThrowIfCancellationRequested();
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/ILdapGroupRoleMappingService.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/ILdapGroupRoleMappingService.cs
index a34f15fd..308f289f 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/ILdapGroupRoleMappingService.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/ILdapGroupRoleMappingService.cs
@@ -24,11 +24,13 @@ public interface ILdapGroupRoleMappingService
///
/// The LDAP groups to search for.
/// The cancellation token.
+ /// A task resolving to the list of mappings whose LDAP group matches any of the provided groups.
Task> GetByGroupsAsync(
IEnumerable ldapGroups, CancellationToken cancellationToken);
/// Enumerate every mapping; Admin UI listing only.
/// The cancellation token.
+ /// A task resolving to all LDAP group role mappings.
Task> ListAllAsync(CancellationToken cancellationToken);
/// Create a new grant.
@@ -39,11 +41,13 @@ public interface ILdapGroupRoleMappingService
///
/// The LDAP group role mapping to create.
/// The cancellation token.
+ /// A task resolving to the newly created with any DB-assigned values populated.
Task CreateAsync(LdapGroupRoleMapping row, CancellationToken cancellationToken);
/// Delete a mapping by its surrogate key.
/// The unique identifier of the mapping to delete.
/// The cancellation token.
+ /// A task that represents the asynchronous delete operation.
Task DeleteAsync(Guid id, CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/LdapGroupRoleMappingService.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/LdapGroupRoleMappingService.cs
index 283fadbc..c79809a4 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/LdapGroupRoleMappingService.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Services/LdapGroupRoleMappingService.cs
@@ -10,10 +10,7 @@ namespace ZB.MOM.WW.OtOpcUa.Configuration.Services;
///
public sealed class LdapGroupRoleMappingService(OtOpcUaConfigDbContext db) : ILdapGroupRoleMappingService
{
- /// Gets LDAP group role mappings for the specified groups.
- /// The LDAP group names to query.
- /// The cancellation token.
- /// The matching role mappings.
+ ///
public async Task> GetByGroupsAsync(
IEnumerable ldapGroups, CancellationToken cancellationToken)
{
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Validation/DraftValidator.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Validation/DraftValidator.cs
index 718485b8..19f4487c 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Validation/DraftValidator.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Configuration/Validation/DraftValidator.cs
@@ -21,6 +21,7 @@ public static class DraftValidator
/// Validates a draft snapshot and returns all validation errors found in a single pass.
///
/// The draft snapshot to validate.
+ /// A read-only list of all validation errors found; empty if the draft is valid.
public static IReadOnlyList Validate(DraftSnapshot draft)
{
var errors = new List();
@@ -147,6 +148,7 @@ public static class DraftValidator
/// Decision #125: EquipmentId = 'EQ-' + lowercase first 12 hex chars of the UUID.
/// The equipment UUID to derive the ID from.
+ /// The derived equipment ID string in the form EQ-xxxxxxxxxxxx.
public static string DeriveEquipmentId(Guid uuid) =>
"EQ-" + uuid.ToString("N")[..12].ToLowerInvariant();
@@ -203,6 +205,7 @@ public static class DraftValidator
///
/// The server cluster to validate.
/// The cluster nodes to validate against the cluster configuration.
+ /// A read-only list of all validation errors found; empty if the topology is valid.
public static IReadOnlyList ValidateClusterTopology(
ServerCluster cluster,
IReadOnlyList clusterNodes)
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/DriverTypeRegistry.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/DriverTypeRegistry.cs
index aa60242d..6c792556 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/DriverTypeRegistry.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/DriverTypeRegistry.cs
@@ -55,6 +55,7 @@ public sealed class DriverTypeRegistry
/// Look up a driver type by name. Throws if unknown.
/// The driver type name to look up.
+ /// The registered for the specified type name.
public DriverTypeMetadata Get(string driverType)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverType);
@@ -69,6 +70,7 @@ public sealed class DriverTypeRegistry
/// Try to look up a driver type by name. Returns null if unknown (no exception).
/// The driver type name to look up.
+ /// The matching , or null if not registered.
public DriverTypeMetadata? TryGet(string driverType)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverType);
@@ -76,6 +78,7 @@ public sealed class DriverTypeRegistry
}
/// Snapshot of all registered driver types.
+ /// A read-only collection of all currently registered driver type metadata entries.
public IReadOnlyCollection All() => _types.Values.ToList();
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/Historian/IHistorianDataSource.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/Historian/IHistorianDataSource.cs
index 0f234500..d6895225 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/Historian/IHistorianDataSource.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/Historian/IHistorianDataSource.cs
@@ -28,6 +28,7 @@ public interface IHistorianDataSource : IDisposable
/// The end of the time range in UTC.
/// The maximum number of values to return per node.
/// A cancellation token that can be used to cancel the operation.
+ /// A task resolving to a containing the raw samples.
Task ReadRawAsync(
string fullReference,
DateTime startUtc,
@@ -46,6 +47,7 @@ public interface IHistorianDataSource : IDisposable
/// The interval for bucketing samples.
/// The aggregation function to apply to each bucket.
/// A cancellation token that can be used to cancel the operation.
+ /// A task resolving to a containing the processed interval samples.
Task ReadProcessedAsync(
string fullReference,
DateTime startUtc,
@@ -63,6 +65,7 @@ public interface IHistorianDataSource : IDisposable
/// The full reference of the tag to read.
/// The list of timestamps to read values at.
/// A cancellation token that can be used to cancel the operation.
+ /// A task resolving to a with one sample per requested timestamp.
Task ReadAtTimeAsync(
string fullReference,
IReadOnlyList timestampsUtc,
@@ -93,6 +96,7 @@ public interface IHistorianDataSource : IDisposable
/// The end of the time range in UTC.
/// The maximum number of events to return, or a non-positive value to use the default backend cap.
/// A cancellation token that can be used to cancel the operation.
+ /// A task resolving to a containing historical alarm and event records.
Task ReadEventsAsync(
string? sourceName,
DateTime startUtc,
@@ -104,5 +108,6 @@ public interface IHistorianDataSource : IDisposable
/// Point-in-time health snapshot for diagnostics and dashboards. Pure
/// observation; never blocks on backend I/O.
///
+ /// The current for this data source.
HistorianHealthSnapshot GetHealthSnapshot();
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAddressSpaceBuilder.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAddressSpaceBuilder.cs
index 85118c95..33e6183f 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAddressSpaceBuilder.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAddressSpaceBuilder.cs
@@ -18,6 +18,7 @@ public interface IAddressSpaceBuilder
///
/// OPC UA browse name (the segment of the path under the parent).
/// Human-readable display name. May equal .
+ /// A child builder scoped to inside this folder.
IAddressSpaceBuilder Folder(string browseName, string displayName);
///
@@ -27,6 +28,7 @@ public interface IAddressSpaceBuilder
/// OPC UA browse name (the segment of the path under the parent folder).
/// Human-readable display name. May equal .
/// Driver-side metadata for the variable.
+ /// An opaque handle for the registered variable.
IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo);
///
@@ -56,6 +58,7 @@ public interface IVariableHandle
/// Acknowledge, Deactivate).
///
/// The alarm condition information.
+ /// A sink that receives alarm lifecycle transitions for this condition.
IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAlarmSource.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAlarmSource.cs
index fa66e5a4..1bcbf0d5 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAlarmSource.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IAlarmSource.cs
@@ -13,6 +13,7 @@ public interface IAlarmSource
///
/// The driver node IDs to subscribe to.
/// Cancellation token for the operation.
+ /// A task that resolves to an opaque for the new subscription.
Task SubscribeAlarmsAsync(
IReadOnlyList sourceNodeIds,
CancellationToken cancellationToken);
@@ -20,11 +21,13 @@ public interface IAlarmSource
/// Cancel an alarm subscription returned by .
/// The subscription handle returned from .
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task UnsubscribeAlarmsAsync(IAlarmSubscriptionHandle handle, CancellationToken cancellationToken);
/// Acknowledge one or more active alarms by source node ID + condition ID.
/// The batch of alarm acknowledgement requests.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task AcknowledgeAsync(
IReadOnlyList acknowledgements,
CancellationToken cancellationToken);
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriver.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriver.cs
index 9e07ee25..646a22b9 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriver.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriver.cs
@@ -23,6 +23,7 @@ public interface IDriver
/// Initialize the driver from its DriverConfig JSON; open connections; prepare for first use.
/// The driver configuration as JSON.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task InitializeAsync(string driverConfigJson, CancellationToken cancellationToken);
///
@@ -37,13 +38,16 @@ public interface IDriver
///
/// The driver configuration as JSON.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken);
/// Stop the driver, close connections, release resources. Called on shutdown or driver removal.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task ShutdownAsync(CancellationToken cancellationToken);
/// Current health snapshot, polled by Core for the status dashboard and ServiceLevel.
+ /// The current driver health snapshot.
DriverHealth GetHealth();
///
@@ -56,6 +60,7 @@ public interface IDriver
/// allocation tracking". Tier C drivers (process-isolated) report through the same
/// interface but the cache-flush is internal to their host.
///
+ /// The approximate driver-attributable memory footprint in bytes.
long GetMemoryFootprint();
///
@@ -63,5 +68,6 @@ public interface IDriver
/// Required-for-correctness state must NOT be flushed.
///
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task FlushOptionalCachesAsync(CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverFactory.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverFactory.cs
index ab154e30..e27fd6a9 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverFactory.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverFactory.cs
@@ -34,12 +34,8 @@ public sealed class NullDriverFactory : IDriverFactory
public static readonly NullDriverFactory Instance = new();
private NullDriverFactory() { }
- /// Creates a driver (always returns null in this null implementation).
- /// The driver type name.
- /// The driver instance identifier.
- /// The driver configuration as a JSON string.
- /// Always returns null.
+ ///
public IDriver? TryCreate(string driverType, string driverInstanceId, string driverConfigJson) => null;
- /// Gets the collection of supported driver types (empty in this null implementation).
+ ///
public IReadOnlyCollection SupportedTypes { get; } = Array.Empty();
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverHealthPublisher.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverHealthPublisher.cs
index fa2516db..bfe43c4d 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverHealthPublisher.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverHealthPublisher.cs
@@ -11,6 +11,10 @@ public interface IDriverHealthPublisher
/// Publishes a health snapshot for one driver instance. Implementations must be
/// non-blocking and tolerant of being called from any thread.
///
+ /// The cluster identifier the driver instance belongs to.
+ /// The unique identifier of the driver instance.
+ /// The current health state of the driver instance.
+ /// Number of errors recorded in the past 5 minutes.
void Publish(
string clusterId,
string driverInstanceId,
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverProbe.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverProbe.cs
index 2043f3cf..5815ae5c 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverProbe.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverProbe.cs
@@ -17,6 +17,10 @@ public interface IDriverProbe
/// timeout cancellation. Never throw on connection failure; instead return a result
/// with Ok = false + a message.
///
+ /// Driver configuration JSON; same shape the runtime driver consumes.
+ /// Maximum duration for the probe attempt.
+ /// Cancellation token for the probe operation.
+ /// A task containing the probe result with success status and optional latency.
Task ProbeAsync(string configJson, TimeSpan timeout, CancellationToken ct);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverSupervisor.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverSupervisor.cs
index 0e072712..33e5b160 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverSupervisor.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IDriverSupervisor.cs
@@ -22,5 +22,6 @@ public interface IDriverSupervisor
///
/// Human-readable reason — flows into the supervisor's logs.
/// Cancels the recycle request; an in-flight restart is not interrupted.
+ /// A task that represents the asynchronous operation.
Task RecycleAsync(string reason, CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHistoryProvider.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHistoryProvider.cs
index 70e089bd..173e3026 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHistoryProvider.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHistoryProvider.cs
@@ -94,6 +94,7 @@ public interface IHistoryProvider
/// HistorianDataSource). The asymmetry is intentional — Core.Abstractions-006.
///
/// Request cancellation.
+ /// A task that resolves to the historical events result for the requested window.
///
/// Default implementation throws. Only drivers with an event historian (Galaxy via the
/// Wonderware Alarm & Events log) override. Modbus / the OPC UA Client driver stay
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHostConnectivityProbe.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHostConnectivityProbe.cs
index 3a446b1d..e712ca9b 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHostConnectivityProbe.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IHostConnectivityProbe.cs
@@ -16,6 +16,7 @@ public interface IHostConnectivityProbe
/// Snapshot of host-level connectivity. The Core uses this to drive Bad-quality
/// fan-out scoped to the affected host's subtree (not the whole driver namespace).
///
+ /// A snapshot list of per-host connectivity statuses.
IReadOnlyList GetHostStatuses();
/// Fired when a host transitions Running ↔ Stopped (or similar lifecycle change).
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/ITagDiscovery.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/ITagDiscovery.cs
index e66f3a9e..87b02f80 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/ITagDiscovery.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/ITagDiscovery.cs
@@ -13,5 +13,6 @@ public interface ITagDiscovery
///
/// The address space builder to stream discovered nodes into.
/// A cancellation token for the discovery operation.
+ /// A task that represents the asynchronous discovery operation.
Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IWritable.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IWritable.cs
index 4abf60e4..75f69c3c 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IWritable.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/IWritable.cs
@@ -19,6 +19,7 @@ public interface IWritable
///
/// Pairs of full reference + value to write.
/// Cancellation token; the driver should abort the batch if cancelled.
+ /// A task that resolves to one per requested write, in the same order.
Task> WriteAsync(
IReadOnlyList writes,
CancellationToken cancellationToken);
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/PollGroupEngine.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/PollGroupEngine.cs
index f8c54378..ed526ca5 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/PollGroupEngine.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Abstractions/PollGroupEngine.cs
@@ -41,6 +41,7 @@ public sealed class PollGroupEngine : IAsyncDisposable
/// Default floor for publishing intervals — matches the Modbus 100 ms cap.
public static readonly TimeSpan DefaultMinInterval = TimeSpan.FromMilliseconds(100);
+ /// Initializes a new poll-group engine with the supplied reader, change callback, interval floor, and optional error sink.
/// Driver-supplied batch reader; snapshots MUST be returned in the same
/// order as the input references.
/// Callback invoked per changed tag — the driver forwards to its own
@@ -68,6 +69,7 @@ public sealed class PollGroupEngine : IAsyncDisposable
/// Register a new polled subscription and start its background loop.
/// The list of tag references to poll.
/// The desired polling interval; will be clamped to the configured minimum.
+ /// A subscription handle that can be passed to to cancel the loop.
public ISubscriptionHandle Subscribe(IReadOnlyList fullReferences, TimeSpan publishingInterval)
{
ArgumentNullException.ThrowIfNull(fullReferences);
@@ -207,6 +209,7 @@ public sealed class PollGroupEngine : IAsyncDisposable
}
/// Cancel every active subscription and await all loop tasks. Idempotent.
+ /// A value task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
// Cancel all loops first so they can all start winding down in parallel.
@@ -253,7 +256,7 @@ public sealed class PollGroupEngine : IAsyncDisposable
private sealed record PollSubscriptionHandle(long Id) : ISubscriptionHandle
{
- /// Gets a diagnostic identifier for this subscription.
+ ///
public string DiagnosticId => $"poll-sub-{Id}";
}
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/IAlarmHistorianSink.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/IAlarmHistorianSink.cs
index 8fc95c86..bcb2b4a7 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/IAlarmHistorianSink.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/IAlarmHistorianSink.cs
@@ -26,9 +26,11 @@ public interface IAlarmHistorianSink
/// Durably enqueue the event. Returns as soon as the queue row is committed.
/// The alarm historian event to enqueue.
/// A cancellation token for async operations.
+ /// A task that represents the asynchronous enqueue operation.
Task EnqueueAsync(AlarmHistorianEvent evt, CancellationToken cancellationToken);
/// Snapshot of current queue depth + drain health.
+ /// A snapshot of the current queue depth and drain state.
HistorianSinkStatus GetStatus();
}
@@ -97,6 +99,7 @@ public interface IAlarmHistorianWriter
/// Push a batch of events to the historian. Returns one outcome per event, same order.
/// The batch of alarm historian events to write.
/// A cancellation token for async operations.
+ /// A task that resolves to one write outcome per event, in the same order as the batch.
Task> WriteBatchAsync(
IReadOnlyList batch, CancellationToken cancellationToken);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/SqliteStoreAndForwardSink.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/SqliteStoreAndForwardSink.cs
index f887990f..eb03013f 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/SqliteStoreAndForwardSink.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.AlarmHistorian/SqliteStoreAndForwardSink.cs
@@ -255,6 +255,7 @@ public sealed class SqliteStoreAndForwardSink : IAlarmHistorianSink, IDisposable
///
/// The alarm historian event to enqueue.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
public async Task EnqueueAsync(AlarmHistorianEvent evt, CancellationToken cancellationToken)
{
if (evt is null) throw new ArgumentNullException(nameof(evt));
@@ -345,6 +346,7 @@ public sealed class SqliteStoreAndForwardSink : IAlarmHistorianSink, IDisposable
/// connections per tick, each paying the open + PRAGMA cost.
///
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
public async Task DrainOnceAsync(CancellationToken ct)
{
if (_disposed) return;
@@ -490,7 +492,7 @@ public sealed class SqliteStoreAndForwardSink : IAlarmHistorianSink, IDisposable
}
}
- /// Gets the current status of the historian sink including queue depth and drain state.
+ ///
public HistorianSinkStatus GetStatus()
{
// Core.AlarmHistorian-008: read the non-dead-lettered count from the in-memory
@@ -534,6 +536,7 @@ public sealed class SqliteStoreAndForwardSink : IAlarmHistorianSink, IDisposable
}
/// Operator action from Admin UI — retry every dead-lettered row. Non-cascading: they rejoin the regular queue + get a fresh backoff.
+ /// The number of rows moved back to the active queue.
public int RetryDeadLettered()
{
using var conn = OpenConnection();
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.ScriptedAlarms/ScriptedAlarmEngine.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.ScriptedAlarms/ScriptedAlarmEngine.cs
index 700ec0bc..8c69dc43 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.ScriptedAlarms/ScriptedAlarmEngine.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.ScriptedAlarms/ScriptedAlarmEngine.cs
@@ -97,6 +97,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// copy under the gate. (Core.ScriptedAlarms-013.)
///
/// The alarm identifier to look up.
+ /// The live read-cache dictionary for the alarm, or if not yet allocated.
internal IReadOnlyDictionary? TryGetScratchReadCacheForTest(string alarmId)
=> _scratchByAlarmId.TryGetValue(alarmId, out var s) ? s.ReadCache : null;
@@ -113,6 +114,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// (Core.ScriptedAlarms-013.)
///
/// The alarm identifier to look up.
+ /// The reusable for the alarm, or if not yet allocated.
internal AlarmPredicateContext? TryGetScratchContextForTest(string alarmId)
=> _scratchByAlarmId.TryGetValue(alarmId, out var s) ? s.Context : null;
private readonly ConcurrentDictionary _valueCache
@@ -175,6 +177,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
///
/// The alarm definitions to load.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public async Task LoadAsync(IReadOnlyList definitions, CancellationToken ct)
{
if (_disposed) throw new ObjectDisposedException(nameof(ScriptedAlarmEngine));
@@ -306,10 +309,12 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// unknown alarm. Mainly used for diagnostics + the Admin UI status page.
///
/// The alarm identifier.
+ /// The current for the alarm, or if the alarm is unknown.
public AlarmConditionState? GetState(string alarmId)
=> _alarms.TryGetValue(alarmId, out var s) ? s.Condition : null;
/// Gets the current persisted state for all loaded alarms.
+ /// A snapshot collection of all current alarm condition states.
public IReadOnlyCollection GetAllStates()
=> _alarms.Values.Select(a => a.Condition).ToArray();
@@ -318,6 +323,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The user performing the acknowledgment.
/// An optional comment to attach to the acknowledgment.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task AcknowledgeAsync(string alarmId, string user, string? comment, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyAcknowledge(cur, user, comment, _clock()));
@@ -326,6 +332,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The user performing the confirmation.
/// An optional comment to attach to the confirmation.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task ConfirmAsync(string alarmId, string user, string? comment, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyConfirm(cur, user, comment, _clock()));
@@ -333,6 +340,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The alarm identifier.
/// The user performing the shelve operation.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task OneShotShelveAsync(string alarmId, string user, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyOneShotShelve(cur, user, _clock()));
@@ -341,6 +349,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The user performing the shelve operation.
/// The UTC time at which the shelve will automatically expire.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task TimedShelveAsync(string alarmId, string user, DateTime unshelveAtUtc, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyTimedShelve(cur, user, unshelveAtUtc, _clock()));
@@ -348,6 +357,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The alarm identifier.
/// The user performing the unshelve operation.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task UnshelveAsync(string alarmId, string user, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyUnshelve(cur, user, _clock()));
@@ -355,6 +365,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The alarm identifier.
/// The user performing the enable operation.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task EnableAsync(string alarmId, string user, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyEnable(cur, user, _clock()));
@@ -362,6 +373,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The alarm identifier.
/// The user performing the disable operation.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task DisableAsync(string alarmId, string user, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyDisable(cur, user, _clock()));
@@ -370,6 +382,7 @@ public sealed class ScriptedAlarmEngine : IDisposable
/// The user adding the comment.
/// The comment text.
/// The cancellation token.
+ /// A task that represents the asynchronous operation.
public Task AddCommentAsync(string alarmId, string user, string text, CancellationToken ct)
=> ApplyAsync(alarmId, ct, cur => Part9StateMachine.ApplyAddComment(cur, user, text, _clock()));
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/DependencyExtractor.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/DependencyExtractor.cs
index 819c0651..ebbeddca 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/DependencyExtractor.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/DependencyExtractor.cs
@@ -39,6 +39,7 @@ public static class DependencyExtractor
/// paths, or a list of rejection messages if non-literal paths were used.
///
/// The script source code to analyze.
+ /// The extracted dependency paths, or rejection messages for unsupported patterns.
public static DependencyExtractionResult Extract(string scriptSource)
{
if (string.IsNullOrWhiteSpace(scriptSource))
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptContext.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptContext.cs
index 8b1d0767..e245f151 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptContext.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptContext.cs
@@ -41,6 +41,7 @@ public abstract class ScriptContext
/// right upstream tags at load time.
///
/// The literal tag path to read.
+ /// The current for the tag, including value, quality, and timestamp.
public abstract DataValueSnapshot GetTag(string path);
///
@@ -81,6 +82,7 @@ public abstract class ScriptContext
/// The current value to check.
/// The previous value to compare against.
/// The minimum difference threshold for a change to be detected.
+ /// when the absolute difference between current and previous exceeds tolerance.
public static bool Deadband(double current, double previous, double tolerance)
=> Math.Abs(current - previous) > tolerance;
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptEvaluator.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptEvaluator.cs
index de482ede..ea508ca8 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptEvaluator.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptEvaluator.cs
@@ -66,6 +66,7 @@ public sealed class ScriptEvaluator : IDisposable
/// Compiles user script source into an evaluator.
/// The user script source code to compile.
+ /// A compiled ready to invoke.
public static ScriptEvaluator Compile(string scriptSource)
{
if (scriptSource is null) throw new ArgumentNullException(nameof(scriptSource));
@@ -173,6 +174,7 @@ public sealed class ScriptEvaluator : IDisposable
/// Runs the script against an already-constructed context.
/// The script context.
/// Cancellation token for the operation.
+ /// A task that resolves to the script's return value.
public Task RunAsync(TContext context, CancellationToken ct = default)
{
if (_disposed) throw new ObjectDisposedException(nameof(ScriptEvaluator));
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptSandbox.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptSandbox.cs
index aed728d0..5cf6fbde 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptSandbox.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.Scripting/ScriptSandbox.cs
@@ -43,6 +43,7 @@ public static class ScriptSandbox
/// to resolve ctx.GetTag(...) calls.
///
/// The concrete script context type to use for compilation.
+ /// The sandbox configuration for compiling scripts with the given context type.
public static SandboxConfig Build(Type contextType)
{
if (contextType is null) throw new ArgumentNullException(nameof(contextType));
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/DependencyGraph.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/DependencyGraph.cs
index e655196e..52d7b890 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/DependencyGraph.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/DependencyGraph.cs
@@ -156,6 +156,7 @@ public sealed class DependencyGraph
/// dependencies. Throws if any cycle
/// exists. Implemented via Kahn's algorithm.
///
+ /// A list of node IDs in topological evaluation order.
public IReadOnlyList TopologicalSort()
{
// Kahn's framing: edge u -> v means "u must come before v". For dependencies,
@@ -205,6 +206,7 @@ public sealed class DependencyGraph
/// Empty list means the graph is a DAG. Useful for surfacing every cycle in one
/// rejection pass so operators see all of them, not just one at a time.
///
+ /// A list of strongly-connected components that form cycles; empty if the graph is acyclic.
public IReadOnlyList> DetectCycles()
{
// Iterative Tarjan's SCC. Avoids recursion so deep graphs don't StackOverflow.
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/ITagUpstreamSource.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/ITagUpstreamSource.cs
index b6ba7612..dec9abd1 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/ITagUpstreamSource.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/ITagUpstreamSource.cs
@@ -30,6 +30,7 @@ public interface ITagUpstreamSource
/// when the path isn't configured.
///
/// The tag path to read.
+ /// The last-known value and quality snapshot for the tag.
DataValueSnapshot ReadTag(string path);
///
@@ -40,5 +41,6 @@ public interface ITagUpstreamSource
///
/// The tag path to subscribe to.
/// The callback to invoke when the value changes.
+ /// An that cancels the subscription when disposed.
IDisposable SubscribeTag(string path, Action observer);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/VirtualTagEngine.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/VirtualTagEngine.cs
index efd330fb..4cc929f6 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/VirtualTagEngine.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core.VirtualTags/VirtualTagEngine.cs
@@ -198,6 +198,7 @@ public sealed class VirtualTagEngine : IDisposable
/// default. Also called after a config reload.
///
/// Cancellation token to stop evaluation.
+ /// A task that represents the asynchronous operation.
public async Task EvaluateAllAsync(CancellationToken ct = default)
{
EnsureLoaded();
@@ -212,6 +213,7 @@ public sealed class VirtualTagEngine : IDisposable
/// Evaluate a single tag — used by the timer trigger + test hooks.
/// Path of the virtual tag to evaluate.
/// Cancellation token to stop evaluation.
+ /// A task that represents the asynchronous operation.
public Task EvaluateOneAsync(string path, CancellationToken ct = default)
{
EnsureLoaded();
@@ -226,6 +228,7 @@ public sealed class VirtualTagEngine : IDisposable
/// evaluation result.
///
/// Path of the tag to read.
+ /// The most recently cached value and quality for the tag path.
public DataValueSnapshot Read(string path)
{
if (string.IsNullOrWhiteSpace(path))
@@ -242,6 +245,7 @@ public sealed class VirtualTagEngine : IDisposable
///
/// Path of the tag to subscribe to.
/// Callback invoked with the tag path and new value on each evaluation.
+ /// An that cancels the subscription when disposed.
public IDisposable Subscribe(string path, Action observer)
{
// Race-safe pattern paired with Unsub.Dispose: if Unsub.Dispose removed the
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/AuthorizationDecision.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/AuthorizationDecision.cs
index 7050f75c..b811aaf3 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/AuthorizationDecision.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/AuthorizationDecision.cs
@@ -19,6 +19,7 @@ public sealed record AuthorizationDecision(
public bool IsAllowed => Verdict == AuthorizationVerdict.Allow;
/// Convenience constructor for the common "no grants matched" outcome.
+ /// An with and empty provenance.
public static AuthorizationDecision NotGranted() => new(AuthorizationVerdict.NotGranted, []);
/// Allow with the list of grants that matched.
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/IPermissionEvaluator.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/IPermissionEvaluator.cs
index ea96aeba..5e8ae98c 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/IPermissionEvaluator.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/IPermissionEvaluator.cs
@@ -22,5 +22,6 @@ public interface IPermissionEvaluator
/// The user session containing resolved LDAP groups and roles.
/// The OPC UA operation being requested.
/// The node address scope being accessed.
+ /// An indicating whether the operation is allowed.
AuthorizationDecision Authorize(UserAuthorizationState session, OpcUaOperation operation, NodeScope scope);
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrie.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrie.cs
index fc82204a..bfd1a339 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrie.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrie.cs
@@ -33,6 +33,7 @@ public sealed class PermissionTrie
///
/// The node scope to match permissions for.
/// The user's LDAP group memberships.
+ /// The list of grants that apply to the given scope for any of the session's LDAP groups.
public IReadOnlyList CollectMatches(NodeScope scope, IEnumerable ldapGroups)
{
ArgumentNullException.ThrowIfNull(scope);
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieBuilder.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieBuilder.cs
index 3e6fd838..a9cacec1 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieBuilder.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieBuilder.cs
@@ -41,6 +41,7 @@ public static class PermissionTrieBuilder
/// Core-011 production hazard. The callback fires only when
/// is non-null (a null lookup is the explicit deterministic-test fallback mode).
///
+ /// An immutable for the given cluster and generation.
public static PermissionTrie Build(
string clusterId,
long generationId,
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieCache.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieCache.cs
index 47161e0a..f61a2bcc 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieCache.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/PermissionTrieCache.cs
@@ -34,6 +34,7 @@ public sealed class PermissionTrieCache
/// Get the current-generation trie for a cluster; null when nothing installed.
/// The cluster identifier.
+ /// The current-generation trie, or null if nothing is installed for the cluster.
public PermissionTrie? GetTrie(string clusterId)
{
ArgumentException.ThrowIfNullOrWhiteSpace(clusterId);
@@ -43,6 +44,7 @@ public sealed class PermissionTrieCache
/// Get a specific (cluster, generation) trie; null if that pair isn't cached.
/// The cluster identifier.
/// The generation identifier.
+ /// The trie for the specified cluster and generation, or null if not cached.
public PermissionTrie? GetTrie(string clusterId, long generationId)
{
if (!_byCluster.TryGetValue(clusterId, out var entry)) return null;
@@ -51,6 +53,7 @@ public sealed class PermissionTrieCache
/// The generation id the shortcut currently serves for a cluster.
/// The cluster identifier.
+ /// The current generation ID, or null if no trie is installed for the cluster.
public long? CurrentGenerationId(string clusterId)
=> _byCluster.TryGetValue(clusterId, out var entry) ? entry.Current.GenerationId : null;
@@ -111,11 +114,13 @@ public sealed class PermissionTrieCache
/// Creates a cluster entry from a single trie.
/// The permission trie to create the entry from.
+ /// A new containing the single trie as the current generation.
public static ClusterEntry FromSingle(PermissionTrie trie) =>
new(trie, new Dictionary { [trie.GenerationId] = trie });
/// Creates a new entry with an additional trie, updating current if it's newer.
/// The new permission trie to add.
+ /// A new with the trie added and the current pointer updated if the new generation is newer.
public ClusterEntry WithAdditional(PermissionTrie trie)
{
var next = new Dictionary(Tries) { [trie.GenerationId] = trie };
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/TriePermissionEvaluator.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/TriePermissionEvaluator.cs
index a92608cc..5b43b6ed 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/TriePermissionEvaluator.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/TriePermissionEvaluator.cs
@@ -24,11 +24,7 @@ public sealed class TriePermissionEvaluator : IPermissionEvaluator
_timeProvider = timeProvider ?? TimeProvider.System;
}
- /// Authorizes an operation against the user's session and node scope.
- /// The user's authorization session.
- /// The OPC UA operation to authorize.
- /// The target node scope.
- /// An authorization decision indicating whether the operation is allowed.
+ ///
public AuthorizationDecision Authorize(UserAuthorizationState session, OpcUaOperation operation, NodeScope scope)
{
ArgumentNullException.ThrowIfNull(session);
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/UserAuthorizationState.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/UserAuthorizationState.cs
index e811109c..54331342 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/UserAuthorizationState.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Authorization/UserAuthorizationState.cs
@@ -64,6 +64,7 @@ public sealed record UserAuthorizationState
/// whenever this is true.
///
/// The current UTC time.
+ /// true when the state exceeds its maximum staleness ceiling.
public bool IsStale(DateTime utcNow) => utcNow - MembershipResolvedUtc > AuthCacheMaxStaleness;
///
@@ -72,6 +73,7 @@ public sealed record UserAuthorizationState
/// call still evaluates against the cached memberships.
///
/// The current UTC time.
+ /// true when a background refresh should be initiated but the current cached memberships are still usable.
public bool NeedsRefresh(DateTime utcNow) =>
!IsStale(utcNow) && utcNow - MembershipResolvedUtc > MembershipFreshnessInterval;
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistry.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistry.cs
index bbade74e..d5459fe0 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistry.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistry.cs
@@ -63,6 +63,7 @@ public sealed class DriverFactoryRegistry
/// missing-assembly deployment doesn't take down the whole server.
///
/// The driver type to look up.
+ /// The registered factory delegate, or if no factory was registered for the type.
public Func? TryGet(string driverType)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverType);
@@ -75,6 +76,7 @@ public sealed class DriverFactoryRegistry
/// case upstream; we don't double-surface that failure here.
///
/// The driver type to look up.
+ /// The registered , or if the type is unknown.
public DriverTier GetTier(string driverType)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverType);
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistryAdapter.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistryAdapter.cs
index de24430e..fd44bb96 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistryAdapter.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverFactoryRegistryAdapter.cs
@@ -20,16 +20,13 @@ public sealed class DriverFactoryRegistryAdapter : IDriverFactory
_registry = registry;
}
- /// Attempts to create a driver instance by type and configuration.
- /// The driver type name.
- /// The driver instance identifier.
- /// The driver configuration as a JSON string.
+ ///
public IDriver? TryCreate(string driverType, string driverInstanceId, string driverConfigJson)
{
var factory = _registry.TryGet(driverType);
return factory?.Invoke(driverInstanceId, driverConfigJson);
}
- /// Gets the collection of supported driver type names.
+ ///
public IReadOnlyCollection SupportedTypes => _registry.RegisteredTypes;
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverHost.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverHost.cs
index 9c8dbd86..7bf283f5 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverHost.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Hosting/DriverHost.cs
@@ -21,6 +21,7 @@ public sealed class DriverHost : IAsyncDisposable
/// Gets the health status of a registered driver.
/// The driver instance identifier to query.
+ /// The driver health if the driver is registered; otherwise null.
public DriverHealth? GetHealth(string driverInstanceId)
{
lock (_lock)
@@ -33,6 +34,7 @@ public sealed class DriverHost : IAsyncDisposable
/// startup. Returns null when the driver is not registered.
///
/// The driver instance identifier to look up.
+ /// The driver instance if registered; otherwise null.
public IDriver? GetDriver(string driverInstanceId)
{
lock (_lock)
@@ -47,6 +49,7 @@ public sealed class DriverHost : IAsyncDisposable
/// The driver instance to register.
/// The configuration JSON for the driver.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
public async Task RegisterAsync(IDriver driver, string driverConfigJson, CancellationToken ct)
{
ArgumentNullException.ThrowIfNull(driver);
@@ -70,6 +73,7 @@ public sealed class DriverHost : IAsyncDisposable
/// Unregisters a driver and calls shutdown.
/// The driver instance identifier to unregister.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
public async Task UnregisterAsync(string driverInstanceId, CancellationToken ct)
{
IDriver? driver;
@@ -84,6 +88,7 @@ public sealed class DriverHost : IAsyncDisposable
}
/// Disposes the driver host and all registered drivers.
+ /// A value task that represents the asynchronous operation.
public async ValueTask DisposeAsync()
{
List snapshot;
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/DriverHealthReport.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/DriverHealthReport.cs
index bd4f0961..99309b9d 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/DriverHealthReport.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/DriverHealthReport.cs
@@ -27,6 +27,7 @@ public static class DriverHealthReport
{
/// Compute the fleet-wide readiness verdict from per-driver states.
/// The list of per-driver health snapshots to aggregate.
+ /// The fleet-wide derived from all driver states.
public static ReadinessVerdict Aggregate(IReadOnlyList drivers)
{
ArgumentNullException.ThrowIfNull(drivers);
@@ -54,6 +55,7 @@ public static class DriverHealthReport
/// return per the Stream C.1 state matrix.
///
/// The readiness verdict to map to HTTP status.
+ /// The HTTP status code (200 or 503) corresponding to the verdict.
public static int HttpStatus(ReadinessVerdict verdict) => verdict switch
{
ReadinessVerdict.Healthy => 200,
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/LogContextEnricher.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/LogContextEnricher.cs
index 97f34a83..7a7bb80b 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/LogContextEnricher.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Observability/LogContextEnricher.cs
@@ -22,6 +22,7 @@ public static class LogContextEnricher
/// The driver type name.
/// The driver capability being invoked.
/// The correlation ID for tracing the call.
+ /// A scope that pops the pushed properties when disposed.
public static IDisposable Push(string driverInstanceId, string driverType, DriverCapability capability, string correlationId)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverInstanceId);
@@ -40,6 +41,7 @@ public static class LogContextEnricher
/// 12-hex-char slice of a GUID — long enough for log correlation, short enough to
/// scan visually.
///
+ /// A 12-character hex string suitable for log correlation.
public static string NewCorrelationId() => Guid.NewGuid().ToString("N")[..12];
private sealed class CompositeScope : IDisposable
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/EquipmentNodeWalker.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/EquipmentNodeWalker.cs
index 01da5665..6bda50e5 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/EquipmentNodeWalker.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/EquipmentNodeWalker.cs
@@ -183,6 +183,7 @@ public static class EquipmentNodeWalker
/// wants an opaque non-JSON reference.
///
/// The tag configuration JSON or string.
+ /// The value of the FullName field from the JSON, or the raw string as a fallback.
internal static string ExtractFullName(string tagConfig)
{
if (string.IsNullOrWhiteSpace(tagConfig)) return tagConfig;
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/GenericDriverNodeManager.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/GenericDriverNodeManager.cs
index 6399075d..16e36612 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/GenericDriverNodeManager.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/OpcUa/GenericDriverNodeManager.cs
@@ -49,6 +49,7 @@ public class GenericDriverNodeManager(IDriver driver) : IDisposable
///
/// The address space builder to populate.
/// The cancellation token.
+ /// A task that represents the asynchronous address space build operation.
public async Task BuildAddressSpaceAsync(IAddressSpaceBuilder builder, CancellationToken ct)
{
ArgumentNullException.ThrowIfNull(builder);
@@ -111,23 +112,15 @@ public class GenericDriverNodeManager(IDriver driver) : IDisposable
IAddressSpaceBuilder inner,
ConcurrentDictionary sinks) : IAddressSpaceBuilder
{
- /// Adds a folder to the address space.
- /// The browse name of the folder node.
- /// The display name of the folder node.
+ ///
public IAddressSpaceBuilder Folder(string browseName, string displayName)
=> new CapturingBuilder(inner.Folder(browseName, displayName), sinks);
- /// Adds a variable to the address space.
- /// The browse name of the variable node.
- /// The display name of the variable node.
- /// Metadata describing the variable's data type and properties.
+ ///
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo)
=> new CapturingHandle(inner.Variable(browseName, displayName, attributeInfo), sinks);
- /// Adds a property to the address space.
- /// The browse name of the property node.
- /// The OPC UA data type of the property.
- /// The initial value of the property, or null.
+ ///
public void AddProperty(string browseName, DriverDataType dataType, object? value)
=> inner.AddProperty(browseName, dataType, value);
}
@@ -136,11 +129,10 @@ public class GenericDriverNodeManager(IDriver driver) : IDisposable
IVariableHandle inner,
ConcurrentDictionary sinks) : IVariableHandle
{
- /// Gets the full reference for the variable.
+ ///
public string FullReference => inner.FullReference;
- /// Marks the variable as an alarm condition and registers its sink.
- /// Configuration for the alarm condition.
+ ///
public IAlarmConditionSink MarkAsAlarmCondition(AlarmConditionInfo info)
{
var sink = inner.MarkAsAlarmCondition(info);
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/AlarmSurfaceInvoker.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/AlarmSurfaceInvoker.cs
index ba2c6014..0368945e 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/AlarmSurfaceInvoker.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/AlarmSurfaceInvoker.cs
@@ -59,6 +59,7 @@ public sealed class AlarmSurfaceInvoker
///
/// The source node IDs to subscribe to.
/// The cancellation token.
+ /// A task that resolves to one subscription handle per resolved host.
public async Task> SubscribeAsync(
IReadOnlyList sourceNodeIds,
CancellationToken cancellationToken)
@@ -89,6 +90,7 @@ public sealed class AlarmSurfaceInvoker
///
/// The subscription handle to unsubscribe.
/// The cancellation token.
+ /// A task that represents the asynchronous unsubscribe operation.
public ValueTask UnsubscribeAsync(IAlarmSubscriptionHandle handle, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(handle);
@@ -110,6 +112,7 @@ public sealed class AlarmSurfaceInvoker
///
/// The alarm acknowledgement requests.
/// The cancellation token.
+ /// A task that represents the asynchronous acknowledgement operation.
public async Task AcknowledgeAsync(
IReadOnlyList acknowledgements,
CancellationToken cancellationToken)
@@ -166,7 +169,7 @@ public sealed class AlarmSurfaceInvoker
public IAlarmSubscriptionHandle Inner { get; } = inner;
/// Gets the resolved host name.
public string Host { get; } = host;
- /// Gets the diagnostic ID from the inner handle.
+ ///
public string DiagnosticId => Inner.DiagnosticId;
}
}
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/CapabilityInvoker.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/CapabilityInvoker.cs
index 42fc65fe..0af92cb4 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/CapabilityInvoker.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/CapabilityInvoker.cs
@@ -58,6 +58,7 @@ public sealed class CapabilityInvoker
/// The host name for logging and status tracking.
/// The async function to execute.
/// Cancellation token for the operation.
+ /// The result produced by after executing through the pipeline.
public async ValueTask ExecuteAsync(
DriverCapability capability,
string hostName,
@@ -86,6 +87,7 @@ public sealed class CapabilityInvoker
/// The host name for logging and status tracking.
/// The async function to execute.
/// Cancellation token for the operation.
+ /// A value task that represents the asynchronous operation.
public async ValueTask ExecuteAsync(
DriverCapability capability,
string hostName,
@@ -121,6 +123,7 @@ public sealed class CapabilityInvoker
/// Whether the write operation is idempotent.
/// The async function to execute.
/// Cancellation token for the operation.
+ /// The result produced by after executing through the write pipeline.
public async ValueTask ExecuteWriteAsync(
string hostName,
bool isIdempotent,
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceOptionsParser.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceOptionsParser.cs
index 168d6677..19f983f5 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceOptionsParser.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceOptionsParser.cs
@@ -50,6 +50,7 @@ public static class DriverResilienceOptionsParser
/// The driver tier for default resilience options.
/// The optional JSON configuration string to parse.
/// An out parameter containing diagnostic information if parsing fails.
+ /// The effective resilience options; tier defaults when the JSON is null or malformed.
public static DriverResilienceOptions ParseOrDefaults(
DriverTier tier,
string? resilienceConfigJson,
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResiliencePipelineBuilder.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResiliencePipelineBuilder.cs
index 99fbcde7..eda8368d 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResiliencePipelineBuilder.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResiliencePipelineBuilder.cs
@@ -54,6 +54,7 @@ public sealed class DriverResiliencePipelineBuilder
///
/// Which capability surface is being called.
/// Per-driver-instance options (tier + per-capability overrides).
+ /// The cached or newly created for the given key.
public ResiliencePipeline GetOrCreate(
string driverInstanceId,
string hostName,
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceStatusTracker.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceStatusTracker.cs
index 1e32128a..db8b4717 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceStatusTracker.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Resilience/DriverResilienceStatusTracker.cs
@@ -128,10 +128,12 @@ public sealed class DriverResilienceStatusTracker
/// Snapshot of a specific (instance, host) pair; null if no counters recorded yet.
/// The driver instance identifier.
/// The host name.
+ /// The current for the pair, or if no counters have been recorded.
public ResilienceStatusSnapshot? TryGet(string driverInstanceId, string hostName) =>
_status.TryGetValue(new StatusKey(driverInstanceId, hostName), out var snapshot) ? snapshot : null;
/// Copy of every currently-tracked (instance, host, snapshot) triple. Safe under concurrent writes.
+ /// A snapshot list of all currently tracked driver instance and host resilience states.
public IReadOnlyList<(string DriverInstanceId, string HostName, ResilienceStatusSnapshot Snapshot)> Snapshot() =>
_status.Select(kvp => (kvp.Key.DriverInstanceId, kvp.Key.HostName, kvp.Value)).ToList();
diff --git a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Stability/MemoryTracking.cs b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Stability/MemoryTracking.cs
index 9dad09ee..977a20d8 100644
--- a/src/Core/ZB.MOM.WW.OtOpcUa.Core/Stability/MemoryTracking.cs
+++ b/src/Core/ZB.MOM.WW.OtOpcUa.Core/Stability/MemoryTracking.cs
@@ -33,6 +33,7 @@ public sealed class MemoryTracking
/// Tier-default multiplier/floor constants per decision #146.
/// The driver tier.
+ /// A tuple with the growth multiplier and the minimum floor bytes for the specified tier.
public static (int Multiplier, long FloorBytes) GetTierConstants(DriverTier tier) => tier switch
{
DriverTier.A => (Multiplier: 3, FloorBytes: 50L * 1024 * 1024),
@@ -73,6 +74,7 @@ public sealed class MemoryTracking
///
/// The current memory footprint in bytes.
/// The current UTC time.
+ /// The classifying this sample against the soft/hard thresholds.
public MemoryTrackingAction Sample(long footprintBytes, DateTime utcNow)
{
if (_phase == TrackingPhase.WarmingUp)
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/AbCipCommandBase.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/AbCipCommandBase.cs
index e5d9e42a..767d19be 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/AbCipCommandBase.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/AbCipCommandBase.cs
@@ -60,6 +60,7 @@ public abstract class AbCipCommandBase : DriverCommandBase
/// probe loop would race the operator's own reads.
///
/// The list of tag definitions to include in the options.
+ /// A fully-configured with probe and alarm projection disabled.
protected AbCipDriverOptions BuildOptions(IReadOnlyList tags) => new()
{
Devices = [new AbCipDeviceOptions(
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/Commands/ReadCommand.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/Commands/ReadCommand.cs
index 5bad9277..2c4e6837 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/Commands/ReadCommand.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbCip.Cli/Commands/ReadCommand.cs
@@ -66,6 +66,7 @@ public sealed class ReadCommand : AbCipCommandBase
///
/// The symbolic tag path.
/// The data type.
+ /// A combined tag-name string in path:type form.
internal static string SynthesiseTagName(string tagPath, AbCipDataType type)
=> $"{tagPath}:{type}";
}
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Cli/Commands/ReadCommand.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Cli/Commands/ReadCommand.cs
index 51ac8ca1..cc293ac9 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Cli/Commands/ReadCommand.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Cli/Commands/ReadCommand.cs
@@ -58,6 +58,7 @@ public sealed class ReadCommand : AbLegacyCommandBase
/// Tag-name key the driver uses internally. Address+type is already unique.
/// The PCCC file address.
/// The data type of the address.
+ /// A combined tag name string in the form address:type.
internal static string SynthesiseTagName(string address, AbLegacyDataType type)
=> $"{address}:{type}";
}
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Cli.Common/SnapshotFormatter.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Cli.Common/SnapshotFormatter.cs
index b44ffdc5..49e2e86c 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Cli.Common/SnapshotFormatter.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Cli.Common/SnapshotFormatter.cs
@@ -23,6 +23,7 @@ public static class SnapshotFormatter
///
/// The tag name to include in the output.
/// The data value snapshot to format.
+ /// A multi-line string representation of the tag and its value.
public static string Format(string tagName, DataValueSnapshot snapshot)
{
ArgumentNullException.ThrowIfNull(snapshot);
@@ -42,6 +43,7 @@ public static class SnapshotFormatter
///
/// The tag name to include in the output.
/// The write result to format.
+ /// A single-line string showing the tag name and write status.
public static string FormatWrite(string tagName, WriteResult result)
{
ArgumentNullException.ThrowIfNull(result);
@@ -54,6 +56,7 @@ public static class SnapshotFormatter
///
/// The list of tag names to include as rows.
/// The list of data value snapshots to format.
+ /// An aligned table string with tag, value, status, and source-time columns.
public static string FormatTable(
IReadOnlyList tagNames, IReadOnlyList snapshots)
{
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/Commands/ReadCommand.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/Commands/ReadCommand.cs
index c1a92581..d2577c6d 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/Commands/ReadCommand.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/Commands/ReadCommand.cs
@@ -52,6 +52,7 @@ public sealed class ReadCommand : FocasCommandBase
/// Constructs a tag name from address and data type.
/// The FOCAS address.
/// The data type.
+ /// A synthesized tag name string combining the address and data type.
internal static string SynthesiseTagName(string address, FocasDataType type)
=> $"{address}:{type}";
}
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/FocasCommandBase.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/FocasCommandBase.cs
index cfa9957f..dc5553c8 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/FocasCommandBase.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.Cli/FocasCommandBase.cs
@@ -47,6 +47,7 @@ public abstract class FocasCommandBase : DriverCommandBase
/// as BadCommunicationError.
///
/// The tag definitions to include in the driver options.
+ /// A configured with the CNC target and the supplied tag list.
protected FocasDriverOptions BuildOptions(IReadOnlyList tags) => new()
{
Devices = [new FocasDeviceOptions(
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli/ModbusCommandBase.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli/ModbusCommandBase.cs
index d3441cc9..d8fd176c 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli/ModbusCommandBase.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Cli/ModbusCommandBase.cs
@@ -48,6 +48,7 @@ public abstract class ModbusCommandBase : DriverCommandBase
/// command against its own keep-alive reads.
///
/// The tag definitions to include in the options.
+ /// A configured for a one-shot CLI run.
protected ModbusDriverOptions BuildOptions(IReadOnlyList tags) => new()
{
Host = Host,
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/Commands/ReadCommand.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/Commands/ReadCommand.cs
index 2cda2f1e..4f3588a3 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/Commands/ReadCommand.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/Commands/ReadCommand.cs
@@ -61,6 +61,7 @@ public sealed class ReadCommand : S7CommandBase
/// Tag-name key used internally. Address + type is already unique.
/// The S7 address to encode in the tag name.
/// The data type to encode in the tag name.
+ /// The synthesised tag name encoding the address and type.
internal static string SynthesiseTagName(string address, S7DataType type)
=> $"{address}:{type}";
}
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/S7CommandBase.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/S7CommandBase.cs
index ecf725f5..ead55c02 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/S7CommandBase.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.S7.Cli/S7CommandBase.cs
@@ -51,6 +51,7 @@ public abstract class S7CommandBase : DriverCommandBase
/// disabled — CLI runs are one-shot.
///
/// The tag definitions to include in the options.
+ /// An populated with the current command-line values and the supplied tags.
protected S7DriverOptions BuildOptions(IReadOnlyList tags) => new()
{
Host = Host,
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/BrowseCommand.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/BrowseCommand.cs
index fc8bec30..5805f025 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/BrowseCommand.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/BrowseCommand.cs
@@ -90,6 +90,7 @@ public sealed class BrowseCommand : TwinCATCommandBase
///
/// The source collection to filter.
/// The prefix to filter on, or null to keep everything.
+ /// A filtered list of variables whose browse names start with the given prefix.
internal static List<(string BrowseName, DriverAttributeInfo Info)> FilterByPrefix(
IReadOnlyList<(string BrowseName, DriverAttributeInfo Info)> source, string? prefix)
=> source
@@ -102,6 +103,7 @@ public sealed class BrowseCommand : TwinCATCommandBase
///
/// The number of matched items.
/// The maximum number to show, or 0 for unbounded.
+ /// The effective print limit: when unbounded, otherwise the lesser of and .
internal static int PrintLimit(int matchedCount, int max)
=> max <= 0 ? matchedCount : Math.Min(max, matchedCount);
@@ -112,6 +114,7 @@ public sealed class BrowseCommand : TwinCATCommandBase
/// authorization is enforced server-side.
///
/// The attribute info to label.
+ /// "RO" for view-only attributes; "RW" for all others.
internal static string AccessTag(DriverAttributeInfo info)
=> info.SecurityClass == SecurityClassification.ViewOnly ? "RO" : "RW";
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/WriteCommand.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/WriteCommand.cs
index 8aa3a0cc..40df4ee5 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/WriteCommand.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/Commands/WriteCommand.cs
@@ -69,6 +69,7 @@ public sealed class WriteCommand : TwinCATTagCommandBase
/// Parse --value per , invariant culture.
/// The raw string value to parse.
/// The target TwinCAT data type.
+ /// The parsed value as a boxed .NET object matching the requested data type.
internal static object ParseValue(string raw, TwinCATDataType type) => type switch
{
TwinCATDataType.Bool => ParseBool(raw),
diff --git a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/TwinCATTagCommandBase.cs b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/TwinCATTagCommandBase.cs
index 928a05d8..23a74907 100644
--- a/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/TwinCATTagCommandBase.cs
+++ b/src/Drivers/Cli/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT.Cli/TwinCATTagCommandBase.cs
@@ -24,6 +24,7 @@ public abstract class TwinCATTagCommandBase : TwinCATCommandBase
/// native notifications toggled by .
///
/// Tag definitions for the driver.
+ /// A configured for a single-device CLI run.
protected TwinCATDriverOptions BuildOptions(IReadOnlyList tags) => new()
{
Devices = [new TwinCATDeviceOptions(
@@ -39,6 +40,7 @@ public abstract class TwinCATTagCommandBase : TwinCATCommandBase
// ---- Test hook ----
/// Test hook that exposes BuildOptions for unit testing.
/// Tag definitions for the driver.
+ /// A configured for a single-device CLI run.
internal TwinCATDriverOptions BuildOptionsForTest(IReadOnlyList tags)
=> BuildOptions(tags);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipDriver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipDriver.cs
index bb53fc21..af941676 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipDriver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipDriver.cs
@@ -130,10 +130,10 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
///
internal AbCipTemplateCache TemplateCache => _templateCache;
- /// Gets the unique identifier for this driver instance.
+ ///
public string DriverInstanceId => _driverInstanceId;
- /// Gets the driver type identifier.
+ ///
public string DriverType => "AbCip";
///
@@ -244,10 +244,7 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
return Task.CompletedTask;
}
- /// Reinitialize the driver by shutting down and reinitializing with new configuration.
- /// The new driver configuration as JSON.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous reinitialization.
+ ///
public async Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
await ShutdownAsync(cancellationToken).ConfigureAwait(false);
@@ -305,19 +302,12 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- ISubscribable (polling overlay via shared engine) ----
- /// Subscribe to value changes for the specified tag references.
- /// The tag references to subscribe to.
- /// The interval at which to publish changes.
- /// Cancellation token for the operation.
- /// A handle representing the subscription.
+ ///
public Task SubscribeAsync(
IReadOnlyList fullReferences, TimeSpan publishingInterval, CancellationToken cancellationToken) =>
Task.FromResult(_poll.Subscribe(fullReferences, publishingInterval));
- /// Unsubscribe from value changes using a subscription handle.
- /// The subscription handle to unsubscribe.
- /// Cancellation token for the operation.
- /// A completed task.
+ ///
public Task UnsubscribeAsync(ISubscriptionHandle handle, CancellationToken cancellationToken)
{
_poll.Unsubscribe(handle);
@@ -349,19 +339,13 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
return _alarmProjection.SubscribeAsync(sourceNodeIds, cancellationToken);
}
- /// Unsubscribe from alarm events.
- /// The alarm subscription handle.
- /// Cancellation token for the operation.
- /// A completed task.
+ ///
public Task UnsubscribeAlarmsAsync(IAlarmSubscriptionHandle handle, CancellationToken cancellationToken) =>
_options.EnableAlarmProjection
? _alarmProjection.UnsubscribeAsync(handle, cancellationToken)
: Task.CompletedTask;
- /// Acknowledge alarms.
- /// The alarm acknowledgements to process.
- /// Cancellation token for the operation.
- /// A completed task.
+ ///
public Task AcknowledgeAsync(
IReadOnlyList acknowledgements, CancellationToken cancellationToken) =>
_options.EnableAlarmProjection
@@ -370,8 +354,7 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- IHostConnectivityProbe ----
- /// Gets the connectivity status of all configured devices.
- /// A read-only list of host connectivity statuses.
+ ///
public IReadOnlyList GetHostStatuses() =>
[.. _devices.Values.Select(s => new HostConnectivityStatus(s.Options.HostAddress, s.HostState, s.HostStateChangedUtc))];
@@ -873,8 +856,7 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
}
}
- /// Gets the current health status of the driver.
- /// The driver health information.
+ ///
public DriverHealth GetHealth() => _health;
///
@@ -885,9 +867,7 @@ public sealed class AbCipDriver : IDriver, IReadable, IWritable, ITagDiscovery,
/// The memory footprint in bytes.
public long GetMemoryFootprint() => 0;
- /// Flushes optional caches to free memory.
- /// Cancellation token for the operation.
- /// A completed task.
+ ///
public Task FlushOptionalCachesAsync(CancellationToken cancellationToken)
{
_templateCache.Clear();
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipStatusMapper.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipStatusMapper.cs
index c0fed449..601bcb1c 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipStatusMapper.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipStatusMapper.cs
@@ -48,6 +48,7 @@ public static class AbCipStatusMapper
/// Map a CIP general-status byte to an OPC UA StatusCode.
/// The CIP general-status byte value.
+ /// The corresponding OPC UA StatusCode.
public static uint MapCipGeneralStatus(byte status) => status switch
{
0x00 => Good,
@@ -72,6 +73,7 @@ public static class AbCipStatusMapper
/// operation; every other (negative) member is an error.
///
/// The libplctag status code as an integer.
+ /// The corresponding OPC UA StatusCode.
public static uint MapLibplctagStatus(int status) => MapLibplctagStatus((Status)status);
///
@@ -80,6 +82,7 @@ public static class AbCipStatusMapper
/// seam, which returns the boxed-as-int value.
///
/// The libplctag Status enum value.
+ /// The corresponding OPC UA StatusCode.
public static uint MapLibplctagStatus(Status status) => status switch
{
Status.Ok => Good,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipSystemTagFilter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipSystemTagFilter.cs
index ed21a36b..a3fafc74 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipSystemTagFilter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipSystemTagFilter.cs
@@ -19,6 +19,7 @@ public static class AbCipSystemTagFilter
/// always preserved case and the system-tag prefixes are uppercase by convention.
///
/// The tag name to check.
+ /// if the tag is a system tag that should be hidden; otherwise .
public static bool IsSystemTag(string tagName)
{
if (string.IsNullOrWhiteSpace(tagName)) return true;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTagPath.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTagPath.cs
index 2f77b24a..4d1a85d2 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTagPath.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTagPath.cs
@@ -24,6 +24,7 @@ public sealed record AbCipTagPath(
int? BitIndex)
{
/// Rebuild the canonical Logix tag string.
+ /// The canonical Logix tag string suitable for the libplctag name= attribute.
public string ToLibplctagName()
{
var buf = new System.Text.StringBuilder();
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTemplateCache.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTemplateCache.cs
index 369c45d2..2d416645 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTemplateCache.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipTemplateCache.cs
@@ -23,6 +23,7 @@ public sealed class AbCipTemplateCache
///
/// The device host address and port.
/// The template instance ID.
+ /// The cached , or null if not yet populated.
public AbCipUdtShape? TryGet(string deviceHostAddress, uint templateInstanceId) =>
_shapes.TryGetValue((deviceHostAddress, templateInstanceId), out var shape) ? shape : null;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtMemberLayout.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtMemberLayout.cs
index 543d96ba..74fef203 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtMemberLayout.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtMemberLayout.cs
@@ -30,6 +30,7 @@ public static class AbCipUdtMemberLayout
/// if any member type is unsupported for declaration-only layout.
///
/// The list of UDT member declarations.
+ /// A dictionary mapping member name to byte offset, or if any member type is unsupported.
public static IReadOnlyDictionary? TryBuild(
IReadOnlyList members)
{
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtReadPlanner.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtReadPlanner.cs
index 62cef0aa..3803c8f2 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtReadPlanner.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/AbCipUdtReadPlanner.cs
@@ -28,6 +28,7 @@ public static class AbCipUdtReadPlanner
/// The list of tag references to read.
/// Dictionary mapping tag names to their definitions.
/// Whether to enable UDT member grouping based on declaration order.
+ /// An partitioning requests into whole-UDT groups and per-tag fallbacks.
public static AbCipUdtReadPlan Build(
IReadOnlyList requests,
IReadOnlyDictionary tagsByName,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagEnumerator.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagEnumerator.cs
index 4f187b39..c79a7fd1 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagEnumerator.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagEnumerator.cs
@@ -15,6 +15,7 @@ public interface IAbCipTagEnumerator : IDisposable
///
/// Parameters for creating device tags.
/// Cancellation token.
+ /// An async enumerable of discovered tags.
IAsyncEnumerable EnumerateAsync(
AbCipTagCreateParams deviceParams,
CancellationToken cancellationToken);
@@ -26,6 +27,7 @@ public interface IAbCipTagEnumeratorFactory
///
/// Creates a new tag enumerator instance.
///
+ /// A new instance.
IAbCipTagEnumerator Create();
}
@@ -59,6 +61,7 @@ internal sealed class EmptyAbCipTagEnumerator : IAbCipTagEnumerator
///
/// Parameters for creating device tags.
/// Cancellation token.
+ /// An empty async enumerable of discovered tags.
public async IAsyncEnumerable EnumerateAsync(
AbCipTagCreateParams deviceParams,
[System.Runtime.CompilerServices.EnumeratorCancellation] CancellationToken cancellationToken)
@@ -79,5 +82,6 @@ internal sealed class EmptyAbCipTagEnumeratorFactory : IAbCipTagEnumeratorFactor
///
/// Creates a new empty tag enumerator.
///
+ /// A new instance.
public IAbCipTagEnumerator Create() => new EmptyAbCipTagEnumerator();
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagRuntime.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagRuntime.cs
index 536ec6fc..2876966b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagRuntime.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTagRuntime.cs
@@ -11,20 +11,24 @@ public interface IAbCipTagRuntime : IDisposable
{
/// Create the underlying native tag (equivalent to libplctag's plc_tag_create).
/// Cancellation token.
+ /// A task that represents the asynchronous operation.
Task InitializeAsync(CancellationToken cancellationToken);
/// Issue a read; on completion the local buffer holds the current PLC value.
/// Cancellation token.
+ /// A task that represents the asynchronous operation.
Task ReadAsync(CancellationToken cancellationToken);
/// Flush the local buffer to the PLC.
/// Cancellation token.
+ /// A task that represents the asynchronous operation.
Task WriteAsync(CancellationToken cancellationToken);
///
/// Raw libplctag status code — mapped to an OPC UA StatusCode via
/// . Zero on success, negative on error.
///
+ /// The raw libplctag status integer; zero on success, negative on error.
int GetStatus();
///
@@ -34,6 +38,7 @@ public interface IAbCipTagRuntime : IDisposable
///
/// CIP data type to decode.
/// Bit index for BOOL-within-DINT extraction, or null.
+ /// The decoded .NET value, or null if the buffer cannot be decoded for the given type.
object? DecodeValue(AbCipDataType type, int? bitIndex);
///
@@ -48,6 +53,7 @@ public interface IAbCipTagRuntime : IDisposable
/// CIP data type to decode.
/// Byte offset in the buffer.
/// Bit index for BOOL-within-DINT extraction, or null.
+ /// The decoded .NET value at the specified offset, or null if the offset is unsupported.
object? DecodeValueAt(AbCipDataType type, int offset, int? bitIndex);
///
@@ -68,6 +74,7 @@ public interface IAbCipTagFactory
{
/// Creates a tag runtime handle from the specified creation parameters.
/// Parameters needed to create the tag runtime.
+ /// A new instance for the specified tag.
IAbCipTagRuntime Create(AbCipTagCreateParams createParams);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTemplateReader.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTemplateReader.cs
index 993db768..8309d8b1 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTemplateReader.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/IAbCipTemplateReader.cs
@@ -16,6 +16,7 @@ public interface IAbCipTemplateReader : IDisposable
/// The device connection parameters.
/// The template instance ID to read.
/// Token to cancel the operation.
+ /// The raw template blob bytes.
Task ReadAsync(
AbCipTagCreateParams deviceParams,
uint templateInstanceId,
@@ -26,5 +27,6 @@ public interface IAbCipTemplateReader : IDisposable
public interface IAbCipTemplateReaderFactory
{
/// Creates a new template reader instance.
+ /// A new instance.
IAbCipTemplateReader Create();
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagEnumerator.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagEnumerator.cs
index 26b241a4..99269714 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagEnumerator.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagEnumerator.cs
@@ -21,10 +21,7 @@ internal sealed class LibplctagTagEnumerator : IAbCipTagEnumerator
{
private Tag? _tag;
- /// Enumerates all tags in the controller symbol table.
- /// Device connection parameters including gateway and path.
- /// Cancellation token for the enumeration.
- /// An async enumerable of discovered tags.
+ ///
public async IAsyncEnumerable EnumerateAsync(
AbCipTagCreateParams deviceParams,
[EnumeratorCancellation] CancellationToken cancellationToken)
@@ -64,7 +61,6 @@ internal sealed class LibplctagTagEnumerator : IAbCipTagEnumerator
/// Factory for .
internal sealed class LibplctagTagEnumeratorFactory : IAbCipTagEnumeratorFactory
{
- /// Creates a new libplctag-based tag enumerator.
- /// A new tag enumerator instance.
+ ///
public IAbCipTagEnumerator Create() => new LibplctagTagEnumerator();
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagRuntime.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagRuntime.cs
index 3f3f46ca..f34dd8ee 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagRuntime.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTagRuntime.cs
@@ -36,36 +36,22 @@ internal sealed class LibplctagTagRuntime : IAbCipTagRuntime
// negotiates with — Driver.AbCip-013.
}
- /// Initializes the tag asynchronously.
- /// The cancellation token.
- /// A task representing the asynchronous initialization.
+ ///
public Task InitializeAsync(CancellationToken cancellationToken) => _tag.InitializeAsync(cancellationToken);
- /// Reads the tag value asynchronously.
- /// The cancellation token.
- /// A task representing the asynchronous read operation.
+ ///
public Task ReadAsync(CancellationToken cancellationToken) => _tag.ReadAsync(cancellationToken);
- /// Writes the tag value asynchronously.
- /// The cancellation token.
- /// A task representing the asynchronous write operation.
+ ///
public Task WriteAsync(CancellationToken cancellationToken) => _tag.WriteAsync(cancellationToken);
- /// Gets the current status of the tag.
- /// The tag status as an integer.
+ ///
public int GetStatus() => (int)_tag.GetStatus();
- /// Decodes the tag value with the specified data type.
- /// The data type to decode.
- /// The bit index for bit-level access, if applicable.
- /// The decoded value.
+ ///
public object? DecodeValue(AbCipDataType type, int? bitIndex) => DecodeValueAt(type, 0, bitIndex);
- /// Decodes the tag value at the specified offset with the specified data type.
- /// The data type to decode.
- /// The byte offset within the tag buffer.
- /// The bit index for bit-level access, if applicable.
- /// The decoded value.
+ ///
public object? DecodeValueAt(AbCipDataType type, int offset, int? bitIndex) => type switch
{
AbCipDataType.Bool => bitIndex is int bit
@@ -87,10 +73,7 @@ internal sealed class LibplctagTagRuntime : IAbCipTagRuntime
_ => null,
};
- /// Encodes the specified value to the tag with the specified data type.
- /// The data type to encode.
- /// The bit index for bit-level access, if applicable.
- /// The value to encode.
+ ///
public void EncodeValue(AbCipDataType type, int? bitIndex, object? value)
{
switch (type)
@@ -177,9 +160,7 @@ internal sealed class LibplctagTagRuntime : IAbCipTagRuntime
/// Default implementation of IAbCipTagFactory that creates LibplctagTagRuntime instances.
internal sealed class LibplctagTagFactory : IAbCipTagFactory
{
- /// Creates a new tag runtime with the specified creation parameters.
- /// The parameters for creating the tag.
- /// A new IAbCipTagRuntime instance.
+ ///
public IAbCipTagRuntime Create(AbCipTagCreateParams createParams) =>
new LibplctagTagRuntime(createParams);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTemplateReader.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTemplateReader.cs
index bd687f2e..314c6de6 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTemplateReader.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/LibplctagTemplateReader.cs
@@ -25,11 +25,7 @@ internal sealed class LibplctagTemplateReader : IAbCipTemplateReader
{
private Tag? _tag;
- /// Reads a template object from the PLC asynchronously.
- /// The device connection parameters.
- /// The template instance ID to read.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous read operation.
+ ///
public async Task ReadAsync(
AbCipTagCreateParams deviceParams,
uint templateInstanceId,
@@ -50,7 +46,7 @@ internal sealed class LibplctagTemplateReader : IAbCipTemplateReader
return _tag.GetBuffer();
}
- ///
+ /// Disposes the underlying libplctag Tag instance.
public void Dispose() => _tag?.Dispose();
private static PlcType MapPlcType(string attribute) => attribute switch
@@ -64,7 +60,6 @@ internal sealed class LibplctagTemplateReader : IAbCipTemplateReader
internal sealed class LibplctagTemplateReaderFactory : IAbCipTemplateReaderFactory
{
- /// Creates a new instance of the libplctag template reader.
- /// A new instance of .
+ ///
public IAbCipTemplateReader Create() => new LibplctagTemplateReader();
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/PlcFamilies/AbCipPlcFamilyProfile.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/PlcFamilies/AbCipPlcFamilyProfile.cs
index 0c5c3495..9d5460cf 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/PlcFamilies/AbCipPlcFamilyProfile.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip/PlcFamilies/AbCipPlcFamilyProfile.cs
@@ -21,6 +21,7 @@ public sealed record AbCipPlcFamilyProfile(
{
/// Look up the profile for a configured family.
/// The PLC family to look up the profile for.
+ /// The profile for the specified PLC family.
public static AbCipPlcFamilyProfile ForFamily(AbCipPlcFamily family) => family switch
{
AbCipPlcFamily.ControlLogix => ControlLogix,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Contracts/AbLegacyPlcFamilyProfile.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Contracts/AbLegacyPlcFamilyProfile.cs
index 8fef30e6..81d3d21b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Contracts/AbLegacyPlcFamilyProfile.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy.Contracts/AbLegacyPlcFamilyProfile.cs
@@ -13,6 +13,7 @@ public sealed record AbLegacyPlcFamilyProfile(
{
/// Gets the profile for the specified PLC family.
/// The PLC family.
+ /// The for the specified family.
public static AbLegacyPlcFamilyProfile ForFamily(AbLegacyPlcFamily family) => family switch
{
AbLegacyPlcFamily.Slc500 => Slc500,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/AbLegacyAddress.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/AbLegacyAddress.cs
index a509d951..2422885b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/AbLegacyAddress.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/AbLegacyAddress.cs
@@ -33,6 +33,7 @@ public sealed record AbLegacyAddress(
string? SubElement)
{
/// Converts the address to the libplctag library address format.
+ /// The libplctag name= attribute string for this address.
public string ToLibplctagName()
{
var file = FileNumber is null ? FileLetter : $"{FileLetter}{FileNumber}";
@@ -44,6 +45,7 @@ public sealed record AbLegacyAddress(
/// Attempts to parse a string into an AB legacy address.
/// The address string to parse.
+ /// A parsed , or if the input is invalid.
public static AbLegacyAddress? TryParse(string? value)
{
if (string.IsNullOrWhiteSpace(value)) return null;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/IAbLegacyTagRuntime.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/IAbLegacyTagRuntime.cs
index 7f1921fa..aca0d9b5 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/IAbLegacyTagRuntime.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/IAbLegacyTagRuntime.cs
@@ -9,22 +9,27 @@ public interface IAbLegacyTagRuntime : IDisposable
{
/// Initializes the tag runtime.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task InitializeAsync(CancellationToken cancellationToken);
/// Reads the current value of the tag.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task ReadAsync(CancellationToken cancellationToken);
/// Writes the encoded value to the tag.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task WriteAsync(CancellationToken cancellationToken);
/// Gets the current status of the tag operation.
+ /// The status code of the last tag operation.
int GetStatus();
/// Decodes the tag value according to the specified data type.
/// The data type to decode.
/// Optional bit index for bit-level access.
+ /// The decoded value, or null if the value cannot be decoded.
object? DecodeValue(AbLegacyDataType type, int? bitIndex);
/// Encodes a value for writing to the tag.
@@ -38,6 +43,7 @@ public interface IAbLegacyTagFactory
{
/// Creates a tag runtime instance with the specified parameters.
/// The tag creation parameters.
+ /// A new tag runtime instance.
IAbLegacyTagRuntime Create(AbLegacyTagCreateParams createParams);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/LibplctagLegacyTagRuntime.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/LibplctagLegacyTagRuntime.cs
index 7caf3c50..d5b3cf3e 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/LibplctagLegacyTagRuntime.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbLegacy/LibplctagLegacyTagRuntime.cs
@@ -96,7 +96,7 @@ internal sealed class LibplctagLegacyTagRuntime : IAbLegacyTagRuntime
}
}
- ///
+ /// Disposes the underlying libplctag tag and releases associated resources.
public void Dispose() => _tag.Dispose();
private static PlcType MapPlcType(string attribute) => attribute switch
@@ -111,9 +111,7 @@ internal sealed class LibplctagLegacyTagRuntime : IAbLegacyTagRuntime
internal sealed class LibplctagLegacyTagFactory : IAbLegacyTagFactory
{
- /// Creates a new libplctag-backed tag runtime instance.
- /// The parameters for tag creation.
- /// A new tag runtime instance.
+ ///
public IAbLegacyTagRuntime Create(AbLegacyTagCreateParams createParams) =>
new LibplctagLegacyTagRuntime(createParams);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/FocasDriver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/FocasDriver.cs
index fefc713a..56792f1d 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/FocasDriver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/FocasDriver.cs
@@ -65,15 +65,12 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
OnDataChange?.Invoke(this, new DataChangeEventArgs(handle, tagRef, snapshot)));
}
- /// Gets the driver instance identifier.
+ ///
public string DriverInstanceId => _driverInstanceId;
- /// Gets the driver type name.
+ ///
public string DriverType => "FOCAS";
- /// Initializes the driver with configuration and prepares device connections and polling.
- /// JSON configuration string for the driver.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous initialization operation.
+ ///
public Task InitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
Volatile.Write(ref _health, new DriverHealth(DriverState.Initializing, null, null));
@@ -156,19 +153,14 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
return Task.CompletedTask;
}
- /// Reinitializes the driver by shutting down and restarting with new configuration.
- /// JSON configuration string for the driver.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous reinitialization operation.
+ ///
public async Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
await ShutdownAsync(cancellationToken).ConfigureAwait(false);
await InitializeAsync(driverConfigJson, cancellationToken).ConfigureAwait(false);
}
- /// Shuts down the driver, cancelling all running operations and releasing resources.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous shutdown operation.
+ ///
public async Task ShutdownAsync(CancellationToken cancellationToken)
{
await _poll.DisposeAsync().ConfigureAwait(false);
@@ -202,13 +194,11 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
Volatile.Write(ref _health, new DriverHealth(DriverState.Unknown, Volatile.Read(ref _health).LastSuccessfulRead, null));
}
- /// Gets the current health status of the driver.
+ ///
public DriverHealth GetHealth() => Volatile.Read(ref _health);
- /// Gets the current memory footprint of the driver.
+ ///
public long GetMemoryFootprint() => 0;
- /// Flushes optional internal caches.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous cache flush operation.
+ ///
public Task FlushOptionalCachesAsync(CancellationToken cancellationToken) => Task.CompletedTask;
/// Gets the number of configured devices.
@@ -224,10 +214,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- IReadable ----
- /// Reads values from one or more tags asynchronously.
- /// A read-only list of tag references to read.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous read operation.
+ ///
public async Task> ReadAsync(
IReadOnlyList fullReferences, CancellationToken cancellationToken)
{
@@ -294,10 +281,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- IWritable ----
- /// Writes values to one or more tags asynchronously.
- /// A read-only list of write requests.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous write operation.
+ ///
public async Task> WriteAsync(
IReadOnlyList writes, CancellationToken cancellationToken)
{
@@ -363,10 +347,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- ITagDiscovery ----
- /// Discovers tags and builds the OPC UA address space asynchronously.
- /// The address space builder for constructing the OPC UA namespace.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous discovery operation.
+ ///
public Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(builder);
@@ -543,19 +524,12 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- ISubscribable (polling overlay via shared engine) ----
- /// Subscribes to data changes on one or more tags.
- /// A read-only list of tag references to subscribe to.
- /// The interval at which to publish data changes.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous subscription operation.
+ ///
public Task SubscribeAsync(
IReadOnlyList fullReferences, TimeSpan publishingInterval, CancellationToken cancellationToken) =>
Task.FromResult(_poll.Subscribe(fullReferences, publishingInterval));
- /// Unsubscribes from a previous subscription.
- /// The subscription handle to unsubscribe from.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous unsubscription operation.
+ ///
public Task UnsubscribeAsync(ISubscriptionHandle handle, CancellationToken cancellationToken)
{
_poll.Unsubscribe(handle);
@@ -564,7 +538,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- IHostConnectivityProbe ----
- /// Gets the connectivity status of all configured devices.
+ ///
public IReadOnlyList GetHostStatuses() =>
[.. _devices.Values.Select(s => new HostConnectivityStatus(s.Options.HostAddress, s.HostState, s.HostStateChangedUtc))];
@@ -970,10 +944,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- IAlarmSource ----
- /// Subscribes to alarm events from the driver.
- /// A read-only list of source node IDs to subscribe to.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous subscription operation.
+ ///
public Task SubscribeAlarmsAsync(
IReadOnlyList sourceNodeIds, CancellationToken cancellationToken)
{
@@ -983,17 +954,11 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
return _alarmProjection.SubscribeAsync(sourceNodeIds, cancellationToken);
}
- /// Unsubscribes from a previous alarm subscription.
- /// The alarm subscription handle to unsubscribe from.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous unsubscription operation.
+ ///
public Task UnsubscribeAlarmsAsync(IAlarmSubscriptionHandle handle, CancellationToken cancellationToken) =>
_alarmProjection is { } p ? p.UnsubscribeAsync(handle, cancellationToken) : Task.CompletedTask;
- /// Acknowledges one or more alarms.
- /// A read-only list of alarm acknowledgement requests.
- /// Cancellation token for the operation.
- /// A task representing the asynchronous acknowledgement operation.
+ ///
public Task AcknowledgeAsync(
IReadOnlyList acknowledgements, CancellationToken cancellationToken) =>
_alarmProjection is { } p ? p.AcknowledgeAsync(acknowledgements, cancellationToken) : Task.CompletedTask;
@@ -1035,9 +1000,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
// ---- IPerCallHostResolver ----
- /// Resolves the host address for a given tag reference.
- /// The full reference of the tag.
- /// The host address for the tag reference.
+ ///
public string ResolveHost(string fullReference)
{
if (_tagsByName.TryGetValue(fullReference, out var def))
@@ -1077,6 +1040,7 @@ public sealed class FocasDriver : IDriver, IReadable, IWritable, ITagDiscovery,
/// Disposes the driver and releases all resources synchronously.
public void Dispose() => DisposeAsync().AsTask().GetAwaiter().GetResult();
/// Disposes the driver and releases all resources asynchronously.
+ /// A task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync() => await ShutdownAsync(CancellationToken.None).ConfigureAwait(false);
///
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/IFocasClient.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/IFocasClient.cs
index dbc46cef..21c79e38 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/IFocasClient.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/IFocasClient.cs
@@ -20,6 +20,7 @@ public interface IFocasClient : IDisposable
/// The CNC host address and port.
/// The connection timeout duration.
/// The cancellation token.
+ /// A task that represents the asynchronous connect operation.
Task ConnectAsync(FocasHostAddress address, TimeSpan timeout, CancellationToken cancellationToken);
/// True when the FWLIB handle is valid + the socket is up.
@@ -33,6 +34,7 @@ public interface IFocasClient : IDisposable
/// The CNC memory address to read from.
/// The FOCAS data type to read.
/// The cancellation token.
+ /// A task that resolves to the read value and its OPC UA status code.
Task<(object? value, uint status)> ReadAsync(
FocasAddress address,
FocasDataType type,
@@ -46,6 +48,7 @@ public interface IFocasClient : IDisposable
/// The FOCAS data type to write.
/// The value to write.
/// The cancellation token.
+ /// A task that resolves to the mapped OPC UA status code (0 = Good).
Task WriteAsync(
FocasAddress address,
FocasDataType type,
@@ -57,6 +60,7 @@ public interface IFocasClient : IDisposable
/// responds with any valid status.
///
/// The cancellation token.
+ /// A task that resolves to true when the CNC responds; otherwise false.
Task ProbeAsync(CancellationToken cancellationToken);
///
@@ -66,6 +70,7 @@ public interface IFocasClient : IDisposable
/// emits transitions (raise / clear) on the driver's OnAlarmEvent.
///
/// The cancellation token.
+ /// A task that resolves to the list of currently active alarms.
Task> ReadAlarmsAsync(CancellationToken cancellationToken);
// ---- Fixed-tree T1 (identity + axis discovery + fast-poll dynamic bundle) ----
@@ -76,6 +81,7 @@ public interface IFocasClient : IDisposable
/// values don't change across the session.
///
/// The cancellation token.
+ /// A task that resolves to the CNC system information snapshot.
Task GetSysInfoAsync(CancellationToken cancellationToken);
///
@@ -84,6 +90,7 @@ public interface IFocasClient : IDisposable
/// calls.
///
/// The cancellation token.
+ /// A task that resolves to the list of configured axis names.
Task> GetAxisNamesAsync(CancellationToken cancellationToken);
///
@@ -91,6 +98,7 @@ public interface IFocasClient : IDisposable
/// the Spindle/{name}/ subtree.
///
/// The cancellation token.
+ /// A task that resolves to the list of configured spindle names.
Task> GetSpindleNamesAsync(CancellationToken cancellationToken);
///
@@ -101,6 +109,7 @@ public interface IFocasClient : IDisposable
///
/// The axis index to read dynamics for.
/// The cancellation token.
+ /// A task that resolves to the dynamic snapshot for the specified axis.
Task ReadDynamicAsync(int axisIndex, CancellationToken cancellationToken);
// ---- Fixed-tree T2 (program + operation mode) ----
@@ -113,6 +122,7 @@ public interface IFocasClient : IDisposable
/// on human-operator timescales.
///
/// The cancellation token.
+ /// A task that resolves to the program and operation-mode snapshot.
Task GetProgramInfoAsync(CancellationToken cancellationToken);
// ---- Fixed-tree T3 (timers) ----
@@ -124,6 +134,7 @@ public interface IFocasClient : IDisposable
///
/// The timer kind to read.
/// The cancellation token.
+ /// A task that resolves to the requested cumulative timer reading.
Task GetTimerAsync(FocasTimerKind kind, CancellationToken cancellationToken);
// ---- Fixed-tree T3.5 (servo meters) ----
@@ -134,6 +145,7 @@ public interface IFocasClient : IDisposable
/// disconnected session or unsupported CNC.
///
/// The cancellation token.
+ /// A task that resolves to the list of servo-load meter readings.
Task> GetServoLoadsAsync(CancellationToken cancellationToken);
// ---- Fixed-tree T3.6 (spindle meters) ----
@@ -145,6 +157,7 @@ public interface IFocasClient : IDisposable
/// series like 16i may return EW_FUNC).
///
/// The cancellation token.
+ /// A task that resolves to the list of per-spindle load percentages.
Task> GetSpindleLoadsAsync(CancellationToken cancellationToken);
///
@@ -152,6 +165,7 @@ public interface IFocasClient : IDisposable
/// bootstrap. Index alignment as per .
///
/// The cancellation token.
+ /// A task that resolves to the list of per-spindle maximum RPM values.
Task> GetSpindleMaxRpmsAsync(CancellationToken cancellationToken);
}
@@ -292,9 +306,7 @@ public interface IFocasClientFactory
///
public sealed class UnimplementedFocasClientFactory : IFocasClientFactory
{
- /// Creates a new client instance (always throws NotSupportedException).
- /// Never returns; always throws NotSupportedException.
- /// Always thrown to indicate backend is not yet provisioned.
+ ///
public IFocasClient Create() => throw new NotSupportedException(
"FOCAS driver backend is 'unimplemented'. Switch to 'Backend: \"wire\"' in driver config " +
"once the CNC is provisioned — see docs/drivers/FOCAS.md.");
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/FocasWireClient.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/FocasWireClient.cs
index 390a9bdc..d97fb083 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/FocasWireClient.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/FocasWireClient.cs
@@ -70,6 +70,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// The FOCAS/2 TCP port (typically 8193).
/// Connection timeout in seconds; zero or negative disables the timeout.
/// Cancellation token for the connect operation.
+ /// A task that represents the asynchronous operation.
public Task ConnectAsync(
string host,
int port,
@@ -90,6 +91,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// The FOCAS/2 TCP port (typically 8193).
/// Connection timeout duration; disables the timeout.
/// Cancellation token for the connect operation.
+ /// A task that represents the asynchronous operation.
public Task ConnectAsync(
string host,
int port,
@@ -183,6 +185,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Async dispose — sends the close PDU when connected and tears down both sockets.
/// Idempotent.
///
+ /// A value task that represents the asynchronous operation.
public async ValueTask DisposeAsync()
{
await _lifetimeGate.WaitAsync(CancellationToken.None).ConfigureAwait(false);
@@ -218,6 +221,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the CNC system info result.
public async Task> ReadSysInfoAsync(
CancellationToken cancellationToken = default,
TimeSpan? timeout = null,
@@ -233,6 +237,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the CNC status result.
public async Task> ReadStatusAsync(
CancellationToken cancellationToken = default,
TimeSpan? timeout = null,
@@ -272,6 +277,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the list of axis name records.
public async Task>> ReadAxisNamesAsync(
short maxCount = 32,
CancellationToken cancellationToken = default,
@@ -288,6 +294,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the list of spindle name records.
public async Task>> ReadSpindleNamesAsync(
short maxCount = 8,
CancellationToken cancellationToken = default,
@@ -308,6 +315,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the dynamic axis data result.
public async Task> ReadDynamic2Async(
short axis = 1,
CancellationToken cancellationToken = default,
@@ -353,6 +361,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the list of servo meter readings.
public async Task>> ReadServoMeterAsync(
short maxCount = 32,
CancellationToken cancellationToken = default,
@@ -390,6 +399,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the list of spindle load metrics.
public Task>> ReadSpindleLoadAsync(
short spindleSelector = -1,
CancellationToken cancellationToken = default,
@@ -402,6 +412,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the list of spindle maximum RPM metrics.
public Task>> ReadSpindleMaxRpmAsync(
short spindleSelector = -1,
CancellationToken cancellationToken = default,
@@ -419,6 +430,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the raw parameter bytes result.
public async Task> ReadParameterBytesAsync(
short dataNumber,
short axis = 0,
@@ -438,6 +450,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the typed parameter result.
public async Task> ReadParameterAsync(
short dataNumber,
short type = 0,
@@ -458,6 +471,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the byte parameter result.
public async Task> ReadParameterByteAsync(short dataNumber, short axis = 0, CancellationToken cancellationToken = default, TimeSpan? timeout = null, ushort? pathId = null)
{
var result = await ReadParameterBytesAsync(dataNumber, axis, cancellationToken, timeout, pathId).ConfigureAwait(false);
@@ -472,6 +486,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the 16-bit integer parameter result.
public async Task> ReadParameterInt16Async(short dataNumber, short axis = 0, CancellationToken cancellationToken = default, TimeSpan? timeout = null, ushort? pathId = null)
{
var result = await ReadParameterBytesAsync(dataNumber, axis, cancellationToken, timeout, pathId).ConfigureAwait(false);
@@ -486,6 +501,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the 32-bit integer parameter result.
public async Task> ReadParameterInt32Async(short dataNumber, short axis = 0, CancellationToken cancellationToken = default, TimeSpan? timeout = null, ushort? pathId = null)
{
var result = await ReadParameterBytesAsync(dataNumber, axis, cancellationToken, timeout, pathId).ConfigureAwait(false);
@@ -500,6 +516,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the single-precision float parameter result.
public async Task> ReadParameterFloat32Async(short dataNumber, short axis = 0, CancellationToken cancellationToken = default, TimeSpan? timeout = null, ushort? pathId = null)
{
var result = await ReadParameterBytesAsync(dataNumber, axis, cancellationToken, timeout, pathId).ConfigureAwait(false);
@@ -514,6 +531,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the double-precision float parameter result.
public async Task> ReadParameterFloat64Async(short dataNumber, short axis = 0, CancellationToken cancellationToken = default, TimeSpan? timeout = null, ushort? pathId = null)
{
var result = await ReadParameterBytesAsync(dataNumber, axis, cancellationToken, timeout, pathId).ConfigureAwait(false);
@@ -527,6 +545,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the macro variable result.
public Task> ReadMacroAsync(
short number,
CancellationToken cancellationToken = default,
@@ -550,6 +569,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the PMC range result.
public async Task> ReadPmcRangeAsync(
short area,
short dataType,
@@ -602,6 +622,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the PMC range result.
public Task> ReadPmcRangeAsync(
FocasPmcArea area,
FocasPmcDataType dataType,
@@ -622,6 +643,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the list of active alarms.
public async Task>> ReadAlarmsAsync(
short type = -1,
short count = 32,
@@ -641,6 +663,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the operation mode result.
public Task> ReadOperationModeAsync(
CancellationToken cancellationToken = default,
TimeSpan? timeout = null,
@@ -658,6 +681,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the raw operation mode code.
public Task> ReadOperationModeCodeAsync(
CancellationToken cancellationToken = default,
TimeSpan? timeout = null,
@@ -671,6 +695,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the executing program name result.
public Task> ReadExecutingProgramNameAsync(
CancellationToken cancellationToken = default,
TimeSpan? timeout = null,
@@ -681,6 +706,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the executed block count.
public Task> ReadBlockCountAsync(
CancellationToken cancellationToken = default,
TimeSpan? timeout = null,
@@ -698,6 +724,7 @@ public sealed class FocasWireClient : IAsyncDisposable, IDisposable
/// Cancellation token for the read operation.
/// Optional per-call timeout override.
/// Optional path ID override; defaults to .
+ /// A task containing the timer value result.
public Task> ReadTimerAsync(
short type,
CancellationToken cancellationToken = default,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/WireFocasClient.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/WireFocasClient.cs
index fd6f70de..eed94fa2 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/WireFocasClient.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS/Wire/WireFocasClient.cs
@@ -36,13 +36,10 @@ public sealed class WireFocasClient : IFocasClient
_wire = new FocasWireClient(logger);
}
- /// Gets a value indicating whether the wire client is connected to the FOCAS host.
+ ///
public bool IsConnected => _wire.IsConnected;
- /// Connects to a FOCAS host at the specified address.
- /// The host address containing the machine name and port.
- /// The connection timeout; values less than or equal to zero are clamped to 1 second.
- /// Cancellation token for the operation.
+ ///
public async Task ConnectAsync(FocasHostAddress address, TimeSpan timeout, CancellationToken cancellationToken)
{
if (_wire.IsConnected) return;
@@ -54,11 +51,7 @@ public sealed class WireFocasClient : IFocasClient
await _wire.ConnectAsync(address.Host, address.Port, effective, cancellationToken).ConfigureAwait(false);
}
- /// Reads a value from the specified FOCAS address.
- /// The FOCAS address to read from.
- /// The FOCAS data type of the value.
- /// Cancellation token for the operation.
- /// A tuple containing the read value and FOCAS status code.
+ ///
public async Task<(object? value, uint status)> ReadAsync(
FocasAddress address, FocasDataType type, CancellationToken cancellationToken)
{
@@ -74,19 +67,12 @@ public sealed class WireFocasClient : IFocasClient
};
}
- /// Writes a value to a FOCAS address (always returns BadNotWritable as OtOpcUa is read-only).
- /// The FOCAS address to write to.
- /// The FOCAS data type of the value.
- /// The value to write.
- /// Cancellation token for the operation.
- /// A task that returns the BadNotWritable status code.
+ ///
public Task WriteAsync(
FocasAddress address, FocasDataType type, object? value, CancellationToken cancellationToken)
=> Task.FromResult(FocasStatusMapper.BadNotWritable);
- /// Probes the FOCAS host to verify connectivity.
- /// Cancellation token for the operation.
- /// True if the probe succeeds; otherwise false.
+ ///
public async Task ProbeAsync(CancellationToken cancellationToken)
{
if (!_wire.IsConnected) return false;
@@ -101,9 +87,7 @@ public sealed class WireFocasClient : IFocasClient
}
}
- /// Reads all active alarms from the FOCAS host.
- /// Cancellation token for the operation.
- /// A list of active alarms; empty if read fails or not connected.
+ ///
public async Task> ReadAlarmsAsync(CancellationToken cancellationToken)
{
if (!_wire.IsConnected) return [];
@@ -125,9 +109,7 @@ public sealed class WireFocasClient : IFocasClient
Message: a.Message ?? string.Empty);
}
- /// Gets system information from the FOCAS host.
- /// Cancellation token for the operation.
- /// The FOCAS system information.
+ ///
public async Task GetSysInfoAsync(CancellationToken cancellationToken)
{
RequireConnected();
@@ -147,9 +129,7 @@ public sealed class WireFocasClient : IFocasClient
AxesCount: axesCount);
}
- /// Gets the names of all axes on the FOCAS host.
- /// Cancellation token for the operation.
- /// A list of axis names; empty if read fails or not connected.
+ ///
public async Task> GetAxisNamesAsync(CancellationToken cancellationToken)
{
if (!_wire.IsConnected) return [];
@@ -169,9 +149,7 @@ public sealed class WireFocasClient : IFocasClient
}
}
- /// Gets the names of all spindles on the FOCAS host.
- /// Cancellation token for the operation.
- /// A list of spindle names; empty if read fails or not connected.
+ ///
public async Task> GetSpindleNamesAsync(CancellationToken cancellationToken)
{
if (!_wire.IsConnected) return [];
@@ -190,10 +168,7 @@ public sealed class WireFocasClient : IFocasClient
}
}
- /// Reads the dynamic state of a specified axis.
- /// The index of the axis to read.
- /// Cancellation token for the operation.
- /// The dynamic snapshot of the axis.
+ ///
public async Task ReadDynamicAsync(int axisIndex, CancellationToken cancellationToken)
{
RequireConnected();
@@ -215,9 +190,7 @@ public sealed class WireFocasClient : IFocasClient
DistanceToGo: pos.Distance);
}
- /// Gets information about the currently executing program.
- /// Cancellation token for the operation.
- /// The current program information.
+ ///
public async Task GetProgramInfoAsync(CancellationToken cancellationToken)
{
RequireConnected();
@@ -245,10 +218,7 @@ public sealed class WireFocasClient : IFocasClient
Mode: modeResult.IsOk ? modeResult.Value : 0);
}
- /// Gets a timer value from the FOCAS host.
- /// The kind of timer to read (run time, cutting time, etc.).
- /// Cancellation token for the operation.
- /// The timer value.
+ ///
public async Task GetTimerAsync(FocasTimerKind kind, CancellationToken cancellationToken)
{
RequireConnected();
@@ -258,9 +228,7 @@ public sealed class WireFocasClient : IFocasClient
return new FocasTimer(kind, t.Minutes, t.Milliseconds);
}
- /// Gets servo load information for all axes.
- /// Cancellation token for the operation.
- /// A list of servo load values for each axis; empty if read fails or not connected.
+ ///
public async Task> GetServoLoadsAsync(CancellationToken cancellationToken)
{
if (!_wire.IsConnected) return [];
@@ -272,15 +240,11 @@ public sealed class WireFocasClient : IFocasClient
.ToList();
}
- /// Gets spindle load information for all spindles.
- /// Cancellation token for the operation.
- /// A list of spindle load percentages; empty if read fails or not connected.
+ ///
public Task> GetSpindleLoadsAsync(CancellationToken cancellationToken) =>
ReadSpindleMetricAsync((sel, ct) => _wire.ReadSpindleLoadAsync(sel, ct), cancellationToken);
- /// Gets maximum RPM information for all spindles.
- /// Cancellation token for the operation.
- /// A list of maximum RPM values for each spindle; empty if read fails or not connected.
+ ///
public Task> GetSpindleMaxRpmsAsync(CancellationToken cancellationToken) =>
ReadSpindleMetricAsync((sel, ct) => _wire.ReadSpindleMaxRpmAsync(sel, ct), cancellationToken);
@@ -427,7 +391,6 @@ public sealed class WireFocasClientFactory : IFocasClientFactory
_logger = logger;
}
- /// Creates a new WireFocasClient instance.
- /// A new IFocasClient implementation.
+ ///
public IFocasClient Create() => new WireFocasClient(_logger);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyBrowseSession.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyBrowseSession.cs
index 431c867c..1734ea97 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyBrowseSession.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyBrowseSession.cs
@@ -22,10 +22,10 @@ internal sealed class GalaxyBrowseSession : IBrowseSession
private volatile bool _disposed;
private IReadOnlyList? _roots;
- /// Opaque token identifying this session in the AdminUI registry.
+ ///
public Guid Token { get; } = Guid.NewGuid();
- /// Wall-clock time of the most recent successful Root/Expand/Attributes call.
+ ///
public DateTime LastUsedUtc { get; private set; } = DateTime.UtcNow;
///
@@ -45,6 +45,8 @@ internal sealed class GalaxyBrowseSession : IBrowseSession
/// returns them as s. Result is cached; a second call
/// returns the cached roots without a re-fetch.
///
+ /// Cancellation token for the operation.
+ /// The top-level browse nodes.
public async Task> RootAsync(CancellationToken cancellationToken)
{
ObjectDisposedException.ThrowIf(_disposed, this);
@@ -69,6 +71,9 @@ internal sealed class GalaxyBrowseSession : IBrowseSession
/// . Throws
/// if the tag hasn't been handed out by a prior Root/Expand call.
///
+ /// The tag name of the node to expand.
+ /// Cancellation token for the operation.
+ /// The direct child browse nodes.
public async Task> ExpandAsync(string nodeId, CancellationToken cancellationToken)
{
ObjectDisposedException.ThrowIf(_disposed, this);
@@ -89,6 +94,9 @@ internal sealed class GalaxyBrowseSession : IBrowseSession
/// via DiscoverHierarchyAsync(MaxDepth=0, RootTagName=nodeId, IncludeAttributes=true).
/// Returns an empty list if the gateway has no matching object.
///
+ /// The tag name of the node to fetch attributes for.
+ /// Cancellation token for the operation.
+ /// The attribute information for the node, or an empty list if not found.
public async Task> AttributesAsync(string nodeId, CancellationToken cancellationToken)
{
ObjectDisposedException.ThrowIf(_disposed, this);
@@ -162,6 +170,7 @@ internal sealed class GalaxyBrowseSession : IBrowseSession
/// Idempotently tears down the underlying repository client. Swallows exceptions
/// on shutdown — the registry's reaper may be racing a client-initiated close.
///
+ /// A task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyDriverBrowser.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyDriverBrowser.cs
index 35fcdccd..52a0d7bc 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyDriverBrowser.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Browser/GalaxyDriverBrowser.cs
@@ -42,7 +42,7 @@ public sealed class GalaxyDriverBrowser : IDriverBrowser
_logger = logger ?? NullLogger.Instance;
}
- /// Driver type key — matches the AdminUI's persisted "GalaxyMxGateway" value.
+ ///
// Hardcoded literal: this project references Driver.Galaxy.Contracts, not Driver.Galaxy,
// so GalaxyDriverFactoryExtensions.DriverTypeName isn't available here.
public string DriverType => "GalaxyMxGateway";
@@ -60,6 +60,7 @@ public sealed class GalaxyDriverBrowser : IDriverBrowser
/// Thrown when the JSON deserialises to null, when Gateway.Endpoint is empty,
/// or when MxAccess.ClientName is empty.
///
+ /// An open browse session over the Galaxy repository client.
public async Task OpenAsync(string configJson, CancellationToken cancellationToken)
{
var opts = JsonSerializer.Deserialize(configJson, JsonOpts)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/AlarmRefBuilder.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/AlarmRefBuilder.cs
index 2ab50439..e5152c70 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/AlarmRefBuilder.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/AlarmRefBuilder.cs
@@ -39,6 +39,7 @@ internal static class AlarmRefBuilder
/// The full reference of the alarm-bearing attribute.
/// The initial alarm severity level.
/// The initial alarm description.
+ /// An with all five sub-attribute references populated.
public static AlarmConditionInfo Build(
string fullReference,
AlarmSeverity initialSeverity = AlarmSeverity.Medium,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DataTypeMap.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DataTypeMap.cs
index 92f08c6c..b9c5f79e 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DataTypeMap.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DataTypeMap.cs
@@ -20,6 +20,7 @@ internal static class DataTypeMap
{
/// Maps an MXAccess data type ID to a driver data type.
/// The MXAccess data type ID.
+ /// The corresponding , defaulting to for unknown codes.
public static DriverDataType Map(int mxDataType) => mxDataType switch
{
0 => DriverDataType.Boolean,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DeployWatcher.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DeployWatcher.cs
index c11325fb..aa1649d5 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DeployWatcher.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/DeployWatcher.cs
@@ -98,6 +98,7 @@ public sealed class DeployWatcher : IDisposable
}
/// Cancels the loop and waits for it to exit cleanly.
+ /// A task that represents the asynchronous stop operation.
public async Task StopAsync()
{
var cts = _cts;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GalaxyDiscoverer.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GalaxyDiscoverer.cs
index d07c79e3..65f579d8 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GalaxyDiscoverer.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GalaxyDiscoverer.cs
@@ -39,6 +39,7 @@ public sealed class GalaxyDiscoverer
///
/// The address space builder to populate with discovery results.
/// The cancellation token for the operation.
+ /// A task that represents the asynchronous discovery operation.
public async Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(builder);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyDeployWatchSource.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyDeployWatchSource.cs
index c984c251..4486efc8 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyDeployWatchSource.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyDeployWatchSource.cs
@@ -22,10 +22,7 @@ public sealed class GatewayGalaxyDeployWatchSource : IGalaxyDeployWatchSource
_client = client ?? throw new ArgumentNullException(nameof(client));
}
- /// Watches for deploy events asynchronously.
- /// The last deploy time that was observed.
- /// The cancellation token.
- /// An async enumerable of deploy events.
+ ///
public IAsyncEnumerable WatchAsync(
DateTimeOffset? lastSeenDeployTime, CancellationToken cancellationToken)
=> _client.WatchDeployEventsAsync(lastSeenDeployTime, cancellationToken);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyHierarchySource.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyHierarchySource.cs
index d3382ddb..9cd4cc3f 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyHierarchySource.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/GatewayGalaxyHierarchySource.cs
@@ -24,6 +24,7 @@ public sealed class GatewayGalaxyHierarchySource : IGalaxyHierarchySource
/// Discovers the Galaxy object hierarchy asynchronously via the gateway.
///
/// Cancellation token for the operation.
+ /// A task that resolves to the full list of Galaxy objects in the hierarchy.
public Task> GetHierarchyAsync(CancellationToken cancellationToken)
=> _client.DiscoverHierarchyAsync(cancellationToken);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyDeployWatchSource.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyDeployWatchSource.cs
index 8ed170d3..7e981c73 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyDeployWatchSource.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyDeployWatchSource.cs
@@ -21,6 +21,7 @@ public interface IGalaxyDeployWatchSource
///
/// The last seen deploy time, or null to receive a bootstrap event.
/// The cancellation token.
+ /// An async stream of deploy events.
IAsyncEnumerable WatchAsync(
DateTimeOffset? lastSeenDeployTime, CancellationToken cancellationToken);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyHierarchySource.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyHierarchySource.cs
index fd3c0b06..7512b185 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyHierarchySource.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Browse/IGalaxyHierarchySource.cs
@@ -16,5 +16,6 @@ public interface IGalaxyHierarchySource
/// callers don't reimplement paging.
///
/// Cancellation token for the operation.
+ /// A task that resolves to the full materialised Galaxy object hierarchy.
Task> GetHierarchyAsync(CancellationToken cancellationToken);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriver.cs
index 1bcc63b6..c52e9950 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriver.cs
@@ -126,7 +126,7 @@ public sealed class GalaxyDriver
/// Fires when a host transitions Running ↔ Stopped (PR 4.7 HostStatusAggregator).
public event EventHandler? OnHostStatusChanged;
- ///
+ /// Fires when an alarm event is received from the Galaxy alarm feed.
public event EventHandler? OnAlarmEvent;
/// Initializes a new instance of the class.
@@ -202,6 +202,7 @@ public sealed class GalaxyDriver
/// asserted deterministically (Driver.Galaxy-013).
///
/// Cancellation token for the replay operation.
+ /// A task that represents the asynchronous replay operation.
internal Task InvokeReplayForTestAsync(CancellationToken cancellationToken) =>
ReplayAsync(cancellationToken);
@@ -449,6 +450,7 @@ public sealed class GalaxyDriver
/// changing the call site.
///
/// The secret reference string to resolve.
+ /// The resolved API key string.
internal static string ResolveApiKey(string secretRef) => ResolveApiKey(secretRef, logger: null);
///
@@ -459,6 +461,7 @@ public sealed class GalaxyDriver
///
/// The secret reference string to resolve.
/// Optional logger for warning on cleartext keys.
+ /// The resolved API key string.
internal static string ResolveApiKey(string secretRef, ILogger? logger)
{
ArgumentException.ThrowIfNullOrEmpty(secretRef);
@@ -1205,6 +1208,7 @@ public sealed class GalaxyDriver
/// GetAwaiter().GetResult() for every async sub-component, risking a
/// deadlock under thread-pool starvation).
///
+ /// A value task that represents the asynchronous disposal operation.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
@@ -1278,26 +1282,18 @@ public sealed class GalaxyDriver
System.Collections.Concurrent.ConcurrentDictionary map)
: IAddressSpaceBuilder
{
- /// Creates a folder node and returns a builder for populating it.
- /// The OPC UA BrowseName of the folder.
- /// The display name for the folder.
+ ///
public IAddressSpaceBuilder Folder(string browseName, string displayName)
=> new SecurityCapturingBuilder(inner.Folder(browseName, displayName), map);
- /// Creates a variable node and captures its security classification.
- /// The OPC UA BrowseName of the variable.
- /// The display name for the variable.
- /// The driver attribute metadata including security classification.
+ ///
public IVariableHandle Variable(string browseName, string displayName, DriverAttributeInfo attributeInfo)
{
map[attributeInfo.FullName] = attributeInfo.SecurityClass;
return inner.Variable(browseName, displayName, attributeInfo);
}
- /// Adds a property node to the current parent.
- /// The OPC UA BrowseName of the property.
- /// The OPC UA data type of the property.
- /// The property value.
+ ///
public void AddProperty(string browseName, DriverDataType dataType, object? value)
=> inner.AddProperty(browseName, dataType, value);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriverFactoryExtensions.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriverFactoryExtensions.cs
index 328aae88..3b92c059 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriverFactoryExtensions.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/GalaxyDriverFactoryExtensions.cs
@@ -35,6 +35,7 @@ public static class GalaxyDriverFactoryExtensions
/// Convenience for tests + standalone callers.
/// The unique identifier for the driver instance.
/// The driver configuration in JSON format.
+ /// A configured instance.
public static GalaxyDriver CreateInstance(string driverInstanceId, string driverConfigJson)
=> CreateInstance(driverInstanceId, driverConfigJson, loggerFactory: null);
@@ -42,6 +43,7 @@ public static class GalaxyDriverFactoryExtensions
/// The unique identifier for the driver instance.
/// The driver configuration in JSON format.
/// The optional logger factory for creating drivers.
+ /// A configured instance.
public static GalaxyDriver CreateInstance(
string driverInstanceId, string driverConfigJson, ILoggerFactory? loggerFactory)
{
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/HostStatusAggregator.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/HostStatusAggregator.cs
index a606f908..cea862d3 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/HostStatusAggregator.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/HostStatusAggregator.cs
@@ -38,6 +38,7 @@ public sealed class HostStatusAggregator
/// Snapshot the current host set. Suitable as the body of
/// IHostConnectivityProbe.GetHostStatuses().
///
+ /// A snapshot of all currently tracked host connectivity statuses.
public IReadOnlyList Snapshot()
{
lock (_lock)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/PerPlatformProbeWatcher.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/PerPlatformProbeWatcher.cs
index daefb2ea..b766e38b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/PerPlatformProbeWatcher.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Health/PerPlatformProbeWatcher.cs
@@ -77,6 +77,7 @@ public sealed class PerPlatformProbeWatcher : IDisposable
///
/// The platform tag names to synchronize.
/// A cancellation token to cancel the operation.
+ /// A task that represents the asynchronous operation.
public async Task SyncPlatformsAsync(
IEnumerable platformTagNames, CancellationToken cancellationToken)
{
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxyMxSession.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxyMxSession.cs
index 7913c69c..746ef7ca 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxyMxSession.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxyMxSession.cs
@@ -55,6 +55,7 @@ public sealed class GalaxyMxSession : IAsyncDisposable
///
/// The MX gateway client options.
/// The cancellation token.
+ /// A task that represents the asynchronous connect operation.
public async Task ConnectAsync(MxGatewayClientOptions clientOptions, CancellationToken cancellationToken)
{
ObjectDisposedException.ThrowIf(_disposed, this);
@@ -89,6 +90,7 @@ public sealed class GalaxyMxSession : IAsyncDisposable
public MxGatewaySession? Session => _session;
/// Disposes the session and underlying gateway client resources.
+ /// A value task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxySubscriptionHandle.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxySubscriptionHandle.cs
index 9103e395..290984d6 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxySubscriptionHandle.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GalaxySubscriptionHandle.cs
@@ -8,6 +8,6 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Runtime;
///
internal sealed record GalaxySubscriptionHandle(long SubscriptionId) : ISubscriptionHandle
{
- /// Gets the diagnostic identifier for the subscription.
+ ///
public string DiagnosticId => $"galaxy-sub-{SubscriptionId}";
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmAcknowledger.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmAcknowledger.cs
index 19b957da..d5fc35f1 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmAcknowledger.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmAcknowledger.cs
@@ -37,6 +37,7 @@ internal sealed class GatewayGalaxyAlarmAcknowledger : IGalaxyAlarmAcknowledger
/// An operator-supplied comment attached to the acknowledgement.
/// The name of the operator performing the acknowledgement.
/// A token to cancel the asynchronous operation.
+ /// A task that represents the asynchronous acknowledge operation.
public async Task AcknowledgeAsync(
string alarmFullReference,
string comment,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmFeed.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmFeed.cs
index e01c1c61..3a584f30 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmFeed.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxyAlarmFeed.cs
@@ -39,6 +39,7 @@ internal sealed class GatewayGalaxyAlarmFeed : IGalaxyAlarmFeed
///
/// The stream request parameters.
/// A cancellation token.
+ /// An async enumerable of alarm feed messages from the gateway stream.
internal delegate IAsyncEnumerable AlarmStreamFactory(
StreamAlarmsRequest request, CancellationToken cancellationToken);
@@ -261,6 +262,7 @@ internal sealed class GatewayGalaxyAlarmFeed : IGalaxyAlarmFeed
};
/// Releases the alarm feed resources and stops the background stream task.
+ /// A that completes when the background stream loop has stopped.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxySubscriber.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxySubscriber.cs
index e38430f6..664b9b2d 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxySubscriber.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/GatewayGalaxySubscriber.cs
@@ -28,11 +28,7 @@ public sealed class GatewayGalaxySubscriber : IGalaxySubscriber
_session = session ?? throw new ArgumentNullException(nameof(session));
}
- /// Subscribes to a bulk list of Galaxy references with optional buffered update interval.
- /// The full Galaxy tag references to subscribe to.
- /// The buffered update interval in milliseconds.
- /// The cancellation token.
- /// A task that returns a list of subscribe results.
+ ///
public async Task> SubscribeBulkAsync(
IReadOnlyList fullReferences, int bufferedUpdateIntervalMs, CancellationToken cancellationToken)
{
@@ -100,10 +96,7 @@ public sealed class GatewayGalaxySubscriber : IGalaxySubscriber
}
}
- /// Unsubscribes from a bulk list of item handles.
- /// The item handles to unsubscribe from.
- /// The cancellation token.
- /// A task representing the unsubscribe operation.
+ ///
public async Task UnsubscribeBulkAsync(IReadOnlyList itemHandles, CancellationToken cancellationToken)
{
if (itemHandles.Count == 0) return;
@@ -117,9 +110,7 @@ public sealed class GatewayGalaxySubscriber : IGalaxySubscriber
.ConfigureAwait(false);
}
- /// Streams Galaxy MX events asynchronously.
- /// The cancellation token.
- /// An async enumerable of MX events.
+ ///
public IAsyncEnumerable StreamEventsAsync(CancellationToken cancellationToken)
{
var session = _session.Session
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyAlarmAcknowledger.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyAlarmAcknowledger.cs
index aa9b1c89..752c4c30 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyAlarmAcknowledger.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyAlarmAcknowledger.cs
@@ -24,6 +24,7 @@ internal interface IGalaxyAlarmAcknowledger
/// OPC UA session by the server-side ACL layer before reaching the driver.
///
/// Cancels the gateway RPC.
+ /// A task that represents the asynchronous acknowledge operation.
Task AcknowledgeAsync(
string alarmFullReference,
string comment,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyDataWriter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyDataWriter.cs
index f91e66e2..7b78e2d5 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyDataWriter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxyDataWriter.cs
@@ -26,6 +26,7 @@ public interface IGalaxyDataWriter
/// (the safest default — non-secured Write).
///
/// Aborts the in-flight batch.
+ /// A task resolving to one per input entry, in input order.
Task> WriteAsync(
IReadOnlyList writes,
Func securityResolver,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxySubscriber.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxySubscriber.cs
index 9d33968e..3c66c9cb 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxySubscriber.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/IGalaxySubscriber.cs
@@ -20,12 +20,14 @@ public interface IGalaxySubscriber
/// The list of tag references to subscribe to.
/// The buffered update interval in milliseconds.
/// Cancellation token for the operation.
+ /// A task that resolves to one per requested reference, in input order.
Task> SubscribeBulkAsync(
IReadOnlyList fullReferences, int bufferedUpdateIntervalMs, CancellationToken cancellationToken);
/// Unsubscribe a batch of item handles obtained from .
/// The item handles to unsubscribe.
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
Task UnsubscribeBulkAsync(IReadOnlyList itemHandles, CancellationToken cancellationToken);
///
@@ -34,5 +36,6 @@ public interface IGalaxySubscriber
/// its .
///
/// Cancellation token for the stream.
+ /// An async sequence of items emitted by the gateway.
IAsyncEnumerable StreamEventsAsync(CancellationToken cancellationToken);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxAccessSeverityMapper.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxAccessSeverityMapper.cs
index 338b94fa..a2e6897a 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxAccessSeverityMapper.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxAccessSeverityMapper.cs
@@ -37,6 +37,7 @@ internal static class MxAccessSeverityMapper
/// + OPC UA Part 9 numeric severity tuple.
///
/// The raw MXAccess severity value (0-999 range, clamped if out of range).
+ /// A tuple of the OPC UA bucket and the corresponding Part 9 numeric severity.
public static (AlarmSeverity Bucket, int OpcUaSeverity) Map(int rawMxAccessSeverity)
{
if (rawMxAccessSeverity < 250)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxValueDecoder.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxValueDecoder.cs
index 93f60aad..09ed4f0f 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxValueDecoder.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/MxValueDecoder.cs
@@ -15,6 +15,7 @@ internal static class MxValueDecoder
{
/// Decodes a gateway MxValue into a boxed CLR object.
/// The MxValue to decode, or null.
+ /// The decoded CLR value, or null when the input is null or empty.
public static object? Decode(MxValue? value)
{
if (value is null) return null;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/ReconnectSupervisor.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/ReconnectSupervisor.cs
index 6e3fbd90..a3ea49d8 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/ReconnectSupervisor.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/ReconnectSupervisor.cs
@@ -147,6 +147,7 @@ public sealed class ReconnectSupervisor : IDisposable
/// and for orchestration that wants to gate calls on recovery completing.
///
/// Token to cancel the wait operation.
+ /// A task that completes when the supervisor reaches the Healthy state or the token is cancelled.
public async Task WaitForHealthyAsync(CancellationToken cancellationToken)
{
while (!cancellationToken.IsCancellationRequested && IsDegraded)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/SubscriptionRegistry.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/SubscriptionRegistry.cs
index 1f70e82f..b3ca1604 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/SubscriptionRegistry.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/SubscriptionRegistry.cs
@@ -32,6 +32,7 @@ internal sealed class SubscriptionRegistry
public int TrackedItemHandleCount => _subscribersByItemHandle.Count;
/// Allocate a fresh subscription id. Monotonic; unique per registry lifetime.
+ /// A new unique subscription identifier.
public long NextSubscriptionId() => Interlocked.Increment(ref _nextSubscriptionId);
///
@@ -108,6 +109,7 @@ internal sealed class SubscriptionRegistry
}
/// Snapshot every active binding for diagnostic output.
+ /// A flat list of all active tag bindings across all subscriptions.
public IReadOnlyList SnapshotAllBindings() =>
[.. _bySubscriptionId.Values.SelectMany(entry => entry.Bindings)];
@@ -116,6 +118,7 @@ internal sealed class SubscriptionRegistry
/// Used by the reconnect replay path so it can re-issue SubscribeBulk per subscription
/// and then each one with the post-reconnect item handles.
///
+ /// A list of (SubscriptionId, Bindings) pairs for all active subscriptions.
public IReadOnlyList<(long SubscriptionId, IReadOnlyList Bindings)> SnapshotEntries() =>
[.. _bySubscriptionId.Values.Select(entry => (entry.SubscriptionId, entry.Bindings))];
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxyDataWriter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxyDataWriter.cs
index 4c15b21c..2f87fb9c 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxyDataWriter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxyDataWriter.cs
@@ -14,6 +14,7 @@ internal sealed class TracedGalaxyDataWriter(IGalaxyDataWriter inner, string cli
/// The list of write requests to process.
/// Function to resolve security classification for tag references.
/// Cancellation token for the operation.
+ /// A task that resolves to the write results for each request.
public async Task> WriteAsync(
IReadOnlyList writes,
Func securityResolver,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxySubscriber.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxySubscriber.cs
index 55717860..a951f9a6 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxySubscriber.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy/Runtime/TracedGalaxySubscriber.cs
@@ -10,10 +10,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Runtime;
///
internal sealed class TracedGalaxySubscriber(IGalaxySubscriber inner, string clientName) : IGalaxySubscriber
{
- /// Subscribes to multiple Galaxy tags in bulk with tracing.
- /// The full tag references to subscribe to.
- /// The buffered update interval in milliseconds.
- /// The cancellation token.
+ ///
public async Task> SubscribeBulkAsync(
IReadOnlyList fullReferences, int bufferedUpdateIntervalMs, CancellationToken cancellationToken)
{
@@ -35,9 +32,7 @@ internal sealed class TracedGalaxySubscriber(IGalaxySubscriber inner, string cli
}
}
- /// Unsubscribes from multiple Galaxy tags in bulk with tracing.
- /// The item handles to unsubscribe from.
- /// The cancellation token.
+ ///
public async Task UnsubscribeBulkAsync(IReadOnlyList itemHandles, CancellationToken cancellationToken)
{
using var activity = GalaxyTelemetry.ActivitySource.StartActivity("galaxy.unsubscribe_bulk");
@@ -60,6 +55,7 @@ internal sealed class TracedGalaxySubscriber(IGalaxySubscriber inner, string cli
/// visibility through 's metrics in PR 6.2 instead.
///
/// The cancellation token.
+ /// An async sequence of items forwarded from the inner subscriber.
public async IAsyncEnumerable StreamEventsAsync(
[EnumeratorCancellation] CancellationToken cancellationToken)
{
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/Ipc/FrameWriter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/Ipc/FrameWriter.cs
index 33e9609d..130c760c 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/Ipc/FrameWriter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/Ipc/FrameWriter.cs
@@ -26,6 +26,7 @@ public sealed class FrameWriter : IDisposable
/// The frame message kind tag.
/// The message object to serialize and write.
/// The cancellation token.
+ /// A task that represents the asynchronous write operation.
public async Task WriteAsync(MessageKind kind, T message, CancellationToken ct)
{
var body = MessagePackSerializer.Serialize(message, cancellationToken: ct);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/WonderwareHistorianClient.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/WonderwareHistorianClient.cs
index 2aacfbcf..a29c8ca9 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/WonderwareHistorianClient.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Client/WonderwareHistorianClient.cs
@@ -66,13 +66,7 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
// ===== IHistorianDataSource =====
- /// Asynchronously reads raw historical data for a tag within a time range.
- /// The full reference path of the tag to read.
- /// The start time in UTC for the read range.
- /// The end time in UTC for the read range.
- /// The maximum number of values to return.
- /// The cancellation token.
- /// A task that returns the historical read result.
+ ///
public async Task ReadRawAsync(
string fullReference, DateTime startUtc, DateTime endUtc, uint maxValuesPerNode,
CancellationToken cancellationToken)
@@ -91,14 +85,7 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
return new HistoryReadResult(ToSnapshots(reply.Samples), ContinuationPoint: null);
}
- /// Asynchronously reads processed historical data with aggregation for a tag within a time range.
- /// The full reference path of the tag to read.
- /// The start time in UTC for the read range.
- /// The end time in UTC for the read range.
- /// The time interval for aggregation.
- /// The type of aggregation to apply.
- /// The cancellation token.
- /// A task that returns the historical read result with aggregated data.
+ ///
public async Task ReadProcessedAsync(
string fullReference, DateTime startUtc, DateTime endUtc, TimeSpan interval,
HistoryAggregateType aggregate, CancellationToken cancellationToken)
@@ -118,11 +105,7 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
return new HistoryReadResult(ToAggregateSnapshots(reply.Buckets), ContinuationPoint: null);
}
- /// Asynchronously reads historical data at specific timestamps for a tag.
- /// The full reference path of the tag to read.
- /// The specific timestamps in UTC to read values for.
- /// The cancellation token.
- /// A task that returns the historical read result with values at the specified times.
+ ///
public async Task ReadAtTimeAsync(
string fullReference, IReadOnlyList timestampsUtc, CancellationToken cancellationToken)
{
@@ -184,13 +167,7 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
return result;
}
- /// Asynchronously reads historical events within a time range.
- /// The source name filter for events, or null to read all sources.
- /// The start time in UTC for the read range.
- /// The end time in UTC for the read range.
- /// The maximum number of events to return.
- /// The cancellation token.
- /// A task that returns the historical events result.
+ ///
public async Task ReadEventsAsync(
string? sourceName, DateTime startUtc, DateTime endUtc, int maxEvents,
CancellationToken cancellationToken)
@@ -231,6 +208,7 @@ public sealed class WonderwareHistorianClient : IHistorianDataSource, IAlarmHist
/// incremented any counter). (Finding 003 / 004.)
///
///
+ /// A reflecting current operation counters and channel connection state.
public HistorianHealthSnapshot GetHealthSnapshot()
{
lock (_healthLock)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/AahClientManagedAlarmEventWriter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/AahClientManagedAlarmEventWriter.cs
index 71e46bdb..c25e2ab3 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/AahClientManagedAlarmEventWriter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/AahClientManagedAlarmEventWriter.cs
@@ -37,6 +37,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
///
/// The alarm events to write.
/// Cancellation token.
+ /// A task resolving to a bool array where each element indicates whether the corresponding event was acknowledged.
public async Task WriteAsync(AlarmHistorianEventDto[] events, CancellationToken cancellationToken)
{
if (events is null || events.Length == 0)
@@ -91,6 +92,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
/// The HRESULT code from the SDK call.
/// Indicates whether the error is a communication-class error.
/// Indicates whether the input was malformed.
+ /// The write outcome for the SDK call result.
public static AlarmHistorianWriteOutcome MapOutcome(int hresult, bool isCommunicationError, bool isMalformedInput)
{
// Order matters: malformed input is permanent regardless of HRESULT pattern;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianClusterEndpointPicker.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianClusterEndpointPicker.cs
index a65ff312..37be9db1 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianClusterEndpointPicker.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianClusterEndpointPicker.cs
@@ -48,6 +48,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
}
/// Gets the list of currently healthy nodes.
+ /// A read-only list of node names that are currently healthy and not in cooldown.
public IReadOnlyList GetHealthyNodes()
{
lock (_lock)
@@ -101,6 +102,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
}
/// Returns a snapshot of all node states.
+ /// A list of objects representing each configured node.
public List SnapshotNodeStates()
{
lock (_lock)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianDataSource.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianDataSource.cs
index 22f3afb8..02877e3f 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianDataSource.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/HistorianDataSource.cs
@@ -83,6 +83,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
/// shared SDK connection should therefore be reset. Internal for unit testing.
///
/// The historian access error code.
+ /// true if the error code indicates a connection-class failure; otherwise false.
internal static bool IsConnectionClassError(HistorianAccessError.ErrorValue code)
=> ConnectionErrorCodes.Contains(code);
@@ -97,6 +98,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
///
/// The historian configuration.
/// The cancellation token.
+ /// A linked pre-wired with the optional request timeout.
internal static CancellationTokenSource BuildRequestCts(HistorianConfiguration cfg, CancellationToken ct)
{
var cts = CancellationTokenSource.CreateLinkedTokenSource(ct);
@@ -160,7 +162,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
};
}
- /// Gets a snapshot of the current health status.
+ ///
public HistorianHealthSnapshot GetHealthSnapshot()
{
var nodeStates = _picker.SnapshotNodeStates();
@@ -396,12 +398,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
}
}
- /// Reads raw historical samples for the specified tag.
- /// The tag name.
- /// The start time for the query.
- /// The end time for the query.
- /// The maximum number of values to return.
- /// Cancellation token for the operation.
+ ///
public Task> ReadRawAsync(
string tagName, DateTime startTime, DateTime endTime, int maxValues,
CancellationToken ct = default)
@@ -485,13 +482,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
return Task.FromResult(results);
}
- /// Reads aggregate historical samples for the specified tag.
- /// The tag name.
- /// The start time for the query.
- /// The end time for the query.
- /// The interval in milliseconds.
- /// The aggregate column name.
- /// Cancellation token for the operation.
+ ///
public Task> ReadAggregateAsync(
string tagName, DateTime startTime, DateTime endTime,
double intervalMs, string aggregateColumn,
@@ -572,10 +563,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
return Task.FromResult(results);
}
- /// Reads historical samples at specific timestamps for the specified tag.
- /// The tag name.
- /// The timestamps to read.
- /// Cancellation token for the operation.
+ ///
public Task> ReadAtTimeAsync(
string tagName, DateTime[] timestamps,
CancellationToken ct = default)
@@ -658,12 +646,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
return Task.FromResult(results);
}
- /// Reads historical events within the specified time range.
- /// The optional event source name filter.
- /// The start time for the query.
- /// The end time for the query.
- /// The maximum number of events to return.
- /// Cancellation token for the operation.
+ ///
public Task> ReadEventsAsync(
string? sourceName, DateTime startTime, DateTime endTime, int maxEvents,
CancellationToken ct = default)
@@ -764,6 +747,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
///
///
/// The history query result.
+ /// The resolved value — the string value when non-empty and numeric value is zero, otherwise the numeric value.
internal static object? SelectValue(HistoryQueryResult result)
=> SelectValueFromPair(result.Value, result.StringValue);
@@ -775,6 +759,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
///
/// The numeric value.
/// The string value.
+ /// The string value when non-empty and numeric value is zero, otherwise the numeric value.
internal static object? SelectValueFromPair(double value, string? stringValue)
{
if (!string.IsNullOrEmpty(stringValue) && value == 0)
@@ -785,6 +770,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
/// Extracts the specified aggregate value from an analog summary query result.
/// The analog summary query result.
/// The aggregate column name.
+ /// The value of the specified aggregate column, or null if the column name is unknown.
internal static double? ExtractAggregateValue(AnalogSummaryQueryResult result, string column)
{
switch (column)
@@ -800,7 +786,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
}
}
- /// Disposes the historian data source and releases its resources.
+ ///
public void Dispose()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/IAlarmHistorianWriteBackend.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/IAlarmHistorianWriteBackend.cs
index 3c655a15..b0e9df38 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/IAlarmHistorianWriteBackend.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/IAlarmHistorianWriteBackend.cs
@@ -25,6 +25,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
///
/// The events to write to the historian.
/// Token to cancel the operation.
+ /// A task that resolves to one per input event, in the same order.
Task WriteBatchAsync(
AlarmHistorianEventDto[] events,
CancellationToken cancellationToken);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/SdkAlarmHistorianWriteBackend.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/SdkAlarmHistorianWriteBackend.cs
index c1a2a9b6..3f2886e3 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/SdkAlarmHistorianWriteBackend.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Backend/SdkAlarmHistorianWriteBackend.cs
@@ -103,10 +103,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
_picker = picker ?? new HistorianClusterEndpointPicker(config);
}
- /// Writes a batch of alarm events to the historian, returning outcomes for each event.
- /// The alarm events to write.
- /// The cancellation token.
- /// An array of outcomes corresponding to each input event.
+ ///
public Task WriteBatchAsync(
AlarmHistorianEventDto[] events,
CancellationToken cancellationToken)
@@ -379,7 +376,7 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware.Backend
RequestTimeoutSeconds = _config.RequestTimeoutSeconds,
};
- /// Disposes the connection and releases resources.
+ ///
public void Dispose()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameReader.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameReader.cs
index 7593a408..39473c39 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameReader.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameReader.cs
@@ -52,6 +52,7 @@ public sealed class FrameReader : IDisposable
/// Deserializes the message body to the specified type.
/// The type to deserialize to.
/// The serialized message body.
+ /// The deserialized value of type .
public static T Deserialize(byte[] body) => MessagePackSerializer.Deserialize(body);
private async Task ReadExactAsync(byte[] buffer, CancellationToken ct)
@@ -70,7 +71,7 @@ public sealed class FrameReader : IDisposable
return true;
}
- /// Disposes the frame reader and optionally closes the underlying stream.
+ ///
public void Dispose()
{
if (!_leaveOpen) _stream.Dispose();
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameWriter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameWriter.cs
index fd88a7e7..de6c05e6 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameWriter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/FrameWriter.cs
@@ -32,6 +32,7 @@ public sealed class FrameWriter : IDisposable
/// The message kind identifier.
/// The message to serialize and write.
/// The cancellation token.
+ /// A task that represents the asynchronous write operation.
public async Task WriteAsync(MessageKind kind, T message, CancellationToken ct)
{
var body = MessagePackSerializer.Serialize(message, cancellationToken: ct);
@@ -57,7 +58,7 @@ public sealed class FrameWriter : IDisposable
finally { _gate.Release(); }
}
- /// Disposes the frame writer and releases resources.
+ ///
public void Dispose()
{
_gate.Dispose();
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/HistorianFrameHandler.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/HistorianFrameHandler.cs
index 9eb9c915..9b70e9df 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/HistorianFrameHandler.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/HistorianFrameHandler.cs
@@ -34,11 +34,7 @@ public sealed class HistorianFrameHandler : IFrameHandler
_alarmWriter = alarmWriter;
}
- /// Handles an incoming frame by dispatching to the appropriate historian operation.
- /// The frame message kind.
- /// The frame body bytes.
- /// The frame writer for sending responses.
- /// Cancellation token.
+ ///
public Task HandleAsync(MessageKind kind, byte[] body, FrameWriter writer, CancellationToken ct)
=> kind switch
{
@@ -262,5 +258,6 @@ public interface IAlarmEventWriter
///
/// Alarm events to write.
/// Cancellation token.
+ /// A task that resolves to an array of booleans indicating whether each event was successfully persisted.
Task WriteAsync(AlarmHistorianEventDto[] events, CancellationToken cancellationToken);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/PipeServer.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/PipeServer.cs
index ffd9cb0c..298189ed 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/PipeServer.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Ipc/PipeServer.cs
@@ -32,6 +32,7 @@ public sealed class PipeServer : IDisposable
/// The named pipe server stream to verify.
/// The allowed security identifier.
/// The rejection reason if verification fails.
+ /// if the caller is verified; with a populated otherwise.
internal delegate bool CallerVerifier(NamedPipeServerStream pipe, SecurityIdentifier allowedSid, out string reason);
/// Initializes a new instance of the class.
@@ -68,6 +69,7 @@ public sealed class PipeServer : IDisposable
///
/// The frame handler to process frames.
/// Cancellation token for the operation.
+ /// A task that completes when the client disconnects or the operation is cancelled.
public async Task RunOneConnectionAsync(IFrameHandler handler, CancellationToken ct)
{
using var linked = CancellationTokenSource.CreateLinkedTokenSource(_cts.Token, ct);
@@ -179,6 +181,7 @@ public sealed class PipeServer : IDisposable
///
/// The frame handler to process frames.
/// Cancellation token for the operation.
+ /// A task that runs until cancelled or the failure limit is exceeded.
public async Task RunAsync(IFrameHandler handler, CancellationToken ct)
{
var consecutiveFailures = 0;
@@ -233,7 +236,7 @@ public sealed class PipeServer : IDisposable
catch (Exception ex) { reason = ex.Message; return false; }
}
- /// Disposes the pipe server and cancels any pending operations.
+ ///
public void Dispose()
{
_cts.Cancel();
@@ -254,5 +257,6 @@ public interface IFrameHandler
/// The serialized message body.
/// The frame writer to send responses.
/// Cancellation token for the operation.
+ /// A task that completes when the frame has been handled and any response written.
Task HandleAsync(MessageKind kind, byte[] body, FrameWriter writer, CancellationToken ct);
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Program.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Program.cs
index db77d55d..6d569911 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Program.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Historian.Wonderware/Program.cs
@@ -120,6 +120,7 @@ public static class Program
/// set OTOPCUA_HISTORIAN_ALARM_WRITE_ENABLED=false to keep a read-only
/// deployment that still loads the SDK for reads.
///
+ /// The alarm-event writer, or null when alarm writes are disabled.
internal static IAlarmEventWriter? BuildAlarmWriter()
{
var raw = Environment.GetEnvironmentVariable("OTOPCUA_HISTORIAN_ALARM_WRITE_ENABLED");
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/DirectLogicAddress.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/DirectLogicAddress.cs
index 88c73903..cdbe8b8b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/DirectLogicAddress.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/DirectLogicAddress.cs
@@ -29,6 +29,7 @@ public static class DirectLogicAddress
///
/// Input is null / empty / contains non-octal digits (8,9).
/// Parsed value exceeds ushort.MaxValue (0xFFFF).
+ /// The 0-based Modbus PDU address.
public static ushort UserVMemoryToPdu(string vAddress)
=> (ushort)DecodeOctalVAddress(vAddress); // DecodeOctalVAddress guards the 0xFFFF ceiling
@@ -80,11 +81,16 @@ public static class DirectLogicAddress
/// Octal 40400 == decimal 16640 (0x4100).
public const ushort SystemVMemoryOctalBase = 0x4100; // octal 40400 decoded
+ ///
+ /// Convert a 0-based offset within the system V-memory bank to its Modbus PDU address,
+ /// using the fixed system base at .
+ ///
///
/// 0-based register offset within the system bank. Pass 0 for V40400 itself; pass 1 for
/// V40401 (octal), and so on. NOT an octal-decoded value — the system bank lives at
/// consecutive PDU addresses, so the offset is plain decimal.
///
+ /// The 0-based Modbus PDU address for the system V-memory register.
public static ushort SystemVMemoryToPdu(ushort offsetWithinSystemBank)
{
var pdu = SystemVMemoryBasePdu + offsetWithinSystemBank;
@@ -109,6 +115,7 @@ public static class DirectLogicAddress
///
/// Input is null / empty / contains non-octal digits.
/// The result exceeds the 16-bit Modbus PDU range.
+ /// The 0-based Modbus PDU address, routed through the correct bank formula.
public static ushort VMemoryToPdu(string vAddress)
{
var octalValue = DecodeOctalVAddress(vAddress);
@@ -155,6 +162,7 @@ public static class DirectLogicAddress
/// ladder-logic editor's notation.
///
/// The Y-output address (octal, with optional Y prefix).
+ /// The 0-based Modbus coil address.
public static ushort YOutputToCoil(string yAddress) =>
AddOctalOffset(YOutputBaseCoil, StripPrefix(yAddress, 'Y'));
@@ -163,6 +171,7 @@ public static class DirectLogicAddress
/// 0-based Modbus coil address.
///
/// The C-relay address (octal, with optional C prefix).
+ /// The 0-based Modbus coil address.
public static ushort CRelayToCoil(string cAddress) =>
AddOctalOffset(CRelayBaseCoil, StripPrefix(cAddress, 'C'));
@@ -172,6 +181,7 @@ public static class DirectLogicAddress
/// exception — the CPU sizes the table to configured I/O, not installed modules.
///
/// The X-input address (octal, with optional X prefix).
+ /// The 0-based Modbus discrete-input address.
public static ushort XInputToDiscrete(string xAddress) =>
AddOctalOffset(XInputBaseDiscrete, StripPrefix(xAddress, 'X'));
@@ -180,6 +190,7 @@ public static class DirectLogicAddress
/// Modbus discrete-input address. Accepts "SP" prefix case-insensitively.
///
/// The SP special-relay address (octal, with optional SP prefix).
+ /// The 0-based Modbus discrete-input address.
public static ushort SpecialToDiscrete(string spAddress)
{
if (string.IsNullOrWhiteSpace(spAddress))
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/MelsecAddress.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/MelsecAddress.cs
index d3f272aa..b98ad45e 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/MelsecAddress.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/MelsecAddress.cs
@@ -53,6 +53,7 @@ public static class MelsecAddress
/// 0-based Modbus DI address the assignment-block has configured X0 to land at.
/// Typical default on QJ71MT91 sample projects: 0. Pass the site-specific value.
///
+ /// The 0-based Modbus discrete-input address.
public static ushort XInputToDiscrete(string xAddress, MelsecFamily family, ushort xBankBase = 0) =>
AddFamilyOffset(xBankBase, StripPrefix(xAddress, 'X'), family);
@@ -63,6 +64,7 @@ public static class MelsecAddress
/// MELSEC Y address. Y prefix optional, case-insensitive.
/// The PLC family — determines whether the trailing digits are hex or octal.
/// 0-based Modbus coil address the assignment-block has configured Y0 to land at.
+ /// The 0-based Modbus coil address.
public static ushort YOutputToCoil(string yAddress, MelsecFamily family, ushort yBankBase = 0) =>
AddFamilyOffset(yBankBase, StripPrefix(yAddress, 'Y'), family);
@@ -73,6 +75,7 @@ public static class MelsecAddress
///
/// MELSEC M address. M prefix optional, case-insensitive.
/// 0-based Modbus coil address the assignment-block has configured M0 to land at.
+ /// The 0-based Modbus coil address.
public static ushort MRelayToCoil(string mAddress, ushort mBankBase = 0)
{
var digits = StripPrefix(mAddress, 'M');
@@ -93,6 +96,7 @@ public static class MelsecAddress
///
/// MELSEC D address. D prefix optional, case-insensitive.
/// 0-based Modbus holding register address the assignment-block has configured D0 to land at.
+ /// The 0-based Modbus holding register address.
public static ushort DRegisterToHolding(string dAddress, ushort dBankBase = 0)
{
var digits = StripPrefix(dAddress, 'D');
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/ModbusModiconAddress.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/ModbusModiconAddress.cs
index 942e7a36..43801f18 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/ModbusModiconAddress.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.Addressing/ModbusModiconAddress.cs
@@ -45,6 +45,7 @@ public static class ModbusModiconAddress
/// The parsed Modbus region, or default if parsing fails.
/// The zero-based PDU offset, or 0 if parsing fails.
/// The error message if parsing fails, or null on success.
+ /// true if the address was parsed successfully; false otherwise.
public static bool TryParse(string? address, out ModbusRegion region, out ushort offset, out string? error)
{
region = default;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriver.cs
index cd1ab6b2..9b300a3b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriver.cs
@@ -135,6 +135,7 @@ public sealed class ModbusDriver
/// breaker without tripping siblings on the same TCP socket.
///
/// Tag reference to resolve the host for.
+ /// The per-slave host string used as the circuit-breaker key.
public string ResolveHost(string fullReference)
{
if (_tagsByName.TryGetValue(fullReference, out var tag))
@@ -171,14 +172,12 @@ public sealed class ModbusDriver
return true;
}
- /// Gets the unique identifier of this driver instance.
+ ///
public string DriverInstanceId => _driverInstanceId;
- /// Gets the driver type name.
+ ///
public string DriverType => "Modbus";
- /// Initializes the driver with the specified configuration JSON.
- /// JSON configuration string.
- /// Cancellation token.
+ ///
public async Task InitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
WriteHealth(new DriverHealth(DriverState.Initializing, null, null));
@@ -212,17 +211,14 @@ public sealed class ModbusDriver
}
}
- /// Reinitializes the driver with new configuration.
- /// New JSON configuration string.
- /// Cancellation token.
+ ///
public async Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
await ShutdownAsync(cancellationToken);
await InitializeAsync(driverConfigJson, cancellationToken);
}
- /// Shuts down the driver and releases resources.
- /// Cancellation token.
+ ///
public async Task ShutdownAsync(CancellationToken cancellationToken)
{
var lastRead = ReadHealth().LastSuccessfulRead;
@@ -230,7 +226,7 @@ public sealed class ModbusDriver
WriteHealth(new DriverHealth(DriverState.Unknown, lastRead, null));
}
- /// Gets the current driver health status.
+ ///
public DriverHealth GetHealth() => ReadHealth();
///
@@ -245,17 +241,14 @@ public sealed class ModbusDriver
/// Driver.Modbus-003: barrier-protected publish of a new _health snapshot.
///
private void WriteHealth(DriverHealth value) => Volatile.Write(ref _health, value);
- /// Gets the memory footprint of the driver.
+ ///
public long GetMemoryFootprint() => 0;
- /// Flushes optional caches to free memory.
- /// Cancellation token.
+ ///
public Task FlushOptionalCachesAsync(CancellationToken cancellationToken) => Task.CompletedTask;
// ---- ITagDiscovery ----
- /// Discovers tags and builds the OPC UA address space.
- /// Address space builder.
- /// Cancellation token.
+ ///
public Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(builder);
@@ -277,9 +270,7 @@ public sealed class ModbusDriver
// ---- IReadable ----
- /// Reads the specified tag references from the Modbus device.
- /// Tag references to read.
- /// Cancellation token.
+ ///
public async Task> ReadAsync(
IReadOnlyList fullReferences, CancellationToken cancellationToken)
{
@@ -537,6 +528,7 @@ public sealed class ModbusDriver
/// on coalesced-read failure (#148), narrowed by bisection (#150), cleared by the
/// re-probe loop (#151) when ranges become healthy again.
///
+ /// A read-only list of currently auto-prohibited Modbus ranges.
public IReadOnlyList GetAutoProhibitedRanges()
{
lock (_autoProhibitedLock)
@@ -587,6 +579,7 @@ public sealed class ModbusDriver
/// retry (single-register or already-narrowed).
///
/// Cancellation token.
+ /// A task that represents the asynchronous operation.
internal async Task RunReprobeOnceForTestAsync(CancellationToken ct)
{
var transport = _transport ?? throw new InvalidOperationException("Transport not connected");
@@ -920,9 +913,7 @@ public sealed class ModbusDriver
// ---- IWritable ----
- /// Writes values to the specified tag references on the Modbus device.
- /// Write requests to execute.
- /// Cancellation token.
+ ///
public async Task> WriteAsync(
IReadOnlyList writes, CancellationToken cancellationToken)
{
@@ -1160,17 +1151,12 @@ public sealed class ModbusDriver
// ---- ISubscribable (polling overlay via shared engine) ----
- /// Subscribes to value changes on the specified tag references.
- /// Tag references to subscribe to.
- /// Interval for publishing changes.
- /// Cancellation token.
+ ///
public Task SubscribeAsync(
IReadOnlyList fullReferences, TimeSpan publishingInterval, CancellationToken cancellationToken) =>
Task.FromResult(_poll.Subscribe(fullReferences, publishingInterval));
- /// Unsubscribes from value changes using the specified handle.
- /// Subscription handle.
- /// Cancellation token.
+ ///
public Task UnsubscribeAsync(ISubscriptionHandle handle, CancellationToken cancellationToken)
{
_poll.Unsubscribe(handle);
@@ -1179,7 +1165,7 @@ public sealed class ModbusDriver
// ---- IHostConnectivityProbe ----
- /// Gets the current connectivity status for all hosts.
+ ///
public IReadOnlyList GetHostStatuses()
{
lock (_probeLock)
@@ -1246,6 +1232,7 @@ public sealed class ModbusDriver
/// from 2 chars per register).
///
/// Tag definition to measure.
+ /// The number of 16-bit registers the tag occupies.
internal static ushort RegisterCount(ModbusTagDefinition tag) => tag.DataType switch
{
ModbusDataType.Int16 or ModbusDataType.UInt16 or ModbusDataType.BitInRegister or ModbusDataType.Bcd16 => 1,
@@ -1306,6 +1293,7 @@ public sealed class ModbusDriver
/// Decodes a register value according to the tag's data type.
/// Raw register bytes.
/// Tag definition specifying the data type.
+ /// The decoded value as a boxed .NET type.
internal static object DecodeRegister(ReadOnlySpan data, ModbusTagDefinition tag)
{
switch (tag.DataType)
@@ -1387,6 +1375,7 @@ public sealed class ModbusDriver
/// Encodes a value into register bytes according to the tag's data type.
/// Value to encode.
/// Tag definition specifying the data type.
+ /// The encoded register bytes.
internal static byte[] EncodeRegister(object? value, ModbusTagDefinition tag)
{
switch (tag.DataType)
@@ -1522,6 +1511,7 @@ public sealed class ModbusDriver
///
/// Raw BCD value.
/// Number of nibbles to decode.
+ /// The decoded decimal value.
internal static uint DecodeBcd(uint raw, int nibbles)
{
uint result = 0;
@@ -1542,6 +1532,7 @@ public sealed class ModbusDriver
///
/// Decimal value to encode.
/// Number of nibbles to encode.
+ /// The BCD-encoded value.
internal static uint EncodeBcd(uint value, int nibbles)
{
uint result = 0;
@@ -1576,6 +1567,7 @@ public sealed class ModbusDriver
/// extensions.
///
/// Modbus exception code.
+ /// The corresponding OPC UA status code.
internal static uint MapModbusExceptionToStatus(byte exceptionCode) => exceptionCode switch
{
0x01 => StatusBadNotSupported, // Illegal Function — FC not in supported list
@@ -1596,6 +1588,7 @@ public sealed class ModbusDriver
/// leak the probe loop, re-probe loop, and poll-engine background tasks. Shares
/// with to keep them in sync.
///
+ /// A task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
await TeardownAsync().ConfigureAwait(false);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriverFactoryExtensions.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriverFactoryExtensions.cs
index 392cc5d1..113e7b47 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriverFactoryExtensions.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusDriverFactoryExtensions.cs
@@ -33,6 +33,7 @@ public static class ModbusDriverFactoryExtensions
/// Public for the Server-side bootstrapper + test consumers (Admin.Tests, etc.).
/// The unique identifier for the driver instance.
/// The JSON configuration string for the driver.
+ /// A configured instance.
public static ModbusDriver CreateInstance(string driverInstanceId, string driverConfigJson)
=> CreateInstance(driverInstanceId, driverConfigJson, loggerFactory: null);
@@ -40,6 +41,7 @@ public static class ModbusDriverFactoryExtensions
/// The unique identifier for the driver instance.
/// The JSON configuration string for the driver.
/// Optional logger factory for creating loggers per driver instance.
+ /// A configured instance.
public static ModbusDriver CreateInstance(string driverInstanceId, string driverConfigJson, ILoggerFactory? loggerFactory)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverInstanceId);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusTcpTransport.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusTcpTransport.cs
index f317af5d..772e1a8a 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusTcpTransport.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus/ModbusTcpTransport.cs
@@ -63,8 +63,7 @@ public sealed class ModbusTcpTransport : IModbusTransport
_reconnect = reconnect ?? new ModbusReconnectOptions();
}
- /// Connects to the Modbus TCP server with IPv4 preference.
- /// The cancellation token for the operation.
+ ///
public async Task ConnectAsync(CancellationToken ct)
{
// Resolve the host explicitly + prefer IPv4. .NET's TcpClient default-constructor is
@@ -121,16 +120,14 @@ public sealed class ModbusTcpTransport : IModbusTransport
/// keep-alive timing into "use the default" on most OSes.
///
/// The timespan to clamp to whole seconds.
+ /// The number of whole seconds, with a minimum of 1.
internal static int ClampToWholeSeconds(TimeSpan ts)
{
var seconds = (int)Math.Ceiling(ts.TotalSeconds);
return seconds < 1 ? 1 : seconds;
}
- /// Sends a Modbus PDU and returns the response, with automatic retry on socket failure.
- /// The Modbus unit/slave ID.
- /// The protocol data unit to send.
- /// The cancellation token for the operation.
+ ///
public async Task SendAsync(byte unitId, byte[] pdu, CancellationToken ct)
{
if (_disposed) throw new ObjectDisposedException(nameof(ModbusTcpTransport));
@@ -284,6 +281,7 @@ public sealed class ModbusTcpTransport : IModbusTransport
}
/// Asynchronously disposes the transport and underlying socket resources.
+ /// A value task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientBrowseSession.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientBrowseSession.cs
index ef9dacaa..01e54ce5 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientBrowseSession.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientBrowseSession.cs
@@ -32,25 +32,17 @@ internal sealed class OpcUaClientBrowseSession : IBrowseSession
_rootNodeId = rootNodeId;
}
- /// Opaque token identifying this session in the AdminUI registry.
+ ///
public Guid Token { get; } = Guid.NewGuid();
- /// Wall-clock time of the most recent successful browse call; the reaper uses
- /// this for idle eviction.
+ ///
public DateTime LastUsedUtc { get; private set; } = DateTime.UtcNow;
- /// Browse one level under the configured root node.
- /// Cancellation token.
+ ///
public Task> RootAsync(CancellationToken cancellationToken)
=> BrowseOneLevelAsync(_rootNodeId, cancellationToken);
- /// Browse one level under the node identified by ,
- /// which must be a stable reference produced by
- /// (or a plain ns=N;… form).
- /// Stable reference string for the parent node.
- /// Cancellation token.
- /// Thrown when cannot be
- /// resolved against the live session's namespace table.
+ ///
public Task> ExpandAsync(string nodeId, CancellationToken cancellationToken)
{
if (!NamespaceMap.TryResolve(_session, nodeId, out var resolved))
@@ -59,10 +51,7 @@ internal sealed class OpcUaClientBrowseSession : IBrowseSession
return BrowseOneLevelAsync(resolved, cancellationToken);
}
- /// The OPC UA picker treats variables as terminal leaves and does not surface
- /// a per-attribute side-panel, so this always returns empty.
- /// Ignored.
- /// Ignored.
+ ///
public Task> AttributesAsync(string nodeId, CancellationToken cancellationToken)
=> Task.FromResult>(Array.Empty());
@@ -158,6 +147,7 @@ internal sealed class OpcUaClientBrowseSession : IBrowseSession
/// Idempotent best-effort dispose: closes the underlying session if it's a
/// concrete , disposes it, and disposes the gate. Close errors are
/// swallowed because the registry reaper may be racing a remote disconnect.
+ /// A value task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientDriverBrowser.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientDriverBrowser.cs
index dd0a0e64..aedf9080 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientDriverBrowser.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Browser/OpcUaClientDriverBrowser.cs
@@ -31,13 +31,10 @@ public sealed class OpcUaClientDriverBrowser : IDriverBrowser
_logger = logger ?? NullLogger.Instance;
}
- /// Driver type key — matches the AdminUI's persisted "OpcUaClient" value.
+ ///
public string DriverType => "OpcUaClient";
- /// Opens a transient OPC UA session and returns a browse session over it.
- /// Driver options serialized as JSON; same shape the runtime
- /// driver would consume.
- /// Cancellation for the connect phase only.
+ ///
public async Task OpenAsync(string configJson, CancellationToken cancellationToken)
{
var opts = JsonSerializer.Deserialize(configJson, JsonOpts)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Contracts/NamespaceMap.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Contracts/NamespaceMap.cs
index 82ab003f..67c110f7 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Contracts/NamespaceMap.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.Contracts/NamespaceMap.cs
@@ -48,6 +48,7 @@ public sealed class NamespaceMap
/// Snapshot the namespace table from a live session.
/// The OPC UA session to snapshot.
+ /// A new capturing the session's current namespace table.
public static NamespaceMap FromSession(ISession session)
{
ArgumentNullException.ThrowIfNull(session);
@@ -60,6 +61,7 @@ public sealed class NamespaceMap
/// a live .
///
/// The namespace table to snapshot.
+ /// A new capturing the supplied namespace table.
public static NamespaceMap FromTable(NamespaceTable namespaceUris)
{
ArgumentNullException.ThrowIfNull(namespaceUris);
@@ -71,11 +73,13 @@ public sealed class NamespaceMap
/// The namespace URI at the given index, or null if out of range.
/// The zero-based index in the namespace table.
+ /// The namespace URI string, or if is out of range.
public string? UriForIndex(int index) =>
index >= 0 && index < _uris.Length ? _uris[index] : null;
/// The index for a namespace URI, or null if the URI is not in the table.
/// The namespace URI to look up.
+ /// The zero-based index, or if the URI is not present.
public ushort? IndexForUri(string uri) =>
_uriToIndex.TryGetValue(uri, out var idx) ? idx : null;
@@ -87,6 +91,7 @@ public sealed class NamespaceMap
/// address space so it survives a remote namespace-table reorder.
///
/// The NodeId to render as a stable reference.
+ /// A stable nsu=… reference string, or the raw node ID form for namespace 0 or unknown namespaces.
public string ToStableReference(NodeId nodeId)
{
ArgumentNullException.ThrowIfNull(nodeId);
@@ -115,6 +120,7 @@ public sealed class NamespaceMap
/// The OPC UA session whose namespace table to resolve against.
/// The reference string to resolve (either nsu=… or ns=N;… format).
/// On success, the resolved NodeId; otherwise NodeId.Null.
+ /// if the reference was resolved to a non-null NodeId; otherwise .
public static bool TryResolve(ISession currentSession, string reference, out NodeId nodeId)
{
nodeId = NodeId.Null;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient/OpcUaClientDriver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient/OpcUaClientDriver.cs
index d81ed3b7..651f8b25 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient/OpcUaClientDriver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient/OpcUaClientDriver.cs
@@ -32,6 +32,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
{
private readonly ILogger _logger;
+ /// Initializes a new instance of with the given options and instance ID.
/// Driver configuration.
/// Stable logical ID from the config DB.
/// Optional logger; defaults to NullLogger when not supplied.
@@ -121,14 +122,12 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
///
private NamespaceMap? _namespaceMap;
- /// Gets the stable logical identifier for this driver instance from the config database.
+ ///
public string DriverInstanceId => _driverInstanceId;
- /// Gets the driver type identifier.
+ ///
public string DriverType => "OpcUaClient";
- /// Initializes the OPC UA client driver with the given configuration.
- /// JSON-serialized driver configuration.
- /// Cancellation token for the operation.
+ ///
public async Task InitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
_health = new DriverHealth(DriverState.Initializing, null, null);
@@ -303,6 +302,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// existing single-endpoint configs keep working without migration.
///
/// Driver options containing endpoint configuration.
+ /// An ordered list of endpoint URL candidates for connection failover.
internal static IReadOnlyList ResolveEndpointCandidates(OpcUaClientDriverOptions opts)
{
if (opts.EndpointUrls is { Count: > 0 }) return opts.EndpointUrls;
@@ -352,6 +352,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// private key N times, wasteful + keeps the password in memory longer.
///
/// Driver options containing authentication configuration.
+ /// A configured for the requested authentication type.
internal static UserIdentity BuildUserIdentity(OpcUaClientDriverOptions options) =>
options.AuthType switch
{
@@ -455,6 +456,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// challenge during session activation).
///
/// Driver options containing certificate configuration.
+ /// A backed by the loaded client user certificate.
internal static UserIdentity BuildCertificateIdentity(OpcUaClientDriverOptions options)
{
if (string.IsNullOrWhiteSpace(options.UserCertificatePath))
@@ -482,6 +484,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// Convert a driver to the OPC UA policy URI.
/// The driver security policy to map.
+ /// The OPC UA security policy URI string corresponding to the given policy.
internal static string MapSecurityPolicy(OpcUaSecurityPolicy policy) => policy switch
{
OpcUaSecurityPolicy.None => SecurityPolicies.None,
@@ -496,17 +499,14 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
private static string ShortPolicyName(string policyUri) =>
policyUri?.Substring(policyUri.LastIndexOf('#') + 1) ?? "(null)";
- /// Reinitializes the driver with new configuration, shutting down and restarting the session.
- /// JSON-serialized driver configuration.
- /// Cancellation token for the operation.
+ ///
public async Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
await ShutdownAsync(cancellationToken).ConfigureAwait(false);
await InitializeAsync(driverConfigJson, cancellationToken).ConfigureAwait(false);
}
- /// Gracefully shuts down the OPC UA session, unsubscribing all active monitoring items and closing the connection.
- /// Cancellation token for the operation.
+ ///
public async Task ShutdownAsync(CancellationToken cancellationToken)
{
// Tear down remote subscriptions first — otherwise Session.Close will try and may fail
@@ -582,7 +582,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
_health = new DriverHealth(DriverState.Unknown, _health.LastSuccessfulRead, null);
}
- /// Gets the current health status of the OPC UA client driver.
+ ///
public DriverHealth GetHealth() => _health;
///
@@ -594,6 +594,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// 10k-node remote server reports ~5 MB — well within the budget and detectable by the
/// Core slope alarm (Driver.OpcUaClient-013).
///
+ /// Approximate in-driver memory usage in bytes based on the discovered node count.
public long GetMemoryFootprint() => _discoveredNodeCount * 512L;
///
@@ -604,6 +605,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// will rebuild it cleanly from the remote server.
///
/// Cancellation token for the operation.
+ /// A task that represents the asynchronous operation.
public Task FlushOptionalCachesAsync(CancellationToken cancellationToken)
{
_discoveredNodeCount = 0;
@@ -612,9 +614,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
// ---- IReadable ----
- /// Reads the current values of the specified nodes from the remote OPC UA server.
- /// Fully-qualified node identifiers to read.
- /// Cancellation token for the operation.
+ ///
public async Task> ReadAsync(
IReadOnlyList fullReferences, CancellationToken cancellationToken)
{
@@ -703,9 +703,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
// ---- IWritable ----
- /// Writes values to the specified nodes on the remote OPC UA server.
- /// Write requests specifying nodes and values to write.
- /// Cancellation token for the operation.
+ ///
public async Task> WriteAsync(
IReadOnlyList writes, CancellationToken cancellationToken)
{
@@ -801,6 +799,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// The OPC UA session to resolve the node ID against.
/// The full reference string to parse.
/// The parsed node ID when successful.
+ /// if the reference was parsed to a valid node ID; otherwise.
internal static bool TryParseNodeId(ISession session, string fullReference, out NodeId nodeId) =>
NamespaceMap.TryResolve(session, fullReference, out nodeId);
@@ -817,9 +816,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
// ---- ITagDiscovery ----
- /// Discovers the remote OPC UA server's address space and materializes it through the supplied builder.
- /// Address space builder for materializing discovered nodes.
- /// Cancellation token for the operation.
+ ///
public async Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(builder);
@@ -1086,6 +1083,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// StatusCode + timestamps.
///
/// The OPC UA data type NodeId to map.
+ /// The corresponding to the given OPC UA data type.
internal static DriverDataType MapUpstreamDataType(NodeId dataType)
{
if (dataType == DataTypeIds.Boolean) return DriverDataType.Boolean;
@@ -1114,6 +1112,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// ; read-only as .
///
/// The OPC UA access level bitmask.
+ /// The corresponding to the given access level.
internal static SecurityClassification MapAccessLevelToSecurityClass(byte accessLevel)
{
const byte CurrentWrite = 2; // AccessLevels.CurrentWrite = 0x02
@@ -1124,10 +1123,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
// ---- ISubscribable ----
- /// Subscribes to monitored value changes on the specified nodes from the remote OPC UA server.
- /// Fully-qualified node identifiers to monitor.
- /// Desired minimum interval between publish cycles.
- /// Cancellation token for the operation.
+ ///
public async Task SubscribeAsync(
IReadOnlyList fullReferences, TimeSpan publishingInterval, CancellationToken cancellationToken)
{
@@ -1198,9 +1194,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
return handle;
}
- /// Unsubscribes from monitored value changes for the specified subscription handle.
- /// The subscription handle to unsubscribe.
- /// Cancellation token for the operation.
+ ///
public async Task UnsubscribeAsync(ISubscriptionHandle handle, CancellationToken cancellationToken)
{
if (handle is not OpcUaSubscriptionHandle h) return;
@@ -1272,7 +1266,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
private sealed record OpcUaSubscriptionHandle(long Id) : ISubscriptionHandle
{
- /// Gets the diagnostic identifier for this subscription.
+ ///
public string DiagnosticId => $"opcua-sub-{Id}";
}
@@ -1290,9 +1284,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
private const int AlarmFieldTime = 5;
private const int AlarmFieldConditionId = 6;
- /// Subscribes to alarm and event notifications from the remote OPC UA server.
- /// Source node identifiers to subscribe alarms from.
- /// Cancellation token for the operation.
+ ///
public async Task SubscribeAlarmsAsync(
IReadOnlyList sourceNodeIds, CancellationToken cancellationToken)
{
@@ -1378,9 +1370,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
return handle;
}
- /// Unsubscribes from alarm and event notifications for the specified alarm subscription handle.
- /// The alarm subscription handle to unsubscribe.
- /// Cancellation token for the operation.
+ ///
public async Task UnsubscribeAlarmsAsync(IAlarmSubscriptionHandle handle, CancellationToken cancellationToken)
{
if (handle is not OpcUaAlarmSubscriptionHandle h) return;
@@ -1400,9 +1390,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
finally { _gate.Release(); }
}
- /// Acknowledges multiple alarms by calling the remote OPC UA server's Acknowledge method.
- /// List of alarm acknowledgement requests.
- /// Cancellation token for the operation.
+ ///
public async Task AcknowledgeAsync(
IReadOnlyList acknowledgements, CancellationToken cancellationToken)
{
@@ -1517,6 +1505,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// guidance: 1-200 Low, 201-500 Medium, 501-800 High, 801-1000 Critical.
///
/// The OPC UA severity value (1-1000).
+ /// The coarse-grained bucket for the given OPC UA severity.
internal static AlarmSeverity MapSeverity(ushort opcSeverity) => opcSeverity switch
{
<= 200 => AlarmSeverity.Low,
@@ -1539,18 +1528,13 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
private sealed record OpcUaAlarmSubscriptionHandle(long Id) : IAlarmSubscriptionHandle
{
- /// Gets the diagnostic identifier for this alarm subscription.
+ ///
public string DiagnosticId => $"opcua-alarm-sub-{Id}";
}
// ---- IHistoryProvider (passthrough to upstream server) ----
- /// Reads raw historical data from the remote OPC UA server.
- /// Fully-qualified node identifier to read history for.
- /// Start time in UTC for the history query.
- /// End time in UTC for the history query.
- /// Maximum number of values to return.
- /// Cancellation token for the operation.
+ ///
public async Task ReadRawAsync(
string fullReference, DateTime startUtc, DateTime endUtc, uint maxValuesPerNode,
CancellationToken cancellationToken)
@@ -1567,13 +1551,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
.ConfigureAwait(false);
}
- /// Reads processed (aggregated) historical data from the remote OPC UA server.
- /// Fully-qualified node identifier to read history for.
- /// Start time in UTC for the history query.
- /// End time in UTC for the history query.
- /// Time interval for aggregation.
- /// The aggregation function to apply.
- /// Cancellation token for the operation.
+ ///
public async Task ReadProcessedAsync(
string fullReference, DateTime startUtc, DateTime endUtc, TimeSpan interval,
HistoryAggregateType aggregate, CancellationToken cancellationToken)
@@ -1590,10 +1568,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
.ConfigureAwait(false);
}
- /// Reads historical data at specific timestamps from the remote OPC UA server.
- /// Fully-qualified node identifier to read history for.
- /// List of specific timestamps to read values at.
- /// Cancellation token for the operation.
+ ///
public async Task ReadAtTimeAsync(
string fullReference, IReadOnlyList timestampsUtc, CancellationToken cancellationToken)
{
@@ -1665,6 +1640,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
/// Map to the OPC UA Part 13 standard aggregate NodeId.
/// The aggregation function type to map.
+ /// The OPC UA aggregate function NodeId corresponding to the given aggregate type.
internal static NodeId MapAggregateToNodeId(HistoryAggregateType aggregate) => aggregate switch
{
HistoryAggregateType.Average => ObjectIds.AggregateFunction_Average,
@@ -1694,7 +1670,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
?? ResolveEndpointCandidates(_options).FirstOrDefault()
?? _options.EndpointUrl;
- /// Gets the current connectivity status of the remote OPC UA server host.
+ ///
public IReadOnlyList GetHostStatuses()
{
lock (_probeLock)
@@ -1927,6 +1903,7 @@ public sealed class OpcUaClientDriver : IDriver, ITagDiscovery, IReadable, IWrit
}
/// Asynchronously disposes the driver and releases all associated resources.
+ /// A task that represents the asynchronous dispose operation.
public async ValueTask DisposeAsync()
{
if (_disposed) return;
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7CpuTypeMap.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7CpuTypeMap.cs
index 9f591094..8de3c279 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7CpuTypeMap.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7CpuTypeMap.cs
@@ -4,6 +4,9 @@ namespace ZB.MOM.WW.OtOpcUa.Driver.S7;
internal static class S7CpuTypeMap
{
+ /// Maps an enum value to the equivalent S7.Net .
+ /// The S7 CPU type to convert.
+ /// The corresponding value.
public static S7NetCpuType ToS7Net(S7CpuType type) => type switch
{
S7CpuType.S7200 => S7NetCpuType.S7200,
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7Driver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7Driver.cs
index 312144dc..c63636f5 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7Driver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7/S7Driver.cs
@@ -103,15 +103,12 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
private DriverHealth _health = new(DriverState.Unknown, null, null);
private bool _disposed;
- /// Gets the unique driver instance identifier.
+ ///
public string DriverInstanceId => driverInstanceId;
- /// Gets the driver type name.
+ ///
public string DriverType => "S7";
- /// Initializes the driver with the provided configuration.
- /// JSON configuration string.
- /// Cancellation token.
- /// A task representing the asynchronous operation.
+ ///
public async Task InitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
_health = new DriverHealth(DriverState.Initializing, null, null);
@@ -192,10 +189,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
}
}
- /// Reinitializes the driver with a new configuration.
- /// JSON configuration string.
- /// Cancellation token.
- /// A task representing the asynchronous operation.
+ ///
public async Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
// InitializeAsync re-parses driverConfigJson, so a config change delivered here is
@@ -204,9 +198,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
await InitializeAsync(driverConfigJson, cancellationToken).ConfigureAwait(false);
}
- /// Shuts down the driver and releases resources.
- /// Cancellation token.
- /// A task representing the asynchronous operation.
+ ///
public async Task ShutdownAsync(CancellationToken cancellationToken)
{
// Signal cancellation to the probe + poll loops first, collect their Task handles,
@@ -251,13 +243,10 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
_health = new DriverHealth(DriverState.Unknown, _health.LastSuccessfulRead, null);
}
- /// Gets the current driver health.
- /// The current health state.
+ ///
public DriverHealth GetHealth() => _health;
- /// Flushes optional caches to free memory.
- /// Cancellation token.
- /// A task representing the asynchronous operation.
+ ///
public Task FlushOptionalCachesAsync(CancellationToken cancellationToken) => Task.CompletedTask;
///
@@ -338,14 +327,12 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
/// under 4 KB; return 0 because the contract asks for a
/// driver-attributable growth number and S7.Net doesn't expose one.
///
+ /// Zero, as S7.Net does not expose a queryable memory footprint.
public long GetMemoryFootprint() => 0;
// ---- IReadable ----
- /// Reads values from the specified tag references.
- /// Tag references to read.
- /// Cancellation token.
- /// A task representing the asynchronous operation returning a list of data value snapshots.
+ ///
public async Task> ReadAsync(
IReadOnlyList fullReferences, CancellationToken cancellationToken)
{
@@ -457,10 +444,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
// ---- IWritable ----
- /// Writes values to the specified tags.
- /// Write requests containing tag references and values.
- /// Cancellation token.
- /// A task representing the asynchronous operation returning a list of write results.
+ ///
public async Task> WriteAsync(
IReadOnlyList writes, CancellationToken cancellationToken)
{
@@ -597,10 +581,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
// ---- ITagDiscovery ----
- /// Discovers tags and builds the OPC UA address space.
- /// Address space builder.
- /// Cancellation token.
- /// A task representing the asynchronous operation.
+ ///
public Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(builder);
@@ -638,11 +619,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
// ---- ISubscribable (polling overlay) ----
- /// Subscribes to changes on the specified tag references.
- /// Tag references to subscribe to.
- /// Polling interval.
- /// Cancellation token.
- /// A task representing the asynchronous operation returning a subscription handle.
+ ///
public Task SubscribeAsync(
IReadOnlyList fullReferences, TimeSpan publishingInterval, CancellationToken cancellationToken)
{
@@ -662,10 +639,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
return Task.FromResult(handle);
}
- /// Unsubscribes from a subscription.
- /// Subscription handle.
- /// Cancellation token.
- /// A task representing the asynchronous operation.
+ ///
public Task UnsubscribeAsync(ISubscriptionHandle handle, CancellationToken cancellationToken)
{
if (handle is S7SubscriptionHandle h && _subscriptions.TryRemove(h.Id, out var state))
@@ -812,7 +786,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
private sealed record S7SubscriptionHandle(long Id) : ISubscriptionHandle
{
- /// Gets the diagnostic identifier for this subscription.
+ ///
public string DiagnosticId => $"s7-sub-{Id}";
}
@@ -825,8 +799,7 @@ public sealed class S7Driver(S7DriverOptions options, string driverInstanceId, I
///
public string HostName => $"{_options.Host}:{_options.Port}";
- /// Gets the host connectivity statuses.
- /// A list containing the current host status.
+ ///
public IReadOnlyList GetHostStatuses()
{
lock (_probeLock)
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/ITwinCATClient.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/ITwinCATClient.cs
index 03a12b4b..6b0eba9a 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/ITwinCATClient.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/ITwinCATClient.cs
@@ -17,6 +17,7 @@ public interface ITwinCATClient : IDisposable
/// The target AMS address.
/// The connection timeout.
/// Cancellation token for the connection attempt.
+ /// A task that represents the asynchronous operation.
Task ConnectAsync(TwinCATAmsAddress address, TimeSpan timeout, CancellationToken cancellationToken);
/// True when the AMS router + target both accept commands.
@@ -41,6 +42,7 @@ public interface ITwinCATClient : IDisposable
/// The target data type.
/// Optional bit index for bit extraction within a word.
/// Cancellation token for the read operation.
+ /// A tuple of the boxed value (or null) and the mapped OPC UA status code.
Task<(object? value, uint status)> ReadValueAsync(
string symbolPath,
TwinCATDataType type,
@@ -56,6 +58,7 @@ public interface ITwinCATClient : IDisposable
/// Optional bit index for bit manipulation within a word.
/// The value to write.
/// Cancellation token for the write operation.
+ /// The mapped OPC UA status code (0 = Good).
Task WriteValueAsync(
string symbolPath,
TwinCATDataType type,
@@ -68,6 +71,7 @@ public interface ITwinCATClient : IDisposable
/// Used by 's probe loop.
///
/// Cancellation token for the probe operation.
+ /// true when the target's AMS state is reachable; otherwise false.
Task ProbeAsync(CancellationToken cancellationToken);
///
@@ -85,6 +89,7 @@ public interface ITwinCATClient : IDisposable
/// immediately (Driver.TwinCAT-014).
/// Invoked with (symbolPath, boxedValue) per notification.
/// Cancels the initial registration; does not tear down an established notification.
+ /// An opaque handle whose tears the notification down.
Task AddNotificationAsync(
string symbolPath,
TwinCATDataType type,
@@ -102,6 +107,7 @@ public interface ITwinCATClient : IDisposable
/// decide whether to drill in via their own walker.
///
/// Cancellation token for the enumeration operation.
+ /// An async sequence of discovered symbols from the target's symbol table.
IAsyncEnumerable BrowseSymbolsAsync(CancellationToken cancellationToken);
}
@@ -125,5 +131,6 @@ public sealed record TwinCATDiscoveredSymbol(
public interface ITwinCATClientFactory
{
/// Creates a new TwinCAT client instance.
+ /// A new instance.
ITwinCATClient Create();
}
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriver.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriver.cs
index 89feddc4..e3cfe5ec 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriver.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriver.cs
@@ -56,15 +56,12 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
OnDataChange?.Invoke(this, new DataChangeEventArgs(handle, tagRef, snapshot)));
}
- /// Gets the unique driver instance identifier.
+ ///
public string DriverInstanceId => _driverInstanceId;
- /// Gets the driver type name.
+ ///
public string DriverType => "TwinCAT";
- /// Initializes the driver with configuration and establishes device connections.
- /// JSON configuration string for the driver.
- /// Cancellation token.
- /// Completion task.
+ ///
public Task InitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
_health = new DriverHealth(DriverState.Initializing, null, null);
@@ -109,19 +106,14 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
return Task.CompletedTask;
}
- /// Reinitializes the driver by shutting down and reinitializing with new configuration.
- /// JSON configuration string for the driver.
- /// Cancellation token.
- /// Completion task.
+ ///
public async Task ReinitializeAsync(string driverConfigJson, CancellationToken cancellationToken)
{
await ShutdownAsync(cancellationToken).ConfigureAwait(false);
await InitializeAsync(driverConfigJson, cancellationToken).ConfigureAwait(false);
}
- /// Shuts down the driver and releases all device connections and subscriptions.
- /// Cancellation token.
- /// Completion task.
+ ///
public async Task ShutdownAsync(CancellationToken cancellationToken)
{
// Native subs first — disposing the handles is cheap + lets the client close its
@@ -154,8 +146,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
_health = new DriverHealth(DriverState.Unknown, _health.LastSuccessfulRead, null);
}
- /// Gets the current driver health status.
- /// Driver health information.
+ ///
public DriverHealth GetHealth() => _health;
///
@@ -165,6 +156,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
/// ~256 bytes per pre-declared tag (tag-definition record + dictionary overhead) and
/// ~512 bytes per active native subscription.
///
+ /// The estimated memory usage in bytes attributable to this driver instance.
public long GetMemoryFootprint() =>
(_tagsByName.Count * 256L) + (_nativeSubs.Count * 512L);
@@ -187,10 +179,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
// ---- IReadable ----
- /// Reads values for the specified tag references from ADS devices.
- /// The full tag references to read.
- /// Cancellation token.
- /// Data value snapshots for each reference.
+ ///
public async Task> ReadAsync(
IReadOnlyList fullReferences, CancellationToken cancellationToken)
{
@@ -245,10 +234,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
// ---- IWritable ----
- /// Writes values to the specified tags on ADS devices.
- /// The write requests to execute.
- /// Cancellation token.
- /// Write results for each request.
+ ///
public async Task> WriteAsync(
IReadOnlyList writes, CancellationToken cancellationToken)
{
@@ -309,10 +295,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
// ---- ITagDiscovery ----
- /// Discovers devices and tags from ADS configuration and optionally controller symbols.
- /// Address space builder for adding discovered nodes.
- /// Cancellation token.
- /// Completion task.
+ ///
public async Task DiscoverAsync(IAddressSpaceBuilder builder, CancellationToken cancellationToken)
{
ArgumentNullException.ThrowIfNull(builder);
@@ -447,10 +430,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
return handle;
}
- /// Unsubscribes from a native or poll-based subscription.
- /// The subscription handle to unsubscribe.
- /// Cancellation token.
- /// Completion task.
+ ///
public Task UnsubscribeAsync(ISubscriptionHandle handle, CancellationToken cancellationToken)
{
if (handle is NativeSubscriptionHandle native && _nativeSubs.TryRemove(native.Id, out var sub))
@@ -464,7 +444,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
private sealed record NativeSubscriptionHandle(long Id) : ISubscriptionHandle
{
- /// Gets the diagnostic identifier for the subscription.
+ ///
public string DiagnosticId => $"twincat-native-sub-{Id}";
}
@@ -474,8 +454,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
// ---- IHostConnectivityProbe ----
- /// Gets the connectivity status for all configured devices.
- /// List of host connectivity statuses.
+ ///
public IReadOnlyList GetHostStatuses() =>
[.. _devices.Values.Select(s => new HostConnectivityStatus(s.Options.HostAddress, s.HostState, s.HostStateChangedUtc))];
@@ -536,9 +515,7 @@ public sealed class TwinCATDriver : IDriver, IReadable, IWritable, ITagDiscovery
///
public const string UnresolvedHostSentinel = "";
- /// Resolves the device host address for the specified tag reference.
- /// The full tag reference.
- /// The host address or if not found.
+ ///
public string ResolveHost(string fullReference)
{
if (_tagsByName.TryGetValue(fullReference, out var def))
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriverFactoryExtensions.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriverFactoryExtensions.cs
index 72430816..0195f04b 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriverFactoryExtensions.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATDriverFactoryExtensions.cs
@@ -24,6 +24,7 @@ public static class TwinCATDriverFactoryExtensions
/// Creates a TwinCAT driver instance from the provided configuration.
/// The driver instance identifier.
/// The driver configuration as JSON.
+ /// A new configured from the supplied JSON.
internal static TwinCATDriver CreateInstance(string driverInstanceId, string driverConfigJson)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverInstanceId);
@@ -39,6 +40,7 @@ public static class TwinCATDriverFactoryExtensions
///
/// The JSON configuration string.
/// The driver instance identifier.
+ /// The parsed .
internal static TwinCATDriverOptions ParseOptions(string driverConfigJson, string driverInstanceId)
{
ArgumentException.ThrowIfNullOrWhiteSpace(driverConfigJson);
@@ -79,6 +81,7 @@ public static class TwinCATDriverFactoryExtensions
///
/// The JSON configuration string.
/// The driver instance identifier.
+ /// The parsed .
public static TwinCATDriverOptions ParseOptionsForTests(string driverConfigJson, string driverInstanceId)
=> ParseOptions(driverConfigJson, driverInstanceId);
diff --git a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATSystemSymbolFilter.cs b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATSystemSymbolFilter.cs
index 7db22b59..9be270f0 100644
--- a/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATSystemSymbolFilter.cs
+++ b/src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.TwinCAT/TwinCATSystemSymbolFilter.cs
@@ -10,6 +10,7 @@ public static class TwinCATSystemSymbolFilter
{
/// Gets a value indicating whether a symbol is a system or infrastructure symbol.
/// The symbol instance path to check.
+ /// when the symbol is a TwinCAT system or infrastructure symbol; otherwise .
public static bool IsSystemSymbol(string instancePath)
{
if (string.IsNullOrWhiteSpace(instancePath)) return true;
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionReaper.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionReaper.cs
index cffe77a6..96f61753 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionReaper.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionReaper.cs
@@ -38,6 +38,8 @@ public sealed class BrowseSessionReaper(
/// Evicts every session whose
/// is older than . Internal so tests can drive a tick directly.
+ /// Cancellation token for the reap operation.
+ /// A task that represents the asynchronous operation.
internal async Task ReapOnceAsync(CancellationToken ct)
{
var now = DateTime.UtcNow;
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionRegistry.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionRegistry.cs
index ca6feee9..112b8fb7 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionRegistry.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/BrowseSessionRegistry.cs
@@ -14,17 +14,25 @@ public sealed class BrowseSessionRegistry
private readonly ConcurrentDictionary _sessions = new();
/// Adds (or replaces) a session in the registry keyed by its token.
+ /// The browse session to register.
public void Register(IBrowseSession session) => _sessions[session.Token] = session;
/// Looks up a session by token without removing it.
+ /// The token to look up.
+ /// The session, if found.
+ /// true if the session was found; otherwise false.
public bool TryGet(Guid token, out IBrowseSession session) =>
_sessions.TryGetValue(token, out session!);
/// Atomically removes a session from the registry, returning it for disposal.
+ /// The token of the session to remove.
+ /// The removed session, if found.
+ /// true if the session was removed; otherwise false.
public bool TryRemove(Guid token, out IBrowseSession session) =>
_sessions.TryRemove(token, out session!);
/// Returns a point-in-time snapshot of all currently registered sessions.
+ /// A read-only list of token/session pairs.
public IReadOnlyList<(Guid Token, IBrowseSession Session)> Snapshot() =>
_sessions.Select(kv => (kv.Key, kv.Value)).ToList();
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/IBrowserSessionService.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/IBrowserSessionService.cs
index b7b171bd..7fb57ed5 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/IBrowserSessionService.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Browsing/IBrowserSessionService.cs
@@ -21,21 +21,38 @@ public interface IBrowserSessionService
{
/// Opens a session against the named driver type using the given JSON config.
/// Never throws — all errors are surfaced via .
+ /// The driver type name to open a browse session for.
+ /// The driver configuration as a JSON string.
+ /// Cancellation token.
+ /// A task that resolves to the open result, including a token on success.
Task OpenAsync(string driverType, string configJson, CancellationToken ct);
/// Returns the root nodes of an open session. Throws
/// if the token is unknown.
+ /// The session token returned by .
+ /// Cancellation token.
+ /// A task that resolves to the root browse nodes.
Task> RootAsync(Guid token, CancellationToken ct);
/// Returns the direct children of in an open session.
/// Throws if the token is unknown.
+ /// The session token returned by .
+ /// The node identifier to expand.
+ /// Cancellation token.
+ /// A task that resolves to the child browse nodes.
Task> ExpandAsync(Guid token, string nodeId, CancellationToken ct);
/// Returns the attributes of in an open session. Throws
/// if the token is unknown.
+ /// The session token returned by .
+ /// The node identifier to read attributes for.
+ /// Cancellation token.
+ /// A task that resolves to the attribute information for the node.
Task> AttributesAsync(Guid token, string nodeId, CancellationToken ct);
/// Removes the session from the registry and disposes it. No-op for unknown tokens.
+ /// The session token to close.
+ /// A task that represents the asynchronous operation.
Task CloseAsync(Guid token);
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminOperationsClient.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminOperationsClient.cs
index 651ec286..8dbec6c0 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminOperationsClient.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminOperationsClient.cs
@@ -25,10 +25,7 @@ public sealed class AdminOperationsClient : IAdminOperationsClient
_proxy = registry.Get();
}
- /// Starts a deployment via the admin operations actor.
- /// The username of who initiated the deployment.
- /// The cancellation token.
- /// The deployment start result.
+ ///
public async Task StartDeploymentAsync(string createdBy, CancellationToken ct)
{
var msg = new StartDeployment(createdBy, CorrelationId.NewId());
@@ -42,6 +39,10 @@ public sealed class AdminOperationsClient : IAdminOperationsClient
/// Uses the caller-supplied for cancellation; does not impose an
/// additional internal timeout beyond what the proxy itself enforces.
///
+ /// The expected response type from the actor.
+ /// The message to forward to the AdminOperationsActor singleton.
+ /// Cancellation token for the ask operation.
+ /// A task that resolves to the actor's response of type .
public Task AskAsync(object message, CancellationToken ct)
=> _proxy.Ask(message, cancellationToken: ct);
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminProbeService.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminProbeService.cs
index 49415b66..4a9d5792 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminProbeService.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/AdminProbeService.cs
@@ -25,6 +25,7 @@ public sealed class AdminProbeService
/// Driver config as JSON (same shape as DriverInstance.DriverConfig).
/// Per-probe timeout; actor clamps to [1, 60].
/// Optional cancellation token from the caller.
+ /// A task that resolves to the from the probe.
public async Task TestAsync(
string driverType,
string configJson,
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/FleetDiagnosticsClient.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/FleetDiagnosticsClient.cs
index 1780d899..81a0b6cc 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/FleetDiagnosticsClient.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/FleetDiagnosticsClient.cs
@@ -31,10 +31,7 @@ public sealed class FleetDiagnosticsClient : IFleetDiagnosticsClient
_systemName = options.Value.SystemName;
}
- /// Gets diagnostics for a cluster node.
- /// The node identifier to query.
- /// Cancellation token.
- /// Diagnostics snapshot for the node, or an empty snapshot if the query fails.
+ ///
public async Task GetDiagnosticsAsync(NodeId nodeId, CancellationToken ct)
{
var selection = _system.ActorSelection($"akka.tcp://{_systemName}@{nodeId.Value}/user/driver-host");
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/ServiceCollectionExtensions.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/ServiceCollectionExtensions.cs
index c0d947a2..8aa8debb 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/ServiceCollectionExtensions.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Clients/ServiceCollectionExtensions.cs
@@ -10,6 +10,7 @@ public static class ServiceCollectionExtensions
/// Registers the Admin UI client services in the dependency injection container.
///
/// The service collection to register clients into.
+ /// The same service collection for chaining.
public static IServiceCollection AddOtOpcUaAdminClients(this IServiceCollection services)
{
services.AddScoped();
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/AbLegacyAddressBuilder.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/AbLegacyAddressBuilder.cs
index 03137eaf..a9a3d459 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/AbLegacyAddressBuilder.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/AbLegacyAddressBuilder.cs
@@ -7,6 +7,11 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.Pickers;
///
public static class AbLegacyAddressBuilder
{
+ /// Builds the canonical AB Legacy PLC address string from its components.
+ /// The file-type prefix (e.g. "N", "F", "B").
+ /// The file number.
+ /// The element index within the file.
+ /// The canonical address string, for example N7:0.
public static string Build(string fileType, int fileNumber, int element)
=> $"{fileType}{fileNumber}:{element}";
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/FocasAddressBuilder.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/FocasAddressBuilder.cs
index b5ebd94c..729c1a77 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/FocasAddressBuilder.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/FocasAddressBuilder.cs
@@ -7,6 +7,10 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.Pickers;
///
public static class FocasAddressBuilder
{
+ /// Builds a canonical FOCAS address string from a parameter group and parameter ID.
+ /// The FOCAS parameter group (e.g. "axis").
+ /// The FOCAS parameter identifier.
+ /// The canonical address string in the form group:parameterId.
public static string Build(string group, int parameterId)
=> $"{group}:{parameterId}";
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/HistorianWonderwareAddressBuilder.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/HistorianWonderwareAddressBuilder.cs
index 2fc5b467..df0e19a4 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/HistorianWonderwareAddressBuilder.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/HistorianWonderwareAddressBuilder.cs
@@ -7,6 +7,11 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.Pickers;
///
public static class HistorianWonderwareAddressBuilder
{
+ /// Builds a Wonderware Historian address query string from tag name, mode, and interval.
+ /// The Wonderware Historian tag name.
+ /// The retrieval mode (e.g., Cyclic, Delta).
+ /// The retrieval interval in seconds.
+ /// The canonical address query string.
public static string Build(string tagName, string mode, int interval)
=> $"{tagName}?mode={mode}&interval={interval}";
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/ModbusAddressBuilder.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/ModbusAddressBuilder.cs
index 13b90164..3aee2225 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/ModbusAddressBuilder.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/ModbusAddressBuilder.cs
@@ -7,6 +7,11 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.Pickers;
///
public static class ModbusAddressBuilder
{
+ /// Builds a canonical Modbus address string from the given register type, offset, and length.
+ /// The register type (Coil, DiscreteInput, Input, or Holding).
+ /// The zero-based register offset.
+ /// The number of registers.
+ /// The canonical address string in the form Xx00000-N.
public static string Build(string regType, int offset, int length)
{
var prefix = regType switch
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/S7AddressBuilder.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/S7AddressBuilder.cs
index 6280681d..7ec13e1b 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/S7AddressBuilder.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/Pickers/S7AddressBuilder.cs
@@ -7,10 +7,12 @@ namespace ZB.MOM.WW.OtOpcUa.AdminUI.Components.Shared.Drivers.Pickers;
///
public static class S7AddressBuilder
{
+ /// Builds the canonical S7 address string from the given components.
/// DB / M / I / Q
/// Only relevant when area == "DB".
/// Byte offset (decimal).
/// X / B / W / D / REAL
+ /// The canonical S7 address string (e.g. DB10.DBD20:REAL, M0.0:X).
public static string Build(string area, int dbNumber, int offset, string s7Type)
{
if (area == "DB")
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/ResilienceFormModel.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/ResilienceFormModel.cs
index 729b6ab3..bc7178da 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/ResilienceFormModel.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Components/Shared/Drivers/ResilienceFormModel.cs
@@ -14,19 +14,27 @@ public sealed class ResilienceFormModel
public static readonly string[] Capabilities =
["Read", "Write", "Discover", "Subscribe", "Probe", "AlarmSubscribe", "AlarmAcknowledge", "HistoryRead"];
+ /// Gets or sets the maximum number of concurrent bulkhead operations, or to use the driver default.
public int? BulkheadMaxConcurrent { get; set; }
+ /// Gets or sets the maximum bulkhead queue depth, or to use the driver default.
public int? BulkheadMaxQueue { get; set; }
+ /// Gets or sets the driver recycle interval in seconds, or to use the driver default.
public int? RecycleIntervalSeconds { get; set; }
// capability name -> (timeout, retry, breaker), each nullable.
+ /// Gets or sets the per-capability policy overrides keyed by capability name.
public Dictionary Policies { get; set; } =
Capabilities.ToDictionary(c => c, _ => new CapabilityRow(), StringComparer.OrdinalIgnoreCase);
public sealed class CapabilityRow
{
+ /// Gets or sets the timeout in seconds for this capability, or to use the driver default.
public int? TimeoutSeconds { get; set; }
+ /// Gets or sets the retry count for this capability, or to use the driver default.
public int? RetryCount { get; set; }
+ /// Gets or sets the circuit-breaker failure threshold for this capability, or to use the driver default.
public int? BreakerFailureThreshold { get; set; }
+ /// Gets a value indicating whether all policy fields are null (no overrides set).
public bool IsEmpty => TimeoutSeconds is null && RetryCount is null && BreakerFailureThreshold is null;
}
@@ -37,6 +45,9 @@ public sealed class ResilienceFormModel
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
};
+ /// Deserializes a from the given JSON string, returning an empty model on null or malformed input.
+ /// The JSON string to deserialize, or .
+ /// A populated , or an empty one if is null/blank/malformed.
public static ResilienceFormModel FromJson(string? json)
{
var model = new ResilienceFormModel();
@@ -62,6 +73,7 @@ public sealed class ResilienceFormModel
}
/// Emit only the non-null overrides; returns null when nothing is overridden.
+ /// A JSON string containing only the non-null overrides, or if nothing is overridden.
public string? ToJson()
{
var caps = Policies
@@ -89,16 +101,23 @@ public sealed class ResilienceFormModel
private sealed class Shape
{
+ /// Gets or sets the maximum number of concurrent bulkhead operations.
public int? BulkheadMaxConcurrent { get; set; }
+ /// Gets or sets the maximum bulkhead queue depth.
public int? BulkheadMaxQueue { get; set; }
+ /// Gets or sets the recycle interval in seconds.
public int? RecycleIntervalSeconds { get; set; }
+ /// Gets or sets the per-capability policy shapes.
public Dictionary? CapabilityPolicies { get; set; }
}
private sealed class PolicyShape
{
+ /// Gets or sets the timeout in seconds.
public int? TimeoutSeconds { get; set; }
+ /// Gets or sets the retry count.
public int? RetryCount { get; set; }
+ /// Gets or sets the circuit-breaker failure threshold.
public int? BreakerFailureThreshold { get; set; }
}
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/EndpointRouteBuilderExtensions.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/EndpointRouteBuilderExtensions.cs
index eafdbd44..90959eda 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/EndpointRouteBuilderExtensions.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/EndpointRouteBuilderExtensions.cs
@@ -18,6 +18,7 @@ public static class EndpointRouteBuilderExtensions
///
/// The root component type for Razor pages.
/// The endpoint route builder.
+ /// The same for chaining.
public static IEndpointRouteBuilder MapAdminUI(this IEndpointRouteBuilder app)
where TApp : IComponent
{
@@ -33,6 +34,7 @@ public static class EndpointRouteBuilderExtensions
/// Adds AdminUI services to the dependency injection container.
///
/// The service collection.
+ /// The same for chaining.
public static IServiceCollection AddAdminUI(this IServiceCollection services)
{
services.AddRazorComponents().AddInteractiveServerComponents();
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/AlertSignalRBridge.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/AlertSignalRBridge.cs
index 906db2a3..145a0683 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/AlertSignalRBridge.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/AlertSignalRBridge.cs
@@ -25,6 +25,7 @@ public sealed class AlertSignalRBridge : ReceiveActor
///
/// The SignalR hub context to send alerts to.
/// In-process fan-out read directly by the Blazor Server Alerts page.
+ /// Akka for creating an actor.
public static Props Props(IHubContext hub, IInProcessBroadcaster broadcaster) =>
Akka.Actor.Props.Create(() => new AlertSignalRBridge(hub, broadcaster));
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusHub.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusHub.cs
index 88a70ee7..0a4de860 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusHub.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusHub.cs
@@ -28,6 +28,8 @@ public sealed class DriverStatusHub : Hub
/// the current snapshot from the in-memory store so the client renders state without
/// waiting for the next change event.
///
+ /// The driver instance identifier to subscribe to.
+ /// A task that represents the asynchronous operation.
public async Task JoinDriver(string driverInstanceId)
{
var groupName = GroupName(driverInstanceId);
@@ -40,5 +42,7 @@ public sealed class DriverStatusHub : Hub
}
/// Builds the SignalR group name for a given driver instance.
+ /// The driver instance identifier.
+ /// The SignalR group name for the specified driver instance.
public static string GroupName(string driverInstanceId) => $"driver:{driverInstanceId}";
}
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusSignalRBridge.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusSignalRBridge.cs
index 6fc52c9b..88a8215c 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusSignalRBridge.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/DriverStatusSignalRBridge.cs
@@ -24,6 +24,7 @@ public sealed class DriverStatusSignalRBridge : ReceiveActor
/// Creates actor props for a .
/// The SignalR hub context for pushing snapshots to grouped clients.
/// Snapshot store updated before each SignalR push.
+ /// Akka for creating a actor.
public static Props Props(IHubContext hub, IDriverStatusSnapshotStore store) =>
Akka.Actor.Props.Create(() => new DriverStatusSignalRBridge(hub, store));
diff --git a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/HubRouteBuilderExtensions.cs b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/HubRouteBuilderExtensions.cs
index f30b5a55..5e707e48 100644
--- a/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/HubRouteBuilderExtensions.cs
+++ b/src/Server/ZB.MOM.WW.OtOpcUa.AdminUI/Hubs/HubRouteBuilderExtensions.cs
@@ -10,6 +10,7 @@ public static class HubRouteBuilderExtensions
/// Maps all OtOpcUa Admin UI SignalR hubs to their configured endpoints.
///
/// The endpoint route builder to register hubs on.
+ /// The same