BACnetEncodeAsn1StandardProperty (FUN) ¶ FUNCTION BACnetEncodeAsn1StandardProperty : IEC_BACNET_STATUS Encodes the given property contents structure into an BACnet ASN1 encoded data type. Encodes the given property contents structure into an BACnet ASN1 encoded data type. If the given property contents structure is invalid or the buffer for the encoding is not large enough an error will be returned. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetEncodeAsn1StandardProperty IEC_BACNET_STATUS Input pPropCont POINTER TO IEC_BACNET_PROPERTY_CONTENTS The pointer to an filled property contents buffer which shall be encoded into ASN1. pBuffer POINTER TO IEC_BACNET_BYTE The pointer to the buffer which stores the ASN1 encoded data. nBufferSize IEC_BACNET_UINT The size of the buffer in which the ASN1 encoded data will be stored. pEncodedSize POINTER TO IEC_BACNET_UINT The pointer to an unsigned integer in which the length from the ASN1 encoded data will be stored.

BACnetDumpStackInformation (FUN) ¶ FUNCTION BACnetDumpStackInformation : IEC_BACNET_STATUS Function dumps internal states for diagnostic reasons into an ASCII file. This function gives an user or an user application the ability to get some information about internal states of processes and objects in the API. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetDumpStackInformation IEC_BACNET_STATUS Input reportFlags IEC_BACNET_DUMP_REPORT_FLAGS Specifies which output should be generated. pszPathFileName POINTER TO BYTE Specifies a path and filename for the ASCII database dump.

BACnetFindUpdateDeviceAddressBindings (FUN) ¶ FUNCTION BACnetFindUpdateDeviceAddressBindings : POINTER TO IEC_BACNET_ADDRESS Finds or updates a BACnet MAC address for some specified device instance number. For an successful communication to a remote device in a BACnet network the application needs the BACnet MAC address for the device instance number. If the device, which the application needs to communicate with, supports the dynamic address binding, the user application can use this function to retrieve the BACnet MAC address. The API will send in configurable periods (see function ::BACnetSetDeviceAddressBindingsCacheOptions) requests to retrieve the right BACnet MAC address.n The property “Address_Binding” from a device object which is defined in this BACnet server API’s database is also searched for an valid address by this function. The property is used by the API for ‘static’ address bindings only, but if the property is beeing read from a BACnet client ‘dynamic’ address bindings resolved from this function will also appear in the returned response. Return: A pointer of type ::BACNET_ADDRESS or NULL if the address is still unknown. InOut: Scope Name Type Comment Return BACnetFindUpdateDeviceAddressBindings POINTER TO IEC_BACNET_ADDRESS Input pSource POINTER TO IEC_BACNET_ADDRESS A pointer with a valid BACnet MAC address if the ‘binding’ should be updated or a NULL pointer if the device instance should be resolved into an BACnet MAC address. deviceNumber IEC_BACNET_INST_NUMBER The device instance number for which the MAC address shall be retrieved or updated. bForceRefresh IEC_BACNET_BOOLEAN If set to True the dynamic address binding is forced to be refreshed for the given device instance number.

BACnetFindUpdateObjectIdNameBindings (FUN) ¶ FUNCTION BACnetFindUpdateObjectIdNameBindings : POINTER TO IEC_BACNET_OBJECT_ID Finds or updates an object identifier for some specified object name. The Who-Has service is used by a sending BACnet-user to identify the device object identifiers and network addresses of other BACnet devices whose local databases contain an object with a given Object_Name or a given Object_Identifier. This function implements the functional process of dynamic object binding. The API will send in configurable periods (see function ::BACnetSetObjectIdNameBindingsCacheOptions) requests to retrieve the right object identifier for an specified object name.n This function will only search for b REMOTE object names and not b LOCAL ones. Return: A pointer to ::BACNET_OBJECT_ID or NULL if the object identifier is still unknown. InOut: Scope Name Type Comment Return BACnetFindUpdateObjectIdNameBindings POINTER TO IEC_BACNET_OBJECT_ID Input devInst IEC_BACNET_INST_NUMBER The device instance number for which the object binding shall be retrieved or updated. pObjectName POINTER TO IEC_BACNET_STRING A pointer to a string structure filled with the object name to search for. pInObjId POINTER TO IEC_BACNET_OBJECT_ID A pointer to an object identifier associated to the given name or a NULL pointer if the given object name should be resolved into an object identifier. bForceRefresh IEC_BACNET_BOOLEAN If set to True the dynamic object binding is forced to be refreshed for the given object name.

BACnetLockDatabaseAccess (FUN) ¶ FUNCTION BACnetLockDatabaseAccess Function which locks the access to the database so that no other process or thread may access the data.

BACnetLoopEnablePidAlgorithm (FUN) ¶ FUNCTION BACnetLoopEnablePidAlgorithm : IEC_BACNET_STATUS Enables or disables the internal PID algorithm for the specified loop object. In case the internal PID algorithm is enabled it will be calculated using the given property values which specify the PID constants. The calculation interval is taken from the update-interval property which is linited in range from 10 ms to 10000 ms. The internal algorithm will take the set-point from the reference specified in set-point-reference or from the set-point property. The controlled value will be taken from the controlled-variable-value property which is updated from the controlled-variable-reference object. It will update the present-value along with the object specified with the manipulated-variable-reference property. In case this function is called to enable the internal PID algorithm this function will trigger the PID calculation too. In case the internal algorithm is not enabled no calculations are done but changes in present-value property are distributed also to the manipulated-variable-reference object and changes in the set-point-reference object also update the set-point property along with changes in the controlled- valariable-reference which update the controlled-variable-value property. Initially after object construction the internal PID algorithm in the loop object is disabled. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetLoopEnablePidAlgorithm IEC_BACNET_STATUS Input deviceInst IEC_BACNET_INST_NUMBER The instance number of the local device in which the local loop object exists. instNumber IEC_BACNET_INST_NUMBER The instance number which specifies the local loop object to change. bEnablePidAlgorithm IEC_BACNET_BOOLEAN If set to TRUE the internal PID algorithm will be enabled.

BACnetOptionalPriorityFilterString (FUN) ¶ FUNCTION BACnetOptionalPriorityFilterString : STRING Retrieves the textual value representation for the priority filter enumeration. Return: A pointer to the corresponding character text string. InOut: Scope Name Type Comment Return BACnetOptionalPriorityFilterString STRING Input PriorityBit IEC_BACNET_PRIORITY_FILTER_BITS The corresponding enumration value.

BACnetReAlertLifeSafetyTransition (FUN) ¶ FUNCTION BACnetReAlertLifeSafetyTransition : IEC_BACNET_STATUS Re-transmits an event notification for life safety objects or event-enrollment objects configured to observe life safety states. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetReAlertLifeSafetyTransition IEC_BACNET_STATUS Input instNumber IEC_BACNET_INST_NUMBER The Device object instance number of the Device in which the object is contained. pObjectID POINTER TO IEC_BACNET_OBJECT_ID A pointer to the object identifier for which the event notification should be re-transmitted.

BACnetRegisterInternalActionErrorCallback (FUN) ¶ FUNCTION BACnetRegisterInternalActionErrorCallback : IEC_BACNET_STATUS Registration function for reporting internal API errors to user application. This function registers a callback to report errors to the user application which are generated by internal API actions (sending COV notifications, sending ACR-events or intrinsic-events failed…) for informational or logging purpose only. InOut: Scope Name Type Comment Return BACnetRegisterInternalActionErrorCallback IEC_BACNET_STATUS Input pICallback CmpEventMgr.ICmpEventCallback Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_IACTION_ERR . Purpose documented in BACstack: A pointer to the callabck function to register

BACnetGetDeviceAddressBindingList (FUN) ¶ FUNCTION BACnetGetDeviceAddressBindingList : IEC_BACNET_STATUS Retrieves the entire array or one item of the array of ‘dynamic’ bound addresses. This function may be used by an application to retrieve the complete or part of the array of the address bindings. Unresolved addresses will also be returned in the result in case the parameter bOnlyResolved is FALSE. They will have an global broadcast address (address.net will be set to ::BACNET_NETWORK_GLOBAL and address.len will be set to ::BACNET_MAC_BROADCAST_LENGTH). Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetDeviceAddressBindingList IEC_BACNET_STATUS Input pContents POINTER TO IEC_BACNET_PROPERTY_CONTENTS A pointer to the property contents structure in which the list is stored. The application may initialize the buffer with NULL pointer and 0 size. In this case the API will allocate the neccessary buffer and the application has to release with a call to ::BACnetFreeStackAllocatedMemory if the buffer is no longer needed. nIndex IEC_BACNET_ARRAY_INDEX Specifies which part of the array shall be retrieved. ::BACNET_ENTIRE_ARRAY will return all items in the array. ::BACNET_ARRAY_COUNT will return the buffer filled with an unsigned showing the number of entries in the array. nCount IEC_BACNET_ELEMENT_COUNT Specifies the maximum number of entries to return in the result starting at the given array position. In case of ::BACNET_ENTIRE_ARRAY this will return the first nCount entries. bOnlyResolved IEC_BACNET_BOOLEAN Specifies that unresolved entries shall NOT be reported in this list if set to TRUE.