This plugin is based on the S2OPC open source library.
OPC UA server protocol stack configuration
Connection configuration
This section provides the connection-level configuration details of an OPC UA server.
Attributes definition
Attribute | Description | Expected values | Mandatory |
---|---|---|---|
url | The server URL endpoint | “opc.tcp://:[/sub/path]” e.g. “opc.tcp://localhost:4841” | YES |
appUri | The application URI | e.g. “urn:S2OPC:localhost” | YES |
productUri | The product URI | e.g. “urn:S2OPC:localhost” | YES |
appDescription | Application description | Any non-empty string. | YES |
localeId | The default language Id. | e.g. "en-US", "fr-FR", ... | YES |
namespaces | List of namespaces URI, starting at namespace 1. Thus, the array should contain only one name. (Array is kept for portability) | e.g. for 2 users namespaces (ns=1, ns=2): [ "urn:S2OPC:localhost", "urn:S2OPC:localhost_2" ] | YES |
policies | Array of accepted policies If no security is required: | YES | |
policies.securityMode | The security mode | A string among “None”, “Sign” and “SignAndEncrypt” (case insensitive) | YES |
policies.securityPolicy | The security policy | A string among “None”, “Basic256”, “Basic256Sha256”, “Aes128Sha256RsaOaep” and “Aes256Sha256RsaPss” | YES |
policies.userPolicies | The user policy If no security is required, "Anonymous" should be used | A string among “Anonymous”, “username”, “username_None”, “username_Basic256” | YES |
users | A map of 'user':'password'. If no user-authentication is required, it can be an empty object | e.g: {"user" : "password", "user2" : "xGt4sdE3Z+" } e.g: {} | YES |
certificates | Note: all certificate files are expected to be provided in the $(FLEDGE_INSTALL)/data/etc/certs/s2opc_srv folder | NO | |
certificates.serverCertPath | The Server certificate filename (DER format) | e.g. "server_2k_cert.der" | NO |
certificates.serverKeyPath | The Server key filename (PEM format) | e.g. "server_2k_key.pem" | NO |
certificates.trusted_root | The list of trusted root certificates (DER) | e.g. [ "cacert.der" ] | NO |
certificates.trusted_intermediate | The list of trusted intermediate certificates (DER) | Same as “trusted_root” | NO |
certificates.revoked | The list of revoked certificates (DER) | Same as “trusted_root” | NO |
certificates.untrusted_root | The list of untrusted root certificates (DER) | Same as “trusted_root” | NO |
certificates.untrusted_intermediate | The list of untrusted intermediate certificates (DER) | Same as “trusted_root” | NO |
certificates.issued | The list of untrusted issued certificates (DER) | Same as “trusted_root” | NO |
Configuration JSON structure
{ "transport_layer":{ "url":"opc.tcp://localhost:4841/OPCUA/s2opc", "appUri":"urn:S2OPC:localhost", "productUri":"urn:S2OPC:localhost", "appDescription":"Application description", "localeId":"en-US", "namespaces":[ "urn:S2OPC:localhost" ], "policies":[ { "securityMode":"None", "securityPolicy":"None", "userPolicies":[ "anonymous" ] }, { "securityMode":"SignAndEncrypt", "securityPolicy":"Basic256Sha256", "userPolicies":[ "username_Basic256Sha256", "username_None" ] } ], "users":{ "user":"password", "user2":"xGt4sdE3Z+" }, "certificates":{ "serverCertPath":"server_2k_cert.der", "serverKeyPath":"server_2k_key.pem", "trusted_root":[ "cacert.der" ], "trusted_intermediate":[], "revoked":["cacrl.der"], "untrusted_root":[], "untrusted_intermediate":[], "issued":[] } } }
Endpoint configuration
This section provides the user-level configuration details of an OPC UA server, once a client-server secured connection is established.
The endpoint (see "transport_layer.url
") is an OPC UA interface and provides several means of use by a client (Browse, Read, Write, Subscribe). The following items allow any connected client to access directly all server data without required use of browsing, provided that it has knowledge of the PIVOT object it needs.
Interface specification:
- As a standard OPC UA server, all functional data are organized under the
Root.Objects
node of namespace 0 ( nodeId =i=85
). - For each PIVOT data, there is one node under
Root.Objects
with:- NodeClass =
Object
- NodeId=
ns=1;s=
<PIVOT_ID>
, with<PIVOT_ID>
as provided inexchanged_data.datapoints[].pivot_id
section configuration. - BrowseName= namespace =1, name =
<PIVOT_ID>
- DisplayName =
<PIVOT_ID>
- References:
- HasTypeDefinition:
FolderType
- HasComponent:
<...>
, one for each variable below
- HasTypeDefinition:
- NodeClass =
NodeId | BrowseName/ DisplayName | IsOrganizedBy | NodeClass | Type | Default value | Details |
---|---|---|---|---|---|---|
| <PIVOT_ID> |
(= "i=85") |
| Parent folder for each PIVOT data | ||
| Cause | ns=1;s= <PIVOT_ID> | Variable | UInt32 (Read-Only) | Mandatory | See Cause of Transmission |
| Confirmation | ns=1;s= <PIVOT_ID> | Variable | Boolean (Read-Only) | false | |
| Test | ns=1;s= <PIVOT_ID> | Variable | Boolean (Read-Only) | false | |
| OperatorBlocked | ns=1;s= <PIVOT_ID> | Variable | Boolean (Read-Only) | false | |
| Source | ns=1;s= <PIVOT_ID> | Variable | String (Read-Only) | "process" | "process" | "substituted" |
| ComingFrom | ns=1;s= <PIVOT_ID> | Variable | String (Read-Only) | Mandatory | Any protocol name ("iec104" ,"opcua", ...) |
| TmOrg | ns=1;s= <PIVOT_ID> | Variable | String (Read-Only) | Mandatory | "genuine" | "substituted" |
| TmValidity | ns=1;s= <PIVOT_ID> | Variable | String (Read-Only) | Mandatory | Validity of the Timestamp of Value "good" | "invalid" | "reserved" | "questionable" |
| DetailQuality | ns=1;s= <PIVOT_ID> | Variable | UInt32 (Read-Only) | 0 | OR-Mask of following values:
|
| TimeQuality | ns=1;s= <PIVOT_ID> | Variable | UInt32 (Read-Only) | 0 | OR-Mask of following values:
|
| Value | ns=1;s= <PIVOT_ID> | Variable | (See below) | Mandatory | (See below) |
With <PIVOT_ID>
as provided in exchanged_data.datapoints[].pivot_id
section configuration.
Notes:
- All read-only variables have a
OpcUa_BadWaitingForInitialData
quality (0x80320000
) intial value until a valid value is received from a south device. - All non-mandatory values will be set automatically be the server if not received from a south device.
- If a mandatory value is missing, then the whole PIVOT object is not updated.
Value content and metadata
PIVOT timestamp
The ns=1;s=
<PIVOT_ID>
/Value
variable contains the pivot timestamp value (t.FractionOfSecond
+ t.SecondSinceEpoch
) is converted to OPC-UA timestamp (Unit= number of 100 nanosecond since Jan 1st,1600.).
The timestamp is not optional in OPCUA. Thus, in case the timestamp were not provided by south layers, the OPC UA north plugin will set the timestamp to 0.
PIVOT value validity
The ns=1;s=
<PIVOT_ID>
/Value
variable contains the pivot value validity
field. It is represented as the OPC UA Quality of the variable, using the following conversion:
PIVOT Validity | OPC UA quality |
---|---|
good | OPC_UA_GOOD |
invalid | OPC_UA_BAD |
reserved | OPC_UA_BAD (not used) |
questionable | OPC_UA_UNCERTAIN |