co2.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** 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 CO2_H
#define CO2_H
 
#ifdef __cplusplus
extern "C"{
#endif
 
#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"
 
#define CO2_REG_DISABLE_CRC                 0x3768
#define CO2_REG_SET_BINARY_GAS              0x3615
#define CO2_REG_SET_RELATIVE_HUMIDITY       0x3624
#define CO2_REG_SET_TEMPERATURE             0x361E
#define CO2_REG_SET_PRESSURE                0x362F
#define CO2_REG_MEASURE_GAS_CONCENTRATION   0x3639
#define CO2_REG_FORCED_RECALIBRATION        0x3661
#define CO2_REG_ENABLE_AUTO_SELF_CALIB      0x3FEF
#define CO2_REG_DISABLE_AUTO_SELF_CALIB     0x3F6E
#define CO2_REG_PREPARE_READ_STATE          0x3752
#define CO2_REG_READ_STATE                  0xE133
#define CO2_REG_WRITE_STATE                 0xE133
#define CO2_REG_APPLY_STATE                 0x3650
#define CO2_REG_SELF_TEST                   0x365B
#define CO2_REG_RESET                       0x0006
#define CO2_REG_ENTER_SLEEP_MODE            0x3677
 
 // co2_reg
 
#define CO2_SET_BINARY_GAS_IN_N2_100PCT     0x0000
#define CO2_SET_BINARY_GAS_IN_AIR_100PCT    0x0001
#define CO2_SET_BINARY_GAS_IN_N2_25PCT      0x0002
#define CO2_SET_BINARY_GAS_IN_AIR_25PCT     0x0003
 
#define CO2_DEVICE_ID                       0x08010301
 
#define CO2_SET_DEV_ADDR_GND                0x29
#define CO2_SET_DEV_ADDR_1KOHMS             0x2C
#define CO2_SET_DEV_ADDR_3p3KOHMS           0x2B
#define CO2_SET_DEV_ADDR_10KOHMS            0x2A
 
 // co2_set
 
#define CO2_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); 
 
 // co2_map
 // co2
 
typedef struct
{
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
    // Device & serial IDs
    uint32_t device_id;
    uint32_t serial_id[ 2 ];
    uint8_t crc_enabled;
 
} co2_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} co2_cfg_t;
 
typedef enum
{
   CO2_OK = 0,
   CO2_ERROR = -1,
   CO2_ERROR_SELF_TEST = -2,
   CO2_ERROR_CRC = -3
 
} co2_return_value_t;
 
void co2_cfg_setup ( co2_cfg_t *cfg );
 
err_t co2_init ( co2_t *ctx, co2_cfg_t *cfg );
 
err_t co2_default_cfg ( co2_t *ctx );
 
err_t co2_generic_write ( co2_t *ctx, uint16_t reg, uint16_t *tx_buf, uint8_t tx_len );
 
err_t co2_generic_read ( co2_t *ctx, uint16_t reg, uint16_t *rx_buf, uint8_t rx_len );
 
err_t co2_reset ( co2_t *ctx );
 
err_t co2_get_id ( co2_t *ctx );
 
err_t co2_set_reference ( co2_t *ctx, uint16_t humidity, uint16_t pressure );
 
err_t co2_read_gas ( co2_t *ctx, float *gas_concentration, float *temperature );
 
err_t co2_disable_crc ( co2_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CO2_H
 
 // co2
 
// ------------------------------------------------------------------------ END