airquality7.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 AIRQUALITY7_H
#define AIRQUALITY7_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 AIRQUALITY7_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define AIRQUALITY7_RETVAL  uint8_t
#define airquality7_err_t   uint8_t
 
#define AIRQUALITY7_OK           0x00
#define AIRQUALITY7_INIT_ERROR   0xFF
#define AIRQUALITY7_CMD_SET_PPMCO2    0x08
#define AIRQUALITY7_CMD_GET_STATUS    0x0C
#define AIRQUALITY7_CMD_GET_REVISION  0x0D
#define AIRQUALITY7_CMD_GET_R0        0x10
#define AIRQUALITY7_DEV_ADDR  0x70
#define AIRQUALITY7_ERR_OK    0x00
#define AIRQUALITY7_ERR_CRC   0x01
#define AIRQUALITY7_NULL      0x00
#define AIRQUALITY7_DUMMY     0x00
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} airquality7_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} airquality7_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void airquality7_cfg_setup ( airquality7_cfg_t *cfg );
 
AIRQUALITY7_RETVAL airquality7_init ( airquality7_t *ctx, airquality7_cfg_t *cfg );
 
void airquality7_generic_write ( airquality7_t *ctx, uint8_t *data_buf );
 
void airquality7_generic_read ( airquality7_t *ctx, uint8_t *data_buf );
 
void airquality7_set_ppmco2( airquality7_t *ctx, uint8_t *ppmco2_value );
 
airquality7_err_t airquality7_get_status( airquality7_t *ctx, uint16_t *tvoc_ppb, 
                                                              uint16_t *co2_ppm, 
                                                              uint32_t *res_val_ohm, 
                                                              uint8_t *err_byte );
 
airquality7_err_t airquality7_get_revision( airquality7_t *ctx, uint8_t *year, 
                                                                uint8_t *month, 
                                                                uint8_t *day, 
                                                                uint8_t *ascii_code );
 
airquality7_err_t airquality7_get_r0_calib( airquality7_t *ctx, uint16_t *r0_kohm );
 
#ifdef __cplusplus
}
#endif
#endif  // _AIRQUALITY7_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END