altitude6.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 ALTITUDE6_H
#define ALTITUDE6_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 ALTITUDE6_CMD_RESET                           0x1E
#define ALTITUDE6_CMD_CONV_D1_OSR_256                 0x40
#define ALTITUDE6_CMD_CONV_D1_OSR_512                 0x42
#define ALTITUDE6_CMD_CONV_D1_OSR_1024                0x44
#define ALTITUDE6_CMD_CONV_D1_OSR_2048                0x46
#define ALTITUDE6_CMD_CONV_D1_OSR_4096                0x48
#define ALTITUDE6_CMD_CONV_D2_OSR_256                 0x50
#define ALTITUDE6_CMD_CONV_D2_OSR_512                 0x52
#define ALTITUDE6_CMD_CONV_D2_OSR_1024                0x54
#define ALTITUDE6_CMD_CONV_D2_OSR_2048                0x56
#define ALTITUDE6_CMD_CONV_D2_OSR_4096                0x58
#define ALTITUDE6_CMD_ADC_READ                        0x00
#define ALTITUDE6_CMD_PROM_READ_START                 0xA0
 
 // altitude6_reg
 
#define ALTITUDE6_RATIO_256                           0x00       
#define ALTITUDE6_RATIO_512                           0x01
#define ALTITUDE6_RATIO_1024                          0x02
#define ALTITUDE6_RATIO_2048                          0x03
#define ALTITUDE6_RATIO_4096                          0x04
 
#define ALTITUDE6_SET_DEV_ADDR_1                      0x76
#define ALTITUDE6_SET_DEV_ADDR_0                      0x77
 
#define ALTITUDE6_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define ALTITUDE6_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // altitude6_set
 
#define ALTITUDE6_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 )
 
 // altitude6_map
 // altitude6
 
typedef enum
{
    ALTITUDE6_DRV_SEL_SPI,      
    ALTITUDE6_DRV_SEL_I2C       
} altitude6_drv_t;
 
typedef err_t ( *altitude6_master_io_t )( struct altitude6_s*, uint8_t, uint8_t*, uint8_t ); 
typedef struct altitude6_s
{
    i2c_master_t  i2c;                     
    spi_master_t  spi;                     
    uint8_t     slave_address;             
    pin_name_t  chip_select;               
    altitude6_drv_t  drv_sel;              
    altitude6_master_io_t  write_f;        
    altitude6_master_io_t  read_f;         
    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;          
} altitude6_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;         
    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;     
    altitude6_drv_t  drv_sel;     
    float sea_level_pressure;     
} altitude6_cfg_t;
 
typedef enum
{
    ALTITUDE6_OK = 0,
    ALTITUDE6_ERROR = -1
 
} altitude6_return_value_t;
 
void altitude6_cfg_setup ( altitude6_cfg_t *cfg );
 
void altitude6_drv_interface_selection ( altitude6_cfg_t *cfg, altitude6_drv_t drv_sel );
 
err_t altitude6_init ( altitude6_t *ctx, altitude6_cfg_t *cfg );
 
err_t altitude6_default_cfg ( altitude6_t *ctx );
 
err_t altitude6_set_command ( altitude6_t *ctx, uint8_t cmd );
 
err_t altitude6_generic_read ( altitude6_t *ctx, uint8_t cmd, uint8_t *data_out, uint8_t len );
 
err_t altitude6_set_ratio ( altitude6_t *ctx, uint8_t temp_ratio, uint8_t press_ratio );
 
err_t altitude6_sw_reset ( altitude6_t *ctx );
 
err_t altitude6_get_calibration_data ( altitude6_t *ctx );
 
err_t altitude6_get_raw_data ( altitude6_t *ctx, uint32_t *temp_data, uint32_t *press_data );
 
err_t altitude6_get_temperature ( altitude6_t *ctx, float *temperature );
 
err_t altitude6_get_pressure ( altitude6_t *ctx, float *pressure );
 
err_t altitude6_get_data ( altitude6_t *ctx, float *temperature, float *pressure, float *altitude );
 
 
 
#ifdef __cplusplus
}
#endif
#endif // ALTITUDE6_H
 
 // altitude6
 
// ------------------------------------------------------------------------ END