scd30.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Puhang Ding
 *               2020 Jan Schlichter
 *               2020 Nishchay Agrawal
 *
 * 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.
 */
 
#ifndef SCD30_H
#define SCD30_H
 
#include "periph/i2c.h"
#include "saul.h"
#include "xtimer.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SCD30_VERSION    0xD100  
#define SCD30_STATUS     0x0202  
#define SCD30_DATA       0x0300  
#define SCD30_START      0x0010  
#define SCD30_STOP       0x0104  
#define SCD30_SOFT_RESET 0xD304  
#define SCD30_INTERVAL   0x4600  
#define SCD30_ASC        0x5306  
#define SCD30_FRC        0x5204  
#define SCD30_T_OFFSET   0x5403  
#define SCD30_A_OFFSET   0x5102  
enum {
    SCD30_OK            =  0,
    SCD30_COM_FAILED    = -1,       
    SCD30_INVALID_VALUE = -2,       
    SCD30_CRC_ERROR     = -3,       
    SCD30_NO_NEW_DATA   = -4,       
};
 
typedef struct {
    float co2_concentration;     
    float temperature;            
    float relative_humidity;     
} scd30_measurement_t;
 
typedef struct {
    i2c_t i2c_dev;                  
    uint8_t i2c_addr;               
} scd30_params_t;
 
typedef struct {
    scd30_params_t params;          
} scd30_t;
 
int8_t scd30_init(scd30_t *dev, const scd30_params_t *params);
 
int8_t scd30_set_param(const scd30_t *dev, uint16_t param, uint16_t val);
 
int8_t scd30_get_param(scd30_t *dev, uint16_t param, uint16_t *val);
 
int8_t scd30_read_triggered(scd30_t *dev, scd30_measurement_t *result);
 
uint8_t scd30_read_periodic(scd30_t *dev, scd30_measurement_t *result);
 
int scd30_start_periodic_measurement(scd30_t *dev, uint16_t *interval,
                                     uint16_t *apc);
 
int8_t scd30_stop_measurements(const scd30_t *dev);
 
int8_t scd30_reset(scd30_t *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SCD30_H */