feat: 增加基金会 OpcDa 组件

Author: ArgoZhang

src/extensions/BootstrapBlazor.OpcDa/BootstrapBlazor.OpcDa.csproj

@@ -0,0 +1,23 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <Version>9.0.0</Version>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <PackageTags>Bootstrap Blazor WebAssembly wasm UI Components SqlSugar</PackageTags>
+    <Description>Bootstrap UI components extensions of SqlSugar</Description>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Using Remove="BootstrapBlazor.Components" />
+    <Using Remove="Microsoft.AspNetCore.Components" />
+    <Using Remove="Microsoft.Extensions.DependencyInjection" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <!--<PackageReference Include="OpcNetApi.Com" Version="2.1.108" />-->
+    <PackageReference Include="ThingsGateway.Foundation.OpcDa" Version="10.9.69" />
+  </ItemGroup>
+
+</Project>

src/extensions/BootstrapBlazor.OpcDa/Extensions/ISubscriptionExtensions.cs

@@ -0,0 +1,20 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+namespace BootstrapBlazor.OpcDa;
+
+/// <summary>
+/// <see cref="Opc.Da.ISubscription"/> 扩展方法类
+/// </summary>
+public static class ISubscriptionExtensions
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="subscription"></param>
+    public static List<OpcItem> Read(this Opc.Da.ISubscription subscription)
+    {
+        return [];
+    }
+}

src/extensions/BootstrapBlazor.OpcDa/OpcItem.cs

@@ -0,0 +1,18 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+namespace BootstrapBlazor.OpcDa;
+
+using Opc.Da;
+
+/// <summary>
+/// OPC Item 配置实体类
+/// </summary>
+public record struct OpcItem(string Name, Quality Quality, DateTime Timestamp, object? Value)
+{
+    /// <summary>
+    /// 获得 Opc Item 上次值
+    /// </summary>
+    public object? LastValue { get; set; }
+}

src/extensions/BootstrapBlazor.OpcDa/OpcServer.cs

@@ -0,0 +1,195 @@
+// Copyright (c) Argo Zhang (argo@163.com). All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+// Website: https://www.blazor.zone or https://argozhang.github.io/
+
+using Opc;
+using Opc.Da;
+using System.Collections.Concurrent;
+
+namespace BootstrapBlazor.OpcDa;
+
+/// <summary>
+/// OPC Server 操作类
+/// </summary>
+public partial class OpcServer : IDisposable
+{
+    private Opc.Da.Server? _server = null;
+    private readonly ConcurrentDictionary<string, HashSet<OpcItem>> _valuesCache = [];
+    private readonly TaskCompletionSource _readTask = new();
+
+    /// <summary>
+    /// 获得 OPC Server 名称
+    /// </summary>
+    public string? ServerName { get; private set; }
+
+    /// <summary>
+    /// 获得 OPC Server 状态
+    /// </summary>
+    public bool IsConnected => _server?.IsConnected ?? false;
+
+    /// <summary>
+    /// 连接到 OPCServer 方法
+    /// </summary>
+    /// <param name="serverName">服务器名称</param>
+    /// <param name="token"></param>
+    /// <remarks>opcda://localhost/Kepware.KEPServerEX.V6</remarks>
+    /// <returns>成功时返回真</returns>
+    public async Task<bool> Connect(string serverName, CancellationToken? token = null)
+    {
+        ServerName = serverName;
+
+        try
+        {
+            // 如果已经连接则先断开
+            Disconnect();
+
+            await Task.Run(() =>
+            {
+                _server = new Opc.Da.Server(new OpcCom.Factory(), new URL(serverName));
+                _server.Connect();
+            }, token ?? CancellationToken.None);
+        }
+        catch (OperationCanceledException)
+        {
+
+        }
+        return IsConnected;
+    }
+
+    /// <summary>
+    /// 断开连接方法
+    /// </summary>
+    /// <returns></returns>
+    public void Disconnect()
+    {
+        ServerName = string.Empty;
+
+        if (_server != null && _server.IsConnected)
+        {
+            foreach (Subscription sub in _server.Subscriptions)
+            {
+                _server.CancelSubscription(sub);
+            }
+            _server.Disconnect();
+            _server = null;
+        }
+    }
+
+    /// <summary>
+    /// 创建订阅方法
+    /// </summary>
+    /// <param name="name">订阅名称</param>
+    /// <param name="updateRate"></param>
+    /// <param name="active"></param>
+    /// <param name="items"></param>
+    /// <returns></returns>
+    public ISubscription CreateSubscription(string name, int updateRate, bool active = true, Item[]? items = null)
+    {
+        var server = GetOpcServer();
+        var subscription = server.CreateSubscription(new SubscriptionState
+        {
+            Name = name,
+            Active = active,
+            UpdateRate = updateRate,
+            Deadband = 0
+        });
+
+        if (items is { Length: > 0 })
+        {
+            subscription.AddItems(items);
+            subscription.DataChanged += (subscriptionHandle, requestHandle, values) =>
+            {
+                foreach (var value in values)
+                {
+                    _valuesCache.AddOrUpdate(name, key => AddFactory(value), (key, v) => UpdateFactory(v, value));
+                }
+
+                _readTask.TrySetResult();
+            };
+        }
+        return subscription;
+    }
+
+    private static HashSet<OpcItem> AddFactory(ItemValueResult value)
+    {
+        return new HashSet<OpcItem>(OpcItemEqualityComparer.Instance)
+        {
+            new(value.ItemName, value.Quality, value.Timestamp, value.Value)
+        };
+    }
+
+    private static HashSet<OpcItem> UpdateFactory(HashSet<OpcItem> items, ItemValueResult value)
+    {
+        var item = new OpcItem(value.ItemName, value.Quality, value.Timestamp, value.Value);
+        if (items.TryGetValue(item, out var v))
+        {
+            item.LastValue = v.Value;
+        }
+        items.Remove(item);
+        items.Add(item);
+        return items;
+    }
+
+    /// <summary>
+    /// 取消订阅方法
+    /// </summary>
+    /// <param name="subscription">订阅接口 <see cref="ISubscription"/> 实例</param>
+    /// <returns></returns>
+    public void CancelSubscription(ISubscription subscription)
+    {
+        var server = GetOpcServer();
+        server.CancelSubscription(subscription);
+    }
+
+    /// <summary>
+    /// 读取指定 Item 值方法
+    /// </summary>
+    /// <param name="items"></param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
+    public HashSet<OpcItem> Read(params List<string> items)
+    {
+        var server = GetOpcServer();
+        var results = server.Read([.. items.Select(i => new Item() { ItemName = i })]);
+        return results.Select(i => new OpcItem(i.ItemName, i.Quality, i.Timestamp, i.Value)).ToHashSet(OpcItemEqualityComparer.Instance);
+    }
+
+    private Opc.Da.Server GetOpcServer()
+    {
+        if (_server == null)
+        {
+            throw new InvalidOperationException("OPC Server is not connected.");
+        }
+        return _server;
+    }
+
+    /// <summary>
+    /// Dispose 方法
+    /// </summary>
+    /// <param name="disposing"></param>
+    protected virtual void Dispose(bool disposing)
+    {
+        if (disposing)
+        {
+            Disconnect();
+        }
+    }
+
+    /// <summary>
+    /// <inheritdoc/>
+    /// </summary>
+    public void Dispose()
+    {
+        Dispose(true);
+        GC.SuppressFinalize(this);
+    }
+
+    class OpcItemEqualityComparer : IEqualityComparer<OpcItem>
+    {
+        public static OpcItemEqualityComparer Instance = new();
+
+        public bool Equals(OpcItem x, OpcItem y) => x.Name == y.Name;
+
+        public int GetHashCode([DisallowNull] OpcItem item) => item.Name.GetHashCode();
+    }
+}