BACnetClientBase (FB)¶
FUNCTION_BLOCK PUBLIC BACnetClientBase EXTENDS CBML.ETrigATo IMPLEMENTS IBACnetClient, IBACnetClientInternal
Base class for all BACnet-Client-FBs. It hold both source Address and target Address for the BACnet-Client-FBs. The source address gets automatically set to the device of the parent BACnet-Server-FB (in the device tree BACnet-Clients are always childs of BACnet-Servers). The target address has to be set (TargetDeviceAddress-, TargetDeviceNumber Property) before any call to the other functions of the BACnet-Client-FBs.
- InOut:
Scope
Name
Type
Initial
Comment
Inherited from
Input
xExecute
BOOL
Rising edge: Starts defined operationFALSE
: Resets the defined operation after ready condition was reachedETrigATo
xAbort
BOOL
TRUE
: Aborts the operationETrigATo
udiTimeOut
UDINT
Max. operating time for executing [µs], 0: No operating time limit
ETrigATo
Output
xDone
BOOL
TRUE
: Ready condition reachedETrigATo
xBusy
BOOL
TRUE
: Operation is runningETrigATo
xError
BOOL
TRUE
: Error condition reachedETrigATo
xAborted
BOOL
TRUE
: Abort condition reachedETrigATo
Input
dwTargetDeviceNumber
DWORD
The device number of the targeted device in the BACnet- Network.
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.
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.
Output
eStatus
CmpBACnet.IEC_BACNET_STATUS
CmpBACnet.IEC_BACNET_STATUS.BACNET_STATUS_OK
If an error occured, the error state.
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.
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
Properties:
Methods:
Structure:
- InitializeOutputs (Method)
- Instance (Property)
- RegisterToServer (Method)
- Request (Method)
- Running (Property)
- SampleInputs (Method)
- Server (Property)
- SourceDeviceAddress (Property)
- SourceDeviceNumber (Property)
- TargetDeviceAddress (Property)
- TargetDeviceNumber (Property)
- UnregisterFromServer (Method)