using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Extensions.Logging; using ZB.MOM.WW.OtOpcUa.Core.Abstractions; using ZB.MOM.WW.OtOpcUa.Core.Hosting; namespace ZB.MOM.WW.OtOpcUa.Driver.Modbus; /// /// Static factory registration helper for . Server's Program.cs /// calls once at startup; the bootstrapper then /// materialises Modbus DriverInstance rows from the central config DB into live driver /// instances. Mirrors GalaxyProxyDriverFactoryExtensions / FocasDriverFactoryExtensions. /// public static class ModbusDriverFactoryExtensions { public const string DriverTypeName = "Modbus"; /// /// Register the Modbus factory with the driver registry. The optional /// is captured at registration time and used to /// construct an per driver instance — without it, /// the driver runs with the null logger (existing tests and standalone callers stay /// unchanged). /// /// The driver factory registry to register with. /// Optional logger factory for creating loggers per driver instance. public static void Register(DriverFactoryRegistry registry, ILoggerFactory? loggerFactory = null) { ArgumentNullException.ThrowIfNull(registry); registry.Register(DriverTypeName, (id, json) => CreateInstance(id, json, loggerFactory)); } /// 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. /// The constructed instance. public static ModbusDriver CreateInstance(string driverInstanceId, string driverConfigJson) => CreateInstance(driverInstanceId, driverConfigJson, loggerFactory: null); /// Logger-aware overload — used by 's closure when wired through DI. /// The unique identifier for the driver instance. /// The JSON configuration string for the driver. /// Optional logger factory for creating loggers per driver instance. /// The constructed instance. public static ModbusDriver CreateInstance(string driverInstanceId, string driverConfigJson, ILoggerFactory? loggerFactory) { ArgumentException.ThrowIfNullOrWhiteSpace(driverInstanceId); ArgumentException.ThrowIfNullOrWhiteSpace(driverConfigJson); var dto = JsonSerializer.Deserialize(driverConfigJson, JsonOptions) ?? throw new InvalidOperationException( $"Modbus driver config for '{driverInstanceId}' deserialised to null"); if (string.IsNullOrWhiteSpace(dto.Host)) throw new InvalidOperationException( $"Modbus driver config for '{driverInstanceId}' missing required Host"); var options = new ModbusDriverOptions { Host = dto.Host!, Port = dto.Port ?? 502, UnitId = dto.UnitId ?? 1, Timeout = TimeSpan.FromMilliseconds(dto.TimeoutMs ?? 2_000), MaxRegistersPerRead = dto.MaxRegistersPerRead ?? 125, MaxRegistersPerWrite = dto.MaxRegistersPerWrite ?? 123, MaxCoilsPerRead = dto.MaxCoilsPerRead ?? 2000, UseFC15ForSingleCoilWrites = dto.UseFC15ForSingleCoilWrites ?? false, UseFC16ForSingleRegisterWrites = dto.UseFC16ForSingleRegisterWrites ?? false, DisableFC23 = dto.DisableFC23 ?? false, WriteOnChangeOnly = dto.WriteOnChangeOnly ?? false, MaxReadGap = dto.MaxReadGap ?? 0, Family = dto.Family is null ? ModbusFamily.Generic : ParseEnum(dto.Family, "", driverInstanceId, "Family"), MelsecSubFamily = dto.MelsecSubFamily is null ? MelsecFamily.Q_L_iQR : ParseEnum(dto.MelsecSubFamily, "", driverInstanceId, "MelsecSubFamily"), AutoProhibitReprobeInterval = dto.AutoProhibitReprobeMs is { } reprobeMs ? TimeSpan.FromMilliseconds(reprobeMs) : null, AutoReconnect = dto.AutoReconnect ?? true, // v3: the deploy artifact (Wave C) populates rawTags with the cluster's authored raw Modbus // tags. The driver maps each RawTagEntry's TagConfig blob through ModbusTagDefinitionFactory // at Initialize; the legacy pre-declared DTO tag path (structured/AddressString → BuildTag) // is retired. RawTags = dto.RawTags is { Count: > 0 } ? [.. dto.RawTags] : [], Probe = new ModbusProbeOptions { Enabled = dto.Probe?.Enabled ?? true, Interval = TimeSpan.FromMilliseconds(dto.Probe?.IntervalMs ?? 5_000), Timeout = TimeSpan.FromMilliseconds(dto.Probe?.TimeoutMs ?? 2_000), ProbeAddress = dto.Probe?.ProbeAddress ?? 0, }, KeepAlive = dto.KeepAlive is null ? new ModbusKeepAliveOptions() : new ModbusKeepAliveOptions { Enabled = dto.KeepAlive.Enabled ?? true, Time = TimeSpan.FromMilliseconds(dto.KeepAlive.TimeMs ?? 30_000), Interval = TimeSpan.FromMilliseconds(dto.KeepAlive.IntervalMs ?? 10_000), RetryCount = dto.KeepAlive.RetryCount ?? 3, }, IdleDisconnectTimeout = dto.IdleDisconnectMs is { } ms ? TimeSpan.FromMilliseconds(ms) : null, Reconnect = dto.Reconnect is null ? new ModbusReconnectOptions() : new ModbusReconnectOptions { InitialDelay = TimeSpan.FromMilliseconds(dto.Reconnect.InitialDelayMs ?? 0), MaxDelay = TimeSpan.FromMilliseconds(dto.Reconnect.MaxDelayMs ?? 30_000), BackoffMultiplier = dto.Reconnect.BackoffMultiplier ?? 2.0, }, }; return new ModbusDriver( options, driverInstanceId, transportFactory: null, logger: loggerFactory?.CreateLogger()); } private static T ParseEnum(string? raw, string? tagName, string driverInstanceId, string field) where T : struct, Enum { if (string.IsNullOrWhiteSpace(raw)) throw new InvalidOperationException( $"Modbus tag '{tagName ?? ""}' in '{driverInstanceId}' missing {field}"); return Enum.TryParse(raw, ignoreCase: true, out var v) ? v : throw new InvalidOperationException( $"Modbus tag '{tagName}' has unknown {field} '{raw}'. " + $"Expected one of {string.Join(", ", Enum.GetNames())}"); } private static readonly JsonSerializerOptions JsonOptions = new() { PropertyNameCaseInsensitive = true, ReadCommentHandling = JsonCommentHandling.Skip, AllowTrailingCommas = true, }; internal sealed class ModbusDriverConfigDto { /// Gets or sets the host address. public string? Host { get; init; } /// Gets or sets the port number. public int? Port { get; init; } /// Gets or sets the unit identifier. public byte? UnitId { get; init; } /// Gets or sets the timeout in milliseconds. public int? TimeoutMs { get; init; } /// Gets or sets the maximum number of registers per read operation. public ushort? MaxRegistersPerRead { get; init; } /// Gets or sets the maximum number of registers per write operation. public ushort? MaxRegistersPerWrite { get; init; } /// Gets or sets the maximum number of coils per read operation. public ushort? MaxCoilsPerRead { get; init; } /// Gets or sets a value indicating whether to use function code 15 for single coil writes. public bool? UseFC15ForSingleCoilWrites { get; init; } /// Gets or sets a value indicating whether to use function code 16 for single register writes. public bool? UseFC16ForSingleRegisterWrites { get; init; } /// Gets or sets a value indicating whether to disable function code 23. public bool? DisableFC23 { get; init; } /// Gets or sets a value indicating whether to write only on change. public bool? WriteOnChangeOnly { get; init; } /// Gets or sets the maximum gap between register addresses for coalescing. public ushort? MaxReadGap { get; init; } /// Gets or sets the Modbus family type. public string? Family { get; init; } /// Gets or sets the Melsec subfamily. public string? MelsecSubFamily { get; init; } /// Gets or sets the automatic prohibition reprobei interval in milliseconds. public int? AutoProhibitReprobeMs { get; init; } /// Gets or sets a value indicating whether automatic reconnection is enabled. public bool? AutoReconnect { get; init; } /// Gets or sets the authored raw tags (RawPath + TagConfig blob + WriteIdempotent) the /// deploy artifact delivers. The driver maps each through the tag-definition factory at Initialize. public List? RawTags { get; init; } /// Gets or sets the probe configuration. public ModbusProbeDto? Probe { get; init; } /// Gets or sets the keep-alive configuration (connection-layer knob). public ModbusKeepAliveDto? KeepAlive { get; init; } /// Gets or sets the idle disconnect timeout in milliseconds. public int? IdleDisconnectMs { get; init; } /// Gets or sets the reconnect configuration. public ModbusReconnectDto? Reconnect { get; init; } } internal sealed class ModbusKeepAliveDto { /// Gets or sets a value indicating whether keep-alive is enabled. public bool? Enabled { get; init; } /// Gets or sets the keep-alive time in milliseconds. public int? TimeMs { get; init; } /// Gets or sets the keep-alive interval in milliseconds. public int? IntervalMs { get; init; } /// Gets or sets the retry count. public int? RetryCount { get; init; } } internal sealed class ModbusReconnectDto { /// Gets or sets the initial reconnect delay in milliseconds. public int? InitialDelayMs { get; init; } /// Gets or sets the maximum reconnect delay in milliseconds. public int? MaxDelayMs { get; init; } /// Gets or sets the backoff multiplier for exponential reconnect delays. public double? BackoffMultiplier { get; init; } } internal sealed class ModbusProbeDto { /// Gets or sets a value indicating whether probing is enabled. public bool? Enabled { get; init; } /// Gets or sets the probe interval in milliseconds. public int? IntervalMs { get; init; } /// Gets or sets the probe timeout in milliseconds. public int? TimeoutMs { get; init; } /// Gets or sets the probe register address. public ushort? ProbeAddress { get; init; } } }