driver_ens160.h

Go to the documentation of this file.

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



typedef enum
{
    ENS160_INTERFACE_IIC = 0x00,        
    ENS160_INTERFACE_SPI = 0x01,        
} ens160_interface_t;

typedef enum
{
    ENS160_ADDRESS_0 = (0x52 << 1),        
    ENS160_ADDRESS_1 = (0x53 << 1),        
} ens160_address_t;

typedef enum
{
    ENS160_BOOL_FALSE = 0x00,        
    ENS160_BOOL_TRUE  = 0x01,        
} ens160_bool_t;

typedef enum
{
    ENS160_MODE_DEEP_SLEEP = 0x00,        
    ENS160_MODE_IDLE       = 0x01,        
    ENS160_MODE_STANDARD   = 0x02,        
} ens160_mode_t;

typedef enum
{
    ENS160_PIN_POLARITY_LOW  = 0x00,        
    ENS160_PIN_POLARITY_HIGH = 0x01,        
} ens160_pin_polarity_t;

typedef enum
{
    ENS160_PIN_DRIVE_OPEN_DRAIN = 0x00,        
    ENS160_PIN_DRIVE_PUSH_PULL  = 0x01,        
} ens160_pin_drive_t;

typedef enum
{
    ENS160_STATUS_RUNNING  = (1 << 7),        
    ENS160_STATUS_ERROR    = (1 << 6),        
    ENS160_STATUS_NORMAL   = (0 << 2),        
    ENS160_STATUS_WARM_UP  = (1 << 2),        
    ENS160_STATUS_START_UP = (2 << 2),        
    ENS160_STATUS_INVALID  = (3 << 2),        
    ENS160_STATUS_NEWDAT   = (1 << 1),        
    ENS160_STATUS_NEWGPR   = (1 << 0),        
} ens160_status_t;

typedef struct ens160_handle_s
{
    uint8_t iic_addr;                                                                   
    uint8_t (*iic_init)(void);                                                          
    uint8_t (*iic_deinit)(void);                                                        
    uint8_t (*iic_read)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);         
    uint8_t (*iic_write)(uint8_t addr, uint8_t reg, uint8_t *buf, uint16_t len);        
    uint8_t (*spi_init)(void);                                                          
    uint8_t (*spi_deinit)(void);                                                        
    uint8_t (*spi_read)(uint8_t reg, uint8_t *buf, uint16_t len);                       
    uint8_t (*spi_write)(uint8_t reg, uint8_t *buf, uint16_t len);                      
    void (*receive_callback)(uint8_t type, uint16_t *dat);                              
    void (*delay_ms)(uint32_t ms);                                                      
    void (*debug_print)(const char *const fmt, ...);                                    
    uint8_t inited;                                                                     
    uint8_t iic_spi;                                                                    
} ens160_handle_t;

typedef struct ens160_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;           
} ens160_info_t;



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

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

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

#define DRIVER_ENS160_LINK_IIC_READ(HANDLE, FUC)          (HANDLE)->iic_read = FUC

#define DRIVER_ENS160_LINK_IIC_WRITE(HANDLE, FUC)         (HANDLE)->iic_write = FUC

#define DRIVER_ENS160_LINK_SPI_INIT(HANDLE, FUC)          (HANDLE)->spi_init = FUC

#define DRIVER_ENS160_LINK_SPI_DEINIT(HANDLE, FUC)        (HANDLE)->spi_deinit = FUC

#define DRIVER_ENS160_LINK_SPI_READ(HANDLE, FUC)          (HANDLE)->spi_read = FUC

#define DRIVER_ENS160_LINK_SPI_WRITE(HANDLE, FUC)         (HANDLE)->spi_write = FUC

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

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

#define DRIVER_ENS160_LINK_RECEIVE_CALLBACK(HANDLE, FUC)  (HANDLE)->receive_callback = FUC



uint8_t ens160_info(ens160_info_t *info);

uint8_t ens160_set_interface(ens160_handle_t *handle, ens160_interface_t interface);

uint8_t ens160_get_interface(ens160_handle_t *handle, ens160_interface_t *interface);

uint8_t ens160_set_addr_pin(ens160_handle_t *handle, ens160_address_t addr_pin);

uint8_t ens160_get_addr_pin(ens160_handle_t *handle, ens160_address_t *addr_pin);

uint8_t ens160_irq_handler(ens160_handle_t *handle);

uint8_t ens160_init(ens160_handle_t *handle);

uint8_t ens160_deinit(ens160_handle_t *handle);

uint8_t ens160_read_aqi(ens160_handle_t *handle, uint8_t *uba);

uint8_t ens160_read_tvoc(ens160_handle_t *handle, uint16_t *tvoc_ppb);

uint8_t ens160_read_eco2(ens160_handle_t *handle, uint16_t *eco2_ppm);

uint8_t ens160_read_etoh(ens160_handle_t *handle, uint16_t *etoh_ppb);

uint8_t ens160_set_mode(ens160_handle_t *handle, ens160_mode_t mode);

uint8_t ens160_get_mode(ens160_handle_t *handle, ens160_mode_t *mode);

uint8_t ens160_soft_reset(ens160_handle_t *handle);

uint8_t ens160_set_interrupt_pin_polarity(ens160_handle_t *handle, ens160_pin_polarity_t polarity);

uint8_t ens160_get_interrupt_pin_polarity(ens160_handle_t *handle, ens160_pin_polarity_t *polarity);

uint8_t ens160_set_interrupt_pin_drive(ens160_handle_t *handle, ens160_pin_drive_t drive);

uint8_t ens160_get_interrupt_pin_drive(ens160_handle_t *handle, ens160_pin_drive_t *drive);

uint8_t ens160_set_general_purpose_read_interrupt_pin_asserted(ens160_handle_t *handle, ens160_bool_t enable);

uint8_t ens160_get_general_purpose_read_interrupt_pin_asserted(ens160_handle_t *handle, ens160_bool_t *enable);

uint8_t ens160_set_data_interrupt_pin_asserted(ens160_handle_t *handle, ens160_bool_t enable);

uint8_t ens160_get_data_interrupt_pin_asserted(ens160_handle_t *handle, ens160_bool_t *enable);

uint8_t ens160_set_interrupt(ens160_handle_t *handle, ens160_bool_t enable);

uint8_t ens160_get_interrupt(ens160_handle_t *handle, ens160_bool_t *enable);

uint8_t ens160_nop(ens160_handle_t *handle);

uint8_t ens160_get_app_version(ens160_handle_t *handle, uint8_t *major, uint8_t *minor, uint8_t *release);

uint8_t ens160_clear(ens160_handle_t *handle);

uint8_t ens160_set_temperature_compensation(ens160_handle_t *handle, uint16_t raw);

uint8_t ens160_get_temperature_compensation(ens160_handle_t *handle, uint16_t *raw);

uint8_t ens160_set_humidity_compensation(ens160_handle_t *handle, uint16_t raw);

uint8_t ens160_get_humidity_compensation(ens160_handle_t *handle, uint16_t *raw);

uint8_t ens160_get_status(ens160_handle_t *handle, uint8_t *status);

uint8_t ens160_get_calculation_temperature(ens160_handle_t *handle, uint16_t *raw);

uint8_t ens160_get_calculation_humidity(ens160_handle_t *handle, uint16_t *raw);

uint8_t ens160_get_checksum(ens160_handle_t *handle, uint8_t *checksum);

uint8_t ens160_set_params(ens160_handle_t *handle, uint8_t params[8]);

uint8_t ens160_get_params(ens160_handle_t *handle, uint8_t params[8]);

uint8_t ens160_get_params_output(ens160_handle_t *handle, uint8_t params[8]);

uint8_t ens160_temperature_convert_to_register(ens160_handle_t *handle, float celsius_deg, uint16_t *reg);

uint8_t ens160_temperature_convert_to_data(ens160_handle_t *handle, uint16_t reg, float *celsius_deg);

uint8_t ens160_humidity_convert_to_register(ens160_handle_t *handle, float percentage, uint16_t *reg);

uint8_t ens160_humidity_convert_to_data(ens160_handle_t *handle, uint16_t reg, float *percentage);

uint8_t ens160_resistance_convert_to_register(ens160_handle_t *handle, float ohm, uint16_t *reg);

uint8_t ens160_resistance_convert_to_data(ens160_handle_t *handle, uint16_t reg, float *ohm);

uint8_t ens160_resistance_split(ens160_handle_t *handle, uint8_t raw[8],
                                uint16_t *resistance0, uint16_t *resistance1,
                                uint16_t *resistance2, uint16_t *resistance3);



uint8_t ens160_set_reg(ens160_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);

uint8_t ens160_get_reg(ens160_handle_t *handle, uint8_t reg, uint8_t *buf, uint16_t len);


 
#ifdef __cplusplus
}
#endif
 
#endif