BACnetClientGetEventInfo.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS

BACnetClientGetAlarmSummary.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

BACnetClientGetAlarmSummary.HasResult (METH) ¶ METHOD PROTECTED HasResult : BOOL InOut: Scope Name Type Return HasResult BOOL

BACnetClientGetEventInfo.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

BACnetClientGetEventInfo.HasResult (METH) ¶ METHOD PROTECTED HasResult : BOOL InOut: Scope Name Type Return HasResult BOOL

BACnetClientCreateObject (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientCreateObject EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Create-Object-Reqeust in the BACnet-Network. If execution completed successfully and xDone is TRUE,CreateObjectID holds mthe ID of the created object. If the request fails, firstFailed holds the index of the first property, due to which reason the creation 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 objectSpecifier CmpBACnet.IEC_BACNET_OBJECT_SPECIFIER This parameter contains information about the type of object that is to be created. The datatype is a choice between an object type and an object identifier. If the object type choice is used, the specified object type shall become the value of the Object_Type property of the newly created object and the responding BACnet-user shall select an object identifier. If the object identifier choice is used, an object with this particular object identifier shall be created. bValuesPresent BOOL TRUE If set to True the list of initial values is valid. nValuesCount CmpBACnet.IEC_BACNET_UNSIGNED Number of entries in the list of initial values. pValues POINTER TO CmpBACnet.IEC_BACNET_PROPERTY_VALUE This parameter contains a list of BACnetPropertyValues that will be used to initialize the values of the specified properties of the newly created object. Output createdObjectID CmpBACnet.IEC_BACNET_OBJECT_ID If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the object ID of the created object. firstFailed CmpBACnet.IEC_BACNET_UNSIGNED If the BACnet-Request failed, this variable shall hold the first property, for which the creation of the object failed. Properties: Instance , inherited from BACnetClientBase Running , inherited from BACnetClientBase Server , inherited from BACnetClientBase SourceDeviceAddress , inherited from BACnetClientBase SourceDeviceNumber , inherited from BACnetClientBase TargetDeviceAddress , inherited from BACnetClientBase TargetDeviceNumber , inherited from BACnetClientBase Methods: InitializeOutputs Request SampleInputs RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: InitializeOutputs (Method) Request (Method) SampleInputs (Method)

BACnetClientCreateObject.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

BACnetClientDeviceManagement ¶ Function blocks for BACnet client functionalities in the area of BACnet device management are collected in this folder. BACnetClientBackupBACnetDevice (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientCreateObject (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientDeleteObject (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientDeviceCommControl (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientReinitializeDevice (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientRestoreBACnetDevice (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientTimeSynchronization (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientUTCTimeSynchronization (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method)

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: Instance , inherited from BACnetClientBase Running , inherited from BACnetClientBase Server , inherited from BACnetClientBase SourceDeviceAddress , inherited from BACnetClientBase SourceDeviceNumber , inherited from BACnetClientBase TargetDeviceAddress , inherited from BACnetClientBase TargetDeviceNumber , inherited from BACnetClientBase Methods: Request SampleInputs InitializeOutputs , inherited from BACnetClientBase RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: Request (Method) SampleInputs (Method)

BACnetClientConfPrivateTransfer.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs