htu21d.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef HTU21D_H
#define HTU21D_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_i2c_master.h"
 
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define HTU21D_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define HTU21D_RETVAL  uint8_t
 
#define HTU21D_OK                                         0x00
#define HTU21D_INIT_ERROR                                 0xFF
#define HTU21D_I2C_ADDRESS                                0x40
#define HTU21D_USER_REG_WRITE                             0xE6
#define HTU21D_USER_REG_READ                              0xE7
#define HTU21D_HEATER_REG_WRITE                           0x51
#define HTU21D_HEATER_REG_READ                            0x11
#define HTU21D_SOFT_RESET                                 0xFE
#define HTU21D_SERIAL1_READ1                              0xFA
#define HTU21D_SERIAL1_READ2                              0x0F
#define HTU21D_SERIAL2_READ1                              0xFC
#define HTU21D_SERIAL2_READ2                              0xC9
#define HTU21D_SI7013_CHIPID                              0x0D
#define HTU21D_SI7020_CHIPID                              0x14
#define HTU21D_SI7021_CHIPID                              0x15
#define HTU21D_CHIPID                                     0x32
#define HTU21D_FIRMWARE_READ1                             0x84
#define HTU21D_FIRMWARE_READ2                             0xB8
#define HTU21D_FIRMWARE_V1                                0xFF
#define HTU21D_FIRMWARE_V2                                0x20
#define HTU21D_FORCE_READ_TEMP                            0xFE
#define HTU21D_ERROR                                      0xFF
#define HTU21D_RES_RH12_TEMP14                            0x00
#define HTU21D_RES_RH8_TEMP12                             0x01
#define HTU21D_RES_RH10_TEMP13                            0x80
#define HTU21D_RES_RH11_TEMP11                            0x81
#define HTU21D_TRIG_HUMD_MEASURE_HOLD                     0xE5
#define HTU21D_TRIG_HUMD_MEASURE_NOHOLD                   0xF5
#define HTU21D_TRIG_TEMP_MEASURE_HOLD                     0xE3
#define HTU21D_TRIG_TEMP_MEASURE_NOHOLD                   0xF3
#define HTU21D_ON                                         0x04
#define HTU21D_OFF                                        0xFB
#define HTU21D_CRC8_POLYNOMINAL                           0x1310
#define HTU21D_DATA_FILTER                                0xFFFC
#define HTU21D_DATA_RESOLUTION                            65536.0
#define HTU21D_TEMP_CALC_COEF                             175.72
#define HTU21D_TEMP_STB_COEF                              -46.85
#define HTU21D_HUMI_CALC_COEF                             125.0
#define HTU21D_HUMI_STB_COEF                              6.0
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} htu21d_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} htu21d_cfg_t;
 
 // End types group
// ------------------------------------------------------------------ CONSTANTS
 // End constants group
// ------------------------------------------------------------------ VARIABLES
 // End variable group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void htu21d_cfg_setup ( htu21d_cfg_t *cfg );
 
HTU21D_RETVAL htu21d_init ( htu21d_t *ctx, htu21d_cfg_t *cfg );
 
void htu21d_generic_write ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void htu21d_generic_read ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint32_t htu21d_read_data ( htu21d_t *ctx, uint8_t reg_adr );
 
void htu21d_send_cmd ( htu21d_t *ctx, uint8_t cmd_byte );
 
void htu21d_generic_read ( htu21d_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
float htu21d_get_temperature ( htu21d_t *ctx );
 
float htu21d_get_humidity( htu21d_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _HTU21D_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END