BACnetClientBackupBACnetDevice (FB)

FUNCTION_BLOCK PUBLIC FINAL BACnetClientBackupBACnetDevice EXTENDS BACnetClientBase

Common Behaviour Model conform (ETrigA) FB to initiates a backup procedure for an BACnet device. If execution completed successfully and xDone is TRUE, the 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

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

deviceInstance

CmpBACnet.IEC_BACNET_DWORD

The device instance number to backup.

password

CmpBACnet.IEC_BACNET_STRING

The optional password needed for the backup procedure. If no password is needed for this procedure set the string type to BACNET_STRING_NONE.

pathToStoredFiles

POINTER TO CmpBACnet.IEC_BACNET_BYTE

The path to the storage location of file object data received.

callback

CmpEventMgr.ICmpEventCallback

An event-callback interface to inform about failures and progress information during the procedure execution.

Properties:

Methods:

Structure: