sht2x.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016-2018 Kees Bakker, SODAQ
 * SPDX-FileCopyrightText: 2017 George Psimenos
 * SPDX-FileCopyrightText: 2018 Steffen Robertz
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <stdbool.h>
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum {
    SHT2X_OK            =  0,           
    SHT2X_ERR_I2C       = -1,           
    SHT2X_ERR_NODEV     = -2,           
    SHT2X_ERR_NOCAL     = -3,           
    SHT2X_ERR_I2C_READ  = -4,           
    SHT2X_ERR_TIMEDOUT  = -5,           
    SHT2X_ERR_CRC       = -6,           
    SHT2X_ERR_USERREG   = -7,           
    SHT2X_ERR_RES       = -8,           
    SHT2X_ERR_OTHER     = -999,         
};

typedef enum {
    SHT2X_RES_12_14BIT  = 0x00,         
    SHT2X_RES_8_12BIT   = 0x01,         
    SHT2X_RES_10_13BIT  = 0x80,         
    SHT2X_RES_11_11BIT  = 0x81,         
} sht2x_res_t;

typedef enum {
    SHT2X_MEASURE_MODE_HOLD = 0,        
    SHT2X_MEASURE_MODE_NO_HOLD = 1      
} sht2x_measure_mode_t;

#define SHT2X_USER_RESOLUTION_MASK          0x81
#define SHT2X_USER_EOB_MASK                 0x40
#define SHT2X_USER_HEATER_MASK              0x04
#define SHT2X_USER_RESERVED_MASK            0x38
#define SHT2X_USER_OTP_MASK                 0x02

typedef struct {
    i2c_t i2c_dev;                      
    uint8_t i2c_addr;                   
    sht2x_res_t resolution;             
    sht2x_measure_mode_t measure_mode;  
    bool is_crc_enabled;                
} sht2x_params_t;

typedef struct {
    sht2x_params_t params;              
} sht2x_t;

int sht2x_init(sht2x_t* dev, const sht2x_params_t* params);

int sht2x_reset(sht2x_t* dev);

int16_t sht2x_read_temperature(const sht2x_t* dev);

uint16_t sht2x_read_humidity(const sht2x_t *dev);

int sht2x_read_ident(const sht2x_t *dev, uint8_t *buffer, size_t buflen);

int sht2x_read_userreg(const sht2x_t *dev, uint8_t *userreg);

int sht2x_write_userreg(const sht2x_t *dev, uint8_t userreg);
 
#ifdef __cplusplus
}
#endif