IBackgroundTask.TaskDisableScheduling (METH) ¶ METHOD TaskDisableScheduling : BOOL Disable scheduling for this task InOut: Scope Name Type Comment Return TaskDisableScheduling BOOL TRUE => Scheduling is disabled, FALSE => Operation failed
IBackgroundTask.TaskDisableWatchdog (METH) ¶ METHOD TaskDisableWatchdog : BOOL Disable watchdog for this task Note Can be called nested. First call disables the watchdog InOut: Scope Name Type Comment Return TaskDisableWatchdog BOOL TRUE => Operation successful, FALSE => Operation failed
IBackgroundTask.TaskEnableScheduling (METH) ¶ METHOD TaskEnableScheduling : BOOL Enable scheduling for this task InOut: Scope Name Type Comment Return TaskEnableScheduling BOOL TRUE => Scheduling is enabled, FALSE => Operation failed
IBackgroundTask.TaskEnableWatchdog (METH) ¶ METHOD TaskEnableWatchdog : BOOL Enable watchdog for this task Note Can be called nested. Last call enables the watchdog InOut: Scope Name Type Comment Return TaskEnableWatchdog BOOL TRUE => Operation successful, FALSE => Operation failed
IBackgroundTask.TaskResetStatistics (METH) ¶ METHOD TaskResetStatistics : BOOL Reset the task statistics of this task InOut: Scope Name Type Comment Return TaskResetStatistics BOOL TRUE => Statistic is reseted, FALSE => Operation failed
IBACnetLIST_of_BACnetAccessZoneOccupancyState.AddElement (METH) ¶ METHOD AddElement : CmpBACnet.IEC_BACNET_STATUS Add element to the end of this property. InOut: Scope Name Type Comment Return AddElement CmpBACnet.IEC_BACNET_STATUS Inout Const value CmpBACnet.IEC_BACNET_ACCESS_ZONE_OCCUPANCY_STATE Element value to add.
BACnetClientAlarmsEvents ¶ Function blocks for BACnet client functionalities in the area of BACnet alarms and BACnet events are collected in this folder. BACNetClientGetEnrollmentSummary (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientAcknowledgeAlarm (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientGetAlarmSummary (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientGetEventInfo (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method)
IBACnetLIST_of_BACnetAccessEvent.UpdateElement (METH) ¶ METHOD UpdateElement : CmpBACnet.IEC_BACNET_STATUS Update the element of this property at the given index. InOut: Scope Name Type Comment Return UpdateElement CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ARRAY_INDEX Index (0 .. number of elements-1). Inout Const value CmpBACnet.IEC_BACNET_ACCESS_EVENT Element value to write.
BACnetClient ¶ Function blocks for BACnet client functionialities are collected in this folder. BACnetClientAlarmsEvents BACNetClientGetEnrollmentSummary (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientAcknowledgeAlarm (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientGetAlarmSummary (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientGetEventInfo (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientBase (FunctionBlock) InitializeOutputs (Method) Instance (Property) RegisterToServer (Method) Request (Method) Running (Property) SampleInputs (Method) Server (Property) SourceDeviceAddress (Property) SourceDeviceNumber (Property) TargetDeviceAddress (Property) TargetDeviceNumber (Property) UnregisterFromServer (Method) BACnetClientConfirm BACnetClientConfPrivateTransfer (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientConfTextMessage (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientDeviceManagement BACnetClientBackupBACnetDevice (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientCreateObject (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientDeleteObject (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientDeviceCommControl (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientReinitializeDevice (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientRestoreBACnetDevice (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientTimeSynchronization (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientUTCTimeSynchronization (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientFile BACnetClientReadStreamFile (FunctionBlock) FreeResult (Method) HasResult (Method) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientWriteStreamFile (FunctionBlock) InitializeOutputs (Method) Request (Method) SampleInputs (Method) BACnetClientLifeSafetyOperation BACnetClientLifeSafetyOperation (FunctionBlock) Request (Method) SampleInputs (Method) BACnetClientProperty 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) IBACnetClient (Interface) Instance (Property) RegisterToServer (Method) SourceDeviceAddress (Property) SourceDeviceNumber (Property) TargetDeviceAddress (Property) TargetDeviceNumber (Property) UnregisterFromServer (Method)
BACnetClientWritePropertyMultiple (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientWritePropertyMultiple EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to execute a Write-Property-Multiple-Request in the BACnet-Network. If execution completed successfully and xDone is TRUE, the Write-Multiple-Request was successful. In any other case eStatus and errorResult may hold additional information of what failed, whereas firstFailed may hold the index of the first property which could not be written. 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 nListCount CmpBACnet.IEC_BACNET_UNSIGNED Number of Write-Property-Lists given in the POINTER writeSpec. writeSpec POINTER TO CmpBACnet.IEC_BACNET_WRITE_LIST Write-Property-Lists identifying the properties to be written. Output firstFailed CmpBACnet.IEC_BACNET_DEV_OBJ_PROP_REFERENCE If the Write-Property-Multiple-Request failed, this variable holds the property which first failed to be written. 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)