driver_pmsx003.h

Go to the documentation of this file.

 
#ifndef DRIVER_PMSX003_H
#define DRIVER_PMSX003_H
 
#include <stdio.h>
#include <stdint.h>
#include <string.h>
 
#ifdef __cplusplus
extern "C"{
#endif



typedef enum
{
    PMSX003_HARD_MODE_SLEEP  = 0x00,        
    PMSX003_HARD_MODE_NORMAL = 0x01,        
} pmsx003_hard_mode_t;

typedef enum
{
    PMSX003_MODE_PASSIVE = 0x00,        
    PMSX003_MODE_ACTIVE  = 0x01,        
} pmsx003_mode_t;

typedef struct pmsx003_data_s
{
    uint16_t pm1p0_standard_ug_m3;           
    uint16_t pm2p5_standard_ug_m3;           
    uint16_t pm10_standard_ug_m3;            
    uint16_t pm1p0_atmospheric_ug_m3;        
    uint16_t pm2p5_atmospheric_ug_m3;        
    uint16_t pm10_atmospheric_ug_m3;         
    uint16_t beyond_0p3um;                   
    uint16_t beyond_0p5um;                   
    uint16_t beyond_1p0um;                   
    uint16_t beyond_2p5um;                   
    uint16_t beyond_5p0um;                   
    uint16_t beyond_10um;                    
    uint8_t version;                         
    uint8_t error_code;                      
} pmsx003_data_t;

typedef struct pmsx003_handle_s
{
    uint8_t (*reset_gpio_init)(void);                         
    uint8_t (*reset_gpio_deinit)(void);                       
    uint8_t (*reset_gpio_write)(uint8_t level);               
    uint8_t (*set_gpio_init)(void);                           
    uint8_t (*set_gpio_deinit)(void);                         
    uint8_t (*set_gpio_write)(uint8_t level);                 
    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 mode;                                             
} pmsx003_handle_t;

typedef struct pmsx003_info_s
{
    char chip_name[32];                
    char manufacturer_name[32];        
    char interface[8];                 
    float supply_voltage_min_v;        
    float supply_voltage_max_v;        
    float max_current_ma;              
    float temperature_min;             
    float temperature_max;             
    uint32_t driver_version;           
} pmsx003_info_t;



#define DRIVER_PMSX003_LINK_INIT(HANDLE, STRUCTURE)            memset(HANDLE, 0, sizeof(STRUCTURE))

#define DRIVER_PMSX003_LINK_UART_INIT(HANDLE, FUC)            (HANDLE)->uart_init = FUC

#define DRIVER_PMSX003_LINK_UART_DEINIT(HANDLE, FUC)          (HANDLE)->uart_deinit = FUC

#define DRIVER_PMSX003_LINK_UART_READ(HANDLE, FUC)            (HANDLE)->uart_read = FUC

#define DRIVER_PMSX003_LINK_UART_WRITE(HANDLE, FUC)           (HANDLE)->uart_write = FUC

#define DRIVER_PMSX003_LINK_UART_FLUSH(HANDLE, FUC)           (HANDLE)->uart_flush = FUC

#define DRIVER_PMSX003_LINK_RESET_GPIO_INIT(HANDLE, FUC)      (HANDLE)->reset_gpio_init = FUC

#define DRIVER_PMSX003_LINK_RESET_GPIO_DEINIT(HANDLE, FUC)    (HANDLE)->reset_gpio_deinit = FUC

#define DRIVER_PMSX003_LINK_RESET_GPIO_WRITE(HANDLE, FUC)     (HANDLE)->reset_gpio_write = FUC

#define DRIVER_PMSX003_LINK_SET_GPIO_INIT(HANDLE, FUC)        (HANDLE)->set_gpio_init = FUC

#define DRIVER_PMSX003_LINK_SET_GPIO_DEINIT(HANDLE, FUC)      (HANDLE)->set_gpio_deinit = FUC

#define DRIVER_PMSX003_LINK_SET_GPIO_WRITE(HANDLE, FUC)       (HANDLE)->set_gpio_write = FUC

#define DRIVER_PMSX003_LINK_DELAY_MS(HANDLE, FUC)             (HANDLE)->delay_ms = FUC

#define DRIVER_PMSX003_LINK_DEBUG_PRINT(HANDLE, FUC)          (HANDLE)->debug_print = FUC



uint8_t pmsx003_info(pmsx003_info_t *info);

uint8_t pmsx003_init(pmsx003_handle_t *handle);

uint8_t pmsx003_deinit(pmsx003_handle_t *handle);

uint8_t pmsx003_read(pmsx003_handle_t *handle, pmsx003_data_t *data);

uint8_t pmsx003_reset(pmsx003_handle_t *handle);

uint8_t pmsx003_set_hard_mode(pmsx003_handle_t *handle, pmsx003_hard_mode_t mode);

uint8_t pmsx003_set_mode(pmsx003_handle_t *handle, pmsx003_mode_t mode);

uint8_t pmsx003_sleep(pmsx003_handle_t *handle);

uint8_t pmsx003_wake_up(pmsx003_handle_t *handle);



uint8_t pmsx003_set_buffer(pmsx003_handle_t *handle, uint8_t *buf, uint16_t len);

uint8_t pmsx003_get_buffer(pmsx003_handle_t *handle, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif