sen5x.h

Go to the documentation of this file.

/*
 * Copyright (C) 2023 TU Braunschweig Institut für Betriebssysteme und Rechnerverbund
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#include "periph/i2c.h"
#include "saul.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    uint16_t mass_concentration_pm1p0;      
    uint16_t mass_concentration_pm2p5;      
    uint16_t mass_concentration_pm4p0;      
    uint16_t mass_concentration_pm10p0;     
    uint16_t number_concentration_pm0p5;    
    uint16_t number_concentration_pm1p0;    
    uint16_t number_concentration_pm2p5;    
    uint16_t number_concentration_pm4p0;    
    uint16_t number_concentration_pm10p0;   
    uint16_t typical_particle_size;         
    int16_t ambient_humidity;               
    int16_t ambient_temperature;            
    int16_t voc_index;                      
    int16_t nox_index;                      
} sen5x_measurement_t;
 
typedef struct {
    i2c_t i2c_dev;                  
    uint8_t i2c_addr;               
} sen5x_params_t;
 
typedef struct {
    sen5x_params_t params;                  
} sen5x_t;
 
int sen5x_init(sen5x_t *dev, const sen5x_params_t *params);
 
int sen5x_reset(const sen5x_t *dev);
 
void sen5x_wake(const sen5x_t *dev);
 
void sen5x_wake_no_pm(const sen5x_t *dev);
 
void sen5x_sleep(const sen5x_t *dev);
 
void sen5x_clean_fan(const sen5x_t *dev);
 
bool sen5x_data_ready_flag(const sen5x_t *dev);
 
void sen5x_read_values(const sen5x_t *dev, sen5x_measurement_t *values);
 
void sen5x_read_pm_values(const sen5x_t *dev, sen5x_measurement_t *values);
 
void sen5x_set_temperature_offset(const sen5x_t *dev, int16_t temp_offset,
                                    int16_t slope, uint16_t time_constant);
 
void sen5x_get_temperature_offset(const sen5x_t *dev, int16_t *temp_offset,
                                    int16_t *slope, uint16_t *time_constant);
 
void sen5x_set_warm_start(const sen5x_t *dev, uint16_t warm_start);
 
void sen5x_get_warm_start(const sen5x_t *dev, uint16_t *warm_start);
 
void sen5x_set_voc_algorithm_tuning(
    const sen5x_t *dev, int16_t index_offset, int16_t learning_time_offset_hours,
    int16_t learning_time_gain_hours, int16_t gating_max_duration_minutes,
    int16_t std_initial, int16_t gain_factor);
 
void sen5x_get_voc_algorithm_tuning(
    const sen5x_t *dev, int16_t *index_offset, int16_t *learning_time_offset_hours,
    int16_t *learning_time_gain_hours, int16_t *gating_max_duration_minutes,
    int16_t *std_initial, int16_t *gain_factor);
 
void sen5x_set_nox_algorithm_tuning(
    const sen5x_t *dev, int16_t index_offset, int16_t learning_time_offset_hours,
    int16_t learning_time_gain_hours, int16_t gating_max_duration_minutes,
    int16_t std_initial, int16_t gain_factor);
 
void sen5x_get_nox_algorithm_tuning(
    const sen5x_t *dev, int16_t *index_offset, int16_t *learning_time_offset_hours,
    int16_t *learning_time_gain_hours, int16_t *gating_max_duration_minutes,
    int16_t *std_initial, int16_t *gain_factor);
 
void sen5x_set_rht_acceleration(const sen5x_t *dev, uint16_t mode);
 
void sen5x_get_rht_acceleration(const sen5x_t *dev, uint16_t *mode);
 
void sen5x_set_voc_state(const sen5x_t *dev, const uint8_t *state, uint8_t state_size);
 
void sen5x_get_voc_state(const sen5x_t *dev, uint8_t *state, uint8_t state_size);
 
#ifdef __cplusplus
}
#endif