thermo6  2.0.0.0
thermo6.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 THERMO6_H
36 #define THERMO6_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 THERMO6_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
75 #define THERMO6_RETVAL uint8_t
76 
77 #define THERMO6_OK 0x00
78 #define THERMO6_INIT_ERROR 0xFF
79 
85 #define THERMO6_SLAVE_ADDRESS 0x48
86 
92 #define THERMO6_REG_TEMPERATURE 0x00
93 #define THERMO6_REG_CONFIG 0x01
94 #define THERMO6_REG_TEMP_HYST 0x02
95 #define THERMO6_REG_TEMP_OS 0x03
96 
102 #define THERMO6_CFG_ONE_SHOT 0x0001
103 
104 #define THERMO6_CFG_CONVERSION_RATE_0_25 0x0000
105 #define THERMO6_CFG_CONVERSION_RATE_1 0x0002
106 #define THERMO6_CFG_CONVERSION_RATE_4 0x0004
107 #define THERMO6_CFG_CONVERSION_RATE_8 0x0006
108 
109 #define THERMO6_CFG_PEC_ENABLE 0x0008
110 #define THERMO6_CFG_PEC_DISABLE 0x0000
111 
112 #define THERMO6_CFG_TIMEOUT_ENABLE 0x0010
113 #define THERMO6_CFG_TIMEOUT_DISABLE 0x0000
114 
115 #define THERMO6_CFG_RESOLUTION_8 0x0000
116 #define THERMO6_CFG_RESOLUTION_9 0x0020
117 #define THERMO6_CFG_RESOLUTION_10 0x0040
118 #define THERMO6_CFG_RESOLUTION_12 0x0060
119 
120 #define THERMO6_CFG_NORMAL_FORMAT 0x0000
121 #define THERMO6_CFG_EXTENDED_FORMAT 0x0080
122 
123 #define THERMO6_CFG_SHUT_DOWN 0x0100
124 #define THERMO6_CFG_POWER_UP 0x0000
125 
126 #define THERMO6_CFG_COMPARATOR_MODE 0x0000
127 #define THERMO6_CFG_INTERRUPT_MODE 0x0200
128 
129 #define THERMO6_CFG_FAULT_QUEUE_1 0x0000
130 #define THERMO6_CFG_FAULT_QUEUE_2 0x0800
131 #define THERMO6_CFG_FAULT_QUEUE_4 0x1000
132 #define THERMO6_CFG_FAULT_QUEUE_6 0x1800
133 
139 #define THERMO6_TEMP_FORMAT_CELSIUS 0
140 #define THERMO6_TEMP_FORMAT_FAHRENHEIT 2
141 #define THERMO6_TEMP_FORMAT_KELVIN 1
142 
148 #define THERMO6_TEMP_RESOLUTION_12bit 3
149 #define THERMO6_TEMP_RESOLUTION_10bit 2
150 #define THERMO6_TEMP_RESOLUTION_9bit 1
151 #define THERMO6_TEMP_RESOLUTION_8bit 0
152  // End group macro
155 // --------------------------------------------------------------- PUBLIC TYPES
164 typedef struct
165 {
166  // Modules
167 
168  i2c_master_t i2c;
169 
170  // ctx variable
171 
172  uint8_t slave_address;
174 
175 } thermo6_t;
176 
180 typedef struct
181 {
182  // Communication gpio pins
183 
184  pin_name_t scl;
185  pin_name_t sda;
186 
187  // static variable
188 
189  uint32_t i2c_speed;
190  uint8_t i2c_address;
191 
192 } thermo6_cfg_t;
193  // End types group
195 
196 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
197 
203 #ifdef __cplusplus
204 extern "C"{
205 #endif
206 
216 
226 
248 
259 void thermo6_generic_write ( thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
260 
272 void thermo6_generic_read ( thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
273 
283 float thermo6_get_temperature_data ( thermo6_t *ctx, uint8_t temp_format );
284 
294 void thermo6_set_other_register ( thermo6_t *ctx, uint8_t reg, float tx_data );
295 
305 float thermo6_get_other_register( thermo6_t *ctx, uint8_t reg );
306 
319 
329 void thermo6_set_register_cfg ( thermo6_t *ctx, uint16_t cfg_data );
330 
331 #ifdef __cplusplus
332 }
333 #endif
334 #endif // _THERMO6_H_
335  // End public_function group
338 
339 // ------------------------------------------------------------------------- END
THERMO6_RETVAL
#define THERMO6_RETVAL
Definition: thermo6.h:75
thermo6_get_temperature_data
float thermo6_get_temperature_data(thermo6_t *ctx, uint8_t temp_format)
Temperature function.
thermo6_init
THERMO6_RETVAL thermo6_init(thermo6_t *ctx, thermo6_cfg_t *cfg)
Initialization function.
thermo6_set_register_cfg
void thermo6_set_register_cfg(thermo6_t *ctx, uint16_t cfg_data)
Write configuration function.
thermo6_set_other_register
void thermo6_set_other_register(thermo6_t *ctx, uint8_t reg, float tx_data)
Set other register.
thermo6_cfg_t
Click configuration structure definition.
Definition: thermo6.h:181
thermo6_default_cfg
void thermo6_default_cfg(thermo6_t *ctx)
Click Default Configuration function.
thermo6_t
Click ctx object definition.
Definition: thermo6.h:165
thermo6_t::i2c
i2c_master_t i2c
Definition: thermo6.h:168
thermo6_t::slave_address
uint8_t slave_address
Definition: thermo6.h:172
thermo6_cfg_t::sda
pin_name_t sda
Definition: thermo6.h:185
thermo6_t::temp_resolution
uint8_t temp_resolution
Definition: thermo6.h:173
thermo6_generic_write
void thermo6_generic_write(thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermo6_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo6.h:189
thermo6_get_over_temp_status
uint8_t thermo6_get_over_temp_status(thermo6_t *ctx)
Read over-temperature status function.
thermo6_cfg_setup
void thermo6_cfg_setup(thermo6_cfg_t *cfg)
Config Object Initialization function.
thermo6_get_other_register
float thermo6_get_other_register(thermo6_t *ctx, uint8_t reg)
Set other register.
thermo6_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo6.h:190
thermo6_cfg_t::scl
pin_name_t scl
Definition: thermo6.h:184
thermo6_generic_read
void thermo6_generic_read(thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.