driver_scd4x.h

Go to the documentation of this file.

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



typedef enum
{
    SCD40 = 0x00,        
    SCD41 = 0x01,        
    SCD43 = 0x02,        
} scd4x_t;

typedef enum
{
    SCD4X_BOOL_FALSE = 0x00,        
    SCD4X_BOOL_TRUE  = 0x01,        
} scd4x_bool_t;

typedef struct scd4x_handle_s
{
    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;                                                              
} scd4x_handle_t;

typedef struct scd4x_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;           
} scd4x_info_t;



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

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

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

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

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

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

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



uint8_t scd4x_info(scd4x_info_t *info);

uint8_t scd4x_set_type(scd4x_handle_t *handle, scd4x_t type);

uint8_t scd4x_get_type(scd4x_handle_t *handle, scd4x_t *type);

uint8_t scd4x_init(scd4x_handle_t *handle);

uint8_t scd4x_deinit(scd4x_handle_t *handle);

uint8_t scd4x_start_periodic_measurement(scd4x_handle_t *handle);

uint8_t scd4x_read(scd4x_handle_t *handle, uint16_t *co2_raw, uint16_t *co2_ppm,
                   uint16_t *temperature_raw, float *temperature_s,
                   uint16_t *humidity_raw, float *humidity_s);

uint8_t scd4x_stop_periodic_measurement(scd4x_handle_t *handle);

uint8_t scd4x_set_temperature_offset(scd4x_handle_t *handle, uint16_t offset);

uint8_t scd4x_get_temperature_offset(scd4x_handle_t *handle, uint16_t *offset);

uint8_t scd4x_temperature_offset_convert_to_register(scd4x_handle_t *handle, float degrees, uint16_t *reg);

uint8_t scd4x_temperature_offset_convert_to_data(scd4x_handle_t *handle, uint16_t reg, float *degrees);

uint8_t scd4x_set_sensor_altitude(scd4x_handle_t *handle, uint16_t altitude);

uint8_t scd4x_get_sensor_altitude(scd4x_handle_t *handle, uint16_t *altitude);

uint8_t scd4x_sensor_altitude_convert_to_register(scd4x_handle_t *handle, float m, uint16_t *reg);

uint8_t scd4x_sensor_altitude_convert_to_data(scd4x_handle_t *handle, uint16_t reg, float *m);

uint8_t scd4x_set_ambient_pressure(scd4x_handle_t *handle, uint16_t pressure);

uint8_t scd4x_get_ambient_pressure(scd4x_handle_t *handle, uint16_t *pressure);

uint8_t scd4x_ambient_pressure_convert_to_register(scd4x_handle_t *handle, float pa, uint16_t *reg);

uint8_t scd4x_ambient_pressure_convert_to_data(scd4x_handle_t *handle, uint16_t reg, float *pa);

uint8_t scd4x_perform_forced_recalibration(scd4x_handle_t *handle, uint16_t co2_raw, uint16_t *frc);

uint8_t scd4x_co2_convert_to_register(scd4x_handle_t *handle, float ppm, uint16_t *reg);

uint8_t scd4x_co2_convert_to_data(scd4x_handle_t *handle, uint16_t reg, float *ppm);

uint8_t scd4x_set_automatic_self_calibration(scd4x_handle_t *handle, scd4x_bool_t enable);

uint8_t scd4x_get_automatic_self_calibration(scd4x_handle_t *handle, scd4x_bool_t *enable);

uint8_t scd4x_start_low_power_periodic_measurement(scd4x_handle_t *handle);

uint8_t scd4x_get_data_ready_status(scd4x_handle_t *handle, scd4x_bool_t *enable);

uint8_t scd4x_persist_settings(scd4x_handle_t *handle);

uint8_t scd4x_get_serial_number(scd4x_handle_t *handle, uint16_t number[3]);

uint8_t scd4x_perform_self_test(scd4x_handle_t *handle, scd4x_bool_t *malfunction_detected);

uint8_t scd4x_perform_factory_reset(scd4x_handle_t *handle);

uint8_t scd4x_reinit(scd4x_handle_t *handle);



uint8_t scd4x_measure_single_shot(scd4x_handle_t *handle);

uint8_t scd4x_measure_single_shot_rht_only(scd4x_handle_t *handle);

uint8_t scd4x_power_down(scd4x_handle_t *handle);

uint8_t scd4x_wake_up(scd4x_handle_t *handle);

uint8_t scd4x_set_automatic_self_calibration_initial_period(scd4x_handle_t *handle, uint16_t hour);

uint8_t scd4x_get_automatic_self_calibration_initial_period(scd4x_handle_t *handle, uint16_t *hour);

uint8_t scd4x_set_automatic_self_calibration_standard_period(scd4x_handle_t *handle, uint16_t hour);

uint8_t scd4x_get_automatic_self_calibration_standard_period(scd4x_handle_t *handle, uint16_t *hour);



uint8_t scd4x_set_reg(scd4x_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);

uint8_t scd4x_get_reg(scd4x_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len, uint16_t delay_ms);


 
#ifdef __cplusplus
}
#endif
 
#endif