pressure14.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 PRESSURE14_H
#define PRESSURE14_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 PRESSURE14_STATUS_PWR_IND                               0x40
#define PRESSURE14_STATUS_BUSY_FLAG                             0x20
#define PRESSURE14_STATUS_ERR_FLAG                              0x04
#define PRESSURE14_STATUS_MATH_SAT                              0x01
 
 // pressure14_stat_reg
 
#define PRESSURE14_CONV_UNIT_PSI                                0x00
#define PRESSURE14_CONV_UNIT_PASCAL                             0x01
#define PRESSURE14_CONV_UNIT_KILOPASCAL                         0x02
#define PRESSURE14_CONV_UNIT_MMHG                               0x03
#define PRESSURE14_CONV_UNIT_INHG                               0x04
#define PRESSURE14_CONV_UNIT_ATMOSPHERIC                        0x05
#define PRESSURE14_CONV_UNIT_MILIBAR                            0x06
#define PRESSURE14_CONV_UNIT_BAR                                0x07
                                                               
 // pressure14_pressure_conversion_units
 
#define PRESSURE14_CONV_UNIT_CELSIUS                            0x00
#define PRESSURE14_CONV_UNIT_KELVIN                             0x01
#define PRESSURE14_CONV_UNIT_FAHRENHEIT                         0x02
                                                               
 // pressure14_temperature_conversion_units
 
#define PRESSURE14_CONST_PSI                                    1.00000
#define PRESSURE14_CONST_PASCAL                                 6894.76
#define PRESSURE14_CONST_KILOPASCAL                             6.89476
#define PRESSURE14_CONST_MMHG                                   51.7149
#define PRESSURE14_CONST_INHG                                   2.03602
#define PRESSURE14_CONST_ATMOSPHERIC                            0.06805
#define PRESSURE14_CONST_MILIBAR                                68.9500
#define PRESSURE14_CONST_BAR                                    0.06895
                                                               
 // pressure14_pressure_conversion_constants
 
#define PRESSURE14_CONST_ADDI_CELS                              0.00000
#define PRESSURE14_CONST_MULT_CELS                              1.00000
#define PRESSURE14_CONST_ADDI_KELV                              273.150
#define PRESSURE14_CONST_MULT_KELV                              1.00000
#define PRESSURE14_CONST_ADDI_FAHR                              32.0000
#define PRESSURE14_CONST_MULT_FAHR                              1.80000
 
 // pressure14_temperature_conversion_constants
 
#define PRESSURE14_CONST_PRESS_OUT_MIN                          1677722.00
#define PRESSURE14_CONST_PRESS_OUT_MAX                          13421772.0
#define PRESSURE14_CONST_PRESS_VAL_MIN                          0.00000000
#define PRESSURE14_CONST_PRESS_VAL_MAX                          60.0000000
#define PRESSURE14_CONST_TEMP_MIN                               -50.000000
#define PRESSURE14_CONST_TEMP_MAX                               150.000000
#define PRESSURE14_CONST_TEMP_OUT_MAX                           16777215.0
 
#define PRESSURE14_CMD_OUT_MEAS                                 0xAA
#define PRESSURE14_CMD_DUMMY                                    0x00
 
 // pressure14_general_sensor_constants
 
//
 
#define PRESSURE14_SET_DEV_ADDR                                 0x28
 
 // pressure14_set
 
#define PRESSURE14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // pressure14_map
 // pressure14
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;       
    // Modules
    i2c_master_t i2c;            
    // I2C slave address
    uint8_t slave_address;       
} pressure14_t;
 
typedef struct
{                               
    pin_name_t  scl;             
    pin_name_t  sda;             
    pin_name_t  int_pin;         
    uint32_t  i2c_speed;         
    uint8_t   i2c_address;       
} pressure14_cfg_t;
 
typedef enum
{
   PRESSURE14_OK = 0,
   PRESSURE14_ERROR = -1
 
} pressure14_return_value_t;
 
void pressure14_cfg_setup ( pressure14_cfg_t *cfg );
 
err_t pressure14_init ( pressure14_t *ctx, pressure14_cfg_t *cfg );
 
err_t pressure14_generic_write ( pressure14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t pressure14_generic_read ( pressure14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
void pressure14_measure_cmd ( pressure14_t *ctx );
 
uint8_t pressure14_check_busy_flag_int ( pressure14_t *ctx );
 
void pressure14_read_press_and_temp ( pressure14_t *ctx, uint8_t *status_byte, uint32_t *pressure_data, uint32_t *temp_data );
 
float pressure14_get_pressure ( uint32_t pressure_raw, uint8_t conv_unit );
 
 
float pressure14_get_temperature ( uint32_t temperature_raw, uint8_t conv_unit );
#ifdef __cplusplus
}
#endif
#endif // PRESSURE14_H
 
 // pressure14
 
// ------------------------------------------------------------------------ END