Accumulator ¶ The BACnet Accumulator object. BACnetAccumulator (FunctionBlock) AckedTransitions (Property) Description (Property) DeviceType (Property) EventAlgorithmInhibit (Property) EventAlgorithmInhibitRef (Property) EventDetectionEnable (Property) EventEnable (Property) EventMessageTexts (Property) EventMessageTextsConfig (Property) EventState (Property) EventTimeStamps (Property) HighLimit (Property) LimitEnable (Property) LimitMonitoringInterval (Property) LoggingObject (Property) LoggingRecord (Property) LowLimit (Property) MaxPresValue (Property) NotificationClass (Property) NotifyType (Property) OutOfService (Property) Prescale (Property) PresentValue (Property) ProfileName (Property) PulseRate (Property) Reliability (Property) ReliabilityEvaluationInhibit (Property) Scale (Property) StatusFlags (Property) TimeDelay (Property) TimeDelayNormal (Property) Units (Property) ValueBeforeChange (Property) ValueChangeTime (Property) ValueSet (Property)

BACnetAccumulator (FB) ¶ FUNCTION_BLOCK PUBLIC BACnetAccumulator EXTENDS BACnetStaticObjectBase IMPLEMENTS IBACnetAccumulator FB reflecting a BACnet-Accumulator-Object. All Properties of this FB give access to the client writeable BACnet-Properties of the reflected BACnet-Object, although the access is done not client sided (without checking access restrictions). Additionaly access is given for the Present_Value-Property, although the latter is not (always) client side writeable. Moreover access right behaviour which changes due to dynamically changing BACnet-Property-Sets is done by an Event-Callback (BACnetEventCallback), which is attached to the BACNET_CALLBACK_WRITE-Callback. Additionally see documentation of BACnetObjectBase . Properties: AckedTransitions Description DeviceType EventAlgorithmInhibit EventAlgorithmInhibitRef EventDetectionEnable EventEnable EventMessageTexts EventMessageTextsConfig EventState EventTimeStamps HighLimit LimitEnable LimitMonitoringInterval LoggingObject LoggingRecord LowLimit MaxPresValue NotificationClass NotifyType OutOfService Prescale PresentValue ProfileName PulseRate Reliability ReliabilityEvaluationInhibit Scale StatusFlags TimeDelay TimeDelayNormal Units ValueBeforeChange ValueChangeTime ValueSet NumberOfProperties , inherited from BACnetObjectBase ObjectID , inherited from BACnetObjectBase Methods: GetBACnetAccumulatorRecordProperty , inherited from BACnetObjectBase GetBACnetArraySizeOfProperty , inherited from BACnetObjectBase GetBACnetArraySizeOfTwoProperties , inherited from BACnetObjectBase GetBACnetBitStringProperty , inherited from BACnetObjectBase GetBACnetBooleanProperty , inherited from BACnetObjectBase GetBACnetClientCOVProperty , inherited from BACnetObjectBase GetBACnetDateProperty , inherited from BACnetObjectBase GetBACnetDateRangeProperty , inherited from BACnetObjectBase GetBACnetDateTimeProperty , inherited from BACnetObjectBase GetBACnetDevObjPropReferenceProperty , inherited from BACnetObjectBase GetBACnetDoubleProperty , inherited from BACnetObjectBase GetBACnetEnumeratedProperty , inherited from BACnetObjectBase GetBACnetObjPropReferenceProperty , inherited from BACnetObjectBase GetBACnetObjectIDProperty , inherited from BACnetObjectBase GetBACnetPrescaleProperty , inherited from BACnetObjectBase GetBACnetRealProperty , inherited from BACnetObjectBase GetBACnetScaleProperty , inherited from BACnetObjectBase GetBACnetSetpointReferenceProperty , inherited from BACnetObjectBase GetBACnetSignedProperty , inherited from BACnetObjectBase GetBACnetStringProperty , inherited from BACnetObjectBase GetBACnetTimeProperty , inherited from BACnetObjectBase GetBACnetTimeStampProperty , inherited from BACnetObjectBase GetBACnetUnsignedProperty , inherited from BACnetObjectBase GetPropertyAccessRight , inherited from BACnetObjectBase GetPropertyCallbackAttachment , inherited from BACnetObjectBase GetPropertyId , inherited from BACnetObjectBase GetPropertyInstanceStackAllocContentBuffer , inherited from BACnetObjectBase GetPropertyInstanceWithContentBuffer , inherited from BACnetObjectBase IsBACnetDateTimePropertyUnspecified , inherited from BACnetObjectBase IsPropertyExistent , inherited from BACnetObjectBase IsPropertyWriteable , inherited from BACnetObjectBase SetBACnetAccumulatorRecordProperty , inherited from BACnetObjectBase SetBACnetBitStringProperty , inherited from BACnetObjectBase SetBACnetBooleanProperty , inherited from BACnetObjectBase SetBACnetClientCOVProperty , inherited from BACnetObjectBase SetBACnetDateProperty , inherited from BACnetObjectBase SetBACnetDateRangeProperty , inherited from BACnetObjectBase SetBACnetDateTimeProperty , inherited from BACnetObjectBase SetBACnetDateTimePropertyToUnspecified , inherited from BACnetObjectBase SetBACnetDevObjPropReferenceProperty , inherited from BACnetObjectBase SetBACnetDoubleProperty , inherited from BACnetObjectBase SetBACnetEnumeratedProperty , inherited from BACnetObjectBase SetBACnetObjPropReferenceProperty , inherited from BACnetObjectBase SetBACnetObjectIDProperty , inherited from BACnetObjectBase SetBACnetPrescaleProperty , inherited from BACnetObjectBase SetBACnetRealProperty , inherited from BACnetObjectBase SetBACnetScaleProperty , inherited from BACnetObjectBase SetBACnetSetpointReferenceProperty , inherited from BACnetObjectBase SetBACnetSignedProperty , inherited from BACnetObjectBase SetBACnetStringProperty , inherited from BACnetObjectBase SetBACnetTimeProperty , inherited from BACnetObjectBase SetBACnetTimeStampProperty , inherited from BACnetObjectBase SetBACnetUnsignedProperty , inherited from BACnetObjectBase SetObjectName , inherited from BACnetObjectBase SetPropertyAccessRight , inherited from BACnetObjectBase SetPropertyCallbackAttachment , inherited from BACnetObjectBase SetPropertyInstance , inherited from BACnetObjectBase WritePropertyInstance , inherited from BACnetObjectBase Structure: AckedTransitions (Property) Description (Property) DeviceType (Property) EventAlgorithmInhibit (Property) EventAlgorithmInhibitRef (Property) EventDetectionEnable (Property) EventEnable (Property) EventMessageTexts (Property) EventMessageTextsConfig (Property) EventState (Property) EventTimeStamps (Property) HighLimit (Property) LimitEnable (Property) LimitMonitoringInterval (Property) LoggingObject (Property) LoggingRecord (Property) LowLimit (Property) MaxPresValue (Property) NotificationClass (Property) NotifyType (Property) OutOfService (Property) Prescale (Property) PresentValue (Property) ProfileName (Property) PulseRate (Property) Reliability (Property) ReliabilityEvaluationInhibit (Property) Scale (Property) StatusFlags (Property) TimeDelay (Property) TimeDelayNormal (Property) Units (Property) ValueBeforeChange (Property) ValueChangeTime (Property) ValueSet (Property)

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)

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

IBACnetEventConsumer (ITF) ¶ INTERFACE PUBLIC IBACnetEventConsumer Interface which has to be implemented by a FB, which can be registered using BACnetServer.RegisterHook or BACnetServer.RegisterCallback . This Interface gets called whenever the specified event (by the calls of BACnetServer.RegisterHook or BACnetServer.RegisterCallback ) occurs. Methods: BACnetEventCallback Structure: BACnetEventCallback (Method)

IBACnetEventConsumer.BACnetEventCallback (METH) ¶ METHOD BACnetEventCallback : BOOL This method gets called, whenever a event occurs for which the implementing FB is registered via BACnetServer.RegisterHook or BACnetServer.RegisterCallback . Since several FBs implementing IBACnetEventConsumer can be registered for one event or callback the following rules are used for the returned BOOL: If the method returns FALSE, all other registered IBACnetEventConsumer objects for the specified Hook/Callback are further called. If the method return TRUE, the other registeres IBACnetEventConsumer objects are not called anymore. The calling order is as the objects were registered. All calls have to treat on their own, whether the EventIds are correct (see CmpBACnet.EVENTIDS) and/or BACnet-Object-IDs or other additional data fits the needs of the registered FB (i.e. the specific BACnet-Object-FB). InOut: Scope Name Type Comment Return BACnetEventCallback BOOL Input EventId DWORD If only one event is possibly called, the following Ids can be ignored. If there are more at least the EventId should be checked, to get the right type of pParameter. ID of the occured Event. Contains the class and the event (see CmpBACnet.EVENTIDS) usParamId WORD Id of the parameter structure (see pParameter and CmpBACnet.EVENTIDS) usVersion WORD Version of the parameter structure (see pParameter and CmpBACnet.EVENTIDS) pParameter POINTER TO BYTE Pointer to the event specific parameter, that is specified by Id (see CmpBACnet.EVENTIDS and CmpBACnet, i.e. EVT_BACNET_ACKALARM)

BACnetClientWritePropertyMultiple.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

IBACnetClient (ITF) ¶ INTERFACE PUBLIC IBACnetClient EXTENDS IBACnetEmpty An interface to identify BACnet client function blocks. BACnetClient instances could be declared in the device tree - like BACnet server FB instances inheriting from IBACnetStaticObjectBase. In this case they are registered with the BACnetServer automatically in there Initialize() method. Additionally they can be declared just in IEC code, which than requires an explicite call to RegisterToServer() / UnregisterFromServer(), whenever appropriate. Usually RegisterToServer() should be called immediately after creation - if possible in fb_init(), but this depends on your general initialization scenario - and UnregisterFromServer() should be called immediately before deletion (for example in fb_exit()). Properties: Instance SourceDeviceAddress SourceDeviceNumber TargetDeviceAddress TargetDeviceNumber Methods: RegisterToServer UnregisterFromServer Structure: Instance (Property) RegisterToServer (Method) SourceDeviceAddress (Property) SourceDeviceNumber (Property) TargetDeviceAddress (Property) TargetDeviceNumber (Property) UnregisterFromServer (Method)

IBACnetClient.UnregisterFromServer (METH) ¶ METHOD UnregisterFromServer : UDINT Unregister a BACnet-Client-FB from its parent BACnet-Server-FB. Using this function enables one to dynamically create/delete BACnet-Client-FBs, which were not inserted via the device tree. Return CmpErrors.Errors.ERR_OK if successful. InOut: Scope Name Type Return UnregisterFromServer UDINT

BACnetHooksCallbacks ¶ Structures and interfaces needed to use the BACnet hooks and callbacks provided by a BACnet server. IBACnetEventConsumer (Interface) BACnetEventCallback (Method)