driver_sts3x.h

Go to the documentation of this file.

 
#ifndef DRIVER_STS3X_H
#define DRIVER_STS3X_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    STS3X_ADDRESS_0 = (0x4A << 1),        
    STS3X_ADDRESS_1 = (0x4B << 1),        
} sts3x_address_t;

typedef enum
{
    STS3X_BOOL_FALSE = 0x00,        
    STS3X_BOOL_TRUE  = 0x01,        
} sts3x_bool_t;

typedef enum
{
    STS3X_RATE_0P5HZ = 0x20,        
    STS3X_RATE_1HZ   = 0x21,        
    STS3X_RATE_2HZ   = 0x22,        
    STS3X_RATE_4HZ   = 0x23,        
    STS3X_RATE_10HZ  = 0x27,        
} sts3x_rate_t;

typedef enum  
{
    STS3X_REPEATABILITY_HIGH   = 0x00,        
    STS3X_REPEATABILITY_MEDIUM = 0x01,        
    STS3X_REPEATABILITY_LOW    = 0x02,        
} sts3x_repeatability_t;

typedef enum  
{
    STS3X_STATUS_ALERT_PENDING_STATUS = (1 << 15),        
    STS3X_STATUS_HEATER_ON            = (1 << 13),        
    STS3X_STATUS_TEMPERATURE_ALERT    = (1 << 10),        
    STS3X_STATUS_SYSTEM_RESET         = (1 << 4),         
    STS3X_STATUS_COMMAND_STATUS       = (1 << 1),         
    STS3X_STATUS_CHECKSUM_STATUS      = (1 << 0),         
} sts3x_status_t;

typedef struct sts3x_handle_s
{
    uint8_t (*iic_init)(void);                                                                     
    uint8_t (*iic_deinit)(void);                                                                   
    uint8_t (*iic_write_address16)(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*iic_read_address16)(uint8_t addr, uint16_t reg, uint8_t *buf, uint16_t len);         
    void (*delay_ms)(uint32_t ms);                                                                 
    void (*debug_print)(const char *const fmt, ...);                                               
    uint8_t iic_addr;                                                                              
    uint8_t repeatability;                                                                         
    uint8_t inited;                                                                                
} sts3x_handle_t;

typedef struct sts3x_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} sts3x_info_t;



#define DRIVER_STS3X_LINK_INIT(HANDLE, STRUCTURE)            memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_STS3X_LINK_IIC_INIT(HANDLE, FUC)              (HANDLE)->iic_init = FUC

#define DRIVER_STS3X_LINK_IIC_DEINIT(HANDLE, FUC)            (HANDLE)->iic_deinit = FUC

#define DRIVER_STS3X_LINK_IIC_READ_ADDRESS16(HANDLE, FUC)    (HANDLE)->iic_read_address16 = FUC

#define DRIVER_STS3X_LINK_IIC_WRITE_ADDRESS16(HANDLE, FUC)   (HANDLE)->iic_write_address16 = FUC

#define DRIVER_STS3X_LINK_DELAY_MS(HANDLE, FUC)              (HANDLE)->delay_ms = FUC

#define DRIVER_STS3X_LINK_DEBUG_PRINT(HANDLE, FUC)           (HANDLE)->debug_print = FUC



uint8_t sts3x_info(sts3x_info_t *info);

uint8_t sts3x_set_addr_pin(sts3x_handle_t *handle, sts3x_address_t addr_pin);

uint8_t sts3x_get_addr_pin(sts3x_handle_t *handle, sts3x_address_t *addr_pin);

uint8_t sts3x_init(sts3x_handle_t *handle);

uint8_t sts3x_deinit(sts3x_handle_t *handle);

uint8_t sts3x_single_read(sts3x_handle_t *handle, sts3x_bool_t clock_stretching_enable, 
                          uint16_t *temperature_raw, float *temperature_s);

uint8_t sts3x_start_continuous_read(sts3x_handle_t *handle, sts3x_rate_t rate);

uint8_t sts3x_stop_continuous_read(sts3x_handle_t *handle);

uint8_t sts3x_continuous_read(sts3x_handle_t *handle, uint16_t *temperature_raw, float *temperature_s);

uint8_t sts3x_get_status(sts3x_handle_t *handle, uint16_t *status);

uint8_t sts3x_clear_status(sts3x_handle_t *handle);

uint8_t sts3x_set_repeatability(sts3x_handle_t *handle, sts3x_repeatability_t repeatability);

uint8_t sts3x_get_repeatability(sts3x_handle_t *handle, sts3x_repeatability_t *repeatability);

uint8_t sts3x_soft_reset(sts3x_handle_t *handle);

uint8_t sts3x_set_heater(sts3x_handle_t *handle, sts3x_bool_t enable);



uint8_t sts3x_set_reg(sts3x_handle_t *handle, uint16_t command);

uint8_t sts3x_get_reg(sts3x_handle_t *handle, uint16_t command, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif