thermo7  2.0.0.0
thermo7.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 THERMO7_H
36 #define THERMO7_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 THERMO7_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
69  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
70 
76 #define THERMO7_RETVAL uint8_t
77 
78 #define THERMO7_OK 0x00
79 #define THERMO7_INIT_ERROR 0xFF
80 
86 #define THERMO7_REG_AMBIENT_TEMPERATURE 0x00
87 #define THERMO7_REG_CONFIGURATION 0x01
88 #define THERMO7_REG_HYSTERESIS_TEMPERATURE 0x02
89 #define THERMO7_REG_TEMPERATURE_LIMIT_SET 0x03
90 
96 #define THERMO7_CONFIG_ONE_SHOT_ENABLE (0x01 << 7)
97 #define THERMO7_CONFIG_ONE_SHOT_DISABLE (0x00 << 7)
98 #define THERMO7_CONFIG_ADC_RESOLUTION_9bit (0x00 << 5)
99 #define THERMO7_CONFIG_ADC_RESOLUTION_10bit (0x01 << 5)
100 #define THERMO7_CONFIG_ADC_RESOLUTION_11bit (0x02 << 5)
101 #define THERMO7_CONFIG_ADC_RESOLUTION_12bit (0x03 << 5)
102 #define THERMO7_CONFIG_FAULT_QUEUE_MODE_1 (0x00 << 3)
103 #define THERMO7_CONFIG_FAULT_QUEUE_MODE_2 (0x01 << 3)
104 #define THERMO7_CONFIG_FAULT_QUEUE_MODE_4 (0x02 << 3)
105 #define THERMO7_CONFIG_FAULT_QUEUE_MODE_6 (0x03 << 3)
106 #define THERMO7_CONFIG_ALERT_POLARITY_ACTIVE_HIGH (0x01 << 2)
107 #define THERMO7_CONFIG_ALERT_POLARITY_ACTIVE_LOW (0x00 << 2)
108 #define THERMO7_CONFIG_COMPARATOR_MODE (0x00 << 1)
109 #define THERMO7_CONFIG_INTERRUPT_MODE (0x01 << 1)
110 #define THERMO7_CONFIG_SHUTDOWN_ENABLE 0x01
111 #define THERMO7_CONFIG_SHUTDOWN_DISABLE 0x00
112  // End group macro
115 // --------------------------------------------------------------- PUBLIC TYPES
124 typedef struct
125 {
126  // Input pins
127 
128  digital_in_t int_pin;
129 
130  // Modules
131 
132  i2c_master_t i2c;
133 
134  // ctx variable
135 
136  uint8_t slave_address;
137 
138 } thermo7_t;
139 
143 typedef struct
144 {
145  // Communication gpio pins
146 
147  pin_name_t scl;
148  pin_name_t sda;
149 
150  // Additional gpio pins
151 
152  pin_name_t int_pin;
153 
154  // static variable
155 
156  uint32_t i2c_speed;
157  uint8_t i2c_address;
158 
159 } thermo7_cfg_t;
160  // End types group
162 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
163 
169 #ifdef __cplusplus
170 extern "C"{
171 #endif
172 
182 
191 
202 void thermo7_generic_write ( thermo7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
203 
214 void thermo7_generic_read ( thermo7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
215 
226 
251 void thermo7_set_configuration ( thermo7_t *ctx, uint8_t configuration );
252 
261 
272 void thermo7_set_hysteresis_temperature ( thermo7_t *ctx, int8_t temperature );
273 
282 
290 void thermo7_set_limit_temperature ( thermo7_t *ctx, int16_t temperature );
291 
300 
314 void thermo7_set_resolution ( thermo7_t *ctx, uint8_t resolution );
315 
316 #ifdef __cplusplus
317 }
318 #endif
319 #endif // _THERMO7_H_
320  // End public_function group
323 
324 // ------------------------------------------------------------------------- END
thermo7_set_configuration
void thermo7_set_configuration(thermo7_t *ctx, uint8_t configuration)
Functions for configuration chip and measurement.
thermo7_t::slave_address
uint8_t slave_address
Definition: thermo7.h:136
THERMO7_RETVAL
#define THERMO7_RETVAL
Definition: thermo7.h:76
thermo7_generic_write
void thermo7_generic_write(thermo7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
thermo7_generic_read
void thermo7_generic_read(thermo7_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
thermo7_set_hysteresis_temperature
void thermo7_set_hysteresis_temperature(thermo7_t *ctx, int8_t temperature)
Functions for settings Hysteresis Temperature.
thermo7_cfg_t
Click configuration structure definition.
Definition: thermo7.h:144
thermo7_t::i2c
i2c_master_t i2c
Definition: thermo7.h:132
thermo7_get_limit_temperature
int16_t thermo7_get_limit_temperature(thermo7_t *ctx)
Functions for get Limit Temperature.
thermo7_t
Click ctx object definition.
Definition: thermo7.h:125
thermo7_get_hysteresis_temperature
int16_t thermo7_get_hysteresis_temperature(thermo7_t *ctx)
Functions for reads Hysteresis Temperature.
thermo7_set_resolution
void thermo7_set_resolution(thermo7_t *ctx, uint8_t resolution)
Functions for settings ADC resolution measurement.
thermo7_cfg_t::i2c_address
uint8_t i2c_address
Definition: thermo7.h:157
thermo7_set_limit_temperature
void thermo7_set_limit_temperature(thermo7_t *ctx, int16_t temperature)
Functions for settings limit Temperature.
thermo7_cfg_t::int_pin
pin_name_t int_pin
Definition: thermo7.h:152
thermo7_cfg_t::scl
pin_name_t scl
Definition: thermo7.h:147
thermo7_read_ambient_temperature
float thermo7_read_ambient_temperature(thermo7_t *ctx)
Functions for reads ambient temperature.
thermo7_get_interrupt
uint8_t thermo7_get_interrupt(thermo7_t *ctx)
Functions for reads state of interrupt pins.
thermo7_cfg_setup
void thermo7_cfg_setup(thermo7_cfg_t *cfg)
Config Object Initialization function.
thermo7_t::int_pin
digital_in_t int_pin
Definition: thermo7.h:128
thermo7_init
THERMO7_RETVAL thermo7_init(thermo7_t *ctx, thermo7_cfg_t *cfg)
Initialization function.
thermo7_cfg_t::sda
pin_name_t sda
Definition: thermo7.h:148
thermo7_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: thermo7.h:156