temphum19.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 TEMPHUM19_H
#define TEMPHUM19_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 TEMPHUM19_REG_RESET                 0x00
#define TEMPHUM19_REG_MODE                  0x01
#define TEMPHUM19_REG_ERROR                 0x03
#define TEMPHUM19_REG_HUMIDITY_LSB          0x04
#define TEMPHUM19_REG_HUMIDITY_MSB          0x05
#define TEMPHUM19_REG_TEMPERATURE_LSB       0x06
#define TEMPHUM19_REG_TEMPERATURE_MSB       0x07
#define TEMPHUM19_REG_CAPACITY_LSB          0x0A
#define TEMPHUM19_REG_CAPACITY_MSB          0x0B
#define TEMPHUM19_REG_CAPACITY_CTRL         0x2C
 
 // temphum19_reg
 
#define TEMPHUM19_10BIT_RESOLUTION          0x400
#define TEMPHUM19_TEMP_DATA                 0x7FF
#define TEMPHUM19_HUM_DATA                  0x3FF
#define TEMPHUM19_TEMP_RESOLUTION           0.1
#define TEMPHUM19_HUM_RESOLUTION            100
#define TEMPHUM19_TEMP_NOMINAL              25
 
#define TEMPHUM19_NORMAL_OPERATION_MODE     0x00
#define TEMPHUM19_HUM_NO_AVG                0x00
#define TEMPHUM19_HUM_AVG_2                 0x08
#define TEMPHUM19_HUM_AVG_4                 0x10
#define TEMPHUM19_HUM_AVG_8                 0x20
#define TEMPHUM19_TEMP_AVG_8                0x00
#define TEMPHUM19_TEMP_AVG_16               0x04
#define TEMPHUM19_START_DETECTION           0x01
#define TEMPHUM19_STOP_DETECTION            0x00
 
#define TEMPHUM19_SET_DEV_ADDR              0x7F
 
 // temphum19_set
 
#define TEMPHUM19_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM );
 
 // temphum19_map
 // temphum19
 
typedef struct
{
    // Output pins
    digital_out_t en;           
    // Modules
    i2c_master_t  i2c;          
    pin_name_t    scl;          
    pin_name_t    sda;          
    // I2C slave address
    uint8_t slave_address;      
    uint8_t  detection_mode;    
} temphum19_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  en;             
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} temphum19_cfg_t;
 
typedef enum
{
    TEMPHUM19_OK = 0,
    TEMPHUM19_ERROR = -1
 
} temphum19_return_value_t;
 
void temphum19_cfg_setup ( temphum19_cfg_t *cfg );
 
err_t temphum19_init ( temphum19_t *ctx, temphum19_cfg_t *cfg );
 
err_t temphum19_default_cfg ( temphum19_t *ctx );
 
err_t temphum19_generic_write ( temphum19_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t temphum19_generic_read ( temphum19_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void temphum19_enable_chip ( temphum19_t *ctx );
 
void temphum19_disable_chip ( temphum19_t *ctx );
 
void temphum19_restart_chip ( temphum19_t *ctx );
 
err_t temphum19_set_mode_reg ( temphum19_t *ctx, uint8_t mode );
 
err_t temphum19_read_data ( temphum19_t *ctx, float *temperature, float *humidity );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM19_H
 
 // temphum19
 
// ------------------------------------------------------------------------ END