thermo15  2.0.0.0
thermo15.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 THERMO15_H
36 #define THERMO15_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_in.h"
49 #include "drv_i2c_master.h"
50 
51 // -------------------------------------------------------------- PUBLIC MACROS
61 #define THERMO15_MAP_MIKROBUS( cfg, mikrobus ) \
62  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
63  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
64  cfg.alt = MIKROBUS( mikrobus, MIKROBUS_INT );
65 
71 #define THERMO15_RETVAL uint8_t
72 
73 #define THERMO15_OK 0x00
74 #define THERMO15_INIT_ERROR 0xFF
75 
81 #define THERMO15_DEVICE_SLAVE_ADDR_000 0x48
82 #define THERMO15_DEVICE_SLAVE_ADDR_001 0x49
83 #define THERMO15_DEVICE_SLAVE_ADDR_010 0x4A
84 #define THERMO15_DEVICE_SLAVE_ADDR_011 0x4B
85 #define THERMO15_DEVICE_SLAVE_ADDR_100 0x4C
86 #define THERMO15_DEVICE_SLAVE_ADDR_101 0x4D
87 #define THERMO15_DEVICE_SLAVE_ADDR_110 0x4E
88 #define THERMO15_DEVICE_SLAVE_ADDR_111 0x4F
89 
95 #define THERMO15_REG_STORED_TEMPERATURE 0x00
96 #define THERMO15_REG_CONFIGURATION 0x01
97 #define THERMO15_REG_TEMPERATURE_HYSTERESIS 0x02
98 #define THERMO15_REG_TEMPERATURE_LIMIT 0x03
99 #define THERMO15_REG_ONE_SHOT 0x04
100 
106 #define THERMO15_DEF_TEMP_HYSTERESIS 75
107 #define THERMO15_DEF_TEMP_LIMIT 80
108 #define THERMO15_REG_ONE_SHOT 0x04
109 
115 #define THERMO15_CFG_WMODE_NORMAL 0x00
116 #define THERMO15_CFG_WMODE_ONE_SHOT 0x20
117 #define THERMO15_CFG_WMODE_SHUTDOWN 0x01
118 #define THERMO15_CFG_FAULT_QUEUE_1 0x00
119 #define THERMO15_CFG_FAULT_QUEUE_2 0x08
120 #define THERMO15_CFG_FAULT_QUEUE_4 0x10
121 #define THERMO15_CFG_FAULT_QUEUE_6 0x18
122 #define THERMO15_CFG_ALERT_ACTIVE_LOW 0x00
123 #define THERMO15_CFG_ALERT_ACTIVE_HIGH 0x04
124 #define THERMO15_CFG_TMODE_COMPARATOR 0x00
125 #define THERMO15_CFG_TMODE_INTERRUPT 0x02
126 
132 #define THERMO15_TEMP_IN_CELSIUS 0x00
133 #define THERMO15_TEMP_IN_KELVIN 0x01
134 #define THERMO15_TEMP_IN_FAHRENHEIT 0x02
135  // End group macro
138 // --------------------------------------------------------------- PUBLIC TYPES
147 typedef struct
148 {
149  digital_in_t alt;
150 
151  // Modules
152 
153  i2c_master_t i2c;
154 
155  // ctx variable
156 
157  uint8_t slave_address;
158 
159 } thermo15_t;
160 
164 typedef struct
165 {
166  // Communication gpio pins
167 
168  pin_name_t scl;
169  pin_name_t sda;
170 
171  // Additional gpio pins
172 
173  pin_name_t alt;
174 
175  // static variable
176 
177  uint32_t i2c_speed;
178  uint8_t i2c_address;
179 
181  // End types group
183 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
184 
190 #ifdef __cplusplus
191 extern "C"{
192 #endif
193 
203 
212 
221 
232 void thermo15_generic_write ( thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
233 
244 void thermo15_generic_read ( thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len );
245 
253 float thermo15_get_temperature_data ( thermo15_t *ctx, uint8_t temp_format );
254 
267 void thermo15_set_temp_register ( thermo15_t *ctx, uint8_t temp_reg, float temp_data );
268 
281 float thermo15_get_temp_register ( thermo15_t *ctx, uint8_t temp_reg );
282 
289 
290 #ifdef __cplusplus
291 }
292 #endif
293 #endif // _THERMO15_H_
294  // End public_function group
297 
298 // ------------------------------------------------------------------------- END
thermo15_cfg_t::sda
pin_name_t sda
Definition: thermo15.h:169
thermo15_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo15.h:177
thermo15_t
Click ctx object definition.
Definition: thermo15.h:148
thermo15_cfg_t::scl
pin_name_t scl
Definition: thermo15.h:168
thermo15_cfg_t::alt
pin_name_t alt
Definition: thermo15.h:173
thermo15_get_interrupt_state
uint8_t thermo15_get_interrupt_state(thermo15_t *ctx)
Interrupt state.
thermo15_get_temperature_data
float thermo15_get_temperature_data(thermo15_t *ctx, uint8_t temp_format)
Ambient temperature data.
thermo15_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo15.h:178
thermo15_init
THERMO15_RETVAL thermo15_init(thermo15_t *ctx, thermo15_cfg_t *cfg)
Initialization function.
thermo15_cfg_t
Click configuration structure definition.
Definition: thermo15.h:165
thermo15_get_temp_register
float thermo15_get_temp_register(thermo15_t *ctx, uint8_t temp_reg)
Get temperature register.
thermo15_t::slave_address
uint8_t slave_address
Definition: thermo15.h:157
thermo15_generic_read
void thermo15_generic_read(thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic read function.
THERMO15_RETVAL
#define THERMO15_RETVAL
Definition: thermo15.h:71
thermo15_cfg_setup
void thermo15_cfg_setup(thermo15_cfg_t *cfg)
Config Object Initialization function.
thermo15_set_temp_register
void thermo15_set_temp_register(thermo15_t *ctx, uint8_t temp_reg, float temp_data)
Set temperature register.
thermo15_t::alt
digital_in_t alt
Definition: thermo15.h:149
thermo15_t::i2c
i2c_master_t i2c
Definition: thermo15.h:153
thermo15_generic_write
void thermo15_generic_write(thermo15_t *ctx, uint8_t reg, uint8_t *data_buffer, uint8_t len)
Generic write function.
thermo15_default_cfg
void thermo15_default_cfg(thermo15_t *ctx)
Click Default Configuration function.