temphum3  2.0.0.0
temphum3.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 TEMPHUM3_H
36 #define TEMPHUM3_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 TEMPHUM3_MAP_MIKROBUS( cfg, mikrobus ) \
53  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
55  cfg.addr = MIKROBUS( mikrobus, MIKROBUS_CS ); \
56  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
57 
63 #define TEMPHUM3_OK 0
64 #define TEMPHUM3_ERROR -1
65 
71 #define TEMPHUM3_MODE_ACTIVE 0x01
72 #define TEMPHUM3_MODE_SLEEP 0x00
73 
79 #define TEMPHUM3_REG_TEMPERATURE 0x00
80 #define TEMPHUM3_REG_HUMIDITY 0x02
81 #define TEMPHUM3_REG_INTERRUPT_DRDY 0x04
82 #define TEMPHUM3_REG_TEMPERATURE_MAX 0x05
83 #define TEMPHUM3_REG_HUMIDITY_MAX 0x06
84 #define TEMPHUM3_REG_INTERRUPT_MASK 0x07
85 #define TEMPHUM3_REG_TEMP_OFFSET_ADJUST 0x08
86 #define TEMPHUM3_REG_HUM_OFFSET_ADJUST 0x09
87 #define TEMPHUM3_REG_TEMP_THRESHOLD_HIGH 0x0A
88 #define TEMPHUM3_REG_HUM_THRESHOLD_HIGH 0x0C
89 #define TEMPHUM3_REG_TEMP_THRESHOLD_LOW 0x0B
90 #define TEMPHUM3_REG_HUM_THRESHOLD_LOW 0x0D
91 #define TEMPHUM3_REG_RST_DRDY_INT_CONF 0x0E
92 #define TEMPHUM3_REG_MEASUREMENT_CONF 0x0F
93 #define TEMPHUM3_REG_MANUFACTURER_ID 0xFC
94 #define TEMPHUM3_REG_DEVICE_ID 0xFE
95 
101 #define TEMPHUM3_STATUS_DRDY 0x80
102 #define TEMPHUM3_STATUS_TEMP_HIGH 0x40
103 #define TEMPHUM3_STATUS_TEMP_LOW 0x20
104 #define TEMPHUM3_STATUS_HUM_HIGH 0x10
105 #define TEMPHUM3_STATUS_HUM_LOW 0x08
106 
112 #define TEMPHUM3_MASK_DRDY 0x80
113 #define TEMPHUM3_MASK_TEMP_HIGH 0x40
114 #define TEMPHUM3_MASK_TEMP_LOW 0x20
115 #define TEMPHUM3_MASK_HUM_HIGH 0x10
116 #define TEMPHUM3_MASK_HUM_LOW 0x08
117 
124 #define TEMPHUM3_CONF_NORMAL_MODE 0x00
125 #define TEMPHUM3_CONF_SOFT_RESET 0x80
126 
132 #define TEMPHUM3_CONF_ODR_NO_REPEATED 0x00
133 #define TEMPHUM3_CONF_ODR_REPEATED_2MIN 0x10
134 #define TEMPHUM3_CONF_ODR_REPEATED_1MIN 0x20
135 #define TEMPHUM3_CONF_ODR_REPEATED_10SEC 0x30
136 #define TEMPHUM3_CONF_ODR_REPEATED_5SEC 0x40
137 #define TEMPHUM3_CONF_ODR_REPEATED_1SEC 0x50
138 #define TEMPHUM3_CONF_ODR_REPEATED_500MS 0x60
139 #define TEMPHUM3_CONF_ODR_REPEATED_200MS 0x70
140 #define TEMPHUM3_CONF_HEATER_OFF 0x00
141 #define TEMPHUM3_CONF_HEATER_ON 0x08
142 #define TEMPHUM3_CONF_INT_DRDY_HIGH_Z 0x00
143 #define TEMPHUM3_CONF_INT_DRDY_ENABLE 0x04
144 #define TEMPHUM3_CONF_INT_POL_LOW 0x00
145 #define TEMPHUM3_CONF_INT_POL_HIGH 0x02
146 #define TEMPHUM3_CONF_INT_MODE_SENSITIVE 0x00
147 #define TEMPHUM3_CONF_INT_MODE_COMPARATOR 0x01
148 
154 #define TEMPHUM3_MCONF_TEMP_RES_14BIT 0x00
155 #define TEMPHUM3_MCONF_TEMP_RES_11BIT 0x40
156 #define TEMPHUM3_MCONF_TEMP_RES_9BIT 0x80
157 #define TEMPHUM3_MCONF_HUM_RES_14BIT 0x00
158 #define TEMPHUM3_MCONF_HUM_RES_11BIT 0x10
159 #define TEMPHUM3_MCONF_HUM_RES_9BIT 0x20
160 #define TEMPHUM3_MCONF_HUM_TEMP 0x00
161 #define TEMPHUM3_MCONF_TEMP_ONLY 0x02
162 #define TEMPHUM3_MCONF_HUM_ONLY 0x04
163 #define TEMPHUM3_MCONF_MEAS_START 0x01
164 #define TEMPHUM3_MCONF_MEAS_NO_ACTION 0x00
165  // End group macro
168 // --------------------------------------------------------------- PUBLIC TYPES
177 typedef struct
178 {
179  // Output pins
180  digital_out_t addr;
181 
182  // Input pins
183  digital_in_t int_pin;
184 
185  // Modules
186  i2c_master_t i2c;
187 
188  // ctx variable
189  uint8_t slave_address;
190 
191 } temphum3_t;
192 
196 typedef struct
197 {
198  // Communication gpio pins
199  pin_name_t scl;
200  pin_name_t sda;
201 
202  // Additional gpio pins
203  pin_name_t addr;
204  pin_name_t int_pin;
205 
206  // static variable
207  uint32_t i2c_speed;
208  uint8_t i2c_address;
209 
211  // End types group
213 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
214 
220 #ifdef __cplusplus
221 extern "C"{
222 #endif
223 
233 
243 
252 
263 void temphum3_generic_write ( temphum3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
264 
275 void temphum3_generic_read ( temphum3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
276 
285 void temphum3_set_mode ( temphum3_t *ctx, uint8_t value );
286 
295 void temphum3_set_configuration ( temphum3_t *ctx, uint8_t value );
296 
304 void temphum3_set_measurement ( temphum3_t *ctx, uint8_t value );
305 
314 
323 
331 uint16_t temphum3_get_id ( temphum3_t *ctx );
332 
341 
349 uint8_t temphum3_get_status_interrupt ( temphum3_t *ctx, uint8_t mask );
350 
359 uint8_t temphum3_get_interrupt_mask ( temphum3_t *ctx, uint8_t mask );
360 
370 void temphum3_set_offset ( temphum3_t *ctx, uint8_t reg, uint8_t value );
371 
380 void temphum3_set_high_temp ( temphum3_t *ctx, uint8_t temp_data );
381 
390 void temphum3_set_low_temp ( temphum3_t *ctx, uint8_t temp_data );
391 
400 void temphum3_set_high_hum( temphum3_t *ctx, uint8_t hum_data );
401 
410 void temphum3_set_low_hum( temphum3_t *ctx, uint8_t hum_data );
411 
420 
429 
430 #ifdef __cplusplus
431 }
432 #endif
433 #endif // _TEMPHUM3_H_
434  // End public_function group
437 
438 // ------------------------------------------------------------------------- END
temphum3_get_id
uint16_t temphum3_get_id(temphum3_t *ctx)
Get ID function.
temphum3_get_max_hum
float temphum3_get_max_hum(temphum3_t *ctx)
Get maximum humidity function.
temphum3_cfg_t::int_pin
pin_name_t int_pin
Definition: temphum3.h:204
temphum3_set_low_temp
void temphum3_set_low_temp(temphum3_t *ctx, uint8_t temp_data)
Set low temperature function.
temphum3_set_mode
void temphum3_set_mode(temphum3_t *ctx, uint8_t value)
Set measurement mode function.
temphum3_cfg_t::sda
pin_name_t sda
Definition: temphum3.h:200
temphum3_set_measurement
void temphum3_set_measurement(temphum3_t *ctx, uint8_t value)
Set measurement function.
temphum3_get_humidity
float temphum3_get_humidity(temphum3_t *ctx)
Get humidity function.
temphum3_set_configuration
void temphum3_set_configuration(temphum3_t *ctx, uint8_t value)
Set configuration function.
temphum3_set_low_hum
void temphum3_set_low_hum(temphum3_t *ctx, uint8_t hum_data)
Set low humidity function.
temphum3_cfg_t::scl
pin_name_t scl
Definition: temphum3.h:199
temphum3_t
Click ctx object definition.
Definition: temphum3.h:178
temphum3_get_interrupt_mask
uint8_t temphum3_get_interrupt_mask(temphum3_t *ctx, uint8_t mask)
Get interrupt mask function.
temphum3_get_temperature
float temphum3_get_temperature(temphum3_t *ctx)
Get temperature function.
temphum3_generic_write
void temphum3_generic_write(temphum3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
temphum3_cfg_t::addr
pin_name_t addr
Definition: temphum3.h:203
temphum3_get_status_interrupt
uint8_t temphum3_get_status_interrupt(temphum3_t *ctx, uint8_t mask)
Get interrupt status function.
temphum3_t::slave_address
uint8_t slave_address
Definition: temphum3.h:189
temphum3_t::i2c
i2c_master_t i2c
Definition: temphum3.h:186
temphum3_set_high_temp
void temphum3_set_high_temp(temphum3_t *ctx, uint8_t temp_data)
Set high temperature function.
temphum3_generic_read
void temphum3_generic_read(temphum3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
temphum3_get_manufacturer_id
uint16_t temphum3_get_manufacturer_id(temphum3_t *ctx)
Get manufacturer's ID function.
temphum3_cfg_t
Click configuration structure definition.
Definition: temphum3.h:197
temphum3_t::int_pin
digital_in_t int_pin
Definition: temphum3.h:183
temphum3_init
err_t temphum3_init(temphum3_t *ctx, temphum3_cfg_t *cfg)
Initialization function.
temphum3_cfg_setup
void temphum3_cfg_setup(temphum3_cfg_t *cfg)
Config Object Initialization function.
temphum3_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: temphum3.h:207
temphum3_t::addr
digital_out_t addr
Definition: temphum3.h:180
temphum3_default_cfg
void temphum3_default_cfg(temphum3_t *ctx)
Click Default Configuration function.
temphum3_set_offset
void temphum3_set_offset(temphum3_t *ctx, uint8_t reg, uint8_t value)
Set offset function.
temphum3_set_high_hum
void temphum3_set_high_hum(temphum3_t *ctx, uint8_t hum_data)
Set high humidity function.
temphum3_cfg_t::i2c_address
uint8_t i2c_address
Definition: temphum3.h:208
temphum3_get_max_temp
float temphum3_get_max_temp(temphum3_t *ctx)
Get maximum temperature function.