BACnetClientReadProperty.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

BACnetClientWriteAllPropertyDataContents.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientWriteProperty (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientWriteProperty EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Write-Property-Request in the BACnet-Network. 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 objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the object under the targeted device to write the property to. objInst CmpBACnet.IEC_BACNET_DWORD The instance number of the object under the targeted device to write the property to. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property of the object under the targeted device to write. nWritePriority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the property. Must be a value within 1..16. propertyContents CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS The contents to be written into the property. nIndex CmpBACnet.IEC_BACNET_ARRAY_INDEX CmpBACnet.CONSTANTS.BACNET_VOID_INDEX Optional : The Index of the element of the property written. Only use for constant array properties. Otherwise use index BACNET_VOID_INDEX or leave empty. pValueSrc POINTER TO CmpBACnet.IEC_BACNET_AUDIT_VALUE_SOURCE 0 Optional : A pointer to a data structure which contains the value source information for generating an logged and/or reported audit notification for this initiated request. If generating an logged and/or reported audit notification for this request is not intended, pValueSrc can be set to 0. 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)

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

BACnetClientWritePropertyMultiple (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientWritePropertyMultiple EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Write-Property-Multiple-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the Write-Multiple-Request was successful. In any other case eStatus and errorResult may hold additional information of what failed, whereas firstFailed may hold the index of the first property which could not be written. 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 nListCount CmpBACnet.IEC_BACNET_UNSIGNED Number of Write-Property-Lists given in the POINTER writeSpec. writeSpec POINTER TO CmpBACnet.IEC_BACNET_WRITE_LIST Write-Property-Lists identifying the properties to be written. pValueSrc POINTER TO CmpBACnet.IEC_BACNET_AUDIT_VALUE_SOURCE 0 Optional : A pointer to a data structure which contains the value source information for generating an logged and/or reported audit notification for this initiated request. If generating an logged and/or reported audit notification for this request is not intended, pValueSrc can be set to 0. Output firstFailed CmpBACnet.IEC_BACNET_DEV_OBJ_PROP_REFERENCE If the Write-Property-Multiple-Request failed, this variable holds the property which first failed to be written. 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)

BACnetClientWritePropertyMultiple.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

IBACnetClient (ITF) ¶ INTERFACE PUBLIC IBACnetClient EXTENDS IBACnetEmpty An interface to identify BACnet client function blocks. BACnetClient instances could be declared in the device tree - like BACnet server FB instances inheriting from IBACnetStaticObjectBase. In this case they are registered with the BACnetServer automatically in there Initialize() method. Additionally they can be declared just in IEC code, which than requires an explicite call to RegisterToServer() / UnregisterFromServer(), whenever appropriate. Usually RegisterToServer() should be called immediately after creation - if possible in fb_init(), but this depends on your general initialization scenario - and UnregisterFromServer() should be called immediately before deletion (for example in fb_exit()). Properties: Instance SourceDeviceAddress SourceDeviceNumber TargetDeviceAddress TargetDeviceNumber Methods: RegisterToServer UnregisterFromServer Structure: Instance (Property) RegisterToServer (Method) SourceDeviceAddress (Property) SourceDeviceNumber (Property) TargetDeviceAddress (Property) TargetDeviceNumber (Property) UnregisterFromServer (Method)

IBACnetClient.UnregisterFromServer (METH) ¶ METHOD UnregisterFromServer : UDINT Unregister a BACnet-Client-FB from its parent BACnet-Server-FB. Using this function enables one to dynamically create/delete BACnet-Client-FBs, which were not inserted via the device tree. Return CmpErrors.Errors.ERR_OK if successful. InOut: Scope Name Type Return UnregisterFromServer UDINT

IBACnetClient.TargetDeviceNumber (PROP) ¶ PROPERTY TargetDeviceNumber : DWORD

IBACnetClient.RegisterToServer (METH) ¶ METHOD RegisterToServer : UDINT Register an empty/freshly created BACnet-Client-FB with its parent BACnet-Server-FB. If the FB was created by a device this initialization is automatically done during Initialization. Using this function enables one to dynamically create BACnet-Client-FBs, which were not inserted via the device tree. Return CmpErrors.Errors.ERR_OK if successful. InOut: Scope Name Type Return RegisterToServer UDINT Input itfBACnetServer IBACnetServer