adc17.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 ADC17_H
#define ADC17_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_i2c_master.h"
 
#define ADC17_REG_SETUP                     0x80
#define ADC17_SETUP_VREF_VDD_REF_NC_OFF     0x00
#define ADC17_SETUP_VREF_EXT_REF_IN_OFF     0x20
#define ADC17_SETUP_VREF_INT_REF_NC_OFF     0x40
#define ADC17_SETUP_VREF_INT_REF_NC_ON      0x50
#define ADC17_SETUP_VREF_INT_REF_OUT_OFF    0x60
#define ADC17_SETUP_VREF_INT_REF_OUT_ON     0x70
#define ADC17_SETUP_CLK_INT                 0x00
#define ADC17_SETUP_CLK_EXT                 0x08
#define ADC17_SETUP_UNIPOLAR                0x00
#define ADC17_SETUP_BIPOLAR                 0x04
#define ADC17_SETUP_RST_RESET               0x00
#define ADC17_SETUP_RST_NO_ACTION           0x02
 
#define ADC17_REG_CONFIG                    0x00
#define ADC17_CONFIG_SCAN_AIN0_TO_CS0       0x00
#define ADC17_CONFIG_SCAN_CS0_8_TIMES       0x20
#define ADC17_CONFIG_SCAN_CS0               0x60
#define ADC17_CONFIG_CS0_AIN0               0x00
#define ADC17_CONFIG_CS0_AIN1               0x02
#define ADC17_CONFIG_DIFFERENTIAL           0x00
#define ADC17_CONFIG_SINGLE_ENDED           0x01
 
#define ADC17_REG_BIT_MASK                  0x80
#define ADC17_SETUP_VREF_BIT_MASK           0x70
#define ADC17_SETUP_CLK_BIT_MASK            0x08
#define ADC17_SETUP_UNI_BIP_BIT_MASK        0x04
#define ADC17_SETUP_RST_BIT_MASK            0x02
#define ADC17_CONFIG_SCAN_BIT_MASK          0x60
#define ADC17_CONFIG_CS0_BIT_MASK           0x02
#define ADC17_CONFIG_SGL_DIF_BIT_MASK       0x01
 
#define ADC17_CHANNEL_0                     0
#define ADC17_CHANNEL_1                     1
 
#define ADC17_RESOLUTION                    0x0FFF
#define ADC17_VREF                          2.048
 
#define ADC17_SET_DEV_ADDR                  0x36
 
 // adc17_set
 
#define ADC17_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // adc17_map
 // adc17
 
typedef struct
{
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
    uint8_t setup_byte;         
    uint8_t config_byte;        
} adc17_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} adc17_cfg_t;
 
typedef enum
{
    ADC17_OK = 0,
    ADC17_ERROR = -1
 
} adc17_return_value_t;
 
void adc17_cfg_setup ( adc17_cfg_t *cfg );
 
err_t adc17_init ( adc17_t *ctx, adc17_cfg_t *cfg );
 
err_t adc17_default_cfg ( adc17_t *ctx );
 
err_t adc17_write_setup_byte ( adc17_t *ctx, uint8_t setup_byte );
 
err_t adc17_write_config_byte ( adc17_t *ctx, uint8_t config_byte );
 
err_t adc17_set_channel ( adc17_t *ctx, uint8_t channel );
 
err_t adc17_get_voltage ( adc17_t *ctx, float *voltage );
 
#ifdef __cplusplus
}
#endif
#endif // ADC17_H
 
 // adc17
 
// ------------------------------------------------------------------------ END