sht.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 SHT_H
#define SHT_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define SHT_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define SHT_OK                  0x00
#define SHT_ERROR               0xFF
#define SHT_I2C_ADDR0           0x44
#define SHT_I2C_ADDR1           0x45
 
#define SHT_MPS_05              0x20    // 0.5 measurements per second
#define SHT_MPS_1               0x21    // 1 measurements per second
#define SHT_MPS_2               0x22    // 2 measurements per second
#define SHT_MPS_4               0x23    // 4 measurements per second
#define SHT_MPS_10              0x27    // 10 measurements per second
#define SHT_RPT_HIGH            0       // High repeatability
#define SHT_RPT_MEDIUM          1       // Medium repeatability
#define SHT_RPT_LOW             2       // Low repeatability
#define SHT_STR_ENABLE          0x2C    // Stretching enabled
#define SHT_STR_DISABLE         0x24    // Stretching disabled
#define SHT_CRC_POLYNOMIAL      0x31
#define SHT_FETCH_DATA          0xE000
#define SHT_PERIODIC_ART        0x2B32
#define SHT_BREAK               0x3093
#define SHT_SOFT_RESET          0x30A2
#define SHT_HEATER              0x30
#define SHT_READ_STATUS         0xF32D
#define SHT_CLEAR_STATUS1       0x3041
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    uint8_t clk_stretching;
    uint8_t repeatability;
    uint8_t mps;
 
} drv_variables_t;
 
typedef struct
{
    // Output pins 
    digital_out_t rst;
 
    // Input pins 
    digital_in_t int_pin;
    
    // Modules 
    i2c_master_t i2c;
 
    // ctx variable 
    uint8_t slave_address;
 
    // driver variables
    drv_variables_t vars;
 
} sht_t;
 
typedef struct
{
    // Communication gpio pins 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
    pin_name_t rst;
    pin_name_t int_pin;
 
    // static variable 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
    // driver variables config
    drv_variables_t vars_cfg;
 
} sht_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void sht_cfg_setup ( sht_cfg_t *cfg );
 
err_t sht_init ( sht_t *ctx, sht_cfg_t *cfg );
 
void sht_generic_write ( sht_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void sht_generic_read ( sht_t *ctx, uint8_t *reg, uint8_t *data_buf, uint8_t len );
 
void sht_reset ( sht_t *ctx );
 
void sht_hw_reset ( sht_t *ctx );
 
uint8_t sht_int_get ( sht_t *ctx );
 
void sht_rst_set ( sht_t *ctx, uint8_t state );
 
void sht_set_clk_strecth ( sht_t *ctx, uint8_t clk_stretching );
 
void sht_set_repeats ( sht_t *ctx, uint8_t repeatability );
 
void sht_set_mps ( sht_t *ctx, uint8_t measure_per_second );
 
float sht_temp_ss ( sht_t *ctx );
 
float sht_hum_ss ( sht_t *ctx );
 
void sht_start_pm ( sht_t *ctx );
 
float sht_temp_pm ( sht_t *ctx );
 
float sht_hum_pm ( sht_t *ctx );
 
void sht_stop_pm ( sht_t *ctx );
 
void sht_software_rst ( sht_t *ctx );
 
void sht_heater_control ( sht_t *ctx, uint8_t state );
 
void sht_clear_status ( sht_t *ctx );
 
uint8_t sht_alert_status ( sht_t *ctx );
 
uint8_t sht_heater_status ( sht_t *ctx );
 
uint8_t sht_hum_status ( sht_t *ctx );
 
uint8_t sht_temp_status ( sht_t *ctx );
 
uint8_t sht_reset_status ( sht_t *ctx );
 
uint8_t sht_cmd_status ( sht_t *ctx );
 
uint8_t sht_wr_chksum_status ( sht_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _SHT_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END