ldc.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 LDC_H
#define LDC_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 LDC_REG_DATA_CH0            0x00
#define LDC_REG_DATA_CH1            0x02
#define LDC_REG_RCOUNT_CH0          0x08
#define LDC_REG_RCOUNT_CH1          0x09
#define LDC_REG_OFFSET_CH0          0x0C
#define LDC_REG_OFFSET_CH1          0x0D
#define LDC_REG_SETTLECOUNT_CH0     0x10
#define LDC_REG_SETTLECOUNT_CH1     0x11
#define LDC_REG_CLOCK_DIVIDERS_CH0  0x14
#define LDC_REG_CLOCK_DIVIDERS_CH1  0x15
#define LDC_REG_STATUS              0x18
#define LDC_REG_ERROR_CONFIG        0x19
#define LDC_REG_CONFIG              0x1A
#define LDC_REG_MUX_CONFIG          0x1B
#define LDC_REG_RESET_DEV           0x1C
#define LDC_REG_DRIVE_CURRENT_CH0   0x1E
#define LDC_REG_DRIVE_CURRENT_CH1   0x1F
#define LDC_REG_MANUFACTURER_ID     0x7E
#define LDC_REG_DEVICE_ID           0x7F
 
 // ldc_reg
 
#define LDC_MANUFACTURER_ID         0x5449
#define LDC_DEVICE_ID               0x3054 
 
#define LDC_INTERNAL_FREQUENCY      43.4/*<MHz*/
#define LDC_FREQUENCY_RESOLUTION    4096
#define LDC_SENSOR_CAPACITANCE      0.00022/*<uF*/
#define LDC_MATH_TWO_PI             6.28318530717958
 
#define LDC_GAIN_1                  0x0000
#define LDC_GAIN_4                  0x0200
#define LDC_GAIN_8                  0x0400
#define LDC_GAIN_16                 0x0600
 
#define LDC_OVER_RANGE              0x8
#define LDC_UNDER_RANGE             0x4
#define LDC_WATCHDOG                0x3
 
#define LDC_STATUS_DRDY             0x0040
 
#define LDC_SET_DEV_ADDR            0x2B 
 
 // ldc_set
 
#define LDC_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.sd = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // ldc_map
 // ldc
 
typedef struct
{
    // Output pins
    digital_out_t  sd;      
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} ldc_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  sd;         
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} ldc_cfg_t;
 
typedef enum
{
   LDC_OK = 0,
   LDC_ERROR = -1,
   LDC_ERROR_UNDER_RANGE = -2,
   LDC_ERROR_OVER_RANGE = -3,
   LDC_ERROR_WATCHDOG = -4
 
} ldc_return_value_t;
 
void ldc_cfg_setup ( ldc_cfg_t *cfg );
 
err_t ldc_init ( ldc_t *ctx, ldc_cfg_t *cfg );
 
err_t ldc_default_cfg ( ldc_t *ctx );
 
err_t ldc_generic_write ( ldc_t *ctx, uint8_t reg, uint16_t tx_data );
 
err_t ldc_generic_read ( ldc_t *ctx, uint8_t reg, uint16_t *rx_data );
 
uint8_t ldc_get_interrupt ( ldc_t *ctx );
 
void ldc_set_shut_down ( ldc_t *ctx, uint8_t state );
 
err_t ldc_get_frequency ( ldc_t *ctx, uint8_t channel, uint16_t divider, float *frequency );
 
float ldc_calculate_inductance ( float frequency );
 
 
#ifdef __cplusplus
}
#endif
#endif // LDC_H
 
 // ldc
 
// ------------------------------------------------------------------------ END