vumeter.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef VUMETER_H
#define VUMETER_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
#include "drv_analog_in.h"
 
#define VUMETER_GAIN_LEVEL_MAX              0xFF
#define VUMETER_GAIN_LEVEL_MID              0x80
#define VUMETER_GAIN_LEVEL_MIN              0x00
 
#define VUMETER_DBU_VREF                    0.7746
#define VUMETER_DBU_TO_VU                   4.0
#define VUMETER_RMS_FOR_20VU                0.123
#define VUMETER_MIN_VU                      -20.0
#define VUMETER_VCC_3V3                     3.3
#define VUMETER_VCC_5V                      5.0
 
#define VUMETER_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define VUMETER_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 
 // vumeter_set
 
#define VUMETER_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.an   = MIKROBUS( mikrobus, MIKROBUS_AN )
 
 // vumeter_map
 // vumeter
 
typedef struct
{
    // Modules
    spi_master_t    spi;            
    analog_in_t     adc;            
    pin_name_t      chip_select;    
} vumeter_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;           
    pin_name_t  mosi;           
    pin_name_t  sck;            
    pin_name_t  cs;             
    pin_name_t  an;             
    // static variable
    uint32_t                            spi_speed;      
    spi_master_mode_t                   spi_mode;       
    spi_master_chip_select_polarity_t   cs_polarity;    
    analog_in_resolution_t              resolution;     
    float                               vref;           
} vumeter_cfg_t;
 
typedef enum
{
    VUMETER_OK = 0,
    VUMETER_ERROR = -1
 
} vumeter_return_value_t;
 
void vumeter_cfg_setup ( vumeter_cfg_t *cfg );
 
err_t vumeter_init ( vumeter_t *ctx, vumeter_cfg_t *cfg );
 
err_t vumeter_read_an_pin_value ( vumeter_t *ctx, uint16_t *data_out );
 
err_t vumeter_read_an_pin_voltage ( vumeter_t *ctx, float *data_out );
 
err_t vumeter_set_gain_level ( vumeter_t *ctx, uint8_t gain_lvl );
 
float vumeter_calculate_vu_level ( vumeter_t *ctx, uint16_t sample_rate_ms );
 
#ifdef __cplusplus
}
#endif
#endif // VUMETER_H
 
 // vumeter
 
// ------------------------------------------------------------------------ END