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
namespaceIndex	Specifies the namespace the node belongs to. Namespaces help avoid conflicts between different sources of information and manage nodes from different standards or vendors. For example in ns=2;s=TemperatureSensor, 2 is the index namespace. Knowing this you would put `2` for this parameter (`namespaceIndex`). Learn more about OPC UA ↗️.
	type	integer
nodeIdentifier	The node identifier is the part of the NodeId that uniquely identifies a node within a given namespace. The identifier can be a numeric value, a string, a GUID, or an opaque byte string. For the moment only strings are handled. For example if a NodeId use the following path ns=2;s=TemperatureSensor. Knowing this you would put `TemperatureSensor` for this parameter (`nodeIdentifier`). Learn more about OPC UA ↗️.
	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
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
namespaceIndex	Specifies the namespace the node belongs to. Namespaces help avoid conflicts between different sources of information and manage nodes from different standards or vendors. For example in ns=2;s=TemperatureSensor, 2 is the index namespace. Knowing this you would put `2` for this parameter (`namespaceIndex`). Learn more about OPC UA ↗️.
	type	integer
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
methodObjectIdentifier	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. For example if a method use the following id ns=2;s=TemperatureSensor, and can be located in the object ns=2;s=ServerA. Knowing this you would put `ServerA` for this parameter (`methodObjectIdentifier`) You would put ServerA here. Learn more about OPC UA ↗️.
	type	string
methodIdentifier	The method identifier is the NodeId of the method node. It uniquely identifies the method within the address space of the OPC UA server. For example if a method use the following id ns=2;s=TemperatureSensor, it can be located in the object ns=2;s=ServerA. Knowing this you would put `TemperatureSensor` for this parameter (`methodIdentifier`). Learn more about OPC UA ↗️.
	type	string
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
namespaceIndex	Specifies the namespace the node belongs to. Namespaces help avoid conflicts between different sources of information and manage nodes from different standards or vendors. For example in ns=2;s=TemperatureSensor, 2 is the index namespace. Knowing this you would put `2` for this parameter (`namespaceIndex`). Learn more about OPC UA ↗️.
	type	integer
nodeIdentifier	The node identifier is the part of the NodeId that uniquely identifies a node within a given namespace. The identifier can be a numeric value, a string, a GUID, or an opaque byte string. For the moment only strings are handled. For example if a NodeId use the following path ns=2;s=TemperatureSensor. Knowing this you would put `TemperatureSensor` for this parameter (`nodeIdentifier`). Learn more about OPC UA ↗️.
	type	string
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