C# OPC UA 客户端开发
OPC UA（OPC Unified Architecture）是为了在工业自动化等行业安全可靠地进行数据交换而制定的开放式国际标准规格。由OPC Foundation于2008年发布，之后制定了国际标准IEC62541.跨越设备的种类、操作系统（OS）、制造商的壁垒，可以安全地进行高可靠性的数据交换，作为标准通信协议得到了工业 4.0的推荐。https://opcfoundation.org/
OPC UA开发首先需要一个服务器端：这里使用KEPServer来模拟。首先下载并安装KepServer，基本一路下一步。配置OPC UA:
在桌面右下角右键点击“OPC UA配置”
选择网卡和端口号，修改成自己想要的地址。
服务端测试：下载softing OPC Client 工具并安装。如下图所示连接KepServer
数据节点读写测试：
有了以上准备后，利用C# 开发自己的OPC UA helper：
我使用的VS2019，新建.net framework类库项目：修改.net framework版本4.6.2以上，nuget 包管理器里搜索opc.ua.client.选择opc 基金会的开发组件：如下图所示：
新建类OPCUAClient.cs
using Opc.Ua;
using Opc.Ua.Client;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
namespace hg.opc.client
{
public class OPCUAClient
{
#region Private Fields
private ApplicationConfiguration appConfig;
private Session clientSession;
private bool isConnected = false; //是否已经连接过
private int reconnectPeriod = 10; // 重连状态
private SessionReconnectHandler sessionReconnectHandler;
private EventHandler onConnectedEventHandler;
private Dictionary subscriptionNodes=new Dictionary(); // 系统所有的节点信息
#endregion Private Fields
#region Public Members
public IUserIdentity UserIdentity { get; set; }= new UserIdentity(new AnonymousIdentityToken());
public bool IsConnected { get => isConnected; private set => isConnected = value; }
public Dictionary SubscriptionNodes { get => subscriptionNodes; set => subscriptionNodes = value; }
public event EventHandler OnConnectedEvent
{
add { onConnectedEventHandler += value; }
remove { onConnectedEventHandler -= value; }
}
#endregion
#region 构造函数
public OPCUAClient()
{
var certificateValidator = new CertificateValidator();
certificateValidator.CertificateValidation += (sender, eventArgs) =>
{
if (ServiceResult.IsGood(eventArgs.Error))
eventArgs.Accept = true;
else if (eventArgs.Error.StatusCode.Code == StatusCodes.BadCertificateUntrusted)
eventArgs.Accept = true;
else
throw new Exception(string.Format("证书验证错误： {0}: {1}", eventArgs.Error.Code, eventArgs.Error.AdditionalInfo));
};
certificateValidator.Update(new SecurityConfiguration
{
AutoAcceptUntrustedCertificates = true,
RejectSHA1SignedCertificates = false,
MinimumCertificateKeySize = 1024,
});
var configuration = new ApplicationConfiguration
{
ApplicationName = "MyOpc_Client",
ApplicationType = ApplicationType.Client,
CertificateValidator = certificateValidator,
ApplicationUri = string.Empty,
ServerConfiguration = new ServerConfiguration
{
MaxSubscriptionCount = 100000,
MaxMessageQueueSize = 100000,
MaxNotificationQueueSize = 100000,
MaxPublishRequestCount = 100000,
},
SecurityConfiguration = new SecurityConfiguration
{
AutoAcceptUntrustedCertificates = true,
RejectSHA1SignedCertificates = false,
MinimumCertificateKeySize = 1024,
SuppressNonceValidationErrors = true,
ApplicationCertificate = new CertificateIdentifier
{
StoreType = CertificateStoreType.X509Store,
StorePath = "CurrentUser\\My",
},
TrustedIssuerCertificates = new CertificateTrustList
{
StoreType = CertificateStoreType.X509Store,
StorePath = "CurrentUser\\Root",
},
TrustedPeerCertificates = new CertificateTrustList
{
StoreType = CertificateStoreType.X509Store,
StorePath = "CurrentUser\\Root",
}
},
TransportQuotas = new TransportQuotas
{
OperationTimeout = 6000000,
MaxStringLength = int.MaxValue,
MaxByteStringLength = int.MaxValue,
MaxArrayLength = 65535,
MaxMessageSize = 419430400,
MaxBufferSize = 65535,
ChannelLifetime = -1,
SecurityTokenLifetime = -1
},
ClientConfiguration = new ClientConfiguration
{
DefaultSessionTimeout = -1,
MinSubscriptionLifetime = -1,
},
DisableHiResClock = true
};
configuration.Validate(ApplicationType.Client);
appConfig = configuration;
}
#endregion
#region 连接
public async Task ConnectServer(string serverUrl)
{
Disconnect();
var endpointDescription = CoreClientUtils.SelectEndpoint(serverUrl, false);
var endpointConfiguration = EndpointConfiguration.Create(appConfig);
var endpoint = new ConfiguredEndpoint(null, endpointDescription, endpointConfiguration);
clientSession = await Task.Run(async ()=> {
return await Session.Create(
appConfig,
endpoint,
false,
false,
appConfig.ApplicationName,
60000,
UserIdentity,
new string[] { });
});
clientSession.KeepAlive += Session_KeepAlive;
IsConnected = true;
onConnectedEventHandler?.Invoke(this, EventArgs.Empty);
}
private void Session_KeepAlive(Session session, KeepAliveEventArgs e)
{
try
{
if (!object.ReferenceEquals(session, this.clientSession))
{
return;
}
if (ServiceResult.IsBad(e.Status))
{
if (reconnectPeriod <= 0)
{
return;
}
if (sessionReconnectHandler == null)
{
sessionReconnectHandler = new SessionReconnectHandler();
sessionReconnectHandler.BeginReconnect(session, reconnectPeriod * 1000, Server_ReconnectComplete);
}
return;
}
}
catch (Exception exception)
{
throw exception;
}
}
private void Server_ReconnectComplete(object sender, EventArgs e)
{
try
{
if (!ReferenceEquals(sender, sessionReconnectHandler))
{
return;
}
clientSession = sessionReconnectHandler.Session;
sessionReconnectHandler.Dispose();
sessionReconnectHandler = null;
}
catch (Exception exception)
{
throw exception;
}
}
public void Disconnect()
{
if (sessionReconnectHandler != null)
{
sessionReconnectHandler.Dispose();
sessionReconnectHandler = null;
}
if (clientSession != null)
{
clientSession.Close(10000);
clientSession = null;
}
IsConnected = false;
}
#endregion
#region 浏览节点
public ReferenceDescriptionCollection BrowserNode2(NodeId nodeId)
{
var browser = new Browser(clientSession);
return browser.Browse(nodeId);
}
public ReferenceDescriptionCollection BrowserNode(NodeId nodeId)
{
var browseDescriptions = new BrowseDescriptionCollection();
var browserDesc = new BrowseDescription();
browserDesc.NodeId = nodeId;
browserDesc.BrowseDirection = BrowseDirection.Forward;
browserDesc.ReferenceTypeId = ReferenceTypeIds.Aggregates;
browserDesc.IncludeSubtypes = true;
browserDesc.NodeClassMask = (uint)(NodeClass.Object | NodeClass.Variable | NodeClass.Method | NodeClass.ReferenceType | NodeClass.ObjectType | NodeClass.View | NodeClass.VariableType | NodeClass.DataType);
browserDesc.ResultMask = (uint)BrowseResultMask.All;
var browseDesc2 = new BrowseDescription();
browseDesc2.NodeId = nodeId;
browseDesc2.BrowseDirection = BrowseDirection.Forward;
browseDesc2.ReferenceTypeId = ReferenceTypeIds.Organizes;
browseDesc2.IncludeSubtypes = true;
browseDesc2.NodeClassMask = (uint)(NodeClass.Object | NodeClass.Variable | NodeClass.Method | NodeClass.View | NodeClass.ReferenceType | NodeClass.ObjectType | NodeClass.VariableType | NodeClass.DataType);
browseDesc2.ResultMask = (uint)BrowseResultMask.All;
browseDescriptions.Add(browserDesc);
browseDescriptions.Add(browseDesc2);
ReferenceDescriptionCollection references = GetReferenceDescriptionCollection(browseDescriptions);
return references;
}
public ReferenceDescriptionCollection GetReferenceDescriptionCollection(BrowseDescriptionCollection browseDescriptions)
{
try
{
var referenceDescriptions = new ReferenceDescriptionCollection();
var unprocessedOperations = new BrowseDescriptionCollection();
while (browseDescriptions.Count > 0)
{
BrowseResultCollection results = null;
DiagnosticInfoCollection diagnosticInfos = null;
clientSession.Browse(null, null, 0, browseDescriptions,out results,out diagnosticInfos);
ClientBase.ValidateResponse(results, browseDescriptions);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, browseDescriptions);
ByteStringCollection continuationPoints = new ByteStringCollection();
for (int i = 0; i < browseDescriptions.Count; i++)
{
if (StatusCode.IsBad(results[i].StatusCode))
{
if (results[i].StatusCode == StatusCodes.BadNoContinuationPoints)
{
unprocessedOperations.Add(browseDescriptions[i]);
}
continue;
}
// check if all references have been fetched.
if (results[i].References.Count == 0)
{
continue;
}
referenceDescriptions.AddRange(results[i].References);
if (results[i].ContinuationPoint != null)
{
continuationPoints.Add(results[i].ContinuationPoint);
}
}
ByteStringCollection revisedContiuationPoints = new ByteStringCollection();
while (continuationPoints.Count > 0)
{
// continue browse operation.
clientSession.BrowseNext(
null,
true,
continuationPoints,
out results,
out diagnosticInfos);
ClientBase.ValidateResponse(results, continuationPoints);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, continuationPoints);
for (int j = 0; j < continuationPoints.Count; j++)
{
if (StatusCode.IsBad(results[j].StatusCode))
{
continue;
}
if (results[j].References.Count == 0)
{
continue;
}
referenceDescriptions.AddRange(results[j].References);
if (results[j].ContinuationPoint != null)
{
revisedContiuationPoints.Add(results[j].ContinuationPoint);
}
}
revisedContiuationPoints = continuationPoints;
}
browseDescriptions = unprocessedOperations;
}
return referenceDescriptions;
}
catch (Exception exception)
{
return null;
}
}
#endregion
#region Node Write/Read Support
///
/// Read a value node from server
///
/// node id
/// DataValue
public DataValue ReadNode(NodeId nodeId)
{
ReadValueIdCollection nodesToRead = new ReadValueIdCollection
{
new ReadValueId( )
{
NodeId = nodeId,
AttributeId = Attributes.Value
}
};
// read the current value
clientSession.Read(
null,
0,
TimestampsToReturn.Neither,
nodesToRead,
out DataValueCollection results,
out DiagnosticInfoCollection diagnosticInfos);
ClientBase.ValidateResponse(results, nodesToRead);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, nodesToRead);
return results[0];
}
///
/// 是否可读写节点
///
///
///
/// Read a value node from server
///
/// type of value
/// node id
/// 实际值
public T ReadNode(string tag)
{
DataValue dataValue = ReadNode(new NodeId(tag));
return (T)dataValue.Value;
}
///
/// Read a tag asynchronously
///
/// The type of tag to read
/// tag值
/// The value retrieved from the OPC
public Task ReadNodeAsync(string tag)
{
ReadValueIdCollection nodesToRead = new ReadValueIdCollection
{
new ReadValueId()
{
NodeId = new NodeId(tag),
AttributeId = Attributes.Value
}
};
// Wrap the ReadAsync logic in a TaskCompletionSource, so we can use C# async/await syntax to call it:
var taskCompletionSource = new TaskCompletionSource();
clientSession.BeginRead(
requestHeader: null,
maxAge: 0,
timestampsToReturn: TimestampsToReturn.Neither,
nodesToRead: nodesToRead,
callback: ar =>
{
DataValueCollection results;
DiagnosticInfoCollection diag;
var response = clientSession.EndRead(
result: ar,
results: out results,
diagnosticInfos: out diag);
try
{
if (!StatusCode.IsGood(response.ServiceResult))
throw new Exception(string.Format("Invalid response from the server. (Response Status: {0})", response.ServiceResult));
if (!StatusCode.IsGood(results[0].StatusCode))
throw new Exception(string.Format("Invalid response from the server. (Response Status: {0})", results[0].StatusCode));
var val = results[0];
taskCompletionSource.TrySetResult((T)val.Value);
}
catch (Exception ex)
{
taskCompletionSource.TrySetException(ex);
}
},
asyncState: null);
return taskCompletionSource.Task;
}
///
/// read several value nodes from server
///
/// all NodeIds
/// all values
public List ReadNodes(NodeId[] nodeIds)
{
ReadValueIdCollection nodesToRead = new ReadValueIdCollection();
for (int i = 0; i < nodeIds.Length; i++)
{
nodesToRead.Add(new ReadValueId()
{
NodeId = nodeIds[i],
AttributeId = Attributes.Value
});
}
// 读取当前的值
clientSession.Read(
null,
0,
TimestampsToReturn.Neither,
nodesToRead,
out DataValueCollection results,
out DiagnosticInfoCollection diagnosticInfos);
ClientBase.ValidateResponse(results, nodesToRead);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, nodesToRead);
return results.ToList();
}
///
/// read several value nodes from server
///
/// all NodeIds
/// all values
public Task> ReadNodesAsync(NodeId[] nodeIds)
{
ReadValueIdCollection nodesToRead = new ReadValueIdCollection();
for (int i = 0; i < nodeIds.Length; i++)
{
nodesToRead.Add(new ReadValueId()
{
NodeId = nodeIds[i],
AttributeId = Attributes.Value
});
}
var taskCompletionSource = new TaskCompletionSource>();
// 读取当前的值
clientSession.BeginRead(
null,
0,
TimestampsToReturn.Neither,
nodesToRead,
callback: ar =>
{
DataValueCollection results;
DiagnosticInfoCollection diag;
var response = clientSession.EndRead(
result: ar,
results: out results,
diagnosticInfos: out diag);
try
{
CheckReturnValue(response.ServiceResult);
taskCompletionSource.TrySetResult(results.ToList());
}
catch (Exception ex)
{
taskCompletionSource.TrySetException(ex);
}
},
asyncState: null);
return taskCompletionSource.Task;
}
///
/// read several value nodes from server
///
/// 所以的节点数组信息
/// all values
public List ReadNodes(string[] tags)
{
List result = new List();
ReadValueIdCollection nodesToRead = new ReadValueIdCollection();
for (int i = 0; i < tags.Length; i++)
{
nodesToRead.Add(new ReadValueId()
{
NodeId = new NodeId(tags[i]),
AttributeId = Attributes.Value
});
}
// 读取当前的值
clientSession.Read(
null,
0,
TimestampsToReturn.Neither,
nodesToRead,
out DataValueCollection results,
out DiagnosticInfoCollection diagnosticInfos);
ClientBase.ValidateResponse(results, nodesToRead);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, nodesToRead);
foreach (var item in results)
{
result.Add((T)item.Value);
}
return result;
}
///
/// read several value nodes from server
///
/// all NodeIds
/// all values
public Task> ReadNodesAsync(string[] tags)
{
ReadValueIdCollection nodesToRead = new ReadValueIdCollection();
for (int i = 0; i < tags.Length; i++)
{
nodesToRead.Add(new ReadValueId()
{
NodeId = new NodeId(tags[i]),
AttributeId = Attributes.Value
});
}
var taskCompletionSource = new TaskCompletionSource>();
// 读取当前的值
clientSession.BeginRead(
null,
0,
TimestampsToReturn.Neither,
nodesToRead,
callback: ar =>
{
DataValueCollection results;
DiagnosticInfoCollection diag;
var response = clientSession.EndRead(
result: ar,
results: out results,
diagnosticInfos: out diag);
try
{
CheckReturnValue(response.ServiceResult);
List result = new List();
foreach (var item in results)
{
result.Add((T)item.Value);
}
taskCompletionSource.TrySetResult(result);
}
catch (Exception ex)
{
taskCompletionSource.TrySetException(ex);
}
},
asyncState: null);
return taskCompletionSource.Task;
}
///
/// 0:NodeClass 1:Value 2:AccessLevel 3:DisplayName 4:Description
///
///
/// nodeIds)
{
ReadValueIdCollection nodesToRead = new ReadValueIdCollection();
foreach (var nodeId in nodeIds)
{
NodeId sourceId = nodeId;
nodesToRead.Add(new ReadValueId()
{
NodeId = sourceId,
AttributeId = Attributes.NodeClass
});
nodesToRead.Add(new ReadValueId()
{
NodeId = sourceId,
AttributeId = Attributes.Value
});
nodesToRead.Add(new ReadValueId()
{
NodeId = sourceId,
AttributeId = Attributes.AccessLevel
});
nodesToRead.Add(new ReadValueId()
{
NodeId = sourceId,
AttributeId = Attributes.DisplayName
});
nodesToRead.Add(new ReadValueId()
{
NodeId = sourceId,
AttributeId = Attributes.Description
});
}
// read all values.
clientSession.Read(
null,
0,
TimestampsToReturn.Neither,
nodesToRead,
out DataValueCollection results,
out DiagnosticInfoCollection diagnosticInfos);
ClientBase.ValidateResponse(results, nodesToRead);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, nodesToRead);
return results.ToArray();
}
///
/// write a note to server(you should use try catch)
///
/// The type of tag to write on
/// 节点名称
/// 值
/// if success True,otherwise False
public bool WriteNode(string tag, T value)
{
WriteValue valueToWrite = new WriteValue()
{
NodeId = new NodeId(tag),
AttributeId = Attributes.Value
};
valueToWrite.Value.Value = value;
valueToWrite.Value.StatusCode = StatusCodes.Good;
valueToWrite.Value.ServerTimestamp = DateTime.MinValue;
valueToWrite.Value.SourceTimestamp = DateTime.MinValue;
WriteValueCollection valuesToWrite = new WriteValueCollection
{
valueToWrite
};
// 写入当前的值
clientSession.Write(
null,
valuesToWrite,
out StatusCodeCollection results,
out DiagnosticInfoCollection diagnosticInfos);
ClientBase.ValidateResponse(results, valuesToWrite);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, valuesToWrite);
if (StatusCode.IsBad(results[0]))
{
throw new ServiceResultException(results[0]);
}
return !StatusCode.IsBad(results[0]);
}
///
/// Write a value on the specified opc tag asynchronously
///
/// The type of tag to write on
/// The fully-qualified identifier of the tag. You can specify a subfolder by using a comma delimited name. E.g: the tag `foo.bar` writes on the tag `bar` on the folder `foo`
/// The value for the item to write
public Task WriteNodeAsync(string tag, T value)
{
WriteValue valueToWrite = new WriteValue()
{
NodeId = new NodeId(tag),
AttributeId = Attributes.Value,
};
valueToWrite.Value.Value = value;
valueToWrite.Value.StatusCode = StatusCodes.Good;
valueToWrite.Value.ServerTimestamp = DateTime.MinValue;
valueToWrite.Value.SourceTimestamp = DateTime.MinValue;
WriteValueCollection valuesToWrite = new WriteValueCollection
{
valueToWrite
};
// Wrap the WriteAsync logic in a TaskCompletionSource, so we can use C# async/await syntax to call it:
var taskCompletionSource = new TaskCompletionSource();
clientSession.BeginWrite(
requestHeader: null,
nodesToWrite: valuesToWrite,
callback: ar =>
{
var response = clientSession.EndWrite(
result: ar,
results: out StatusCodeCollection results,
diagnosticInfos: out DiagnosticInfoCollection diag);
try
{
ClientBase.ValidateResponse(results, valuesToWrite);
ClientBase.ValidateDiagnosticInfos(diag, valuesToWrite);
taskCompletionSource.SetResult(StatusCode.IsGood(results[0]));
}
catch (Exception ex)
{
taskCompletionSource.TrySetException(ex);
}
},
asyncState: null);
return taskCompletionSource.Task;
}
///
/// 所有的节点都写入成功，返回True ，否则返回False
///
/// 节点名称数组
/// 节点的值数据
/// 所有的是否都写入成功
public bool WriteNodes(string[] tags, object[] values)
{
WriteValueCollection valuesToWrite = new WriteValueCollection();
for (int i = 0; i < tags.Length; i++)
{
if (i < values.Length)
{
WriteValue valueToWrite = new WriteValue()
{
NodeId = new NodeId(tags[i]),
AttributeId = Attributes.Value
};
valueToWrite.Value.Value = values[i];
valueToWrite.Value.StatusCode = StatusCodes.Good;
valueToWrite.Value.ServerTimestamp = DateTime.MinValue;
valueToWrite.Value.SourceTimestamp = DateTime.MinValue;
valuesToWrite.Add(valueToWrite);
}
}
// 写入当前的值
clientSession.Write(
null,
valuesToWrite,
out StatusCodeCollection results,
out DiagnosticInfoCollection diagnosticInfos);
ClientBase.ValidateResponse(results, valuesToWrite);
ClientBase.ValidateDiagnosticInfos(diagnosticInfos, valuesToWrite);
bool result = true;
foreach (var r in results)
{
if (StatusCode.IsBad(r))
{
result = false;
break;
}
}
return result;
}
private void CheckReturnValue(StatusCode status)
{
if (!StatusCode.IsGood(status))
throw new Exception(string.Format("Invalid response from the server. (Response Status: {0})", status));
}
#endregion Node Write/Read Support
#region 订阅
///
/// 新增一批订阅，需要指定订阅的关键字，订阅的tag名数组，以及回调方法
///
/// 关键字
/// 节点名称数组
/// 回调方法
public void AddSubscription(string key, string[] tags, Action callback)
{
Subscription m_subscription = new Subscription(clientSession.DefaultSubscription);
m_subscription.PublishingEnabled = true;
m_subscription.PublishingInterval = 0;
m_subscription.KeepAliveCount = uint.MaxValue;
m_subscription.LifetimeCount = uint.MaxValue;
m_subscription.MaxNotificationsPerPublish = uint.MaxValue;
m_subscription.Priority = 100;
m_subscription.DisplayName = key;
for (int i = 0; i < tags.Length; i++)
{
var item = new MonitoredItem
{
StartNodeId = new NodeId(tags[i]),
AttributeId = Attributes.Value,
DisplayName = tags[i],
SamplingInterval = 100,
};
item.Notification += (MonitoredItem monitoredItem, MonitoredItemNotificationEventArgs args) =>
{
callback?.Invoke(key, monitoredItem, args);
};
m_subscription.AddItem(item);
}
clientSession.AddSubscription(m_subscription);
m_subscription.Create();
lock (SubscriptionNodes)
{
if (SubscriptionNodes.ContainsKey(key))
{
// remove
SubscriptionNodes[key].Delete(true);
clientSession.RemoveSubscription(SubscriptionNodes[key]);
SubscriptionNodes[key].Dispose();
SubscriptionNodes[key] = m_subscription;
}
else
{
SubscriptionNodes.Add(key, m_subscription);
}
}
}
///
/// 新增订阅，需要指定订阅的关键字，订阅的tag名数组，以及回调方法
///
/// 关键字
/// 节点名称数组
/// 回调方法
public void AddSubscription(string key, string tag, Action callback)
{
AddSubscription(key, new string[] { tag }, callback);
}
///
/// 移除订阅消息，如果该订阅消息是批量的，也直接移除
///
/// 订阅关键值
public void RemoveSubscription(string key)
{
lock (SubscriptionNodes)
{
if (SubscriptionNodes.ContainsKey(key))
{
// remove
SubscriptionNodes[key].Delete(true);
clientSession.RemoveSubscription(SubscriptionNodes[key]);
SubscriptionNodes[key].Dispose();
SubscriptionNodes.Remove(key);
}
}
}
///
/// 移除所有的订阅消息
///
public void RemoveAllSubscription()
{
lock (SubscriptionNodes)
{
foreach (var item in SubscriptionNodes)
{
item.Value.Delete(true);
clientSession.RemoveSubscription(item.Value);
item.Value.Dispose();
}
SubscriptionNodes.Clear();
}
}
#endregion
}
}
利用上面的OPCUAClient开发的winform程序：
源码下载：https://download.csdn.net/download/elie_yang/20814696