BACnetClientDeleteObject.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

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

BACnetClientCreateObject.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientProperty ¶ Function blocks for BACnet client functionalities in the area of BACnet properties are collected in this folder. BACnetClientAddListElement (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientReadAllPropertyDataContents (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientReadProperty (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientReadPropertyMultiple (FunctionBlock) FreeResult (Method) HasResult (Method) Request (Method) SampleInputs (Method) BACnetClientReadRange (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientRemoveListElement (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientSubscribeCOV (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientSubscribeCOVProperty (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientWriteProperty (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientWritePropertyMultiple (FunctionBlock) Request (Method) SampleInputs (Method)

BACnetClientAddListElement (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientAddListElement EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Add-List-Element-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the Add-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 added. 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 add a list element to. objInst CmpBACnet.IEC_BACNET_DWORD The instance number of the object under the targeted device to add a list element to. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property of the object under the targeted device to add a list element to. nIndex CmpBACnet.IEC_BACNET_SIGNED The Index of the element in the property, where the elements of property Contents shall be added. elements CmpBACnet.IEC_BACNET_PROPERTY_CONTENTS The elements to be written into the property (compare elements.nElements). Output firstFailed CmpBACnet.IEC_BACNET_UNSIGNED If the Add-List-Element-Request failed, this variable holds the index of the first element, which failed to be added. 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)

BACnetClientLifeSafetyOperation ¶ BACnetClientLifeSafetyOperation (FunctionBlock) Request (Method) SampleInputs (Method)

BACnetClientLifeSafetyOperation (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientLifeSafetyOperation EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to send a LifeSafetyOperation-Request 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 fSafetyObjectIdPresent CmpBACnet.IEC_BACNET_BOOLEAN If set to true the objectID parameter is valid and present. processID CmpBACnet.IEC_BACNET_UNSIGNED The processID attribute is the numeric identifier of the Process within the client which shall receive the notifications. requestingSource CmpBACnet.IEC_BACNET_STRING This attribute specifies the identity of the human operator that initiates this service request. eRequest CmpBACnet.IEC_BACNET_LIFE_SAFETY_OPERATION This attribute specifies the requested operation (which may take on one of the standard values: NONE, SILENCE, SILENCE_AUDIBLE, SILENCE_VISUAL, RESET, RESET_ALARM, RESET_FAULT). objectID CmpBACnet.IEC_BACNET_OBJECT_ID The object ID attribute is optional. If it is omitted the request is interpreted as an operation on all applicable objects within the receiving device. The mask attribute indicates if the object ID is present. 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)

BACnetClientWriteStreamFile (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientWriteStreamFile EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Write-Stream-File-Reqeust in the BACnet-Network. If execution completed successfully and xDone is TRUE, result is filled with valid data (describing the write access), 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 objFileInst CmpBACnet.IEC_BACNET_DWORD The instance of the file object under the targeted device to read the file data from. startPosition CmpBACnet.IEC_BACNET_SIGNED Start position in the file of the file object to start reading. octetCount CmpBACnet.IEC_BACNET_UNSIGNED Number of octets (bytes) to be read from the file of the file object. pOctetBuffer POINTER TO CmpBACnet.IEC_BACNET_BYTE The buffer (with size octetCount) to write into the file. Output result CmpBACnet.IEC_BACNET_WRITE_FILE_RESULT If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the wrtie file requedt. 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)

BACnetClientWriteStreamFile.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

BACnetClientReadStreamFile (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientReadStreamFile EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Read-Stream-File-Reqeust in the BACnet-Network. If execution completed successfully and xDone is TRUE, result is filled with valid data (the read file 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 objFileInst CmpBACnet.IEC_BACNET_DWORD The instance of the file object under the targeted device to read the file data from. startPosition CmpBACnet.IEC_BACNET_SIGNED Start position in the file of the file object to start reading. octetCount CmpBACnet.IEC_BACNET_UNSIGNED Number of octets (bytes) to be read from the file of the file object. Output result CmpBACnet.IEC_BACNET_READ_FILE_RESULT If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the read file. This data is an octet (byte) stream, which can be found in this structure. 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)