no2.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 NO2_H
#define NO2_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 NO2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST )
#define NO2_RETVAL  uint8_t
 
#define NO2_OK                              0x00
#define NO2_INIT_ERROR                      0xFF
#define NO2_STATUS_REG                      0x00
#define NO2_LOCK_REG                        0x01
#define NO2_TIACN_REG                       0x10
#define NO2_REFCN_REG                       0x11
#define NO2_MODECN_REG                      0x12
#define NO2_WRITE_MODE                      0x00
#define NO2_READ_ONLY_MODE                  0x01
#define NO2_EXT_TIA_RES                     0x00
#define NO2_2750_OHM_TIA_RES                0x04
#define NO2_3500_OHM_TIA_RES                0x08
#define NO2_7K_OHM_TIA_RES                  0x0C
#define NO2_14K_OHM_TIA_RES                 0x10
#define NO2_35K_OHM_TIA_RES                 0x14
#define NO2_120K_OHM_TIA_RES                0x18
#define NO2_350K_OHM_TIA_RES                0x1C
#define NO2_10_OHM_LOAD_RES                 0x00
#define NO2_33_OHM_LOAD_RES                 0x01
#define NO2_50_OHM_LOAD_RES                 0x02
#define NO2_100_OHM_LOAD_RES                0x03
#define NO2_VREF_INT                        0x00
#define NO2_VREF_EXT                        0x80
#define NO2_20_PERCENTS_INT_ZERO            0x00
#define NO2_50_PERCENTS_INT_ZERO            0x20
#define NO2_67_PERCENTS_INT_ZERO            0x40
#define NO2_INT_ZERO_BYPASSED               0x60
#define NO2_BIAS_POL_NEGATIVE               0x00
#define NO2_BIAS_POL_POSITIVE               0x10
#define NO2_0_PERCENTS_BIAS                 0x00
#define NO2_1_PERCENT_BIAS                  0x01
#define NO2_2_PERCENTS_BIAS                 0x02
#define NO2_4_PERCENTS_BIAS                 0x03
#define NO2_6_PERCENTS_BIAS                 0x04
#define NO2_8_PERCENTS_BIAS                 0x05
#define NO2_10_PERCENTS_BIAS                0x06
#define NO2_12_PERCENTS_BIAS                0x07
#define NO2_14_PERCENTS_BIAS                0x08
#define NO2_16_PERCENTS_BIAS                0x09
#define NO2_18_PERCENTS_BIAS                0x0A
#define NO2_20_PERCENTS_BIAS                0x0B
#define NO2_22_PERCENTS_BIAS                0x0C
#define NO2_24_PERCENTS_BIAS                0x0D
#define NO2_FET_DIS                         0x00
#define NO2_FET_EN                          0x80
#define NO2_DEEP_SLEEP_MODE                 0x00
#define NO2_2_LEAD_MODE                     0x01
#define NO2_STANDBY_MODE                    0x02
#define NO2_3_LEAD_MODE                     0x03
#define NO2_TEMP_MODE_TIA_OFF               0x06
#define NO2_TEMP_MODE_TIA_ON                0x07
#define NO2_DEVICE_EN                       0x00
#define NO2_DEVICE_DIS                      0x01
#define ADC_DEVICE_ADDR                      0x4D
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
 
    // Input pins 
 
    digital_in_t an;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} no2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t an;
    pin_name_t rst;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} no2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void no2_cfg_setup ( no2_cfg_t *cfg );
 
NO2_RETVAL no2_init ( no2_t *ctx, no2_cfg_t *cfg );
 
void no2_default_cfg ( no2_t *ctx );
 
void no2_generic_write ( no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void no2_generic_read ( no2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void no2_write_byte ( no2_t *ctx, uint8_t reg, uint8_t dev_data );
 
uint8_t no2_read_byte ( no2_t *ctx, uint8_t reg );
 
void no2_enable ( no2_t *ctx, uint8_t state );
 
uint16_t no2_read_adc ( no2_t *ctx );
 
float no2_get_no_2_ppm ( no2_t *ctx );
 
void no2_wait_ready ( no2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _NO2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END