airquality3.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 AIRQUALITY3_H
#define AIRQUALITY3_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 AIRQUALITY3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.wke = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define AIRQUALITY3_RETVAL  uint8_t
 
#define AIRQUALITY3_OK           0x00
#define AIRQUALITY3_INIT_ERROR   0xFF
#define AIRQUALITY3_REG_ID               0x20
#define AIRQUALITY3_REG_ERROR_ID         0xE0
#define AIRQUALITY3_REG_STATUS           0x00
#define AIRQUALITY3_REG_HW_VERSION       0x21
#define AIRQUALITY3_REG_FW_BOOT_VERSION  0x23
#define AIRQUALITY3_REG_FW_APP_VERSION   0x24
#define AIRQUALITY3_REG_SW_RESET         0xFF
#define AIRQUALITY3_REG_ALG_DATA         0x02
#define AIRQUALITY3_REG_RAW_DATA         0x03
#define AIRQUALITY3_REG_ENV_DATA         0x05
#define AIRQUALITY3_REG_NTC              0x06
#define AIRQUALITY3_REG_MEAS_MODE        0x01
#define AIRQUALITY3_REG_BASELINE         0x11
#define AIRQUALITY3_DRIVE_MODE_0  ( 0x00 << 4 )
#define AIRQUALITY3_DRIVE_MODE_1  ( 0x01 << 4 )
#define AIRQUALITY3_DRIVE_MODE_2  ( 0x02 << 4 )
#define AIRQUALITY3_DRIVE_MODE_3  ( 0x03 << 4 )
#define AIRQUALITY3_DRIVE_MODE_4  ( 0x04 << 4 )
#define AIRQUALITY3_INT_DATARDY_0 ( 0x00 << 3 )
#define AIRQUALITY3_INT_DATARDY_1 ( 0x01 << 3 )
#define AIRQUALITY3_INT_THRESH_0  ( 0x00 << 2 )
#define AIRQUALITY3_INT_THRESH_1  ( 0x01 << 2 )
#define AIRQUALITY3_APP_START   0xF4
#define AIRQUALITY3_APP_VERIFY  0xF3
#define AIRQUALITY3_APP_DATA    0xF2
#define AIRQUALITY3_APP_ERASE   0xF1
#define AIRQUALITY3_DEVICE_SLAVE_ADDRESS 0x5A
#define AIRQUALITY3_POWER_STATE_ON 0
#define AIRQUALITY3_POWER_STATE_OFF 1
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t wke;
 
    // Input pins 
 
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} airquality3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t wke;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} airquality3_cfg_t;
 
typedef struct
{
    uint8_t device_id;
    uint8_t hw_ver;
    uint8_t fw_boot_ver;
    uint8_t fw_app_ver;
 
}airguality3_info_t;
 
typedef struct
{
    uint16_t co2;
    uint16_t tvoc;
    uint16_t raw_data;
    uint8_t m_status;
 
}airquality3_air_data_t;
 
 // End types group
 
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void airquality3_cfg_setup ( airquality3_cfg_t *cfg );
 
AIRQUALITY3_RETVAL airquality3_init ( airquality3_t *ctx, airquality3_cfg_t *cfg );
 
void airquality3_default_cfg ( airquality3_t *ctx );
 
void airquality3_generic_write ( airquality3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void airquality3_generic_read ( airquality3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t airquality3_get_starus ( airquality3_t *ctx );
 
void airquality3_get_device_info ( airquality3_t *ctx, airguality3_info_t *info );
 
void airquality3_software_reset ( airquality3_t *ctx, uint32_t reset );    // 0x11,0xE5,0x72,0x8A
 
uint8_t airquality3_get_co2_and_tvoc ( airquality3_t *ctx, airquality3_air_data_t *air_data );
 
 
void airquality3_get_raw_data ( airquality3_t *ctx, uint16_t *raw_data );
 
void airquality3_set_environment_data ( airquality3_t *ctx, uint32_t env_data );    // 0x11,0xE5,0x72,0x8A
 
void airquality3_get_ntc_data ( airquality3_t *ctx, uint8_t *data_buf );
 
void airquality3_set_measurement_mode ( airquality3_t *ctx, uint8_t mode );
 
void airquality3_set_baseline ( airquality3_t *ctx, uint16_t baseline );
 
void airquality3_app_function ( airquality3_t *ctx, uint8_t app_task );
 
void airquality3_set_power( airquality3_t *ctx, uint16_t pwr_state );
 
void airquality3_hardware_reset( airquality3_t *ctx );
 
uint8_t airquality3_get_interrupt_state( airquality3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _AIRQUALITY3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END