adc12.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 ADC12_H
#define ADC12_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 ADC12_CMD_SD_MASK           0x80
#define ADC12_CMD_SD_DIFF           0x00
#define ADC12_CMD_SD_SINGLE_END     0x80
 
#define ADC12_CMD_PD_MASK           0x0C
#define ADC12_CMD_PD_PDADCONV       0x00
#define ADC12_CMD_PD_IROFF_ADON     0x04
#define ADC12_CMD_PD_IRON_ADOFF     0x08
#define ADC12_CMD_PD_IRON_ADON      0x0C
 
 // adc12_cmd
 
#define ADC12_SINGLE_END_CH0         0
#define ADC12_SINGLE_END_CH1         1
#define ADC12_SINGLE_END_CH2         2
#define ADC12_SINGLE_END_CH3         3
#define ADC12_SINGLE_END_CH4         4
#define ADC12_SINGLE_END_CH5         5
#define ADC12_SINGLE_END_CH6         6
#define ADC12_SINGLE_END_CH7         7
 
#define ADC12_DIFF_CH0_P_CH1_N       0
#define ADC12_DIFF_CH1_P_CH0_N       1
#define ADC12_DIFF_CH2_P_CH3_N       2
#define ADC12_DIFF_CH3_P_CH2_N       3
#define ADC12_DIFF_CH4_P_CH5_N       4
#define ADC12_DIFF_CH5_P_CH4_N       5
#define ADC12_DIFF_CH6_P_CH7_N       6
#define ADC12_DIFF_CH7_P_CH6_N       7
 
#define ADC12_INTERNAL_VREF          2500
 
#define ADC12_RES                    4096.0
 
#define ADC12_DEV_ADDR_DEFAULT        0x48
#define ADC12_DEV_ADDR_01             0x49
#define ADC12_DEV_ADDR_10             0x4A
#define ADC12_DEV_ADDR_11             0x4B
 
 // adc12_set
 
#define ADC12_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // adc12_map
 // adc12
 
typedef struct
{
    // Modules
 
    i2c_master_t i2c;        
    // I2C slave address
 
    uint8_t slave_address;   
    uint8_t adc12_sd_mode;   
    uint8_t adc12_pd_mode;   
} adc12_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} adc12_cfg_t;
 
typedef enum
{
    ADC12_OK = 0,
    ADC12_ERROR = -1
 
} adc12_return_value_t;
 
void adc12_cfg_setup ( adc12_cfg_t *cfg );
 
err_t adc12_init ( adc12_t *ctx, adc12_cfg_t *cfg );
 
err_t adc12_send_cmd ( adc12_t *ctx, uint8_t cmd_byte );
 
err_t adc12_read_data ( adc12_t *ctx, uint16_t *data_out );
 
void adc12_set_sd_mode ( adc12_t *ctx, uint8_t sd_mode );
 
uint8_t adc12_get_sd_mode ( adc12_t *ctx );
 
void adc12_set_pd_mode ( adc12_t *ctx, uint8_t pd_mode );
 
uint8_t adc12_get_pd_mode ( adc12_t *ctx );
 
err_t adc12_read_raw_data ( adc12_t *ctx, uint8_t ch, uint16_t *data_out );
 
err_t adc12_read_voltage ( adc12_t *ctx, uint8_t ch, uint16_t vref, float *data_out );
 
#ifdef __cplusplus
}
#endif
#endif // ADC12_H
 
 // adc12
 
// ------------------------------------------------------------------------ END