Shelve Alarm Condition VI

Owning Palette: Alarms and Conditions VIs

Requires: OPC UA Toolkit

Transits among the one-shot shelved state, the timed shelved state, and the unshelved state for an alarm.

The one-shot shelved state prevents an alarm from displaying for its current active state. The timed shelved state prevents an alarm from displaying for a definite time period. The unshelved state allows an alarm to display.

You must manually select the polymorphic instance to use.

Example

One-Shot Shelve Alarm Condition

	OPC UA client refnum in specifies the reference for the OPC UA client.
	condition node ID specifies the ID of the condition node. The format of the node ID is ns=<namespace index>;<identifier type>=<identifier>. A node ID contains the following components: namespace index is a base 10 number that indicates the namespace of the node ID. If namespace index is 0, the format of the node ID can be <identifier type>=<identifier>. The namespace index for a node that you created with the OPC UA Toolkit is 2. identifier type represents the type of the identifier and has the following values: Value Identifier Type i Numeric s String g GUID b Opaque identifier is a string value that represents the name of the identifier. The format of the node ID can also be ns=<namespace index>;<identifier type>=<identifier>@<index>:<index>. For example, ns=2;s=Folder.Array@1:2. This format only applies to the array data type and allows you to read a single element or a range of elements of an array. You cannot use @ in a node name. For backwards compatibility, condition node ID also accepts node paths as input for OPC UA servers only. You can regard the node path as the string type identifier of the node ID. For example, a node path can be Device.folder.item.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	timeout specifies the maximum time, in milliseconds, that this VI waits to get a response from the OPC UA server. The default is 5000.
	OPC UA client refnum out returns the reference for the OPC UA client.
	service status returns the status of an OPC UA service call. OPC UA services contain parameters that are conveyed between an OPC UA client and an OPC UA server.
	error out contains error information. This output provides standard error out functionality.

Timed Shelve Alarm Condition

	OPC UA client refnum in specifies the reference for the OPC UA client.
	condition node ID specifies the ID of the condition node. The format of the node ID is ns=<namespace index>;<identifier type>=<identifier>. A node ID contains the following components: namespace index is a base 10 number that indicates the namespace of the node ID. If namespace index is 0, the format of the node ID can be <identifier type>=<identifier>. The namespace index for a node that you created with the OPC UA Toolkit is 2. identifier type represents the type of the identifier and has the following values: Value Identifier Type i Numeric s String g GUID b Opaque identifier is a string value that represents the name of the identifier. The format of the node ID can also be ns=<namespace index>;<identifier type>=<identifier>@<index>:<index>. For example, ns=2;s=Folder.Array@1:2. This format only applies to the array data type and allows you to read a single element or a range of elements of an array. You cannot use @ in a node name. For backwards compatibility, condition node ID also accepts node paths as input for OPC UA servers only. You can regard the node path as the string type identifier of the node ID. For example, a node path can be Device.folder.item.
	shelving time specifies the time period, in milliseconds, during which an alarm is in a shelved state. shelving time should be less than the maximum time that an alarm condition is in shelved state. You can set or get the maximum time by the Max Time Shelved property.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	timeout specifies the maximum time, in milliseconds, that this VI waits to get a response from the OPC UA server. The default is 5000.
	OPC UA client refnum out returns the reference for the OPC UA client.
	service status returns the status of an OPC UA service call. OPC UA services contain parameters that are conveyed between an OPC UA client and an OPC UA server.
	error out contains error information. This output provides standard error out functionality.

Unshelve Alarm Condition

	OPC UA client refnum in specifies the reference for the OPC UA client.
	condition node ID specifies the ID of the condition node. The format of the node ID is ns=<namespace index>;<identifier type>=<identifier>. A node ID contains the following components: namespace index is a base 10 number that indicates the namespace of the node ID. If namespace index is 0, the format of the node ID can be <identifier type>=<identifier>. The namespace index for a node that you created with the OPC UA Toolkit is 2. identifier type represents the type of the identifier and has the following values: Value Identifier Type i Numeric s String g GUID b Opaque identifier is a string value that represents the name of the identifier. The format of the node ID can also be ns=<namespace index>;<identifier type>=<identifier>@<index>:<index>. For example, ns=2;s=Folder.Array@1:2. This format only applies to the array data type and allows you to read a single element or a range of elements of an array. You cannot use @ in a node name. For backwards compatibility, condition node ID also accepts node paths as input for OPC UA servers only. You can regard the node path as the string type identifier of the node ID. For example, a node path can be Device.folder.item.
	error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
	timeout specifies the maximum time, in milliseconds, that this VI waits to get a response from the OPC UA server. The default is 5000.
	OPC UA client refnum out returns the reference for the OPC UA client.
	service status returns the status of an OPC UA service call. OPC UA services contain parameters that are conveyed between an OPC UA client and an OPC UA server.
	error out contains error information. This output provides standard error out functionality.

Example

Refer to the OPC UA Demo.lvproj in the labview\examples\Data Communication\OPCUA directory for an example of using the Shelve Alarm Condition VI.