temphum16.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 TEMPHUM16_H
#define TEMPHUM16_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"
#include "drv_spi_master.h"
 
#define TEMPHUM16_REG_DEVICE_ID              0x0F 
#define TEMPHUM16_REG_AVERAGE                0x10   
#define TEMPHUM16_REG_CTRL_1                 0x20    
#define TEMPHUM16_REG_CTRL_2                 0x21    
#define TEMPHUM16_REG_CTRL_3                 0x22    
#define TEMPHUM16_REG_STATUS                 0x27    
#define TEMPHUM16_REG_H_OUT_L                0x28   
#define TEMPHUM16_REG_H_OUT_H                0x29   
#define TEMPHUM16_REG_T_OUT_L                0x2A   
#define TEMPHUM16_REG_T_OUT_H                0x2B   
#define TEMPHUM16_REG_H0_RH_X2               0x30      
#define TEMPHUM16_REG_H1_RH_X2               0x31      
#define TEMPHUM16_REG_T0_DEGC_X8             0x32    
#define TEMPHUM16_REG_T1_DEGC_X8             0x33    
#define TEMPHUM16_REG_T0_T1_DEGC_H2          0x35 
#define TEMPHUM16_REG_H0_T0_OUT_L            0x36   
#define TEMPHUM16_REG_H0_T0_OUT_H            0x37   
#define TEMPHUM16_REG_H1_T0_OUT_L            0x3A   
#define TEMPHUM16_REG_H1_T0_OUT_H            0x3B   
#define TEMPHUM16_REG_T0_OUT_L               0x3C      
#define TEMPHUM16_REG_T0_OUT_H               0x3D      
#define TEMPHUM16_REG_T1_OUT_L               0x3E      
#define TEMPHUM16_REG_T1_OUT_H               0x3F
 
 // temphum16_reg
 
#define TEMPHUM16_PWR_MODE_POWER_DOWN        0x00
#define TEMPHUM16_PWR_MODE_CONTINUOUS        0x01
    
#define TEMPHUM16_BDU_CONTINUOUS_UPDATE      0x00
#define TEMPHUM16_BDU_NOT_UPDAT_UNTIL_READ   0x01
    
#define TEMPHUM16_ODR_ONE_SHOT_MODE          0x00
#define TEMPHUM16_ODR_1_Hz                   0x01
#define TEMPHUM16_ODR_7_Hz                   0x02
#define TEMPHUM16_ODR_12_5_Hz                0x03
    
#define TEMPHUM16_HEATER_DISABLE             0x00
#define TEMPHUM16_HEATER_ENABLE              0x01
 
#define TEMPHUM16_DEVICE_ID                  0xBC
 
#define TEMPHUM16_DRDY                       0x01
 
#define TEMPHUM16_SET_DEV_ADDR               0x5F
 
 // temphum16_set
 
#define TEMPHUM16_MAP_MIKROBUS( cfg, mikrobus )     \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL );  \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA );  \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS );   \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // temphum16_map
 // temphum16
 
typedef enum
{
   TEMPHUM16_DRV_SEL_SPI,      
   TEMPHUM16_DRV_SEL_I2C       
} temphum16_drv_t;
 
typedef err_t ( *temphum16_master_io_t )( struct temphum16_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct temphum16_s
{
    digital_in_t  rdy;       
    i2c_master_t  i2c;                              
    spi_master_t  spi;                              
    uint8_t     slave_address;                      
    pin_name_t  chip_select;                        
    temphum16_drv_t  drv_sel;               
    temphum16_master_io_t  write_f;         
    temphum16_master_io_t  read_f;          
} temphum16_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  miso;       
    pin_name_t  mosi;       
    pin_name_t  sck;        
    pin_name_t  cs;         
    pin_name_t  rdy;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
    uint32_t                           spi_speed;       
    spi_master_mode_t                  spi_mode;        
    spi_master_chip_select_polarity_t  cs_polarity;     
   temphum16_drv_t  drv_sel;                            
} temphum16_cfg_t;
 
typedef enum
{
   TEMPHUM16_OK = 0,
   TEMPHUM16_ERROR = -1
 
} temphum16_return_value_t;
 
void temphum16_cfg_setup ( temphum16_cfg_t *cfg );
 
void temphum16_drv_interface_selection ( temphum16_cfg_t *cfg, temphum16_drv_t drv_sel );
 
err_t temphum16_init ( temphum16_t *ctx, temphum16_cfg_t *cfg );
 
err_t temphum16_default_cfg ( temphum16_t *ctx );
 
err_t temphum16_generic_write ( temphum16_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t temphum16_generic_read ( temphum16_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t temphum16_get_device_id ( temphum16_t *ctx, uint8_t *device_id );
 
err_t temphum16_power_mode ( temphum16_t *ctx, uint8_t pwr_mode );
 
err_t temphum16_bdu_mode ( temphum16_t *ctx, uint8_t bdu_mode );
 
err_t temphum16_set_odr ( temphum16_t *ctx, uint8_t odr );
 
err_t temphum16_heater ( temphum16_t *ctx, uint8_t heater_mode );
 
err_t temphum16_enable_data_ready_interrupt ( temphum16_t *ctx );
 
err_t temphum16_get_status ( temphum16_t *ctx, uint8_t *status );
 
uint8_t temphum16_check_ready ( temphum16_t *ctx );
 
err_t temphum16_get_humidity ( temphum16_t *ctx, float *humidity );
 
err_t temphum16_get_temperature ( temphum16_t *ctx, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM16_H
 
 // temphum16
 
// ------------------------------------------------------------------------ END