barometer7.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 BAROMETER7_H
#define BAROMETER7_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_spi_master.h"
#include "spi_specifics.h"
 
#define BAROMETER7_CMD_TRIGGER_TEST_MODE        0x0C
#define BAROMETER7_CMD_RESET_BIT_MASK           0x10
#define BAROMETER7_CMD_ACQUIRE_PRESSURE         0x20
#define BAROMETER7_CMD_ACQUIRE_TEMPERATURE      0x40
#define BAROMETER7_CMD_TRIGGER_DIAGNOSIS        0x80
#define BAROMETER7_CMD_ACQUIRE_IDENTIFIER       0xE0
 
 // barometer7_cmd
 
#define BAROMETER7_SET_DATA_SAMPLE_EDGE      SET_SPI_DATA_SAMPLE_EDGE
#define BAROMETER7_SET_DATA_SAMPLE_MIDDLE    SET_SPI_DATA_SAMPLE_MIDDLE
 
 // barometer7_set
 
#define BAROMETER7_MAP_MIKROBUS( cfg, mikrobus )    \
    cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
    cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
    cfg.sck  = MIKROBUS( mikrobus, MIKROBUS_SCK );  \
    cfg.cs   = MIKROBUS( mikrobus, MIKROBUS_CS )
 
 // barometer7_map
 // barometer7
 
typedef struct
{
    // Modules
    spi_master_t  spi;        
    pin_name_t  chip_select;  
    uint8_t   diagnosis;      
    uint8_t   parity;         
} barometer7_t;
 
typedef struct
{
    // Communication gpio pins
    pin_name_t  miso;      
    pin_name_t  mosi;      
    pin_name_t  sck;       
    pin_name_t  cs;        
    // static variable
    uint32_t                           spi_speed;        
    spi_master_mode_t                  spi_mode;         
    spi_master_chip_select_polarity_t  cs_polarity;      
} barometer7_cfg_t;
 
typedef struct
{
    uint8_t  supplier;           
    uint8_t  silicon_version;    
    uint8_t  metal_version;      
    uint8_t  asic_name;          
} barometer7_identifier_t;
 
typedef enum
{
    BAROMETER7_OK = 0,
    BAROMETER7_ERROR = -1,
    BAROMETER7_CMD_ERROR = -2
 
} barometer7_return_value_t;
 
typedef enum
{
    BAROMETER7_EEPROM_FEC_ERROR = 0x10,
    BAROMETER7_ACQUISITION_CHAIN_FAILURE = 0x08,
    BAROMETER7_SENSOR_CELL_FAILURE = 0x04,
    BAROMETER7_PRESSURE_OUT_OF_RANGE_HIGH = 0x02,
    BAROMETER7_PRESSURE_OUT_OF_RANGE_LOW = 0x01,
    BAROMETER7_NO_ERROR = 0x0A
 
} barometer7_diagnosis_code_t;
 
void barometer7_cfg_setup ( barometer7_cfg_t *cfg );
 
err_t barometer7_init ( barometer7_t *ctx, barometer7_cfg_t *cfg );
 
err_t barometer7_default_cfg ( barometer7_t *ctx );
 
err_t barometer7_generic_transfer ( barometer7_t *ctx, uint8_t cmd, uint16_t *data_out );
 
err_t barometer7_set_command ( barometer7_t *ctx, uint8_t cmd, uint16_t *data_out );
 
err_t barometer7_set_reset ( barometer7_t *ctx, uint8_t cmd, uint16_t *data_out );
 
err_t barometer7_get_press_data ( barometer7_t *ctx, uint16_t *press_data );
 
err_t barometer7_get_temp_data ( barometer7_t *ctx, uint16_t *temp_data );
 
err_t barometer7_get_trigger_diagnosis_data ( barometer7_t *ctx, uint16_t *td_data );
 
err_t barometer7_trigger_test_mode ( barometer7_t *ctx, uint16_t *tdm_data );
 
err_t barometer7_get_id_data ( barometer7_t *ctx, uint16_t *id_data );
 
err_t barometer7_get_identifier ( barometer7_t *ctx, barometer7_identifier_t *identifier );
 
err_t barometer7_get_pressure ( barometer7_t *ctx, float *pressure );
 
err_t barometer7_get_temperature ( barometer7_t *ctx, float *temperature );
 
 
 
#ifdef __cplusplus
}
#endif
#endif // BAROMETER7_H
 
 // barometer7
 
// ------------------------------------------------------------------------ END