Frends.Opcua.Read
Task for reading data from OPCUA Server.
Task version: 1.0.0
Required Frends version: 5.7+
Required .NET version: 8.0
Compatible Agents: Crossplatform
Source code: https://github.com/FrendsPlatform/Frends.Opcua/tree/main/Frends.Opcua.Read
Task Parameters
Mode : OpcOperationMode
Determines the mode for either reading specific nodes or browse existing nodes.
Possible values:
Read: Determines the mode for either reading specific nodes or browse existing nodes.Browse: Determines the mode for either reading specific nodes or browse existing nodes.
Default: 0
Example: OpcOperationMode.ReadNodes
NodeIds : String[]
List of NodeIds to read from the OPC UA Server.
Default: -
Example: [ "ns=2;i=1001", "ns=2;s=Temperature" ]
StartNodeId : String
NodeId of the node where browsing should be started.
Default: -
Example: ns=2;s=Temperature
ServerName : String
OPC UA Server name or IP address.
Default: localhost
Example: localhost
Port : Int32
Port to be used to connect to the OPC UA Server.
Default: 4080
Example: 4080
Path : String
Optional parameter to set a specific path to the server URL.
Default: -
Example: path
AutoAcceptUntrustedCertificates : Boolean
Whether to accept untrusted/self-signed server certificates.
Set to false in production environments.
Default: True
Example: true
Authentication : AuthenticationMode
Authentication to be used connecting to the OPC UA Server.
Possible values:
Anonymous: Authentication to be used connecting to the OPC UA Server.UsernamePassword: Authentication to be used connecting to the OPC UA Server.Certificate: Authentication to be used connecting to the OPC UA Server.
Default: 1
Example: AuthenticationMode.UsernamePassword
Username : String
Username for the authentication.
Default: -
Example: user
🗝Password : String
Password for the authentication.
Default: -
Example: pass
CertificatePath : String
Path to the certificate to be used to authenticate to OPC UA Server.
Default: -
Example: C:\path\to\certificate
🗝CertificatePassword : String
Password for the certificate file.
Default: -
Example: Password
PrivateKeyPath : String
Path to the private key. Used forr certificate authentication if .der or .crt typed certifications are being used.
Default: -
Example: C:\path\to\privatekey
ConnectionTimeout : Int32
Connection timeout in seconds.
Default: 10
Example: 10
SessionTimeout : Int32
Session timeout in seconds.
Default: 60
Example: 60
SecurityMode : OpcMessageSecurityMode
Defines the OPC UA message security level applied to communication between client and server.
Controls whether messages are sent without security, digitally signed for integrity,
or both signed and encrypted for full confidentiality and protection against tampering.
Possible values:
None: Defines the OPC UA message security level applied to communication between client and server.
Controls whether messages are sent without security, digitally signed for integrity,
or both signed and encrypted for full confidentiality and protection against tampering.
Sign: Defines the OPC UA message security level applied to communication between client and server.
Controls whether messages are sent without security, digitally signed for integrity,
or both signed and encrypted for full confidentiality and protection against tampering.
SignAndEncrypt: Defines the OPC UA message security level applied to communication between client and server.
Controls whether messages are sent without security, digitally signed for integrity,
or both signed and encrypted for full confidentiality and protection against tampering.
Default: 0
Example: OpcMessageSecurityMode.None
ApplicationCertificatePath : String
Optional path to a PFX/PKCS#12 file to use as the client application certificate
for establishing a secure channel. When left empty a temporary self-signed certificate
is generated for the duration of the task and discarded afterwards.
Requires ApplicationCertificatePassword if the PFX is password protected.
Default: -
Example: C:\path\to\cert
🗝ApplicationCertificatePassword : String
Password for the PFX file specified in ApplicationCertificatePath.
Leave empty if the certificate has no password.
Default: -
Example: passphrase
SecurityPolicy : OpcSecurityPolicy
Defines the cryptographic algorithm set used for securing OPC UA communication.
Includes encryption algorithms, hashing functions, and key exchange mechanisms.
The selected policy must be supported by the server endpoint and compatible with the chosen SecurityMode.
Possible values:
None: Defines the cryptographic algorithm set used for securing OPC UA communication.
Includes encryption algorithms, hashing functions, and key exchange mechanisms.
The selected policy must be supported by the server endpoint and compatible with the chosen SecurityMode.
Basic256Sha256: Defines the cryptographic algorithm set used for securing OPC UA communication.
Includes encryption algorithms, hashing functions, and key exchange mechanisms.
The selected policy must be supported by the server endpoint and compatible with the chosen SecurityMode.
Aes128Sha256RsaOaep: Defines the cryptographic algorithm set used for securing OPC UA communication.
Includes encryption algorithms, hashing functions, and key exchange mechanisms.
The selected policy must be supported by the server endpoint and compatible with the chosen SecurityMode.
Aes256Sha256RsaPss: Defines the cryptographic algorithm set used for securing OPC UA communication.
Includes encryption algorithms, hashing functions, and key exchange mechanisms.
The selected policy must be supported by the server endpoint and compatible with the chosen SecurityMode.
Default: 0
Example: OpcSecurityPolicy.None
ApplicationName : String
Application name used when connecting to the OPC UA Server.
Default: Frends.OpcUa.Client
Example: Frends.OpcUa.Client
PkiRootPath : String
The root directory path where the OPC UA client PKI store is located.
The SDK will create the following subdirectories automatically:
own — stores the auto-generated client application certificatetrusted — stores trusted server certificatesrejected — stores rejected server certificates
On first connect the SDK generates a self-signed application certificate and saves it
under {PkiRootPath}/own, which is then reused on subsequent runs.
Only applicable when OpcMessageSecurityMode is anything other than None.
Default: -
Example: ./pki
ThrowErrorOnFailure : Boolean
Whether to throw an error on failure.
Default: True
Example: true
ErrorMessageOnFailure : String
Overrides the error message on failure.
Default: -
Example: Custom error message
Task Result
Success : Boolean
Indicates whether the read operation was successful.
Example: true
NodeValues : Object
JSON array of node read results. Each element contains NodeId, Value, DataType, StatusCode, and SourceTimestamp.
Example: { }
Error : Error
Error message if the operation failed.
Example: object { string Message, Exception AdditionalInfo }
Task Changelog
Changelog for Task Frends.Opcua.Read.
[1.0.0] - 2026-05-18
Added
Initial implementation
Last updated
Was this helpful?