BACNetClientGetEnrollmentSummary.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientAcknowledgeAlarm (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientAcknowledgeAlarm EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Acknowledge-Alarm-Reqeust in the BACnet-Network. If the 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 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 processID CmpBACnet.IEC_BACNET_UNSIGNED The ID of the process to acknowledge the alarms with. eventObjInst CmpBACnet.IEC_BACNET_DWORD The object instance to acknowledge the alarms for. eventObjType CmpBACnet.IEC_BACNET_OBJECT_TYPE The object type to acknowledge the alarms for. eventState CmpBACnet.IEC_BACNET_EVENT_STATE Event state to be acknowledged. timeStamp CmpBACnet.IEC_BACNET_TIME_STAMP Time Stamp of the acknowledgement. ackSource WSTRING(255) Identifier of the source of acknowledgement. ackTime CmpBACnet.IEC_BACNET_TIME_STAMP CHECK: BACN-200 Time of the acknowledgemnent. 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)

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 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)

BACnetClientGetEventInfo.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

BACnetClientGetAlarmSummary (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientGetAlarmSummary EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Get-Alarm-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 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 result CmpBACnet.IEC_BACNET_ALARM_INFO If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the alarm summary. 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)

BACnetClientGetAlarmSummary.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

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. 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)

BACnetClientBase.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

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

BACnetClientGetAlarmSummary.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs