sgp30.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021 Inria
 *
 * 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 "periph/i2c.h"
#include "ztimer.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    uint16_t tvoc;      
    uint16_t eco2;      
#ifdef MODULE_SGP30_STRICT
    uint32_t timestamp; 
#endif
} sgp30_data_t;
 
typedef struct {
    uint16_t raw_h2;        
    uint16_t raw_ethanol;   
} sgp30_raw_data_t;
 
typedef struct {
    i2c_t i2c_dev;              
} sgp30_params_t;
 
typedef struct {
    sgp30_params_t params;      
#ifdef MODULE_SGP30_STRICT
    bool ready;                 
    ztimer_t _timer;            
    sgp30_data_t _data;         
#endif
} sgp30_t;
 
int sgp30_init(sgp30_t *dev, const sgp30_params_t *params);
 
int sgp30_start_air_quality(sgp30_t *dev);
 
int sgp30_read_future_set(sgp30_t *dev, uint16_t *version);
 
int sgp30_reset(sgp30_t *dev);
 
#if defined(MODULE_SGP30_STRICT) || defined(DOXYGEN)
bool sgp30_ready(sgp30_t *dev);
#endif
 
int sgp30_read_serial_number(sgp30_t *dev, uint8_t *buf, size_t len);
 
int sgp30_read_measurements(sgp30_t *dev, sgp30_data_t *data);
 
int sgp30_set_absolute_humidity(sgp30_t *dev, uint32_t humidity);
 
int sgp30_set_baseline(sgp30_t *dev, sgp30_data_t *data);
 
int sgp30_get_baseline(sgp30_t *dev, sgp30_data_t *data);
 
int sgp30_read_raw_measurements(sgp30_t *dev, sgp30_raw_data_t *data);
 
#ifdef __cplusplus
}
#endif