BACnetClientAuditLogQuery.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

BACnetClientAuditLogQuery (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientAuditLogQuery EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Audit-Log-Query-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the Audit-Log-Query-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 serviceInfo CmpBACnet.IEC_BACNET_AUDIT_LOG_QUERY_REQUEST_INFO This variable describes the requested information. 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 result CmpBACnet.IEC_BACNET_AUDIT_LOG_QUERY_RESPONSE_INFO If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the result of the request. 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 Request SampleInputs InitializeOutputs , inherited from BACnetClientBase RegisterToServer , inherited from BACnetClientBase UnregisterFromServer , inherited from BACnetClientBase Structure: FreeResult (Method) HasResult (Method) Request (Method) SampleInputs (Method)

BACnetClientGetEventInfo (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientGetEventInfo EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Get-Enrollment-Summary-Reqeust in the BACnet-Network. If execution completed successfully, xDone is set to TRUE. 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 xLastReceivedPresent BOOL Determines whether the following lastReceivedType and lastReceivedInst parameters shall be used. lastReceivedType CmpBACnet.IEC_BACNET_OBJECT_TYPE Type of the last object type received by the GetEventInfo call. lastReceivedInst CmpBACnet.IEC_BACNET_DWORD Type of the last object instance received by the GetEventInfo call. Output result CmpBACnet.IEC_BACNET_EVENT_INFO If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the event info. 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)

BACnetClientBase (FB) ¶ FUNCTION_BLOCK PUBLIC BACnetClientBase EXTENDS CBML.ETrigATo IMPLEMENTS IBACnetClient , IBACnetClientInternal Base class for all BACnet-Client-FBs. It hold both source Address and target Address for the BACnet-Client-FBs. The source address gets automatically set to the device of the parent BACnet-Server-FB (in the device tree BACnet-Clients are always childs of BACnet-Servers). The target address has to be set (TargetDeviceAddress-, TargetDeviceNumber Property) before any call to the other functions of the BACnet-Client-FBs. 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. 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. 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. Output eStatus CmpBACnet.IEC_BACNET_STATUS CmpBACnet.IEC_BACNET_STATUS.BACNET_STATUS_OK If an error occured, the error state. 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. 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 Properties: Instance Running Server SourceDeviceAddress SourceDeviceNumber TargetDeviceAddress TargetDeviceNumber Methods: InitializeOutputs RegisterToServer Request SampleInputs UnregisterFromServer Structure: InitializeOutputs (Method) Instance (Property) RegisterToServer (Method) Request (Method) Running (Property) SampleInputs (Method) Server (Property) SourceDeviceAddress (Property) SourceDeviceNumber (Property) TargetDeviceAddress (Property) TargetDeviceNumber (Property) UnregisterFromServer (Method)

BACnetClientAuditLogQuery.HasResult (METH) ¶ METHOD PROTECTED HasResult : BOOL InOut: Scope Name Type Return HasResult BOOL

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

BACnetClientGetEventInfo.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientAuditLog ¶ BACnetClientAuditLogQuery (FunctionBlock) FreeResult (Method) HasResult (Method) Request (Method) SampleInputs (Method)

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

BACnetClientGetEventInfo.HasResult (METH) ¶ METHOD PROTECTED HasResult : BOOL InOut: Scope Name Type Return HasResult BOOL