UA_MonitoredItemAddList – OPC UA Client Function Blocks for IEC 61131-3

7.14 UA_MonitoredItemAddList

FB-Name			UA_MonitoredItemAddList
This Function Block can be used to add handle of multiple nodes using a list of node handles.
VAR_INPUT
B	Execute	BOOL	On rising edge monitored items will be added to a subscription.
B	SubscriptionHdl	DWORD	Subscription handle.
B	NodeHdlCount	UINT	Number of valid elements in the array to add.
B	NodeHdls	ARRAY OF DWORD	Array of Node handles. Max length of array is to be defined by the vendor and shall be same length thanVariables array length. Shall be the same size as NodeHdlCount. See Constants of Array Lengths (MAX_ELEMENTS_MONITORLIST)
B	SyncMode	UAMonitoringSyncMode	See UAMonitoringSyncMode See chapter 4.2 Monitored Items for general concept of SyncModes 0 = UAMSync_Unknown Default, this results into an error code – has to be set to one of the following options 1 = UAMS_ControllerSync 2 = UAMS_FwSync
B	NodeAddInfos	ARRAY OF UANodeAdditionalInfo	See UANodeAdditionalInfo. Specifies the attribute and IndexRange. See Constants of Array Lengths (MAX_ELEMENTS_MONITORLIST) This parameter is optional. If not existing, the UAAI_Value (13) will be taken from internal implementation.
B	Timeout	TIME	Time to response.
VAR_OUTPUT
B	Done	BOOL	FB has completed its task.
B	Busy	BOOL	The FB is not finished and new output values are to be expected.
B	Error	BOOL	Signals that an error has occurred within the FB.
B	ErrorID	DWORD	Error code.
B	NodeErrorIDs	ARRAY OF DWORD	Array of DWORD. Contains an error code for each element of the Variables array. Length is vendor-specific (MAX_ELEMENTS_MONITORLIST). See Constants of Array Lengths. Shall be the same length than NodeHdlCount.
B	MonitoredItemHdls	ARRAY OF DWORD	Array of monitored item handles. Length is vendor-specific (MAX_ELEMENTS_MONITORLIST). See Constants of Array Lengths. Shall be the same length than NodeHdlCount.
VAR_IN_OUT
B	Variables	ARRAY OF UAMonitoredVariables	See UAMonitoredVariables. Length is vendor-specific (MAX_ELEMENTS_MONITORLIST). See Constants of Array Lengths. Shall be the same length as NodeHdlCount
B	MonitoringParameter	ARRAY OF UAMonitoringParameter	See UAMonitoringParameter Length is vendor-specific (MAX_ELEMENTS_MONITORLIST). See Constants of Array Lengths. Shall be the same length as NodeHdlCount.
B	ValuesChanged	ARRAY OF BOOL	Indicates that the values of the monitored item have been changed. Length is vendor-specific (MAX_ELEMENTS_MONITORLIST). Shall be the same length as NodeHdlCount. See Constants of Array Lengths
B	MinLostValueCount	ARRAY OF UINT	Count the minimum lost values if queue size is > 1 – see also UAMonitoredVariables.
Notes: VAR_IN_OUT: „Variables” as would provide best type save solution for users: The client firmware is able to map the UA memory layout to the controller layout. The firmware client can receive the type definition from the OPC UA Server. Workaround would be to provide a byte array as “Variables” and the firmware client just provide the blob (UA memory layout – so called “raw data”) into that byte array. A “Variable” could be the name of the variable so the internal firmware can get address, length, data type of variable.

	UA_MonitoredItemAddList
BOOL	Execute	Done	BOOL
DWORD	SubscriptionHdl	Busy	BOOL
UINT	NodeHdlCount	Error	BOOL
ARRAY OF DWORD	NodeHdls	ErrorID	DWORD
UAMonitoringSyncMode	SyncMode	NodeErrorIDs	ARRAY OF DWORD
ARRAY OF UANodeAdditionalInfo	NodeAddInfos	MonitoredItemHdls	ARRAY OF DWORD
TIME	Timeout

ARRAY OF UAMonitoredVariables	Variables	Variables	ARRAY OF UAMonitoredVariables
ARRAY OF UAMonitoringParameter	MonitoringParameter	MonitoringParameter	ARRAY OF UAMonitoringParameter
ARRAY OF BOOL	ValuesChanged	ValuesChanged	ARRAY OF BOOL
ARRAY OF UINT	MinLostValueCount	MinLostValueCount	ARRAY OF UINT