sht1x.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 SHT1X_H
#define SHT1X_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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define SHT1X_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl= MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda= MIKROBUS( mikrobus, MIKROBUS_SDA )
 
#define SHT1X_RETVAL  uint8_t
 
#define SHT1X_OK           0x00
#define SHT1X_INIT_ERROR   0xFF
#define SHT1X_MEAS_TEMP                         0x03
#define SHT1X_MEAS_HUMI                         0x05
#define SHT1X_STAT_REG_W                        0x06
#define SHT1X_STAT_REG_R                        0x07
#define SHT1X_SOFT_RESET                        0x1E
#define SHT1X_SR_MASK                           0x07
#define SHT1X_NACK                              0
#define SHT1X_ACK                               1
#define SHT1X_D1                                  -40.1     
#define SHT1X_D2h                                   0.01    
#define SHT1X_D2l                                   0.04    
#define SHT1X_V3_C1                               -4.0000  
#define SHT1X_V3_C2h                               0.0405   
#define SHT1X_V3_C3h                              -2.8000E-6
#define SHT1X_V3_C2l                               0.6480   
#define SHT1X_V3_C3l                              -7.2000E-4
#define SHT1X_V4_C1                               -2.0468   
#define SHT1X_V4_C2h                               0.0367   
#define SHT1X_V4_C3h                              -1.5955E-6
#define SHT1X_V4_C2l                               0.5872   
#define SHT1X_V4_C3l                              -4.0845E-4
#define SHT1X_T1                                   0.01     
#define SHT1X_T2h                                  0.00008  
#define SHT1X_T2l                                  0.00128  
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
   digital_out_t scl;
   digital_out_t sda;
 
} sht1x_t;
 
typedef struct
{
    // Additional gpio pins 
 
   pin_name_t scl;
   pin_name_t sda;
 
} sht1x_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void sht1x_cfg_setup ( sht1x_cfg_t *cfg );
 
SHT1X_RETVAL sht1x_init ( sht1x_t *ctx, sht1x_cfg_t *cfg );
 
void sht1x_output_sda ( sht1x_t *ctx, sht1x_cfg_t *cfg );
 
void sht1x_input_sda ( sht1x_t *ctx, sht1x_cfg_t *cfg );
 
void sht1x_sda_high ( sht1x_t *ctx );
 
void sht1x_sda_low ( sht1x_t *ctx );
 
uint8_t sht1x_get_sda ( sht1x_t *ctx );
 
void sht1x_scl_high ( sht1x_t *ctx );
 
void sht1x_scl_low ( sht1x_t *ctx );
 
float sht1x_calc_temp ( sht1x_t *ctx, uint16_t t );
 
float sht1x_calc_humi ( sht1x_t *ctx, uint16_t h, uint16_t t );
 
#ifdef __cplusplus
}
#endif
#endif  // _SHT1X_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END