driver_sps30.h

Go to the documentation of this file.

 
#ifndef DRIVER_SPS30_H
#define DRIVER_SPS30_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif
 
typedef enum
{
    SPS30_INTERFACE_IIC  = 0x00,       
    SPS30_INTERFACE_UART = 0x01,       
} sps30_interface_t;
 
typedef enum
{
    SPS30_FORMAT_IEEE754 = 0x03,        
    SPS30_FORMAT_UINT16  = 0x05,        
} sps30_format_t;
 
typedef enum
{
    SPS30_DATA_READY_FLAG_NOT_READY = 0x00,        
    SPS30_DATA_READY_FLAG_AVAILABLE = 0x01,        
} sps30_data_ready_flag_t;
 
typedef enum
{
    SPS30_STATUS_FAN_SPEED_ERROR = (1 << 21),       
    SPS30_STATUS_LASER_ERROR     = (1 << 5),        
    SPS30_STATUS_FAN_ERROR       = (1 << 4),        
} sps30_status_t;
 
typedef struct sps30_handle_s
{
    uint8_t (*iic_init)(void);                                                
    uint8_t (*iic_deinit)(void);                                              
    uint8_t (*iic_write_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);       
    uint8_t (*iic_read_cmd)(uint8_t addr, uint8_t *buf, uint16_t len);        
    uint8_t (*uart_init)(void);                                               
    uint8_t (*uart_deinit)(void);                                             
    uint16_t (*uart_read)(uint8_t *buf, uint16_t len);                        
    uint8_t (*uart_flush)(void);                                              
    uint8_t (*uart_write)(uint8_t *buf, uint16_t len);                        
    void (*delay_ms)(uint32_t ms);                                            
    void (*debug_print)(const char *const fmt, ...);                          
    uint8_t inited;                                                           
    uint8_t iic_uart;                                                         
    uint8_t format;                                                           
    uint8_t buf[256];                                                         
} sps30_handle_t;
 
typedef struct sps30_pm_s
{
    float pm1p0_ug_m3;                
    float pm2p5_ug_m3;                
    float pm4p0_ug_m3;                
    float pm10_ug_m3;                 
    float pm0p5_cm3;                  
    float pm1p0_cm3;                  
    float pm2p5_cm3;                  
    float pm4p0_cm3;                  
    float pm10_cm3;                   
    float typical_particle_um;        
} sps30_pm_t;
 
typedef struct sps30_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[16];                
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} sps30_info_t;
 
#define DRIVER_SPS30_LINK_INIT(HANDLE, STRUCTURE)              memset(HANDLE, 0, sizeof(STRUCTURE))
 
#define DRIVER_SPS30_LINK_UART_INIT(HANDLE, FUC)              (HANDLE)->uart_init = FUC
 
#define DRIVER_SPS30_LINK_UART_DEINIT(HANDLE, FUC)            (HANDLE)->uart_deinit = FUC
 
#define DRIVER_SPS30_LINK_UART_READ(HANDLE, FUC)              (HANDLE)->uart_read = FUC
 
#define DRIVER_SPS30_LINK_UART_WRITE(HANDLE, FUC)             (HANDLE)->uart_write = FUC
 
#define DRIVER_SPS30_LINK_UART_FLUSH(HANDLE, FUC)             (HANDLE)->uart_flush = FUC
 
#define DRIVER_SPS30_LINK_IIC_INIT(HANDLE, FUC)               (HANDLE)->iic_init = FUC
 
#define DRIVER_SPS30_LINK_IIC_DEINIT(HANDLE, FUC)             (HANDLE)->iic_deinit = FUC
 
#define DRIVER_SPS30_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)      (HANDLE)->iic_write_cmd = FUC
 
#define DRIVER_SPS30_LINK_IIC_READ_COMMAND(HANDLE, FUC)       (HANDLE)->iic_read_cmd = FUC
 
#define DRIVER_SPS30_LINK_DELAY_MS(HANDLE, FUC)               (HANDLE)->delay_ms = FUC
 
#define DRIVER_SPS30_LINK_DEBUG_PRINT(HANDLE, FUC)            (HANDLE)->debug_print = FUC
 
uint8_t sps30_info(sps30_info_t *info);
 
uint8_t sps30_set_interface(sps30_handle_t *handle, sps30_interface_t interface);
 
uint8_t sps30_get_interface(sps30_handle_t *handle, sps30_interface_t *interface);
 
uint8_t sps30_init(sps30_handle_t *handle);
 
uint8_t sps30_deinit(sps30_handle_t *handle);
 
uint8_t sps30_read(sps30_handle_t *handle, sps30_pm_t *pm);
 
uint8_t sps30_sleep(sps30_handle_t *handle);
 
uint8_t sps30_reset(sps30_handle_t *handle);
 
uint8_t sps30_wake_up(sps30_handle_t *handle);
 
uint8_t sps30_start_measurement(sps30_handle_t *handle, sps30_format_t format);
 
uint8_t sps30_stop_measurement(sps30_handle_t *handle);
 
uint8_t sps30_read_data_flag(sps30_handle_t *handle, sps30_data_ready_flag_t *flag);
 
uint8_t sps30_start_fan_cleaning(sps30_handle_t *handle);
 
uint8_t sps30_set_auto_cleaning_interval(sps30_handle_t *handle, uint32_t second);
 
uint8_t sps30_get_auto_cleaning_interval(sps30_handle_t *handle, uint32_t *second);
 
uint8_t sps30_disable_auto_cleaning_interval(sps30_handle_t *handle);
 
uint8_t sps30_get_product_type(sps30_handle_t *handle, char type[9]);
 
uint8_t sps30_get_serial_number(sps30_handle_t *handle, char sn[17]);
 
uint8_t sps30_get_version(sps30_handle_t *handle, uint8_t *major, uint8_t *minor);
 
uint8_t sps30_get_device_status(sps30_handle_t *handle, uint32_t *status);
 
uint8_t sps30_clear_device_status(sps30_handle_t *handle);
 
uint8_t sps30_set_reg_iic(sps30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);
 
uint8_t sps30_get_reg_iic(sps30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);
 
uint8_t sps30_set_get_reg_uart(sps30_handle_t *handle, uint8_t *input, uint16_t in_len, uint8_t *output, uint16_t out_len);
 
#ifdef __cplusplus
}
#endif
 
#endif