pressure18.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 PRESSURE18_H
#define PRESSURE18_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"
#include "spi_specifics.h"
 
#define PRESSURE18_REG_CHIP_ID                  0x00
#define PRESSURE18_REG_ERR                      0x02
#define PRESSURE18_REG_STATUS                   0x03
#define PRESSURE18_REG_DATA_0                   0x04
#define PRESSURE18_REG_DATA_1                   0x05
#define PRESSURE18_REG_DATA_2                   0x06
#define PRESSURE18_REG_DATA_3                   0x07
#define PRESSURE18_REG_DATA_4                   0x08
#define PRESSURE18_REG_DATA_5                   0x09
#define PRESSURE18_REG_SENSOR_TIME_0            0x0C
#define PRESSURE18_REG_SENSOR_TIME_1            0x0D
#define PRESSURE18_REG_SENSOR_TIME_2            0x0E
#define PRESSURE18_REG_SENSOR_TIME_3            0x0F
#define PRESSURE18_REG_EVENT                    0x10
#define PRESSURE18_REG_INT_STATUS               0x11
#define PRESSURE18_REG_FIFO_LENGTH_0            0x12
#define PRESSURE18_REG_FIFO_LENGTH_1            0x13
#define PRESSURE18_REG_FIFO_DATA                0x14
#define PRESSURE18_REG_FIFO_WTM_0               0x15
#define PRESSURE18_REG_FIFO_WTM_1               0x16
#define PRESSURE18_REG_FIFO_CONFIG_1            0x17
#define PRESSURE18_REG_FIFO_CONFIG_2            0x18
#define PRESSURE18_REG_INT_CTRL                 0x19
#define PRESSURE18_REG_IF_CONF                  0x1A
#define PRESSURE18_REG_PWR_CTRL                 0x1B
#define PRESSURE18_REG_OSR                      0x1C
#define PRESSURE18_REG_ODR                      0x1D
#define PRESSURE18_REG_CONFIG                   0x1F
#define PRESSURE18_REG_CALIB_DATA               0x31
#define PRESSURE18_REG_CMD                      0x7E
 
 // pressure18_reg
 
#define PRESSURE18_CHIP_ID                      0x50
 
#define PRESSURE18_ERR_FATAL                    0x01
#define PRESSURE18_ERR_CMD                      0x02
#define PRESSURE18_ERR_CONF                     0x04
 
#define PRESSURE18_STATUS_CMD_RDY               0x10
#define PRESSURE18_STATUS_DRDY_PRESS            0x20
#define PRESSURE18_STATUS_DRDY_TEMP             0x40
 
#define PRESSURE18_INT_CTRL_OD_PUSH_PULL        0x00
#define PRESSURE18_INT_CTRL_OD_OPEN_DRAIN       0x01
#define PRESSURE18_INT_CTRL_LEVEL_ACTIVE_LOW    0x00
#define PRESSURE18_INT_CTRL_LEVEL_ACTIVE_HIGH   0x02
#define PRESSURE18_INT_CTRL_LATCH_DISABLED      0x00
#define PRESSURE18_INT_CTRL_LATCH_ENABLED       0x04
#define PRESSURE18_INT_CTRL_FWTM_DISABLED       0x00
#define PRESSURE18_INT_CTRL_FWTM_ENABLED        0x08
#define PRESSURE18_INT_CTRL_FFULL_DISABLED      0x00
#define PRESSURE18_INT_CTRL_FFULL_ENABLED       0x10
#define PRESSURE18_INT_CTRL_DRDY_DISABLED       0x00
#define PRESSURE18_INT_CTRL_DRDY_ENABLED        0x40
 
#define PRESSURE18_PWR_CTRL_PRESS_EN            0x01
#define PRESSURE18_PWR_CTRL_TEMP_EN             0x02
#define PRESSURE18_PWR_CTRL_MODE_SLEEP          0x00
#define PRESSURE18_PWR_CTRL_MODE_FORCED         0x10
#define PRESSURE18_PWR_CTRL_MODE_NORMAL         0x30
 
#define PRESSURE18_OSR_P_X1                     0x00
#define PRESSURE18_OSR_P_X2                     0x01
#define PRESSURE18_OSR_P_X4                     0x02
#define PRESSURE18_OSR_P_X8                     0x03
#define PRESSURE18_OSR_P_X16                    0x04
#define PRESSURE18_OSR_P_X32                    0x05
#define PRESSURE18_OSR_T_X1                     0x00
#define PRESSURE18_OSR_T_X2                     0x08
#define PRESSURE18_OSR_T_X4                     0x10
#define PRESSURE18_OSR_T_X8                     0x18
#define PRESSURE18_OSR_T_X16                    0x20
#define PRESSURE18_OSR_T_X32                    0x28
 
#define PRESSURE18_ODR_5_MS                     0x00
#define PRESSURE18_ODR_10_MS                    0x01
#define PRESSURE18_ODR_20_MS                    0x02
#define PRESSURE18_ODR_40_MS                    0x03
#define PRESSURE18_ODR_80_MS                    0x04
#define PRESSURE18_ODR_160_MS                   0x05
#define PRESSURE18_ODR_320_MS                   0x06
#define PRESSURE18_ODR_640_MS                   0x07
#define PRESSURE18_ODR_1p280_S                  0x08
#define PRESSURE18_ODR_2p560_S                  0x09
#define PRESSURE18_ODR_5p120_S                  0x0A
#define PRESSURE18_ODR_10p24_S                  0x0B
#define PRESSURE18_ODR_20p48_S                  0x0C
#define PRESSURE18_ODR_40p96_S                  0x0D
#define PRESSURE18_ODR_81p92_S                  0x0E
#define PRESSURE18_ODR_163p84_S                 0x0F
#define PRESSURE18_ODR_327p68_S                 0x10
#define PRESSURE18_ODR_655p36_S                 0x11        
 
#define PRESSURE18_CMD_NOP                      0x00
#define PRESSURE18_CMD_EXTMODE_EN_MIDDLE        0x34
#define PRESSURE18_CMD_FIFO_FLUSH               0xB0
#define PRESSURE18_CMD_SOFT_RESET               0xB6
 
#define PRESSURE18_PA_TO_MBAR                   0.01
 
#define PRESSURE18_DEVICE_ADDRESS_0             0x76
#define PRESSURE18_DEVICE_ADDRESS_1             0x77
 
#define PRESSURE18_SET_DATA_SAMPLE_EDGE         SET_SPI_DATA_SAMPLE_EDGE
#define PRESSURE18_SET_DATA_SAMPLE_MIDDLE       SET_SPI_DATA_SAMPLE_MIDDLE
 
 // pressure18_set
 
#define PRESSURE18_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.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // pressure18_map
 // pressure18
 
typedef enum
{
    PRESSURE18_DRV_SEL_SPI,             
    PRESSURE18_DRV_SEL_I2C              
} pressure18_drv_t;
 
typedef err_t ( *pressure18_master_io_t )( struct pressure18_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct
{
    float par_t1;
    float par_t2;
    float par_t3;
    float par_p1;
    float par_p2;
    float par_p3;
    float par_p4;
    float par_p5;
    float par_p6;
    float par_p7;
    float par_p8;
    float par_p9;
    float par_p10;
    float par_p11;
    float t_lin;
    
} pressure18_calib_coef_t;
 
typedef struct pressure18_s
{
    digital_in_t int_pin;               
    i2c_master_t i2c;                   
    spi_master_t spi;                   
    uint8_t      slave_address;         
    pin_name_t   chip_select;           
    pressure18_drv_t drv_sel;           
    pressure18_master_io_t write_f;     
    pressure18_master_io_t read_f;      
    pressure18_calib_coef_t calib_coef; 
} pressure18_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 int_pin;                 
    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; 
    pressure18_drv_t drv_sel;           
} pressure18_cfg_t;
 
typedef enum
{
    PRESSURE18_OK = 0,
    PRESSURE18_ERROR = -1
 
} pressure18_return_value_t;
 
void pressure18_cfg_setup ( pressure18_cfg_t *cfg );
 
void pressure18_drv_interface_selection ( pressure18_cfg_t *cfg, pressure18_drv_t drv_sel );
 
err_t pressure18_init ( pressure18_t *ctx, pressure18_cfg_t *cfg );
 
err_t pressure18_default_cfg ( pressure18_t *ctx );
 
err_t pressure18_generic_write ( pressure18_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t pressure18_generic_read ( pressure18_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t pressure18_write_register ( pressure18_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t pressure18_read_register ( pressure18_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t pressure18_check_communication ( pressure18_t *ctx );
 
uint8_t pressure18_get_int_pin ( pressure18_t *ctx );
 
err_t pressure18_soft_reset ( pressure18_t *ctx );
 
err_t pressure18_read_data ( pressure18_t *ctx, float *pressure, float *temperature );
 
#ifdef __cplusplus
}
#endif
#endif // PRESSURE18_H
 
 // pressure18
 
// ------------------------------------------------------------------------ END