BACnetSetHook (FUN) ¶ FUNCTION BACnetSetHook : IEC_BACNET_STATUS Sets / registers a service hook Registers a hook routine, which is the service application hook. The service application hook may override the default API processing of some BACnet service requests. A hook can be registered at any time. One hook procedure is registered per service. If the same service is hooked more than once (the hook is registered more than once for the same service), the new hook procedure replaces old one. A NULL procedure pointer cancels the hook. InOut: Scope Name Type Comment Return BACnetSetHook IEC_BACNET_STATUS A status indicating whether the operation worked. Input eHookType IEC_BACNET_CB_TYPE The hook type which shold be registered. pICallback CmpEventMgr.ICmpEventCallback A pointer to the hook event interface. Hook routines are provided by the application.
BACnetSetObjectIdNameBindingsCacheOptions (FUN) ¶ FUNCTION BACnetSetObjectIdNameBindingsCacheOptions : IEC_BACNET_STATUS Configures timing an retry parameters for the ‘dynamic’ object binding procedure. This function configures 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 BACnetSetObjectIdNameBindingsCacheOptions IEC_BACNET_STATUS Input refreshIhaveCache 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. The lowest value accepted here is 10 and the default is 500 seconds. whoHasInterval 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. The lowest value accepted here is 1 and the default is 5 seconds. whoHasRetries 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. whoHasMaxPending 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-Have requests from the network are collected even if no dynamic object identifier resolution is requested for that object name. bAllowUnicastIhaves 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. True is the default setting for this option. bAllowBroadcastIhaves IEC_BACNET_BOOLEAN If set to True all received Who-Has requests are answered with broadcast I have’s. False is the default setting for this option. bUseGlobalBcastWhoHas 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.
BACnetFreeStackAllocatedMemory (FUN) ¶ FUNCTION BACnetFreeStackAllocatedMemory Application can release BACnet API allocated memory by calling this. Some BACnet service functions (like ::BACnetReadPropertyMultiple) which retrieve information from BACnet devices, may be allowed to allocate it’s own memory to deliver the values to the user. The user has to initialize the pointer with NULL and size of buffer with 0 in that case. The returned memory should be freed with this function if the user doesn’t need the buffer contents any more. InOut: Scope Name Type Comment Input pMemory POINTER TO IEC_BACNET_BYTE The pointer to memory which had been allocated by the stack API during an BACnet service request.
BACnetGetBACstackTaskPriority (FUN) ¶ FUNCTION BACnetGetBACstackTaskPriority : IEC_BACNET_STATUS Get the task priority of the BACstack process task. The BACstack process task priority can be configured in CODESYScontrol.cfg, section [CmpBACnet] entry TaskPrio. To support configuration of this task priority from either project object tree or user application BACnetSetBACstackTaskPriority can be used prior to starting the BACnet server. Setting the task priority using BACnetSetBACstackTaskPriority does have precedence over the value configured in CODESYScontrol.cfg. BACnetGetBACstackTaskPriority gets the resulting task priority. InOut: Scope Name Type Return BACnetGetBACstackTaskPriority IEC_BACNET_STATUS Output taskPrio UDINT
BACnetGetDatabaseObjectDescription (FUN) ¶ FUNCTION BACnetGetDatabaseObjectDescription : POINTER TO IEC_BACNET_PROPERTY_DESCRIPTION_LIST Function for retrieving information about object properties. This function can be called by an user application that needs information about which standard properties are defined for an particular object type. Return: A pointer of type ::BACNET_PROPERTY_DESCRIPTION_LIST or NULL. InOut: Scope Name Type Comment Return BACnetGetDatabaseObjectDescription POINTER TO IEC_BACNET_PROPERTY_DESCRIPTION_LIST Input objectType IEC_BACNET_OBJECT_TYPE The object type for which the caller wants the set of property informations.
BACnetGetDatabaseObjectPropertyDescription (FUN) ¶ FUNCTION BACnetGetDatabaseObjectPropertyDescription : POINTER TO IEC_BACNET_PROPERTY_DESCRIPTION Function for retrieving information about an single object property. This function can be called by an user application that needs information about an standard property that is defined for an particular object type. Return: A pointer of type ::BACNET_PROPERTY_DESCRIPTION or NULL. InOut: Scope Name Type Comment Return BACnetGetDatabaseObjectPropertyDescription POINTER TO IEC_BACNET_PROPERTY_DESCRIPTION Input objectType IEC_BACNET_OBJECT_TYPE The object type for which the caller wants the property information. propertyID IEC_BACNET_PROPERTY_ID The property identifier for which the caller wants the information. bOnlyStandard IEC_BACNET_BOOLEAN If set to True and the user application has defined some proprietary objects their property information will be returned here too.
BACnetSetDccValueAndTimeout (FUN) ¶ FUNCTION BACnetSetDccValueAndTimeout : IEC_BACNET_STATUS Sets the device communication control status of a local device along with some tinmeout in secnds for automatic reset to enabled. If a local device in the database shall not respond to any APDU received the value DCC_DISABLE shall be set. If a local device shall only stop initiatig request on its own the value DCC_DISABLE_INITIATION shall be set. If a local device shall execute all received requests the value DCC_ENABLE shall be set. The default value after construction of a local device is DCC_ENABLE. The timeout specified may only be applied for one the disabled states and not for the enabled state. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSetDccValueAndTimeout IEC_BACNET_STATUS Input instNumber IEC_BACNET_INST_NUMBER The Device object instance number of the Device. value IEC_BACNET_DCC_VALUE The device communication value to set for the specified device. nTimeout IEC_BACNET_UINT The timeout in seconds for automatic reset to the enabled state. The value of ::BACNET_DCC_INDEFINITE will disable the automatic reset.
BACnetRegisterAddressBindingsChangeCallback (FUN) ¶ FUNCTION BACnetRegisterAddressBindingsChangeCallback : IEC_BACNET_STATUS Registers a callback for address changes on dynamic address bindings. With this callback a user application gets informed about any detected address changes or finished address resolutions which were pending and have completed now. This callback is only called on successful address resolutions or changes. It won’t be called on expired retries or timeouts for an pending resolution. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetRegisterAddressBindingsChangeCallback IEC_BACNET_STATUS Input pICallback CmpEventMgr.ICmpEventCallback Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_ADDRESS_CHANGE . Purpose documented in BACstack: A pointer to the callback function to register.
BACnetGetDccPassword (FUN) ¶ FUNCTION BACnetGetDccPassword : POINTER TO IEC_BACNET_STRING Returns the current DCC password of a local device. Pointer to ::BACNET_STRING structure containing the current set password for the DCC service. This pointer references a internal structure in the database and should not be freed or modified by the user application. InOut: Scope Name Type Comment Return BACnetGetDccPassword POINTER TO IEC_BACNET_STRING Input instNumber IEC_BACNET_INST_NUMBER The Device object instance number of the Device. pbSendIamAfterEnable POINTER TO IEC_BACNET_BOOLEAN Optional pointer to return the send I-Am after enable flag.
BACnetGetDccValueAndTimeout (FUN) ¶ FUNCTION BACnetGetDccValueAndTimeout : IEC_BACNET_STATUS Returns the current DCC status of a local device and its remaining timout before reset to enable in seconds. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetDccValueAndTimeout IEC_BACNET_STATUS Input instNumber IEC_BACNET_INST_NUMBER The Device object instance number of the Device. pValue POINTER TO IEC_BACNET_DCC_VALUE A pointer to store the actual device communication control value from the specified device. pnTimeout POINTER TO IEC_BACNET_UINT A pointer to store the remaining timeout in seconds before the reset to enabled occurs. If no timeout is active the value ::BACNET_DCC_INDEFINITE is returned here.
