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 
38 #include "drv_digital_out.h"
39 #include "drv_digital_in.h"
40 #include "drv_i2c_master.h"
41 
42 // -------------------------------------------------------------- PUBLIC MACROS
52 #define THERMO6_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
55 
61 #define THERMO6_RETVAL uint8_t
62 
63 #define THERMO6_OK 0x00
64 #define THERMO6_INIT_ERROR 0xFF
65 
71 #define THERMO6_SLAVE_ADDRESS 0x48
72 
78 #define THERMO6_REG_TEMPERATURE 0x00
79 #define THERMO6_REG_CONFIG 0x01
80 #define THERMO6_REG_TEMP_HYST 0x02
81 #define THERMO6_REG_TEMP_OS 0x03
82 
88 #define THERMO6_CFG_ONE_SHOT 0x0001
89 
90 #define THERMO6_CFG_CONVERSION_RATE_0_25 0x0000
91 #define THERMO6_CFG_CONVERSION_RATE_1 0x0002
92 #define THERMO6_CFG_CONVERSION_RATE_4 0x0004
93 #define THERMO6_CFG_CONVERSION_RATE_8 0x0006
94 
95 #define THERMO6_CFG_PEC_ENABLE 0x0008
96 #define THERMO6_CFG_PEC_DISABLE 0x0000
97 
98 #define THERMO6_CFG_TIMEOUT_ENABLE 0x0010
99 #define THERMO6_CFG_TIMEOUT_DISABLE 0x0000
100 
101 #define THERMO6_CFG_RESOLUTION_8 0x0000
102 #define THERMO6_CFG_RESOLUTION_9 0x0020
103 #define THERMO6_CFG_RESOLUTION_10 0x0040
104 #define THERMO6_CFG_RESOLUTION_12 0x0060
105 
106 #define THERMO6_CFG_NORMAL_FORMAT 0x0000
107 #define THERMO6_CFG_EXTENDED_FORMAT 0x0080
108 
109 #define THERMO6_CFG_SHUT_DOWN 0x0100
110 #define THERMO6_CFG_POWER_UP 0x0000
111 
112 #define THERMO6_CFG_COMPARATOR_MODE 0x0000
113 #define THERMO6_CFG_INTERRUPT_MODE 0x0200
114 
115 #define THERMO6_CFG_FAULT_QUEUE_1 0x0000
116 #define THERMO6_CFG_FAULT_QUEUE_2 0x0800
117 #define THERMO6_CFG_FAULT_QUEUE_4 0x1000
118 #define THERMO6_CFG_FAULT_QUEUE_6 0x1800
119 
125 #define THERMO6_TEMP_FORMAT_CELSIUS 0
126 #define THERMO6_TEMP_FORMAT_FAHRENHEIT 2
127 #define THERMO6_TEMP_FORMAT_KELVIN 1
128 
134 #define THERMO6_TEMP_RESOLUTION_12bit 3
135 #define THERMO6_TEMP_RESOLUTION_10bit 2
136 #define THERMO6_TEMP_RESOLUTION_9bit 1
137 #define THERMO6_TEMP_RESOLUTION_8bit 0
138  // End group macro
141 // --------------------------------------------------------------- PUBLIC TYPES
150 typedef struct
151 {
152  // Modules
153 
154  i2c_master_t i2c;
155 
156  // ctx variable
157 
158  uint8_t slave_address;
160 
161 } thermo6_t;
162 
166 typedef struct
167 {
168  // Communication gpio pins
169 
170  pin_name_t scl;
171  pin_name_t sda;
172 
173  // static variable
174 
175  uint32_t i2c_speed;
176  uint8_t i2c_address;
177 
178 } thermo6_cfg_t;
179  // End types group
181 
182 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
183 
189 #ifdef __cplusplus
190 extern "C"{
191 #endif
192 
201 void thermo6_cfg_setup ( thermo6_cfg_t *cfg );
202 
212 
233 void thermo6_default_cfg ( thermo6_t *ctx );
234 
245 void thermo6_generic_write ( thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
246 
258 void thermo6_generic_read ( thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
259 
269 float thermo6_get_temperature_data ( thermo6_t *ctx, uint8_t temp_format );
270 
280 void thermo6_set_other_register ( thermo6_t *ctx, uint8_t reg, float tx_data );
281 
291 float thermo6_get_other_register( thermo6_t *ctx, uint8_t reg );
292 
305 
315 void thermo6_set_register_cfg ( thermo6_t *ctx, uint16_t cfg_data );
316 
317 #ifdef __cplusplus
318 }
319 #endif
320 #endif // _THERMO6_H_
321  // End public_function group
324 
325 // ------------------------------------------------------------------------- END
THERMO6_RETVAL
#define THERMO6_RETVAL
Definition: thermo6.h:61
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:166
thermo6_default_cfg
void thermo6_default_cfg(thermo6_t *ctx)
Click Default Configuration function.
thermo6_t
Click ctx object definition.
Definition: thermo6.h:150
thermo6_t::i2c
i2c_master_t i2c
Definition: thermo6.h:154
thermo6_t::slave_address
uint8_t slave_address
Definition: thermo6.h:158
thermo6_cfg_t::sda
pin_name_t sda
Definition: thermo6.h:171
thermo6_t::temp_resolution
uint8_t temp_resolution
Definition: thermo6.h:159
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:175
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:176
thermo6_cfg_t::scl
pin_name_t scl
Definition: thermo6.h:170
thermo6_generic_read
void thermo6_generic_read(thermo6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.