proximity15.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 PROXIMITY15_H
#define PROXIMITY15_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 PROXIMITY15_REG_SOFT_RESET              0x0000
#define PROXIMITY15_REG_PAD_I2C_HV_CFG          0x002D
#define PROXIMITY15_REG_CFG_TIMEOUT_MACROP      0x004B
#define PROXIMITY15_REG_CFG_TIMEOUT_MACROP_A_HI 0x005E
#define PROXIMITY15_REG_CFG_VCSEL_PERIOD_A      0x0060
#define PROXIMITY15_REG_CFG_TIMEOUT_MACROP_B_HI 0x0061
#define PROXIMITY15_REG_CFG_VCSEL_PERIOD_B      0x0063
#define PROXIMITY15_REG_CFG_VALID_PHASE_HIGH    0x0069
#define PROXIMITY15_REG_SYSTEM_INT_MEAS_PERIOD  0x006C
#define PROXIMITY15_REG_SD_CFG_WOI_SD0          0x0078
#define PROXIMITY15_REG_SD_CFG_INIT_PHASE_SD0   0x007A
#define PROXIMITY15_REG_SYSTEM_INTERRUPT_CLEAR  0x0086
#define PROXIMITY15_REG_SYSTEM_MODE_START       0x0087
#define PROXIMITY15_REG_RES_FINAL_RANGE_MM_SD0  0x0096
#define PROXIMITY15_REG_RES_OSC_CALIB_VAL       0x00DE
#define PROXIMITY15_REG_MODEL_ID                0x010F
#define PROXIMITY15_REG_MODULE_TYPE             0x0110
 
 // proximity15_reg
 
#define PROXIMITY15_MODEL_ID                    0xEA
#define PROXIMITY15_MODULE_TYPE                 0xCC
 
#define PROXIMITY15_SOFT_RESET_ENTER            0x00
#define PROXIMITY15_SOFT_RESET_EXIT             0x01
#define PROXIMITY15_START_RANGING               0x40
#define PROXIMITY15_STOP_RANGING                0x00
#define PROXIMITY15_CLEAR_INTERRUPT             0x01
#define PROXIMITY15_MEASURE_PERIOD_CONST        1.075
#define PROXIMITY15_TIMEOUT_MACROP_SHORT        0x14
#define PROXIMITY15_TIMEOUT_MACROP_LONG         0x0A
#define PROXIMITY15_DISTANCE_MODE_SHORT         0x01
#define PROXIMITY15_DISTANCE_MODE_LONG          0x02
 
#define PROXIMITY15_SET_DEV_ADDR                0x29
 
 // proximity15_set
 
#define PROXIMITY15_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.xsh = MIKROBUS( mikrobus, MIKROBUS_CS ); \
    cfg.int_pin = MIKROBUS( mikrobus, MIKROBUS_INT )
#define PROXIMITY15_MAP_MIKROBUS( cfg, mikrobus ) \ …
 
 // proximity15_map
 // proximity15
 
typedef struct
{
    // Output pins
    digital_out_t  xsh;         
    // Input pins
    digital_in_t   int_pin;     
    // Modules
    i2c_master_t   i2c;         
    // I2C slave address
    uint8_t slave_address;      
} proximity15_t;
typedef struct {…};
 
typedef struct
{
    pin_name_t  scl;            
    pin_name_t  sda;            
    pin_name_t  xsh;            
    pin_name_t  int_pin;        
    uint32_t  i2c_speed;        
    uint8_t   i2c_address;      
} proximity15_cfg_t;
typedef struct {…};
 
typedef enum
{
    PROXIMITY15_OK = 0,
    PROXIMITY15_ERROR = -1
 
} proximity15_return_value_t;
typedef enum {…};
 
typedef enum
{
    PROXIMITY15_TIMING_BUDGET_15MS = 0,
    PROXIMITY15_TIMING_BUDGET_20MS,
    PROXIMITY15_TIMING_BUDGET_33MS,
    PROXIMITY15_TIMING_BUDGET_50MS,
    PROXIMITY15_TIMING_BUDGET_100MS,
    PROXIMITY15_TIMING_BUDGET_200MS,
    PROXIMITY15_TIMING_BUDGET_500MS
 
} proximity15_timing_budget_t;
typedef enum {…};
 
void proximity15_cfg_setup ( proximity15_cfg_t *cfg );
 
err_t proximity15_init ( proximity15_t *ctx, proximity15_cfg_t *cfg );
 
err_t proximity15_default_cfg ( proximity15_t *ctx );
 
err_t proximity15_write_registers ( proximity15_t *ctx, uint16_t reg, uint8_t *tx_buf, uint8_t tx_len );
 
err_t proximity15_read_registers ( proximity15_t *ctx, uint16_t reg, uint8_t *rx_buf, uint8_t rx_len );
 
err_t proximity15_write_register ( proximity15_t *ctx, uint16_t reg, uint8_t tx_data );
 
err_t proximity15_read_register ( proximity15_t *ctx, uint16_t reg, uint8_t *rx_data );
 
err_t proximity15_check_communication ( proximity15_t *ctx );
 
err_t proximity15_software_reset ( proximity15_t *ctx );
 
err_t proximity15_get_distance ( proximity15_t *ctx, uint16_t *distance );
 
void proximity15_enable_sensor ( proximity15_t *ctx );
 
void proximity15_disable_sensor ( proximity15_t *ctx );
 
uint8_t proximity15_get_int_pin ( proximity15_t *ctx );
 
err_t proximity15_start_ranging ( proximity15_t *ctx );
 
err_t proximity15_stop_ranging ( proximity15_t *ctx );
 
err_t proximity15_clear_interrupt ( proximity15_t *ctx );
 
err_t proximity15_set_inter_measurement_period ( proximity15_t *ctx, uint16_t time_ms );
 
err_t proximity15_set_distance_mode ( proximity15_t *ctx, uint8_t mode );
 
err_t proximity15_get_distance_mode ( proximity15_t *ctx, uint8_t *mode );
 
err_t proximity15_set_timing_budget ( proximity15_t *ctx, proximity15_timing_budget_t time );
 
err_t proximity15_get_timing_budget ( proximity15_t *ctx, proximity15_timing_budget_t *time );
 
#ifdef __cplusplus
}
#endif
#endif // PROXIMITY15_H
 
 // proximity15
 
// ------------------------------------------------------------------------ END