irgrid  2.0.0.0
irgrid.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 IRGRID_H
29 #define IRGRID_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_i2c_master.h"
48 
69 #define IRGRID_CAL_ACOMMON_L 0xD0
70 #define IRGRID_CAL_ACOMMON_H 0xD1
71 #define IRGRID_CAL_ACP_L 0xD3
72 #define IRGRID_CAL_ACP_H 0xD4
73 #define IRGRID_CAL_BCP 0xD5
74 #define IRGRID_CAL_ALPHA_CP_L 0xD6
75 #define IRGRID_CAL_ALPHA_CP_H 0xD7
76 #define IRGRID_CAL_TGC 0xD8
77 #define IRGRID_CAL_AI_SCALE 0xD9
78 #define IRGRID_CAL_BI_SCALE 0xD9
79 #define IRGRID_VTH_L 0xDA
80 #define IRGRID_VTH_H 0xDB
81 #define IRGRID_KT1_L 0xDC
82 #define IRGRID_KT1_H 0xDD
83 #define IRGRID_KT2_L 0xDE
84 #define IRGRID_KT2_H 0xDF
85 #define IRGRID_KT_SCALE 0xD2
86 #define IRGRID_CAL_A0_L 0xE0
87 #define IRGRID_CAL_A0_H 0xE1
88 #define IRGRID_CAL_A0_SCALE 0xE2
89 #define IRGRID_CAL_DELTA_A_SCALE 0xE3
90 #define IRGRID_CAL_EMIS_L 0xE4
91 #define IRGRID_CAL_EMIS_H 0xE5
92 #define IRGRID_OSC_TRIM_VALUE 0xF7
93  // irgrid_reg
95 
115 #define IRGRID_MAP_MIKROBUS( cfg, mikrobus ) \
116  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
117  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
118  // irgrid_map // irgrid
121 
126 typedef struct
127 {
128  // Modules
129  i2c_master_t i2c;
131  // I2C slave address
134 
135  // static variable
136  uint8_t refresh_rate;
138  int16_t resolution;
139  int16_t cpix;
140  int16_t ptat;
141 
142 } irgrid_t;
143 
148 typedef struct
149 {
150  pin_name_t scl;
151  pin_name_t sda;
153  uint32_t i2c_speed;
154  uint8_t i2c_ram_address;
157 } irgrid_cfg_t;
158 
162 typedef struct
163 {
164  // Static variable
165 
166  uint8_t eeprom_data[ 256 ];
167  int16_t ir_data[ 64 ];
168  float temperature_data[ 64 ];
169  float a_data[ 64 ];
170  float b_data[ 64 ];
171  float alpha_a_data[ 64 ];
172 
173 } irgrid_data_t;
174 
179 typedef enum
180 {
182  IRGRID_ERROR = -1
183 
185 
202 
217 err_t irgrid_init ( irgrid_t *ctx, irgrid_cfg_t *cfg );
218 
230 uint8_t irgrid_device_init ( irgrid_t *ctx, irgrid_data_t *data_str, uint8_t refrate );
231 
241 void irgrid_write_ram( irgrid_t *ctx, uint8_t *data_buf, uint8_t len );
242 
253 void irgrid_read_ram ( irgrid_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
254 
265 void irgrid_write_eeprom ( irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
266 
277 void irgrid_read_eeprom ( irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
278 
289 uint8_t irgrid_measure ( irgrid_t *ctx, irgrid_data_t *data_str );
290 
299 void irgrid_get_ir_raw ( irgrid_data_t *data_str, int16_t *buffer );
300 
309 void irgrid_get_temperature ( irgrid_data_t *data_str, float *buffer );
310 
321 
322 #ifdef __cplusplus
323 }
324 #endif
325 #endif // IRGRID_H
326  // irgrid
328 
329 // ------------------------------------------------------------------------ END
irgrid_cfg_t::sda
pin_name_t sda
Definition: irgrid.h:151
irgrid_get_amb_temperature
float irgrid_get_amb_temperature(irgrid_t *ctx)
Read Ambient Temperature.
irgrid_get_ir_raw
void irgrid_get_ir_raw(irgrid_data_t *data_str, int16_t *buffer)
Read Raw Temperature buffer.
irgrid_cfg_t::i2c_eeprom_address
uint8_t i2c_eeprom_address
Definition: irgrid.h:155
IRGRID_ERROR
@ IRGRID_ERROR
Definition: irgrid.h:182
irgrid_write_eeprom
void irgrid_write_eeprom(irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Write function using EEPROM slave adress.
irgrid_data_t
Click data object definition.
Definition: irgrid.h:163
irgrid_t::cpix
int16_t cpix
Definition: irgrid.h:139
irgrid_write_ram
void irgrid_write_ram(irgrid_t *ctx, uint8_t *data_buf, uint8_t len)
Write function using RAM slave adress.
irgrid_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: irgrid.h:153
irgrid_read_ram
void irgrid_read_ram(irgrid_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len)
Read function using RAM slave adress.
irgrid_read_eeprom
void irgrid_read_eeprom(irgrid_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Read function using EEPROM slave adress.
irgrid_cfg_t
IR Grid Click configuration object.
Definition: irgrid.h:149
irgrid_cfg_t::i2c_ram_address
uint8_t i2c_ram_address
Definition: irgrid.h:154
irgrid_get_temperature
void irgrid_get_temperature(irgrid_data_t *data_str, float *buffer)
Read Calculated Temperature buffer.
irgrid_measure
uint8_t irgrid_measure(irgrid_t *ctx, irgrid_data_t *data_str)
Measurement.
irgrid_cfg_setup
void irgrid_cfg_setup(irgrid_cfg_t *cfg)
IR Grid configuration object setup function.
irgrid_t::slave_eeprom_address
uint8_t slave_eeprom_address
Definition: irgrid.h:133
irgrid_return_value_t
irgrid_return_value_t
IR Grid Click return value data.
Definition: irgrid.h:180
irgrid_t::resolution
int16_t resolution
Definition: irgrid.h:138
irgrid_t::i2c
i2c_master_t i2c
Definition: irgrid.h:129
irgrid_t
IR Grid Click context object.
Definition: irgrid.h:127
IRGRID_OK
@ IRGRID_OK
Definition: irgrid.h:181
irgrid_t::temperature_amb
float temperature_amb
Definition: irgrid.h:137
irgrid_cfg_t::scl
pin_name_t scl
Definition: irgrid.h:150
irgrid_init
err_t irgrid_init(irgrid_t *ctx, irgrid_cfg_t *cfg)
IR Grid initialization function.
irgrid_t::ptat
int16_t ptat
Definition: irgrid.h:140
irgrid_t::refresh_rate
uint8_t refresh_rate
Definition: irgrid.h:136
irgrid_device_init
uint8_t irgrid_device_init(irgrid_t *ctx, irgrid_data_t *data_str, uint8_t refrate)
Device Initialization.
irgrid_t::slave_ram_address
uint8_t slave_ram_address
Definition: irgrid.h:132