thermok  2.0.0.0
thermok.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 THERMOK_H
36 #define THERMOK_H
37 
38 #include "mikrosdk_version.h"
39 
40 #ifdef __GNUC__
41 #if mikroSDK_GET_VERSION < 20800ul
42 #include "rcu_delays.h"
43 #else
44 #include "delays.h"
45 #endif
46 #endif
47 
48 #include "drv_digital_out.h"
49 #include "drv_digital_in.h"
50 #include "drv_i2c_master.h"
51 
52 
53 // -------------------------------------------------------------- PUBLIC MACROS
63 #define THERMOK_MAP_MIKROBUS( cfg, mikrobus ) \
64  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
65  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
66  cfg.al4 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
67  cfg.al3 = MIKROBUS( mikrobus, MIKROBUS_RST ); \
68  cfg.al2 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
69  cfg.al1 = MIKROBUS( mikrobus, MIKROBUS_INT );
70 
76 #define THERMOK_RETVAL uint8_t
77 
78 #define THERMOK_OK 0x00
79 #define THERMOK_INIT_ERROR 0xFF
80 
86 #define THERMOK_DEVICE_SLAVE_ADDR_0 0x60
87 #define THERMOK_DEVICE_SLAVE_ADDR_1 0x61
88 #define THERMOK_DEVICE_SLAVE_ADDR_2 0x62
89 #define THERMOK_DEVICE_SLAVE_ADDR_3 0x63
90 #define THERMOK_DEVICE_SLAVE_ADDR_4 0x64
91 #define THERMOK_DEVICE_SLAVE_ADDR_5 0x65
92 #define THERMOK_DEVICE_SLAVE_ADDR_6 0x66
93 #define THERMOK_DEVICE_SLAVE_ADDR_7 0x67
94 
100 #define THERMOK_REG_HOT_JUNCTION_TEMP_THR 0x00
101 #define THERMOK_REG_JUNCTIONS_TEMP_DELTA_THR 0x01
102 #define THERMOK_REG_COLD_JUNCTION_TEMP_THR 0x02
103 #define THERMOK_REG_RAW_ADC_DATA 0x03
104 #define THERMOK_REG_STATUS 0x04
105 #define THERMOK_REG_SENSOR_CONFIG 0x05
106 #define THERMOK_REG_DEVICE_CONFIG 0x06
107 #define THERMOK_REG_ALERT1_CONFIG 0x08
108 #define THERMOK_REG_ALERT2_CONFIG 0x09
109 #define THERMOK_REG_ALERT3_CONFIG 0x0A
110 #define THERMOK_REG_ALERT4_CONFIG 0x0B
111 #define THERMOK_REG_ALERT1_HYSTERESIS 0x0C
112 #define THERMOK_REG_ALERT2_HYSTERESIS 0x0D
113 #define THERMOK_REG_ALERT3_HYSTERESIS 0x0E
114 #define THERMOK_REG_ALERT4_HYSTERESIS 0x0F
115 #define THERMOK_REG_ALERT1_LIMIT 0x10
116 #define THERMOK_REG_ALERT2_LIMIT 0x11
117 #define THERMOK_REG_ALERT3_LIMIT 0x12
118 #define THERMOK_REG_ALERT4_LIMIT 0x13
119 #define THERMOK_REG_DEVICE_ID 0x20
120 
126 #define THERMOK_SCFG_TYPE_K 0x00
127 #define THERMOK_SCFG_TYPE_J 0x10
128 #define THERMOK_SCFG_TYPE_T 0x20
129 #define THERMOK_SCFG_TYPE_N 0x30
130 #define THERMOK_SCFG_TYPE_S 0x40
131 #define THERMOK_SCFG_TYPE_E 0x50
132 #define THERMOK_SCFG_TYPE_B 0x60
133 #define THERMOK_SCFG_TYPE_R 0x70
134 #define THERMOK_SCFG_FILTER_COEFFICIENT_0 0x00
135 #define THERMOK_SCFG_FILTER_COEFFICIENT_1 0x01
136 #define THERMOK_SCFG_FILTER_COEFFICIENT_2 0x02
137 #define THERMOK_SCFG_FILTER_COEFFICIENT_3 0x03
138 #define THERMOK_SCFG_FILTER_COEFFICIENT_4 0x04
139 #define THERMOK_SCFG_FILTER_COEFFICIENT_5 0x05
140 #define THERMOK_SCFG_FILTER_COEFFICIENT_6 0x06
141 #define THERMOK_SCFG_FILTER_COEFFICIENT_7 0x07
142 
148 #define THERMOK_DCFG_COLD_JUNCTION_RES_0p0625 0x00
149 #define THERMOK_DCFG_COLD_JUNCTION_RES_0p25 0x80
150 #define THERMOK_DCFG_ADC_RES_18bit 0x00
151 #define THERMOK_DCFG_ADC_RES_16bit 0x20
152 #define THERMOK_DCFG_ADC_RES_14bit 0x40
153 #define THERMOK_DCFG_ADC_RES_12bit 0x60
154 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_1 0x00
155 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_2 0x04
156 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_4 0x08
157 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_8 0x0C
158 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_16 0x10
159 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_32 0x14
160 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_64 0x18
161 #define THERMOK_DCFG_NUM_TEMP_SAMPLES_128 0x1C
162 #define THERMOK_DCFG_MODE_NORMAL_OPERATION 0x00
163 #define THERMOK_DCFG_MODE_SHUTDOWN 0x01
164 #define THERMOK_DCFG_MODE_BURST 0x02
165 
171 #define THERMOK_ACFG_INTERRUPT_CLEAR_1 0x80
172 #define THERMOK_ACFG_INTERRUPT_CLEAR_0 0x00
173 #define THERMOK_ACFG_ALERT_MONITOR_TC 0x10
174 #define THERMOK_ACFG_ALERT_MONITOR_TH 0x00
175 #define THERMOK_ACFG_ALERT_LIMIT_RISING 0x08
176 #define THERMOK_ACFG_ALERT_LIMIT_FALLING 0x00
177 #define THERMOK_ACFG_ALERT_ACTIVE_HIGH 0x04
178 #define THERMOK_ACFG_ALERT_ACTIVE_LOW 0x00
179 #define THERMOK_ACFG_ALERT_MODE_INTERRUPT 0x02
180 #define THERMOK_ACFG_ALERT_MODE_COMPARATOR 0x00
181 #define THERMOK_ACFG_ALERT_OUT_ENABLED 0x01
182 #define THERMOK_ACFG_ALERT_OUT_DISABLED 0x00
183 
189 #define THERMOK_AHYS_HYSTERESIS_128C 0x80
190 #define THERMOK_AHYS_HYSTERESIS_64C 0x40
191 #define THERMOK_AHYS_HYSTERESIS_32C 0x20
192 #define THERMOK_AHYS_HYSTERESIS_16C 0x10
193 #define THERMOK_AHYS_HYSTERESIS_8C 0x08
194 #define THERMOK_AHYS_HYSTERESIS_4C 0x04
195 #define THERMOK_AHYS_HYSTERESIS_2C 0x02
196 #define THERMOK_AHYS_HYSTERESIS_1C 0x01
197 
203 #define THERMOK_ALIMIT_1024C 0x4000
204 #define THERMOK_ALIMIT_512C 0x2000
205 #define THERMOK_ALIMIT_255C 0x1000
206 #define THERMOK_ALIMIT_128C 0x0800
207 #define THERMOK_ALIMIT_64C 0x0400
208 #define THERMOK_ALIMIT_32C 0x0200
209 #define THERMOK_ALIMIT_16C 0x0100
210 #define THERMOK_ALIMIT_8C 0x0080
211 #define THERMOK_ALIMIT_4C 0x0040
212 #define THERMOK_ALIMIT_2C 0x0020
213 #define THERMOK_ALIMIT_1C 0x0010
214 #define THERMOK_ALIMIT_0p5C 0x0008
215 #define THERMOK_ALIMIT_0p25C 0x0004
216 #define THERMOK_ALIMIT_SIGN_1 0x8000
217 #define THERMOK_ALIMIT_SIGN_0 0x0000
218 
224 #define THERMOK_DEVICE_ID 0x40
225 #define THERMOK_DEVICE_REV 0x10
226 #define THERMOK_DEVICE_INFO 0x4010
227 
233 #define THERMOK_TEMP_IN_FAHRENHEIT 0x02
234 #define THERMOK_TEMP_IN_KELVIN 0x01
235 #define THERMOK_TEMP_IN_CELSIUS 0x00
236  // End group macro
239 // --------------------------------------------------------------- PUBLIC TYPES
248 typedef struct
249 {
250  // Input pins
251 
252  digital_in_t al4;
253  digital_in_t al3;
254  digital_in_t al2;
255  digital_in_t al1;
256 
257  // Modules
258 
259  i2c_master_t i2c;
260 
261  // ctx variable
262 
263  uint8_t slave_address;
264 
265 } thermok_t;
266 
270 typedef struct
271 {
272  // Communication gpio pins
273 
274  pin_name_t scl;
275  pin_name_t sda;
276 
277  // Additional gpio pins
278 
279  pin_name_t al4;
280  pin_name_t al3;
281  pin_name_t al2;
282  pin_name_t al1;
283 
284  // static variable
285 
286  uint32_t i2c_speed;
287  uint8_t i2c_address;
288 
289 } thermok_cfg_t;
290 
294 typedef struct
295 {
296  uint8_t burst_cmp;
297  uint8_t temp_h_update;
298  uint8_t over_volt;
299  uint8_t alert_4;
300  uint8_t alert_3;
301  uint8_t alert_2;
302  uint8_t alert_1;
303 
305  // End types group
307 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
308 
314 #ifdef __cplusplus
315 extern "C"{
316 #endif
317 
327 
337 
348 void thermok_generic_write ( thermok_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
349 
360 void thermok_generic_read ( thermok_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
361 
369 
377 
387 float thermok_get_temperature ( thermok_t *ctx, uint8_t reg, uint8_t temp_format );
388 
396 void thermok_set_register_cfg ( thermok_t *ctx, uint8_t reg_cfg, uint8_t cfg_data );
397 
405 
413 
421 
429 
430 #ifdef __cplusplus
431 }
432 #endif
433 #endif // _THERMOK_H_
434  // End public_function group
437 
438 // ------------------------------------------------------------------------- END
thermok_t::al3
digital_in_t al3
Definition: thermok.h:253
thermok_alert_t::over_volt
uint8_t over_volt
Definition: thermok.h:298
thermok_cfg_t::al4
pin_name_t al4
Definition: thermok.h:279
thermok_alert_t::alert_3
uint8_t alert_3
Definition: thermok.h:300
thermok_init
THERMOK_RETVAL thermok_init(thermok_t *ctx, thermok_cfg_t *cfg)
Initialization function.
thermok_alert_t::alert_2
uint8_t alert_2
Definition: thermok.h:301
thermok_set_register_cfg
void thermok_set_register_cfg(thermok_t *ctx, uint8_t reg_cfg, uint8_t cfg_data)
Set register config.
THERMOK_RETVAL
#define THERMOK_RETVAL
Definition: thermok.h:76
thermok_alert_t::temp_h_update
uint8_t temp_h_update
Definition: thermok.h:297
thermok_t
Click ctx object definition.
Definition: thermok.h:249
thermok_cfg_t::sda
pin_name_t sda
Definition: thermok.h:275
thermok_cfg_t::scl
pin_name_t scl
Definition: thermok.h:274
thermok_generic_write
void thermok_generic_write(thermok_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermok_alert_t::alert_1
uint8_t alert_1
Definition: thermok.h:302
thermok_alert_t::alert_4
uint8_t alert_4
Definition: thermok.h:299
thermok_t::al1
digital_in_t al1
Definition: thermok.h:255
thermok_cfg_t
Click configuration structure definition.
Definition: thermok.h:271
thermok_get_alert_state_4
uint8_t thermok_get_alert_state_4(thermok_t *ctx)
Alert 4 pin state.
thermok_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermok.h:287
thermok_t::al2
digital_in_t al2
Definition: thermok.h:254
thermok_cfg_setup
void thermok_cfg_setup(thermok_cfg_t *cfg)
Config Object Initialization function.
thermok_get_alert_state_3
uint8_t thermok_get_alert_state_3(thermok_t *ctx)
Alert 3 pin state.
thermok_generic_read
void thermok_generic_read(thermok_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
thermok_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermok.h:286
thermok_cfg_t::al1
pin_name_t al1
Definition: thermok.h:282
thermok_t::al4
digital_in_t al4
Definition: thermok.h:252
thermok_t::i2c
i2c_master_t i2c
Definition: thermok.h:259
thermok_get_temperature
float thermok_get_temperature(thermok_t *ctx, uint8_t reg, uint8_t temp_format)
Temperature data.
thermok_cfg_t::al2
pin_name_t al2
Definition: thermok.h:281
thermok_get_status
void thermok_get_status(thermok_t *ctx, thermok_alert_t *status)
Get status.
thermok_get_alert_state_2
uint8_t thermok_get_alert_state_2(thermok_t *ctx)
Alert 2 pin state.
thermok_cfg_t::al3
pin_name_t al3
Definition: thermok.h:280
thermok_get_alert_state_1
uint8_t thermok_get_alert_state_1(thermok_t *ctx)
Alert 1 pin state.
thermok_get_device_info
uint16_t thermok_get_device_info(thermok_t *ctx)
Functions for read device info.
thermok_t::slave_address
uint8_t slave_address
Definition: thermok.h:263
thermok_alert_t
Alert structure definition.
Definition: thermok.h:295
thermok_alert_t::burst_cmp
uint8_t burst_cmp
Definition: thermok.h:296