airflow.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 AIRFLOW_H
#define AIRFLOW_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_spi_master.h"
 
#define AIRFLOW_I2C_CMD_RESET                   0x11
#define AIRFLOW_I2C_CMD_GET_SIG                 0x23
#define AIRFLOW_I2C_CMD_GET_DATA                0x26
#define AIRFLOW_I2C_CMD_CONV                    0x27
#define AIRFLOW_I2C_CMD_GET_NON_BAR             0x50
#define AIRFLOW_I2C_CMD_GET_NON_BLOCK_BAR       0x51
#define AIRFLOW_SPI_CMD_NONE                    0x00
#define AIRFLOW_SPI_CMD_RESET                   0x01
#define AIRFLOW_SPI_CMD_CONV                    0x04
#define AIRFLOW_SPI_CMD_STOP                    0x05
#define AIRFLOW_SPI_CMD_GET_DATA                0x06
#define AIRFLOW_SPI_CMD_GET_BAR                 0x07
#define AIRFLOW_SPI_CMD_GET_SIG                 0x0C
 
 // airflow_reg
 
#define AIRFLOW_NO_BAROMETRIC_CORRECTION    0x01
#define AIRFLOW_BAROMETRIC_CORRECTION       0x03
 
#define AIRFLOW_SET_DEV_ADDR                    0x5B
 
 // airflow_set
 
#define AIRFLOW_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.rdy = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // airflow_map
 // airflow
 
typedef enum
{
   AIRFLOW_DRV_SEL_SPI,      
   AIRFLOW_DRV_SEL_I2C       
} airflow_drv_t;
 
typedef err_t ( *airflow_master_io_t )( struct airflow_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct airflow_s
{
    digital_in_t  rdy;             
    i2c_master_t  i2c;             
    spi_master_t  spi;             
    uint8_t     slave_address;     
    pin_name_t  chip_select;       
   airflow_drv_t  drv_sel;         
   airflow_master_io_t  write_f;   
   airflow_master_io_t  read_f;    
   uint8_t major_fw_ver;
   uint8_t minor_fw_ver;
   char part_number[ 12 ];
   char lot_number[ 8 ];
   uint16_t pressure_range;
   char output_type;
   uint16_t scale_factor;
   char calibration_id[ 3 ];
   uint8_t week;
   uint8_t year;
   uint16_t sequence_number;
 
} airflow_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  miso;       
    pin_name_t  mosi;       
    pin_name_t  sck;        
    pin_name_t  cs;         
    pin_name_t  rdy;        
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
    uint32_t                           spi_speed;   
    spi_master_mode_t                  spi_mode;    
    spi_master_chip_select_polarity_t  cs_polarity; 
   airflow_drv_t  drv_sel;  
} airflow_cfg_t;
 
typedef enum
{
   AIRFLOW_OK = 0,
   AIRFLOW_ERROR = -1
 
} airflow_return_value_t;
 
void airflow_cfg_setup ( airflow_cfg_t *cfg );
 
void airflow_drv_interface_selection ( airflow_cfg_t *cfg, airflow_drv_t drv_sel );
 
err_t airflow_init ( airflow_t *ctx, airflow_cfg_t *cfg );
 
err_t airflow_default_cfg ( airflow_t *ctx );
 
err_t airflow_generic_write ( airflow_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t airflow_generic_read ( airflow_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
void airflow_reset_device ( airflow_t *ctx );
 
uint8_t airflow_check_ready ( airflow_t *ctx );
 
err_t airflow_get_differential_pressure ( airflow_t *ctx, float *pressure );
 
err_t airflow_get_atmospheric_pressure ( airflow_t *ctx, float *pressure, float *temperature );
 
err_t airflow_get_status ( airflow_t *ctx, uint8_t *status );
 
#ifdef __cplusplus
}
#endif
#endif // AIRFLOW_H
 
 // airflow
 
// ------------------------------------------------------------------------ END