使用C#开发OPC UA服务器

黎俊刚

OPC基金会提供了OPC UA .NET标准库以及示例程序，但官方文档过于简单，光看官方文档和示例程序很难弄懂OPC UA .NET标准库怎么用，花了不少时间摸索才略微弄懂如何使用，以下记录如何从一个控制台程序开发一个OPC UA服务器。
安装Nuget包

安装OPCFoundation.NetStandard.Opc.Ua

主程序

修改Program.cs代码如下：

1. using Opc.Ua;
2. using Opc.Ua.Configuration;
3. using Opc.Ua.Server;
5. namespace SampleOpcUaServer
6. {
7.     internal class Program
8.     {
9.         static void Main(string[] args)
10.         {
11.             // 启动OPC UA服务器
12.             ApplicationInstance application = new ApplicationInstance();
13.             application.ConfigSectionName = "OpcUaServer";
14.             application.LoadApplicationConfiguration(false).Wait();
15.             application.CheckApplicationInstanceCertificate(false, 0).Wait();
17.             var server = new StandardServer();
18.             var nodeManagerFactory = new NodeManagerFactory();
19.             server.AddNodeManager(nodeManagerFactory);
20.             application.Start(server).Wait();
22.             // 模拟数据
23.             var nodeManager = nodeManagerFactory.NodeManager;
24.             var simulationTimer = new System.Timers.Timer(1000);
25.             var random = new Random();
26.             simulationTimer.Elapsed += (sender, EventArgs) =>
27.             {
28.                 nodeManager?.UpdateValue("ns=2;s=Root_Test", random.NextInt64());
29.             };
30.             simulationTimer.Start();
32.             // 输出OPC UA Endpoint
33.             Console.WriteLine("Endpoints:");
34.             foreach (var endpoint in server.GetEndpoints().DistinctBy(x => x.EndpointUrl))
35.             {
36.                 Console.WriteLine(endpoint.EndpointUrl);
37.             }
39.             Console.WriteLine("按Enter添加新变量");
40.             Console.ReadLine();
42.             // 添加新变量
43.             nodeManager?.AddVariable("ns=2;s=Root", "Test2", (int)BuiltInType.Int16, ValueRanks.Scalar);
44.             Console.WriteLine("已添加变量");
45.             Console.ReadLine();
46.         }
47.     }
48. }

复制代码

上述代码中：

• ApplicationInstance是OPC UA标准库中用于配置OPC UA Server和检查证书的类。
  
• application.ConfigSectionName指定了配置文件的名称，配置文件是xml文件，将会在程序文件夹查找名为OpcUaServer.Config.xml的配置文件。配置文件内容见后文。
  
• application.LoadApplicationConfiguration加载前面指定的配置文件。如果不想使用配置文件，也可通过代码给application.ApplicationConfiguration赋值。
  
• 有StandardServer和ReverseConnectServer两种作为OPC UA服务器的类，ReverseConnectServer派生于StandardServer，这两种类的区别未深入研究，用StandardServer可满足基本的需求。
  
• OPC UA的地址空间由节点组成，简单理解节点就是提供给OPC UA客户端访问的变量和文件夹。通过server.AddNodeManager方法添加节点管理工厂类，NodeManagerFactory类定义见后文。
  
• 调用application.Start(server)方法后，OPC UA Server就会开始运行，并不会阻塞代码，为了保持在控制台程序中运行，所以使用Console.ReadLine()阻塞程序。
  
• nodeManager?.UpdateValue是自定义的更新OPC UA地址空间中变量值的方法。
  
• nodeManager?.AddVariable在此演示动态添加一个新的变量。
  

OPC UA配置文件

新建OpcUaServer.Config.xml文件。

在属性中设为“始终赋值”。

内容如下：

1. <?xml version="1.0" encoding="utf-8"?>
2. <ApplicationConfiguration
3.   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.   xmlns:ua="http://opcfoundation.org/UA/2008/02/Types.xsd"
5.   xmlns="http://opcfoundation.org/UA/SDK/Configuration.xsd"
6. >
7.         <ApplicationName>Sample OPC UA Server</ApplicationName>
8.         <ApplicationUri>urn:localhost:UA:OpcUaServer</ApplicationUri>
9.         <ProductUri>uri:opcfoundation.org:OpcUaServer</ProductUri>
10.         <ApplicationType>Server_0</ApplicationType>
12.         <SecurityConfiguration>
14.                
15.                 <ApplicationCertificate>
16.                         <StoreType>Directory</StoreType>
17.                         <StorePath>%CommonApplicationData%\OPC Foundation\pki\own</StorePath>
18.                         <SubjectName>CN=Sample Opc Ua Server, C=US, S=Arizona, O=SomeCompany, DC=localhost</SubjectName>
19.                 </ApplicationCertificate>
21.                
22.                 <TrustedIssuerCertificates>
23.                         <StoreType>Directory</StoreType>
24.                         <StorePath>%CommonApplicationData%\OPC Foundation\pki\issuer</StorePath>
25.                 </TrustedIssuerCertificates>
27.                
28.                 <TrustedPeerCertificates>
29.                         <StoreType>Directory</StoreType>
30.                         <StorePath>%CommonApplicationData%\OPC Foundation\pki\trusted</StorePath>
31.                 </TrustedPeerCertificates>
33.                
34.                 <RejectedCertificateStore>
35.                         <StoreType>Directory</StoreType>
36.                         <StorePath>%CommonApplicationData%\OPC Foundation\pki\rejected</StorePath>
37.                 </RejectedCertificateStore>
38.         </SecurityConfiguration>
40.         <TransportConfigurations></TransportConfigurations>
42.         <TransportQuotas>
43.                 <OperationTimeout>600000</OperationTimeout>
44.                 <MaxStringLength>1048576</MaxStringLength>
45.                 <MaxByteStringLength>1048576</MaxByteStringLength>
46.                 <MaxArrayLength>65535</MaxArrayLength>
47.                 <MaxMessageSize>4194304</MaxMessageSize>
48.                 <MaxBufferSize>65535</MaxBufferSize>
49.                 <ChannelLifetime>300000</ChannelLifetime>
50.                 <SecurityTokenLifetime>3600000</SecurityTokenLifetime>
51.         </TransportQuotas>
52.         <ServerConfiguration>
53.                 <BaseAddresses>
54.                         <ua:String>https://localhost:62545/OpcUaServer/</ua:String>
55.                         <ua:String>opc.tcp://localhost:62546/OpcUaServer</ua:String>
56.                 </BaseAddresses>
57.                 <SecurityPolicies>
58.                         <ServerSecurityPolicy>
59.                                 <SecurityMode>SignAndEncrypt_3</SecurityMode>
60.                                 <SecurityPolicyUri>http://opcfoundation.org/UA/SecurityPolicy#Basic256Sha256</SecurityPolicyUri>
61.                         </ServerSecurityPolicy>
62.                         <ServerSecurityPolicy>
63.                                 <SecurityMode>None_1</SecurityMode>
64.                                 <SecurityPolicyUri>http://opcfoundation.org/UA/SecurityPolicy#None</SecurityPolicyUri>
65.                         </ServerSecurityPolicy>
66.                         <ServerSecurityPolicy>
67.                                 <SecurityMode>Sign_2</SecurityMode>
68.                                 <SecurityPolicyUri></SecurityPolicyUri>
69.                         </ServerSecurityPolicy>
70.                         <ServerSecurityPolicy>
71.                                 <SecurityMode>SignAndEncrypt_3</SecurityMode>
72.                                 <SecurityPolicyUri></SecurityPolicyUri>
73.                         </ServerSecurityPolicy>
74.                 </SecurityPolicies>
75.                 <UserTokenPolicies>
76.                         <ua:UserTokenPolicy>
77.                                 <ua:TokenType>Anonymous_0</ua:TokenType>
78.                         </ua:UserTokenPolicy>
79.                         <ua:UserTokenPolicy>
80.                                 <ua:TokenType>UserName_1</ua:TokenType>
81.                         </ua:UserTokenPolicy>
82.                         <ua:UserTokenPolicy>
83.                                 <ua:TokenType>Certificate_2</ua:TokenType>
84.                         </ua:UserTokenPolicy>
85.                        
86.                 </UserTokenPolicies>
87.                 <DiagnosticsEnabled>false</DiagnosticsEnabled>
88.                 <MaxSessionCount>100</MaxSessionCount>
89.                 <MinSessionTimeout>10000</MinSessionTimeout>
90.                 <MaxSessionTimeout>3600000</MaxSessionTimeout>
91.                 <MaxBrowseContinuationPoints>10</MaxBrowseContinuationPoints>
92.                 <MaxQueryContinuationPoints>10</MaxQueryContinuationPoints>
93.                 <MaxHistoryContinuationPoints>100</MaxHistoryContinuationPoints>
94.                 <MaxRequestAge>600000</MaxRequestAge>
95.                 <MinPublishingInterval>100</MinPublishingInterval>
96.                 <MaxPublishingInterval>3600000</MaxPublishingInterval>
97.                 <PublishingResolution>50</PublishingResolution>
98.                 <MaxSubscriptionLifetime>3600000</MaxSubscriptionLifetime>
99.                 <MaxMessageQueueSize>10</MaxMessageQueueSize>
100.                 <MaxNotificationQueueSize>100</MaxNotificationQueueSize>
101.                 <MaxNotificationsPerPublish>1000</MaxNotificationsPerPublish>
102.                 <MinMetadataSamplingInterval>1000</MinMetadataSamplingInterval>
103.                 <AvailableSamplingRates>
104.                         <SamplingRateGroup>
105.                                 <Start>5</Start>
106.                                 <Increment>5</Increment>
107.                                 <Count>20</Count>
108.                         </SamplingRateGroup>
109.                         <SamplingRateGroup>
110.                                 <Start>100</Start>
111.                                 <Increment>100</Increment>
112.                                 <Count>4</Count>
113.                         </SamplingRateGroup>
114.                         <SamplingRateGroup>
115.                                 <Start>500</Start>
116.                                 <Increment>250</Increment>
117.                                 <Count>2</Count>
118.                         </SamplingRateGroup>
119.                         <SamplingRateGroup>
120.                                 <Start>1000</Start>
121.                                 <Increment>500</Increment>
122.                                 <Count>20</Count>
123.                         </SamplingRateGroup>
124.                 </AvailableSamplingRates>
125.                 <MaxRegistrationInterval>30000</MaxRegistrationInterval>
126.                 <NodeManagerSaveFile>OpcUaServer.nodes.xml</NodeManagerSaveFile>
127.         </ServerConfiguration>
129.         <TraceConfiguration>
130.                 <OutputFilePath>Logs\SampleOpcUaServer.log</OutputFilePath>
131.                 <DeleteOnLoad>true</DeleteOnLoad>
132.                
133.                
134.                
135.                
136.                
137.                 <TraceMasks>515</TraceMasks>
138.                
139.                
140.                
141.                
142.                
143.                
144.         </TraceConfiguration>
146. </ApplicationConfiguration>

复制代码

需要关注的内容有：

• ApplicationName：在通过OPC UA工具连接此服务器时，显示的服务器名称就是该值。
  
• ApplicationType：应用类型，可用的值有：
  
  
  
  • Server_0：服务器
    
  • Client_1：客户端
    
  • ClientAndServer_2：客户机和服务器
    
  • DisconveryServer_3：发现服务器。发现服务器用于注册OPC UA服务器，然后提供OPC UA客户端搜索到服务器。
    
  
  
• SecurityConfiguration：该节点中指定了OPC UA的证书存储路径，一般保持默认，不需修改。
  
• ServerConfiguration.BaseAddresses：该节点指定OPC UA服务器的url地址。
  
• ServerConfiguration.SecurityPolicies：该节点配置允许的服务器安全策略，配置通讯是否要签名和加密。
  
• ServerConfiguration.UserTokenPolicies：该节点配置允许的用户Token策略，例如是否允许匿名访问。
  
• AvailableSamplingRates：配置支持的变量采样率。
  
• TraceConfiguration：配置OPC UA服务器的日志记录，设定日志记录路径，配置的路径是在系统临时文件夹下的路径，日志文件的完整路径是在%TEMP%\Logs\SampleOpcUaServer.log。
  

NodeManagerFactory

新建NodeManagerFactory类，OPC UA server将调用该类的Create方法创建INodeManager实现类，而INodeManager实现类用于管理OPC UA地址空间。内容如下：

1. using Opc.Ua;
2. using Opc.Ua.Server;
4. namespace SampleOpcUaServer
5. {
6.     internal class NodeManagerFactory : INodeManagerFactory
7.     {
8.         public NodeManager? NodeManager { get; private set; }
9.         public StringCollection NamespacesUris => new StringCollection() { "http://opcfoundation.org/OpcUaServer" };
11.         public INodeManager Create(IServerInternal server, ApplicationConfiguration configuration)
12.         {
13.             if (NodeManager != null)
14.                 return NodeManager;
16.             NodeManager = new NodeManager(server, configuration, NamespacesUris.ToArray());
17.             return NodeManager;
18.         }
19.     }
20. }

复制代码

• 实现INodeManagerFactory接口，需实现NamespacesUris属性和Create方法。
  
• NodeManager类是自定义的类，定义见后文。
  
• 为了获取Create方法返回的NodeManager类，定义了NodeManager属性。
  

NodeManager

新建NodeManager类：

1. using Opc.Ua;
2. using Opc.Ua.Server;
4. namespace SampleOpcUaServer
5. {
6.     internal class NodeManager : CustomNodeManager2
7.     {
8.         public NodeManager(IServerInternal server, params string[] namespaceUris)
9.             : base(server, namespaceUris)
10.         {
11.         }
13.         public NodeManager(IServerInternal server, ApplicationConfiguration configuration, params string[] namespaceUris)
14.             : base(server, configuration, namespaceUris)
15.         {
16.         }
18.         protected override NodeStateCollection LoadPredefinedNodes(ISystemContext context)
19.         {
20.             FolderState root = CreateFolder(null, "Root");
21.             root.AddReference(ReferenceTypes.Organizes, true, ObjectIds.ObjectsFolder); // 将节点添加到服务器根节点
22.             root.EventNotifier = EventNotifiers.SubscribeToEvents;
23.             AddRootNotifier(root);
25.             CreateVariable(root, "Test", BuiltInType.Int64, ValueRanks.Scalar);
27.             return new NodeStateCollection(new List<NodeState> { root });
28.         }
30.         protected virtual FolderState CreateFolder(NodeState? parent, string name)
31.         {
32.             string path = parent?.NodeId.Identifier is string id ? id + "_" + name : name;
34.             FolderState folder = new FolderState(parent);
35.             folder.SymbolicName = name;
36.             folder.ReferenceTypeId = ReferenceTypes.Organizes;
37.             folder.TypeDefinitionId = ObjectTypeIds.FolderType;
38.             folder.NodeId = new NodeId(path, NamespaceIndex);
39.             folder.BrowseName = new QualifiedName(path, NamespaceIndex);
40.             folder.DisplayName = new LocalizedText("en", name);
41.             folder.WriteMask = AttributeWriteMask.None;
42.             folder.UserWriteMask = AttributeWriteMask.None;
43.             folder.EventNotifier = EventNotifiers.None;
45.             if (parent != null)
46.             {
47.                 parent.AddChild(folder);
48.             }
50.             return folder;
51.         }
53.         protected virtual BaseDataVariableState CreateVariable(NodeState? parent, string name, BuiltInType dataType, int valueRank)
54.         {
55.             return CreateVariable(parent, name, (uint)dataType, valueRank);
56.         }
58.         protected virtual BaseDataVariableState CreateVariable(NodeState? parent, string name, NodeId dataType, int valueRank)
59.         {
60.             string path = parent?.NodeId.Identifier is string id ? id + "_" + name : name;
62.             BaseDataVariableState variable = new BaseDataVariableState(parent);
63.             variable.SymbolicName = name;
64.             variable.ReferenceTypeId = ReferenceTypes.Organizes;
65.             variable.TypeDefinitionId = VariableTypeIds.BaseDataVariableType;
66.             variable.NodeId = new NodeId(path, NamespaceIndex);
67.             variable.BrowseName = new QualifiedName(path, NamespaceIndex);
68.             variable.DisplayName = new LocalizedText("en", name);
69.             variable.WriteMask = AttributeWriteMask.None;
70.             variable.UserWriteMask = AttributeWriteMask.None;
71.             variable.DataType = dataType;
72.             variable.ValueRank = valueRank;
73.             variable.AccessLevel = AccessLevels.CurrentReadOrWrite;
74.             variable.UserAccessLevel = AccessLevels.CurrentReadOrWrite;
75.             variable.Historizing = false;
76.             variable.Value = Opc.Ua.TypeInfo.GetDefaultValue(dataType, valueRank, Server.TypeTree);
77.             variable.StatusCode = StatusCodes.Good;
78.             variable.Timestamp = DateTime.UtcNow;
80.             if (valueRank == ValueRanks.OneDimension)
81.             {
82.                 variable.ArrayDimensions = new ReadOnlyList<uint>(new List<uint> { 0 });
83.             }
84.             else if (valueRank == ValueRanks.TwoDimensions)
85.             {
86.                 variable.ArrayDimensions = new ReadOnlyList<uint>(new List<uint> { 0, 0 });
87.             }
89.             if (parent != null)
90.             {
91.                 parent.AddChild(variable);
92.             }
94.             return variable;
95.         }
97.         public void UpdateValue(NodeId nodeId, object value)
98.         {
99.             var variable = (BaseDataVariableState)FindPredefinedNode(nodeId, typeof(BaseDataVariableState));
100.             if (variable != null)
101.             {
102.                 variable.Value = value;
103.                 variable.Timestamp = DateTime.UtcNow;
104.                 variable.ClearChangeMasks(SystemContext, false);
105.             }
106.         }
108.                 public void AddFolder(NodeId parentId, string name)
109.                 {
110.                     var node = Find(parentId);
111.                     if (node != null)
112.                     {
113.                         CreateFolder(node, name);
114.                         AddPredefinedNode(SystemContext, node);
115.                     }
116.                 }
118.                 public void AddVariable(NodeId parentId, string name, BuiltInType dataType, int valueRank)
119.                 {
120.                     AddVariable(parentId, name, (uint)dataType, valueRank);
121.                 }
123.                 public void AddVariable(NodeId parentId, string name, NodeId dataType, int valueRank)
124.                 {
125.                     var node = Find(parentId);
126.                     if (node != null)
127.                     {
128.                         CreateVariable(node, name, dataType, valueRank);
129.                         AddPredefinedNode(SystemContext, node);
130.                     }
131.                 }
132.     }
133. }

复制代码

上述代码中：

• 需继承CustomNodeManager2，这是OPC UA标准库中提供的类。
  
• 重写LoadPredefinedNodes方法，在该方法中配置预定义节点。其中创建了一个Root文件夹，Root文件夹中添加了Test变量。
  
• root.AddReference(ReferenceTypes.Organizes, true, ObjectIds.ObjectsFolder)该语句将节点添加到OPC UA服务器根节点，如果不使用该语句，可在Server节点下看到添加的节点。
  
• CreateFolder是定义的方法，用于简化创建文件夹节点。
  
• CreateVariable是自定义的方法，用于简化创建变量节点。
  
• UpdateValue是用于更新变量节点值的方法。其中修改值后，需调用ClearChangeMasks方法，才能通知客户端更新值。
  
• AddFolder用于启动服务器后添加新的文件夹。
  
• AddVariable用于启动服务器后添加新的变量。
  

测试服务器

比较好用的测试工具有：

• UaExpert：Unified Automation公司提供的测试工具，需安装，能用于连接OPC UA。
  
• OpcExpert：opcti公司提供的免费测试工具，绿色版，能连接OPC和OPC UA。
  

以下用OpcExpert测试。
浏览本地计算机可发现OPC UA服务器，可看到添加的Root节点和Test变量，Test变量的值会每秒更新。

源码地址：https://github.com/Yada-Yang/SampleOpcUaServer

来源:https://www.cnblogs.com/yada/p/18257593
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！