thermo18  2.0.0.0
thermo18.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef THERMO18_H
29 #define THERMO18_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_i2c_master.h"
38 
59 #define THERMO18_REG_DEVICE_ID 0x1
60 #define THERMO18_REG_T_H_LIMIT 0x2
61 #define THERMO18_REG_T_L_LIMIT 0x3
62 #define THERMO18_REG_CTRL 0x4
63 #define THERMO18_REG_STATUS 0x5
64 #define THERMO18_REG_DATA_T_L 0x6
65 #define THERMO18_REG_DATA_T_H 0x7
66 #define THERMO18_REG_SOFT_RESET 0xC
67  // thermo18_reg
69 
84 #define THERMO18_CONTROL_ONESHOT_ENABLED 0x01
85 #define THERMO18_CONTROL_CONTINOUS_ENABLED 0x04
86 
91 #define THERMO18_STATUS_DATA_READY 0x00
92 #define THERMO18_STATUS_DATA_BUSY 0x01
93 #define THERMO18_STATUS_OVERTEMPERATURE 0x02
94 #define THERMO18_STATUS_UNDERTEMPERATURE 0x04
95 
100 #define THERMO18_DEVICE_ID 0xA0
101 
107 #define THERMO18_SET_DEV_ADDR 0x3F
108  // thermo18_set
110 
125 #define THERMO18_MAP_MIKROBUS( cfg, mikrobus ) \
126  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
127  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
128  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
129  // thermo18_map // thermo18
132 
137 typedef struct
138 {
139  // Input pins
140  digital_in_t int_pin;
142  // Modules
143  i2c_master_t i2c;
145  // I2C slave address
146  uint8_t slave_address;
148 } thermo18_t;
149 
154 typedef struct
155 {
156  pin_name_t scl;
157  pin_name_t sda;
159  pin_name_t int_pin;
161  uint32_t i2c_speed;
162  uint8_t i2c_address;
165 
170 typedef enum
171 {
173  THERMO18_ERROR = -1
174 
176 
192 void thermo18_cfg_setup ( thermo18_cfg_t *cfg );
193 
207 err_t thermo18_init ( thermo18_t *ctx, thermo18_cfg_t *cfg );
208 
222 err_t thermo18_default_cfg ( thermo18_t *ctx );
223 
236 err_t thermo18_generic_write ( thermo18_t *ctx, uint8_t reg, uint8_t tx_data ) ;
237 
250 err_t thermo18_generic_read ( thermo18_t *ctx, uint8_t reg, uint8_t *rx_data );
251 
264 err_t thermo18_read_temperature ( thermo18_t *ctx, float *temperature );
265 
276 err_t thermo18_reset ( thermo18_t *ctx );
277 
285 uint8_t thermo18_get_interrupt ( thermo18_t *ctx );
286 
301 err_t thermo18_set_temperature_threshold ( thermo18_t *ctx, uint8_t threshold_reg, float threshold_limit );
302 
303 #ifdef __cplusplus
304 }
305 #endif
306 #endif // THERMO18_H
307  // thermo18
309 
310 // ------------------------------------------------------------------------ END
thermo18_generic_write
err_t thermo18_generic_write(thermo18_t *ctx, uint8_t reg, uint8_t tx_data)
Thermo 18 I2C writing function.
thermo18_default_cfg
err_t thermo18_default_cfg(thermo18_t *ctx)
Thermo 18 default configuration function.
THERMO18_ERROR
Definition: thermo18.h:172
thermo18_read_temperature
err_t thermo18_read_temperature(thermo18_t *ctx, float *temperature)
Reads and calculates temperature value.
thermo18_t
Thermo 18 Click context object.
Definition: thermo18.h:136
thermo18_get_interrupt
uint8_t thermo18_get_interrupt(thermo18_t *ctx)
Get interrput status.
thermo18_cfg_setup
void thermo18_cfg_setup(thermo18_cfg_t *cfg)
Thermo 18 configuration object setup function.
thermo18_cfg_t
Thermo 18 Click configuration object.
Definition: thermo18.h:153
THERMO18_OK
Definition: thermo18.h:171
thermo18_return_value_t
thermo18_return_value_t
Thermo 18 Click return value data.
Definition: thermo18.h:169
thermo18_generic_read
err_t thermo18_generic_read(thermo18_t *ctx, uint8_t reg, uint8_t *rx_data)
Thermo 18 I2C reading function.
thermo18_reset
err_t thermo18_reset(thermo18_t *ctx)
Resets device.
thermo18_set_temperature_threshold
err_t thermo18_set_temperature_threshold(thermo18_t *ctx, uint8_t threshold_reg, float threshold_limit)
Sets temperature threshold.
thermo18_init
err_t thermo18_init(thermo18_t *ctx, thermo18_cfg_t *cfg)
Thermo 18 initialization function.