sds011.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 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 SDS011_H
#define SDS011_H
 
#include <stdbool.h>
 
#include "periph/gpio.h"
#include "periph/uart.h"
#include "mutex.h"
#include "sds011_internal.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SDS011_DEVID_WILDCARD            (0xFFFF)
 
enum {
    SDS011_OK,               
    SDS011_INVALID_RESPONSE, 
    SDS011_INVALID_CHKSUM,   
    SDS011_ERROR,            
};
 
typedef enum sds011_reporting_mode {
    SDS011_RMODE_ACTIVE = 0, 
    SDS011_RMODE_QUERY  = 1, 
} sds011_reporting_mode_t;
 
typedef enum sds011_working_mode {
    SDS011_WMODE_SLEEP = 0, 
    SDS011_WMODE_WORK  = 1, 
} sds011_working_mode_t;
 
typedef struct {
    uart_t   uart;    
    gpio_t   pwr_pin; 
    uint16_t dev_id;  
    bool     pwr_ah;  
} sds011_params_t;
 
typedef struct {
    uint16_t pm_2_5;  
    uint16_t pm_10;   
} sds011_data_t;
 
typedef void (*sds011_callback_t)(sds011_data_t *data, void *ctx);
 
typedef struct {
    sds011_params_t   params;        
    mutex_t           dev_lock;      
    mutex_t           cb_lock;       
    sds011_callback_t cb;            
    void              *cbctx;        
    uint16_t          checksum;      
    uint8_t           rx_mem[SDS011_FRAME_RECV_LEN]; 
    uint8_t           pos;           
} sds011_t;
 
int sds011_init(sds011_t *dev, const sds011_params_t *params);
 
void sds011_power_on(const sds011_t *dev);
 
void sds011_power_off(const sds011_t *dev);
 
int sds011_read(sds011_t *dev, sds011_data_t *data);
 
int sds011_register_callback(sds011_t *dev, sds011_callback_t cb, void *ctx);
 
int sds011_get_reporting_mode(sds011_t *dev, sds011_reporting_mode_t *mode);
 
int sds011_set_reporting_mode(sds011_t *dev, sds011_reporting_mode_t mode);
 
int sds011_get_working_mode(sds011_t *dev, sds011_working_mode_t *mode);
 
int sds011_set_working_mode(sds011_t *dev, sds011_working_mode_t mode);
 
int sds011_get_working_period(sds011_t *dev, uint8_t *minutes);
 
int sds011_set_working_period(sds011_t *dev, uint8_t minutes);
 
int sds011_get_fw_version(sds011_t *dev, uint8_t *year, uint8_t *mon, uint8_t *day);
 
int sds011_set_dev_id(sds011_t *dev, uint16_t sens_dev_id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SDS011_H */