irthermo3  2.0.0.0
irthermo3.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef IRTHERMO3_H
36 #define IRTHERMO3_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define IRTHERMO3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define IRTHERMO3_OK 0x00
62 #define IRTHERMO3_ERROR 0xFF
63 
69 #define IRTHERMO3_DEV_ADR_GND 0x3A
70 #define IRTHERMO3_DEV_ADR_VCC 0x3B
71 
77 #define IRTHERMO3_EEPROM_VERSION 0x240B
78 
84 #define IRTHERMO3_EEPROM_CAL_CONST_P_R_LSW 0x240C
85 #define IRTHERMO3_EEPROM_CAL_CONST_P_R_MSW 0x240D
86 #define IRTHERMO3_EEPROM_CAL_CONST_P_G_LSW 0x240E
87 #define IRTHERMO3_EEPROM_CAL_CONST_P_G_MSW 0x240F
88 #define IRTHERMO3_EEPROM_CAL_CONST_P_T_LSW 0x2410
89 #define IRTHERMO3_EEPROM_CAL_CONST_P_T_MSW 0x2411
90 #define IRTHERMO3_EEPROM_CAL_CONST_P_O_LSW 0x2412
91 #define IRTHERMO3_EEPROM_CAL_CONST_P_O_MSW 0x2413
92 #define IRTHERMO3_EEPROM_CAL_CONST_AA_LSW 0x2414
93 #define IRTHERMO3_EEPROM_CAL_CONST_AA_MSW 0x2415
94 #define IRTHERMO3_EEPROM_CAL_CONST_AB_LSW 0x2416
95 #define IRTHERMO3_EEPROM_CAL_CONST_AB_MSW 0x2417
96 #define IRTHERMO3_EEPROM_CAL_CONST_BA_LSW 0x2418
97 #define IRTHERMO3_EEPROM_CAL_CONST_BA_MSW 0x2419
98 #define IRTHERMO3_EEPROM_CAL_CONST_BB_LSW 0x241A
99 #define IRTHERMO3_EEPROM_CAL_CONST_BB_MSW 0x241B
100 #define IRTHERMO3_EEPROM_CAL_CONST_CA_LSW 0x241C
101 #define IRTHERMO3_EEPROM_CAL_CONST_CA_MSW 0x241D
102 #define IRTHERMO3_EEPROM_CAL_CONST_CB_LSW 0x241E
103 #define IRTHERMO3_EEPROM_CAL_CONST_CB_MSW 0x241F
104 #define IRTHERMO3_EEPROM_CAL_CONST_DA_LSW 0x2420
105 #define IRTHERMO3_EEPROM_CAL_CONST_DA_MSW 0x2421
106 #define IRTHERMO3_EEPROM_CAL_CONST_DB_LSW 0x2422
107 #define IRTHERMO3_EEPROM_CAL_CONST_DB_MSW 0x2423
108 #define IRTHERMO3_EEPROM_CAL_CONST_EA_LSW 0x2424
109 #define IRTHERMO3_EEPROM_CAL_CONST_EA_MSW 0x2425
110 #define IRTHERMO3_EEPROM_CAL_CONST_EB_LSW 0x2426
111 #define IRTHERMO3_EEPROM_CAL_CONST_EB_MSW 0x2427
112 #define IRTHERMO3_EEPROM_CAL_CONST_FA_LSW 0x2428
113 #define IRTHERMO3_EEPROM_CAL_CONST_FA_MSW 0x2429
114 #define IRTHERMO3_EEPROM_CAL_CONST_FB_LSW 0x242A
115 #define IRTHERMO3_EEPROM_CAL_CONST_FB_MSW 0x242B
116 #define IRTHERMO3_EEPROM_CAL_CONST_GA_LSW 0x242C
117 #define IRTHERMO3_EEPROM_CAL_CONST_GA_MSW 0x242D
118 #define IRTHERMO3_EEPROM_CAL_CONST_GB 0x242E
119 #define IRTHERMO3_EEPROM_CAL_CONST_KA 0x242E
120 #define IRTHERMO3_EEPROM_CAL_CONST_KB 0x242E
121 #define IRTHERMO3_EEPROM_CAL_CONST_HA_COSTUMER 0x2481
122 #define IRTHERMO3_EEPROM_CAL_CONST_HB_COSTUMER 0x2482
123 
129 #define IRTHERMO3_EEPROM_CTRL_REG 0x24D4
130 #define IRTHERMO3_EEPROM_I2C_ADDRESS 0x24D5
131 #define IRTHERMO3_REG_I2C_ADDRESS 0x3000
132 #define IRTHERMO3_REG_CONTROL 0x3001
133 #define IRTHERMO3_REG_RESET 0x3005
134 #define IRTHERMO3_REG_STATUS 0x3FFF
135 
141 #define IRTHERMO3_RAW_DATA_1 0x4000
142 #define IRTHERMO3_RAW_DATA_2 0x4001
143 #define IRTHERMO3_RAW_DATA_3 0x4002
144 #define IRTHERMO3_RAW_DATA_4 0x4003
145 #define IRTHERMO3_RAW_DATA_5 0x4004
146 #define IRTHERMO3_RAW_DATA_6 0x4005
147 #define IRTHERMO3_RAW_DATA_7 0x4006
148 #define IRTHERMO3_RAW_DATA_8 0x4007
149 #define IRTHERMO3_RAW_DATA_9 0x4008
150 
156 #define IRTHERMO3_MODE_SLEEP 0x02
157 #define IRTHERMO3_MODE_STEPIN 0x04
158 #define IRTHERMO3_MODE_CONTINOUS 0x06
159  // End group macro
162 // --------------------------------------------------------------- PUBLIC TYPES
171 typedef struct
172 {
173  float p_r;
174  float p_g;
175  float p_t;
176  float p_o;
177  float ea;
178  float eb;
179  float fa;
180  float fb;
181  float ga;
182  float gb;
183  float ka;
184  float ha;
185  float hb;
186 
188 
192 typedef struct
193 {
194  // Modules
195  i2c_master_t i2c;
196 
197  // ctx variable
198  uint8_t slave_address;
199 
200  // Calculation coefficients
202 
203 } irthermo3_t;
204 
208 typedef struct
209 {
210  // Communication gpio pins
211  pin_name_t scl;
212  pin_name_t sda;
213 
214  // static variable
215  uint32_t i2c_speed;
216  uint8_t i2c_address;
217 
219  // End types group
221 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
222 
228 #ifdef __cplusplus
229 extern "C"{
230 #endif
231 
241 
251 
262 void irthermo3_generic_write ( irthermo3_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t len );
263 
274 void irthermo3_generic_read ( irthermo3_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t len );
275 
285 void irthermo3_write_u16 ( irthermo3_t *ctx, uint16_t reg, uint16_t wr_data );
286 
297 int16_t irthermo3_read_i16( irthermo3_t *ctx, uint16_t reg );
298 
309 int32_t irthermo3_read_i32 ( irthermo3_t *ctx, uint16_t reg );
310 
319 void irthermo3_set_mode( irthermo3_t *ctx, uint8_t mode );
320 
330 
339 
348 
349 #ifdef __cplusplus
350 }
351 #endif
352 #endif // _IRTHERMO3_H_
353  // End public_function group
356 
357 // ------------------------------------------------------------------------- END
irthermo3_get_ambient_temp
float irthermo3_get_ambient_temp(irthermo3_t *ctx)
Read Ambient Temperature function.
irthermo3_cal_coef_t::p_r
float p_r
Definition: irthermo3.h:173
irthermo3_cal_coef_t::fa
float fa
Definition: irthermo3.h:179
irthermo3_cal_coef_t::ka
float ka
Definition: irthermo3.h:183
irthermo3_generic_write
void irthermo3_generic_write(irthermo3_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
irthermo3_init
err_t irthermo3_init(irthermo3_t *ctx, irthermo3_cfg_t *cfg)
Initialization function.
irthermo3_cfg_t
Click configuration structure definition.
Definition: irthermo3.h:209
irthermo3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: irthermo3.h:215
irthermo3_cal_coef_t::eb
float eb
Definition: irthermo3.h:178
irthermo3_cal_coef_t
Calculation coefficients.
Definition: irthermo3.h:172
irthermo3_cal_coef_t::ha
float ha
Definition: irthermo3.h:184
irthermo3_read_i16
int16_t irthermo3_read_i16(irthermo3_t *ctx, uint16_t reg)
Read i16 dat function.
irthermo3_t::slave_address
uint8_t slave_address
Definition: irthermo3.h:198
irthermo3_t
Click ctx object definition.
Definition: irthermo3.h:193
irthermo3_cal_coef_t::ea
float ea
Definition: irthermo3.h:177
irthermo3_t::i2c
i2c_master_t i2c
Definition: irthermo3.h:195
irthermo3_cal_coef_t::p_g
float p_g
Definition: irthermo3.h:174
irthermo3_cfg_t::sda
pin_name_t sda
Definition: irthermo3.h:212
irthermo3_cal_coef_t::gb
float gb
Definition: irthermo3.h:182
irthermo3_cfg_t::scl
pin_name_t scl
Definition: irthermo3.h:211
irthermo3_cal_coef_t::ga
float ga
Definition: irthermo3.h:181
irthermo3_cfg_setup
void irthermo3_cfg_setup(irthermo3_cfg_t *cfg)
Config Object Initialization function.
irthermo3_get_object_temp
float irthermo3_get_object_temp(irthermo3_t *ctx)
Read Object Temperature function.
irthermo3_t::cal_coef
irthermo3_cal_coef_t cal_coef
Definition: irthermo3.h:201
irthermo3_generic_read
void irthermo3_generic_read(irthermo3_t *ctx, uint16_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
irthermo3_write_u16
void irthermo3_write_u16(irthermo3_t *ctx, uint16_t reg, uint16_t wr_data)
Write u16 data function.
irthermo3_set_mode
void irthermo3_set_mode(irthermo3_t *ctx, uint8_t mode)
Set device mode function.
irthermo3_cal_coef_t::hb
float hb
Definition: irthermo3.h:185
irthermo3_cal_coef_t::p_o
float p_o
Definition: irthermo3.h:176
irthermo3_cfg_t::i2c_address
uint8_t i2c_address
Definition: irthermo3.h:216
irthermo3_cal_coef_t::fb
float fb
Definition: irthermo3.h:180
irthermo3_cal
void irthermo3_cal(irthermo3_t *ctx)
Calibration function.
irthermo3_read_i32
int32_t irthermo3_read_i32(irthermo3_t *ctx, uint16_t reg)
Read i32 dat function.
irthermo3_cal_coef_t::p_t
float p_t
Definition: irthermo3.h:175