LimitDeviceObjectPropertyReferencesToCertainTypes.PostStartBACnetStack (METH) ¶ METHOD PostStartBACnetStack : UDINT InOut: Scope Name Type Return PostStartBACnetStack UDINT

LimitDeviceObjectPropertyReferencesToCertainTypes.PreRegister (METH) ¶ METHOD PreRegister : UDINT InOut: Scope Name Type Return PreRegister UDINT Input itfServer BACnet.IBACnetServer

LoggingObjects ¶ Function blocks for TrendLog and related are collected in this folder. Internal LogObjectBaseFileHandleTableEntry (Struct) LogObjectsBase (FunctionBlock) BACnetEventCallback ReadRangeErrorCompletion (Method) Files DataFiles CreateDataFiles (Method) DataFileName (Method) ListDataFiles (Method) PurgeDataFile (Method) ReadNumberOfRecordsAndLastSequenceFromDataFile (Method) ReadNumberOfRecordsFromDataFile (Method) RemoveDataFiles (Method) RemoveUnusedDataFiles (Method) ResetDataFile (Method) WriteRecordContentToDataFile (Method) base ComputeRecordSize (Method) FreeReadRangeResult (Method) GetBufferSize (Method) GetRecordsByPosition (Method) GetRecordsBySequence (Method) GetRecordsByTime (Method) GetStopWhenFull (Method) HardShutdown (Property) Init (Method) Logging LogDataFile (Method) LogFilePos (Method) LogFileSize (Method) LogFileSizeAndPos (Method) LogObjectAddrString (Method) LogObjectPropertyAddrString (Method) LogReadRangeResult (Method) LogRecord (Method) LogRecordContentInfo (Method) MaxDataSize (Property) ObjectHandling ObjectId (Method) ObjectType (Property) PersistentPath (Property) PostStopBACnetStack (Method) ReadRangeResultSetInfo (Method) ScanObjectsAndSetCallbackAttachments (Method) ServerDeviceId (Property) SetCallbackAttachments (Method) SetReadCallbackAttachment (Method) SetWriteCallbackAttachment (Method) TempPath (Property) ToString ReadRangeInfoToString (Method) UpdateObjectPropertiesFromDataFile (Method) TrendLog (FunctionBlock) BACnetEventCallback (Method) GetCallback (Method) GetHook (Method) Init (Method) Name (Property) NumCallbacks (Property) NumHooks (Property) PostStartBACnetStack (Method) PreRegister (Method) private SetCallbackAttachments (Method) UpdateObjectPropertiesFromDataFile (Method) proxy GetBufferSize (Method) GetLogDeviceObjectProperty (Method) GetStopWhenFull (Method)

Internal ¶ LogObjectBaseFileHandleTableEntry (Struct) LogObjectsBase (FunctionBlock) BACnetEventCallback ReadRangeErrorCompletion (Method) Files DataFiles CreateDataFiles (Method) DataFileName (Method) ListDataFiles (Method) PurgeDataFile (Method) ReadNumberOfRecordsAndLastSequenceFromDataFile (Method) ReadNumberOfRecordsFromDataFile (Method) RemoveDataFiles (Method) RemoveUnusedDataFiles (Method) ResetDataFile (Method) WriteRecordContentToDataFile (Method) base ComputeRecordSize (Method) FreeReadRangeResult (Method) GetBufferSize (Method) GetRecordsByPosition (Method) GetRecordsBySequence (Method) GetRecordsByTime (Method) GetStopWhenFull (Method) HardShutdown (Property) Init (Method) Logging LogDataFile (Method) LogFilePos (Method) LogFileSize (Method) LogFileSizeAndPos (Method) LogObjectAddrString (Method) LogObjectPropertyAddrString (Method) LogReadRangeResult (Method) LogRecord (Method) LogRecordContentInfo (Method) MaxDataSize (Property) ObjectHandling ObjectId (Method) ObjectType (Property) PersistentPath (Property) PostStopBACnetStack (Method) ReadRangeResultSetInfo (Method) ScanObjectsAndSetCallbackAttachments (Method) ServerDeviceId (Property) SetCallbackAttachments (Method) SetReadCallbackAttachment (Method) SetWriteCallbackAttachment (Method) TempPath (Property) ToString ReadRangeInfoToString (Method) UpdateObjectPropertiesFromDataFile (Method)

TrendLog (FB) ¶ FUNCTION_BLOCK TrendLog EXTENDS LogObjectsBase IMPLEMENTS BACnet.IBACnetEventConsumer Default implementation to handle Trend_Log-object data storage in the file system. Assumptions and requirements see LogObjectsBase . TrendLog provide the feature to monitor BACnet properties, but doesnt allow to monitor other entities than BACnet properties. See ANSI/ASHRAE Standard 135-2012 Table 12-29. Properties of the Trend Log Object Type footnote [8]. Monitoring other entities (than BACnet properties) is definded in the ANSI/ASHRAE Standard 135-2012 for historic reasons and not recommended anyway. Use a BinaryInput, BinaryValue, AnalogInput or AnalogValue to represent the other entity and monitor it’s Present_Value. TrendLog is limited to monitor properties of selected value types (BOOLEAN, UNSIGNED, SIGNED, REAL, ENUMERATED, BIT_STRING) only. To ensure the Log_DeviceObjectProperty property can not be set to other properties use the BACnet-Server-plugin LimitDeviceObjectPropertyReferencesToCertainTypes. Also TrendLog data files needs to be consistent with object persistence. Most obvious Total_Record_Count needs to be consistent with last records sequence number. So in case you delete object persistence files created by ObjectPersistence you need to delete TrendLog data files as well. This BACnet-Server-plugin needs to be registered prior to BACnetServer.StartBACnetStack() to capture log records created during StartBACnetStack(), so you can’t use it with BACnet-Server AutoStart (at application init). Properties: Name NumCallbacks NumHooks HardShutdown , inherited from LogObjectsBase MaxDataSize , inherited from LogObjectsBase ObjectType , inherited from LogObjectsBase PersistentPath , inherited from LogObjectsBase ServerDeviceId , inherited from LogObjectsBase TempPath , inherited from LogObjectsBase Methods: BACnetEventCallback GetCallback GetHook Init PostStartBACnetStack PreRegister ComputeRecordSize , inherited from LogObjectsBase CreateDataFiles , inherited from LogObjectsBase DataFileName , inherited from LogObjectsBase FreeReadRangeResult , inherited from LogObjectsBase GetBufferSize GetLogDeviceObjectProperty GetRecordsByPosition , inherited from LogObjectsBase GetRecordsBySequence , inherited from LogObjectsBase GetRecordsByTime , inherited from LogObjectsBase GetStopWhenFull ListDataFiles , inherited from LogObjectsBase LogDataFile , inherited from LogObjectsBase LogFilePos , inherited from LogObjectsBase LogFileSize , inherited from LogObjectsBase LogFileSizeAndPos , inherited from LogObjectsBase LogObjectAddrString , inherited from LogObjectsBase LogObjectPropertyAddrString , inherited from LogObjectsBase LogReadRangeResult , inherited from LogObjectsBase LogRecord , inherited from LogObjectsBase LogRecordContentInfo , inherited from LogObjectsBase ObjectId , inherited from LogObjectsBase PostStopBACnetStack , inherited from LogObjectsBase PurgeDataFile , inherited from LogObjectsBase ReadNumberOfRecordsAndLastSequenceFromDataFile , inherited from LogObjectsBase ReadNumberOfRecordsFromDataFile , inherited from LogObjectsBase ReadRangeErrorCompletion , inherited from LogObjectsBase ReadRangeInfoToString , inherited from LogObjectsBase ReadRangeResultSetInfo , inherited from LogObjectsBase RemoveDataFiles , inherited from LogObjectsBase RemoveUnusedDataFiles , inherited from LogObjectsBase ResetDataFile , inherited from LogObjectsBase ScanObjectsAndSetCallbackAttachments , inherited from LogObjectsBase SetCallbackAttachments SetReadCallbackAttachment , inherited from LogObjectsBase SetWriteCallbackAttachment , inherited from LogObjectsBase UpdateObjectPropertiesFromDataFile WriteRecordContentToDataFile , inherited from LogObjectsBase Structure: BACnetEventCallback (Method) GetCallback (Method) GetHook (Method) Init (Method) Name (Property) NumCallbacks (Property) NumHooks (Property) PostStartBACnetStack (Method) PreRegister (Method) private SetCallbackAttachments (Method) UpdateObjectPropertiesFromDataFile (Method) proxy GetBufferSize (Method) GetLogDeviceObjectProperty (Method) GetStopWhenFull (Method)

ObjectPersistence (FB) ¶ FUNCTION_BLOCK ObjectPersistence EXTENDS BACnet.BACnetServerPluginBase IMPLEMENTS CmpEventMgr.ICmpEventCallback, BACnet.IBACnetPersistence Default implementation of object persistence. It stores selected properties of objects in one binary data file per object and maintains an index file for bookkeeping. The naming convention for the object persistence file is: pdata_{deviceId}_{objectType}_{objectInstanceNumber}.dat to ensures to identify and restore object information for an object matching the tuple {deviceId},{objectType},{objectInstanceNumber}. Optionally ObjectPersistence stores/restores objects which have create by client CreateObject-requests - this option is enabled by default. This BACnet-Server-plugin needs to be registered prior to BACnetServer.StartBACnetStack() to ensure restore of objects from persistence during StartBACnetStack(), so you can’t use it with BACnet-Server AutoStart (at application init). During restore non existent object files listed in the index file are ignored silently. The user is in control where to place the persistence files - writing the ObjectPersistence.PersistentPath. This helps to control when the persistence files are deleted. The default for PersistentPath is ‘./bacnetbackup’ which keeps the persistence files at “Reset Origin (Application)” (as well at “Reset Warm” and “Reset Cold” of course) but deletes the persistence files at “Reset Origin Device”. If it is required to delete the persistence files at “Reset Origin (Application)” this could be achieved placing the persistence files underneath the application: pCurrentApplication := CmpApp.AppGetCurrent(ADR(result)); objectPersistence.PersistentPath := CONCAT(pCurrentApplication^.szName, ‘/bacnetbackup’); Placing the persistence files somewhere else leaves the control when to delete them completely at the application calling ObjectPersistence.DeleteAllData(). There are two options when to persist object information. The recommended default option is to persist object information at graceful shutdown of BACnetServer - see BACnetServer.StopBACnetStack(). A graceful shutdown of BACnetServer is done during graceful shutdown of the PLC if the PLC provides enough power reserve through an internal uninterruptible power supply (UPS). CmpApp.EVT_PrepareExit is used to trigger the graceful shutdown of BACnetServer during graceful shutdown of the PLC. Some PLC’s doesnt provides enough power reserve to do so, in this case a “hard shutdown” might happen any time. In this case the object information needs to be stored on demand calling DumpDatabase() prior to a sudden shutdown, but a hard shutdown might happen in the middle of this action. So all objects are stored to an object temp file first, last file to store is the index temp file. Done this the index temp file is copied to index file, and afterwards all object temp files are copied to object data files. In case the index file or an object data file can not be read properly during restore, we give it a try to read the according temp file instead. The application can choose this option setting HardShutdown to TRUE prior to plugin registration. Properties: HardShutdown Name PersistentPath RestoreClientCreatedObjects Methods: DeleteAllData DumpDataBase LogIndexFileContent PostUnregister PreRegister Structure: DeleteAllData (Method) DumpDataBase (Method) HardShutdown (Property) LogIndexFileContent (Method) Name (Property) PersistentPath (Property) PostUnregister (Method) PreRegister (Method) RestoreClientCreatedObjects (Property)

ObjectPersistence.DeleteAllData (METH) ¶ METHOD DeleteAllData : CmpBACnet.IEC_BACNET_STATUS This function deletes all the previously created data files. InOut: Scope Name Type Return DeleteAllData CmpBACnet.IEC_BACNET_STATUS

ObjectPersistence.DumpDataBase (METH) ¶ METHOD DumpDataBase : CmpBACnet.IEC_BACNET_STATUS Dumps the object database to data files. InOut: Scope Name Type Return DumpDataBase CmpBACnet.IEC_BACNET_STATUS

ObjectPersistence.HardShutdown (PROP) ¶ PROPERTY HardShutdown : BOOL

ObjectPersistence.LogIndexFileContent (METH) ¶ METHOD LogIndexFileContent : CmpBACnet.IEC_BACNET_STATUS Logs the existing persistence files. InOut: Scope Name Type Return LogIndexFileContent CmpBACnet.IEC_BACNET_STATUS