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.

BACnetGetDeviceAddressBindingsCacheOptions (FUN) ¶ FUNCTION BACnetGetDeviceAddressBindingsCacheOptions : IEC_BACNET_STATUS Configures timing an retry parameters for the ‘dynamic’ address binding procedure. This function reads the timing and retry parameters for the ‘dynamic’ address binding procedure as defined in the BACnet standard. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetDeviceAddressBindingsCacheOptions IEC_BACNET_STATUS Input pRefreshIamCache POINTER TO IEC_BACNET_UNSIGNED Specifies the refresh time in seconds after all listed dynamic bindings get refreshed. After expiration of the refresh interval all bindings are requested using Who-Is requests again. pWhoIsInterval POINTER TO IEC_BACNET_UNSIGNED Specifies the interval in which periodically Who-Is requests are sent as long as they have not been answered and thus it is also the timeout in which an answer is expected. pWhoIsRetries POINTER TO IEC_BACNET_UNSIGNED Specifies the number of retries made before dynamic resolution will stop until next refresh interval has expired. pWhoIsMaxPending POINTER TO IEC_BACNET_UNSIGNED Specifies the maximum number of requests with outstanding replies which might be sent out into the network. pbPrefillCache POINTER TO IEC_BACNET_BOOLEAN If set to True all received I-Am requests from the network are collected even if no dynamic address resolution is requested for that device. pbAllowUnicastIams POINTER TO IEC_BACNET_BOOLEAN If set to True all received Who-Is requests are answered with unicast I am’s sent to the source address over which they have been received. pbAllowBroadcastIams POINTER TO IEC_BACNET_BOOLEAN If set to True all received Who-Is requests are answered with broadcast I am’s. pbUseGlobalBcastWhoIs POINTER TO IEC_BACNET_BOOLEAN If set to True all sent WhoIs gequests will use the global broadcast address to pass over BACnet routers instead of local broadcast addresses which are not routed.

BACnetGetObjectIdNameBindingList (FUN) ¶ FUNCTION BACnetGetObjectIdNameBindingList : IEC_BACNET_STATUS calls the provided callback for each item. An application may use this function to build a list for own use with all pending and resolved object identifier bindings. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetObjectIdNameBindingList IEC_BACNET_STATUS Input devInst IEC_BACNET_INST_NUMBER The device instance number for which the object binding shall be looped through. pICallback CmpEventMgr.ICmpEventCallback Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_OBJECT_ID_CHANGE . Purpose documented in BACstack: A pointer to the callback function.

BACnetGetObjectIdNameBindingsCacheOptions (FUN) ¶ FUNCTION BACnetGetObjectIdNameBindingsCacheOptions : IEC_BACNET_STATUS Configures timing an retry parameters for the ‘dynamic’ object binding procedure. This function reads the timing and retry parameters for the ‘dynamic’ object binding procedure as defined in the BACnet standard. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetObjectIdNameBindingsCacheOptions IEC_BACNET_STATUS Input pRefreshIhaveCache POINTER TO IEC_BACNET_UNSIGNED Specifies the refresh time in seconds after all listed dynamic bindings get refreshed. After expiration of the refresh interval all bindings are requested using Who-Has requests again. pWhoHasInterval POINTER TO IEC_BACNET_UNSIGNED Specifies the interval in which periodically Who-Has requests are sent as long as they have not been answered and thus it is also the timeout in which an answer is expected. pWhoHasRetries POINTER TO IEC_BACNET_UNSIGNED Specifies the number of retries made before dynamic resolution will stop until next refresh interval has expired. pWhoHasMaxPending POINTER TO IEC_BACNET_UNSIGNED Specifies the maximum number of requests with outstanding replies which might be sent out into the network. pbPrefillCache POINTER TO IEC_BACNET_BOOLEAN If set to True all received I-Have requests from the network are collected even if no dynamic object identifier resolution is requested for that object name. pbAllowUnicastIhaves POINTER TO IEC_BACNET_BOOLEAN If set to True all received Who-Has requests are answered with unicast I have’s sent to the source address over which they have been received. pbAllowBroadcastIhaves POINTER TO IEC_BACNET_BOOLEAN If set to True all received Who-Has requests are answered with broadcast I have’s. pbUseGlobalBcastWhoHas POINTER TO IEC_BACNET_BOOLEAN If set to True all sent WhoHas gequests will use the global broadcast address to pass over BACnet routers instead of local broadcast addresses which are not routed.

BACnetGetStackApiVersion (FUN) ¶ FUNCTION BACnetGetStackApiVersion : STRING Returns the current version of the BACnet stack API as STRING. Returns the current version of this BACnet stack API as string in the format: <major-number>.<minor-number>.<patch-number>.<build-number>. InOut: Scope Name Type Comment Return BACnetGetStackApiVersion STRING String in following format: <major-number>.<minor- number>.<patch-number>.<build-number>.

BACnetGetStackApiVersionParts (FUN) ¶ FUNCTION BACnetGetStackApiVersionParts Provides the current version of the BACnet stack API. BACnetGetStackApiVersion returns the current version of this BACnet stack API as string in the format: <major-number>.<minor-number>.<patch-number>.<build-number>. BACnetGetStackApiVersionParts provides the same information as UINT for simple version comparison. InOut: Scope Name Type Output major UINT minor UINT patch UINT build UINT

BACnetGetStructureSizeFromDataType (FUN) ¶ FUNCTION BACnetGetStructureSizeFromDataType : IEC_BACNET_UNSIGNED Function returs the structure size for the given data type. The corresponding size of the c-structure for the given data type or (size_t)-1 is returned in case the given type is invalid. The returned size may be used to advance pointers to the next array or list element in an property contents buffer. InOut: Scope Name Type Comment Return BACnetGetStructureSizeFromDataType IEC_BACNET_UNSIGNED Input dataType IEC_BACNET_DATA_TYPE The BACnet datatype enumeration value.

BACnetInstnumberToDeviceAddress (FUN) ¶ FUNCTION BACnetInstnumberToDeviceAddress : IEC_BACNET_STATUS Function retrieves the BACnet MAC address for an b LOCAL device instance. This functionm is needed if the appication needs to know it’s own device address and how it needs to look if it should be reachable across BACnet networks. For e.g. the application needs to know it’s own address for an specific network because it needs to write an entry into some recipient list. NOTE: Do not mix b LOCAL and b REMOTE device instances here. The function which is needed for resolving b REMOTE instances is ::BACnetFindUpdateDeviceAddressBindings Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetInstnumberToDeviceAddress IEC_BACNET_STATUS Input devInst IEC_BACNET_INST_NUMBER The device instance number for which the address should be retrieved. nRemoteNetnumber IEC_BACNET_UNSIGNED A BACnet network number from where the device instance in question should be accessed. pAddress POINTER TO IEC_BACNET_ADDRESS A pointer to an address structure which is filled by the API on success.

BACnetSetDccPassword (FUN) ¶ FUNCTION BACnetSetDccPassword : IEC_BACNET_STATUS Sets the DCC service password of a local device. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSetDccPassword IEC_BACNET_STATUS Input instNumber IEC_BACNET_INST_NUMBER The Device object instance number of the Device. The special value ::BACNET_INST_NUMBER_MAX will set the given password and flags for ALL current constructued Devices. pPassword POINTER TO IEC_BACNET_STRING Optional pointer to BACnet string structure containing the password to set. If this is NULL, any password will allow the service to be executed (default setting). bSendIamAfterEnable IEC_BACNET_BOOLEAN Flag specifying if an I-Am is sent after the disable duration has expired.

BACnetSetDeviceAddressBindingsCacheOptions (FUN) ¶ FUNCTION BACnetSetDeviceAddressBindingsCacheOptions : IEC_BACNET_STATUS Configures timing an retry parameters for the ‘dynamic’ address binding procedure. This function configures the timing and retry parameters for the ‘dynamic’ address binding procedure as defined in the BACnet standard. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSetDeviceAddressBindingsCacheOptions IEC_BACNET_STATUS Input refreshIamCache IEC_BACNET_UNSIGNED Specifies the refresh time in seconds after all listed dynamic bindings get refreshed. After expiration of the refresh interval all bindings are requested using Who-Is requests again. The lowest value accepted here is 10 and the default is 500 seconds. whoIsInterval IEC_BACNET_UNSIGNED Specifies the interval in which periodically Who-Is requests are sent as long as they have not been answered and thus it is also the timeout in which an answer is expected. The lowest value accepted here is 1 and the default is 5 seconds. whoIsRetries IEC_BACNET_UNSIGNED Specifies the number of retries made before dynamic resolution will stop until next refresh interval has expired. The lowest value accepted is 1 and the default is 5. whoIsMaxPending IEC_BACNET_UNSIGNED Specifies the maximum number of requests with outstanding replies which might be sent out into the network. The lowest value accepted here is 1 and the default is 20. bPrefillCache IEC_BACNET_BOOLEAN If set to True all received I-Am requests from the network are collected even if no dynamic address resolution is requested for that device. bAllowUnicastIams IEC_BACNET_BOOLEAN If set to True all received Who-Is requests are answered with unicast I am’s sent to the source address over which they have been received. True is the default setting for this option. bAllowBroadcastIams IEC_BACNET_BOOLEAN If set to True all received Who-Is requests are answered with broadcast I am’s. False is the default setting for this option. bUseGlobalBcastWhoIs IEC_BACNET_BOOLEAN If set to True all sent WhoIs gequests will use the global broadcast address to pass over BACnet routers instead of local broadcast addresses which are not routed.