OPC UA client
In design time and/or at runtime, imports the nodes of interest published by an OPC UA server and can keep the structures and values synchronized
- BrowseName
- OPCUAClient
- SuperType
- Object(BaseObjectType)
Properties
| Name | BrowseName | DataType | Description |
|---|---|---|---|
| Server endpoint URL | ServerEndpointURL | String | Communications protocol and network address of the endpoint on the server |
| Verify server identity | VerifyServerIdentity | Boolean | Validates the server public certificate. True = accept the certificate only if trusted; False = temporarily accept the certificate even if it not trusted |
| Requested publishing interval | RequestedPublishingInterval | Duration | Refresh interval when requesting data from the OPC/UA server |
| Requested sampling interval | RequestedSamplingInterval | Duration | Sampling frequency at which the OPC UA server polls the data from the field |
| Minimum message security mode | MinimumMessageSecurityMode | Message security mode | Minimum security level for messages exchanged between client and server. None = the messages can be unsigned and unencrypted; Signature = the messages must be signed or signed and encrypted; Signature and encryption = the messages must be signed and encrypted |
| Minimum security policy | MinimumSecurityPolicy | Security policy | Minimum security level for messages exchanged between client and server. None = the client does not require any specific security policy; Basic256Sha256 = this policy or more secure; Aes128_Sha256_RsaOaep = this policy or more secure; Aes256_Sha256_RsaPss = this policy |
| Client certificate file | ClientCertificateFile | ResourceUri | Client public certificate file, according to standard X509v3 and with .der extension. It must be found in the FTOptixApplication/ProjectFiles/PKI/Own/Certs/ folder |
| Client private key file | ClientPrivateKeyFile | ResourceUri | Client private key file, with ASCII Base64 encoding and .pem extension. It must be found in the FTOptixApplication/ProjectFiles/PKI/Own/Certs/ folder |
| User identity type | UserIdentityType | User identity type | This is the method for identification of the user. Anonymous = no information on the user available; User/Password = user identified by username and password; Certificate = user identified by a certificate |
| Username | Username | String | Username to be used when logging to the remote server |
| Password | Password | Password | Password to be used when logging to the remote server |
| User certificate file | UserCertificateFile | ResourceUri | The user public certification file, type X509v3 and with .der extension. It must be found in the FTOptixApplication/ProjectFiles/PKI/Own/Certs/ folder |
| User private key file | UserPrivateKeyFile | ResourceUri | User private key file, with ASCII Base64 encoding and .pem extension. It must be found in the FTOptixApplication/ProjectFiles/PKI/Own/Certs/ folder |
| Application URI | ApplicationURI | String | URI that globally identifies the application instance |
| Application name | ApplicationName | String | A legible ID of the application instance, not necessarily unique |
| Product URI | ProductURI | String | URI that globally identifies the software |
| Connection status | ConnectionStatus | Connection status | Status of the OPC/UA connection |
| Server URI | ServerUri | String | Remote path of the OPC/UA server |
| Enabled | Enabled | Boolean | Enables the object |
| Events | Events | Events | Events to listen while connected to the OPC/UA server |
| Synchronize the Node IDs on start | SynchronizeNodeIdsOnStart | Boolean | Synchronize the NodeIDs of the OPC UA nodes imported at design time with the NodeIDs of the same nodes on the server to which the client connects at runtime. If the situation on the server is not known, set it to True |
| Max array length | MaxArrayLength | Int32 | Maximum accepted number of elements in an array |
| Objects | Object | ||
| Runtime configurations | RuntimeConfigurations | Runtime configuration | Runtime synchronization of OPC/UA nodes |
Methods
Subscribe to data change
- BrowseName
- SubscribeToDataChange
Subscribe to value change from the OPC/UA server
| Name | DataType | Description |
|---|---|---|
| ReadValues | Read value | Read values |
Unsubscribe from data change
- BrowseName
- UnsubscribeFromDataChange
Unsubscribe from value change event
| Name | DataType | Description |
|---|---|---|
| ReadValues | Read value |
Translate browse paths to Node IDs (NodeIds)
- BrowseName
- TranslateBrowsePathsToNodeIds
When this option is on, browse paths are translated to NodeId
| Name | DataType | Description |
|---|---|---|
| BrowsePaths | BaseDataType | Browse paths list |
| Name | DataType | Description |
|---|---|---|
| NodeIds | NodeId | NodeIds list |
Read values
- BrowseName
- ReadValues
Read values from the OPC/UA server
| Name | DataType | Description |
|---|---|---|
| ReadValues | Read value | Read values |
| Name | DataType | Description |
|---|---|---|
| ReadValueResults | Read value result | Read value results |
Asynchronous read values
- BrowseName
- ReadValuesAsync
Asynchronously read values from the OPC/UA server
| Name | DataType | Description |
|---|---|---|
| OperationId | Guid | Operation ID |
| ReadValues | Read value | Read values |
Write values
- BrowseName
- WriteValues
Write values to the OPC/UA server
| Name | DataType | Description |
|---|---|---|
| WriteValues | WriteValue | Values to write |
| Name | DataType | Description |
|---|---|---|
| WriteValueResults | Write value result | Result of the OPC/UA write operation |
Call method
- BrowseName
- CallMethod
Call methods via OPC/UA
| Name | DataType | Description |
|---|---|---|
| TargetNode | NodeId | Target node to be called |
| Method | NodeId | Method |
| InputArguments | BaseDataType | Input arguments |
| Name | DataType | Description |
|---|---|---|
| ErrorCode | UInt32 | Error code |
| OutputArguments | BaseDataType | Output arguments |
Browse
- BrowseName
- Browse
Browse OPC/UA tree
| Name | DataType | Description |
|---|---|---|
| NodeId | NodeId | Node ID of the node to browse |
| BrowseDirection | Browse direction | Reference browse direction |
| ReferenceTypeId | NodeId | Node ID of the reference type to browse |
| IncludeSubtypes | Boolean | Indicates whether subtypes of the reference type should be browsed |
| Name | DataType | Description |
|---|---|---|
| Result | StatusCode | OPC UA-defined result code |
| References | ReferenceDescription | Reference descriptions |