BACnetClientConfTextMessage.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs
IBACnetLIST_of_BACnetAuthorizationExemption.GetContent (METH) ¶ METHOD GetContent : CmpBACnet.IEC_BACNET_STATUS Get the whole content of this property. After usage, use FreeStackAllocatedMemory , to free the used memory. InOut: Scope Name Type Comment Return GetContent CmpBACnet.IEC_BACNET_STATUS Output pData POINTER TO CmpBACnet.IEC_BACNET_AUTHORIZATION_EXEMPTION Property content. After usage, use FreeStackAllocatedMemory , to free the used memory. count CmpBACnet.IEC_BACNET_ELEMENT_COUNT Number of property elements.
BACnetClientBackupBACnetDevice.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS
BACnetClientConfTextMessage (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientConfTextMessage EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to send a confirmed TextMessage in the BACnet-Network. 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 fMessageClassPresent CmpBACnet.IEC_BACNET_BOOLEAN If set to True the messageClass parameter is valid and present. messageClass CmpBACnet.IEC_BACNET_MESSAGE_CLASS This parameter, if present, indicates the class of the received message. The datatype of this parameter shall be a choice of Unsigned or Character String. The interpretation of the meaning of any particular value for this parameter shall be a local matter. eMessagePriority CmpBACnet.IEC_BACNET_MESSAGE_PRIORITY This parameter indicates the priority for message handling: NORMAL or URGENT. messageText CmpBACnet.IEC_BACNET_STRING This parameter, of type CharacterString, will be used to transport the text message. 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.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs
BACnetClientReadRange (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientReadRange EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Read-Range-Reqeust in the BACnet-Network. Ifexecution 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 objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the object under the targeted device to read the range from. objInst CmpBACnet.IEC_BACNET_DWORD The instance number of the object under the targeted device to read the range from. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property of the object under the targeted device to read the range from. rangeType CmpBACnet.IEC_BACNET_RANGE_TYPE The type of the range to be read. range CmpBACnet.IEC_BACNET_READ_RANGE_RANGE The type dependant range to be read. nIndex CmpBACnet.IEC_BACNET_SIGNED -1 Optional : The Index of the element of the property read. Only use for constant array properties. Otherwise use index -1 or leave empty. Output result CmpBACnet.IEC_BACNET_READ_RANGE_RESULT If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the read property. Use the helper functions GetRealFromContents, Get… to evaluate its value (for simple property types). Otherwise be sure to correctly interpretate the contents data. 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: FreeResult HasResult InitializeOutputs Request SampleInputs RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method)
BACnetClientReadRange.FreeResult (METH) ¶ METHOD PROTECTED FreeResult
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