Skip to content

OPC UA server with nodes that generate random and increasing data, and anomalies

License

Notifications You must be signed in to change notification settings

harrison-tin/iot-edge-opc-plc

 
 

Repository files navigation

page_type description languages products urlFragment
sample
Industrial IoT - Sample OPC UA server that generates random data and anomalies.
csharp
azure
azure-iot-hub
azure-iot-sample-opc-ua-server

OPC PLC server

Implements an OPC-UA server with different nodes generating random data, anomalies and configuration of user defined nodes.

Deploy to Azure

  • After deployment, the OPC PLC server will be available at opc.tcp://<NAME>.<REGION>.azurecontainer.io:50000
  • See region limits

Features

The following nodes are part of the PLC simulation:

  • Alternating boolean
  • Random signed 32-bit integer
  • Random unsigend 32-bit integer
  • Sine wave with a spike anomaly
  • Sine wave with a dip anomaly
  • Value showing a positive trend
  • Value showing a negative trend
  • Value having periodical good, bad and uncertain statuses (slow changing - 10 s by default)
  • Value having periodical good, bad and uncertain statuses (fast changing - 1 s by default)

By default everything is enabled, use command line options to disable certain anomaly or data generation features. Additionally to those nodes with simulated data, a JSON configuration file allows nodes to be created as specified. Finally, the simulation supports a number of nodes of specific types that can change at a configurable rate.

Getting Started

Prerequisites

The implementation is based on .NET Core so it is cross-platform. The recommended hosting environment is Docker.

Quickstart

A Docker container of the component is hosted in the Microsoft Container Registry (MCR) and can be pulled by:

docker pull mcr.microsoft.com/iotedge/opc-plc:<See version.json>

The tags of the container match the tags of this repository and the containers are available for Windows and Linux.

Sample start command for Docker:

docker run --rm -it -p 50000:50000 -p 8080:8080 --name opcplc mcr.microsoft.com/iotedge/opc-plc:latest --pn=50000 --autoaccept --sph --sn=5 --sr=10 --st=uint --fn=5 --fr=1 --ft=uint --ctb --scn --lid --lsn --ref --gn=5

Sample start command for Windows:

dotnet opcplc.dll --pn=50000 --at X509Store --autoaccept --sph --sn=5 --sr=10 --st=uint --fn=5 --fr=1 --ft=uint --ctb --scn --lid --lsn --ref --gn=5

Note: Make sure that your OPC UA client uses security policy Basic256Sha256 and message security mode Sign & Encrypt to connect.

User node configuration via JSON configuration file

If the module (application) is started with the argument --nodesfile then the specified JSON configuration file is loaded. Nodes defined in the JSON file will be published by the server. This enables another OPC-UA client application to set the state/value of the node. Please note that nodes specified in the JSON file are NOT part of the simulation. They remain visible in an unchanged state until an OPC UA client changes their status.

The following command shows how to use a configuration file on Windows:

dotnet opcplc.dll --at X509Store --nodesfile nodesfile.json

Here's a sample node configuration file:

{
  "Folder": "MyTelemetry",
  "NodeList": [
    {
      "NodeId": 1023,
      "Name": "ActualSpeed",
      "Description": "Rotational speed"
    },
    {
      "NodeId": "aRMS"
    },
    {
      "NodeId": "1025",
      "Name": "DKW",
      "DataType": "Float",
      "ValueRank": -1,
      "AccessLevel": "CurrentReadOrWrite",
      "Description": "Diagnostic characteristic value"
    }
  ]
}
  • Folder: Defines the name of the folder under which the user specified nodes should be created. This folder is created below the root of the OPC UA server.
  • NodeList: Defines the list of nodes, which will be published by the emulated server. Nodes specified in the list can be browsed and changed by OPC UA applications. This enables developers to easyly implement and test OPC UA client applications.
  • NodeId: Specifies the identifier of the node and is required. This value can be a decimal or string value. Every other JSON type is converted to a string identifier.
  • Name: The display name of the tag. If not set it will be set to the NodeId. (Optional)
  • DataType: The OPC UA valid type. It specifies one of types defined by BuiltInType. If an invalid type is specified or if it is ommitted it defaults to 'Int32'. (Optional)
  • ValueRank: As defined by type ValueRanks. If omitted it will be set to the value '-1' (Scalar). (Optional)
  • AccessLevel: Specifies one of access levels defined by type AccessLevels. If an invalid access level is specified or if it is omitted it defaults to 'CurrentReadOrWrite'. (Optional)
  • Description: Description of the node. If not set it will be set to the NodeId. (Optional)

Slow and fast changing nodes

A number of changing nodes can be simulated with the following options. The nodes are categorized into slow and fast only for convenience.

  • sn: Number of slow nodes (default 1)
  • sr: Rate in seconds at which to change the slow nodes (uint, default every 10 s)
  • st: Data type for slow nodes (UInt|Double|Bool|UIntArray, case insensitive)
  • stl: lower bound of data type of slow nodes (UInt|Double types only, defaults to minimium value of the type in C# with exception of Double where it defaults to 0.0)
  • stu: upper bound of data type of slow nodes (UInt|Double types only, defaults to maximum value of the type in C#)
  • str: randomization of slow nodes value (UInt|Double types only, defaults to false)
  • sts: step or increment size of slow nodes value (UInt|Double types only, defaults to 1)
  • fn: Number of fast nodes (default 1)
  • fr: Rate in seconds at which to change the fast nodes (uint, default every 1 s)
  • vfr: Rate in milliseconds at which to change the fast nodes (uint, default every 1000 ms)
  • ft: Data type for fast nodes (UInt|Double|Bool|UIntArray, case insensitive)
  • ftl: lower bound of data type of fast nodes (UInt|Double types only, defaults to minimium value of the type in C# with exception of Double where it defaults to 0.0)
  • ftu: upper bound of data type of fast nodes (UInt|Double types only, defaults to maximum value of the type in C#)
  • ftr: randomization of fast nodes value (UInt|Double types only, defaults to false)
  • fts: step or increment size of fast nodes value (UInt|Double types only, defaults to 1)

Data types

  • UInt: Increases by 1
  • Double: Increases by 0.1
  • Bool: Alternates
  • UIntArray: 32 values that increase by 1

OPC Publisher file (pn.json)

The options --sph and --sp show and dump an OPC Publisher configuration file (default name: pn.json) that matches the configuration. In addition, a web server hosts the file on a configurable port (--wp, default 8080): e.g. http://localhost:8080/pn.json Additionally, you can set the configuration file name via the option --spf.

Complex type (boiler)

The option --ctb adds a simple boiler to the address space.

Features:

  • BoilerStatus is a complex type that shows: temperature, pressure and heater state
  • Method to turn heater on/off
  • When the heater is on, the bottom temperature increases by 1 degree/s, the top temperature is always 5 degrees less than the bottom one
  • Pressure is calculated as 100000 + bottom temperature

Simple Events

The option --ses enables simple events from the quickstart sample from OPC Foundation.

Simple Events defines four new event types. SystemCycleStatusEventType is inherited from the SystemEventType and SystemCycleStartedEventType, SystemCycleAbortedEventType, SystemCycleFinishedEventType from SystemCycleStatusEventType.

Every 3000 ms a new SystemCycleStartedEventState is triggered. (The other event types are not used.) A message is generated with a counter "The system cycle '{counter}' has started." for each event.

A structure of type CycleStepDataType is added to SystemCycleStartedEventState event. The values in that structure is hard coded to Name: Step 1 and Duration: 1000.

Alarms and Condition

The option --alm enables Alarm and Condition quickstart sample from OPC Foundation.

It creates a hierarchical folder structure from Server, starting with Green and Yellow. The leaf nodes SouthMotor, WestTank, EastTank and NorthMotor are sources for the alarms.

The alarms are of different types:

All these alarms will update on a regular interval. It is also possible to Acknowledge, Confirm and and add Comment to them.

This simulation also emits two types of system events: SystemEventType and AuditEventType, every 1000 ms.

Deterministic Alarms testing

The option --dalm=<file> enables deterministic testing of Alarms and Conditions.

More information about this feature can be found here.

Other features

  • Node with special characters in name and NodeId: --scn
  • Node with long ID (3950 bytes): --lid
  • Nodes with large values (10/50 kB string, 100 kB StringArray, 200 kB ByteArray): --lsn
  • Nodes for testing all datatypes, arrays, methods, permissions, etc --ref. The ReferenceNodeManager of the OPC UA .NET reference stack is used for this purpose.
  • Limit the number of updates of Slow and Fast nodes. Update the values of the SlowNumberOfUpdates and FastNumberOfUpdates configuration nodes in the OpcPlc/SimulatorConfiguration folder to:
    • < 0 (default): Slow and Fast nodes are updated indefinitely
    • 0: Slow and Fast nodes are not updated
    • > 0: Slow and Fast nodes are updated the given number of times, then they stop being updated (the value of the configuration node is decremented at every update).
  • Nodes with deterministic random GUIDs as node IDs: --gn=<number_of_nodes>
  • Node with opaque identifier (free-format byte string): --on

OPC UA Methods

Name Description Prerequisite
ResetTrend Reset the trend values to their baseline value Generate positive or negative trends activated
ResetStepUp Resets the StepUp counter to 0 Generate data activated
StopStepUp Stops the StepUp counter Generate data activated
StartStepUp Starts the StepUp counter Generate data activated
StopUpdateSlowNodes Stops the increase of value of slow nodes slow nodes activated
StopUpdateFastNodes Stops the increase of value of fast nodes fast nodes activated
StartUpdateSlowNodes Start the increase of value of slow nodes slow nodes activated
StartUpdateFastNodes Start the increase of value of fast nodes fast nodes activated

Build

The build scripts are for Azure DevOps and the container build is done in ACR. To use your own ACR you need to:

  • Create a service connection called azureiiot to the subscription/resource group in which your ACR is located
  • Set a variable called BUILD_REGISTRY with the name of your Azure Container Registry

Using <reporoot>/tools/scripts/build.ps1 you can also build with Docker Desktop locally. The sample below builds a debug container and is started at the root of the repository:

.\tools\scripts\build.ps1 -Path . -Debug

If you want to build using Docker yourself, it is a bit more complicated, since the dockerfile is generated by the scripts. So first run the build.ps1 script as above, then locate the dockerfile for your configuration and target runtime under <reporoot>/src/bin/publish. Next, make your modifications and publish the opc-plc project in Visual Studio. Ensure that you have chosen "Self-Contained" as "Deployment Mode" and the correct "Target runtime" in the Visual Studio Publish configuration. Finally, run the docker build command in the folder you published to using the dockerfile of your configuration and target runtime.

Building with PowerShell is even simpler. Here's an example for a linux-x64 build:

.\tools\scripts\docker-source.ps1 .\src
docker build -f .\src\bin\publish\Release\linux-x64\Dockerfile.linux-amd64 -t iotedge/opc-plc .\src\bin\publish\Release\linux-x64

Notes

X.509 certificates:

  • Running on Windows natively, you cannot use an application certificate store of type Directory, since the access to the private key will fail. Use the option --at X509Store in this case.
  • Running as Linux Docker container, you can map the certificate stores to the host file system by using the Docker run option -v <hostdirectory>:/appdata. This will make the certificate persistent over starts.
  • Running as Linux Docker container using an X509Store for the application certificate, you need to use the Docker run option -v x509certstores:/root/.dotnet/corefx/cryptography/x509stores and the application option --at X509Store

Resources

Command-line reference

Usage: dotnet opcplc.dll [<options>]

OPC UA PLC for different data simulation scenarios.
To exit the application, press CTRL-C while it's running.

Use the following format to specify a list of strings:
"<string 1>,<string 2>,...,<string n>"
or if one string contains commas:
""<string 1>","<string 2>",...,"<string n>""

Options:
      --lf, --logfile=VALUE  the filename of the logfile to use.
                               Default: './machinename-plc.log'
      --lt, --logflushtimespan=VALUE
                             the timespan in seconds when the logfile should be
                               flushed.
                               Default: 00:00:30 sec
      --ll, --loglevel=VALUE the loglevel to use (allowed: fatal, error, warn,
                               info, debug, verbose).
                               Default: info
      --sc, --simulationcyclecount=VALUE
                             count of cycles in one simulation phase
                               Default:  50 cycles
      --ct, --cycletime=VALUE
                             length of one cycle time in milliseconds
                               Default:  100 msec
      --ei, --eventinstances=VALUE
                             number of event instances
                               Default: 0
      --er, --eventrate=VALUE
                             rate in milliseconds to send events
                               Default: 1000
      --pn, --portnum=VALUE  the server port of the OPC server endpoint.
                               Default: 50000
      --op, --path=VALUE     the enpoint URL path part of the OPC server
                               endpoint.
                               Default: ''
      --ph, --plchostname=VALUE
                             the fullqualified hostname of the plc.
                               Default: machinename
      --ol, --opcmaxstringlen=VALUE
                             the max length of a string opc can transmit/
                               receive.
                               Default: 4194304
      --lr, --ldsreginterval=VALUE
                             the LDS(-ME) registration interval in ms. If 0,
                               then the registration is disabled.
                               Default: 0
      --aa, --autoaccept     all certs are trusted when a connection is
                               established.
                               Default: False
      --ut, --unsecuretransport
                             enables the unsecured transport.
                               Default: False
      --to, --trustowncert   the own certificate is put into the trusted
                               certificate store automatically.
                               Default: False
      --at, --appcertstoretype=VALUE
                             the own application cert store type.
                               (allowed values: Directory, X509Store)
                               Default: 'Directory'
      --ap, --appcertstorepath=VALUE
                             the path where the own application cert should be
                               stored
                               Default (depends on store type):
                               X509Store: 'CurrentUser\UA_MachineDefault'
                               Directory: 'pki/own'
      --tp, --trustedcertstorepath=VALUE
                             the path of the trusted cert store
                               Default 'pki/trusted'
      --rp, --rejectedcertstorepath=VALUE
                             the path of the rejected cert store
                               Default 'pki/rejected'
      --ip, --issuercertstorepath=VALUE
                             the path of the trusted issuer cert store
                               Default 'pki/issuer'
      --csr                  show data to create a certificate signing request
                               Default 'False'
      --ab, --applicationcertbase64=VALUE
                             update/set this applications certificate with the
                               certificate passed in as bas64 string
      --af, --applicationcertfile=VALUE
                             update/set this applications certificate with the
                               certificate file specified
      --pb, --privatekeybase64=VALUE
                             initial provisioning of the application
                               certificate (with a PEM or PFX fomat) requires a
                               private key passed in as base64 string
      --pk, --privatekeyfile=VALUE
                             initial provisioning of the application
                               certificate (with a PEM or PFX fomat) requires a
                               private key passed in as file
      --cp, --certpassword=VALUE
                             the optional password for the PEM or PFX or the
                               installed application certificate
      --tb, --addtrustedcertbase64=VALUE
                             adds the certificate to the applications trusted
                               cert store passed in as base64 string (comma
                               separated values)
      --tf, --addtrustedcertfile=VALUE
                             adds the certificate file(s) to the applications
                               trusted cert store passed in as base64 string (
                               multiple filenames supported)
      --ib, --addissuercertbase64=VALUE
                             adds the specified issuer certificate to the
                               applications trusted issuer cert store passed in
                               as base64 string (comma separated values)
      --if, --addissuercertfile=VALUE
                             adds the specified issuer certificate file(s) to
                               the applications trusted issuer cert store (
                               multiple filenames supported)
      --rb, --updatecrlbase64=VALUE
                             update the CRL passed in as base64 string to the
                               corresponding cert store (trusted or trusted
                               issuer)
      --uc, --updatecrlfile=VALUE
                             update the CRL passed in as file to the
                               corresponding cert store (trusted or trusted
                               issuer)
      --rc, --removecert=VALUE
                             remove cert(s) with the given thumbprint(s) (
                               comma separated values)
      --daa, --disableanonymousauth
                             flag to disable anonymous authentication.
                               Default: False
      --dua, --disableusernamepasswordauth
                             flag to disable username/password authentication.
                               Default: False
      --dca, --disablecertauth
                             flag to disable certificate authentication.
                               Default: False
      --au, --adminuser=VALUE
                             the username of the admin user.
                               Default: sysadmin
      --ac, --adminpassword=VALUE
                             the password of the administrator.
                               Default: demo
      --du, --defaultuser=VALUE
                             the username of the default user.
                               Default: user1
      --dc, --defaultpassword=VALUE
                             the password of the default user.
                               Default: password
      --alm, --alarms        add alarm simulation to address space.
                               Default: False
      --ses, --simpleevents  add simple events simulation to address space.
                               Default: False
      --ref, --referencetest add reference test simulation node manager to
                               address space.
                               Default: False
      --dalm, --deterministicalarms=VALUE
                             add deterministic alarm simulation to address
                               space.
                               Provide a script file for controlling
                               deterministic alarms.
      --sp, --showpnjson     show OPC Publisher configuration file using IP
                               address as EndpointUrl.
                               Default: False
      --sph, --showpnjsonph  show OPC Publisher configuration file using
                               plchostname as EndpointUrl.
                               Default: False
      --spf, --showpnfname=VALUE
                             filename of the OPC Publisher configuration file
                               to write when using options sp/sph.
                               Default: pn.json
      --wp, --webport=VALUE  web server port for hosting OPC Publisher
                               configuration file.
                               Default: 8080
      --cdn, --certdnsnames=VALUE
                             add additional DNS names or IP addresses to this
                               application's certificate (comma separated values)
  -h, --help                 show this message and exit
      --ctb, --complextypeboiler
                             add complex type (boiler) to address space.
                               Default: False
      --nv, --nodatavalues   do not generate data values
                               Default: False
      --gn, --guidnodes=VALUE
                             number of nodes with deterministic GUID IDs
                               Default: 1
      --nd, --nodips         do not generate dip data
                               Default: False
      --fn, --fastnodes=VALUE
                             number of fast nodes
                               Default: 1
      --fr, --fastrate=VALUE rate in seconds to change fast nodes
                               Default: 1
      --ft, --fasttype=VALUE data type of fast nodes (UInt|Double|Bool|
                               UIntArray)
                               Default: UInt
      --ftl, --fasttypelowerbound=VALUE
                             lower bound of data type of fast nodes (UInt|
                               Double|Bool|UIntArray)
                               Default: min value of node type.
      --ftu, --fasttypeupperbound=VALUE
                             upper bound of data type of fast nodes (UInt|
                               Double|Bool|UIntArray)
                               Default: max value of node type.
      --ftr, --fasttyperandomization=VALUE
                             randomization of fast nodes value (UInt|Double|
                               Bool|UIntArray)
                               Default: False
      --fts, --fasttypestepsize=VALUE
                             step or increment size of fast nodes value (UInt|
                               Double|Bool|UIntArray)
                               Default: 1
      --fsi, --fastnodesamplinginterval=VALUE
                             rate in milliseconds to sample fast nodes
                               Default: 0
      --vfr, --veryfastrate=VALUE
                             rate in milliseconds to change fast nodes
                               Default: 10000
      --lid, --longid        add node with ID of 3950 chars.
                               Default: False
      --lsn, --longstringnodes
                             add nodes with string values of 10/50/100/200 kB.
                               Default: False
      --nn, --nonegtrend     do not generate negative trend data
                               Default: False
      --on, --opaquenode
                             add node with an opaque identifier 
                               Default: False
      --np, --nopostrend     do not generate positive trend data
                               Default: False
      --sn, --slownodes=VALUE
                             number of slow nodes
                               Default: 1
      --sr, --slowrate=VALUE rate in seconds to change slow nodes
                               Default: 10
      --st, --slowtype=VALUE data type of slow nodes (UInt|Double|Bool|
                               UIntArray)
                               Default: UInt
      --stl, --slowtypelowerbound=VALUE
                             lower bound of data type of slow nodes (UInt|
                               Double|Bool|UIntArray)
                               Default: min value of node type.
      --stu, --slowtypeupperbound=VALUE
                             upper bound of data type of slow nodes (UInt|
                               Double|Bool|UIntArray)
                               Default: max value of node type.
      --str, --slowtyperandomization=VALUE
                             randomization of slow nodes value (UInt|Double|
                               Bool|UIntArray)
                               Default: False
      --sts, --slowtypestepsize=VALUE
                             step or increment size of slow nodes value (UInt|
                               Double|Bool|UIntArray)
                               Default: 1
      --ssi, --slownodesamplinginterval=VALUE
                             rate in milliseconds to sample slow nodes
                               Default: 0
      --scn, --specialcharname
                             add node with special characters in name 
                               Default: False
      --ns, --nospikes       do not generate spike data
                               Default: False
      --nf, --nodesfile=VALUE
                             the filename which contains the list of nodes to
                               be created in the OPC UA address space.

About

OPC UA server with nodes that generate random and increasing data, and anomalies

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C# 96.8%
  • PowerShell 3.1%
  • Batchfile 0.1%