thermo8  2.0.0.0
thermo8.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 THERMO8_H
36 #define THERMO8_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 THERMO8_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.ale = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define THERMO8_RETVAL uint8_t
77 
78 #define THERMO8_OK 0x00
79 #define THERMO8_INIT_ERROR 0xFF
80 
86 #define THERMO8_ADDR0 0x18
87 #define THERMO8_ADDR1 (0x18 | 0x01)
88 #define THERMO8_ADDR2 (0x18 | 0x02)
89 #define THERMO8_ADDR3 (0x18 | 0x03)
90 #define THERMO8_ADDR4 (0x18 | 0x04)
91 #define THERMO8_ADDR5 (0x18 | 0x05)
92 #define THERMO8_ADDR6 (0x18 | 0x06)
93 #define THERMO8_ADDR7 (0x18 | 0x07)
94 
100 #define THERMO8_CONFIG 0x01
101 #define THERMO8_TUPPER 0x02
102 #define THERMO8_TLOWER 0x03
103 #define THERMO8_TCRIT 0x04
104 #define THERMO8_TUPPER_REACHED 0x03
105 #define THERMO8_TLOWER_REACHED 0x0C
106 #define THERMO8_TCRIT_REACHED 0x30
107 #define THERMO8_TCRIT_ONLY_ALERT 1
108 #define THERMO8_ALERT_ON_ALL 0
109 #define THERMO8_THYS_0C 0x00
110 #define THERMO8_THYS_1C5 0x01
111 #define THERMO8_THYS_3C 0x02
112 #define THERMO8_THYS_6C 0x03
113 
119 #define THERMO8_TA 0x05
120 #define THERMO8_MANID 0x06
121 #define THERMO8_DEVID 0x07
122 
128 #define THERMO8_RESOLUTION_REG 0x08
129 #define THERMO8_R05C_30MS 0x00
130 #define THERMO8_R025C_65MS 0x01
131 #define THERMO8_R0125C_130MS 0x02
132 #define THERMO8_R00625C_250MS 0x03
133  // End group macro
136 // --------------------------------------------------------------- PUBLIC TYPES
145 typedef struct
146 {
147  // Input pins
148 
149  digital_in_t ale;
150 
151  // Modules
152 
153  i2c_master_t i2c;
154 
155  // ctx variable
156 
157  uint8_t slave_address;
158  uint16_t limit_status;
159 
160 } thermo8_t;
161 
165 typedef struct
166 {
167  // Communication gpio pins
168 
169  pin_name_t scl;
170  pin_name_t sda;
171 
172  // Additional gpio pins
173 
174  pin_name_t ale;
175 
176  // static variable
177 
178  uint32_t i2c_speed;
179  uint8_t i2c_address;
180 
181 } thermo8_cfg_t;
182  // End types group
184 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
185 
191 #ifdef __cplusplus
192 extern "C"{
193 #endif
194 
204 
214 
223 
234 void thermo8_generic_write ( thermo8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
235 
246 void thermo8_generic_read ( thermo8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
247 
255 uint8_t thermo8_ale_get ( thermo8_t *ctx );
256 
266 void thermo8_write_reg ( thermo8_t *ctx, uint8_t r_addr, uint16_t r_data );
267 
276 uint16_t thermo8_read_reg ( thermo8_t *ctx, uint8_t r_addr );
277 
287 void thermo8_write_reg_8 ( thermo8_t *ctx, uint8_t r_addr, uint8_t r_data);
288 
297 uint8_t thermo8_read_reg_8 ( thermo8_t *ctx, uint8_t r_addr );
298 
307 
316 void thermo8_set_resolution ( thermo8_t *ctx, uint8_t r_cfg );
317 
325 uint16_t thermo8_get_dev_id ( thermo8_t *ctx );
326 
334 uint16_t thermo8_get_man_id ( thermo8_t *ctx );
335 
344 void thermo8_sleep ( thermo8_t *ctx );
345 
354 
364 void thermo8_limit_set ( thermo8_t *ctx, uint8_t limit_reg_addr, float limit );
365 
374 
384 void thermo8_alert_enable ( thermo8_t *ctx, uint8_t thys, uint8_t alert_cfg );
385 
395 
404 
414 
423 
424 #ifdef __cplusplus
425 }
426 #endif
427 #endif // _THERMO8_H_
428  // End public_function group
431 
432 // ------------------------------------------------------------------------- END
thermo8_tcrit_unlock
void thermo8_tcrit_unlock(thermo8_t *ctx)
Function for unlocking the critical temperature setting register.
thermo8_get_temperature
float thermo8_get_temperature(thermo8_t *ctx)
Function will return the temperature value in �C.
thermo8_t::ale
digital_in_t ale
Definition: thermo8.h:149
thermo8_generic_write
void thermo8_generic_write(thermo8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermo8_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo8.h:178
THERMO8_RETVAL
#define THERMO8_RETVAL
Definition: thermo8.h:76
thermo8_cfg_t::sda
pin_name_t sda
Definition: thermo8.h:170
thermo8_read_reg
uint16_t thermo8_read_reg(thermo8_t *ctx, uint8_t r_addr)
Function for reading from 16 bit registers.
thermo8_write_reg
void thermo8_write_reg(thermo8_t *ctx, uint8_t r_addr, uint16_t r_data)
Function for writing to 16 bit registers.
thermo8_limit_set
void thermo8_limit_set(thermo8_t *ctx, uint8_t limit_reg_addr, float limit)
Function for setting the temperature alarm levels for the lower, upper and critical alert levels.
thermo8_cfg_t::scl
pin_name_t scl
Definition: thermo8.h:169
thermo8_cfg_t
Click configuration structure definition.
Definition: thermo8.h:166
thermo8_generic_read
void thermo8_generic_read(thermo8_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
thermo8_get_man_id
uint16_t thermo8_get_man_id(thermo8_t *ctx)
Function will return the manufacturer ID.
thermo8_cfg_setup
void thermo8_cfg_setup(thermo8_cfg_t *cfg)
Config Object Initialization function.
thermo8_get_alert_stat
uint8_t thermo8_get_alert_stat(thermo8_t *ctx)
Function will return all alert states.
thermo8_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo8.h:179
thermo8_tcrit_lock
void thermo8_tcrit_lock(thermo8_t *ctx)
Function for locking the critical temperature setting register.
thermo8_set_resolution
void thermo8_set_resolution(thermo8_t *ctx, uint8_t r_cfg)
Function will set the conversion resoult temperature step depending on the passed constant.
thermo8_t
Click ctx object definition.
Definition: thermo8.h:146
thermo8_get_dev_id
uint16_t thermo8_get_dev_id(thermo8_t *ctx)
Function will return the device ID.
thermo8_win_lock
void thermo8_win_lock(thermo8_t *ctx)
Function for locking the Tupper and Tlower registers.
thermo8_read_reg_8
uint8_t thermo8_read_reg_8(thermo8_t *ctx, uint8_t r_addr)
Function for single byte read's.
thermo8_ale_get
uint8_t thermo8_ale_get(thermo8_t *ctx)
Function for returning the state of the alert pin.
thermo8_t::i2c
i2c_master_t i2c
Definition: thermo8.h:153
thermo8_default_cfg
void thermo8_default_cfg(thermo8_t *ctx)
Click Default Configuration function.
thermo8_win_unlock
void thermo8_win_unlock(thermo8_t *ctx)
Function for unlocking the Tupper and Tlower registers.
thermo8_t::slave_address
uint8_t slave_address
Definition: thermo8.h:157
thermo8_init
THERMO8_RETVAL thermo8_init(thermo8_t *ctx, thermo8_cfg_t *cfg)
Initialization function.
thermo8_alert_enable
void thermo8_alert_enable(thermo8_t *ctx, uint8_t thys, uint8_t alert_cfg)
Function for setting the Tupper and Tlower hysterezis level as well as the alert mode.
thermo8_write_reg_8
void thermo8_write_reg_8(thermo8_t *ctx, uint8_t r_addr, uint8_t r_data)
Function for single byte writes.
thermo8_sleep
void thermo8_sleep(thermo8_t *ctx)
Function will place Thermo 8 to the low power mode.
thermo8_wake_up
void thermo8_wake_up(thermo8_t *ctx)
Function for waking up the Click board from the sleep mode.
thermo8_cfg_t::ale
pin_name_t ale
Definition: thermo8.h:174
thermo8_t::limit_status
uint16_t limit_status
Definition: thermo8.h:158