driver_sen5x.h

Go to the documentation of this file.

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



typedef enum
{
    SEN50 = 0x00,        
    SEN54 = 0x01,        
    SEN55 = 0x02,        
} sen5x_type_t;

typedef enum
{
    SEN5X_DATA_READY_FLAG_NOT_READY = 0x00,        
    SEN5X_DATA_READY_FLAG_AVAILABLE = 0x01,        
} sen5x_data_ready_flag_t;

typedef enum
{
    SEN5X_STATUS_FAN_SPEED_ERROR     = (1 << 21),       
    SEN5X_STATUS_FAN_CLEANING_ACTIVE = (1 << 19),       
    SEN5X_STATUS_GAS_ERROR           = (1 << 7),        
    SEN5X_STATUS_RHT_ERROR           = (1 << 6),        
    SEN5X_STATUS_LASER_ERROR         = (1 << 5),        
    SEN5X_STATUS_FAN_ERROR           = (1 << 4),        
} sen5x_status_t;

typedef enum
{
    SEN5X_RHT_ACCELERATION_LOW    = 0,       
    SEN5X_RHT_ACCELERATION_HIGH   = 1,       
    SEN5X_RHT_ACCELERATION_MEDIUM = 2,       
} sen5x_rht_acceleration_mode_t;

typedef struct sen55_data_s
{
    uint16_t pm1p0_raw;                                  
    uint16_t pm2p5_raw;                                  
    uint16_t pm4p0_raw;                                  
    uint16_t pm10_raw;                                   
    int16_t compensated_ambient_humidity_raw;            
    int16_t compensated_ambient_temperature_raw;         
    int16_t voc_raw;                                     
    int16_t nox_raw;                                     
    uint8_t pm_valid;                                    
    float pm1p0_ug_m3;                                   
    float pm2p5_ug_m3;                                   
    float pm4p0_ug_m3;                                   
    float pm10_ug_m3;                                    
    float compensated_ambient_humidity_percentage;       
    float compensated_ambient_temperature_degree;        
    float voc_index;                                     
    float nox_index;                                     
} sen55_data_t;

typedef struct sen54_data_s
{
    uint16_t pm1p0_raw;                                  
    uint16_t pm2p5_raw;                                  
    uint16_t pm4p0_raw;                                  
    uint16_t pm10_raw;                                   
    int16_t compensated_ambient_humidity_raw;            
    int16_t compensated_ambient_temperature_raw;         
    int16_t voc_raw;                                     
    uint8_t pm_valid;                                    
    float pm1p0_ug_m3;                                   
    float pm2p5_ug_m3;                                   
    float pm4p0_ug_m3;                                   
    float pm10_ug_m3;                                    
    float compensated_ambient_humidity_percentage;       
    float compensated_ambient_temperature_degree;        
    float voc_index;                                     
} sen54_data_t;

typedef struct sen50_data_s
{
    uint16_t pm1p0_raw;        
    uint16_t pm2p5_raw;        
    uint16_t pm4p0_raw;        
    uint16_t pm10_raw;         
    uint8_t pm_valid;          
    float pm1p0_ug_m3;         
    float pm2p5_ug_m3;         
    float pm4p0_ug_m3;         
    float pm10_ug_m3;          
} sen50_data_t;

typedef struct sen5x_pm_s
{
    uint16_t mass_concentration_pm1p0_raw;          
    uint16_t mass_concentration_pm2p5_raw;          
    uint16_t mass_concentration_pm4p0_raw;          
    uint16_t mass_concentration_pm10_raw;           
    uint16_t number_concentration_pm0p5_raw;        
    uint16_t number_concentration_pm1p0_raw;        
    uint16_t number_concentration_pm2p5_raw;        
    uint16_t number_concentration_pm4p0_raw;        
    uint16_t number_concentration_pm10_raw;         
    uint16_t typical_particle_raw;                  
    uint8_t pm_valid;                               
    float pm1p0_ug_m3;                              
    float pm2p5_ug_m3;                              
    float pm4p0_ug_m3;                              
    float pm10_ug_m3;                               
    float pm0p5_cm3;                                
    float pm1p0_cm3;                                
    float pm2p5_cm3;                                
    float pm4p0_cm3;                                
    float pm10_cm3;                                 
    float typical_particle_um;                      
} sen5x_pm_t;

typedef struct sen5x_raw_s
{
    int16_t humidity_raw;             
    int16_t temperature_raw;          
    uint16_t voc_raw;                 
    uint16_t nox_raw;                 
    float humidity_percentage;        
    float temperature_degree;         
    float voc;                        
    float nox;                        
} sen5x_raw_t;

typedef struct sen5x_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 type;                                                             
    uint8_t inited;                                                           
} sen5x_handle_t;

typedef struct sen5x_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;           
} sen5x_info_t;



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

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

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

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

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

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

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



uint8_t sen5x_info(sen5x_info_t *info);

uint8_t sen5x_set_type(sen5x_handle_t *handle, sen5x_type_t type);

uint8_t sen5x_get_type(sen5x_handle_t *handle, sen5x_type_t *type);

uint8_t sen5x_init(sen5x_handle_t *handle);

uint8_t sen5x_deinit(sen5x_handle_t *handle);

uint8_t sen5x_start_measurement(sen5x_handle_t *handle);

uint8_t sen5x_start_measurement_without_pm(sen5x_handle_t *handle);

uint8_t sen5x_stop_measurement(sen5x_handle_t *handle);

uint8_t sen5x_read_data_flag(sen5x_handle_t *handle, sen5x_data_ready_flag_t *flag);

uint8_t sen55_read(sen5x_handle_t *handle, sen55_data_t *output);

uint8_t sen54_read(sen5x_handle_t *handle, sen54_data_t *output);

uint8_t sen50_read(sen5x_handle_t *handle, sen50_data_t *output);

uint8_t sen5x_read_pm_value(sen5x_handle_t *handle, sen5x_pm_t *pm);

uint8_t sen5x_read_raw_value(sen5x_handle_t *handle, sen5x_raw_t *raw);

uint8_t sen5x_set_temperature_compensation(sen5x_handle_t *handle, int16_t temperature_offset,
                                           int16_t normalized_temperature_offset_slope,
                                           uint16_t time_constant);

uint8_t sen5x_get_temperature_compensation(sen5x_handle_t *handle, int16_t *temperature_offset,
                                           int16_t *normalized_temperature_offset_slope,
                                           uint16_t *time_constant);

uint8_t sen5x_temperature_compensation_convert_to_register(sen5x_handle_t *handle,
                                                           float temperature_offset_degree,
                                                           float normalized_temperature_offset_slope_factor,
                                                           float time_constant_second,
                                                           int16_t *temperature_offset_reg,
                                                           int16_t *normalized_temperature_offset_slope_reg,
                                                           uint16_t *time_constant_reg);

uint8_t sen5x_temperature_compensation_convert_to_data(sen5x_handle_t *handle,
                                                       int16_t temperature_offset_reg,
                                                       int16_t normalized_temperature_offset_slope_reg,
                                                       uint16_t time_constant_reg,
                                                       float *temperature_offset_degree,
                                                       float *normalized_temperature_offset_slope_factor,
                                                       float *time_constant_second);

uint8_t sen5x_set_warm_start(sen5x_handle_t *handle, uint16_t param);

uint8_t sen5x_get_warm_start(sen5x_handle_t *handle, uint16_t *param);

uint8_t sen5x_set_voc_algorithm_tuning(sen5x_handle_t *handle, int16_t index_offset,
                                       int16_t learning_time_offset_hour,
                                       int16_t learning_time_gain_hour,
                                       int16_t gating_max_duration_minute,
                                       int16_t std_initial,
                                       int16_t gain_factor);

uint8_t sen5x_get_voc_algorithm_tuning(sen5x_handle_t *handle, int16_t *index_offset,
                                       int16_t *learning_time_offset_hour,
                                       int16_t *learning_time_gain_hour,
                                       int16_t *gating_max_duration_minute,
                                       int16_t *std_initial,
                                       int16_t *gain_factor);

uint8_t sen5x_set_nox_algorithm_tuning(sen5x_handle_t *handle, int16_t index_offset,
                                       int16_t learning_time_offset_hour,
                                       int16_t learning_time_gain_hour,
                                       int16_t gating_max_duration_minute,
                                       int16_t std_initial,
                                       int16_t gain_factor);

uint8_t sen5x_get_nox_algorithm_tuning(sen5x_handle_t *handle, int16_t *index_offset,
                                       int16_t *learning_time_offset_hour,
                                       int16_t *learning_time_gain_hour,
                                       int16_t *gating_max_duration_minute,
                                       int16_t *std_initial,
                                       int16_t *gain_factor);

uint8_t sen5x_set_rht_acceleration_mode(sen5x_handle_t *handle, sen5x_rht_acceleration_mode_t mode);

uint8_t sen5x_get_rht_acceleration_mode(sen5x_handle_t *handle, sen5x_rht_acceleration_mode_t *mode);

uint8_t sen5x_set_voc_algorithm_state(sen5x_handle_t *handle, uint16_t state[4]);

uint8_t sen5x_get_voc_algorithm_state(sen5x_handle_t *handle, uint16_t state[4]);

uint8_t sen5x_start_fan_cleaning(sen5x_handle_t *handle);

uint8_t sen5x_set_auto_cleaning_interval(sen5x_handle_t *handle, uint32_t second);

uint8_t sen5x_get_auto_cleaning_interval(sen5x_handle_t *handle, uint32_t *second);

uint8_t sen5x_disable_auto_cleaning_interval(sen5x_handle_t *handle);

uint8_t sen5x_get_product_name(sen5x_handle_t *handle, char name[32]);

uint8_t sen5x_get_serial_number(sen5x_handle_t *handle, char sn[32]);

uint8_t sen5x_get_version(sen5x_handle_t *handle, uint8_t *version);

uint8_t sen5x_get_device_status(sen5x_handle_t *handle, uint32_t *status);

uint8_t sen5x_clear_device_status(sen5x_handle_t *handle);

uint8_t sen5x_reset(sen5x_handle_t *handle);



uint8_t sen5x_set_reg(sen5x_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);

uint8_t sen5x_get_reg(sen5x_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif