BACnetClientWriteAllPropertyDataContents (FB)

FUNCTION_BLOCK PUBLIC FINAL BACnetClientWriteAllPropertyDataContents EXTENDS BACnetClientBase

Common Behaviour Model conform (ETrigA) FB to write all property contained data at once.

Tries to write all given property data contents at once so the application does not need to handle different errors and use fallbacks to bypass this errors (like breaking down array or lists into their elements to transmit them).

If execution completed successfully and xDone is TRUE, the Write-Request was successful. In any other case eStatus and errorResult may hold additional information of what failed.

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

objectID

CmpBACnet.IEC_BACNET_OBJECT_ID

The object identifier which property should be accessed.

ePropertyID

CmpBACnet.IEC_BACNET_PROPERTY_ID

The property identifier specifies the property to be accessed.

nIndex

CmpBACnet.IEC_BACNET_ARRAY_INDEX

The index specifies if a single element or the whole array is accessed.

nWritePriority

CmpBACnet.IEC_BACNET_PRIORITY_LEVEL

This parameter is an integer in the range 1-16, which indicates the priority assigned to this write operation.

sValue

CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS

If the access is successful this parameter shall be used to replace the current value of the property.

Properties:

Methods:

Structure: