audioamp4  2.0.0.0
Functions
Public function

Functions

void audioamp4_cfg_setup (audioamp4_cfg_t *cfg)
 Config Object Initialization function. More...
 
AUDIOAMP4_RETVAL audioamp4_init (audioamp4_t *ctx, audioamp4_cfg_t *cfg)
 Initialization function. More...
 
void audioamp4_default_cfg (audioamp4_t *ctx)
 Click Default Configuration function. More...
 
AUDIOAMP4_RETVAL audioamp4_set_channel (audioamp4_t *ctx, uint8_t channel)
 Set channel function function. More...
 
AUDIOAMP4_RETVAL audioamp4_shutdown (audioamp4_t *ctx, uint8_t state)
 Set channel function function. More...
 

Detailed Description

Function Documentation

◆ audioamp4_cfg_setup()

void audioamp4_cfg_setup ( audioamp4_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ audioamp4_default_cfg()

void audioamp4_default_cfg ( audioamp4_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for AudioAmp 4 click.

Note
Default Configuration
   Device State       : OFF        - AUDIOAMP4_SHUTDOWN_OFF 
   Set Channel        : Channel 0  - AUDIOAMP4_VOLUME_CHANN_0

◆ audioamp4_init()

AUDIOAMP4_RETVAL audioamp4_init ( audioamp4_t ctx,
audioamp4_cfg_t cfg 
)

Initialization function.

Parameters
audioamp4Click object.
cfgClick configuration structure.

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

◆ audioamp4_set_channel()

AUDIOAMP4_RETVAL audioamp4_set_channel ( audioamp4_t ctx,
uint8_t  channel 
)

Set channel function function.

Parameters
ctxClick object.
channelSelected channel
Returns
Returns device response

This function executes default configuration for AudioAmp 4 click.

◆ audioamp4_shutdown()

AUDIOAMP4_RETVAL audioamp4_shutdown ( audioamp4_t ctx,
uint8_t  state 
)

Set channel function function.

Parameters
ctxClick object.
stateState of device
Returns
Returns device response

This function executes default configuration for AudioAmp 4 click.