irgrid2  2.0.0.0
irgrid2.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef IRGRID2_H
29 #define IRGRID2_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_i2c_master.h"
37 
64 #define IRGRID2_SET_DEV_ADDR 0x33
65  // irgrid2_set
67 
82 #define IRGRID2_MAP_MIKROBUS( cfg, mikrobus ) \
83  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
84  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
85  // irgrid2_map // irgrid2
88 
93 typedef struct
94 {
95  int16_t k_vdd;
96  int16_t vdd_25;
97  float kv_ptat;
98  float kt_ptat;
99  uint16_t v_ptat_25;
100  float alpha_ptat;
101  int16_t gain_eeprom;
102  float tgc;
103  float cp_kv;
104  float cp_kta;
107  float ks_ta;
108  float ks_to[ 4 ];
109  int16_t ct[ 4 ];
110  float alpha[ 768 ];
111  int16_t offset[ 768 ];
112  float kta[ 768 ];
113  float kv[ 768 ];
114  float cp_alpha[ 2 ];
115  int16_t cp_offset[ 2 ];
116  float il_chess_c[ 3 ];
117  uint16_t broken_pixels[ 5 ];
118  uint16_t outlier_pixels[ 5 ];
120 
125 typedef struct
126 {
127  // Modules
128  i2c_master_t i2c;
130  // I2C slave address
131  uint8_t slave_address;
133 
134 } irgrid2_t;
135 
140 typedef struct
141 {
142  pin_name_t scl;
143  pin_name_t sda;
145  uint32_t i2c_speed;
146  uint8_t i2c_address;
148 } irgrid2_cfg_t;
149 
154 typedef enum
155 {
165  IRGRID2_2_PIX_ERROR = 0xF4
166 
168 
186 
202 err_t irgrid2_init ( irgrid2_t *ctx, irgrid2_cfg_t *cfg );
203 
218 
234 void irgrid2_generic_write ( irgrid2_t *ctx, uint16_t reg, uint8_t *data_buf, uint16_t len );
235 
252 void irgrid2_generic_read ( irgrid2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
253 
263 void irgrid2_read_eeprom ( irgrid2_t *ctx, uint16_t *eeprom_data );
264 
274 uint8_t irgrid2_extract_parameters ( irgrid2_t *ctx, uint16_t *eeprom_data );
275 
285 void irgrid2_set_refresh_rate ( irgrid2_t *ctx, uint8_t refresh_rate );
286 
296 uint16_t irgrid2_get_frame_data ( irgrid2_t *ctx, uint16_t *frame_data );
297 
307 void irgrid2_set_resolution ( irgrid2_t *ctx, uint8_t resolution );
308 
317 
326 
336 
346 
356 
367 void irgrid2_get_pixel_temperature ( irgrid2_t *ctx, float *temp_ambient, float *pixel_temp );
368 
378 float irgrid2_get_temp_ambient ( irgrid2_t *ctx, uint16_t *frame_data );
379 
389 uint16_t irgrid2_get_subpage_number ( uint16_t *frame_data );
390 
398 float irgrid2_get_vdd ( irgrid2_t *ctx, uint16_t *frame_data );
399 
411 void irgrid2_calculate_temp_obj ( irgrid2_t *ctx, uint16_t *frame_data, float tr_data, float *px_matrix );
412 
423 void irgrid2_get_image ( irgrid2_t *ctx, uint16_t *frame_data, float *px_matrix );
424 #ifdef __cplusplus
425 }
426 #endif
427 #endif // IRGRID2_H
428  // irgrid2
430 
431 // ------------------------------------------------------------------------ END
irgrid2_get_refresh_rate
uint16_t irgrid2_get_refresh_rate(irgrid2_t *ctx)
Function for getting current refresh Rate.
irgrid2_cfg_t::sda
pin_name_t sda
Definition: irgrid2.h:143
irgrid2_get_pixel_temperature
void irgrid2_get_pixel_temperature(irgrid2_t *ctx, float *temp_ambient, float *pixel_temp)
Function for getting pixels temperature.
irgrid2_params_t::kv_ptat
float kv_ptat
Definition: irgrid2.h:97
irgrid2_params_t::resolution_eeprom
uint8_t resolution_eeprom
Definition: irgrid2.h:105
irgrid2_generic_write
void irgrid2_generic_write(irgrid2_t *ctx, uint16_t reg, uint8_t *data_buf, uint16_t len)
IR Grid 2 I2C writing function.
irgrid2_calculate_temp_obj
void irgrid2_calculate_temp_obj(irgrid2_t *ctx, uint16_t *frame_data, float tr_data, float *px_matrix)
Function for calculating temperature objects.
irgrid2_t
IR Grid 2 Click context object.
Definition: irgrid2.h:126
irgrid2_params_t::k_vdd
int16_t k_vdd
Definition: irgrid2.h:95
irgrid2_params_t::gain_eeprom
int16_t gain_eeprom
Definition: irgrid2.h:101
irgrid2_params_t::cp_kv
float cp_kv
Definition: irgrid2.h:103
irgrid2_t::params
irgrid2_params_t params
Definition: irgrid2.h:132
irgrid2_cfg_t::i2c_address
uint8_t i2c_address
Definition: irgrid2.h:146
irgrid2_get_temp_ambient
float irgrid2_get_temp_ambient(irgrid2_t *ctx, uint16_t *frame_data)
Function for getting Ambient temperature.
irgrid2_t::i2c
i2c_master_t i2c
Definition: irgrid2.h:128
irgrid2_get_current_res
uint16_t irgrid2_get_current_res(irgrid2_t *ctx)
Function for getting current resolution.
irgrid2_get_vdd
float irgrid2_get_vdd(irgrid2_t *ctx, uint16_t *frame_data)
Function for getting Vdd.
irgrid2_params_t
IR Grid 2 Click params definition.
Definition: irgrid2.h:94
irgrid2_params_t::calibration_mode_eeprom
uint8_t calibration_mode_eeprom
Definition: irgrid2.h:106
IRGRID2_INIT_ERROR
@ IRGRID2_INIT_ERROR
Definition: irgrid2.h:158
irgrid2_generic_read
void irgrid2_generic_read(irgrid2_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
IR Grid 2 I2C reading function.
IRGRID2_EEPROM_ERROR
@ IRGRID2_EEPROM_ERROR
Definition: irgrid2.h:160
IRGRID2_OUTLIER_PIX_ERROR
@ IRGRID2_OUTLIER_PIX_ERROR
Definition: irgrid2.h:164
irgrid2_cfg_t
IR Grid 2 Click configuration object.
Definition: irgrid2.h:141
irgrid2_return_value_t
irgrid2_return_value_t
IR Grid 2 Click return value data.
Definition: irgrid2.h:155
irgrid2_set_chess_mode
void irgrid2_set_chess_mode(irgrid2_t *ctx)
Function for setting chess mode.
irgrid2_t::slave_address
uint8_t slave_address
Definition: irgrid2.h:131
irgrid2_get_image
void irgrid2_get_image(irgrid2_t *ctx, uint16_t *frame_data, float *px_matrix)
Function for getting Image.
irgrid2_read_eeprom
void irgrid2_read_eeprom(irgrid2_t *ctx, uint16_t *eeprom_data)
Function for reading EEPROM.
IRGRID2_ERROR
@ IRGRID2_ERROR
Definition: irgrid2.h:157
IRGRID2_OK
@ IRGRID2_OK
Definition: irgrid2.h:156
irgrid2_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: irgrid2.h:145
irgrid2_params_t::alpha_ptat
float alpha_ptat
Definition: irgrid2.h:100
IRGRID2_EEPROM_OK
@ IRGRID2_EEPROM_OK
Definition: irgrid2.h:159
irgrid2_set_interleaved_mode
void irgrid2_set_interleaved_mode(irgrid2_t *ctx)
Function for setting interleaved mode.
irgrid2_params_t::v_ptat_25
uint16_t v_ptat_25
Definition: irgrid2.h:99
irgrid2_cfg_setup
void irgrid2_cfg_setup(irgrid2_cfg_t *cfg)
IR Grid 2 configuration object setup function.
IRGRID2_BROKEN_PIX_ERROR
@ IRGRID2_BROKEN_PIX_ERROR
Definition: irgrid2.h:163
irgrid2_params_t::vdd_25
int16_t vdd_25
Definition: irgrid2.h:96
irgrid2_default_cfg
void irgrid2_default_cfg(irgrid2_t *ctx)
IR Grid 2 default configuration function.
irgrid2_params_t::cp_kta
float cp_kta
Definition: irgrid2.h:104
IRGRID2_2_PIX_ERROR
@ IRGRID2_2_PIX_ERROR
Definition: irgrid2.h:165
irgrid2_get_subpage_number
uint16_t irgrid2_get_subpage_number(uint16_t *frame_data)
Function for getting sub page number.
irgrid2_get_frame_data
uint16_t irgrid2_get_frame_data(irgrid2_t *ctx, uint16_t *frame_data)
Function for getting frame data.
irgrid2_params_t::tgc
float tgc
Definition: irgrid2.h:102
irgrid2_cfg_t::scl
pin_name_t scl
Definition: irgrid2.h:142
irgrid2_params_t::kt_ptat
float kt_ptat
Definition: irgrid2.h:98
irgrid2_params_t::ks_ta
float ks_ta
Definition: irgrid2.h:107
IRGRID2_ADJ_PIXELS_ERROR
@ IRGRID2_ADJ_PIXELS_ERROR
Definition: irgrid2.h:161
irgrid2_extract_parameters
uint8_t irgrid2_extract_parameters(irgrid2_t *ctx, uint16_t *eeprom_data)
Parameters storage function.
irgrid2_get_current_mode
uint16_t irgrid2_get_current_mode(irgrid2_t *ctx)
Function for getting current mode.
irgrid2_set_refresh_rate
void irgrid2_set_refresh_rate(irgrid2_t *ctx, uint8_t refresh_rate)
Function for setting refresh rate.
IRGRID2_ADJ_PIXELS_OK
@ IRGRID2_ADJ_PIXELS_OK
Definition: irgrid2.h:162
irgrid2_init
err_t irgrid2_init(irgrid2_t *ctx, irgrid2_cfg_t *cfg)
IR Grid 2 initialization function.
irgrid2_set_resolution
void irgrid2_set_resolution(irgrid2_t *ctx, uint8_t resolution)
Function for setting resolution.