BACnet Library Documentation ¶ Company 3S - Smart Software Solutions GmbH Title BACnet Version 1.7.0.0 Categories Intern|BACnet Namespace BACnet Author 3S - Smart Software Solutions GmbH Placeholder BACnet Description 1 ¶ The BACnet library is the connection between BACnet devices inserted in the device tree, to the CmpBACnet library, which then communicates the BACnet configuration and dynamics to the component on the runtime system. An introduction of BACnet can be found at http://www.bacnet.org . There is a tutorial at http://www.bacnet.org/Tutorial/HMN-Overview/sld001.htm and a tutorial covering BACnet IP http://www.bacnet.org/Tutorial/BACnetIP/index.html . The CODESYS BACnet package includes extensive examples covering lots of practical aspects using CODESYS BACnet in applications. Since this library is intended to be easy usable and is not confined to specialized runtime component functionalities, the BACnet library should be always used instead of directly accessing the runtime component via the CmpBACnet library. CODESYS BACnet library - detailed information ¶ Contents: ¶ BACnetClient BACnetClientAlarmsEvents BACnetClientBase (FunctionBlock) BACnetClientConfirm BACnetClientDeviceManagement BACnetClientFile BACnetClientLifeSafetyOperation BACnetClientProperty IBACnetClient (Interface) BACnetHooksCallbacks IBACnetEventConsumer (Interface) BACnetObjects Accumulator AnalogInput AnalogOutput AnalogValue Averaging BACnetObjectBase (FunctionBlock) BinaryInput BinaryOutput BinaryValue Calendar Command Device EventEnrollment EventLog File Global Group Group IBACnetObjectBase (Interface) IBACnetStaticObjectBase (Interface) IntegerValue LargeAnalogValue LifeSafetyPoint LifeSafetyZone Loop MultistateInput MultistateOutput MultistateValue NotificationClass PositiveIntegerValue Program PulseConverter Schedule StructuredView TrendLog TrendLogMultiple BACnetServer Async BACnetIPdatalink (FunctionBlock) BACnetMSTPdatalink (FunctionBlock) BACnetServer (FunctionBlock) IBACnetServer (Interface) BACnetServerPlugin BACnetServerPluginBase (FunctionBlock) BACnetServerPluginCallbackBase (FunctionBlock) BACnetServerPluginHookBase (FunctionBlock) IBACnetServerPlugin (Interface) IBACnetServerPluginCallback (Interface) IBACnetServerPluginHook (Interface) Constants (GVL) Debug Doc compile options to enable specific logging other compile options Enums BACnetPropertyAttributeExistent (Enum) BACnetPropertyAttributePersistent (Enum) BACnetPropertyAttributeWritable (Enum) Library Information GetLibVersion (Function) GetLibVersionNumber (Function) IsLibReleased (Function) Persistence BACnetPersistenceInfo (Struct) IBACnetPersistence (Interface) PropertyConfiguration IBACnetPropertyConfiguration (Interface) Structs BACnetDateRange (Struct) BACnetDateTime (Struct) BACnetDevObjPropReference (Struct) BACnetPropertyAttributes (Struct) BACnetSetpointReference (Struct) BACnetTimeStamp (Struct) BACnetTimeStampUnion (Union) BBMD_Info (Struct) Utilities BACnetUtilities IOUtilities Mem RegisterEventUtilities StringConversions ToString Indices and tables ¶ 1 Based on BACnet.library, last modified 16.08.2022, 11:23:18. LibDoc 4.4.0.0-b.27 The content file BACnet.clean.json was generated with CODESYS V3.5 SP16 Patch 1 on 16.08.2022, 11:23:19.

BACNetClientGetEnrollmentSummary (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACNetClientGetEnrollmentSummary 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 filter CmpBACnet.IEC_BACNET_ENROLLMENT_FILTER Filter for the aquired enrollment summary. Output result CmpBACnet.IEC_BACNET_ENROLLMENT_INFO If the BACnet-Request succeeded (xDone is TRUE and no error occured (xError is FALSE)), this variable holds the contents of the enrollment 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)

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)

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)

BACNetClientGetEnrollmentSummary.InitializeOutputs (METH) ¶ METHOD PROTECTED InitializeOutputs

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

BACNetClientGetEnrollmentSummary.FreeResult (METH) ¶ METHOD PROTECTED FreeResult

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

BACnetClientReinitializeDevice.SampleInputs (METH) ¶ METHOD PROTECTED SampleInputs

BACnetClientRestoreBACnetDevice (FB) ¶ FUNCTION_BLOCK PUBLIC FINAL BACnetClientRestoreBACnetDevice EXTENDS BACnetClientBase Common Behaviour Model conform (ETrigA) FB to initiates a restore procedure for an BACnet device. If execution completed successfully and xDone is TRUE, the 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 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 deviceInstance CmpBACnet.IEC_BACNET_DWORD The device instance number to restore. password CmpBACnet.IEC_BACNET_STRING The optional password needed for the restore procedure. If no password is needed for this procedure set the string type to BACNET_STRING_NONE. pathToStoredFiles POINTER TO CmpBACnet.IEC_BACNET_BYTE The path to the storage location of file object data received. callback CmpEventMgr.ICmpEventCallback An event-callback interface to inform about failures and progress information during the procedure execution. 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)