driver_stcc4.h

Go to the documentation of this file.

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



typedef enum
{
    STCC4_ADDRESS_0 = (0x64 << 1),        
    STCC4_ADDRESS_1 = (0x65 << 1),        
} stcc4_address_t;

typedef enum
{
    STCC4_BOOL_FALSE = 0x00,        
    STCC4_BOOL_TRUE  = 0x01,        
} stcc4_bool_t;

typedef struct stcc4_handle_s
{
    uint8_t iic_addr;                                                          
    uint8_t (*iic_init)(void);                                                 
    uint8_t (*iic_deinit)(void);                                               
    uint8_t (*iic_write_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);        
    uint8_t (*iic_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);         
    void (*delay_ms)(uint32_t ms);                                             
    void (*debug_print)(const char *const fmt, ...);                           
    uint8_t inited;                                                            
    uint8_t type;                                                              
} stcc4_handle_t;

typedef struct stcc4_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;           
} stcc4_info_t;



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

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

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

#define DRIVER_STCC4_LINK_IIC_READ_COMMAND(HANDLE, FUC)      (HANDLE)->iic_read_cmd = FUC

#define DRIVER_STCC4_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)     (HANDLE)->iic_write_cmd = FUC

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

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



uint8_t stcc4_info(stcc4_info_t *info);

uint8_t stcc4_set_address_pin(stcc4_handle_t *handle, stcc4_address_t address);

uint8_t stcc4_get_address_pin(stcc4_handle_t *handle, stcc4_address_t *address);

uint8_t stcc4_init(stcc4_handle_t *handle);

uint8_t stcc4_deinit(stcc4_handle_t *handle);

uint8_t stcc4_read(stcc4_handle_t *handle, int16_t *co2_raw, int16_t *co2_ppm,
                   uint16_t *temperature_raw, float *temperature_s,
                   uint16_t *humidity_raw, float *humidity_s, uint16_t *sensor_status);

uint8_t stcc4_start_continuous_measurement(stcc4_handle_t *handle);

uint8_t stcc4_stop_continuous_measurement(stcc4_handle_t *handle);

uint8_t stcc4_set_rht_compensation(stcc4_handle_t *handle, uint16_t temperature_raw, uint16_t humidity_raw);

uint8_t stcc4_set_pressure_compensation(stcc4_handle_t *handle, uint16_t pressure_raw);

uint8_t stcc4_measure_single_shot(stcc4_handle_t *handle);

uint8_t stcc4_enter_sleep_mode(stcc4_handle_t *handle);

uint8_t stcc4_exit_sleep_mode(stcc4_handle_t *handle);

uint8_t stcc4_perform_conditioning(stcc4_handle_t *handle);

uint8_t stcc4_perform_soft_reset(stcc4_handle_t *handle);

uint8_t stcc4_perform_factory_reset(stcc4_handle_t *handle);

uint8_t stcc4_perform_self_test(stcc4_handle_t *handle, uint16_t *result);

uint8_t stcc4_enable_testing_mode(stcc4_handle_t *handle);

uint8_t stcc4_disable_testing_mode(stcc4_handle_t *handle);

uint8_t stcc4_perform_forced_recalibration(stcc4_handle_t *handle, uint16_t target_co2, uint16_t *correct_co2);

uint8_t stcc4_get_product_id(stcc4_handle_t *handle, uint32_t *product_id, uint8_t unique_serial_number[8]);

uint8_t stcc4_frc_co2_convert_to_register(stcc4_handle_t *handle, float ppm, uint16_t *reg);

uint8_t stcc4_frc_co2_convert_to_data(stcc4_handle_t *handle, uint16_t reg, float *ppm);

uint8_t stcc4_humidity_convert_to_register(stcc4_handle_t *handle, float percentage, uint16_t *reg);

uint8_t stcc4_humidity_convert_to_data(stcc4_handle_t *handle, uint16_t reg, float *percentage);

uint8_t stcc4_temperature_convert_to_register(stcc4_handle_t *handle, float deg, uint16_t *reg);

uint8_t stcc4_temperature_convert_to_data(stcc4_handle_t *handle, uint16_t reg, float *deg);

uint8_t stcc4_pressure_convert_to_register(stcc4_handle_t *handle, float pa, uint16_t *reg);

uint8_t stcc4_pressure_convert_to_data(stcc4_handle_t *handle, uint16_t reg, float *pa);



uint8_t stcc4_set_reg(stcc4_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);

uint8_t stcc4_get_reg(stcc4_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len, uint16_t delay_ms);


 
#ifdef __cplusplus
}
#endif
 
#endif