temphum18.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 TEMPHUM18_H
#define TEMPHUM18_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 TEMPHUM18_REG_HUMIDITY_SENSOR_RESOLUTION_READ           0x06
#define TEMPHUM18_REG_HUMIDITY_SENSOR_RESOLUTION_WRITE          0x46
#define TEMPHUM18_REG_TEMPERATURE_SENSOR_RESOLUTION_READ        0x11
#define TEMPHUM18_REG_TEMPERATURE_SENSOR_RESOLUTION_WRITE       0x51
#define TEMPHUM18_REG_SENSOR_ID_UPPER_READ                      0x1E
#define TEMPHUM18_REG_SENSOR_ID_LOWER_READ                      0x1F
 
 // temphum18_reg
 
#define TEMPHUM18_CMD_ENTER_PROGRAMMING_MODE                    0xA0
#define TEMPHUM18_CMD_DUMMY                                     0x00
#define TEMPHUM18_CMD_ENTER_MEASUREMENTS_MODE                   0x80
 // temphum18_cmd
 
#define TEMPHUM18_STATUS_VALID_DATA                              0x00
#define TEMPHUM18_STATUS_STALE_DATA                              0x01
 // temphum18_status
 
#define TEMPHUM18_RESOLUTION_8_BITS                             0x00
#define TEMPHUM18_RESOLUTION_10_BITS                            0x01
#define TEMPHUM18_RESOLUTION_12_BITS                            0x02
#define TEMPHUM18_RESOLUTION_14_BITS                            0x03
 
#define TEMPHUM18_SET_DEV_ADDR  0x44
 
 // temphum18_set
 
#define TEMPHUM18_MAP_MIKROBUS( cfg, mikrobus )   \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // temphum18_map
 // temphum18
 
typedef struct
{
    // Modules
    i2c_master_t i2c;          
    // I2C slave address
    uint8_t slave_address;     
} temphum18_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} temphum18_cfg_t;
 
typedef enum
{
    TEMPHUM18_OK = 0,
    TEMPHUM18_ERROR = -1
 
} temphum18_return_value_t;
 
void temphum18_cfg_setup ( temphum18_cfg_t *cfg );
 
err_t temphum18_init ( temphum18_t *ctx, temphum18_cfg_t *cfg );
 
err_t temphum18_default_cfg ( temphum18_t *ctx );
 
err_t temphum18_generic_write ( temphum18_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t temphum18_generic_read ( temphum18_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t temphum18_wake_up ( temphum18_t *ctx );
 
err_t temphum18_get_raw_data ( temphum18_t *ctx, uint8_t resolution, int16_t *temp, uint16_t *hum, uint8_t *status );
 
err_t temphum18_get_temp_hum ( temphum18_t *ctx, uint8_t resolution, float *temperature, float *humidity );
 
err_t temphum18_enter_programming_mode ( temphum18_t *ctx );
 
err_t temphum18_enter_measurements_mode ( temphum18_t *ctx );
 
err_t temphum18_set_relative_humidity_resolution ( temphum18_t *ctx, uint8_t resolution );
 
err_t temphum18_set_temperature_resolution ( temphum18_t *ctx, uint8_t resolution );
 
#ifdef __cplusplus
}
#endif
#endif // TEMPHUM18_H
 
 // temphum18
 
// ------------------------------------------------------------------------ END