proximity19  2.1.0.0
Data Structures | Macros | Enumerations | Functions
proximity19.h File Reference

This file contains API for Proximity 19 Click Driver. More...

#include "mikrosdk_version.h"
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  proximity19_t
 Proximity 19 Click context object. More...
 
struct  proximity19_cfg_t
 Proximity 19 Click configuration object. More...
 

Macros

#define PROXIMITY19_REG_SYSTEM_CONTROL   0x40
 Proximity 19 description register. More...
 
#define PROXIMITY19_REG_MODE_CONTROL0   0x41
 
#define PROXIMITY19_REG_MODE_CONTROL1   0x42
 
#define PROXIMITY19_REG_MODE_CONTROL2   0x43
 
#define PROXIMITY19_REG_PS_DATA_LSB   0x44
 
#define PROXIMITY19_REG_PS_DATA_MSB   0x45
 
#define PROXIMITY19_REG_PS_OFFSET_LSB   0x46
 
#define PROXIMITY19_REG_PS_OFFSET_MSB   0x47
 
#define PROXIMITY19_REG_INTERRUPT   0x4A
 
#define PROXIMITY19_REG_PS_TH_HIGH_LSB   0x4B
 
#define PROXIMITY19_REG_PS_TH_HIGH_MSB   0x4C
 
#define PROXIMITY19_REG_PS_TH_LOW_LSB   0x4D
 
#define PROXIMITY19_REG_PS_TH_LOW_MSB   0x4E
 
#define PROXIMITY19_REG_MANUFACT_ID   0x92
 
#define PROXIMITY19_SW_RESET   0x80
 Proximity 19 system control register bitmask. More...
 
#define PROXIMITY19_PART_ID_BITMASK   0x7F
 
#define PROXIMITY19_PART_ID_VAL   0x1C
 
#define PROXIMITY19_PS_GAIN_X1   0x00
 Proximity 19 mode control 0 register bitmask. More...
 
#define PROXIMITY19_PS_GAIN_X2   0x01
 
#define PROXIMITY19_PS_GAIN_BITMASK   0xF3
 
#define PROXIMITY19_PD_SEL_NO   0x00
 
#define PROXIMITY19_PD_SEL_FAR   0x01
 
#define PROXIMITY19_PD_SEL_NEAR   0x02
 
#define PROXIMITY19_PD_SEL_BOTH   0x03
 
#define PROXIMITY19_PD_SEL_BITMASK   0x03
 
#define PROXIMITY19_PERIOD_10_MS   0x00
 Proximity 19 mode control 1 register bitmask. More...
 
#define PROXIMITY19_PERIOD_50_MS   0x01
 
#define PROXIMITY19_PERIOD_100_MS   0x02
 
#define PROXIMITY19_PERIOD_500_MS   0x03
 
#define PROXIMITY19_PERIOD_5_MS   0x04
 
#define PROXIMITY19_PERIOD_BITMASK   0x70
 
#define PROXIMITY19_PS_PULSE_50_US   0x00
 
#define PROXIMITY19_PS_PULSE_100_US   0x01
 
#define PROXIMITY19_PS_PULSE_200_US   0x02
 
#define PROXIMITY19_PS_PULSE_400_US   0x03
 
#define PROXIMITY19_PS_PULSE_BITMASK   0x0C
 
#define PROXIMITY19_VCSEL_CURR_3_MA   0x00
 
#define PROXIMITY19_VCSEL_CURR_4_MA   0x01
 
#define PROXIMITY19_VCSEL_CURR_5_MA   0x02
 
#define PROXIMITY19_VCSEL_CURR_BITMASK   0x03
 
#define PROXIMITY19_PS_DISABLE   0x00
 Proximity 19 mode control 2 register bitmask. More...
 
#define PROXIMITY19_PS_ENABLE   0x01
 
#define PROXIMITY19_PS_TH_RES   0x0F
 Proximity 19 PS threshold resolution. More...
 
#define PROXIMITY19_PS_RES_MSB_BITMASK   0x07
 Proximity 19 PS data resolution. More...
 
#define PROXIMITY19_PS_OFFSET_BITMASK   0x01
 
#define PROXIMITY19_DET_RANGE_MIN   1.0f
 
#define PROXIMITY19_DET_RANGE_MAX   14.0f
 
#define PROXIMITY19_DATA_RANGE_50_US   0x03FEu
 Proximity 19 PS measurement result calculation values. More...
 
#define PROXIMITY19_DATA_RANGE_100_US   0x03FEu
 
#define PROXIMITY19_DATA_RANGE_200_US   0x07FEu
 
#define PROXIMITY19_DATA_RANGE_400_US   0x0FFEu
 
#define PROXIMITY19_GAIN_X1   1.0f
 Proximity 19 PS gain. More...
 
#define PROXIMITY19_GAIN_X2   2.0f
 
#define PROXIMITY19_GAIN_X2_BOTH_PD   3.0f
 
#define PROXIMITY19_MANUFACT_ID   0xE0
 Proximity 19 manufacture ID. More...
 
#define PROXIMITY19_DEVICE_ADDRESS   0x39
 Proximity 19 device address setting. More...
 
#define PROXIMITY19_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  proximity19_return_value_t { PROXIMITY19_OK = 0, PROXIMITY19_ERROR = -1 }
 Proximity 19 Click return value data. More...
 

Functions

void proximity19_cfg_setup (proximity19_cfg_t *cfg)
 Proximity 19 configuration object setup function. More...
 
err_t proximity19_init (proximity19_t *ctx, proximity19_cfg_t *cfg)
 Proximity 19 initialization function. More...
 
err_t proximity19_default_cfg (proximity19_t *ctx)
 Proximity 19 default configuration function. More...
 
err_t proximity19_generic_write (proximity19_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 Proximity 19 I2C writing function. More...
 
err_t proximity19_generic_read (proximity19_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 Proximity 19 I2C reading function. More...
 
err_t proximity19_sw_reset (proximity19_t *ctx)
 Proximity 19 software reset function. More...
 
err_t proximity19_get_part_id (proximity19_t *ctx, uint8_t *part_id)
 Proximity 19 get part ID function. More...
 
err_t proximity19_set_ps_gain (proximity19_t *ctx, uint8_t ps_gain)
 Proximity 19 set PS gain function. More...
 
err_t proximity19_set_pd_sel (proximity19_t *ctx, uint8_t pd_sel)
 Proximity 19 set PD photodiode function. More...
 
err_t proximity19_set_period (proximity19_t *ctx, uint8_t period)
 Proximity 19 set period function. More...
 
err_t proximity19_set_pulse_width (proximity19_t *ctx, uint8_t pulse_width)
 Proximity 19 set pulse width function. More...
 
err_t proximity19_set_vcsel_current (proximity19_t *ctx, uint8_t vcsel_current)
 Proximity 19 set VCSEL current function. More...
 
err_t proximity19_ps_enable (proximity19_t *ctx)
 Proximity 19 PS enable function. More...
 
err_t proximity19_ps_disable (proximity19_t *ctx)
 Proximity 19 PS standby function. More...
 
err_t proximity19_get_ps_data (proximity19_t *ctx, uint16_t *ps_data)
 Proximity 19 get PS data function. More...
 
err_t proximity19_get_distance (proximity19_t *ctx, float *distance)
 Proximity 19 get distance function. More...
 
err_t proximity19_set_ps_offset (proximity19_t *ctx, uint16_t ps_offset)
 Proximity 19 set PS offset function. More...
 
err_t proximity19_int_cfg (proximity19_t *ctx, uint8_t int_cfg)
 Proximity 19 interrupt configuration function. More...
 
err_t proximity19_set_ps_th (proximity19_t *ctx, uint16_t ps_th_high, uint16_t ps_th_low)
 Proximity 19 set PS threshold function. More...
 
err_t proximity19_get_manufact_id (proximity19_t *ctx, uint8_t *manufact_id)
 Proximity 19 get manufacture ID function. More...
 
uint8_t proximity19_get_int_pin (proximity19_t *ctx)
 Proximity 19 get interrupt function. More...
 

Detailed Description

This file contains API for Proximity 19 Click Driver.

Enumeration Type Documentation

◆ proximity19_return_value_t

Proximity 19 Click return value data.

Predefined enum values for driver return values.

Enumerator
PROXIMITY19_OK 
PROXIMITY19_ERROR