owner.opc-ua

Opc Ua Owner File

oneOf

OpcUa Read Owner

OpcUa Read Owner

OpcUa Method Owner

OpcUa Method Owner

OpcUa Subscription Owner

OpcUa Subscription Owner

OpcUa Read Owner

Used for reading a specific node on the linked device.

type

object

properties

  • type

type

string

enum

DirectRead

default

DirectRead

  • 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

  • linkedDevice

The OPC UA device device.opc-ua ↗️ that this owner will use to get the value.

For example root.opcua.device1 could be the OnSphere path of the OPC UA device.

type

string

  • nodeId

Node ID is an identifier for a node in an OPC server’s address space. OPC Unified Architecture allows the OPC server to choose one or more types of node IDs for representation of its nodes.

A node Id is not, by itself, a string. It’s primarily an object, containing a namespace and the identifier. Node IDs can be numeric (a 32-bit integer), string, a GUID (globally unique identifier, 128 bits), or opaque (a binary data blob). Depending on the type of Node Id, the node id may have one of the following forms:

  • ns=namespace;i=integer

  • ns=namespace;s=string

  • ns=namespace;g=guid

  • ns=namespace;b=base64string

Here below is a example of how it could look in this configuration file:

"nodeId": {
    "ns": "example",
    "s":"10"
}

But OPC UA also have a string representation that you can use as well to describe a node Id. Meaning you could freely describe the same node id as:

"nodeId": "ns:example;s:10"

Both of theses examples represent the same node id. You are free to use the representation that suits you best

Learn more about OPC UA ↗️.

  • pollingFrequency

This trigger the values in polling mode at a given frequency so that they make a request to the server and read the data of a Node. If this is not set it uses the device default pollingFrequency

Learn more about OPC UA ↗️.

DurationConfigurationEntity

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

OpcUa Method Owner

type

object

properties

  • type

type

string

enum

MethodRead

default

MethodRead

  • 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

  • linkedDevice

The OPC UA device device.opc-ua ↗️ that this owner will use to get the value.

For example root.opcua.device1 could be the OnSphere path of the OPC UA device.

type

string

  • pollingFrequency

This trigger the values in polling mode at a given frequency so that they make a request to the server and read the data of a Node. If this is not set it uses the device default pollingFrequency.

Learn more about OPC UA ↗️.

DurationConfigurationEntity

  • methodObjectNodeId

Node ID is an identifier for a node in an OPC server’s address space. OPC Unified Architecture allows the OPC server to choose one or more types of node IDs for representation of its nodes.

The method object identifier is the NodeId of the object node that contains the method. This is the node representing the object or component to which the method belongs.

A node Id is not, by itself, a string. It’s primarily an object, containing a namespace and the identifier. Node IDs can be numeric (a 32-bit integer), string, a GUID (globally unique identifier, 128 bits), or opaque (a binary data blob). Depending on the type of Node Id, the node id may have one of the following forms:

  • ns=namespace;i=integer

  • ns=namespace;s=string

  • ns=namespace;g=guid

  • ns=namespace;b=base64string

Here below is a example of how it could look in this configuration file:

"nodeId": {
    "ns": "example",
    "s":"10"
}

But OPC UA also have a string representation that you can use as well to describe a node Id. Meaning you could freely describe the same node id as:

"nodeId": "ns:example;s:10"

Both of theses examples represent the same node id. You are free to use the representation that suits you best

Learn more about OPC UA ↗️.

  • methodNodeId

Node ID is an identifier for a node in an OPC server’s address space. OPC Unified Architecture allows the OPC server to choose one or more types of node IDs for representation of its nodes.

The method identifier is the NodeId of the method node. It uniquely identifies the method within the address space of the OPC UA server.

A node Id is not, by itself, a string. It’s primarily an object, containing a namespace and the identifier. Node IDs can be numeric (a 32-bit integer), string, a GUID (globally unique identifier, 128 bits), or opaque (a binary data blob). Depending on the type of Node Id, the node id may have one of the following forms:

  • ns=namespace;i=integer

  • ns=namespace;s=string

  • ns=namespace;g=guid

  • ns=namespace;b=base64string

Here below is a example of how it could look in this configuration file:

"nodeId": {
    "ns": "example",
    "s":"10"
}

But OPC UA also have a string representation that you can use as well to describe a node Id. Meaning you could freely describe the same node id as:

"nodeId": "ns:example;s:10"

Both of theses examples represent the same node id. You are free to use the representation that suits you best

Learn more about OPC UA ↗️.

  • parameters

BETA, For the moment only the first parameters of the given list [A, 2, Test] can be passed to the method. In this case it will be A.

type

array

default

items

type

string

additionalProperties

False

OpcUa Subscription Owner

Used to subscribe to a specific node on the linked device.

type

object

properties

  • type

type

string

enum

Subscription

default

Subscription

  • 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

  • linkedDevice

The OPC UA device device.opc-ua ↗️ that this owner will use to get the value.

For example root.opcua.device1 could be the OnSphere path of the OPC UA device.

type

string

  • nodeId

Node ID is an identifier for a node in an OPC server’s address space. OPC Unified Architecture allows the OPC server to choose one or more types of node IDs for representation of its nodes.

A node Id is not, by itself, a string. It’s primarily an object, containing a namespace and the identifier. Node IDs can be numeric (a 32-bit integer), string, a GUID (globally unique identifier, 128 bits), or opaque (a binary data blob). Depending on the type of Node Id, the node id may have one of the following forms:

  • ns=namespace;i=integer

  • ns=namespace;s=string

  • ns=namespace;g=guid

  • ns=namespace;b=base64string

Here below is a example of how it could look in this configuration file:

"nodeId": {
    "ns": "example",
    "s":"10"
}

But OPC UA also have a string representation that you can use as well to describe a node Id. Meaning you could freely describe the same node id as:

"nodeId": "ns:example;s:10"

Both of theses examples represent the same node id. You are free to use the representation that suits you best

Learn more about OPC UA ↗️.

  • samplingInterval

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 ↗️.

DurationConfigurationEntity

additionalProperties

False