airquality9.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/
 
#ifndef AIRQUALITY9_H
#define AIRQUALITY9_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"
 
#define AIRQUALITY9_REG_PART_ID                 0x00
#define AIRQUALITY9_REG_OPMODE                  0x10
#define AIRQUALITY9_REG_CONFIG                  0x11
#define AIRQUALITY9_REG_COMMAND                 0x12
#define AIRQUALITY9_REG_TEMP_IN                 0x13
#define AIRQUALITY9_REG_RH_IN                   0x15
#define AIRQUALITY9_REG_DATA_STATUS             0x20
#define AIRQUALITY9_REG_DATA_AQI                0x21
#define AIRQUALITY9_REG_DATA_TVOC               0x22
#define AIRQUALITY9_REG_DATA_ECO2               0x24
#define AIRQUALITY9_REG_DATA_T                  0x30
#define AIRQUALITY9_REG_DATA_RH                 0x32
#define AIRQUALITY9_REG_DATA_MISR               0x38
#define AIRQUALITY9_REG_GPR_WRITE               0x40
#define AIRQUALITY9_REG_GPR_READ                0x48
 
 // airquality9_reg
 
#define AIRQUALITY9_OPMODE_DEEP_SLEEP           0x00
#define AIRQUALITY9_OPMODE_IDLE                 0x01
#define AIRQUALITY9_OPMODE_STANDARD             0x02
#define AIRQUALITY9_OPMODE_RESET                0xF0
 
#define AIRQUALITY_CONFIG_INTPOL_LOW            0x00
#define AIRQUALITY_CONFIG_INTPOL_HIGH           0x40
#define AIRQUALITY_CONFIG_INTCFG_OPEN_DRAIN     0x00
#define AIRQUALITY_CONFIG_INTCFG_PUSH_PULL      0x20
#define AIRQUALITY_CONFIG_INTGPR_BIT            0x08
#define AIRQUALITY_CONFIG_INTDAT_BIT            0x02
#define AIRQUALITY_CONFIG_INTEN_BIT             0x01
 
#define AIRQUALITY_STATUS_OPMODE_RUNNING        0x80
#define AIRQUALITY_STATUS_ERROR_DETECTED        0x40
#define AIRQUALITY_STATUS_VALID_NORMAL_OP       0x00
#define AIRQUALITY_STATUS_VALID_WARM_UP         0x04
#define AIRQUALITY_STATUS_VALID_INIT_START_UP   0x08
#define AIRQUALITY_STATUS_VALID_INVALID         0x0C
#define AIRQUALITY_STATUS_VALID_FLAG_BITS       0x0C
#define AIRQUALITY_STATUS_NEW_DATA              0x02
#define AIRQUALITY_STATUS_NEW_GPR               0x01
 
#define AIRQUALITY9_PART_ID_LSB                 0x60
#define AIRQUALITY9_PART_ID_MSB                 0x01
 
#define AIRQUALITY9_AQI_UBA_EXELLENT            1
#define AIRQUALITY9_AQI_UBA_GOOD                2
#define AIRQUALITY9_AQI_UBA_MODERATE            3
#define AIRQUALITY9_AQI_UBA_POOR                4
#define AIRQUALITY9_AQI_UBA_UNHEALTHY           5
 
#define AIRQUALITY9_DEVICE_ADDRESS_0            0x52
#define AIRQUALITY9_DEVICE_ADDRESS_1            0x53
 
#define AIRQUALITY9_SET_DATA_SAMPLE_EDGE        SET_SPI_DATA_SAMPLE_EDGE
#define AIRQUALITY9_SET_DATA_SAMPLE_MIDDLE      SET_SPI_DATA_SAMPLE_MIDDLE
 
 // airquality9_set
 
#define AIRQUALITY9_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // airquality9_map
 // airquality9
 
typedef enum
{
    AIRQUALITY9_DRV_SEL_SPI,      
    AIRQUALITY9_DRV_SEL_I2C       
} airquality9_drv_t;
 
typedef err_t ( *airquality9_master_io_t )( struct airquality9_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct airquality9_s
{
    digital_out_t en;                   
    digital_in_t  int_pin;              
    i2c_master_t  i2c;                  
    spi_master_t  spi;                  
    uint8_t     slave_address;          
    pin_name_t  chip_select;            
    airquality9_drv_t  drv_sel;         
    airquality9_master_io_t  write_f;   
    airquality9_master_io_t  read_f;    
} airquality9_t;
 
typedef struct
{
    pin_name_t  scl;                    
    pin_name_t  sda;                    
    pin_name_t  miso;                   
    pin_name_t  mosi;                   
    pin_name_t  sck;                    
    pin_name_t  cs;                     
    pin_name_t  en;                     
    pin_name_t  int_pin;                
    uint32_t  i2c_speed;                
    uint8_t   i2c_address;              
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
    airquality9_drv_t  drv_sel;         
} airquality9_cfg_t;
 
typedef enum
{
    AIRQUALITY9_OK = 0,
    AIRQUALITY9_ERROR = -1
 
} airquality9_return_value_t;
 
void airquality9_cfg_setup ( airquality9_cfg_t *cfg );
 
void airquality9_drv_interface_selection ( airquality9_cfg_t *cfg, airquality9_drv_t drv_sel );
 
err_t airquality9_init ( airquality9_t *ctx, airquality9_cfg_t *cfg );
 
err_t airquality9_default_cfg ( airquality9_t *ctx );
 
err_t airquality9_generic_write ( airquality9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t airquality9_generic_read ( airquality9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void airquality9_enable_device ( airquality9_t *ctx );
 
void airquality9_disable_device ( airquality9_t *ctx );
 
uint8_t airquality9_get_int_pin ( airquality9_t *ctx );
 
err_t airquality9_check_communication ( airquality9_t *ctx );
 
err_t airquality9_set_operating_mode ( airquality9_t *ctx, uint8_t opmode );
 
err_t airquality9_set_interrupt_config ( airquality9_t *ctx, uint8_t int_cfg );
 
err_t airquality9_read_status ( airquality9_t *ctx, uint8_t *status );
 
err_t airquality9_read_aqi_uba ( airquality9_t *ctx, uint8_t *aqi_uba );
 
err_t airquality9_read_tvoc ( airquality9_t *ctx, uint16_t *tvoc );
 
err_t airquality9_read_eco2 ( airquality9_t *ctx, uint16_t *eco2 );
 
#ifdef __cplusplus
}
#endif
#endif // AIRQUALITY9_H
 
 // airquality9
 
// ------------------------------------------------------------------------ END