airquality4.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 AIRQUALITY4_H
#define AIRQUALITY4_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 AIRQUALITY4_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define AIRQUALITY4_RETVAL  uint8_t
 
#define AIRQUALITY4_OK           0x00
#define AIRQUALITY4_INIT_ERROR   0xFF
 // End group macro
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
 
    // Modules
 
    i2c_master_t i2c;
 
    // ctx variable
 
    uint8_t slave_address;
 
} airquality4_t;
 
typedef struct
{
    // Communication gpio pins
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} airquality4_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void airquality4_cfg_setup ( airquality4_cfg_t *cfg );
 
AIRQUALITY4_RETVAL airquality4_init ( airquality4_t *ctx, airquality4_cfg_t *cfg );
 
void airquality4_default_cfg ( airquality4_t *ctx );
 
void air_quality4_get_id ( airquality4_t *ctx, uint8_t *data_buf);
 
void air_quality4_dev_init ( airquality4_t *ctx );
 
void air_quality4_measure_quality ( airquality4_t *ctx, uint8_t *read_air );
 
void air_quality4_get_co2_and_tvoc ( airquality4_t *ctx, uint16_t *value);
 
void air_quality4_measure_signal ( airquality4_t *ctx, uint8_t *read_air);
 
void air_quality4_get_h2_and_ethon ( airquality4_t *ctx, uint16_t *value );
 
void air_quality4_get_baseline ( airquality4_t *ctx,  uint8_t *read_air);
 
void air_quality4_set_baseline ( airquality4_t *ctx );
 
void air_quality4_soft_reset ( airquality4_t *ctx );
 
void air_quality4_get_version ( airquality4_t *ctx, uint8_t *version );
 
void air_quality4_get_version ( airquality4_t *ctx, uint8_t *version );
 
#ifdef __cplusplus
}
#endif
#endif  // _AIRQUALITY4_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END