BACnetConfPrivateTransfer (FUN) ¶ FUNCTION BACnetConfPrivateTransfer : IEC_BACNET_STATUS ConfirmedPrivateTransfer completion routine. Sends a request to invoke proprietary or non-standard confirmed service in a remote device. This routine may control APDU properties like APDU length, segmentation, and timeout for both request and response. This routine can execute asynchronously, so this routine will return to the caller before the BACnet reply is received so that the applications keeps running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_PRIVATE_XFER_COMPLETE_CB routine, which has to be provided by the BACnet application, will be used to process this information. If a number of asynchronous requests are sent, the responses will be queued and identified by the transaction handles. If the application does not supply the BACNET_PRIVATE_XFER_COMPLETE_CB routine, then the BACnetConfPrivateTransfer routine sends a request and waits for reply. return IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetConfPrivateTransfer IEC_BACNET_STATUS Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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_PRIVATE_TRANSFER_INFO A pointer to the service information data structure. This data structure is to transport the service parameters to the destination device. 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. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pResult POINTER TO IEC_BACNET_PRIVATE_TRANSFER_INFO A pointer to a buffer to hold the Result data if successful executed (datatype IEC_BACNET_PRIVATE_TRANSFER_INFO). The application may initialize the parameters member of the IEC_BACNET_PRIVATE_TRANSFER_INFO struture with a NULL pointer and bufferSize with 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be NULL if the application isn’t interested in detailed error information.

BACnetConfTextMessage (FUN) ¶ FUNCTION BACnetConfTextMessage : IEC_BACNET_STATUS Sends an confirmed TextMessage. Sends a request to transmit a text to the remote device. Message may be prioritized into Normal or Urgent categories. In addition, a text message may be optionally classified by a numeric class code or class identification string. The interpretation of the class is a local matter. This routine may control APDU properties like APDU length, segmentation, and timeout, for both request and response. This routine can execute asynchronously, so this routine will return to the caller before the BACnet reply is received so that the applications keeps running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_SIMPLE_ACK_COMPLETE_CB routine, which has to be provided by the BACnet application, will be used to process this information. If a number of asynchronous requests are sent, the responses will be queued and identified by the transaction handles. If application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine, then this routine sends a request and waits for reply. InOut: Scope Name Type Comment Return BACnetConfTextMessage 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 the service information data structure. This data structure of datatype BACNET_TEXT_MESSAGE_INFO contains an object Identifier of device object of the request initiator, a boolean if Message Class Present attribute, a message class, a message priority, a message string type and a message string. 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. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be NULL if the application isn’t interested in detailed error information.

BACnetCreateObject (FUN) ¶ FUNCTION BACnetCreateObject : IEC_BACNET_STATUS Sends a CreateObject request. Sends a request to create a new instance of an object which may be as standard as vendor-specified object. This service may provide initialization of the properties of the newly created standard objects or the property values may be written later. This routine may control APDU properties like APDU length, segmentation and timeout for both request and response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the applications can keep running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_CREATE_OBJECT_COMPLETE_CB routine, which is provided by the BACnet application, shall be used to process this information. If a number of asynchronous requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply the BACNET_CREATE_OBJECT_COMPLETE_CB routine; then this routine sends a request and waits for reply. InOut: Scope Name Type Comment Return BACnetCreateObject IEC_BACNET_STATUS A status indicating if the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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_CREATE_OBJECT_INFO A pointer to the request information data structure. This data structure specifies either Object Type or ObjectID to create a new instance of an object and a list of property values. 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information. pObjectID POINTER TO BACnetCreateObjectResult A pointer to the memory block to return the object Identifier of a newly created object, plus the “first failed” property which may be 0. See BACnetCreateObjectResult pFirstFailed POINTER TO IEC_BACNET_UNSIGNED A pointer to a buffer in which to place the sequence number of the first element in the pElements list which cannot be added to the property. pFirstFailed may be 0.

BACnetCreateObjectResult (STRUCT) ¶ TYPE BACnetCreateObjectResult : STRUCT A data transport unit for results of BACnetCreateObject . BACnetCreateObjectResult transports a pointers to an object-ID and the “first failed” sequence number. The caller had to provide the memory pointed to by those pointers. InOut: Name Type Comment pObjectID POINTER TO IEC_BACNET_OBJECT_ID A pointer to the memory block to return the object Identifier of a newly created object if successfully creating of the object, and successfully initializing all the properties specified. pFirstFailed POINTER TO IEC_BACNET_UNSIGNED A pointer to the memory block to transport the numerical position, started at 1, of the offending property value which was successfully written. If the present request is considered invalid for reasons other than property initialization or the present request is valid, this argument shall have a value of zero.

BACnetDeleteObject (FUN) ¶ FUNCTION BACnetDeleteObject : IEC_BACNET_STATUS Sends a DeleteObject request. Sends a request to remote device to delete an existing object. This service cannot be applied to Device object. This routine may control APDU properties like APDU length, segmentation and timeout for both request and response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the applications can keep running. In this case the response information will be received by the thread that is responsible for receiving asynchronous responses. An optional BACNET_SIMPLE_ACK_COMPLETE_CB routine, which is provided by the BACnetc application, shall be used to process this information. If a number of asynchronous requests are sent, the responses shall be queued and identified by the transaction handles. If application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine; then the BACnetDeleteObject routine sends a request and waits for reply. InOut: Scope Name Type Comment Return BACnetDeleteObject IEC_BACNET_STATUS A status indicating if the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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. pObjectID POINTER TO IEC_BACNET_OBJECT_ID A pointer to the memory block to convey the Object Identifier of the Object to delete. 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.

BACnetDeviceCommControl (FUN) ¶ FUNCTION BACnetDeviceCommControl : IEC_BACNET_STATUS Sends a deviceCommunicationControl request. Instructs a remote device to enable/disable initiating and responding to all APDUs (except Device-Communication-Control and Reinitialize-Device, in the IEC_BACNET_DCC_VALUE.DCC_DISABLE case). This routine may control APDU properties like APDU length, segmentation and timeout for both request and response. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the applications can keep running. In this case the response information will be received by the thread that is responsible for receiving asynchronous responses. An optional BACNET_SIMPLE_ACK_COMPLETE_CB routine, which is provided by the BACnet application, shall be used to process this information. If a number of asynchronous requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine; then the BACnetDeviceCommControl routine sends a request and waits for reply. InOut: Scope Name Type Comment Return BACnetDeviceCommControl IEC_BACNET_STATUS A status indicating if the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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. pDccParams POINTER TO IEC_BACNET_DCC_INFO A pointer to the service information data structure. The fields of this data structure include the time duration, which may be indefinite or indicate a number of minutes that the remote device shall ignore all APDUs (except Device-Communication-Control and Reinitialize-Device APDUs in the DCC_DISABLE case), dccValue (which may be IEC_BACNET_DCC_VALUE.DCC_ENABLE or IEC_BACNET_DCC_VALUE.DCC_DISABLE ), and a password. 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.

BACnetGetAlarmSummary (FUN) ¶ FUNCTION BACnetGetAlarmSummary : IEC_BACNET_STATUS Send an GetAlarmSummary request This routine generates a Get Alarm Summary service request. It is used by a client BACnet user to obtain a summary of “alarm-active” objects within the given device that is capable of alarm processing. The “alarm-active” objects are objects that have any value but IEC_BACNET_EVENT_STATE.STATE_NORMAL for the Event_State property and IEC_BACNET_NOTIFY_TYPE.NOTIFY_TYPE_ALARM for the Notify_Type property. InOut: Scope Name Type Comment Return BACnetGetAlarmSummary IEC_BACNET_STATUS A status indicating if the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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. 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pInfoBuffer POINTER TO IEC_BACNET_ALARM_INFO A pointer to a memory block of datatype IEC_BACNET_ALARM_INFO in which to place summary information, which is a list of Alarm Summary items. Each item of datatype IEC_BACNET_ALARM_SUMMARY consists of three parameters: Object ID of the appropriate object, the Event State of this object, and Acked Transitions property values. The application may initialize the pSummaries member of the IEC_BACNET_ALARM_INFO struture with a 0 pointer and bufferCount and summaryCount with 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.

BACnetGetEnrollmentSummary (FUN) ¶ FUNCTION BACnetGetEnrollmentSummary : IEC_BACNET_STATUS Sends an GetEnrollmentSummary request Obtains a summary of event-initiating objects within the given device. Several different filters may be applied to define the search criteria. This routine generates an GetEnrollmentSummary service request. Asynchron call, which fills pResult with the call result in an asynchronus manner. As soon as pInfoBufferStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pResult is valid. InOut: Scope Name Type Comment Return BACnetGetEnrollmentSummary IEC_BACNET_STATUS A status indicating if the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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. pFilter POINTER TO IEC_BACNET_ENROLLMENT_FILTER This argument contains five filters: enrollment, event state, event type, priority, and notification class. Some of these filters are optional. 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pInfoBuffer POINTER TO IEC_BACNET_ENROLLMENT_INFO A pointer to a memory block into which to place summary information, which is a list of Enrollment Summary items. Each item of datatype IEC_BACNET_ENROLLMENT_SUMMARY consists of the following parameters: the Object ID of the appropriate object, its event type, event state, notification priority, and notification class property values. The application may initialize the pSummaries member of the IEC_BACNET_ENROLLMENT_INFO struture with a 0 pointer and bufferCount and summaryCount with 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.

BACnetGetEventInfo (FUN) ¶ FUNCTION BACnetGetEventInfo : IEC_BACNET_STATUS Sends a GetEventInformation request. Sends a request to obtain a summary of “event-active” objects within the given device that generates event notifications. The “event-active” objects are objects that have any value other than IEC_BACNET_EVENT_STATE.STATE_NORMAL for the Event_State property, or have an acked- transitions property that has at least one of the bits ( IEC_BACNET_EVENT_TRANSITION_BITS.EVENT_TRANSITION_TO_OFFNORMAL , IEC_BACNET_EVENT_TRANSITION_BITS.EVENT_TRANSITION_TO_FAULT , IEC_BACNET_EVENT_TRANSITION_BITS.EVENT_TRANSITION_TO_NORMAL ) set to FALSE. This routine allows to control APDU properties like APDU length, segmentation, and timeout for both requests and responses. This routine can execute asynchronously, i.e. this routine will return to the caller before the BACnet reply comes so that the application can keep running. In this case the response information will be received by the thread which is responsible for receiving asynchronous responses. An optional BACNET_EVENT_INFO_COMPLETE_CB routine, which is provided by the BACnet application, shall be used to process this information. If a number of asynchronous service requests are sent, the responses shall be queued and identified by the transaction handles. If the application does not supply the BACNET_EVENT_INFO_COMPLETE_CB routine, then this routine sends out a request and waits for a response. Asynchron call, which fills pResult with the call result in an asynchronus manner. As soon as pInfoBufferStatus is IEC_BACNET_STATUS.BACNET_STATUS_OK the data in pResult is valid. InOut: Scope Name Type Comment Return BACnetGetEventInfo IEC_BACNET_STATUS A status indicating if the operation worked. Input pSourceAddress POINTER TO IEC_BACNET_ADDRESS If the BACnet application has only one device constructed and installed, this can be 0. 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_EVENT_INFO_INFO A pointer to a memory block that holds a data structure of datatype IEC_BACNET_EVENT_INFO_INFO . This data structure may contain optional ObjectID parameter to specify the last Object Identifier received in a preceding Get Event Info ACK if it’s moreEvents field was TRUE. If ObjectID parameter is omitted, the returned summary shall start with the first event-active object. 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 0. In this case APDU properties are used which were specified in the device object properties of the applications device which sends the request. pInfoBuffer POINTER TO IEC_BACNET_EVENT_INFO A pointer to a memory block of datatype BACNET_EVENT_INFO to place the response information. It contains a list of Event Summary items. Each item of datatype IEC_BACNET_EVENT_SUMMARY consists of a number of parameters that describe the appropriate object. ObjectID, Event-State, Acked-Transitions, Notify-Type, and Event-Enable parameters convey values of the corresponding properties of the object. Event-Stamps parameter conveys the timestamps of the last event notifications for TO-OFFNORMAL, TO-FAULT, and TONORMAL events. Event-Priorities parameter conveys the priorities specified in the Priority property of the associated notification class object. Event Info data structure contains actual number of the items returned, and the total length of Event-Summary list buffer expressed as a number of items this buffer can hold. The last parameter of IEC_BACNET_EVENT_INFO data structure is the More Events flag which indicates whether (TRUE) or not (FALSE) more objects exist that should be listed, but that cannot be conveyed by the reply because APDU is too short. The application may initialize the pSummaries member of the IEC_BACNET_EVENT_INFO struture with a 0 pointer and bufferCount and summaryCount with 0 too. In this case the memory for the response is allocated by the API and the application is responsible to release it with a call to BACnetFreeStackAllocatedMemory if the buffer is no longer needed. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be 0 if the application isn’t interested in detailed error information.

BACnetLifeSafetyOperation (FUN) ¶ FUNCTION BACnetLifeSafetyOperation : IEC_BACNET_STATUS Sends a LifeSafetyOperation request. Sends the requests to provide a mechanism for transporting specific instructions from an operator to silence, audible or visual notification appliances or reset notification appliances. This service may be used in fire, life safety and security systems. Because the present version of this BACnet API does not support a default processing for this service, the destination has to include a Hook procedure to process it. This routine may control APDU properties like APDU length, segmentation and timeout for both requests and responses. This routine can execute asynchronously, so this routine will return to the caller before the BACnet reply is received so that the application keeps running. In this case the response information will be received by the thread that is responsible for receiving asynchronous responses. An optional BACNET_SIMPLE_ACK_COMPLETE_CB routine, which has to be provided by the BACnet application, shall be used to process this information. If a number of asynchronous requests are sent, the responses will be queued and identified by their transaction handles. If the application does not supply the BACNET_SIMPLE_ACK_COMPLETE_CB routine, then this routine sends a request and waits for reply. return IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetLifeSafetyOperation 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_LIFE_SAFETY_INFO A pointer to hold the request information data structure. 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. pTransactionToken POINTER TO BACnetAsyncTransactionToken Transaction token of the asynchronous call - see BACnetAsyncTransactionToken . pError POINTER TO IEC_BACNET_ERROR A pointer to a structure to hold BACnet Error information. pError may be NULL if the application isn’t interested in detailed error information.