htu21d  2.0.0.0
htu21d.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 HTU21D_H
36 #define HTU21D_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_i2c_master.h"
54 
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define HTU21D_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
68  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
69 
75 #define HTU21D_RETVAL uint8_t
76 
77 #define HTU21D_OK 0x00
78 #define HTU21D_INIT_ERROR 0xFF
79 
86 #define HTU21D_I2C_ADDRESS 0x40
87 
93 #define HTU21D_USER_REG_WRITE 0xE6
94 
100 #define HTU21D_USER_REG_READ 0xE7
101 
107 #define HTU21D_HEATER_REG_WRITE 0x51
108 
114 #define HTU21D_HEATER_REG_READ 0x11
115 
121 #define HTU21D_SOFT_RESET 0xFE
122 
128 #define HTU21D_SERIAL1_READ1 0xFA
129 
135 #define HTU21D_SERIAL1_READ2 0x0F
136 
142 #define HTU21D_SERIAL2_READ1 0xFC
143 
149 #define HTU21D_SERIAL2_READ2 0xC9
150 
156 #define HTU21D_SI7013_CHIPID 0x0D
157 
163 #define HTU21D_SI7020_CHIPID 0x14
164 
170 #define HTU21D_SI7021_CHIPID 0x15
171 
177 #define HTU21D_CHIPID 0x32
178 
184 #define HTU21D_FIRMWARE_READ1 0x84
185 
191 #define HTU21D_FIRMWARE_READ2 0xB8
192 
198 #define HTU21D_FIRMWARE_V1 0xFF
199 
205 #define HTU21D_FIRMWARE_V2 0x20
206 
212 #define HTU21D_FORCE_READ_TEMP 0xFE
213 
219 #define HTU21D_ERROR 0xFF
220 
226 #define HTU21D_RES_RH12_TEMP14 0x00
227 
233 #define HTU21D_RES_RH8_TEMP12 0x01
234 
240 #define HTU21D_RES_RH10_TEMP13 0x80
241 
247 #define HTU21D_RES_RH11_TEMP11 0x81
248 
254 #define HTU21D_TRIG_HUMD_MEASURE_HOLD 0xE5
255 
261 #define HTU21D_TRIG_HUMD_MEASURE_NOHOLD 0xF5
262 
268 #define HTU21D_TRIG_TEMP_MEASURE_HOLD 0xE3
269 
275 #define HTU21D_TRIG_TEMP_MEASURE_NOHOLD 0xF3
276 
282 #define HTU21D_ON 0x04
283 
289 #define HTU21D_OFF 0xFB
290 
296 #define HTU21D_CRC8_POLYNOMINAL 0x1310
297 
303 #define HTU21D_DATA_FILTER 0xFFFC
304 #define HTU21D_DATA_RESOLUTION 65536.0
305 #define HTU21D_TEMP_CALC_COEF 175.72
306 #define HTU21D_TEMP_STB_COEF -46.85
307 #define HTU21D_HUMI_CALC_COEF 125.0
308 #define HTU21D_HUMI_STB_COEF 6.0
309  // End group macro
312 // --------------------------------------------------------------- PUBLIC TYPES
321 typedef struct
322 {
323  // Modules
324 
325  i2c_master_t i2c;
326 
327  // ctx variable
328 
329  uint8_t slave_address;
330 
331 } htu21d_t;
332 
336 typedef struct
337 {
338  // Communication gpio pins
339 
340  pin_name_t scl;
341  pin_name_t sda;
342 
343  // static variable
344 
345  uint32_t i2c_speed;
346  uint8_t i2c_address;
347 
348 } htu21d_cfg_t;
349  // End types group
351 // ------------------------------------------------------------------ CONSTANTS // End constants group
360 // ------------------------------------------------------------------ VARIABLES // End variable group
368 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
369 
375 #ifdef __cplusplus
376 extern "C"{
377 #endif
378 
388 
397 
408 void htu21d_generic_write ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
409 
421 void htu21d_generic_read ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
422 
433 uint32_t htu21d_read_data ( htu21d_t *ctx, uint8_t reg_adr );
434 
445 void htu21d_send_cmd ( htu21d_t *ctx, uint8_t cmd_byte );
446 
457 void htu21d_generic_read ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
458 
470 
482 
494 #ifdef __cplusplus
495 }
496 #endif
497 #endif // _HTU21D_H_
498  // End public_function group
501 
502 // ------------------------------------------------------------------------- END
htu21d_cfg_t::scl
pin_name_t scl
Definition: htu21d.h:340
htu21d_get_temperature
float htu21d_get_temperature(htu21d_t *ctx)
Get temperature value function.
htu21d_t
Click ctx object definition.
Definition: htu21d.h:322
htu21d_cfg_setup
void htu21d_cfg_setup(htu21d_cfg_t *cfg)
Config Object Initialization function.
htu21d_generic_write
void htu21d_generic_write(htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
htu21d_cfg_t::sda
pin_name_t sda
Definition: htu21d.h:341
HTU21D_RETVAL
#define HTU21D_RETVAL
Definition: htu21d.h:75
htu21d_send_cmd
void htu21d_send_cmd(htu21d_t *ctx, uint8_t cmd_byte)
Send command function.
htu21d_cfg_t::i2c_address
uint8_t i2c_address
Definition: htu21d.h:346
htu21d_init
HTU21D_RETVAL htu21d_init(htu21d_t *ctx, htu21d_cfg_t *cfg)
Initialization function.
htu21d_t::slave_address
uint8_t slave_address
Definition: htu21d.h:329
htu21d_generic_read
void htu21d_generic_read(htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
htu21d_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: htu21d.h:345
htu21d_read_data
uint32_t htu21d_read_data(htu21d_t *ctx, uint8_t reg_adr)
Generic read 24-bit data function.
htu21d_t::i2c
i2c_master_t i2c
Definition: htu21d.h:325
htu21d_get_humidity
float htu21d_get_humidity(htu21d_t *ctx)
Get humidity value function.
htu21d_cfg_t
Click configuration structure definition.
Definition: htu21d.h:337