thermo11  2.0.0.0
thermo11.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 THERMO11_H
36 #define THERMO11_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 
57 // -------------------------------------------------------------- PUBLIC MACROS
67 #define THERMO11_MAP_MIKROBUS( cfg, mikrobus ) \
68  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
69  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
70  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT );
71 
77 #define THERMO11_RETVAL uint8_t
78 
79 #define THERMO11_OK 0x00
80 #define THERMO11_INIT_ERROR 0xFF
81 
87 #define THERMO11_DEV_ADDR 0x48
88 
94 #define THERMO11_TEMPERATURE_REG 0x00
95 #define THERMO11_CONFIG_REG 0x01
96 #define THERMO11_HIGH_LIMIT_REG 0x02
97 #define THERMO11_LOW_LIMIT_REG 0x03
98 #define THERMO11_EEPROM_UNLOCK_REG 0x04
99 #define THERMO11_EEPROM1_REG 0x05
100 #define THERMO11_EEPROM2_REG 0x06
101 #define THERMO11_TEMP_OFFSET_REG 0x07
102 #define THERMO11_EEPROM3_REG 0x08
103 #define THERMO11_DEV_ID_REG 0x0F
104 
110 #define THERMO11_CONTINUOUS_CONV_MODE 0x0000
111 #define THERMO11_SHUTDOWN_MODE 0x0400
112 #define THERMO11_ONESHOT_CONV_MODE 0x0C00
113 #define THERMO11_CONV_TIME_0 0x0000
114 #define THERMO11_CONV_TIME_1 0x0080
115 #define THERMO11_CONV_TIME_2 0x0100
116 #define THERMO11_CONV_TIME_3 0x0180
117 #define THERMO11_CONV_TIME_4 0x0200
118 #define THERMO11_CONV_TIME_5 0x0280
119 #define THERMO11_CONV_TIME_6 0x0300
120 #define THERMO11_CONV_TIME_7 0x0380
121 #define THERMO11_NO_AVRG 0x0000
122 #define THERMO11_8_AVRG_CONV 0x0020
123 #define THERMO11_32_AVRG_CONV 0x0040
124 #define THERMO11_64_AVRG_CONV 0x0060
125 #define THERMO11_THERM_MODE 0x0010
126 #define THERMO11_ALERT_MODE 0x0000
127 #define THERMO11_INT_PIN_ACT_HIGH 0x0008
128 #define THERMO11_INT_PIN_ACT_LOW 0x0000
129 #define THERMO11_INT_PIN_DRDY_FLAG 0x0004
130 #define THERMO11_INT_PIN_ALERT_FLAGS 0x0000
131 #define THERMO11_SW_RESET_CMD 0x0002
132 
138 #define THERMO11_EEPROM_LOCK 0x0000
139 #define THERMO11_EEPROM_UNLOCK 0x8000
140 #define THERMO11_EEPROM_BUSY_FLAG 0x4000
141 
147 #define THERMO11_DEV_ID_MASK 0x0FFF
148 #define THERMO11_REVISION_MASK 0xF000
149 
155 #define THERMO11_DRDY_FLAG 0x01
156 #define THERMO11_LOW_ALERT_FLAG 0x02
157 #define THERMO11_HIGH_ALERT_FLAG 0x04
158 #define THERMO11_FLAG_IS_CLEARED 0x00
159 
165 #define THERMO11_INVALID_TEMP_RANGE 0x02
166 #define THERMO11_INVALID_ADDR 0x01
167 #define THERMO11_OK 0x00
168  // End group macro
171 // --------------------------------------------------------------- PUBLIC TYPES
180 typedef struct
181 {
182 
183  // Input pins
184  digital_in_t int_pin;
185 
186  // Modules
187 
188  i2c_master_t i2c;
189 
190  // ctx variable
191 
192  uint8_t slave_address;
193 
194 } thermo11_t;
195 
199 typedef struct
200 {
201  // Communication gpio pins
202 
203  pin_name_t scl;
204  pin_name_t sda;
205 
206  // Additional gpio pins
207 
208  pin_name_t int_pin;
209 
210  // static variable
211 
212  uint32_t i2c_speed;
213  uint8_t i2c_address;
214 
216  // End types group
218 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
219 
225 #ifdef __cplusplus
226 extern "C"{
227 #endif
228 
238 
248 
271 
282 void thermo11_generic_write ( thermo11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
283 
295 void thermo11_generic_read ( thermo11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
296 
306 THERMO11_RETVAL thermo11_write_reg ( thermo11_t *ctx, uint8_t reg_addr, uint16_t data_in );
307 
317 THERMO11_RETVAL thermo11_read_reg ( thermo11_t *ctx, uint8_t reg_addr, uint16_t *data_out );
318 
329 float thermo11_get_temp ( thermo11_t *ctx, uint8_t temp_addr );
330 
340 
351 
360 
368 
379 
394 THERMO11_RETVAL thermo11_program_eeprom ( thermo11_t *ctx, uint8_t eeprom_addr, uint16_t eeprom_data );
395 
407 THERMO11_RETVAL thermo11_set_temp ( thermo11_t *ctx, uint8_t temp_addr, float temp_value );
408 
409 #ifdef __cplusplus
410 }
411 #endif
412 #endif // _THERMO11_H_
413  // End public_function group
416 
417 // ------------------------------------------------------------------------- END
thermo11_write_reg
THERMO11_RETVAL thermo11_write_reg(thermo11_t *ctx, uint8_t reg_addr, uint16_t data_in)
Repeated Write function.
thermo11_generic_write
void thermo11_generic_write(thermo11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermo11_generic_read
void thermo11_generic_read(thermo11_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
thermo11_t::i2c
i2c_master_t i2c
Definition: thermo11.h:188
thermo11_default_cfg
void thermo11_default_cfg(thermo11_t *ctx)
Click Default Configuration function.
thermo11_program_eeprom
THERMO11_RETVAL thermo11_program_eeprom(thermo11_t *ctx, uint8_t eeprom_addr, uint16_t eeprom_data)
EEPROM Program function.
thermo11_sw_reset
void thermo11_sw_reset(thermo11_t *ctx)
Software Reset Command.
THERMO11_RETVAL
#define THERMO11_RETVAL
Definition: thermo11.h:77
thermo11_read_reg
THERMO11_RETVAL thermo11_read_reg(thermo11_t *ctx, uint8_t reg_addr, uint16_t *data_out)
Repeated Read function.
thermo11_get_temp
float thermo11_get_temp(thermo11_t *ctx, uint8_t temp_addr)
Temperature Get function.
thermo11_t::slave_address
uint8_t slave_address
Definition: thermo11.h:192
thermo11_general_call_reset_cmd
void thermo11_general_call_reset_cmd(thermo11_t *ctx)
General Call Reset Command.
thermo11_cfg_t
Click configuration structure definition.
Definition: thermo11.h:200
thermo11_t
Click ctx object definition.
Definition: thermo11.h:181
thermo11_cfg_t::sda
pin_name_t sda
Definition: thermo11.h:204
thermo11_cfg_setup
void thermo11_cfg_setup(thermo11_cfg_t *cfg)
Config Object Initialization function.
thermo11_cfg_t::int_pin
pin_name_t int_pin
Definition: thermo11.h:208
thermo11_t::int_pin
digital_in_t int_pin
Definition: thermo11.h:184
thermo11_check_status
THERMO11_RETVAL thermo11_check_status(thermo11_t *ctx)
Status Check function.
thermo11_cfg_t::scl
pin_name_t scl
Definition: thermo11.h:203
thermo11_set_temp
THERMO11_RETVAL thermo11_set_temp(thermo11_t *ctx, uint8_t temp_addr, float temp_value)
Temperature Set function.
thermo11_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo11.h:212
thermo11_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo11.h:213
thermo11_init
THERMO11_RETVAL thermo11_init(thermo11_t *ctx, thermo11_cfg_t *cfg)
Initialization function.
thermo11_get_int
THERMO11_RETVAL thermo11_get_int(thermo11_t *ctx)
INT Pin Check function.
thermo11_sm_bus_alert_cmd
uint8_t thermo11_sm_bus_alert_cmd(thermo11_t *ctx)
SMBus Alert Command.