temphum14.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 TEMPHUM14_H
#define TEMPHUM14_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
 
#define TEMPHUM14_I2C_SLAVE_ADDR_GND                     0x40
#define TEMPHUM14_I2C_SLAVE_ADDR_VCC                     0x41
 
#define TEMPHUM14_CMD_RESET                              0x1E
#define TEMPHUM14_CMD_HEATER_ON                          0x04
#define TEMPHUM14_CMD_HEATER_OFF                         0x02
#define TEMPHUM14_CMD_READ_T_AND_RH                      0x00
#define TEMPHUM14_CMD_READ_RH                            0x10
#define TEMPHUM14_CMD_CONVERSION                         0x40
#define TEMPHUM14_CMD_READ_DIAGNOSTIC                    0x08
#define TEMPHUM14_CMD_READ_SERIAL_NUMBER                 0x0A
 
#define TEMPHUM14_CONVERSION_HUM_OSR_0_007               0x18
#define TEMPHUM14_CONVERSION_HUM_OSR_0_010               0x10
#define TEMPHUM14_CONVERSION_HUM_OSR_0_014               0x08
#define TEMPHUM14_CONVERSION_HUM_OSR_0_020               0x00
#define TEMPHUM14_CONVERSION_TEMP_0_012                  0x06
#define TEMPHUM14_CONVERSION_TEMP_0_016                  0x04
#define TEMPHUM14_CONVERSION_TEMP_0_025                  0x02
#define TEMPHUM14_CONVERSION_TEMP_0_040                  0x00
 
#define TEMPHUM14_BIT_MASK_HUM_OSR                       0x18
#define TEMPHUM14_BIT_MASK_TEMP_OSR                      0x06
 
#define TEMPHUM14_HEATER_DISABLE                         0x00
#define TEMPHUM14_HEATER_ENABLE                          0x01
 
#define TEMPHUM14_STATUS_OFF                             0x00
#define TEMPHUM14_STATUS_ON                              0x01
 
// Calculation
#define TEMPHUM14_CALC_16_BIT_DIVIDER                    65535.0
#define TEMPHUM14_CALC_TEMP_MULTI_FACT                   165.000
#define TEMPHUM14_CALC_TEMP_SUB_FACT                     40.0000
#define TEMPHUM14_CALC_HUM_MULTI_FACT                    100.000
 
 // temphum14_reg
 
 
#define TEMPHUM14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // temphum14_map
 // temphum14
 
typedef struct
{
    // Output pins
    digital_out_t  rst;     
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} temphum14_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  rst;       
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} temphum14_cfg_t;
 
typedef enum
{
   TEMPHUM14_OK = 0,
   TEMPHUM14_ERROR = -1
 
} temphum14_return_value_t;
 
typedef struct
{
    uint8_t nvm_error;
    uint8_t hum_un_over;
    uint8_t hum_h_err;
    uint8_t hum_l_err;
    uint8_t temp_un_over;
    uint8_t temp_h_err;
    uint8_t temp_l_err;
    uint8_t heater_on;
} temphum14_diagn_t;
 
void temphum14_cfg_setup ( temphum14_cfg_t *cfg );
 
err_t temphum14_init ( temphum14_t *ctx, temphum14_cfg_t *cfg );
 
err_t temphum14_generic_write ( temphum14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t temphum14_generic_read ( temphum14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void temphum14_hw_reset ( temphum14_t *ctx );
 
void temphum14_set_cmd ( temphum14_t *ctx, uint8_t cmd );
 
void temphum14_set_conversion ( temphum14_t *ctx, uint8_t hum_osr, uint8_t temp_osr );
 
void temphum14_read_t_and_rh ( temphum14_t *ctx, uint8_t *p_rx_data );
 
void temphum14_get_temp_and_hum ( temphum14_t *ctx, float *temp, float *hum );
 
void temphum14_read_rh ( temphum14_t *ctx, uint8_t *p_rx_data );
 
float temphum14_get_hum ( temphum14_t *ctx );
 
void temphum14_soft_reset ( temphum14_t *ctx );
 
void temphum14_set_heater ( temphum14_t *ctx, uint8_t en_heater );
 
void temphum14_get_diagnostic ( temphum14_t *ctx, temphum14_diagn_t *diag_data );
 
uint32_t temphum14_get_serial_number ( temphum14_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM14_H
 
 // temphum14
 
// ------------------------------------------------------------------------ END