audioamp9 2.1.0.0
audioamp9.h File Reference

This file contains API for AudioAmp 9 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"

Go to the source code of this file.

Data Structures

struct  audioamp9_t
 AudioAmp 9 Click context object. More...
 
struct  audioamp9_cfg_t
 AudioAmp 9 Click configuration object. 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
 
#define AUDIOAMP9_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  audioamp9_return_value_t { AUDIOAMP9_OK = 0 , AUDIOAMP9_ERROR = -1 }
 AudioAmp 9 Click return value data. More...
 

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

This file contains API for AudioAmp 9 Click Driver.

Enumeration Type Documentation

◆ audioamp9_return_value_t

AudioAmp 9 Click return value data.

Predefined enum values for driver return values.

Enumerator
AUDIOAMP9_OK 
AUDIOAMP9_ERROR