driver_sgp41_algorithm.h

Go to the documentation of this file.

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


#define SGP41_ALGORITHM_TYPE_VOC        (0)        
#define SGP41_ALGORITHM_TYPE_NOX        (1)        

typedef struct sgp41_gas_index_algorithm_s
{
    uint8_t m_algorithm_type;                                       
    float m_sampling_interval;                                      
    float m_index_offset;                                           
    int32_t m_sraw_minimum;                                         
    float m_gating_max_duration_minutes;                            
    float m_init_duration_mean;                                     
    float m_init_duration_variance;                                 
    float m_gating_threshold;                                       
    float m_index_gain;                                             
    float m_tau_mean_hours;                                         
    float m_tau_variance_hours;                                     
    float m_sraw_std_initial;                                       
    float m_uptime;                                                 
    float m_sraw;                                                   
    float m_gas_index;                                              
    uint8_t m_mean_variance_estimator_initialized;                  
    float m_mean_variance_estimator_mean;                           
    float m_mean_variance_estimator_sraw_offset;                    
    float m_mean_variance_estimator_std;                            
    float m_mean_variance_estimator_gamma_mean;                     
    float m_mean_variance_estimator_gamma_variance;                 
    float m_mean_variance_estimator_gamma_initial_mean;             
    float m_mean_variance_estimator_gamma_initial_variance;         
    float m_mean_variance_estimator_n_gamma_mean;                   
    float m_mean_variance_estimator_n_gamma_variance;               
    float m_mean_variance_estimator_uptime_gamma;                   
    float m_mean_variance_estimator_uptime_gating;                  
    float m_mean_variance_estimator_gating_duration_minutes;        
    float m_mean_variance_estimator_sigmoid_k;                      
    float m_mean_variance_estimator_sigmoid_x0;                     
    float m_mox_model_sraw_std;                                     
    float m_mox_model_sraw_mean;                                    
    float m_sigmoid_scaled_k;                                       
    float m_sigmoid_scaled_x0;                                      
    float m_sigmoid_scaled_offset_default;                          
    float m_adaptive_lowpass_a1;                                    
    float m_adaptive_lowpass_a2;                                    
    uint8_t m_adaptive_lowpass_initialized;                         
    float m_adaptive_lowpass_x1;                                    
    float m_adaptive_lowpass_x2;                                    
    float m_adaptive_lowpass_x3;                                    
} sgp41_gas_index_algorithm_t;

void sgp41_algorithm_reset(sgp41_gas_index_algorithm_t *params);

void sgp41_algorithm_init_with_sampling_interval(sgp41_gas_index_algorithm_t *params, int32_t algorithm_type, float sampling_interval);

void sgp41_algorithm_init(sgp41_gas_index_algorithm_t *params, int32_t algorithm_type);

void sgp41_algorithm_get_sampling_interval(const sgp41_gas_index_algorithm_t *params, float *sampling_interval);

void sgp41_algorithm_set_states(sgp41_gas_index_algorithm_t *params, float state0, float state1);

void sgp41_algorithm_get_states(const sgp41_gas_index_algorithm_t *params, float* state0, float* state1);

void sgp41_algorithm_set_tuning_parameters(sgp41_gas_index_algorithm_t *params, int32_t index_offset,
                                           int32_t learning_time_offset_hours, int32_t learning_time_gain_hours,
                                           int32_t gating_max_duration_minutes, int32_t std_initial,
                                           int32_t gain_factor);

void sgp41_algorithm_get_tuning_parameters(const sgp41_gas_index_algorithm_t *params, int32_t *index_offset,
                                           int32_t *learning_time_offset_hours, int32_t *learning_time_gain_hours,
                                           int32_t *gating_max_duration_minutes, int32_t *std_initial,
                                           int32_t *gain_factor);

void sgp41_algorithm_process(sgp41_gas_index_algorithm_t *params, int32_t sraw, int32_t *gas_index);

 
#ifdef __cplusplus
}
#endif
 
#endif