File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 16.08.2022, 11:23:19 companyName string 3S-Smart Software Solutions GmbH libraryFile BACnet.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 1 contentFile BACnet.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 16.08.2022, 11:23:18 LibraryCategories library-category-list Intern|BACnet Author string 3S - Smart Software Solutions GmbH Company 3S - Smart Software Solutions GmbH CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 DefaultNamespace BACnet Description See: Description DocFormat reStructuredText LanguageModelAttribute qualified-access-only Placeholder BACnet Project BACnet Title BACnet Version version 1.7.0.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 3SLicense ¶ Library Identification ¶ Placeholder: 3SLicense Default Resolution: 3SLicense, * (3S - Smart Software Solutions GmbH) Namespace: _3S_LICENSE Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: 3SLicense CAA Ressource Manager Extern ¶ Library Identification ¶ Placeholder: CAA ResMan Default Resolution: CAA Ressource Manager Extern, * (CAA Technical Workgroup) Namespace: RSM Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA ResMan CAA Types Extern ¶ Library Identification ¶ Placeholder: CAA Types Default Resolution: CAA Types Extern, * (CAA Technical Workgroup) Namespace: CAA Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CAA Types CmpApp ¶ Library Identification ¶ Placeholder: CmpApp Default Resolution: CmpApp, * (System) Namespace: CmpApp Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpApp CmpBACnet ¶ Library Identification ¶ Placeholder: CmpBACnet Default Resolution: CmpBACnet, * (3S - Smart Software Solutions GmbH) Namespace: CmpBACnet Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CmpBACnet CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpEventMgr ¶ Library Identification ¶ Placeholder: CmpEventMgr Default Resolution: CmpEventMgr, * (System) Namespace: CmpEventMgr Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpEventMgr CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpIecTask CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog CmpSettings ¶ Library Identification ¶ Placeholder: CmpSettings Default Resolution: CmpSettings, * (System) Namespace: CmpSettings Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpSettings Common Behaviour Model ¶ Library Identification ¶ Placeholder: CBML Default Resolution: Common Behaviour Model, * (3S - Smart Software Solutions GmbH) Namespace: CBML Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: CBML Component Manager ¶ Library Identification ¶ Placeholder: Component Manager Default Resolution: Component Manager, * (System) Namespace: Component_Manager Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Component Manager IoDrvEthernet Interfaces ¶ Library Identification ¶ Name: IoDrvEthernet Interfaces Version: newest Company: 3S - Smart Software Solutions GmbH Namespace: IIoDrvEthernet Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDrvEthernet Interfaces, * (3S - Smart Software Solutions GmbH) IoDrvUtility ¶ Library Identification ¶ Placeholder: IoDriver Utility Default Resolution: IoDrvUtility, * (3S - Smart Software Solutions GmbH) Namespace: IoDrvUtility Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: IoDriver Utility IoStandard ¶ Library Identification ¶ Placeholder: IoStandard Default Resolution: IoStandard, * (System) Namespace: IoStandard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: IoStandard Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysFile ¶ Library Identification ¶ Placeholder: SysFile Default Resolution: SysFile, * (System) Namespace: SysFile Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysFile SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSem ¶ Library Identification ¶ Placeholder: SysSem Default Resolution: SysSem, * (System) Namespace: SysSem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSem SysTimeCore ¶ Library Identification ¶ Placeholder: SysTimeCore Default Resolution: SysTimeCore, * (System) Namespace: SysTimeCore Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTimeCore SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System) Util ¶ Library Identification ¶ Placeholder: Util Default Resolution: Util, * (System) Namespace: Util Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Util Library Parameter ¶ Parameter: IBLOCKSIZE = 22800
BACnetCommand.InitializeActionCommandBACnetReal (METH) ¶ METHOD InitializeActionCommandBACnetReal Initialized a BACnet-ActionCommand, which writes a BACnet-Real/Double value to another BACnet-Object-Property. The initialized command then normally is used as part of a BACnet-ActionList. InOut: Scope Name Type Comment Input devInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet device. bacObjectInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet object under the BACnet device. bacObjectType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the targeted BACnet object under the BACnet device. bacPropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the targetedn property under the BACnet object. priority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the BinaryPV value to the targeted property. postDelay CmpBACnet.IEC_BACNET_UNSIGNED The post delay after writing the BinaryPV value. quitOnFailure CmpBACnet.IEC_BACNET_BOOLEAN Whether the action list execution shall be quited on failure of this action command or not. Inout bacReal CmpBACnet.IEC_BACNET_REAL The real value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
BACnetCommand.InitializeActionCommandBACnetUnsigned (METH) ¶ METHOD InitializeActionCommandBACnetUnsigned Initialized a BACnet-ActionCommand, which writes a BACnet-Unsigned value to another BACnet-Object-Property. The initialized command then normally is used as part of a BACnet-ActionList. InOut: Scope Name Type Comment Input devInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet device. bacObjectInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet object under the BACnet device. bacObjectType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the targeted BACnet object under the BACnet device. bacPropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the targetedn property under the BACnet object. priority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the BinaryPV value to the targeted property. postDelay CmpBACnet.IEC_BACNET_UNSIGNED The post delay after writing the BinaryPV value. quitOnFailure CmpBACnet.IEC_BACNET_BOOLEAN Whether the action list execution shall be quited on failure of this action command or not. Inout bacUnsigned CmpBACnet.IEC_BACNET_UNSIGNED The unsinged value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
BACnetCommand.InitializeActionCommandBACnetBinaryPV (METH) ¶ METHOD InitializeActionCommandBACnetBinaryPV Initialized a BACnet-ActionCommand, which writes a BACnet-BinaryPV value to another BACnet-Object-Property. The initialized command then normally is used as part of a BACnet-ActionList. InOut: Scope Name Type Comment Input devInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet device. bacObjectInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet object under the BACnet device. bacObjectType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the targeted BACnet object under the BACnet device. bacPropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the targetedn property under the BACnet object. priority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the BinaryPV value to the targeted property. postDelay CmpBACnet.IEC_BACNET_UNSIGNED The post delay after writing the BinaryPV value. quitOnFailure CmpBACnet.IEC_BACNET_BOOLEAN Whether the action list execution shall be quited on failure of this action command or not. Inout bacBinaryPV CmpBACnet.IEC_BACNET_BINARY_PV The BinaryPV value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
BACnetCommand.InitializeActionCommandBACnetBoolean (METH) ¶ METHOD InitializeActionCommandBACnetBoolean Initialized a BACnet-ActionCommand, which writes a BACnet-Boolean value to another BACnet-Object-Property. The initialized command then normally is used as part of a BACnet-ActionList. InOut: Scope Name Type Comment Input devInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet device. bacObjectInst CmpBACnet.IEC_BACNET_DWORD The instance number of the targeted BACnet object under the BACnet device. bacObjectType CmpBACnet.IEC_BACNET_OBJECT_TYPE The type of the targeted BACnet object under the BACnet device. bacPropertyID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the targetedn property under the BACnet object. priority CmpBACnet.IEC_BACNET_SIGNED The priority used to write the BinaryPV value to the targeted property. postDelay CmpBACnet.IEC_BACNET_UNSIGNED The post delay after writing the BinaryPV value. quitOnFailure CmpBACnet.IEC_BACNET_BOOLEAN Whether the action list execution shall be quited on failure of this action command or not. Inout bacBoolean CmpBACnet.IEC_BACNET_BOOLEAN The boolean value to be written. bacActionCommand CmpBACnet.IEC_BACNET_ACTION_COMMAND The action command structure to be filled.
BACnetSchedule.AddExceptionReference (METH) ¶ METHOD AddExceptionReference : CmpBACnet.IEC_BACNET_STATUS Adds a reference (to a BACnet-Calendar-Object) to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionReference CmpBACnet.IEC_BACNET_STATUS Input calendarInstance CmpBACnet.IEC_BACNET_DWORD The instance number of the calendar object to reference. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the calendar entries which correspond to the exception date. entryCount CmpBACnet.IEC_BACNET_ELEMENT_COUNT The number of times and values for the exceptions. eventPriority BYTE The priority with which the values are written.
BACnetSchedule.AddExceptionWeekAndDay (METH) ¶ METHOD AddExceptionWeekAndDay : CmpBACnet.IEC_BACNET_STATUS Adds a week and day entry (i.e. weekly at day) to the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Comment Return AddExceptionWeekAndDay CmpBACnet.IEC_BACNET_STATUS Input month CmpBACnet.IEC_BACNET_MONTH The month of the exception date. weekOfMonth CmpBACnet.IEC_BACNET_WEEK_OF_MONTH The week of the month of the exception date. dayOfWeek CmpBACnet.IEC_BACNET_DAY_OF_WEEK The day of the week of the exception date. pEntries POINTER TO CmpBACnet.IEC_BACNET_TIME_VALUE The times and values during the week and day dates which correspond to the exception date. entryCount CmpBACnet.IEC_BACNET_ELEMENT_COUNT The number of times and values for the exceptions. eventPriority BYTE The priority with which the values are written.
BACnetSchedule.RemoveExceptionEntry (METH) ¶ METHOD RemoveExceptionEntry : CmpBACnet.IEC_BACNET_STATUS Removes a entry at index nIndex from the Exception_Schedule-Property of this BACnet-Object. InOut: Scope Name Type Initial Comment Return RemoveExceptionEntry CmpBACnet.IEC_BACNET_STATUS Input nIndex CmpBACnet.IEC_BACNET_ELEMENT_COUNT 0 The 1 based index of the exception entry to remove.
BACnetSchedule.AddPropertyReference (METH) ¶ METHOD AddPropertyReference : CmpBACnet.IEC_BACNET_STATUS Adds device object property reference to the List_Of-Object_Property_References-Property (which lists all the Objects to influenced by this Schedule) of this BACnet-Object. InOut: Scope Name Type Initial Comment Return AddPropertyReference CmpBACnet.IEC_BACNET_STATUS Input deviceInstance CmpBACnet.IEC_BACNET_DWORD The BACnet device to reference. objInstance CmpBACnet.IEC_BACNET_DWORD The BACnet object instance number of the BACnet device to reference. objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The BACnet object type number of the BACnet device to reference. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The BACnet property ID of the BACnet object to reference. nIndex CmpBACnet.IEC_BACNET_SIGNED The 1 based index to reference of the BACnet property. xDevicePresent BOOL TRUE Whether the BACnet device is present or not.