sps30.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 HAW Hamburg
 *
 * 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 SPS30_H
#define SPS30_H
 
#include <stdbool.h>
#include "periph/gpio.h"
#include "periph/i2c.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
    i2c_t i2c_dev;                
} sps30_params_t;
 
typedef struct {
    sps30_params_t p;             
} sps30_t;
 
typedef struct {
    float mc_pm1;       
    float mc_pm2_5;     
    float mc_pm4;       
    float mc_pm10;      
    float nc_pm0_5;     
    float nc_pm1;       
    float nc_pm2_5;     
    float nc_pm4;       
    float nc_pm10;      
    float ps;           
} sps30_data_t;
 
typedef enum {
    SPS30_OK = 0,     
    SPS30_CRC_ERROR,  
    SPS30_I2C_ERROR   
} sps30_error_code_t;
 
#define SPS30_FAN_CLEAN_S    (10U)
 
#define SPS30_SER_ART_LEN    (32U)
 
#define SPS30_DEFAULT_ACI_S  (604800UL)
 
#ifndef CONFIG_SPS30_ERROR_RETRY
#define CONFIG_SPS30_ERROR_RETRY    (500U)
#endif
 
int sps30_init(sps30_t *dev, const sps30_params_t *params);
 
int sps30_start_measurement(const sps30_t *dev);
 
int sps30_stop_measurement(const sps30_t *dev);
 
bool sps30_data_ready(const sps30_t *dev, int *error);
 
int sps30_read_measurement(const sps30_t *dev, sps30_data_t *data);
 
int sps30_read_ac_interval(const sps30_t *dev, uint32_t *seconds);
 
int sps30_write_ac_interval(const sps30_t *dev, uint32_t seconds);
 
int sps30_start_fan_clean(const sps30_t *dev);
 
int sps30_read_article_code(const sps30_t *dev, char *str, size_t len);
 
int sps30_read_serial_number(const sps30_t *dev, char *str, size_t len);
 
int sps30_reset(const sps30_t *dev);
 
int sps30_sleep(const sps30_t *dev);
 
int sps30_wakeup(const sps30_t *dev);
 
#ifdef __cplusplus
}
#endif
#endif /* SPS30_H */