XDK API  3.6.0
Documentation
Functions
Mic_AKU340

Hardware abstraction layer for the AKU340 microphone functionalities. More...

+ Collaboration diagram for Mic_AKU340:

Functions

 BCDS_DEPRECATED (int32_t BSP_Mic_AKU340_Sense(void))
 Senses the AKU340 Microphone signal. More...
 
Retcode_T BSP_Mic_AKU340_Connect (void)
 Maps the GPIO pins To their desired function. More...
 
Retcode_T BSP_Mic_AKU340_Disable (void)
 Disables the control over the AKU340. More...
 
Retcode_T BSP_Mic_AKU340_Disconnect (void)
 Disconnects the peripheral from the MCU. More...
 
Retcode_T BSP_Mic_AKU340_Enable (void)
 Enables the control over the on board AKU340. More...
 

Detailed Description

Typically the application needs to call BSP_Mic_AKU340_Connect() to establish the link between the ADC and the AKU340 peripheral then it enables it via the BSP_Mic_AKU340_Enable() after that it is possible to sense the signal it using BSP_Mic_AKU340_Sense() which the value of the microphone output voltage.

The application can then disable the AKU340 and disconnect it from the MCU via BSP_Mic_AKU340_Disable() and BSP_Mic_AKU340_Disconnect() functions.

Function Documentation

BCDS_DEPRECATED ( int32_t   BSP_Mic_AKU340_Sensevoid)
Deprecated:
This API is deprecated.

This function is called to trigger an ADC Conversion at the microphone pin and return the measured value.

Returns
returns INT32_MIN.
Retcode_T BSP_Mic_AKU340_Connect ( void  )

The function once called will map the GPIO pins dedicated for the peripheral to their desired function.

Return values
RETCODE_OKin the case of success or an error code otherwise.

Due to electrical issues noted, the AKU VOUT port has to be permanently drained using a pull-down to ground level in order to avoid charge accumulation

+ Here is the caller graph for this function:

Retcode_T BSP_Mic_AKU340_Disable ( void  )
Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Retcode_T BSP_Mic_AKU340_Disconnect ( void  )

This function once called will disconnect the peripheral from the MCU and puts the pins into low power consumption status.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T BSP_Mic_AKU340_Enable ( void  )

This function once called will enable the AKU340 microphone and start the ADC conversion for its channel.

Return values
RETCODE_OKin the case of success or an error code otherwise.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:53 by doxygen 1.8.8