ndirco2.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 NDIRCO2_H
#define NDIRCO2_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 NDIRCO2_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
  cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN ); \
  cfg.bsy = MIKROBUS( mikrobus, MIKROBUS_RST ); \
  cfg.cal = MIKROBUS( mikrobus, MIKROBUS_CS ); \
  cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT ); 
#define NDIRCO2_RETVAL  uint8_t
 
#define NDIRCO2_OK           0x00
#define NDIRCO2_INIT_ERROR   0xFF
#define NDIRCO2_SOFTWARE_RESET_REG         0x00
#define NDIRCO2_CONTROL_REG                0x01
#define NDIRCO2_STATUS_REG                 0x02
#define NDIRCO2_DATA_LOW_REG               0x03
#define NDIRCO2_DATA_HIGH_REG              0x04
#define NDIRCO2_AVERAGING_COUNT_REG        0x07
#define NDIRCO2_HIGH_ALARM_THRESHOLD_REG   0x0C
#define NDIRCO2_LOW_ALARM_THRESHOLD_REG    0x0D
#define NDIRCO2_FUNCTION_REG               0x0F
#define NDIRCO2_NORMAL_STATE               0x00
#define NDIRCO2_RESET                      0x01
#define NDIRCO2_MOVING_AVERAGE_SEL         0x00
#define NDIRCO2_IIR_DIGITAL_FILTER_SEL     0x04
#define NDIRCO2_MIN_AVG_COUNT_1_TIME       0x00
#define NDIRCO2_MAX_AVG_COUNT_64_TIMES     0x3F
#define NDIRCO2_PWM_PIN_DISABLE            0x00
#define NDIRCO2_PWM_PIN_ENABLE             0x01
#define NDIRCO2_PWM_HIGH_CONCENTRATION     0x00
#define NDIRCO2_PWM_LOW_CONCENTRATION      0x08
#define NDIRCO2_CHECK_EACH_MEASURE         0x00
#define NDIRCO2_CHECK_AVG_COMPLETED        0x01
#define NDIRCO2_POWER_DOWN_MODE            0x00
#define NDIRCO2_CONTINUOUS_OP_MODE         0x01
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    // Input pins 
 
    digital_in_t an;
    digital_in_t bsy;
    digital_in_t cal;
    digital_in_t int_pin;
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} ndirco2_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
    
    // Additional gpio pins 
 
    pin_name_t an;
    pin_name_t bsy;
    pin_name_t cal;
    pin_name_t int_pin;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} ndirco2_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void ndirco2_cfg_setup ( ndirco2_cfg_t *cfg );
 
NDIRCO2_RETVAL ndirco2_init ( ndirco2_t *ctx, ndirco2_cfg_t *cfg );
 
void ndirco2_generic_write ( ndirco2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void ndirco2_generic_read ( ndirco2_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint8_t ndirco2_read_register ( ndirco2_t *ctx, uint8_t register_address, uint16_t *data_out );
 
uint8_t ndirco2_write_register ( ndirco2_t *ctx, uint8_t register_address, uint8_t transfer_data );
 
void ndirco2_read_current_address ( ndirco2_t *ctx, uint8_t *data_out, uint8_t n_bytes );
 
void ndirco2_read_co2 ( ndirco2_t *ctx, uint8_t set_check_mode, uint16_t *output_data );
 
uint8_t ndirco2_check_busy ( ndirco2_t *ctx );
 
uint8_t ndirco2_check_average_complete ( ndirco2_t *ctx );
 
void ndirco2_set_mode ( ndirco2_t *ctx, uint8_t select_mode );
 
void ndirco2_reset ( ndirco2_t *ctx );
 
uint8_t ndirco2_check_alarm( ndirco2_t *ctx );
 
 
#ifdef __cplusplus
}
#endif
#endif  // _NDIRCO2_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END