audioamp5 2.0.0.0
Functions

Functions

void audioamp5_cfg_setup (audioamp5_cfg_t *cfg)
 Config Object Initialization function. More...
 
AUDIOAMP5_RETVAL audioamp5_init (audioamp5_t *ctx, audioamp5_cfg_t *cfg)
 Initialization function. More...
 
void audioamp5_default_cfg (audioamp5_t *ctx)
 Click Default Configuration function. More...
 
void audioamp5_set_device_state (audioamp5_t *ctx, uint8_t state)
 Default Configuration function. More...
 
void audioamp5_mode_select (audioamp5_t *ctx, uint8_t state)
 Mode Selection function. More...
 
void audioamp5_gain_select (audioamp5_t *ctx, uint8_t state)
 Gain Selection function. More...
 
void audioamp5_config_update (audioamp5_t *ctx)
 Configuration Update function. More...
 

Detailed Description

Function Documentation

◆ audioamp5_cfg_setup()

void audioamp5_cfg_setup ( audioamp5_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ audioamp5_config_update()

void audioamp5_config_update ( audioamp5_t ctx)

Configuration Update function.

Parameters
ctxClick object.

@description Function makes that desired configuration be updated.

◆ audioamp5_default_cfg()

void audioamp5_default_cfg ( audioamp5_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Audio Amp 5 click.

◆ audioamp5_gain_select()

void audioamp5_gain_select ( audioamp5_t ctx,
uint8_t  state 
)

Gain Selection function.

Parameters
ctxClick object.
state0 - 20dB, 1 - 26dB

@description Function performs a desired gain selection.

◆ audioamp5_init()

AUDIOAMP5_RETVAL audioamp5_init ( audioamp5_t ctx,
audioamp5_cfg_t cfg 
)

Initialization function.

Parameters
audioamp5Click object.
cfgClick configuration structure.

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

◆ audioamp5_mode_select()

void audioamp5_mode_select ( audioamp5_t ctx,
uint8_t  state 
)

Mode Selection function.

Parameters
ctxClick object.
state0 - BD Mode, 1 - 1SPW Mode

@description Function puts a device to the desired mode.

◆ audioamp5_set_device_state()

void audioamp5_set_device_state ( audioamp5_t ctx,
uint8_t  state 
)

Default Configuration function.

Parameters
ctxClick object.

@description Function sets a default configuration parameters to the module.

Note
Default configuration
Mode select : BD Mode   - AUDIOAMP5_BD_MODE
Gain select : 20DB Gain - AUDIOAMP5_GAIN_20DB