ozone3.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 OZONE3_H
#define OZONE3_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 OZONE3_REG_STATUS                      0x00
#define OZONE3_REG_LOCK                        0x01
#define OZONE3_REG_TIACN                       0x10
#define OZONE3_REG_REFCN                       0x11
#define OZONE3_REG_MODECN                      0x12
 
 // ozone3_reg
 
#define OZONE3_WRITE_MODE                      0x00
#define OZONE3_READ_ONLY_MODE                  0x01
 
#define OZONE3_RES_TIA_EXT                     0x00
#define OZONE3_RES_TIA_2750_Ohm                0x04
#define OZONE3_RES_TIA_3500_Ohm                0x08
#define OZONE3_RES_TIA_7K_Ohm                  0x0C
#define OZONE3_RES_TIA_14K_Ohm                 0x10
#define OZONE3_RES_TIA_35K_Ohm                 0x14
#define OZONE3_RES_TIA_120K_Ohm                0x18
#define OZONE3_RES_TIA_350K_Ohm                0x1C
#define OZONE3_RES_LOAD_10_Ohm                 0x00
#define OZONE3_RES_LOAD_33_Ohm                 0x01
#define OZONE3_RES_LOAD_50_Ohm                 0x02
#define OZONE3_RES_LOAD_100_Ohm                0x03
 
#define OZONE3_VREF_INT                        0x00
#define OZONE3_VREF_EXT                        0x80
#define OZONE3_PERCENTS_INT_ZERO_20            0x00
#define OZONE3_PERCENTS_INT_ZERO_50            0x20
#define OZONE3_PERCENTS_INT_ZERO_67            0x40
#define OZONE3_INT_ZERO_BYPASSED               0x60
#define OZONE3_BIAS_POL_NEGATIVE               0x00
#define OZONE3_BIAS_POL_POSITIVE               0x10
#define OZONE3_PERCENTS_BIAS_0                 0x00
#define OZONE3_PERCENTS_BIAS_1                 0x01
#define OZONE3_PERCENTS_BIAS_2                 0x02
#define OZONE3_PERCENTS_BIAS_4                 0x03
#define OZONE3_PERCENTS_BIAS_6                 0x04
#define OZONE3_PERCENTS_BIAS_8                 0x05
#define OZONE3_PERCENTS_BIAS_10                0x06
#define OZONE3_PERCENTS_BIAS_12                0x07
#define OZONE3_PERCENTS_BIAS_14                0x08
#define OZONE3_PERCENTS_BIAS_16                0x09
#define OZONE3_PERCENTS_BIAS_18                0x0A
#define OZONE3_PERCENTS_BIAS_20                0x0B
#define OZONE3_PERCENTS_BIAS_22                0x0C
#define OZONE3_PERCENTS_BIAS_24                0x0D
#define OZONE3_FET_DIS                         0x00
#define OZONE3_FET_EN                          0x80
#define OZONE3_DEEP_SLEEP_MODE                 0x00
#define OZONE3_LEAD_MODE_2                     0x01
#define OZONE3_STANDBY_MODE                    0x02
#define OZONE3_LEAD_MODE_3                     0x03
#define OZONE3_TEMP_MODE_TIA_OFF               0x06
#define OZONE3_TEMP_MODE_TIA_ON                0x07
#define OZONE3_DEVICE_ENABLE                   0x00
#define OZONE3_DEVICE_DISABLE                  0x01
 
#define OZONE3_SET_DEV_ADDR                    0x48
#define OZONE3_ADC_DEVICE_ADDR                 0x4D
 
 // ozone3_set
 
#define OZONE3_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 )
 
 // ozone3_map
 // ozone3
 
typedef struct
{
    // Output pins
 
    digital_out_t  rst;     
    // Input pins
 
    digital_in_t  an;       
    // Modules
 
    i2c_master_t i2c;       
    // I2C slave address
 
    uint8_t slave_address;  
} ozone3_t;
 
typedef struct
{
    pin_name_t  scl;       
    pin_name_t  sda;       
    pin_name_t  an;        
    pin_name_t  rst;       
    uint32_t  i2c_speed;   
    uint8_t   i2c_address; 
} ozone3_cfg_t;
 
typedef enum
{
   OZONE3_OK = 0,
   OZONE3_ERROR = -1
 
} ozone3_return_value_t;
 
void ozone3_cfg_setup ( ozone3_cfg_t *cfg );
 
err_t ozone3_init ( ozone3_t *ctx, ozone3_cfg_t *cfg );
 
err_t ozone3_default_cfg ( ozone3_t *ctx );
 
err_t ozone3_generic_write ( ozone3_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t ozone3_generic_read ( ozone3_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t ozone3_enable ( ozone3_t *ctx, uint8_t state );
 
err_t ozone3_write_byte ( ozone3_t *ctx, uint8_t reg, uint8_t dev_data );
 
uint8_t ozone3_read_byte ( ozone3_t *ctx, uint8_t reg );
 
uint16_t ozone3_read_adc ( ozone3_t *ctx );
 
float ozone3_get_o3_ppm ( ozone3_t *ctx );
 
void ozone3_wait_ready ( ozone3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // OZONE3_H
 
 // ozone3
 
// ------------------------------------------------------------------------ END