ultralowpress.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 ULTRALOWPRESS_H
#define ULTRALOWPRESS_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 ULTRALOWPRESS_REG_CMD           0x22
#define ULTRALOWPRESS_REG_TEMP          0x2E
#define ULTRALOWPRESS_REG_PRESS         0x30
#define ULTRALOWPRESS_REG_STATUS_SYNC   0x32
#define ULTRALOWPRESS_REG_STATUS        0x36
#define ULTRALOWPRESS_REG_SERIAL_NUM_L  0x50
#define ULTRALOWPRESS_REG_SERIAL_NUM_H  0x52
 
 // ultralowpress_reg
 
#define ULTRALOWPRESS_REG_CMD_SLEEP     0x6C32
#define ULTRALOWPRESS_REG_CMD_RESET     0xB169
#define ULTRALOWPRESS_STATUS_CLEAR      0xFFFF
 
#define ULTRALOWPRESS_SET_DEV_ADDR      0x6C
 
 // ultralowpress_set
 
#define ULTRALOWPRESS_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA );
 
 // ultralowpress_map
 // ultralowpress
 
typedef struct
{
    // Modules
    i2c_master_t i2c;           
    // I2C slave address
    uint8_t slave_address;      
} ultralowpress_t;
 
typedef struct
{
    pin_name_t scl;             
    pin_name_t sda;             
    uint32_t   i2c_speed;       
    uint8_t    i2c_address;     
} ultralowpress_cfg_t;
 
typedef enum
{
    ULTRALOWPRESS_OK = 0,
    ULTRALOWPRESS_ERROR = -1
 
} ultralowpress_return_value_t;
 
void ultralowpress_cfg_setup ( ultralowpress_cfg_t *cfg );
 
err_t ultralowpress_init ( ultralowpress_t *ctx, ultralowpress_cfg_t *cfg );
 
err_t ultralowpress_generic_write ( ultralowpress_t *ctx, uint8_t reg, uint16_t tx_data );
 
err_t ultralowpress_generic_read ( ultralowpress_t *ctx, uint8_t reg, uint16_t *rx_data );
 
void ultralowpress_clear_status ( ultralowpress_t *ctx );
 
uint8_t ultralowpress_ready_to_read ( ultralowpress_t *ctx );
 
float ultralowpress_get_press ( ultralowpress_t *ctx );
 
float ultralowpress_get_temp ( ultralowpress_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // ULTRALOWPRESS_H
 
 // ultralowpress
 
// ------------------------------------------------------------------------ END