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
38#include "drv_digital_out.h"
39#include "drv_i2c_master.h"
40
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define HTU21D_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
54 cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
61#define HTU21D_RETVAL uint8_t
62
63#define HTU21D_OK 0x00
64#define HTU21D_INIT_ERROR 0xFF
72#define HTU21D_I2C_ADDRESS 0x40
79#define HTU21D_USER_REG_WRITE 0xE6
86#define HTU21D_USER_REG_READ 0xE7
93#define HTU21D_HEATER_REG_WRITE 0x51
100#define HTU21D_HEATER_REG_READ 0x11
107#define HTU21D_SOFT_RESET 0xFE
114#define HTU21D_SERIAL1_READ1 0xFA
121#define HTU21D_SERIAL1_READ2 0x0F
128#define HTU21D_SERIAL2_READ1 0xFC
135#define HTU21D_SERIAL2_READ2 0xC9
142#define HTU21D_SI7013_CHIPID 0x0D
149#define HTU21D_SI7020_CHIPID 0x14
156#define HTU21D_SI7021_CHIPID 0x15
163#define HTU21D_CHIPID 0x32
170#define HTU21D_FIRMWARE_READ1 0x84
177#define HTU21D_FIRMWARE_READ2 0xB8
184#define HTU21D_FIRMWARE_V1 0xFF
191#define HTU21D_FIRMWARE_V2 0x20
198#define HTU21D_FORCE_READ_TEMP 0xFE
205#define HTU21D_ERROR 0xFF
212#define HTU21D_RES_RH12_TEMP14 0x00
219#define HTU21D_RES_RH8_TEMP12 0x01
226#define HTU21D_RES_RH10_TEMP13 0x80
233#define HTU21D_RES_RH11_TEMP11 0x81
240#define HTU21D_TRIG_HUMD_MEASURE_HOLD 0xE5
247#define HTU21D_TRIG_HUMD_MEASURE_NOHOLD 0xF5
254#define HTU21D_TRIG_TEMP_MEASURE_HOLD 0xE3
261#define HTU21D_TRIG_TEMP_MEASURE_NOHOLD 0xF3
268#define HTU21D_ON 0x04
275#define HTU21D_OFF 0xFB
282#define HTU21D_CRC8_POLYNOMINAL 0x1310
289#define HTU21D_DATA_FILTER 0xFFFC
290#define HTU21D_DATA_RESOLUTION 65536.0
291#define HTU21D_TEMP_CALC_COEF 175.72
292#define HTU21D_TEMP_STB_COEF -46.85
293#define HTU21D_HUMI_CALC_COEF 125.0
294#define HTU21D_HUMI_STB_COEF 6.0 // End group macro
298// --------------------------------------------------------------- PUBLIC TYPES
307typedef struct
308{
309 // Modules
310
311 i2c_master_t i2c;
312
313 // ctx variable
314
316
317} htu21d_t;
318
322typedef struct
323{
324 // Communication gpio pins
325
326 pin_name_t scl;
327 pin_name_t sda;
328
329 // static variable
330
331 uint32_t i2c_speed;
332 uint8_t i2c_address;
333
335 // End types group
337// ------------------------------------------------------------------ CONSTANTS // End constants group
346// ------------------------------------------------------------------ VARIABLES // End variable group
354// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
355
361#ifdef __cplusplus
362extern "C"{
363#endif
364
374
383
394void htu21d_generic_write ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
395
407void htu21d_generic_read ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
408
419uint32_t htu21d_read_data ( htu21d_t *ctx, uint8_t reg_adr );
420
431void htu21d_send_cmd ( htu21d_t *ctx, uint8_t cmd_byte );
432
443void htu21d_generic_read ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
444
456
468
480#ifdef __cplusplus
481}
482#endif
483#endif // _HTU21D_H_
484 // End public_function group
487
488// ------------------------------------------------------------------------- END
#define HTU21D_RETVAL
Definition: htu21d.h:61
uint32_t htu21d_read_data(htu21d_t *ctx, uint8_t reg_adr)
Generic read 24-bit data function.
HTU21D_RETVAL htu21d_init(htu21d_t *ctx, htu21d_cfg_t *cfg)
Initialization function.
void htu21d_generic_read(htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
float htu21d_get_temperature(htu21d_t *ctx)
Get temperature value function.
float htu21d_get_humidity(htu21d_t *ctx)
Get humidity value function.
void htu21d_generic_write(htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
void htu21d_cfg_setup(htu21d_cfg_t *cfg)
Config Object Initialization function.
void htu21d_send_cmd(htu21d_t *ctx, uint8_t cmd_byte)
Send command function.
Click configuration structure definition.
Definition: htu21d.h:323
uint32_t i2c_speed
Definition: htu21d.h:331
pin_name_t scl
Definition: htu21d.h:326
pin_name_t sda
Definition: htu21d.h:327
uint8_t i2c_address
Definition: htu21d.h:332
Click ctx object definition.
Definition: htu21d.h:308
i2c_master_t i2c
Definition: htu21d.h:311
uint8_t slave_address
Definition: htu21d.h:315