airquality8.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 AIRQUALITY8_H
#define AIRQUALITY8_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"
 
#define AIRQUALITY8_REG_PID                                             0x00
#define AIRQUALITY8_REG_CONF                                            0x20
#define AIRQUALITY8_REG_PROD_DATA                                       0x26
#define AIRQUALITY8_REG_CMD                                             0x93
#define AIRQUALITY8_REG_STATUS                                          0x94
#define AIRQUALITY8_REG_TRACKING                                        0x3A
 
#define AIRQUALITY8_REG_CFG_H                                           0x40
#define AIRQUALITY8_REG_CFG_D                                           0x50
#define AIRQUALITY8_REG_CFG_M                                           0x60
#define AIRQUALITY8_REG_CFG_S                                           0x68
#define AIRQUALITY8_REG_CFG_R                                           0x97
 
 // airquality8_reg
 
#define AIRQUALITY8_PRODUCT_ID                                          0x6320
 
#define AIRQUALITY8_GAS_DETECTION_STRATEGY_AUTO                         0 
#define AIRQUALITY8_GAS_DETECTION_STRATEGY_FORCE_O3                     1 
#define AIRQUALITY8_GAS_DETECTION_STRATEGY_FORCE_NO2                    2
 
#define AIRQUALITY8_RCDA_STRATEGY_FIX                                   0
#define AIRQUALITY8_RCDA_STRATEGY_SET                                   1
#define AIRQUALITY8_RCDA_STRATEGY_ADJ                                   2
 
#define AIRQUALITY8_STATUS_SEQUENCER_RUNNING_MASK                       0x80
#define AIRQUALITY8_STATUS_SLEEP_TIMER_ENABLED_MASK                     0x40
#define AIRQUALITY8_STATUS_ALARM_MASK                                   0x20
#define AIRQUALITY8_STATUS_LAST_SEQ_STEP_MASK                           0x1F
#define AIRQUALITY8_STATUS_POR_EVENT_MASK                               0x80
#define AIRQUALITY8_STATUS_ACCESS_CONFLICT_MASK                         0x40
 
#define AIRQUALITY8_SET_DEV_ADDR                                        0x33
 
 // airquality8_set
 
#define AIRQUALITY8_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
 
 // airquality8_map
 // airquality8
 
typedef struct
{
    // Output pins
    digital_out_t  rst;     
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;   
} airquality8_t;
 
typedef struct
{
    pin_name_t  scl;       
    pin_name_t  sda;       
    pin_name_t  rst;       
    pin_name_t  int_pin;   
    uint32_t  i2c_speed;   
    uint8_t   i2c_address; 
} airquality8_cfg_t;
 
typedef enum
{
    AIRQUALITY8_OK                       = 0,
    AIRQUALITY8_ERROR                    = -1,
    AIRQUALITY8_ERROR_INIT_OUT_OF_RANGE  = 1,
    AIRQUALITY8_ERROR_GAS_TIMEOUT        = 2,
    AIRQUALITY8_ERROR_I2C                = 3,
    AIRQUALITY8_ERROR_SENSOR_UNSUPPORTED = 4,
    AIRQUALITY8_ERROR_CONFIG_MISSING     = 5,
    AIRQUALITY8_ERROR_SENSOR             = 6,
    AIRQUALITY8_ERROR_ACCESS_CONFLICT    = 7,
    AIRQUALITY8_ERROR_POR_EVENT          = 8
 
} airquality8_return_value_t;
 
void airquality8_cfg_setup ( airquality8_cfg_t *cfg );
 
err_t airquality8_init ( airquality8_t *ctx, airquality8_cfg_t *cfg );
 
err_t airquality8_default_cfg ( airquality8_t *ctx );
 
err_t airquality8_generic_write ( airquality8_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t airquality8_generic_read ( airquality8_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void airquality8_hw_reset ( airquality8_t *ctx );
 
err_t airquality8_get_status ( airquality8_t *ctx, uint8_t *status );
 
err_t airquality8_get_sensor_info ( airquality8_t *ctx, uint8_t *cfg_data, uint8_t *prod_data, uint16_t *pid );
 
err_t airquality8_init_sensor ( airquality8_t *ctx, uint16_t *mox_lr, uint16_t *mox_er );
 
err_t airquality8_init_measurement ( airquality8_t *ctx );
 
err_t airquality8_start_measurement ( airquality8_t *ctx );
 
err_t airquality8_read_rmox ( airquality8_t *ctx, float *rmox, uint16_t mox_lr, uint16_t mox_er );
 
float airquality8_calc_oaq ( float *rmox, uint8_t rcda_strategy, uint8_t gas_detection_strategy );
 
uint8_t raq_check_interrupt ( airquality8_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // AIRQUALITY8_H
 
 // airquality8
 
// ------------------------------------------------------------------------ END