BACnetProperties ¶ Utilities for dealing with BACnet objects and their properties. GetBACnetDataTypeSize (Function) GetBACnetPropertyDataType (Function) InitializePropertyInstance (Function) property proxies IBACnetARRAY7_of_BACnetDailySchedule (Interface) GetContent (Method) GetCount (Method) GetElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAY7_of_BACnetTimerStateChangeValue (Interface) GetContent (Method) GetCount (Method) GetElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetAccessRule (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetActionList (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetAssignedAccessRights (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetAssignedLandingCalls (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetAuthenticationFactorFormat (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetAuthenticationPolicy (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetCredentialAuthenticationFactor (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetDeviceObjectPropertyReference (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetDeviceObjectReference (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetDoorStatus (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetLandingDoorStatus (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetLiftCarCallList (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetLiftCarDoorCommand (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetNameValue (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetNameValueCollection (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetNodeType (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetObjectIdentifier (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetObjectSelector (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetOptionalCharacterString (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetPortPermission (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetPropertyAccessResult (Interface) AddElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetPropertyAccessResult_ReadOnly (Interface) GetContent (Method) GetCount (Method) GetElement (Method) IBACnetARRAYN_of_BACnetRelationship (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetSpecialEvent (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BACnetStageLimitValue (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_BITSTRING (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_CharacterString (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_OCTETSTRING (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_REAL (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_Unsigned (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_Unsigned32 (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetARRAYN_of_Unsigned8 (Interface) AddElement (Method) GetContent (Method) GetCount (Method) GetElement (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetAccessCredentialDisableReason (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetAccessEvent (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetAccessZoneOccupancyState (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetAddressBinding (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetAuthorizationExemption (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetBDTEntry (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetCOVMultipleSubscription (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetCOVSubscription (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetCalendarEntry (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetDestination (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetDeviceObjectPropertyReference (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetDeviceObjectReference (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetDoorAlarmState (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetEscalatorFault (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetEventNotificationSubscription (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetFDTEntry (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetLandingCallStatus (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetLifeSafetyMode (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetLifeSafetyState (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetLiftFault (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetRecipient (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetRouterEntry (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetTimerState (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetVMACEntry (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetVTClass (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_BACnetVTSession (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_ReadAccessResult (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_ReadAccessSpecification (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) IBACnetLIST_of_Unsigned (Interface) AddElement (Method) GetContent (Method) GetCount (Method) InsertElement (Method) RemoveElement (Method) SetContent (Method) UpdateElement (Method) ISingleValue_of_Any (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetAuthenticationFactor (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetChannelValue (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetEventParameter (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetFaultParameter (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetHostNPort (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetLandingCallStatus (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_BACnetPriorityArray (Interface) GetContent (Method) SetContent (Method) ISingleValue_of_OCTETSTRING (Interface) GetContent (Method) SetContent (Method)
BACnetDateRange (STRUCT) ¶ TYPE BACnetDateRange : STRUCT Helper Structure for CODESYS-Typed date ranges. InOut: Name Type startDate DATE endDate DATE
BACnetDateTime (STRUCT) ¶ TYPE BACnetDateTime : STRUCT Helper Structure for CODESYS-typed date times to work with BACnet properties of BACnet standard type “BACnetDateTime” represented by CmpBACnet.IEC_BACNET_DATE_TIME. Please note: CmpBACnet.IEC_BACNET_DATE_TIME allows “unspecified” elements, but BACnetDateTime does not for historic reason. CmpBACnet.IEC_BACNET_DATE_TIME allows “unspecified” elements which are used for two different objectives. 1.) eventually “fully unspecified”: properties representing a time stamp or a time range start / end, for example BinaryInput.Change_Of_State_Time or TrendLog.Start_Time / .Stop_Time 2.) eventually “partially unspecified”: Schedule.Exception_Schedule The BACnet standard uses the terms “fully unspecified” or “fully specified”, but not the term “partially unspecified” (instead a bit more unspecific “unspecified”). “fully unspecified”: In most cases a time stamp indicates the time of a change of object state. Prior to first change of object state the time stamp is supposed to be “unspecified”. For an example see File.Modification_Date or PulseConverter.Update_Time Another use case of “fully unspecified” is a time range - see TrendLog.Start_Time and .Stop_Time or Schedule. “partially unspecified” is mainly used in Schedule.Exception_Schedule BACnetDateTime has been used in earlier versions of CODESYS BACnet as an API type instead of CmpBACnet.IEC_BACNET_DATE_TIME for convenience. So an interface breaking change would have been necessary to switch to CmpBACnet.IEC_BACNET_DATE_TIME to allow “unspecified” directly. We found this too hard of a measure, so we kept BACnetDateTime as an API type and added some assumptions and helper functions. Assumption: a BACnetDateTime dat = D#1970-1-1 AND tim = T#0S (begin of universe) or dat = D#2106-2-7 AND tim = T#23H59M59S999MS (end of universe) is assumed to be “fully unspecified”. Helper functions: IsBACnetBACnetDateTimeUnspecified to check if a BACnetDateTime is “fully unspecified”. IsBACnetDateTimeUnspecified to check if a CmpBACnet.IEC_BACNET_DATE_TIME is “fully unspecified”. InitializeBACnetDateTimeUnspecified to initialize a CmpBACnet.IEC_BACNET_DATE_TIME to “fully unspecified”. BACnetObjectBase.SetBACnetDateTimePropertyToUnspecified to initialize a property to “fully unspecified”. InOut: Name Type dat DATE tim TIME
IBACnetPropertyConfiguration (ITF) ¶ INTERFACE PUBLIC IBACnetPropertyConfiguration Interface for BACnet property configuration (plugin) implementations. Properties: Name Methods: GetPropertyAttributes Structure: GetPropertyAttributes (Method) Name (Property)
IBACnetPropertyConfiguration.GetPropertyAttributes (METH) ¶ METHOD GetPropertyAttributes : BOOL Gets the property attributes of a given object property. Returns FALSE, if no propAttr for objID/propID is provided. InOut: Scope Name Type Return GetPropertyAttributes BOOL Input objID CmpBACnet.IEC_BACNET_OBJECT_ID propID CmpBACnet.IEC_BACNET_PROPERTY_ID Output propAttr BACnetPropertyAttributes
GetBACnetDataTypeSize (FUN) ¶ FUNCTION GetBACnetDataTypeSize : UDINT Returns the size of the IEC-Struct corresponding to a specific BACnet-Data-Type. InOut: Scope Name Type Comment Return GetBACnetDataTypeSize UDINT Input dataID CmpBACnet.IEC_BACNET_DATA_TYPE The BACnet data type to get its size for.
GetBACnetPropertyDataType (FUN) ¶ FUNCTION GetBACnetPropertyDataType : CmpBACnet.IEC_BACNET_DATA_TYPE Returns the BACnet-Data-Type for a specific BACnet-Object-Property. Note Data types may depend on the object type (i.e. the Present_Value of a Binary Value object is different to the Present_Value of a Analog Value object). InOut: Scope Name Type Comment Return GetBACnetPropertyDataType CmpBACnet.IEC_BACNET_DATA_TYPE Input objTyp CmpBACnet.IEC_BACNET_OBJECT_TYPE The object type having the desired property. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property to determine its BACnet data type for.
IBACnetPropertyConfiguration.Name (PROP) ¶ PROPERTY Name : STRING
Structs ¶ Structures representing accumulated BACnet data types in form of accumulated IEC data types. BACnetDateRange (Struct) BACnetDateTime (Struct) BACnetOptionalPriorityFilter (Struct) BACnetTimeStamp (Struct) BACnetTimeStampUnion (Union) BBMD_Info (Struct)
BACnetTimeStampUnion (UNION) ¶ TYPE BACnetTimeStampUnion : UNION Helper Structure for CODESYS-Typed time stamps, which include this union. InOut: Name Type tim TIME seqNumber UDINT dateTime BACnetDateTime