BACnetClientConfPrivateTransfer (FB)

FUNCTION_BLOCK PUBLIC FINAL BACnetClientConfPrivateTransfer EXTENDS BACnetClientBase

Common Behaviour Model conform (ETrigA) FB to execute a ConfirmedPrivateTransfer-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

nVendorID

CmpBACnet.IEC_BACNET_UNSIGNED

This parameter, of type Unsigned, specifies the unique vendor identification code for the type of vendor-proprietary service to be performed.

nServiceNumber

CmpBACnet.IEC_BACNET_UNSIGNED

This parameter, of type Unsigned, specifies the desired service to be performed.

fParametersPresent

CmpBACnet.IEC_BACNET_BOOLEAN

If set to True the parameters value is valid.

parameters

CmpBACnet.IEC_BACNET_BUFFER

This optional parameter shall transport additional parameters for the service specified by ‘Vendor ID’ and ‘Service Number’. The datatype and interpretation of these parameters is a local matter.

nByteCount

CmpBACnet.IEC_BACNET_UNSIGNED

This is the size of the filled bytes in the parameters buffer on reply to the confirmed service variant of this type.

Output

result

CmpBACnet.IEC_BACNET_PRIVATE_TRANSFER_INFO

If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the result of the request.

Properties:

Methods:

Structure: