Utilities ¶ Utility functionalities for dealing with the BACnet object, their properties and some general issues like string conversion to different string representations. BACnetUtilities BACnetDateTimeCmp (Function) BACnetProperties GetBACnetDataTypeSize (Function) GetBACnetPropertyDataType (Function) InitializeEmptyPropertyInstance (Function) InitializePropertyInstance (Function) IsBACnetObjectAMEVCreatable (Function) IsBACnetPropertyAMEVASBWritable (Function) SetPropertyAgain (Function) FromBACnetContents GetBitStringFromContents (Function) GetBoolFromContents (Function) GetDateFromContents (Function) GetDateRangeFromContents (Function) GetDateTimeFromContents (Function) GetDevObjPropReferenceFromContents (Function) GetLrealFromContents (Function) GetObjectIDFromContents (Function) GetRealFromContents (Function) GetSetpointReferenceFromContents (Function) GetSignedFromContents (Function) GetTimeFromContents (Function) GetUnsignedFromContents (Function) GetWStringFromContents (Function) FromBACnetDataTypes FromBACnetBitString (Function) FromBACnetBoolean (Function) FromBACnetDate (Function) FromBACnetDateRange (Function) FromBACnetDateTime (Function) FromBACnetDevObjPropReference (Function) FromBACnetSetpointReference (Function) FromBACnetString (Function) FromBACnetTime (Function) FromBACnetTimeStamp (Function) IsBACnetBACnetDateTimeUnspecified (Function) IsBACnetDateTimeUnspecified (Function) InitializeBACnetDataTypes BitStrings BACnetBitStringGetBit (Function) BACnetBitStringSetBit (Function) InitializeBACnetBitString (Function) InitializeBACnetBoolean (Function) InitializeBACnetDate (Function) InitializeBACnetDateRange (Function) InitializeBACnetDateTime (Function) InitializeBACnetDateTimeUnspecified (Function) InitializeBACnetDevObjPropReference (Function) InitializeBACnetSetpointReference (Function) InitializeBACnetString (Function) InitializeBACnetTime (Function) InitializeBACnetTimeStamp (Function) IOUtilities Mem DeallocStackAllocatedContentBuffer (Function) FreeStackAllocatedMemory (Function) RegisterEventUtilities StringConversions BufferToString (Function) ISO88591 UTF8 ToString BACnetDateTimeToString (Function) EventIdToString (Function) IEC_BACNET_ERROR_TO_STRING (Function) MemoryToString (Function) PropertyAddrString (Function) PropertyAttributeExistenceString (Function) PropertyAttributePersistentString (Function) PropertyAttributeWritableString (Function) PropertyAttributesString (Function) PropertyIndexAddrString (Function)
InitializeEmptyPropertyInstance (FUN) ¶ FUNCTION InitializeEmptyPropertyInstance : BOOL Initializes a property (prop) with its (working) defaults (mostly empty) considering constant array sizes, lists and special property types. InOut: Scope Name Type Comment Return InitializeEmptyPropertyInstance BOOL Input objTyp CmpBACnet.IEC_BACNET_OBJECT_TYPE The object instance which has the desired property. accessID CmpBACnet.IEC_BACNET_ACCESS The access specifier used for initializing the property instance. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID of the property for which the instance data shall be initialized. Inout prop CmpBACnet.IEC_BACNET_PROPERTY_INSTANCE
InitializePropertyInstance (FUN) ¶ FUNCTION InitializePropertyInstance : BOOL Initializes a IEC_BACNET_PROPERTY_INSTANCE with the given parameters and data. InOut: Scope Name Type Comment Return InitializePropertyInstance BOOL Input ePropAccess CmpBACnet.IEC_BACNET_ACCESS The access specifier to use for initialization. ePropID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID to use for initialization. ePropDataType CmpBACnet.IEC_BACNET_DATA_TYPE The data type to use for initialization. uiNumOfElements UDINT The number of elements to use for initialization. uiDataSize UDINT The data size to use for initialization. pData POINTER TO BYTE The data to use for initialization. Inout propInst CmpBACnet.IEC_BACNET_PROPERTY_INSTANCE After a successfull call the initialized property instance data is written to thuis structure.
BACnetUtilities ¶ Utilities for dealing with BACnet objects and their properties and BACnet data types. BACnetDateTimeCmp (Function) BACnetProperties GetBACnetDataTypeSize (Function) GetBACnetPropertyDataType (Function) InitializeEmptyPropertyInstance (Function) InitializePropertyInstance (Function) IsBACnetObjectAMEVCreatable (Function) IsBACnetPropertyAMEVASBWritable (Function) SetPropertyAgain (Function) FromBACnetContents GetBitStringFromContents (Function) GetBoolFromContents (Function) GetDateFromContents (Function) GetDateRangeFromContents (Function) GetDateTimeFromContents (Function) GetDevObjPropReferenceFromContents (Function) GetLrealFromContents (Function) GetObjectIDFromContents (Function) GetRealFromContents (Function) GetSetpointReferenceFromContents (Function) GetSignedFromContents (Function) GetTimeFromContents (Function) GetUnsignedFromContents (Function) GetWStringFromContents (Function) FromBACnetDataTypes FromBACnetBitString (Function) FromBACnetBoolean (Function) FromBACnetDate (Function) FromBACnetDateRange (Function) FromBACnetDateTime (Function) FromBACnetDevObjPropReference (Function) FromBACnetSetpointReference (Function) FromBACnetString (Function) FromBACnetTime (Function) FromBACnetTimeStamp (Function) IsBACnetBACnetDateTimeUnspecified (Function) IsBACnetDateTimeUnspecified (Function) InitializeBACnetDataTypes BitStrings BACnetBitStringGetBit (Function) BACnetBitStringSetBit (Function) InitializeBACnetBitString (Function) InitializeBACnetBoolean (Function) InitializeBACnetDate (Function) InitializeBACnetDateRange (Function) InitializeBACnetDateTime (Function) InitializeBACnetDateTimeUnspecified (Function) InitializeBACnetDevObjPropReference (Function) InitializeBACnetSetpointReference (Function) InitializeBACnetString (Function) InitializeBACnetTime (Function) InitializeBACnetTimeStamp (Function)
SetPropertyAgain (FUN) ¶ FUNCTION SetPropertyAgain : CmpBACnet.IEC_BACNET_STATUS Just gets a properties value and sets it again, to initiate any possible callbacks and hooks when writing the specified property. InOut: Scope Name Type Comment Return SetPropertyAgain CmpBACnet.IEC_BACNET_STATUS Input itfBACnetObj IBACnetObjectBase The BACnet object to use for getting and setting the property. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The ID of the property to first get and then set with the gotten value.
FromBACnetContents ¶ Utilities for getting IEC typed values from BACnet-Property-Content form data. GetBitStringFromContents (Function) GetBoolFromContents (Function) GetDateFromContents (Function) GetDateRangeFromContents (Function) GetDateTimeFromContents (Function) GetDevObjPropReferenceFromContents (Function) GetLrealFromContents (Function) GetObjectIDFromContents (Function) GetRealFromContents (Function) GetSetpointReferenceFromContents (Function) GetSignedFromContents (Function) GetTimeFromContents (Function) GetUnsignedFromContents (Function) GetWStringFromContents (Function)
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.
IsBACnetObjectAMEVCreatable (FUN) ¶ FUNCTION IsBACnetObjectAMEVCreatable : BOOL According to AMEV AS-B specifications return whether the given objer not. InOut: Scope Name Type Comment Return IsBACnetObjectAMEVCreatable BOOL Input objType CmpBACnet.IEC_BACNET_OBJECT_TYPE The object type to check for AMEV AS-B availability.
IsBACnetPropertyAMEVASBWritable (FUN) ¶ FUNCTION IsBACnetPropertyAMEVASBWritable : BOOL Is the Property writable following a given PICs (following AMEV-AS-B). InOut: Scope Name Type Comment Return IsBACnetPropertyAMEVASBWritable BOOL Input objTyp CmpBACnet.IEC_BACNET_OBJECT_TYPE The object type to check. propID CmpBACnet.IEC_BACNET_PROPERTY_ID The property ID within the given object type to check.