BACnetClientReadProperty (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientReadProperty EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Read-Property-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, result is filled with valid data, in any other case the data in result are not valid. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigATo xAbort BOOL TRUE : Aborts the operation ETrigATo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigATo Output xDone BOOL TRUE : Ready condition reached ETrigATo xBusy BOOL TRUE : Operation is running ETrigATo xError BOOL TRUE : Error condition reached ETrigATo xAborted BOOL TRUE : Abort condition reached ETrigATo Input dwTargetDeviceNumber DWORD The device number of the targeted device in the BACnet- Network. BACnetClientBase pTargetDeviceAddress POINTER TO CmpBACnet.IEC_BACNET_ADDRESS 0 Optional : The device address of the targeted device in the BACnet-Network. If an adress is given the given device number is ignored. BACnetClientBase Output eStatus CmpBACnet.IEC_BACNET_STATUS CmpBACnet.IEC_BACNET_STATUS.BACNET_STATUS_OK If an error occured, the error state. BACnetClientBase errorResult CmpBACnet.IEC_BACNET_ERROR STRUCT(tag := CmpBACnet.IEC_BACNET_FAILURE_TYPE._FAILURE_MAX_SIZE) If an error occured (this means eStatus <> BACNET_STATUS_OK), whereas the sent BACnet-Request was answered with an specific error information, the latter is contained in this structure. BACnetClientBase iState DINT 0 The State in which the FB is during execution: 0: No execution, resetted state 1: Searching for the Target-Device and a valid address for it 2: Sending the BACnet-Request into the network 3: Waiting for the answer (if there is one) to the BACnet-Request made in 2 4: Finishing the call, setting of the output variables BACnetClientBase Input objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the object under the targeted device to read the property from. objInst CmpBACnet.IEC_BACNET_DWORD The instance number of the object under the targeted device to read the property from. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property of the object under the targeted device to read. nIndex CmpBACnet.IEC_BACNET_SIGNED -1 Optional : The Index of the element of the property read. Only use for constant array properties. Otherwise use index -1 or leave empty. Output result CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the read property. Use the helper functions GetRealFromContents, Get… to evaluate its value (for simple property types). Otherwise be sure to correctly interpretate the contents data. Properties: Instance , inherited from BACnetClientBase Running , inherited from BACnetClientBase Server , inherited from BACnetClientBase SourceDeviceAddress , inherited from BACnetClientBase SourceDeviceNumber , inherited from BACnetClientBase TargetDeviceAddress , inherited from BACnetClientBase TargetDeviceNumber , inherited from BACnetClientBase Methods: FreeResult HasResult InitializeOutputs Request SampleInputs RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method)

BACnetClientReadProperty.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

BACnetClientReadPropertyMultiple (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientReadPropertyMultiple EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Read-Property-Multiple-Reqeust in the BACnet-Network. If execution completed successfully and xDone is TRUE, result is filled with valid data, in any other case the data in result are not valid. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Starts defined operation FALSE : Resets the defined operation after ready condition was reached ETrigATo xAbort BOOL TRUE : Aborts the operation ETrigATo udiTimeOut UDINT Max. operating time for executing [µs], 0: No operating time limit ETrigATo Output xDone BOOL TRUE : Ready condition reached ETrigATo xBusy BOOL TRUE : Operation is running ETrigATo xError BOOL TRUE : Error condition reached ETrigATo xAborted BOOL TRUE : Abort condition reached ETrigATo Input dwTargetDeviceNumber DWORD The device number of the targeted device in the BACnet- Network. BACnetClientBase pTargetDeviceAddress POINTER TO CmpBACnet.IEC_BACNET_ADDRESS 0 Optional : The device address of the targeted device in the BACnet-Network. If an adress is given the given device number is ignored. BACnetClientBase Output eStatus CmpBACnet.IEC_BACNET_STATUS CmpBACnet.IEC_BACNET_STATUS.BACNET_STATUS_OK If an error occured, the error state. BACnetClientBase errorResult CmpBACnet.IEC_BACNET_ERROR STRUCT(tag := CmpBACnet.IEC_BACNET_FAILURE_TYPE._FAILURE_MAX_SIZE) If an error occured (this means eStatus <> BACNET_STATUS_OK), whereas the sent BACnet-Request was answered with an specific error information, the latter is contained in this structure. BACnetClientBase iState DINT 0 The State in which the FB is during execution: 0: No execution, resetted state 1: Searching for the Target-Device and a valid address for it 2: Sending the BACnet-Request into the network 3: Waiting for the answer (if there is one) to the BACnet-Request made in 2 4: Finishing the call, setting of the output variables BACnetClientBase Input nListCount CmpBACnet.IEC_BACNET_UNSIGNED Number of Read-Lists given by the POINTER readSpec. readSpec POINTER TO CmpBACnet.IEC_BACNET_READ_LIST Read-Lists, which define objects and properties to be read by the Read-Property-Multiple-Request. Output result CmpBACnet.IEC_BACNET_READ_RAW_RESULT_LIST If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the read properties. Eventually use the helper functions GetRealFromContents, Get… to evaluate the property values. Otherwise be sure to correctly interpretate the contents data. Properties: Instance , inherited from BACnetClientBase Running , inherited from BACnetClientBase Server , inherited from BACnetClientBase SourceDeviceAddress , inherited from BACnetClientBase SourceDeviceNumber , inherited from BACnetClientBase TargetDeviceAddress , inherited from BACnetClientBase TargetDeviceNumber , inherited from BACnetClientBase Methods: FreeResult HasResult Request SampleInputs InitializeOutputs , inherited from BACnetClientBase RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: FreeResult (Method) HasResult (Method) Request (Method) SampleInputs (Method)

BACnetClientReadPropertyMultiple.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

BACnetClientReadAllPropertyDataContents.HasResult (METH) ¶ METHOD PROTECTED HasResult : BOOL InOut: Scope Name Type Return HasResult BOOL

BACnetClientReadAllPropertyDataContents.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

BACnetClientReadAllPropertyDataContents.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS

BACnetClientReadAllPropertyDataContents.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientReadPropertyMultiple.HasResult (METH) ¶ METHOD PROTECTED HasResult : BOOL InOut: Scope Name Type Return HasResult BOOL

BACnetClientReadPropertyMultiple.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS