proximity14.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 PROXIMITY14_H
#define PROXIMITY14_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 PROXIMITY14_REG_CFG1            0x00
#define PROXIMITY14_REG_CFG2            0x03
#define PROXIMITY14_REG_CFG3            0x04
#define PROXIMITY14_REG_CFG4            0x08
#define PROXIMITY14_REG_THRESHOLD_LOW   0x05
#define PROXIMITY14_REG_THRESHOLD_HIGH  0x06
#define PROXIMITY14_REG_CANCELLATION    0x07
#define PROXIMITY14_REG_DATA            0xF8
#define PROXIMITY14_REG_INT_FLAG        0xF9
#define PROXIMITY14_REG_ID              0xFA
#define PROXIMITY14_REG_AC_DATA         0xFB
 
 // proximity14_reg
 
#define PROXIMITY14_SET_DEV_ADDR  0x60
 
 // proximity14_set
 
#define PROXIMITY14_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
 
 // proximity14_map
 // proximity14
 
typedef struct
{
    // Input pins
    digital_in_t  int_pin;  
    // Modules
    i2c_master_t i2c;       
    // I2C slave address
    uint8_t slave_address;  
} proximity14_t;
 
typedef struct
{
    pin_name_t  scl;        
    pin_name_t  sda;        
    pin_name_t  int_pin;    
    uint32_t  i2c_speed;    
    uint8_t   i2c_address;  
} proximity14_cfg_t;
 
typedef enum
{
   PROXIMITY14_OK = 0,
   PROXIMITY14_ERROR = -1
 
} proximity14_return_value_t;
 
void proximity14_cfg_setup ( proximity14_cfg_t *cfg );
 
err_t proximity14_init ( proximity14_t *ctx, proximity14_cfg_t *cfg );
 
err_t proximity14_default_cfg ( proximity14_t *ctx );
 
err_t proximity14_generic_write ( proximity14_t *ctx, uint8_t reg, uint16_t tx_data );
 
err_t proximity14_generic_read ( proximity14_t *ctx, uint8_t reg, uint16_t *rx_data );
 
uint8_t proximity14_get_int ( proximity14_t *ctx );
 
#ifdef __cplusplus
}
#endif
#endif // PROXIMITY14_H
 
 // proximity14
 
// ------------------------------------------------------------------------ END