irgrid.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 IRGRID_H
#define IRGRID_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 IRGRID_CAL_ACOMMON_L        0xD0
#define IRGRID_CAL_ACOMMON_H        0xD1
#define IRGRID_CAL_ACP_L            0xD3
#define IRGRID_CAL_ACP_H            0xD4
#define IRGRID_CAL_BCP              0xD5
#define IRGRID_CAL_ALPHA_CP_L       0xD6
#define IRGRID_CAL_ALPHA_CP_H       0xD7
#define IRGRID_CAL_TGC              0xD8
#define IRGRID_CAL_AI_SCALE         0xD9
#define IRGRID_CAL_BI_SCALE         0xD9
#define IRGRID_VTH_L                0xDA
#define IRGRID_VTH_H                0xDB
#define IRGRID_KT1_L                0xDC
#define IRGRID_KT1_H                0xDD
#define IRGRID_KT2_L                0xDE
#define IRGRID_KT2_H                0xDF
#define IRGRID_KT_SCALE             0xD2
#define IRGRID_CAL_A0_L             0xE0
#define IRGRID_CAL_A0_H             0xE1
#define IRGRID_CAL_A0_SCALE         0xE2
#define IRGRID_CAL_DELTA_A_SCALE    0xE3
#define IRGRID_CAL_EMIS_L           0xE4
#define IRGRID_CAL_EMIS_H           0xE5
#define IRGRID_OSC_TRIM_VALUE       0xF7
 
 // irgrid_reg
 
#define IRGRID_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // irgrid_map
 // irgrid
 
typedef struct
{
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_ram_address;
    uint8_t slave_eeprom_address;
 
    // static variable 
    uint8_t refresh_rate;
    float   temperature_amb;
    int16_t resolution;
    int16_t cpix;
    int16_t ptat;
 
} irgrid_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    uint32_t  i2c_speed;        
    uint8_t i2c_ram_address;    
    uint8_t i2c_eeprom_address; 
} irgrid_cfg_t;
 
typedef struct
{
    // Static variable 
 
    uint8_t  eeprom_data[ 256 ];
    int16_t  ir_data[ 64 ];
    float    temperature_data[ 64 ];
    float    a_data[ 64 ];
    float    b_data[ 64 ];
    float    alpha_a_data[ 64 ];
 
} irgrid_data_t;
 
typedef enum
{
    IRGRID_OK = 0,
    IRGRID_ERROR = -1
 
} irgrid_return_value_t;
 
void irgrid_cfg_setup ( irgrid_cfg_t *cfg );
 
err_t irgrid_init ( irgrid_t *ctx, irgrid_cfg_t *cfg );
 
uint8_t irgrid_device_init ( irgrid_t *ctx, irgrid_data_t *data_str, uint8_t refrate );
 
void irgrid_write_ram( irgrid_t *ctx, uint8_t *data_buf, uint8_t len );
 
void irgrid_read_ram ( irgrid_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
 
void irgrid_write_eeprom ( irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void irgrid_read_eeprom ( irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t irgrid_measure ( irgrid_t *ctx, irgrid_data_t *data_str );
 
void irgrid_get_ir_raw ( irgrid_data_t *data_str, int16_t *buffer );
 
void irgrid_get_temperature ( irgrid_data_t *data_str, float *buffer );
 
float irgrid_get_amb_temperature ( irgrid_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // IRGRID_H
 
 // irgrid
 
// ------------------------------------------------------------------------ END