barometer9.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 BAROMETER9_H
#define BAROMETER9_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 BAROMETER9_REG_PART_ID0             0x00
#define BAROMETER9_REG_PART_ID1             0x01
#define BAROMETER9_REG_UIND0                0x02
#define BAROMETER9_REG_UIND1                0x03
#define BAROMETER9_REG_UIND2                0x04
#define BAROMETER9_REG_UIND3                0x05
#define BAROMETER9_MODE_CFG                 0x06
#define BAROMETER9_MEAS_CFG                 0x07
#define BAROMETER9_STBY_CFG                 0x08
#define BAROMETER9_OVS_CFG                  0x09
#define BAROMETER9_MAVG_CFG                 0x0A
#define BAROMETER9_INTF_CFG                 0x0B
#define BAROMETER9_INT_CFG                  0x0C
#define BAROMETER9_PRESS_LO_XL_CFG          0x0D
#define BAROMETER9_PRESS_LO_L_CFG           0x0E
#define BAROMETER9_PRESS_LO_H_CFG           0x0F
#define BAROMETER9_PRESS_HI_XL_CFG          0x10
#define BAROMETER9_PRESS_HI_L_CFG           0x11
#define BAROMETER9_PRESS_HI_H_CFG           0x12
#define BAROMETER9_FIFO_CFG                 0x13
#define BAROMETER9_DATA_STAT                0x14
#define BAROMETER9_FIFO_STAT                0x15
#define BAROMETER9_INT_STAT                 0x16
#define BAROMETER9_PRESS_OUT_XL             0x17
#define BAROMETER9_PRESS_OUT_L              0x18
#define BAROMETER9_PRESS_OUT_H              0x19
#define BAROMETER9_TEMP_OUT_L               0x1A
#define BAROMETER9_TEMP_OUT_H               0x1B
#define BAROMETER9_PRESS_OUT_F_XL           0x27
#define BAROMETER9_PRESS_OUT_F_L            0x28
#define BAROMETER9_PRESS_OUT_F_H            0x29
 
 // barometer9_reg
 
#define BAROMETER9_HIGH_POWER_MODE         0x80
#define BAROMETER9_LOW_POWER_MODE          0x00
#define BAROMETER9_DIRECT_PATH             0x00
#define BAROMETER9_FIFO_MODE               0x20
#define BAROMETER9_AVERAGE_MODE            0x40
#define BAROMETER9_IDLE_MODE               0x00
#define BAROMETER9_MEASURMENT_MODE         0x10
#define BAROMETER9_SW_RESET                0x08
#define BAROMETER9_READ_PRESS_ONLY         0x01
#define BAROMETER9_READ_TEMP_ONLY          0x02
#define BAROMETER9_READ_PRES_AND_TEMP      0x03
 
#define BAROMETER9_P_CONV_0                0x00
#define BAROMETER9_P_CONV_1                0x08
#define BAROMETER9_P_CONV_2                0x10
#define BAROMETER9_PT_RATE_1               0x00
#define BAROMETER9_PT_RATE_4               0x01
#define BAROMETER9_PT_RATE_8               0x02
#define BAROMETER9_PT_RATE_16              0x03
#define BAROMETER9_PT_RATE_32              0x04
#define BAROMETER9_PT_RATE_64              0x05
#define BAROMETER9_PT_RATE_128             0x06
#define BAROMETER9_PT_RATE_256             0x07
 
#define BAROMETER9_TEMPERATURE_CON_CONST   128
#define BAROMETER9_K_TO_C_CON_CONST        273.15f
#define BAROMETER9_PRESSURE_CON_CONST      64
 
#define BAROMETER9_DEVICE_ID                0x0321
 
#define BAROMETER9_DEVICE_ADDRESS            0x20
 
#define BAROMETER9_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define BAROMETER9_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // barometer9_set
 
#define BAROMETER9_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 )
 
 // barometer9_map
 // barometer9
 
typedef enum
{
    BAROMETER9_DRV_SEL_SPI,      
    BAROMETER9_DRV_SEL_I2C       
} barometer9_drv_t;
 
struct barometer9_s;
typedef err_t ( *barometer9_master_io_t )( struct barometer9_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct barometer9_s
{
    digital_in_t int_pin;               
    i2c_master_t i2c;                   
    spi_master_t spi;                   
    uint8_t      slave_address;         
    pin_name_t   chip_select;           
    barometer9_drv_t drv_sel;           
    barometer9_master_io_t write_f;     
    barometer9_master_io_t read_f;      
} barometer9_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;  
    barometer9_drv_t drv_sel;   
} barometer9_cfg_t;
 
typedef enum
{
    BAROMETER9_OK = 0,
    BAROMETER9_ERROR = -1
 
} barometer9_return_value_t;
 
void barometer9_cfg_setup ( barometer9_cfg_t *cfg );
 
void barometer9_drv_interface_sel ( barometer9_cfg_t *cfg, barometer9_drv_t drv_sel );
 
err_t barometer9_init ( barometer9_t *ctx, barometer9_cfg_t *cfg );
 
err_t barometer9_default_cfg ( barometer9_t *ctx );
 
err_t barometer9_generic_write ( barometer9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
 
err_t barometer9_generic_read ( barometer9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
 
err_t barometer9_read_part_id ( barometer9_t *ctx, uint16_t *part_id );
 
err_t barometer9_get_temperature ( barometer9_t *ctx, float *temperature );
 
err_t barometer9_get_pressure ( barometer9_t *ctx, float *pressure );
 
err_t barometer9_sw_reset ( barometer9_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // BAROMETER9_H
 
 // barometer9
 
// ------------------------------------------------------------------------ END