vtohz3.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 VTOHZ3_H
#define VTOHZ3_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 VTOHZ3_MAXIMAL_IN_FREQUENCY     1000000
#define VTOHZ3_MINIMAL_IN_FREQUENCY     32000
#define VTOHZ3_DEFAULT_IN_FREQUENCY     100000
 
#define VTOHZ3_VREF_3V3                 3.3
#define VTOHZ3_VREF_5V                  5.0
#define VTOHZ3_VREF_INTERNAL_2V5        2.5
 
#define VTOHZ3_SET_DATA_SAMPLE_EDGE     SET_SPI_DATA_SAMPLE_EDGE
#define VTOHZ3_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 
 // vtohz3_set
 
#define VTOHZ3_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 ); \
    cfg.buf  = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.fout = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // vtohz3_map
 // vtohz3
 
typedef struct
{
    // Output pins
    digital_out_t  buf;               
    // Input pins
    digital_in_t   fout;              
    // Modules
    spi_master_t   spi;               
    analog_in_t    adc;               
    pin_name_t     chip_select;       
    uint32_t       clock_in_freq;     
} vtohz3_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;                                      
    // Additional gpio pins
    pin_name_t  buf;                                     
    pin_name_t  fout;                                    
    // 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;             
} vtohz3_cfg_t;
 
typedef enum
{
    VTOHZ3_OK = 0,
    VTOHZ3_ERROR = -1
 
} vtohz3_return_value_t;
 
void vtohz3_cfg_setup ( vtohz3_cfg_t *cfg );
 
err_t vtohz3_init ( vtohz3_t *ctx, vtohz3_cfg_t *cfg );
 
err_t vtohz3_set_input_frequency ( vtohz3_t *ctx, uint32_t freq );
 
err_t vtohz3_disable_input_frequency ( vtohz3_t *ctx );
 
void vtohz3_set_buf_pin ( vtohz3_t *ctx, uint8_t state );
 
uint8_t vtohz3_get_fout_pin ( vtohz3_t *ctx );
 
err_t vtohz3_read_an_pin_value ( vtohz3_t *ctx, uint16_t *data_out );
 
err_t vtohz3_read_an_pin_voltage ( vtohz3_t *ctx, float *data_out );
 
uint32_t vtohz3_get_frequency ( vtohz3_t *ctx, float voltage, float vref_in );
 
#ifdef __cplusplus
}
#endif
#endif // VTOHZ3_H
 
 // vtohz3
 
// ------------------------------------------------------------------------ END