audioamp9 2.1.0.0
Macros | Functions
AudioAmp 9 Click Driver

API for configuring and manipulating AudioAmp 9 Click driver. More...

Macros

#define AUDIOAMP9_GAIN_LEVEL1   0x01
 AudioAmp 9 gain level setting.
 
#define AUDIOAMP9_GAIN_LEVEL2   0x02
 
#define AUDIOAMP9_GAIN_LEVEL3   0x03
 
#define AUDIOAMP9_GAIN_LEVEL4   0x04
 

Functions

void audioamp9_cfg_setup (audioamp9_cfg_t *cfg)
 AudioAmp 9 configuration object setup function.
 
err_t audioamp9_init (audioamp9_t *ctx, audioamp9_cfg_t *cfg)
 AudioAmp 9 initialization function.
 
void audioamp9_default_cfg (audioamp9_t *ctx)
 AudioAmp 9 default configuration function.
 
void audioamp9_shutdown_on (audioamp9_t *ctx)
 AudioAmp 9 shutdown on function.
 
void audioamp9_shutdown_off (audioamp9_t *ctx)
 AudioAmp 9 shutdown off function.
 
void audioamp9_mute_on (audioamp9_t *ctx)
 AudioAmp 9 mute on function.
 
void audioamp9_mute_off (audioamp9_t *ctx)
 AudioAmp 9 mute off function.
 
void audioamp9_set_gain1 (audioamp9_t *ctx)
 AudioAmp 9 set gain level 1 function.
 
void audioamp9_set_gain2 (audioamp9_t *ctx)
 AudioAmp 9 set gain level 2 function.
 
void audioamp9_set_gain3 (audioamp9_t *ctx)
 AudioAmp 9 set gain level 3 function.
 
void audioamp9_set_gain4 (audioamp9_t *ctx)
 AudioAmp 9 set gain level 4 function.
 
err_t audioamp9_set_gain_level (audioamp9_t *ctx, uint8_t gain_level)
 AudioAmp 9 set gain function.
 

Detailed Description

API for configuring and manipulating AudioAmp 9 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Macro Definition Documentation

◆ AUDIOAMP9_GAIN_LEVEL1

#define AUDIOAMP9_GAIN_LEVEL1   0x01

AudioAmp 9 gain level setting.

Specified setting for gain level of AudioAmp 9 Click driver.

◆ AUDIOAMP9_GAIN_LEVEL2

#define AUDIOAMP9_GAIN_LEVEL2   0x02

◆ AUDIOAMP9_GAIN_LEVEL3

#define AUDIOAMP9_GAIN_LEVEL3   0x03

◆ AUDIOAMP9_GAIN_LEVEL4

#define AUDIOAMP9_GAIN_LEVEL4   0x04

Function Documentation

◆ audioamp9_cfg_setup()

void audioamp9_cfg_setup ( audioamp9_cfg_t * cfg)

AudioAmp 9 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See audioamp9_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ audioamp9_default_cfg()

void audioamp9_default_cfg ( audioamp9_t * ctx)

AudioAmp 9 default configuration function.

This function executes a default configuration of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ audioamp9_init()

err_t audioamp9_init ( audioamp9_t * ctx,
audioamp9_cfg_t * cfg )

AudioAmp 9 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See audioamp9_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ audioamp9_mute_off()

void audioamp9_mute_off ( audioamp9_t * ctx)

AudioAmp 9 mute off function.

This function turns off the mute mode of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_mute_on()

void audioamp9_mute_on ( audioamp9_t * ctx)

AudioAmp 9 mute on function.

This function turns on the mute mode of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_set_gain1()

void audioamp9_set_gain1 ( audioamp9_t * ctx)

AudioAmp 9 set gain level 1 function.

This function turns on gain level 1 of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_set_gain2()

void audioamp9_set_gain2 ( audioamp9_t * ctx)

AudioAmp 9 set gain level 2 function.

This function turns on gain level 2 of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_set_gain3()

void audioamp9_set_gain3 ( audioamp9_t * ctx)

AudioAmp 9 set gain level 3 function.

This function turns on gain level 3 of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_set_gain4()

void audioamp9_set_gain4 ( audioamp9_t * ctx)

AudioAmp 9 set gain level 4 function.

This function turns on gain level 4 of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_set_gain_level()

err_t audioamp9_set_gain_level ( audioamp9_t * ctx,
uint8_t gain_level )

AudioAmp 9 set gain function.

This function sets a specific gain level of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
[in]gain_level: Selected gain level.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ audioamp9_shutdown_off()

void audioamp9_shutdown_off ( audioamp9_t * ctx)

AudioAmp 9 shutdown off function.

This function turns off the shutdown mode of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ audioamp9_shutdown_on()

void audioamp9_shutdown_on ( audioamp9_t * ctx)

AudioAmp 9 shutdown on function.

This function turns on the shutdown mode of AudioAmp 9 click board.

Parameters
[in]ctx: Click context object. See audioamp9_t object definition for detailed explanation.
Returns
Nothing.
Note
None.