adc8.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 ADC8_H
#define ADC8_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ADC8_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define ADC8_MAP_MIKROBUS( cfg, mikrobus ) \ …
#define ADC8_RETVAL  uint8_t
 
#define ADC8_OK           0x00
#define ADC8_INIT_ERROR   0xFF
#define ADC8_REG_CONFIGURATION   0x01
#define ADC8_REG_CONVERSION      0x00
#define ADC8_REG_THRESHOLD_LOW   0x02
#define ADC8_REG_THRESHOLD_HIGH  0x03
#define ADC8_CFG_CONVERSION_ENABLE   0x0000
#define ADC8_CFG_CONVERSION_DISABLE  0x8000
#define ADC8_CFG_MUX_AINP0_AINN1   0x0000
#define ADC8_CFG_MUX_AINP0_AINN3   0x1000
#define ADC8_CFG_MUX_AINP1_AINN3   0x2000
#define ADC8_CFG_MUX_AINP2_AINN3   0x3000
#define ADC8_CFG_MUX_AINP0_GND     0x4000
#define ADC8_CFG_MUX_AINP1_GND     0x5000
#define ADC8_CFG_MUX_AINP2_GND     0x6000
#define ADC8_CFG_MUX_AINP3_GND     0x7000
#define ADC8_CFG_GAIN_6144mV   0x0000
#define ADC8_CFG_GAIN_4096mV   0x0200
#define ADC8_CFG_GAIN_2048mV   0x0400
#define ADC8_CFG_GAIN_1024mV   0x0600
#define ADC8_CFG_GAIN_512mV    0x0800
#define ADC8_CFG_GAIN_256mV    0x0A00
#define ADC8_CFG_MODE_CONTINUOUS  0x0000
#define ADC8_CFG_MODE_SINGLE      0x0100
#define ADC8_CFG_SPS_8    0x0000
#define ADC8_CFG_SPS_16   0x0020
#define ADC8_CFG_SPS_32   0x0040
#define ADC8_CFG_SPS_64   0x0060
#define ADC8_CFG_SPS_128  0x0080
#define ADC8_CFG_SPS_250  0x00A0
#define ADC8_CFG_SPS_475  0x00C0
#define ADC8_CFG_SPS_860  0x00E0
#define ADC8_CFG_COMP_MODE_TRADITIONAL  0x0000
#define ADC8_CFG_COMP_MODE_WINDOW       0x0010
#define ADC8_CFG_COMP_POL_LOW    0x0000
#define ADC8_CFG_COMP_POL_HIGH   0x0008
#define ADC8_CFG_COMP_LAT_ENABLE    0x0000
#define ADC8_CFG_COMP_LAT_DISABLE   0x0004
 
#define ADC8_CFG_COMP_QUE_1_CONV       0x0000
#define ADC8_CFG_COMP_QUE_2_CONV       0x0001
#define ADC8_CFG_COMP_QUE_4_CONV       0x0002
#define ADC8_CFG_COMP_QUE_ALERT_CONV   0x0003
#define ADC8_DEVICE_SLAVE_ADDR_GND 0x48
#define ADC8_DEVICE_SLAVE_ADDR_VDD 0x49
#define ADC8_DEVICE_SLAVE_ADDR_SDA 0x4A
#define ADC8_DEVICE_SLAVE_ADDR_SCL 0x4B
#define ADC8_SINGLE_CHANNEL_0  0x00
#define ADC8_SINGLE_CHANNEL_1  0x01
#define ADC8_SINGLE_CHANNEL_2  0x02
#define ADC8_SINGLE_CHANNEL_3  0x03
#define ADC8_DIFF_CHANNEL_0_1  0x04
#define ADC8_DIFF_CHANNEL_0_3  0x05
#define ADC8_DIFF_CHANNEL_1_3  0x06
#define ADC8_DIFF_CHANNEL_2_3  0x07
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
    float max_voltage;
    uint16_t cfg_reg_value;
    uint8_t diff_flag;
 
} adc8_t;
typedef struct {…};
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} adc8_cfg_t;
typedef struct {…};
 
typedef struct
{
    float ch_0;
    float ch_1;
    float ch_2;
    float ch_3;
 
} adc8_single_volt_t;
typedef struct {…};
 
typedef struct
{
    float ch_0_1;
    float ch_0_3;
    float ch_1_3;
    float ch_2_3;
 
} adc8_diff_volt_t;
typedef struct {…};
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void adc8_cfg_setup ( adc8_cfg_t *cfg );
 
ADC8_RETVAL adc8_init ( adc8_t *ctx, adc8_cfg_t *cfg );
 
void adc8_default_cfg ( adc8_t *ctx );
 
void adc8_generic_write ( adc8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void adc8_generic_read ( adc8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void adc8_set_cfg_register ( adc8_t *ctx, uint16_t cfg );
 
uint16_t adc8_get_adc_value ( adc8_t *ctx, uint8_t channel );
 
float adc8_get_voltage ( adc8_t *ctx, uint8_t channel );
 
uint8_t adc8_get_interrupt_state( adc8_t *ctx );
 
void adc8_get_single_channel( adc8_t *ctx, adc8_single_volt_t *volt );
 
void adc8_get_diff_channel( adc8_t *ctx, adc8_diff_volt_t *volt );
 
#ifdef __cplusplus
}
#endif
#endif  // _ADC8_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END