pot4.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 POT4_H
#define POT4_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_analog_in.h"
#include "drv_i2c_master.h"
 
#define POT4_PERCENTS               100
#define POT4_ROUND_TO_NEAREST_INT   0.5
 
#define POT4_ADC_RESOLUTION         0x0FFF
#define POT4_VREF_3V3               3.3
#define POT4_VREF_5V                5.0
 
#define POT4_SET_DEV_ADDR           0x4D
 
 // pot4_set
 
#define POT4_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.an  = MIKROBUS( mikrobus, MIKROBUS_AN ); \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // pot4_map
 // pot4
 
typedef enum
{
    POT4_DRV_SEL_ADC,               
    POT4_DRV_SEL_I2C                
} pot4_drv_t;
 
typedef struct
{
    digital_in_t sw;                
    analog_in_t  adc;               
    i2c_master_t i2c;               
    uint8_t      slave_address;     
    pin_name_t   chip_select;       
    float        vref;              
    pot4_drv_t   drv_sel;           
} pot4_t;
 
typedef struct
{
    pin_name_t an;                  
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t sw;                  
    analog_in_resolution_t resolution;      
    float                  vref;            
    uint32_t               i2c_speed;       
    uint8_t                i2c_address;     
    pot4_drv_t drv_sel;             
} pot4_cfg_t;
 
typedef enum
{
    POT4_OK = 0,
    POT4_ERROR = -1
 
} pot4_return_value_t;
 
void pot4_cfg_setup ( pot4_cfg_t *cfg );
 
void pot4_drv_interface_selection ( pot4_cfg_t *cfg, pot4_drv_t drv_sel );
 
err_t pot4_init ( pot4_t *ctx, pot4_cfg_t *cfg );
 
err_t pot4_read_raw_adc ( pot4_t *ctx, uint16_t *raw_adc );
 
err_t pot4_read_voltage ( pot4_t *ctx, float *voltage );
 
err_t pot4_set_vref ( pot4_t *ctx, float vref );
 
uint8_t pot4_get_switch_pin ( pot4_t *ctx );
 
uint8_t pot4_convert_voltage_to_percents ( pot4_t *ctx, float voltage );
 
#ifdef __cplusplus
}
#endif
#endif // POT4_H
 
 // pot4
 
// ------------------------------------------------------------------------ END