device.opc-ua

OpcUa device

type

object

properties

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

  • isTemplateGeneratedByOspComposer

If the value is set to true, manual editing of this file should be avoided, as the composer will override the value in the next generation.

type

boolean

  • moduleId

The OPC UA module module.opc-ua ↗️ that this device will use to communicate.

For example modules.opc-ua.opc-ua-1 is the default OnSphere path of the OPC UA module.

type

string

  • ipAddress

The IP address of the OPC UA device. This address is used by the client to locate and connect to the OPC UA server on the network.

For the moment only URL construction using opc.tcp prefix is handled.

For example opc.tcp://192.168.42.1:4840 is valid and this parameter (ipAddress) will be 192.168.42.1.

Learn more about OPC UA ↗️.

type

string

  • port

The port number on which the OPC UA device’s server is listening. This port is used by the client to establish a connection with the server. It should be a valid port number between 0 and 65535.

The value that OPC UA servers are set to by default is 4840.

Learn more about OPC UA ↗️.

type

integer

  • securityPolicyType

The OpcUa security policy. It’s important to choose the right security policy to ensure that both the client and server support the chosen policy.

The default is Basic256Sha256.

Learn more about OPC UA ↗️.

type

string

enum

None, Basic128Rsa15, Basic256, Basic256Sha256, Aes128_Sha256_RsaOaep, Aes256_Sha256_RsaPss

default

Basic256Sha256

  • authenticationMethod

The OpcUa authentication method. You can choose the option to pass either a Username/Password combination or a certificate with a private key.

The default is Anonymous.

Learn more about OPC UA ↗️.

oneOf

Anonymous

UsernamePassword

Certificate

  • clientCertificate

The custom certificate for the OpcUa client.

The default is the certificate of the OSP OPC UA module. In the majority of the cases this certificate needs to be added to the trust store of the server.

Learn more about OPC UA ↗️.

OpcUaClientCertificateFile

  • folder

The OpcUa folder that you want to connect to (placed after the port in the tcp url). This is used only if you want to target a certain folder specifically.

For example if you are only interested in /rootFolder/subrootFolder/deviceA and /rootFolder/subrootFolder/deviceB that are situated in folder ‘/rootFolder/subrootFolder’, you can set this parameter to ‘/rootFolder/subrootFolder’ so that when you declare the identifier part deviceA and B you don’t have to repeat ‘/rootFolder/subrootFolder’.

Learn more about OPC UA ↗️.

type

string

  • pollingFrequency

The polling frequency used by default for every value using this device. This poll the values at the given frequency so that they make a request to the server and read the data of a Node.

Learn more about OPC UA ↗️.

default

value

10

unit

SECONDS

DurationConfigurationEntity

  • publishingInterval

Regulates the rate at which the server transmits data updates to the client, effectively limiting the frequency of notifications.

For instance, if a value changes every millisecond but the sampling interval is set to 100 milliseconds, the server will only notify the client of value changes at most every 100 milliseconds, preventing excessive notification spam.

Learn more about OPC UA ↗️.

default

value

10

unit

SECONDS

DurationConfigurationEntity

  • numberOfThreads

Custom number of threads used to communicate and split charge on this specific device communications.

Can be useful if there is a lot of value that are in polling mode.

Learn more about OPC UA ↗️.

type

integer

default

1

additionalProperties

False

Anonymous

type

object

properties

  • type

type

string

enum

Anonymous

default

Anonymous

additionalProperties

False

UsernamePassword

type

object

properties

  • type

type

string

enum

UsernamePassword

default

UsernamePassword

  • username

The username to use for the connection to the device.

It can be for example sysadmin.

Learn more about OPC UA ↗️.

type

string

  • passwordProvider

The password to use for the connection to the device.

It can be defined as plaintext or via a secret.

Learn more about OPC UA ↗️.

oneOf

PLAINTEXT

SECRET

additionalProperties

False

PLAINTEXT

type

object

properties

  • type

type

string

enum

PLAINTEXT

default

PLAINTEXT

  • password

The password to use in plaintext. It can be for example thisIs@TestPassword123.

type

string

additionalProperties

False

SECRET

type

object

properties

  • type

type

string

enum

SECRET

default

SECRET

  • secretPath

The path of the secret containing the password. This is a path to the secret containing the password.

type

string

additionalProperties

False

Certificate

type

object

properties

  • type

type

string

enum

Certificate

default

Certificate

  • certificatePath

The file path to the OPC UA certificate used for client authentication. This certificate is used to establish a secure connection with the OPC UA server and should be a valid X.509 certificate in PEM or DER format.

An absolute path is required.

Learn more about OPC UA ↗️.

type

string

  • privateKeyPath

The file path to the OPC UA private key used for client authentication. This key is associated with the provided certificate and is required to establish a secure connection. The private key should be in PEM or DER format.

An absolute path is required.

Learn more about OPC UA ↗️.

type

string

additionalProperties

False

OpcUaClientCertificateFile

type

object

properties

  • certificatePath

The file path to the OPC UA certificate used for client authentication. This certificate is used to establish a secure connection with the OPC UA server and should be a valid X.509 certificate in PEM or DER format.

An absolute path is required.

Learn more about OPC UA ↗️.

type

string

  • privateKeyPath

The file path to the OPC UA private key used for client authentication. This key is associated with the provided certificate and is required to establish a secure connection. The private key should be in PEM or DER format.

An absolute path is required.

Learn more about OPC UA ↗️.

type

string

  • clientURI

The OPC UA uri you want to set for the client. This is really important and it needs to be the same as the one defined in the subject alternative names of the certificate.

The default value is ‘urn:swissdotnet:onsphere’.

Learn more about OPC UA ↗️.

type

string

additionalProperties

False

DurationConfigurationEntity

type

object

properties

  • value

The amount of time expressed with the unit

type

integer

  • unit

The unit of time expressed with the value

type

string

enum

NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS

additionalProperties

False