pressure17.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 PRESSURE17_H
#define PRESSURE17_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 PRESSURE17_REG_MANUFACTURER_ID          0x0F
#define PRESSURE17_REG_PART_ID                  0x10
#define PRESSURE17_REG_POWER_DOWN               0x12
#define PRESSURE17_REG_RESET                    0x13
#define PRESSURE17_REG_MODE_CONTROL             0x14
#define PRESSURE17_REG_IIR_FIFO_CONTROL         0x15
#define PRESSURE17_REG_FIFO_DATA                0x18
#define PRESSURE17_REG_STATUS                   0x19
#define PRESSURE17_REG_PRESS_OUT_MSB            0x1A
#define PRESSURE17_REG_PRESS_OUT_LSB            0x1B
#define PRESSURE17_REG_PRESS_OUT_XL             0x1C
#define PRESSURE17_REG_TEMP_OUT_MSB             0x1D
#define PRESSURE17_REG_TEMP_OUT_LSB             0x1E
 
 // pressure17_reg
 
#define PRESSURE17_MANUFACTURER_ID              0xE0
#define PRESSURE17_PART_ID                      0x34
 
#define PRESSURE17_POWER_DOWN                   0x00
#define PRESSURE17_POWER_ACTIVE                 0x01
 
#define PRESSURE17_RSTB_RESET                   0x00
#define PRESSURE17_RSTB_ACTIVE                  0x01
 
#define PRESSURE17_MODE_AVE_NUM_8_TIMES         0x60
#define PRESSURE17_MODE_AVE_NUM_16_TIMES        0x80
#define PRESSURE17_MODE_AVE_NUM_32_TIMES        0xA0
#define PRESSURE17_MODE_AVE_NUM_64_TIMES        0xC0
#define PRESSURE17_MODE_DR_EN                   0x10
#define PRESSURE17_MODE_FULL_EN                 0x08
#define PRESSURE17_MODE_WTM_EN                  0x04
#define PRESSURE17_MODE_STANDBY_MODE            0x00
#define PRESSURE17_MODE_ONE_SHOT_MODE           0x01
#define PRESSURE17_MODE_CONTINUOUS_MODE         0x02
 
#define PRESSURE17_FIFO_EN                      0x80
#define PRESSURE17_WTM_LEVEL_2                  0x00
#define PRESSURE17_WTM_LEVEL_3                  0x40
#define PRESSURE17_IIR_OFF                      0x00
#define PRESSURE17_IIR_ON_WEAK                  0x01
#define PRESSURE17_IIR_ON_MIDDLE                0x02
#define PRESSURE17_IIR_ON_STRONG                0x03
 
#define PRESSURE17_FIFO_LVL_FIFO_EMPTY          0x00
#define PRESSURE17_FIFO_LVL_FIFO_NUM_1          0x01
#define PRESSURE17_FIFO_LVL_FIFO_NUM_2          0x02
#define PRESSURE17_FIFO_LVL_FIFO_NUM_3          0x03
#define PRESSURE17_FIFO_LVL_FIFO_FULL           0x04
 
#define PRESSURE17_STATUS_RD_FULL               0x04
#define PRESSURE17_STATUS_RD_WTM                0x02
#define PRESSURE17_STATUS_RD_DRDY               0x01
 
#define PRESSURE17_PRESS_COUNTS_PER_MBAR        2048
#define PRESSURE17_TEMP_COUNTS_PER_C            32
 
#define PRESSURE17_SET_DEV_ADDR                 0x5D
 
 // pressure17_set
 
#define PRESSURE17_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // pressure17_map
 // pressure17
 
typedef struct
{
    // Input pins
    digital_in_t int_pin;       
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} pressure17_t;
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} pressure17_cfg_t;
 
typedef enum
{
    PRESSURE17_OK = 0,
    PRESSURE17_ERROR = -1
 
} pressure17_return_value_t;
 
void pressure17_cfg_setup ( pressure17_cfg_t *cfg );
 
err_t pressure17_init ( pressure17_t *ctx, pressure17_cfg_t *cfg );
 
err_t pressure17_default_cfg ( pressure17_t *ctx );
 
err_t pressure17_generic_write ( pressure17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t pressure17_generic_read ( pressure17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t pressure17_write_register ( pressure17_t *ctx, uint8_t reg, uint8_t data_in );
 
err_t pressure17_read_register ( pressure17_t *ctx, uint8_t reg, uint8_t *data_out );
 
err_t pressure17_check_communication ( pressure17_t *ctx );
 
err_t pressure17_read_data ( pressure17_t *ctx, float *pressure, float *temperature );
 
uint8_t pressure17_get_int_pin ( pressure17_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // PRESSURE17_H
 
 // pressure17
 
// ------------------------------------------------------------------------ END