airquality5.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 AIRQUALITY5_H
#define AIRQUALITY5_H
 
#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"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define AIRQUALITY5_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT ) 
#define AIRQUALITY5_RETVAL  uint8_t
 
#define AIRQUALITY5_OK           0x00
#define AIRQUALITY5_INIT_ERROR   0xFF
#define AIRQ5_DATA_CHANNEL_NO2    0x4000
#define AIRQ5_DATA_CHANNEL_NH3    0x5000
#define AIRQ5_DATA_CHANNEL_CO     0x6000
#define AIRQ5_REG_POINTER_CONVERT         0x00
#define AIRQ5_REG_POINTER_CONFIG          0x01
#define AIRQ5_REG_POINTER_LOW_THRESH      0x02
#define AIRQ5_REG_POINTER_HIGH_THRESH     0x03
#define AIRQ5_CONFIG_OS_SINGLE        0x8000
#define AIRQ5_CONFIG_OS_BUSY          0x0000
#define AIRQ5_CONFIG_OS_NOTBUSY       0x8000
#define AIRQ5_CONFIG_PGA_6_144V       0x0000
#define AIRQ5_CONFIG_PGA_4_096V       0x0200
#define AIRQ5_CONFIG_PGA_2_048V       0x0400
#define AIRQ5_CONFIG_PGA_1_024V       0x0600
#define AIRQ5_CONFIG_PGA_0_512V       0x0800
#define AIRQ5_CONFIG_PGA_0_256V       0x0A00
#define AIRQ5_CONFIG_CONTINUOUS_MODE  0x0000
#define AIRQ5_CONFIG_SINGLE_MODE      0x0100
#define AIRQ5_CONFIG_DATA_RATE_128SPS    0x0000
#define AIRQ5_CONFIG_DATA_RATE_250SPS    0x0020
#define AIRQ5_CONFIG_DATA_RATE_490SPS    0x0040
#define AIRQ5_CONFIG_DATA_RATE_920SPS    0x0060
#define AIRQ5_CONFIG_DATA_RATE_1600SPS   0x0080
#define AIRQ5_CONFIG_DATA_RATE_2400SPS   0x00A0
#define AIRQ5_CONFIG_DATA_RATE_3300SPS   0x00C0
#define AIRQ5_CONFIG_COMP_MODE_TRADITIONAL  0x0000
#define AIRQ5_CONFIG_COMP_MODE_WINDOW       0x0010
#define AIRQ5_CONFIG_COMP_POL_ACTIVE_LOW    0x0000
#define AIRQ5_CONFIG_COMP_POL_ACTIVE_HIGH   0x0008
#define AIRQ5_CONFIG_COMP_LAT_NOT_LATCH    0x0000
#define AIRQ5_CONFIG_COMP_LAT_LATCH        0x0004
#define AIRQ5_CONFIG_COMP_QUE_1CONV   0x0000
#define AIRQ5_CONFIG_COMP_QUE_2CONV   0x0001
#define AIRQ5_CONFIG_COMP_QUE_4CONV   0x0002
#define AIRQ5_CONFIG_COMP_QUE_0CONV   0x0003
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
 
    // Input pins 
 
    digital_in_t rdy;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
    uint16_t data_config;
 
} airquality5_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rdy;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} airquality5_cfg_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void airquality5_cfg_setup ( airquality5_cfg_t *cfg );
 
AIRQUALITY5_RETVAL airquality5_init ( airquality5_t *ctx, airquality5_cfg_t *cfg );
 
void airquality5_default_cfg ( airquality5_t *ctx );
 
void airquality5_generic_write ( airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void airquality5_generic_read ( airquality5_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void airq5_write_data ( airquality5_t *ctx, uint8_t reg, uint16_t data_b );
 
uint16_t airq5_read_data ( airquality5_t *ctx, uint8_t reg );
 
void airq5_set_configuration ( airquality5_t *ctx, uint16_t config );
 
uint16_t airq5_read_sensor_data( airquality5_t *ctx, uint16_t channel_data );
 
uint8_t airq5_get_interrupt ( airquality5_t *ctx );
#ifdef __cplusplus
}
#endif
#endif  // _AIRQUALITY5_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END