driver_scd30.h

Go to the documentation of this file.

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



typedef enum
{
    SCD30_INTERFACE_IIC  = 0x00,       
    SCD30_INTERFACE_UART = 0x01,       
} scd30_interface_t;

typedef enum
{
    SCD30_BOOL_FALSE = 0x0000,        
    SCD30_BOOL_TRUE  = 0x0001,        
} scd30_bool_t;

typedef struct scd30_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;                                                         
} scd30_handle_t;

typedef struct scd30_data_s
{
    uint16_t co2_raw;                
    float co2_ppm;                   
    uint16_t temperature_raw;        
    float temperature_deg;           
    uint16_t humidity_raw;           
    float humidity_percent;          
} scd30_data_t;

typedef struct scd30_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;           
} scd30_info_t;



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

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

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

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

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

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

#define DRIVER_SCD30_LINK_IIC_INIT(HANDLE, FUC)               (HANDLE)->iic_init = FUC

#define DRIVER_SCD30_LINK_IIC_DEINIT(HANDLE, FUC)             (HANDLE)->iic_deinit = FUC

#define DRIVER_SCD30_LINK_IIC_WRITE_COMMAND(HANDLE, FUC)      (HANDLE)->iic_write_cmd = FUC

#define DRIVER_SCD30_LINK_IIC_READ_COMMAND(HANDLE, FUC)       (HANDLE)->iic_read_cmd = FUC

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

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



uint8_t scd30_info(scd30_info_t *info);

uint8_t scd30_set_interface(scd30_handle_t *handle, scd30_interface_t interface);

uint8_t scd30_get_interface(scd30_handle_t *handle, scd30_interface_t *interface);

uint8_t scd30_init(scd30_handle_t *handle);

uint8_t scd30_deinit(scd30_handle_t *handle);

uint8_t scd30_read(scd30_handle_t *handle, scd30_data_t *data);

uint8_t scd30_start_measurement_with_pressure_compensation(scd30_handle_t *handle, uint16_t mbar);

uint8_t scd30_start_measurement(scd30_handle_t *handle);

uint8_t scd30_stop_measurement(scd30_handle_t *handle);

uint8_t scd30_set_measurement_interval(scd30_handle_t *handle, uint16_t second);

uint8_t scd30_get_measurement_interval(scd30_handle_t *handle, uint16_t *second);

uint8_t scd30_get_data_ready_status(scd30_handle_t *handle, uint16_t *status);

uint8_t scd30_set_automatic_self_calibration(scd30_handle_t *handle, scd30_bool_t enable);

uint8_t scd30_get_automatic_self_calibration(scd30_handle_t *handle, scd30_bool_t *enable);

uint8_t scd30_set_forced_recalibration(scd30_handle_t *handle, uint16_t co2_ppm);

uint8_t scd30_get_forced_recalibration(scd30_handle_t *handle, uint16_t *co2_ppm);

uint8_t scd30_set_temperature_offset(scd30_handle_t *handle, uint16_t deg);

uint8_t scd30_get_temperature_offset(scd30_handle_t *handle, uint16_t *deg);

uint8_t scd30_temperature_offset_convert_to_register(scd30_handle_t *handle, float deg, uint16_t *reg);

uint8_t scd30_temperature_offset_convert_to_data(scd30_handle_t *handle, uint16_t reg, float *deg);

uint8_t scd30_set_altitude_compensation(scd30_handle_t *handle, uint16_t m);

uint8_t scd30_get_altitude_compensation(scd30_handle_t *handle, uint16_t *m);

uint8_t scd30_get_firmware_version(scd30_handle_t *handle, uint16_t *version);

uint8_t scd30_soft_reset(scd30_handle_t *handle);



uint8_t scd30_set_reg_iic(scd30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);

uint8_t scd30_get_reg_iic(scd30_handle_t *handle, uint16_t reg, uint8_t *buf, uint16_t len);

uint8_t scd30_set_get_reg_uart(scd30_handle_t *handle, uint8_t *input, uint16_t in_len, uint8_t *output, uint16_t out_len);


 
#ifdef __cplusplus
}
#endif
 
#endif