ServiceReader.TagId (PROP) ¶ PROPERTY TagId : UDINT

BACnetRegisterClientEventNotification (FUN) ¶ FUNCTION BACnetRegisterClientEventNotification : IEC_BACNET_STATUS Registers an device notification class reference for event and alarm acquisation. This function enables the user appliaction to subscribe to an event and alarm source very easy. This function will do most of the work, normally a client application has to manage, just in one call. It checks periodical for the presence and online state for devices and checks for integrity of the alarms and event acquired from other devices. InOut: Scope Name Type Comment Return BACnetRegisterClientEventNotification 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 be acquired. notifClass IEC_BACNET_INST_NUMBER The notification class object instance number from the remote or local device from which the events or alarms shall be acquired. pValidTransitions POINTER TO IEC_BACNET_BIT_STRING A pointer to an bit string structure which contians the bits for the transitions on which a notification shall be sent. More information can be found under BACNET_DESTINATION pValidDays POINTER TO IEC_BACNET_BIT_STRING A pointer to an bit string structure which contians the bits for the weekdays on which a notification shall be sent. More information can be found under BACNET_DESTINATION pFromTime POINTER TO IEC_BACNET_TIME A pointer to a time structure which contains the start time at which notifications shall be sent. More information can be found under BACNET_DESTINATION pToTime POINTER TO IEC_BACNET_TIME A pointer to a time structure which contains the end time at which notifications shall NOT be sent anymore. More information can be found under BACNET_DESTINATION nSubscribeMode IEC_BACNET_CLIENT_SUBSCRIBE_MODE This defines how the data is acquired. pICallback CmpEventMgr.ICmpEventCallback A pointer to the event-callback interface which gets called on BACnet event notification. To unregister a NULL pointer shall be used here. pUserArg POINTER TO BYTE A pointer to data from the user application which is transparent for the API. This pointer will not be modified by the BACnet API. This pointer and the pUserFct pointer is associated with the given device instance and notification class object instance pair. So for every different combination of those parameters these pointers are stored. This pointer may be NULL.

BACnetRegisterClientUnsubscribeCompletionCallback (FUN) ¶ FUNCTION BACnetRegisterClientUnsubscribeCompletionCallback : IEC_BACNET_STATUS Registers the user application callback for completed unregistrations. This registers a callback routine. This callback can be registered at any time. If the callback is registered more than once, the new callback procedure replaces old one. A NULL pointer cancels the callback. This function gives a user application the ability to get notified if an unregistration of device object property reference has completed. Depending on the type of registration made (COV, COVP or POLLING), an unregistration may need some time to be processed. The function for initiation of the unregistration BACnetUnregisterClientDataPoint completes directly but the callback is called after the unsubscription for event or value notification in the remote device has completed. The application may only expect unsubscribe complete callbacks for which the BACnetUnregisterClientDataPoint function call has returned the BACNET_STATUS_BUSY. In case that all registered references have been retrievd by polling this function callback will also be called for the last customer which unregisters the last reference to an device but the referenced object will be the device and the property will be PROP_ALL and the index BACNET_VOID_INDEX (-1). InOut: Scope Name Type Comment Return BACnetRegisterClientUnsubscribeCompletionCallback IEC_BACNET_STATUS Input hCustomer IEC_BACNET_HANDLE An handle to an created advanced BACnet client customer created by BACnetOpenClientCustomer . pICallback CmpEventMgr.ICmpEventCallback A pointer to the event-callback interface which gets called which gets called on completion of an unregistration. To unregister a NULL pointer shall be used here. pUserUnsubArg POINTER TO BYTE A pointer to data from the user application which is transparent for the API. This pointer will not be modified by the BACnet API. This may be NULL.

BACnetRestartAllClients (FUN) ¶ FUNCTION BACnetRestartAllClients : IEC_BACNET_STATUS Resets for all registered devices their communication state to INIT. Calling this function will reset the communication state for all registered devices, objects and properties to it’s initial state. The advanced BACnet client API will re-establish the communication to all devices as if they have been registered for the first time. InOut: Scope Name Type Return BACnetRestartAllClients IEC_BACNET_STATUS

BACnetRestoreBACnetDevice (FUN) ¶ FUNCTION BACnetRestoreBACnetDevice : IEC_BACNET_STATUS Function initiates a restore for an BACnet device. This function will start an restore procedure for the specified device. InOut: Scope Name Type Comment Return BACnetRestoreBACnetDevice IEC_BACNET_STATUS Input pInfo POINTER TO IEC_BACNET_BACKUPRESTORE_INFO Pointer to information which specifies which device should be restored and where the file object data is stored to be restored. pICallback CmpEventMgr.ICmpEventCallback A pointer to the event-callback interface to inform about failures and progress information during the procedure execution. pAPDUParams POINTER TO IEC_BACNET_APDU_PROPERTIES A pointer to the APDU-Properties structure which sets APDU properties for this transaction only. This does not change global defaults or settings for the application APDU Properties. This argument may be NULL. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. phTransaction POINTER TO BYTE The handle which identifies the transaction handled by the user application. The given handle has to be unique, in case the application needs to separate multiple pending requests. This handle is transparent for the BACnet API and is returned unchanged to the user application in the completion routine callback. This handle may be NULL, but the user application will be unable to cancel pending requests by a call to BACnetCancelPendingConfirmedRequest or to separate them in the callback if multiple completions are pending in such case.

BACnetSetClientDeviceCommunication (FUN) ¶ FUNCTION BACnetSetClientDeviceCommunication : IEC_BACNET_STATUS Enables or disables communication in the advanced BACnet client API to devices. The user application can enable or disable communication to registered devices. If communication is disabled to one or ALL devices, the connection state change callback will be called for all customers which have registerd that callback for the device. If a new device is registered it’s communication state is initially enabled by default. InOut: Scope Name Type Comment Return BACnetSetClientDeviceCommunication IEC_BACNET_STATUS Input devId IEC_BACNET_INST_NUMBER The device instance number for which communication needs to be changed. A value of 0xFFFFFFFF will change the state of ALL registered devices including the global communication enable / disable state. dccValue IEC_BACNET_DCC_VALUE Specifies if communication should be enabled ( DCC_ENABLE ) or disabled ( DCC_DISABLE or DCC_OFFLINE )

BACnetSetClientDeviceFixAddress (FUN) ¶ FUNCTION BACnetSetClientDeviceFixAddress : IEC_BACNET_STATUS Registers a fix MAC address for communication with the advanced BACnet client API. The user application can register a fix MAC address for communication to an remote BACnet device instead of using dynamic address binding which is the default for this API. InOut: Scope Name Type Comment Return BACnetSetClientDeviceFixAddress IEC_BACNET_STATUS Input devId IEC_BACNET_INST_NUMBER The device instance number for which a fix MAC address shall be registered. pAddress POINTER TO IEC_BACNET_ADDRESS A pointer to a valid MAC address structure which contains the network address under which the given device instance number is reachable. To go back to dynamic address binding this parameter shall be NULL.

BACnetSetClientDeviceFixSubscribeCovTime (FUN) ¶ FUNCTION BACnetSetClientDeviceFixSubscribeCovTime : IEC_BACNET_STATUS Function sets or deletes an fix daily timepoint for sending resubscribes instead of using an configured intervall. This Function sets or deletes an fix daily timepoint for sending resubscribes instead of using an configured intervall. Main use of this function is to be able to separate resubscribe attempts for devices so that the will not be sent at the same time as this would happen if using the same intervall for many registered objects in different devices which could put heavy traffinc on the network. InOut: Scope Name Type Comment Return BACnetSetClientDeviceFixSubscribeCovTime IEC_BACNET_STATUS Input devId IEC_BACNET_INST_NUMBER The device instance number for which an fixed timepoint for sending COV/COVP resubscribe requests shall be set or deleted. pSubscribeTime POINTER TO IEC_BACNET_TIME A pointer to an BACnet time structure containing the timepoint for fixed sending of the COV/COVP resubscribe requests. A NULL pointer removes the fix timepoint and reverts using given intervalls configured with function BACnetRegisterClientDataPoint .

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. To remove the global timing parameters and use the dynamically assigned ones again set nTimeout, nSegmentTimeout AND nRetryCount TO -1. To disable the periodic alive check set nAliveCheckInterval to 0. InOut: Scope Name Type Comment Return BACnetSetClientGlobalCommTimingParameters IEC_BACNET_STATUS Input nTimeout IEC_BACNET_UNSIGNED This is the APDU timeout in milliseconds (see |BACNET_APDU_PROPERTIES| for further information to this paramter). nSegmentTimeout IEC_BACNET_UNSIGNED This is the APDU segment timeout in milliseconds (see |BACNET_APDU_PROPERTIES| for further information to this paramter). nRetryCount IEC_BACNET_UNSIGNED This is the APDU retry count (see | BACNET_APDU_PROPERTIES|for further information to this paramter). nAliveCheckInterval IEC_BACNET_UNSIGNED 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. nErrorAliveCheckInterval IEC_BACNET_UNSIGNED In case of an detected communication failure this value is used as the timer trying to establish communication again. 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. 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 IEC_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.

BACnetSetClientGlobalMaxDeviceActions (FUN) ¶ FUNCTION BACnetSetClientGlobalMaxDeviceActions : IEC_BACNET_STATUS Sets the maximum pending requests per registered device. This function gives a user application the ability to restrict the maximum pending requests to one device. The advanced BACnet client API uses asynchronous requests for communication to devices. So it is able to send multiple requests to one device at the same time. As soon as the device responses, an new request will be sent as long as there are any requests in the queue for that device. InOut: Scope Name Type Comment Return BACnetSetClientGlobalMaxDeviceActions IEC_BACNET_STATUS Input nMaxActionsPerDevice IEC_BACNET_UNSIGNED Number of maximum pending requests per registered device. Valid ranges are values from 2 till 250. The default on registration is 40 for a new device. nMaxRpmItemCounts IEC_BACNET_UNSIGNED Number of maximum object items or property items in one ReadPropertyMultiple request sent to an device. The default is 100 items. Valid range values from 10 to 500 items.