temphum22.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 TEMPHUM22_H
#define TEMPHUM22_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 TEMPHUM22_CMD_MEAS_TH_HIGH_PREC         0xFD
#define TEMPHUM22_CMD_MEAS_TH_MED_PREC          0xF6
#define TEMPHUM22_CMD_MEAS_TH_LOW_PREC          0xE0
#define TEMPHUM22_CMD_READ_SERIAL_NUM           0x89
#define TEMPHUM22_CMD_SOFT_RESET                0x94
#define TEMPHUM22_CMD_ACT_HEATER_200mW_1S       0x39
#define TEMPHUM22_CMD_ACT_HEATER_200mW_0p1S     0x32
#define TEMPHUM22_CMD_ACT_HEATER_110mW_1S       0x2F
#define TEMPHUM22_CMD_ACT_HEATER_110mW_0p1S     0x24
#define TEMPHUM22_CMD_ACT_HEATER_20mW_1S        0x1E
#define TEMPHUM22_CMD_ACT_HEATER_20mW_0p1S      0x15
 
 // temphum22_reg
 
#define TEMPHUM22_MAX_RH                        100.0
#define TEMPHUM22_MIN_RH                        0.0
#define TEMPHUM22_DATA_RESOLUTION               65535.0
#define TEMPHUM22_ABS_MIN_TEMP                  ( -45.0 )
#define TEMPHUM22_ABS_MAX_TEMP                  ( 130.0 )
#define TEMPHUM22_ABS_MIN_HUM                   ( -6.0 )
#define TEMPHUM22_ABS_MAX_HUM                   ( 119.0 )
 
#define TEMPHUM22_DEVICE_ADDRESS                0x44
 
 // temphum22_set
 
#define TEMPHUM22_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // temphum22_map
 // temphum22
 
typedef struct
{
    // Modules
    i2c_master_t i2c;               
    // I2C slave address
    uint8_t slave_address;          
} temphum22_t;
 
typedef struct
{
    pin_name_t scl;                 
    pin_name_t sda;                 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
} temphum22_cfg_t;
 
typedef enum
{
    TEMPHUM22_OK = 0,
    TEMPHUM22_ERROR = -1
 
} temphum22_return_value_t;
 
void temphum22_cfg_setup ( temphum22_cfg_t *cfg );
 
err_t temphum22_init ( temphum22_t *ctx, temphum22_cfg_t *cfg );
 
err_t temphum22_send_cmd ( temphum22_t *ctx, uint8_t cmd );
 
err_t temphum22_read_response ( temphum22_t *ctx, uint8_t *data_out );
 
err_t temphum22_soft_reset ( temphum22_t *ctx );
 
err_t temphum22_read_serial_num ( temphum22_t *ctx, uint32_t *serial_num );
 
err_t temphum22_read_measurement_high_precision ( temphum22_t *ctx, float *temp, float *hum );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM22_H
 
 // temphum22
 
// ------------------------------------------------------------------------ END