BACnetGetAlarmSummary (FUN) ¶ FUNCTION BACnetGetAlarmSummary : IEC_BACNET_STATUS Send an GetAlarmSummary request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetGetAlarmSummary 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. 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 . pServiceInfo POINTER TO IEC_BACNET_ALARM_INFO A pointer to a data structure which contains all service parameters this service provides and the application needs to process. 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.
BACnetRemoveListElement (FUN) ¶ FUNCTION BACnetRemoveListElement : IEC_BACNET_STATUS Sends an Renmove-List-Element request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetRemoveListElement 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_CHANGE_LIST_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. pFirstFailed POINTER TO IEC_BACNET_ELEMENT_COUNT A pointer to memory in which the API stores in case of some error the count of the first element which could not be processed. This argument may be NULL.
BACnetRetrieveExtraInfoForLastIllegalResponseStatus (FUN) ¶ FUNCTION BACnetRetrieveExtraInfoForLastIllegalResponseStatus : IEC_BACNET_STATUS This function retreives extra error information in case some invalid / illegal response has been recieved for a previously sent request. In case of some invalid or illegal received response the status BACNET_STATUS_ILLEGAL_RESPONSE is returned by the requesting client function (e.g. BACnetReadProperty(…)). In this case this function may be used to get more information about the error detected in the response. This function will get the extra information for the last received response with detected errors. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetRetrieveExtraInfoForLastIllegalResponseStatus IEC_BACNET_STATUS Input ptService POINTER TO IEC_BACNET_SERVICE_EXECCODE A ponter to store the service code for which an invalid or illegal response was received. Can be NULL if application does not need this information. ptError POINTER TO IEC_BACNET_ERROR A pointer to store the BACnet error code generated for the invalid / illegal response. Can be NULL if application does not need this information. pszDebugInfoBuffer POINTER TO IEC_BACNET_BYTE A pointer to a large buffer for storing the ASCII decoded and parsed ASN1 request. This feature is only available if the stack API was build bith the define DO_ASCII_DECODING. Can be NULL if application does not need this information. nAsciiBufferSize IEC_BACNET_UINT Contains the size of the debug info buffer in bytes. If the buffer is too small the decoding is trucated to the buffer size. pAsn1InfoBuffer POINTER TO IEC_BACNET_BYTE A pointer to a buffer to store the complete received response in ASN1 encoding. Can be NULL if application does not need this information. pnAsn1BufferSize POINTER TO IEC_BACNET_UINT As input it shall contain the size of the buffer. As output it will contain the size of the ASN1 response received. pAsn1ErrorBuffer POINTER TO IEC_BACNET_BYTE A ponter to a buffer to strore the part of the ASN1 encoding which contains the error. Can be NULL if application does not need this information. pnAsn1ErrorSize POINTER TO IEC_BACNET_UINT As input it shall contain the size of the buffer. As output it will contain the size of the ASN1 response part which contains the error.
BACnetSubscribeCOV (FUN) ¶ FUNCTION BACnetSubscribeCOV : IEC_BACNET_STATUS Sends an SubscribeCov request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetSubscribeCOV 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_SUBSCRIBE_COV_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.
BACnetWritePropertyMultiple (FUN) ¶ FUNCTION BACnetWritePropertyMultiple : IEC_BACNET_STATUS Sends an WritePropertyMultiple request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetWritePropertyMultiple 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_MUL_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. pFirstFailed POINTER TO IEC_BACNET_OBJ_PROP_REFERENCE A pointer to a structure to store the device object property refernce which failed to be written. This argument may be NULL if the application isn’t interested in detailed error information
BACnetYouAre (FUN) ¶ FUNCTION BACnetYouAre : IEC_BACNET_STATUS Sends a you-are request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetYouAre 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_YOU_ARE_INFO Pointer to structure which contains all service data required for initiating this request.
advanced ¶ BACnetBackupBACnetDevice (Function) BACnetCloseClientCustomer (Function) BACnetGetClientDeviceCommunication (Function) BACnetOpenClientCustomer (Function) BACnetReadFileObjectContents (Function) BACnetRegisterClientCommunicationStateCallback (Function) BACnetRegisterClientDataPoint (Function) BACnetRegisterClientDataValueCallback (Function) BACnetRegisterClientEventNotification (Function) BACnetRegisterClientEventNotificationCallback (Function) BACnetRegisterClientUnsubscribeCompletionCallback (Function) BACnetRestartAllClients (Function) BACnetRestoreBACnetDevice (Function) BACnetRetrieveListOfNetworkDevices (Function) BACnetRetrieveObjectData (Function) BACnetSetClientDeviceCommunication (Function) BACnetSetClientDeviceFixAddress (Function) BACnetSetClientDeviceFixSubscribeCovTime (Function) BACnetSetClientGlobalCommTimingParameters (Function) BACnetSetClientGlobalMaxDeviceActions (Function) BACnetUnregisterClientDataPoint (Function) BACnetUnregisterClientEventNotification (Function) BACnetWriteFileObjectContents (Function)
BACnetReadFile (FUN) ¶ FUNCTION BACnetReadFile : IEC_BACNET_STATUS Sends an AtomicReadFile request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetReadFile 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_FILE_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_FILE_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.
BACnetReadProperty (FUN) ¶ FUNCTION BACnetReadProperty : IEC_BACNET_STATUS Sends a ReadProperty request Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetReadProperty 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_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 . pContents POINTER TO IEC_BACNET_PROPERTY_CONTENTS This pointer references the data structure in which any successful service execution result is 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.
BACnetReadPropertyMultiple (FUN) ¶ FUNCTION BACnetReadPropertyMultiple : IEC_BACNET_STATUS Sends an ReadPropertyMultiple request. Return: IEC_BACNET_STATUS InOut: Scope Name Type Comment Return BACnetReadPropertyMultiple 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. pRpmInfo POINTER TO IEC_BACNET_READ_MUL_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 . readAccessResult POINTER TO IEC_BACNET_READ_RAW_RESULT_LIST A pointer to a data structure which contains all service response parameters this service provides and the application needs to process. 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.
