thermo5  2.0.0.0
thermo5.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 THERMO5_H
36 #define THERMO5_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_i2c_master.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define THERMO5_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define THERMO5_RETVAL uint8_t
77 
78 #define THERMO5_OK 0x00
79 #define THERMO5_INIT_ERROR 0xFF
80 
86 #define THERMO5_I2C_ADDRESS 0x4C
87 
93 #define THERMO5_INTER_DIO_DATA_HI_BYTE 0x00
94 #define THERMO5_INTER_DIO_DATA_LO_BYTE 0x29
95 #define THERMO5_EXTER_DIO_1_DATA_HI_BYTE 0x01
96 #define THERMO5_EXTER_DIO_1_DATA_LO_BYTE 0x10
97 #define THERMO5_EXTER_DIO_2_DATA_HI_BYTE 0x23
98 #define THERMO5_EXTER_DIO_2_DATA_LO_BYTE 0x24
99 #define THERMO5_EXTER_DIO_3_HI_BYTE 0x2A
100 #define THERMO5_EXTER_DIO_3_LO_BYTE 0x2B
101 
102 #define THERMO5_INTER_DIODE 0x0029
103 #define THERMO5_EXTER_DIODE1 0x0110
104 #define THERMO5_EXTER_DIODE2 0x2324
105 #define THERMO5_EXTER_DIODE3 0x2A2B
106 
112 #define THERMO5_STAT 0x02
113 
119 #define THERMO5_CONFIG 0x03
120 
126 #define THERMO5_CONVERS_RATE 0x04
127 
133 #define THERMO5_INTER_DIO_HI_LIM 0x05
134 #define THERMO5_INTER_DIO_LO_LIM 0x06
135 #define THERMO5_EXTER_DIO_1_HI_LIM_HI_BYTE 0x07
136 #define THERMO5_EXTER_DIO_1_HI_LIM_LO_BYTE 0x13
137 #define THERMO5_EXTER_DIO_1_LO_LIM_HI_BYTE 0x08
138 #define THERMO5_EXTER_DIO_1_LO_LIM_LO_BYTE 0x14
139 #define THERMO5_EXTER_DIO_2_HI_LIM_HI_BYTE 0x15
140 #define THERMO5_EXTER_DIO_2_LO_LIM_HI_BYTE 0x16
141 #define THERMO5_EXTER_DIO_2_HI_LIM_LO_BYTE 0x17
142 #define THERMO5_EXTER_DIO_2_LO_LIM_LO_BYTE 0x18
143 #define THERMO5_EXTER_DIO_3_HI_LIM_HI_BYTE 0x2C
144 #define THERMO5_EXTER_DIO_3_LO_LIM_HI_BYTE 0x2D
145 #define THERMO5_EXTER_DIO_3_HI_LIM_LO_BYTE 0x2E
146 #define THERMO5_EXTER_DIO_3_LO_LIM_LO_BYTE 0x2F
147 
153 #define THERMO5_SCRATCHPAD_1 0x11
154 #define THERMO5_SCRATCHPAD_2 0x12
155 
161 #define THERMO5_ONE_SHOT 0x0F
162 
168 #define THERMO5_EXTER_DIO_1_THERM_LIM 0x19
169 #define THERMO5_EXTER_DIO_2_THERM_LIM 0x1A
170 #define THERMO5_INTER_DIO_THERM_LIM 0x20
171 #define THERMO5_THERM_HYSTERESIS 0x21
172 #define THERMO5_EXTER_DIO_3_THERM_LIM 0x30
173 
179 #define THERMO5_EXTER_DIO_FAULT 0x1B
180 
186 #define THERMO5_CHANNEL_MASK_REGISTER 0x1F
187 
193 #define THERMO5_CONSECUTIVE_ALERT 0x22
194 
200 #define THERMO5_EXTER_DIO_1_BETA_CONFIG 0x25
201 #define THERMO5_EXTER_DIO_2_BETA_CONFIG 0x26
202 
208 #define THERMO5_EXTER_DIO_1_IDE_FAC 0x27
209 #define THERMO5_EXTER_DIO_2_IDE_FAC 0x28
210 #define THERMO5_EXTER_DIO_3_IDE_FAC 0x31
211 
217 #define THERMO5_HI_LIM_STAT 0x35
218 
224 #define THERMO5_LO_LIM_STAT 0x36
225 
231 #define THERMO5_THERM_LIM_STAT 0x37
232 
238 #define THERMO5_FILTER_CONTROL 0x40
239 
245 #define THERMO5_PRODUCT_ID 0xFD
246 
252 #define THERMO5_MANUFACTURER_ID 0xFE
253 
259 #define THERMO5_REVISION 0xFF
260 
266 #define THERMO5_CONVER_RATE_0_0625 0x00
267 #define THERMO5_CONVER_RATE_0_125 0x01
268 #define THERMO5_CONVER_RATE_0_25 0x02
269 #define THERMO5_CONVER_RATE_0_5 0x03
270 #define THERMO5_CONVER_RATE_1 0x04
271 #define THERMO5_CONVER_RATE_2 0x05
272 #define THERMO5_CONVER_RATE_4 0x06
273 #define THERMO5_CONVER_RATE_8 0x07
274 #define THERMO5_CONVER_RATE_16 0x08
275 #define THERMO5_CONVER_RATE_32 0x09
276 #define THERMO5_CONVER_RATE_64 0x0A
277 
283 #define THERMO5_FILTER_DECODE_DISABLE 0x00
284 #define THERMO5_FILTER_DECODE_LEVEL_1 0x01
285 #define THERMO5_FILTER_DECODE_AVERAGE 0x02
286 #define THERMO5_FILTER_DECODE_LEVEL_2 0x03
287  // End group macro
290 // --------------------------------------------------------------- PUBLIC TYPES
299 typedef struct
300 {
301  // Input pins
302 
303  digital_in_t int_pin;
304 
305  // Modules
306 
307  i2c_master_t i2c;
308 
309  // ctx variable
310 
311  uint8_t slave_address;
312 
313 } thermo5_t;
314 
318 typedef struct
319 {
320  // Communication gpio pins
321 
322  pin_name_t scl;
323  pin_name_t sda;
324 
325  // Additional gpio pins
326 
327  pin_name_t int_pin;
328 
329  // static variable
330 
331  uint32_t i2c_speed;
332  uint8_t i2c_address;
333 
334 } thermo5_cfg_t;
335  // End types group
337 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
338 
344 #ifdef __cplusplus
345 extern "C"{
346 #endif
347 
357 
367 
378 void thermo5_generic_write ( thermo5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
379 
390 void thermo5_generic_read ( thermo5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
391 
401 void thermo5_write_byte ( thermo5_t *ctx, uint8_t wr_addr, uint8_t wr_data );
402 
411 uint8_t thermo5_read_byte ( thermo5_t *ctx, uint8_t rd_addr );
412 
421 uint16_t thermo5_read_data ( thermo5_t *ctx, uint16_t reg_addr );
422 
431 
440 
449 
458 
467 
476 
485 
494 
503 
513 
523 
533 
543 
552 void thermo5_write_config ( thermo5_t *ctx, uint8_t wr_data );
553 
562 
571 void thermo5_set_convers_rate ( thermo5_t *ctx, uint8_t convers_rate );
572 
581 
590 void thermo5_set_filter_rate ( thermo5_t *ctx, uint8_t filter_decode_rate );
591 
600 
609 void thermo5_set_diode_1_beta_config ( thermo5_t *ctx, uint8_t enable );
610 
619 
628 void thermo5_set_diode_2_beta_config ( thermo5_t *ctx, uint8_t enable );
629 
638 
639 #ifdef __cplusplus
640 }
641 #endif
642 #endif // _THERMO5_H_
643  // End public_function group
646 
647 // ------------------------------------------------------------------------- END
thermo5_set_diode_2_beta_config
void thermo5_set_diode_2_beta_config(thermo5_t *ctx, uint8_t enable)
Set External Diode 2 Beta Configuration function.
thermo5_cfg_setup
void thermo5_cfg_setup(thermo5_cfg_t *cfg)
Config Object Initialization function.
thermo5_read_config
uint8_t thermo5_read_config(thermo5_t *ctx)
Read configuration function.
thermo5_read_therm_limit_stat
uint8_t thermo5_read_therm_limit_stat(thermo5_t *ctx)
Read therm limit status function.
thermo5_read_low_limit_stat
uint8_t thermo5_read_low_limit_stat(thermo5_t *ctx)
Read low limit status function.
thermo5_read_extern_1_temp
float thermo5_read_extern_1_temp(thermo5_t *ctx)
Read external diode 1 temperature function.
thermo5_set_convers_rate
void thermo5_set_convers_rate(thermo5_t *ctx, uint8_t convers_rate)
Set conversion rate function.
thermo5_read_data
uint16_t thermo5_read_data(thermo5_t *ctx, uint16_t reg_addr)
Read data function.
thermo5_read_filter_rate
uint8_t thermo5_read_filter_rate(thermo5_t *ctx)
Read filter configuration function.
thermo5_read_stat_reg
uint8_t thermo5_read_stat_reg(thermo5_t *ctx)
Read status register function.
thermo5_cfg_t::scl
pin_name_t scl
Definition: thermo5.h:322
thermo5_get_interrupt_state
uint8_t thermo5_get_interrupt_state(thermo5_t *ctx)
Get interrupt state function.
thermo5_read_extern_2_temp
float thermo5_read_extern_2_temp(thermo5_t *ctx)
Read external diode 2 temperature function.
thermo5_write_config
void thermo5_write_config(thermo5_t *ctx, uint8_t wr_data)
Write configuration function.
thermo5_read_byte
uint8_t thermo5_read_byte(thermo5_t *ctx, uint8_t rd_addr)
Read byte function.
thermo5_cfg_t::int_pin
pin_name_t int_pin
Definition: thermo5.h:327
thermo5_cfg_t::sda
pin_name_t sda
Definition: thermo5.h:323
thermo5_read_product_id
uint8_t thermo5_read_product_id(thermo5_t *ctx)
Read product ID function.
thermo5_t::slave_address
uint8_t slave_address
Definition: thermo5.h:311
thermo5_read_extern_3_temp
float thermo5_read_extern_3_temp(thermo5_t *ctx)
Read external diode 3 temperature function.
thermo5_cfg_t
Click configuration structure definition.
Definition: thermo5.h:319
thermo5_t
Click ctx object definition.
Definition: thermo5.h:300
thermo5_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo5.h:332
thermo5_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo5.h:331
thermo5_read_diode_1_beta_config
uint8_t thermo5_read_diode_1_beta_config(thermo5_t *ctx)
Read External Diode 1 Beta Configuration function.
thermo5_read_revision_register
uint8_t thermo5_read_revision_register(thermo5_t *ctx)
Read revision register function.
thermo5_t::int_pin
digital_in_t int_pin
Definition: thermo5.h:303
thermo5_set_filter_rate
void thermo5_set_filter_rate(thermo5_t *ctx, uint8_t filter_decode_rate)
Filter configuration function.
thermo5_read_exter_diode_fault
uint8_t thermo5_read_exter_diode_fault(thermo5_t *ctx)
Read external diode fault function.
thermo5_read_high_limit_stat
uint8_t thermo5_read_high_limit_stat(thermo5_t *ctx)
Read high limit status function.
THERMO5_RETVAL
#define THERMO5_RETVAL
Definition: thermo5.h:76
thermo5_read_diode_2_beta_config
uint8_t thermo5_read_diode_2_beta_config(thermo5_t *ctx)
Read External Diode 2 Beta Configuration function.
thermo5_set_diode_1_beta_config
void thermo5_set_diode_1_beta_config(thermo5_t *ctx, uint8_t enable)
Set External Diode 1 Beta Configuration function.
thermo5_init
THERMO5_RETVAL thermo5_init(thermo5_t *ctx, thermo5_cfg_t *cfg)
Initialization function.
thermo5_read_inter_temp
float thermo5_read_inter_temp(thermo5_t *ctx)
Read internal diode temperature function.
thermo5_read_manufacturer_id
uint8_t thermo5_read_manufacturer_id(thermo5_t *ctx)
Read manufacturer ID function.
thermo5_generic_write
void thermo5_generic_write(thermo5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermo5_read_convers_rate
uint8_t thermo5_read_convers_rate(thermo5_t *ctx)
Read conversion rate function.
thermo5_t::i2c
i2c_master_t i2c
Definition: thermo5.h:307
thermo5_write_byte
void thermo5_write_byte(thermo5_t *ctx, uint8_t wr_addr, uint8_t wr_data)
Write byte function.
thermo5_generic_read
void thermo5_generic_read(thermo5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.