ldc1000.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 LDC1000_H
#define LDC1000_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_spi_master.h"
#include "math.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define LDC1000_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso    = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi    = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck     = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs      = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define LDC1000_RETVAL  uint8_t
 
#define LDC1000_OK           0x00
#define LDC1000_INIT_ERROR   0xFF
#define LDC1000_CMD_ID            0x00
#define LDC1000_CMD_RPMAX         0x01
#define LDC1000_CMD_RPMIN         0x02
#define LDC1000_CMD_SENSORFREQ    0x03
#define LDC1000_CMD_LDCCONFIG     0x04
#define LDC1000_CMD_CLKCONFIG     0x05
#define LDC1000_CMD_THRESHILSB    0x06
#define LDC1000_CMD_THRESHIMSB    0x07
#define LDC1000_CMD_THRESLOLSB    0x08
#define LDC1000_CMD_THRESLOMSB    0x09
#define LDC1000_CMD_INTCONFIG     0x0A
#define LDC1000_CMD_PWRCONFIG     0x0B
#define LDC1000_CMD_STATUS        0x20
#define LDC1000_CMD_PROXLSB       0x21
#define LDC1000_CMD_PROXMSB       0x22
#define LDC1000_CMD_FREQCTRLSB    0x23
#define LDC1000_CMD_FREQCTRMID    0x24
#define LDC1000_CMD_FREQCTRMSB    0x25
#define LDC1000_RPMAX_38_785K             0x11
#define LDC1000_RPMIN_2_39K               0x3B
#define LDC1000_SENSORFREQ_N217_F20       0xD9
#define LDC1000_LDCCONFIG_A2V_T6144       0x0F
#define LDC1000_CLKCONFIG_EC_ET_ENABLE    0x02
#define LDC1000_PWRCONFIG_ACTIVE_MODE     0x01
#define LDC1000_CMD_SPI_READ              0x80
#define LDC1000_SENSITIVITY               100
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    digital_out_t cs;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
} ldc1000_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t spi_speed;
    uint8_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} ldc1000_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ldc1000_cfg_setup ( ldc1000_cfg_t *cfg );
 
LDC1000_RETVAL ldc1000_init ( ldc1000_t *ctx, ldc1000_cfg_t *cfg );
 
void ldc1000_default_cfg ( ldc1000_t *ctx );
 
void ldc1000_write_byte ( ldc1000_t *ctx, uint8_t address, uint8_t input_data );
 
uint8_t ldc1000_read_byte ( ldc1000_t *ctx, uint8_t address );
 
uint16_t ldc1000_get_proximity_data ( ldc1000_t *ctx );
 
float ldc1000_get_inductance_data ( ldc1000_t *ctx );
 
uint8_t ldc1000_get_int_input ( ldc1000_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _LDC1000_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END