C# 和 .NET 新增

适用于 .NET 的 C# OPC UA 客户端库

通过经过签名和加密的 opc.tcp 连接,用 C# 浏览、读取、写入和订阅 PLC、SCADA 系统和网关的 OPC UA 服务器。

基于 opc.tcp 的 OPC UA 二进制
Sign 和 SignAndEncrypt,最高支持 Aes256_Sha256_RsaPss
数据变化和事件订阅
匿名、用户名和 X.509 身份

包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 或独立的 sgcIndustrial 软件包中。

用 C# 读取和订阅 → · OPC UA 常见问题 →

C# OPC UA 客户端
using System;
using esegece.sgcWebSockets;

var opcua = new TsgcOPCUAClient();
opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
opcua.Connect();
Console.WriteLine(opcua.ReadValue("ns=2;s=Line1.Temperature"));
opcua.WriteValue("ns=2;s=Line1.Setpoint", 75.5);
opcua.Disconnect();

适用于 .NET 应用程序的 OPC UA 客户端

安全通道、会话、服务和订阅集成在一个类中,API 与 Delphi 组件相同。

sgcWebSockets .NET 中的 C# OPC UA 客户端是 TsgcOPCUAClient,属于 esegece.sgcIndustrial 包,命名空间为 esegece.sgcWebSockets。设置 EndpointUrl,选择 SecurityPolicy 和 SecurityMode,调用 Connect,然后使用 ns=2;s=Line1.Speed 这样的节点 ID。ReadValue 以普通 .NET 对象返回值(类型化数组,矩阵为 double[,]),WriteValue 会先读取节点的数据类型,使值按服务器期望的方式编码。

每次服务调用都是同步的,失败时抛出 EsgcOPCUAError,其 StatusCode 保存 OPC UA 状态码。订阅通过 OnDataChange 和 OnEvent 把数据变化和事件推送给您的处理程序。该包面向 .NET 8、.NET 9、.NET 10 和 .NET Standard 2.0。

服务

GetEndpoints、Browse、BrowseNext、TranslateBrowsePath、Read、Write 和 Call。

订阅

带死区和队列大小的数据变化项,带 select 和 where 子句的事件项。

安全

Sign 或 SignAndEncrypt 模式下的 Basic256Sha256、Aes128_Sha256_RsaOaep 和 Aes256_Sha256_RsaPss。

身份

匿名、用户名和密码,或 X.509 用户证书。

C# 中的 OPC UA,分步说明

引用 esegece.sgcIndustrial 包,连接后读取、浏览或订阅。本页的每个示例都可以针对 .NET 8 编译。

using System;
using esegece.sgcWebSockets;

var opcua = new TsgcOPCUAClient();
opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
opcua.Connect();
try
{
    Console.WriteLine("Speed: " + opcua.ReadValue("ns=2;s=Line1.Speed"));
    // write with an explicit built-in type
    opcua.WriteValue("ns=2;s=Line1.Mode", (ushort)2, TsgcOPCUABuiltInType.uabtUInt16);
}
catch (EsgcOPCUAError e)
{
    Console.WriteLine($"Status 0x{e.StatusCode:X8}: {e.Message}");
}
finally
{
    opcua.Disconnect();
}
using System;
using esegece.sgcWebSockets;
using static esegece.sgcWebSockets.sgcOPCUA_Types;

var opcua = new TsgcOPCUAClient();
opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
opcua.Connect();
// i=85 is the Objects folder
foreach (TsgcOPCUAReferenceDescription item in opcua.Browse("i=85"))
    Console.WriteLine(item.DisplayName.Text + " = " + sgcOPCUANodeIdToString(item.NodeId.NodeId));
// resolve a browse path to a node id
TsgcOPCUANodeId speed = opcua.TranslateBrowsePath("i=85", "/2:Line1/2:Speed");
Console.WriteLine(sgcOPCUANodeIdToString(speed));
// call a method with two Int32 arguments
TsgcOPCUAVariant[] outputs = opcua.Call("ns=2;s=Methods", "ns=2;s=Methods.Add", new[] {
    sgcOPCUAVariantSimple(TsgcOPCUABuiltInType.uabtInt32, 2),
    sgcOPCUAVariantSimple(TsgcOPCUABuiltInType.uabtInt32, 3) });
Console.WriteLine("Result: " + outputs[0].Value);
opcua.Disconnect();
using System;
using esegece.sgcWebSockets;
using static esegece.sgcWebSockets.sgcOPCUA_Encoding;

class LineMonitor
{
    public void Start(TsgcOPCUAClient aClient)
    {
        aClient.OnDataChange += OnOPCUADataChange;
        aClient.OnEvent += OnOPCUAEvent;
        TsgcOPCUASubscription subscription = aClient.CreateSubscription(500);
        // report changes larger than 0.5 only
        aClient.AddMonitoredItem(subscription, "ns=2;s=Line1.Temperature", 250, 1, true,
            TsgcOPCUADeadbandType.uadbtAbsolute, 0.5);
        // i=2253 is the Server object, which reports the events of the whole server
        aClient.AddEventMonitoredItem(subscription, "i=2253", new[] { "Message", "Severity", "SourceName" });
    }

    void OnOPCUADataChange(object Sender, TsgcOPCUASubscription aSubscription,
        TsgcOPCUAMonitoredItem aMonitoredItem, TsgcOPCUADataValue aValue)
    {
        Console.WriteLine("Temperature: " + aValue.Value.Value);
    }

    void OnOPCUAEvent(object Sender, TsgcOPCUASubscription aSubscription,
        TsgcOPCUAMonitoredItem aMonitoredItem, TsgcOPCUAVariant[] aEventFields)
    {
        // the fields arrive in the order of the select clauses
        Console.WriteLine(sgcOPCUAVariantToValue(aEventFields[2]) + " (" +
            sgcOPCUAVariantToValue(aEventFields[1]) + "): " + sgcOPCUAVariantToValue(aEventFields[0]));
    }
}
using System.IO;
using System.Linq;
using esegece.sgcWebSockets;

class SecureLine
{
    // DER bytes of the server certificate you trust
    readonly byte[] FTrusted = File.ReadAllBytes(@"C:\pki\trusted\server.der");

    public TsgcOPCUAClient Connect()
    {
        var opcua = new TsgcOPCUAClient();
        opcua.EndpointUrl = "opc.tcp://192.168.1.60:4840";
        opcua.SecurityPolicy = TsgcOPCUASecurityPolicy.opcspAes256_Sha256_RsaPss;
        opcua.SecurityMode = TsgcOPCUAMessageSecurityMode.opcsmSignAndEncrypt;
        // no certificate files set: the application certificate is created in memory
        // X.509 user identity
        opcua.Authentication.AuthenticationType = TsgcOPCUAAuthenticationType.opcatCertificate;
        opcua.Authentication.CertificateFile = @"C:\pki\user\operator.der";
        opcua.Authentication.PrivateKeyFile = @"C:\pki\user\operator.pem";
        opcua.OnValidateServerCertificate += OnOPCUAValidateServerCertificate;
        opcua.WatchDog.Enabled = true;   // reconnect after a network drop
        opcua.Connect();
        return opcua;
    }

    void OnOPCUAValidateServerCertificate(object Sender, byte[] aCertificate, ref bool aAccept)
    {
        aAccept = aCertificate != null && aCertificate.SequenceEqual(FTrusted);
    }
}

服务调用是同步的。在 WinForms、WPF 或 ASP.NET 应用程序中,请从工作线程或 Task.Run 内调用。订阅事件通过 NotifyEvents 触发:有 UI 线程时在 UI 线程上触发,否则在线程池上按顺序触发。

支持的 OPC UA 服务

简单重载接受节点 ID 字符串;完整重载接受规范中的请求类。

服务集服务C# 方法
发现GetEndpointsGetEndpoints
视图Browse, BrowseNextBrowse, BrowseNext
视图TranslateBrowsePathsToNodeIdsTranslateBrowsePath
属性ReadRead, ReadValue
属性WriteWrite, WriteValue
方法CallCall
订阅CreateSubscription, DeleteSubscriptions, SetPublishingModeCreateSubscription, DeleteSubscription, SetPublishingMode
MonitoredItemCreateMonitoredItems, ModifyMonitoredItems, DeleteMonitoredItemsAddMonitoredItem, AddEventMonitoredItem, ModifyMonitoredItem, RemoveMonitoredItem
订阅Publish, Republish, TransferSubscriptions由客户端完成:OnDataChange、OnEvent、OnKeepAlive、WatchDog

为生产环境打造的 OPC UA 客户端

自动处理发布循环

客户端保持足够的 Publish 请求在途,确认每条通知,请求服务器重新发布丢失的消息并丢弃重复项,因此您的处理程序对每个值只会看到一次。

死区和队列

AddMonitoredItem 为每个节点设置采样间隔、队列大小以及绝对或百分比死区。ModifyMonitoredItem 可在之后修改它们,SetPublishingMode 可暂停订阅。

事件和报警

AddEventMonitoredItem 返回您选择的事件字段,例如 Message、Severity 和 SourceName,并可通过可选的 where 子句过滤。

证书

应用程序证书从 DER 或 PEM 文件加载,在首次连接时创建并保存,或在内存中创建。除非 OnValidateServerCertificate 接受,否则服务器证书会被拒绝。

自动重连

网络中断后,WatchDog 首先重新激活同一个会话,并重新发布错过的通知。如果会话已不存在,则打开新会话并转移或重新创建订阅。OnReconnect 会说明走的是哪条路径,您的订阅对象保持有效。

与 Delphi 相同的 API

类、属性、方法和事件名称与 Delphi 和 C++Builder 组件一致,因此团队可以在两个平台上共用同一套设计。

属于 sgcWebSockets Enterprise

OPC UA 客户端包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 中,位于 esegece.sgcIndustrial 包内,与串口和 Modbus 组件放在一起。可在定价页面(.NET 标签)或 .NET 功能矩阵中比较各版本。

已对照基于 asyncua 构建的参考服务器进行测试,asyncua 是一个独立的开源 OPC UA 实现:全部十一个端点(每种策略和模式)、三种身份类型、带延续点的浏览、读取 18 种内置类型(含数组和矩阵)、方法调用、死区和事件订阅,以及两分钟的发布运行且无丢失或重复的消息。

C# OPC UA 常见问题

创建 TsgcOPCUAClient,设置 EndpointUrl,调用 Connect(),然后调用 ReadValue("ns=2;s=Line1.Speed")。它返回一个 object,其类型为该值的 .NET 类型。Read 可以一次调用读取多个节点和属性。

用发布间隔调用 CreateSubscription,用 AddMonitoredItem 添加节点并处理 OnDataChange。为每个监控项设置死区,可以让微小变化不进入您的处理程序。

Sign 或 SignAndEncrypt 模式下的 Basic256Sha256、Aes128_Sha256_RsaOaep 和 Aes256_Sha256_RsaPss,另有用于较旧服务器的已弃用的 Basic128Rsa15 和 Basic256,以及用于测试环境的 None。

处理 OnValidateServerCertificate,只对您信任的证书把 aAccept 设置为 true,例如把 DER 字节与您保存的副本进行比较。如果没有该处理程序,所有安全连接都会被拒绝,除非为测试设置了 AutoAcceptServerCertificate。

客户端触发 OnError 和 OnDisconnect。启用 WatchDog.Enabled = true 后,它每隔 WatchDog.Interval 秒重试一次(默认 10 秒,WatchDog.Attempts 为 0 表示不限次数)。如果服务器仍保留会话,它会重新激活同一个会话,否则会打开新会话并转移或重新创建订阅。OnReconnect 会报告走的是哪条路径,您的订阅对象保持有效。

esegece.sgcIndustrial 包面向 .NET 8、.NET 9、.NET 10 和 .NET Standard 2.0,因此也可以在 .NET Framework 4.8 上运行。

OPC UA 客户端包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 或独立的 sgcIndustrial 软件包中。它不包含 OPC UA 服务器、HTTPS、JSON 和 WebSocket 传输、HistoryRead、PubSub、Reverse Connect 和 Global Discovery Server。

更多 sgcWebSockets .NET 内容

工业组件

串口、Modbus 和 OPC UA,附完整的组件参考。

C# Modbus TCP 和 RTU

适用于您的 OPC UA 服务器旁边那些设备的 Modbus 客户端和服务器。

C# MQTT 客户端

在同一个应用程序中把 OPC UA 数据变化转发到 MQTT 代理。

也适用于 Delphi 和 C++Builder

相同的 OPC UA 客户端,类名和方法名相同,WatchDog 重连也相同。

超值之选:All-AccesseSeGeCe 全部产品,含高级支持,每年 €1,059 起。
查看 All-Access 价格

用 C# 读取您的第一个 OPC UA 节点

包含在 sgcWebSockets Enterprise(Delphi 和 .NET)和 All-Access 或独立的 sgcIndustrial 软件包中。