alcohol3.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 ALCOHOL3_H
#define ALCOHOL3_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_i2c_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ALCOHOL3_MAP_MIKROBUS( cfg, mikrobus )   \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define ALCOHOL3_RETVAL  uint8_t
 
#define ALCOHOL3_OK                      0x00
#define ALCOHOL3_INIT_ERROR              0xFF
#define ALCOHOL3_DEVICE_SLAVE_ADDRESS    0x4D
#define ALCOHOL3_PARAM_CO_OUT_MIN        1 
#define ALCOHOL3_PARAM_CO_OUT_MAX        1000
#define ALCOHOL3_PARAM_SUPPLY_IN_MIN     0
#define ALCOHOL3_PARAM_SUPPLY_IN_MAX     4096
// ppm to mg/L
 
#define ALCOHOL3_CONV_MGL_PARAM_A        1.82
#define ALCOHOL3_CONV_MGL_PARAM_B        0.91
#define ALCOHOL3_CONV_MGL_PARAM_C        0.18
#define ALCOHOL3_CONV_MGL_PARAM_D        0.09
 
#define ALCOHOL3_CONV_AIR_PPM_PARAM_A    1000
#define ALCOHOL3_CONV_AIR_PPM_PARAM_B    500
#define ALCOHOL3_CONV_AIR_PPM_PARAM_C    100
#define ALCOHOL3_CONV_AIR_PPM_PARAM_D    50
 // CO [ ppm ]
 
#define ALCOHOL3_CO_PPM_0                0
#define ALCOHOL3_CO_PPM_10               10
#define ALCOHOL3_CO_PPM_50               50
#define ALCOHOL3_CO_PPM_100              100
#define ALCOHOL3_CO_PPM_500              500
 
// Equivalent C2H5OH
 
#define ALCOHOL3_EQU_TO_PPM_0            0
#define ALCOHOL3_EQU_TO_PPM_10           1
#define ALCOHOL3_EQU_TO_PPM_50           6
#define ALCOHOL3_EQU_TO_PPM_100          18
#define ALCOHOL3_EQU_TO_PPM_500          274
 // End group macro
 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct
{
    
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
} alcohol3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
} alcohol3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void alcohol3_cfg_setup ( alcohol3_cfg_t *cfg );
 
ALCOHOL3_RETVAL alcohol3_init ( alcohol3_t *ctx, alcohol3_cfg_t *cfg );
 
void alcohol3_default_cfg ( alcohol3_t *ctx );
 
void alcohol3_generic_write ( alcohol3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void alcohol3_generic_read ( alcohol3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
uint16_t alcohol3_get_adc_data ( alcohol3_t *ctx );
 
uint16_t alcohol3_get_co_in_ppm ( alcohol3_t *ctx );
 
float alcohol3_get_co_in_mgl ( alcohol3_t *ctx );
 
uint16_t alcohol3_ethanol_in_ppm ( alcohol3_t *ctx );
 
float alcohol3_get_percentage_bac ( alcohol3_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif  // _ALCOHOL3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END