12345fish/h-opc

OPC made simpler

h-opc

An Opc Library and a command line to perform OPC operations with ease and transparency among different protocols. Currently supports synchronous operation over UA and DA protocols.

Table of Contents

• Use
• Documentation
  • Exploring the nodes
  • Read a node
  • Writing to a node
  • Monitoring a tag
  • Go Asynchronous!
• Command line
• Build + Contribute
  • Unit Testing
    • UA
    • DA
• Disclaimer
• Roadmap

Use

A nuget package is available for the library. To install Hylasoft.Opc, run the following command in the Package Manager Console:

PM> Install-Package H.Opc

NOTE: Package was moved on NuGet.org from Hylasoft.Opc to H.Opc because of account issues

To install the command line interface, head to the release section.

Documentation

to use the UA Client simply...

using (var client = new UaClient(new Uri("opc.tcp://host-url")))
{
  // Use `client` here
}

and to use the DA Client instead:

using (var client = new DaClient(new Uri("opcda://host-url")))
{
  // Use `client` here
}

Exploring the nodes

You can get a reference to a node with...

var node = client.FindNode("path.to.my.node");

This will get you a reference to the node node in the folder path.to.my.

You can use the node reference to explore the hieriarchy of nodes with the properties Parent and SubNodes. For example...

Node parentNode = node.Parent;
IEnumerable<Node> children = client.ExploreFolder(node.Tag);
IENumerable<Node> grandChildren = children.SelectMany(m => client.ExploreFolder(m.Tag));

Read a node

Reading a variable? As simple as...

var myString = client.Read<string>("path.to.string");
var myInt = client.Read<int>("path.to.num");

The example above will read a string from the tags string and num in the folder path.to

Writing to a node

To write a value just...

client.Write("path.to.string", "My new value");
client.Write("path.to.num", 42);

Monitoring a tag

Dead-simple monitoring:

client.Monitor<string>("path.to.string", (newValue, unsubscribe) =>
{
  DoSomethingWithYourValue(newValue);
  if(ThatsEnough == true)
    unsubscribe();
});

The second parameter is an Action<T, Action> that has two parameter:

• newValue is the new value of the tag
• unsubscribe is a function that unsubscribes the current monitored item. It's very handy when you want to terminate your callback

it's important that you either enclose the client into a using statement or call Dispose() when you are finished, to unsubscribe all the monitored items and terminate the connection!

Go Asynchronous!

Each method as an asynchornous counterpart that can be used with the async/await syntax. The asynchronous syntax is recommended over the synchronous one (maybe the synchronous one will be deprecated one day).

Command line

You can also use the command line interface project to quickly test your an OPC. Build the h-opc-cli project or download it from the release page of this repository, then run:

h-opc-cli.exe [OpcType] [server-url]

Where OpcType is the type of opc to use (e.g: "UA", "DA"). Once the project is running, you can use the internal command to manipulate the variable. To have more information aboute the internal commands, type help or ?

Build + Contribute

The repository uses cs-boilerplate. Read the readme of the cs-boilerplate repository to understand how to build, run tasks and commit your work to master.

Unit Testing

• The unit tests rely on locally running test OPC servers. The ones used in this project are OPC Foundation's Sample Server and Graybox Simulator
  • OPC Foundation's Sample Server requires you register with the website before you can download.

UA

• Open OPC Foundation's Sample Client (under Start -> OPC Foundation -> UA x.xx -> Sample Applications -> Opc.Ua.SampleClient.exe)
  • This will start the server too
  • Running tests will only work with this program open

DA

• With Graybox Simulator installed, tests should automatically work

Disclaimer

The following binaries belong to the OPC Foundation. You must become a registered user in order to use them:

• OPC.Ua.Client.dll
• OPC.Ua.Core.dll
• OPC.Ua.Configuration.dll
• OpcComRcw.dll
• OpcNetApi.Com.dll
• OpcNetApi.dll

You must agree to the terms and condition exposed on the OPC Foundation website. Hyla Soft is not responsible of their usage and cannot be held responsible.

Roadmap

• Add promise-based asynchronous calls