barometer5.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 BAROMETER5_H
#define BAROMETER5_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 BAROMETER5_CMD_RESET                           0x1E
#define BAROMETER5_CMD_CONV_D1_OSR_256                 0x40
#define BAROMETER5_CMD_CONV_D1_OSR_512                 0x42
#define BAROMETER5_CMD_CONV_D1_OSR_1024                0x44
#define BAROMETER5_CMD_CONV_D1_OSR_2048                0x46
#define BAROMETER5_CMD_CONV_D1_OSR_4096                0x48
#define BAROMETER5_CMD_CONV_D2_OSR_256                 0x50
#define BAROMETER5_CMD_CONV_D2_OSR_512                 0x52
#define BAROMETER5_CMD_CONV_D2_OSR_1024                0x54
#define BAROMETER5_CMD_CONV_D2_OSR_2048                0x56
#define BAROMETER5_CMD_CONV_D2_OSR_4096                0x58
#define BAROMETER5_CMD_ADC_READ                        0x00
#define BAROMETER5_CMD_PROM_READ_START                 0xA0
 
 // barometer5_reg
 
#define BAROMETER5_RATIO_256                           0x00       
#define BAROMETER5_RATIO_512                           0x01
#define BAROMETER5_RATIO_1024                          0x02
#define BAROMETER5_RATIO_2048                          0x03
#define BAROMETER5_RATIO_4096                          0x04
 
#define BAROMETER5_SET_DEV_ADDR                        0x76
 
 // barometer5_set
 
#define BAROMETER5_MAP_MIKROBUS( cfg, mikrobus )  \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA )
 
 // barometer5_map
 // barometer5
 
typedef struct
{
    // Modules
    i2c_master_t i2c;             
    // I2C slave address
    uint8_t slave_address;        
    float sea_lvl_pressure;       
    uint16_t press_sens_c1;       
    uint16_t press_off_c2;        
    uint16_t press_tcs_c3;        
    uint16_t press_tco_c4;        
    uint16_t press_tref_c5;       
    uint16_t press_tempsens_c6;   
    uint8_t ratio_temp;           
    uint8_t ratio_press;          
} barometer5_t;
 
typedef struct
{
    pin_name_t  scl;          
    pin_name_t  sda;          
    uint32_t  i2c_speed;      
    uint8_t   i2c_address;    
    float sea_level_pressure; 
} barometer5_cfg_t;
 
typedef enum
{
    BAROMETER5_OK = 0,
    BAROMETER5_ERROR = -1
 
} barometer5_return_value_t;
 
void barometer5_cfg_setup ( barometer5_cfg_t *cfg );
 
err_t barometer5_init ( barometer5_t *ctx, barometer5_cfg_t *cfg );
 
err_t barometer5_default_cfg ( barometer5_t *ctx );
 
err_t barometer5_generic_write ( barometer5_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t barometer5_generic_read ( barometer5_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t barometer5_set_command ( barometer5_t *ctx, uint8_t cmd );
 
err_t barometer5_set_ratio ( barometer5_t *ctx, uint8_t temp_ratio, uint8_t press_ratio );
 
err_t barometer5_sw_reset ( barometer5_t *ctx );
 
err_t barometer5_get_calibration_data ( barometer5_t *ctx );
 
err_t barometer5_get_raw_data ( barometer5_t *ctx, uint32_t *temp_data, uint32_t *press_data );
 
err_t barometer5_get_temperature ( barometer5_t *ctx, float *temperature );
 
err_t barometer5_get_pressure ( barometer5_t *ctx, float *pressure );
 
err_t barometer5_calculate_altitude ( barometer5_t *ctx, float *altitude );
 
err_t barometer5_get_data ( barometer5_t *ctx, float *temperature, float *pressure );
 
 
#ifdef __cplusplus
}
#endif
#endif // BAROMETER5_H
 
 // barometer5
 
// ------------------------------------------------------------------------ END