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

pAPDUParams

POINTER TO CmpBACnet.IEC_BACNET_APDU_PROPERTIES

0

A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL.

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.

pValueSrc

POINTER TO CmpBACnet.IEC_BACNET_AUDIT_VALUE_SOURCE

0

Optional: A pointer to a data structure which contains the value source information for generating an logged and/or reported audit notification for this initiated request. If generating an logged and/or reported audit notification for this request is not intended, pValueSrc can be set to 0.

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:

Methods:

Structure: