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 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_SIGNED -1 Optional : The Index of the element of the property written. Only use for constant array properties. Otherwise use index -1 or leave empty. 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)

BACnetClientReadRange.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientRemoveListElement (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientRemoveListElement EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Remove-List-Element-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the Remove-List-Element-Request was successful. In any other case eStatus and errorResult may hold additional information of what failed and firstFailed holds the index of the first element, which failed to be removed. 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 objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the object under the targeted device to remove a list element from. objInst CmpBACnet.IEC_BACNET_DWORD The instance number of the object under the targeted device to remove a list element from. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property of the object under the targeted device to remove a list element from. nIndex CmpBACnet.IEC_BACNET_SIGNED The Index of the element in the property, where the elements of property Contents shall be removed. elements CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS The elements to be removed from the property (compare elements.nElements). Output firstFailed CmpBACnet.IEC_BACNET_UNSIGNED If the Remove-List-Element-Request failed, this variable holds the index of the first element, which failed to be removed. 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)

BACnetClientRemoveListElement.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientSubscribeCOV (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientSubscribeCOV EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Subscribe-COV-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the COV-Subscription 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 xSubscribe BOOL TRUE Describes whether the COV subsciption shall be made/renewed or deleted. xIssueConfirmedNotifications BOOL Describes whether confirmed or unconfirmed COV notification shall be send by the COV-Provider. monitoredObjType CmpBACnet.IEC_BACNET_OBJECT_TYPE Object type of the monitored object under the targeted device. monitoredObjInst CmpBACnet.IEC_BACNET_DWORD Object instance of the monitored object under the targeted device. lifetime CmpBACnet.IEC_BACNET_UNSIGNED Lifetime of the COV-Subscription in seconds. Use 0 for infinite lifetime. 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)

BACnetClientRemoveListElement.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

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

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

BACnetClientWriteProperty.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientReadRange.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs