irgrid3.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 IRGRID3_H
#define IRGRID3_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_i2c_master.h"
 
#define IRGRID3_SET_DEV_ADDR  0x33
 
 // irgrid3_set
 
#define IRGRID3_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // irgrid3_map
 // irgrid3
 
typedef struct 
{
    int16_t k_vdd;
    int16_t vdd_25;
    float kv_ptat;
    float kt_ptat;
    uint16_t v_ptat_25;
    float alpha_ptat;
    int16_t gain_eeprom;
    float tgc;
    float cp_kv;
    float cp_kta;
    uint8_t resolution_eeprom;
    uint8_t calibration_mode_eeprom;
    float ks_ta;
    float ks_to[ 4 ];
    int16_t ct[ 4 ];
    float alpha[ 768 ];
    int16_t offset[ 768 ];
    float kta[ 768 ];
    float kv[ 768 ];
    float cp_alpha[ 2 ];
    int16_t cp_offset[ 2 ];
    float il_chess_c[ 3 ];
    uint16_t broken_pixels[ 5 ];
    uint16_t outlier_pixels[ 5 ];
} irgrid3_params_t;
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
    irgrid3_params_t params;
    
} irgrid3_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} irgrid3_cfg_t;
 
typedef enum
{
   IRGRID3_OK = 0,
   IRGRID3_ERROR = -1,
   IRGRID3_INIT_ERROR = 0xFF,
   IRGRID3_EEPROM_OK = 0x00,
   IRGRID3_EEPROM_ERROR = 0xF0,
   IRGRID3_ADJ_PIXELS_ERROR = 0xF1,
   IRGRID3_ADJ_PIXELS_OK  = 0x00,
   IRGRID3_BROKEN_PIX_ERROR = 0xF2,
   IRGRID3_OUTLIER_PIX_ERROR = 0xF3,
   IRGRID3_2_PIX_ERROR = 0xF4
 
} irgrid3_return_value_t;
 
void irgrid3_cfg_setup ( irgrid3_cfg_t *cfg );
 
err_t irgrid3_init ( irgrid3_t *ctx, irgrid3_cfg_t *cfg );
 
void irgrid3_default_cfg ( irgrid3_t *ctx );
 
void irgrid3_generic_write ( irgrid3_t *ctx, uint16_t reg, uint8_t *data_buf, uint16_t len );
 
void irgrid3_generic_read ( irgrid3_t *ctx, uint16_t reg, uint8_t *rx_buf, uint16_t rx_len );
 
void irgrid3_read_eeprom ( irgrid3_t *ctx, uint16_t *eeprom_data );
 
uint8_t irgrid3_extract_parameters ( irgrid3_t *ctx, uint16_t *eeprom_data );
 
void irgrid3_set_refresh_rate ( irgrid3_t *ctx, uint8_t refresh_rate );
 
uint16_t irgrid3_get_frame_data ( irgrid3_t *ctx, uint16_t *frame_data );
 
void irgrid3_set_resolution ( irgrid3_t *ctx, uint8_t resolution );
 
uint16_t irgrid3_get_current_res ( irgrid3_t *ctx );
 
uint16_t irgrid3_get_refresh_rate ( irgrid3_t *ctx );
 
void irgrid3_set_interleaved_mode ( irgrid3_t *ctx );
 
void irgrid3_set_chess_mode ( irgrid3_t *ctx );
 
uint16_t irgrid3_get_current_mode ( irgrid3_t *ctx );
 
void irgrid3_get_pixel_temperature ( irgrid3_t *ctx, float *temp_ambient, float *pixel_temp );
 
float irgrid3_get_temp_ambient ( irgrid3_t *ctx, uint16_t *frame_data );
 
uint16_t irgrid3_get_subpage_number ( uint16_t *frame_data );
 
float irgrid3_get_vdd ( irgrid3_t *ctx, uint16_t *frame_data );
 
void irgrid3_calculate_temp_obj ( irgrid3_t *ctx, uint16_t *frame_data, float tr_data, float *px_matrix );
 
void irgrid3_get_image ( irgrid3_t *ctx, uint16_t *frame_data, float *px_matrix );
#ifdef __cplusplus
}
#endif
#endif // IRGRID3_H
 
 // irgrid3
 
// ------------------------------------------------------------------------ END