temphum15.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 TEMPHUM15_H
#define TEMPHUM15_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 TEMPHUM15_CMD_MEASURE_HIGH_PRECISION                     0xFD
#define TEMPHUM15_CMD_MEASURE_MEDIUM_PRECISION                   0xF6
#define TEMPHUM15_CMD_MEASURE_LOW_PRECISION                      0xE0
#define TEMPHUM15_CMD_READ_SERIAL                                0x89
#define TEMPHUM15_CMD_SOFT_RESET                                 0x94
#define TEMPHUM15_CMD_HEATER_HIGHEST_POW_HIGH_DUR                0x39
#define TEMPHUM15_CMD_HEATER_HIGHEST_POW_LOW_DUR                 0x32
#define TEMPHUM15_CMD_HEATER_MEDIUM_POW_HIGH_DUR                 0x2F
#define TEMPHUM15_CMD_HEATER_MEDIUM_POW_LOW_DUR                  0x24
#define TEMPHUM15_CMD_HEATER_LOWEST_POW_HIGH_DUR                 0x1E
#define TEMPHUM15_CMD_HEATER_LOWEST_POW_LOW_DUR                  0x15
 
 // temphum15_cmd
 
#define TEMPHUM15_SET_DEV_ADDR                                   0x44
 
 // temphum15_set
 
#define TEMPHUM15_MODE_HIGH_PRECISION                            0x00
#define TEMPHUM15_MODE_MEDIUM_PRECISION                          0x01
#define TEMPHUM15_MODE_LOW_PRECISION                             0x02
 
 // precision_mode
 
#define TEMPHUM15_SUCCESS                                         0
#define TEMPHUM15_ERROR                                          -1
 
 // status
 
#define TEMPHUM15_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // temphum15_map
 // temphum15
 
typedef struct
{
    // Modules
 
    i2c_master_t i2c;                                
    // I2C slave address
 
    uint8_t slave_address;                           
} temphum15_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} temphum15_cfg_t;
 
void temphum15_cfg_setup ( temphum15_cfg_t *cfg );
 
err_t temphum15_init ( temphum15_t *ctx, temphum15_cfg_t *cfg );
 
err_t temphum15_default_cfg ( temphum15_t *ctx );
 
err_t temphum15_generic_write ( temphum15_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t temphum15_generic_read ( temphum15_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t temphum15_get_temp_and_hum ( temphum15_t *ctx, uint8_t precision_mode, float *temp_val, float *hum_val );
 
err_t temphum15_soft_reset ( temphum15_t *ctx );
 
err_t temphum15_read_serial ( temphum15_t *ctx, uint32_t *serial_number );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM15_H
 
 // temphum15
 
// ------------------------------------------------------------------------ END