BACnetWriteProperty (FUN) ¶ FUNCTION BACnetWriteProperty : IEC_BACNET_STATUS Sends a WriteProperty request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWriteProperty IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pServiceInfo POINTER TO IEC_BACNET_WRITE_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.

BACnetReadRange (FUN) ¶ FUNCTION BACnetReadRange : IEC_BACNET_STATUS Sends a ReadRange request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetReadRange IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pServiceInfo POINTER TO IEC_BACNET_READ_RANGE_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pResult POINTER TO IEC_BACNET_READ_RANGE_RESULT This parameter points to an memory location in which the service result will be stored. pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.

BACnetReinitializeDevice (FUN) ¶ FUNCTION BACnetReinitializeDevice : IEC_BACNET_STATUS Sends a reinitializeDevice request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetReinitializeDevice IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pServiceInfo POINTER TO IEC_BACNET_REINIT_DEV_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR In case of any service execution error the error result will be stored in the structure this pointer references. This parameter may be NULL if the application isn’t interested in detailed error information.

BACnetUnconfTextMessage (FUN) ¶ FUNCTION BACnetUnconfTextMessage : IEC_BACNET_STATUS Sends a unconfirmed TextMessage. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetUnconfTextMessage IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pServiceInfo POINTER TO IEC_BACNET_TEXT_MESSAGE_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process.

BACnetWhoAmI (FUN) ¶ FUNCTION BACnetWhoAmI : IEC_BACNET_STATUS Sends a who-am-i request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWhoAmI IEC_BACNET_STATUS Input devInst IEC_BACNET_INST_NUMBER Instance number of the local Device from which the request should be sent. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent.

BACnetWhoAmIEx (FUN) ¶ FUNCTION BACnetWhoAmIEx : IEC_BACNET_STATUS Sends a who-am-i request with specified service parameters. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWhoAmIEx IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be NULL. In this case the MAC address of this device will be used. Otherwise this shall be the MAC address returned on device object construction. pDestinationAddress POINTER TO IEC_BACNET_ADDRESS This is the MAC address of the device to which the request should be sent. pServiceInfo POINTER TO IEC_BACNET_WHO_AM_I_INFO Pointer to structure which contains all service data required for initiating this request.

BACnetUnregisterClientEventNotification (FUN) ¶ FUNCTION BACnetUnregisterClientEventNotification : IEC_BACNET_STATUS Releases an device notification class reference from event acquisation. The user application can remove device notification class references from event acquisation which it doesn’t need anymore. If the user application has registered an callback for unsubscribe completion, it will get notified about the successful or unsuccessful unsubscription asynchronously. ::BACNET_STATUS BACNET_STATUS_BUSY: if unsubscription is pending. The registered unsubscribe-complete callback will be called on completion BACNET_STATUS_OK: unsubscription completed. The registered unsubscribe-complete callback WILL NOT BE CALLED OTHER: some other failure in given parameters has been detected InOut: Scope Name Type Comment Return BACnetUnregisterClientEventNotification IEC_BACNET_STATUS Input hCustomer IEC_BACNET_HANDLE An handle to an created advanced BACnet client customer created by ::BACnetOpenClientCustomer. devId IEC_BACNET_INST_NUMBER The device instance number from the remote or local device from which the events or alarms shall NOT be acquired anymore. notifClass IEC_BACNET_INST_NUMBER The notification class object instance number from the remote or local device from which the events or alarms shall NOT be acquired anymore.

BACnetWriteFileObjectContents (FUN) ¶ FUNCTION BACnetWriteFileObjectContents : IEC_BACNET_STATUS Function initiates a file data transfer to write the file object data. This function will start a file data transfer to write the specified file object data in the specified device. In case of stream data in the specified file object the data is expected in binary format. In case of record data in the file object the record is expected also in binary format but is may be expected in the extended format for each record by a record marker and record size. If the records data is not in the expected format some error will be returned. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWriteFileObjectContents IEC_BACNET_STATUS Input pInfo POINTER TO IEC_BACNET_FILEACCESS_INFO Pointer to information which specifies which device and which file object will be accessed and the format of the file data in case of a record access file object. pICallback CmpEventMgr.ICmpEventCallback Pointer to the event-callback interface. Event-callback argument type is EVT_BACNET_FILEACCESS_PROGRESS . Purpose documented in BACstack: Pointer to the user application callback funktion to inform about failures and progress information during the data transfer procedure. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the structure which contains a set of APDU properties to control the timing and size of transmitted frames for this request. It temporarily overwrites the global APDU settings made in the source device from which this request is sent and which parameters would control this request if this pointer is NULL. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken .

BACnetCommonAPI ¶ Functions for directly accessing common BACnet functionalities of the BACnet component on the runtime system. BACnetCloseServerEtc BACnetClose (Function) BACnetCopyPropertyContents (Function) BACnetDecodeAsn1StandardProperty (Function) BACnetDeleteDeviceAddressBindings (Function) BACnetDeleteObjectIdNameBindings (Function) BACnetDeviceAddressToInstNumber (Function) BACnetDumpStackInformation (Function) BACnetEncodeAsn1StandardProperty (Function) BACnetFindUpdateDeviceAddressBindings (Function) BACnetFindUpdateObjectIdNameBindings (Function) BACnetFreeStackAllocatedMemory (Function) BACnetGetBACstackTaskPriority (Function) BACnetGetDatabaseObjectDescription (Function) BACnetGetDatabaseObjectPropertyDescription (Function) BACnetGetDccPassword (Function) BACnetGetDccValueAndTimeout (Function) BACnetGetDeviceAddressBindingList (Function) BACnetGetDeviceAddressBindingsCacheOptions (Function) BACnetGetObjectIdNameBindingList (Function) BACnetGetObjectIdNameBindingsCacheOptions (Function) BACnetGetStackApiVersion (Function) BACnetGetStackApiVersionParts (Function) BACnetGetStructureSizeFromDataType (Function) BACnetInstnumberToDeviceAddress (Function) BACnetLockDatabaseAccess (Function) BACnetLoopEnablePidAlgorithm (Function) BACnetOptionalPriorityFilterString (Function) BACnetReAlertLifeSafetyTransition (Function) BACnetRegisterAddressBindingsChangeCallback (Function) BACnetRegisterInternalActionErrorCallback (Function) BACnetRegisterObjectIdNameBindingsChangeCallback (Function) BACnetRegisterTimeProviderFunction (Function) BACnetSendDeviceRestartNotification (Function) BACnetSendNetworkManagementMessage (Function) BACnetSetBACstackTaskPriority (Function) BACnetSetCallback (Function) BACnetSetDccPassword (Function) BACnetSetDccValueAndTimeout (Function) BACnetSetDeviceAddressBindingsCacheOptions (Function) BACnetSetHook (Function) BACnetSetObjectIdNameBindingsCacheOptions (Function) BACnetSetRoutingFilterCallback (Function) BACnetSrvcAbortCbCompletion (Function) BACnetSrvcErrorCbCompletion (Function) BACnetSrvcGetMacAddressesFromHandle (Function) BACnetSrvcGetPortIdAndLinkTypeFromHandle (Function) BACnetSrvcIgnoreCbCompletion (Function) BACnetSrvcRejectCbCompletion (Function) BACnetSrvcResponseCbCompletion (Function) BACnetStackControl (Function) BACnetSubscribeCovPropMultipleErrorCbCompletion (Function) BACnetTimeProviderTimeChangedTrigger (Function) BACnetTimeSynchronization (Function) BACnetUTCTimeSynchronization (Function) BACnetUnlockDatabaseAccess (Function) String_ToText BACnetAccessCredentialDisableReasonString (Function) BACnetAccessCredentialDisableString (Function) BACnetAccessDoorPVString (Function) BACnetAccessEventString (Function) BACnetAccessPassbackModeString (Function) BACnetAccessUserTypeString (Function) BACnetAccessZoneOccupancyStateString (Function) BACnetAccumulatorStatusString (Function) BACnetActionString (Function) BACnetAuditLevelString (Function) BACnetAuditOperationString (Function) BACnetAuthenticationStatusString (Function) BACnetAuthorizationModeString (Function) BACnetBackupStateString (Function) BACnetBinaryPVString (Function) BACnetDataTypeString (Function) BACnetDayOfWeekBitsString (Function) BACnetDayOfWeekString (Function) BACnetDevStatusString (Function) BACnetDoorAlarmStateString (Function) BACnetDoorSecuredStatusString (Function) BACnetDoorStatusString (Function) BACnetDoorValueString (Function) BACnetEnumString (Function) BACnetEventStateString (Function) BACnetEventTransitionString (Function) BACnetEventTypeString (Function) BACnetFileAccessString (Function) BACnetLifeSafetyModeString (Function) BACnetLifeSafetyOpString (Function) BACnetLifeSafetyStateString (Function) BACnetLightingInProgressString (Function) BACnetLightingTransitionString (Function) BACnetLimitEnableString (Function) BACnetLockStatusString (Function) BACnetLoggingTypeString (Function) BACnetMaintenanceString (Function) BACnetMonthString (Function) BACnetNodeTypeString (Function) BACnetNotifyTypeString (Function) BACnetObjTypeString (Function) BACnetObjectIdToText (Function) BACnetPDUtypeToText (Function) BACnetPolarityString (Function) BACnetProgramErrorString (Function) BACnetProgramRequestString (Function) BACnetProgramStateString (Function) BACnetPropIDString (Function) BACnetPropertyIdToText (Function) BACnetReliabilityString (Function) BACnetSecurityLevelString (Function) BACnetSegmentString (Function) BACnetServiceChoiceToText (Function) BACnetServiceString (Function) BACnetShedStateString (Function) BACnetSilencedStateString (Function) BACnetStatusFlagString (Function) BACnetUnitsString (Function) BACnetVtClassesSupportedString (Function)

BACnetSetClientGlobalCommTimingParameters (FUN) ¶ FUNCTION BACnetSetClientGlobalCommTimingParameters : IEC_BACNET_STATUS Sets the global communication parameters of the advanced client API. This function gives a user application the ability to configure the used APDU timings for communication with remote BACnet devices. During connection establishment the APDU parameters are read from the remote BACnet devices and used. But in some cases it might be useful to override those parameters.n To remove the global timing parameters and use the dynamically assigned ones again set nTimeout, nSegmentTimeout and nRetryCount to -1.n To disable the periodic alive check set nAliveCheckInterval to 0. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSetClientGlobalCommTimingParameters IEC_BACNET_STATUS Input nTimeout IEC_BACNET_UINT This is the APDU timeout in milliseconds (see ::BACNET_APDU_PROPERTIES for further information to this paramter). nSegmentTimeout IEC_BACNET_UINT This is the APDU segment timeout in milliseconds (see ::BACNET_APDU_PROPERTIES for further information to this paramter). nRetryCount IEC_BACNET_UINT This is the APDU retry count (see ::BACNET_APDU_PROPERTIES for further information to this paramter). nAliveCheckInterval IEC_BACNET_UINT This is the alive check interval in milliseconds in which periodical requests are sent to devices to check if they are still alive. If this is set to 0 no alive check will be performed at all. The default interval is 15000 milliseconds. nErrorAliveCheckInterval IEC_BACNET_UINT In case of an detected communication failure this value is used as the timer trying to establish communication again. The default interval is 15000 milliseconds. nErrorCovCheckInterval IEC_BACNET_UINT In case a subscribe for COV(-P) failed and the error returned was of a temporarily kind this interval in seconds is the interval at which retries for subscriptions are executed. The default is 3600 seconds. This interval is only active in case the fallback to polling is allowed for that registered datapoint. nCovSubcribeWatchdogTimer IEC_BACNET_UINT This specifies the time in seconds to use for the observation timer to expect a COV notification received after the subscribe request has been sent and confirmed. If no COV notification is received within this time the subscription is marked as not successful and polling for this property will be activated if not disabled. In case of receiving a COV notification after this time the polling will stop and the COV bad marking will be removed. A value of 0 will use the default time calculated from APDU timeout x APDU retries x 3. The maximum value used for this timer will be 600 seconds. nMaxClntErrorCounts IEC_BACNET_UINT Number of detected communication failures needed to switch state to offline. The default interval is 5. bReportErrors IEC_BACNET_BOOLEAN If set to True special error checking will take place on reception of COV, COVP and event notifications. If the API receives an notification for an device object property reference which is not registered by any customer it will reply an error to the sender of the notification. If set to False those notifications will be positiv acknowledged. The default is False. bExtendedDeviceInfo IEC_BACNET_BOOLEAN If set to True extended device information will be read on connection establishment and provided to the user application in the ::BACNET_REMOTE_DEVICE_CAPS structure. bNoUseOfRPM IEC_BACNET_BOOLEAN If set to True the polling of all registered object properties will be made using the ReadProperty service and not the ReadPropertyMultiple service event if the corresponding device supports this service. bUseDeviceId IEC_BACNET_BOOLEAN If set to True all subscriptions in recipient lists for event and device-restart notifications will be written by using the device-id entry type instead of the MAC address type of the recipient. bNoCheckForMissingCovs IEC_BACNET_BOOLEAN If set to True the timer for expecting COV notification after the (re-)subscribe is not activated. So in case the COV subscription does not lead to a COV notification in time frame specified with nCovSubcribeWatchdogTimer or APDU timeout x APDU retries x 3 as default, no event of a possible COV subscription failure will be returned to the users application and loss of data might be possible for some devices which have problems in their COV implementation in case the fallback of polling is disabled too.