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)
BACnetClientDeleteObject (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientDeleteObject EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Delete-Object-Reqeust in the BACnet-Network. If execution completed successfully and xDone is TRUE no additional variable gets its contents updated, but it is indicated, that the deletion succeeded. 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 to be deleted. objInst CmpBACnet.IEC_BACNET_DWORD The instance number of the object to be deleted. 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)
BACnetClientDeleteObject.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs
BACnetClientConfPrivateTransfer.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs
BACnetClientConfPrivateTransfer.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS
BACnetClientBackupBACnetDevice.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS
BACnetClientBackupBACnetDevice.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs
BACnetClientConfTextMessage.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS
BACnetClientConfTextMessage.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs
BACnetClientDeleteObject.Request (METH) ¶ METHOD PROTECTED Request : CmpBACnet.IEC_BACNET_STATUS InOut: Scope Name Type Return Request CmpBACnet.IEC_BACNET_STATUS