co23.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 CO23_H
#define CO23_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"
#include "drv_uart.h"
 
#define CO23_REG_PROD_ID                  0x00
#define CO23_REG_SENS_STS                 0x01
#define CO23_REG_MEAS_RATE_H              0x02
#define CO23_REG_MEAS_RATE_L              0x03
#define CO23_REG_MEAS_CFG                 0x04
#define CO23_REG_CO2PPM_H                 0x05
#define CO23_REG_CO2PPM_L                 0x06
#define CO23_REG_MEAS_STS                 0x07
#define CO23_REG_INT_CFG                  0x08
#define CO23_REG_ALARM_TH_H               0x09
#define CO23_REG_ALARM_TH_L               0x0A
#define CO23_REG_PRESS_REF_H              0x0B
#define CO23_REG_PRESS_REF_L              0x0C
#define CO23_REG_CALIB_REF_H              0x0D
#define CO23_REG_CALIB_REF_L              0x0E
#define CO23_REG_SCRATCH_PAD              0x0F
#define CO23_REG_SENS_RST                 0x10
 
 // co23_reg
 
#define CO23_OP_MODE_IDLE                 0x00
#define CO23_OP_MODE_SINGLE               0x01
#define CO23_OP_MODE_CONTINUOUS           0x02
#define CO23_OP_BOC_CFG_DISABLE           0x00
#define CO23_OP_BOC_CFG_AUTOMATIC         0x01
#define CO23_OP_BOC_CFG_FORCED            0x02
#define CO23_PWM_MODE_SINGLE_PULSE        0x00
#define CO23_PWM_MODE_TRAIN_PULSE         0x01 
 
#define CO23_TX_DRV_BUFFER_SIZE            100
#define CO23_RX_DRV_BUFFER_SIZE            300
 
#define CO23_DEVICE_ADDRESS               0x28
 
 // co23_set
 
#define CO23_MAP_MIKROBUS( cfg, mikrobus )           \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL );    \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );    \
    cfg.pwo = MIKROBUS( mikrobus, MIKROBUS_AN );     \
    cfg.pws = MIKROBUS( mikrobus, MIKROBUS_PWM );    \
    cfg.tx_pin  = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin  = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // co23_map
 // co23
 
typedef enum
{
    CO23_DRV_SEL_I2C,       
    CO23_DRV_SEL_UART       
} co23_drv_t;
 
typedef err_t ( *co23_master_io_t )( struct co23_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct co23_s
{
    // Output pins
    digital_out_t pws;        
    // Input pins
    digital_in_t pwo;         
    digital_in_t int_pin;     
    // Modules
    i2c_master_t i2c;         
    uart_t uart;              
    // I2C slave address
    uint8_t slave_address;    
    // Buffers
    char uart_rx_buffer[ CO23_RX_DRV_BUFFER_SIZE ];    
    char uart_tx_buffer[ CO23_TX_DRV_BUFFER_SIZE ];    
    co23_drv_t drv_sel;          
    co23_master_io_t write_f;    
    co23_master_io_t read_f;     
} co23_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t rx_pin;     
    pin_name_t tx_pin;     
    pin_name_t scl;        
    pin_name_t sda;        
    pin_name_t pwo;        
    pin_name_t pws;        
    pin_name_t int_pin;    
    // Static variable
    uint32_t         baud_rate;        
    bool             uart_blocking;    
    uart_data_bits_t data_bit;         
    uart_parity_t    parity_bit;       
    uart_stop_bits_t stop_bit;         
    uint32_t   i2c_speed;      
    uint8_t    i2c_address;    
    co23_drv_t drv_sel;        
} co23_cfg_t;
 
typedef struct
{
    uint8_t sen_rdy;
    uint8_t pwm_dis_st;
    uint8_t ortmp;
    uint8_t orvs;
    uint8_t iccer;
    uint8_t ortmp_clr;
    uint8_t orvs_clr;
    uint8_t iccer_clr;
    
} co23_sens_status_t;
 
typedef struct
{
    uint8_t pwm_outen;
    uint8_t pwm_mode;
    uint8_t boc_cfg;
    uint8_t op_mode;
    
} co23_meas_cfg_t;
 
typedef struct
{
    uint8_t drdy;
    uint8_t int_sts;
    uint8_t alarm;
    uint8_t int_sts_clr;
    uint8_t alarm_clr;
    
} co23_meas_status_t;
 
typedef struct
{
    uint8_t int_typ;
    uint8_t int_func;
    uint8_t alarm_typ;
    
} co23_int_cfg_t;
 
typedef enum
{
    CO23_CMD_SOFT_RESET = 0xA3,
    CO23_CMD_RESET_ABOC = 0xBC,
    CO23_CMD_STEPWISE_FILTER_DIS = 0xDF,
    CO23_CMD_SAVE_FCS_CALIB_OFFSET = 0xCF,
    CO23_CMD_RESET_FCS             = 0xFC,
    CO23_CMD_STEPWISE_FILTER_EN = 0xFE
 
} co23_soft_reset_value_t;
 
typedef enum
{
    CO23_OK = 0,
    CO23_ERROR = -1
 
} co23_return_value_t;
 
void co23_cfg_setup ( co23_cfg_t *cfg );
 
void co23_drv_interface_selection ( co23_cfg_t *cfg, co23_drv_t drv_sel );
 
err_t co23_init ( co23_t *ctx, co23_cfg_t *cfg );
 
err_t co23_default_cfg ( co23_t *ctx );
 
err_t co23_generic_write ( co23_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t co23_generic_read ( co23_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t co23_get_device_id ( co23_t *ctx, uint8_t *prod, uint8_t *rev );
 
err_t co23_get_sens_status ( co23_t *ctx, co23_sens_status_t *sens_status );
 
err_t co23_set_meas_rate ( co23_t *ctx, uint16_t meas_rate_sec );
 
err_t co23_get_meas_cfg ( co23_t *ctx, co23_meas_cfg_t *meas_cfg );
 
err_t co23_set_meas_cfg ( co23_t *ctx, co23_meas_cfg_t meas_cfg );
 
err_t co23_get_co2_ppm ( co23_t *ctx, uint16_t *co2_ppm );
 
err_t co23_get_meas_status ( co23_t *ctx, co23_meas_status_t *meas_status );
 
err_t co23_get_int_cfg ( co23_t *ctx, co23_int_cfg_t *int_cfg );
 
err_t co23_set_int_cfg ( co23_t *ctx, co23_int_cfg_t int_cfg );
 
err_t co23_set_alarm_threshold ( co23_t *ctx, uint16_t alarm_th_ppm );
 
err_t co23_set_pressure_ref ( co23_t *ctx, uint16_t pressure_mbar );
 
err_t co23_set_calib_ref ( co23_t *ctx, uint16_t calib_ppm );
 
err_t co23_soft_reset_trigger ( co23_t *ctx, co23_soft_reset_value_t reset_cmd );
 
uint8_t co23_get_pwo_pin ( co23_t *ctx );
 
uint8_t co23_get_int_pin ( co23_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // CO23_H
 
 // co23
 
// ------------------------------------------------------------------------ END