esp32/i2c_sh3x33/components/i2c_sht3x/include/i2c_sht3x.h

#ifndef __I2C_SHT3X_H__
#define __I2C_SHT3X_H__


#include "driver/i2c.h"
#include "esp_log.h"

#define SHT3X_TICKS_TO_WAIT           (100 / portTICK_RATE_MS)    // I2C读写的超时等待时间

#define SHT3X_I2C_BUS                 I2C_NUM_0 // SHT30所在的I2C总线

#define SHT3X_SLAVE_ADDRESS           0x44    // SHT30在I2C总线上的从机器件地址

// SHT30命令列表
typedef enum
{
    /* 软件复位命令 */

    SOFT_RESET_CMD = 0x30A2,    
    /*
    单次测量模式
    命名格式：Repeatability_CS_CMD
    CS：Clock stretching
    */
    HIGH_ENABLED_CMD    = 0x2C06,
    MEDIUM_ENABLED_CMD  = 0x2C0D,
    LOW_ENABLED_CMD     = 0x2C10,
    HIGH_DISABLED_CMD   = 0x2400,
    MEDIUM_DISABLED_CMD = 0x240B,
    LOW_DISABLED_CMD    = 0x2416,

    /*
    周期测量模式
    命名格式：Repeatability_MPS_CMD
    MPS：measurement per second
    */
    HIGH_0_5_CMD   = 0x2032,
    MEDIUM_0_5_CMD = 0x2024,
    LOW_0_5_CMD    = 0x202F,
    HIGH_1_CMD     = 0x2130,
    MEDIUM_1_CMD   = 0x2126,
    LOW_1_CMD      = 0x212D,
    HIGH_2_CMD     = 0x2236,
    MEDIUM_2_CMD   = 0x2220,
    LOW_2_CMD      = 0x222B,
    HIGH_4_CMD     = 0x2334,
    MEDIUM_4_CMD   = 0x2322,
    LOW_4_CMD      = 0x2329,
    HIGH_10_CMD    = 0x2737,
    MEDIUM_10_CMD  = 0x2721,
    LOW_10_CMD     = 0x272A,
    /* 周期测量模式读取数据命令 */
    READOUT_FOR_PERIODIC_MODE = 0xE000,
} SHT30_CMD;


/**
 * @brief    复位SHT3X
 * 
 * @param    none
 * 
 * @retval    none
*/
void sht3x_reset(void);

/**
 * @brief    初始化SHT3X
 * 
 * @param    none
 * 
 * @retval    成功返回HAL_OK(ESP_OK)
 * 
 * @note    周期测量模式
*/
esp_err_t sht3x_init(void);

/**
 * @brief    从SHT3X读取一次数据
 * 
 * @param    dat —— 存储读取数据的地址（6个字节数组）
 * 
 * @retval    成功 —— 返回HAL_OK(ESP_OK)
*/
uint8_t sht3x_read_dat(uint8_t* dat);

/**
 * @brief    将SHT3X接收的6个字节数据进行CRC校验，并转换为温度值和湿度值
 * 
 * @param    dat  —— 存储接收数据的地址（6个字节数组）
 * 
 * @retval    校验成功  —— 返回0
 *            校验失败  —— 返回1，并设置温度值和湿度值为0
*/
uint8_t sht3x_dat2float(uint8_t* const dat, float* temperature, float* humidity);
esp_err_t sht3x_read_th_raw_dat(uint8_t* dat);


#endif