evc 2.0.0.0
Public function

Functions

void evc_cfg_setup (evc_cfg_t *cfg)
 Config Object Initialization function.
 
EVC_RETVAL evc_init (evc_t *ctx, evc_cfg_t *cfg)
 Initialization function.
 
void evc_default_cfg (evc_t *ctx)
 Click Default Configuration function.
 
void evc_generic_write (evc_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic write function.
 
void evc_generic_read (evc_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function.
 
void evc_set_volume_part (evc_t *ctx, uint8_t channel, uint8_t volume1, uint8_t volume2)
 Set volume for the channel.
 
void evc_set_volume_full (evc_t *ctx, uint8_t channel, int8_t volume)
 Set volume for the channel.
 
void evc_clear (evc_t *ctx)
 Clear register.
 
void evc_mute (evc_t *ctx, uint8_t mute)
 Mute and Unmute.
 

Detailed Description

Function Documentation

◆ evc_cfg_setup()

void evc_cfg_setup ( evc_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.

◆ evc_clear()

void evc_clear ( evc_t * ctx)

Clear register.

Parameters
ctxClick object.

@description This function clears the registers.

Note
The PT2258 function register does not have any default settings. After clearing the register, an initial value must send in order to each register. If a register does has not been set, it is possible that no sound will be output. The cleaning and settings for each registers are included in the function "defaultConfiguration()".

◆ evc_default_cfg()

void evc_default_cfg ( evc_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for EVC click.

Note
Calling this function clears all registers, sets each channel to 0dB and unmutes the sound. Contains additional initialization settings.

◆ evc_generic_read()

void evc_generic_read ( evc_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

@description This function reads data from the desired register.

◆ evc_generic_write()

void evc_generic_write ( evc_t * ctx,
uint8_t reg,
uint8_t * data_buf,
uint8_t len )

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

@description This function writes data to the desired register.

◆ evc_init()

EVC_RETVAL evc_init ( evc_t * ctx,
evc_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ evc_mute()

void evc_mute ( evc_t * ctx,
uint8_t mute )

Mute and Unmute.

Parameters
ctxClick object.
MuteMute register

@description This function mute and unmute the sound

◆ evc_set_volume_full()

void evc_set_volume_full ( evc_t * ctx,
uint8_t channel,
int8_t volume )

Set volume for the channel.

Parameters
ctxClick object.
channelChunnel register (from _EQUALIZER_CHANNEL_1 to _EQUALIZER_CHANNEL_6)
volumeVolume (from 0 to -79) (int8_t value)

@description This function sets the volume for the selected channel, uses one volume variables.

◆ evc_set_volume_part()

void evc_set_volume_part ( evc_t * ctx,
uint8_t channel,
uint8_t volume1,
uint8_t volume2 )

Set volume for the channel.

Parameters
ctxClick object.
channelChunnel register (from _EQUALIZER_CHANNEL_1 to _EQUALIZER_CHANNEL_6)
volume1Volume (from _EQUALIZER_SET_VOLUME_1dB to _EQUALIZER_SET_VOLUME_9dB)
volume2Volume (from _EQUALIZER_SET_VOLUME_10dB to _EQUALIZER_SET_VOLUME_70dB)

@description This function sets the volume for the selected channel, uses two variables.