pht.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 PHT_H
#define PHT_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 PHT_RH_CMD_RESET                                           0xFE
#define PHT_RH_CMD_WRITE_USER_REG                                  0xE6
#define PHT_RH_CMD_READ_USER_REG                                   0xE7
#define PHT_RH_MEASURE_RH_HOLD                                     0xE5
#define PHT_RH_MEASURE_RH_NO_HOLD                                  0xF5
 
#define PHT_PT_CMD_RESET                                           0x1E
#define PHT_PT_CMD_ADC_READ                                        0x00
#define PHT_PT_CMD_PROM_READ_P_T_START                             0xA0
#define PHT_PT_CMD_PROM_READ_P_T_END                               0xAE
 
#define PHT_PT_CMD_RATIO_256                                       0x00
#define PHT_PT_CMD_RATIO_512                                       0x01
#define PHT_PT_CMD_RATIO_1024                                      0x02
#define PHT_PT_CMD_RATIO_2048                                      0x03
#define PHT_PT_CMD_RATIO_4096                                      0x04
#define PHT_PT_CMD_RATIO_8192                                      0x05
 
#define PHT_PT_MANUFACTURER_RESERVED                               0x00
#define PHT_PT_C1_SENS                                             0x01
#define PHT_PT_C2_OFF                                              0x02
#define PHT_PT_C3_TCS                                              0x03
#define PHT_PT_C4_TCO                                              0x04
#define PHT_PT_C5_TREF                                             0x05
#define PHT_PT_C6_TEMPSENS                                         0x06
#define PHT_PT_CRC                                                 0x07
 
#define PHT_SENSOR_TYPE_RH                                         0x00
#define PHT_SENSOR_TYPE_PT                                         0x01
 
#define PHT_I2C_SLAVE_ADDR_RH                                      0x40
#define PHT_I2C_SLAVE_ADDR_P_AND_T                                 0x76
 
 
 // pht_set
 
#define PHT_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // pht_map
 // pht
 
typedef struct
{
    // Modules
    i2c_master_t i2c;                                
    // I2C slave address
    uint8_t slave_address;                           
} pht_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;                                
    uint8_t   i2c_address;                              
} pht_cfg_t;
 
typedef enum
{
   PHT_OK = 0,
   PHT_ERROR = -1
 
} pht_return_value_t;
 
void pht_cfg_setup ( pht_cfg_t *cfg );
 
err_t pht_init ( pht_t *ctx, pht_cfg_t *cfg );
 
err_t pht_generic_write ( pht_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t pht_generic_read ( pht_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
 
void pht_set_command ( pht_t *ctx, uint8_t sensor_type, uint8_t cmd );
 
void pht_soft_reset ( pht_t *ctx, uint8_t sensor_type );
 
uint8_t pht_get_prom ( pht_t *ctx, uint8_t sel_data, uint32_t *tx_data );
 
uint8_t pht_set_ratio ( pht_t *ctx, uint8_t temp_ratio, uint8_t press_ratio );
 
void pht_reset ( pht_t *ctx );
 
void pht_write_user_register ( pht_t *ctx, uint8_t tx_data );
 
uint8_t pht_read_user_register ( pht_t *ctx );
 
uint8_t pht_measure_rh ( pht_t *ctx, uint16_t *rh_data );
 
void pht_get_temperature_pressure ( pht_t *ctx, float *temperature, float *pressure );
 
void pht_get_relative_humidity ( pht_t *ctx, float *humidity );
 
#ifdef __cplusplus
}
#endif
#endif // PHT_H
 
 // pht
 
// ------------------------------------------------------------------------ END