altitude3.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * 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 ALTITUDE3_H
#define ALTITUDE3_H
 
#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 "math.h"
#include "string.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define ALTITUDE3_MAP_MIKROBUS( cfg, mikrobus ) \
  cfg.scl  = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
  cfg.sda  = MIKROBUS( mikrobus, MIKROBUS_SDA )
#define ALTITUDE3_RETVAL  uint8_t
 
#define ALTITUDE3_OK           0x00
#define ALTITUDE3_INIT_ERROR   0xFF
#define ALTITUDE3_SLAVE_ADDR                         0x63
 
#define ALTITUDE3_LOW_POWER_T_FIRST                  0x609C
#define ALTITUDE3_LOW_POWER_P_FIRST                  0x401A
#define ALTITUDE3_NORMAL_T_FIRST                     0x6825
#define ALTITUDE3_NORMAL_P_FIRST                     0x48A3
#define ALTITUDE3_LOW_NOISE_T_FIRST                  0x70DF
#define ALTITUDE3_LOW_NOISE_P_FIRST                  0x5059
#define ALTITUDE3_ULTRA_LOW_NOISE_T_FIRST            0x7866
#define ALTITUDE3_ULTRA_LOW_NOISE_P_FIRST            0x58E0
 
#define ALTITUDE3_OK                                 0x00
#define ALTITUDE3_T_FIRST_ORDER                      0x01
#define ALTITUDE3_P_FIRST_ORDER                      0x02
#define ALTITUDE3_INITIALIZED                        0x03
#define ALTITUDE3_ERROR                              0xFF
 
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct 
{
  
  uint32_t  min_delay_us;
  uint16_t  sensor_const[ 4 ];
  uint32_t  p_pa_calib[ 3 ];
  float     lut_lower;
  float     lut_upper;
  double    quadr_factor;
  uint16_t  offst_factor;
 
} altitude3_param_t;
 
typedef struct
{
  //Sensor data
 
  int8_t temperature; 
  uint32_t pressure; 
  int16_t altitude;
 
} sensor_data_t;
 
typedef struct
{
    // Modules 
 
    i2c_master_t i2c;
 
    // ctx variable 
 
    uint8_t slave_address;
 
    uint8_t update_check;
 
    sensor_data_t sens_data;
 
} altitude3_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t scl;
    pin_name_t sda;
 
    // static variable 
 
    uint32_t i2c_speed;
    uint8_t i2c_address;
 
    uint8_t update_check_cfg;
 
} altitude3_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void altitude3_cfg_setup ( altitude3_cfg_t *cfg );
 
ALTITUDE3_RETVAL altitude3_init ( altitude3_t *ctx, altitude3_cfg_t *cfg );
 
void altitude3_default_cfg ( altitude3_t *ctx );
 
void altitude3_generic_write ( altitude3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
 
void altitude3_generic_read ( altitude3_t *ctx, uint8_t *reg_buf, uint8_t *data_buf, uint8_t len );
 
uint8_t altitude3_measurement_mode ( altitude3_t *ctx, uint16_t mode_cmd );
 
void altitude3_soft_reset ( altitude3_t *ctx );
 
uint8_t altitude3_read_adc_results ( altitude3_t *ctx, uint8_t read_order, int16_t *temperature, uint32_t *pressure );
 
void altitude3_init_cfg( altitude3_t *ctx, altitude3_param_t *s );
 
uint8_t altitude3_get_data ( altitude3_t *ctx, uint8_t read_order );
 
#ifdef __cplusplus
}
#endif
#endif  // _ALTITUDE3_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END