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.