proximity6  2.0.0.0
Functions

Functions

void proximity6_cfg_setup (proximity6_cfg_t *cfg)
 Config Object Initialization function. More...
 
PROXIMITY6_RETVAL proximity6_init (proximity6_t *ctx, proximity6_cfg_t *cfg)
 Initialization function. More...
 
void proximity6_default_cfg (proximity6_t *ctx)
 Click Default Configuration function. More...
 
void proximity6_generic_write (proximity6_t *ctx, uint8_t reg, uint16_t *data_buf, uint8_t len)
 Generic write function. More...
 
void proximity6_generic_read (proximity6_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
 Generic read function. More...
 
uint8_t proximity6_set_mode (proximity6_t *ctx, uint8_t select_mode)
 Mode Set function. More...
 
uint8_t proximity6_read_data (proximity6_t *ctx, uint16_t *axis_out)
 Data Read function. More...
 
void proximity6_get_position (proximity6_t *ctx, uint8_t *position)
 Position Get function. More...
 
uint8_t proximity6_display_data (proximity6_t *ctx, uint8_t *data_value, uint8_t set_resolution)
 Data Display function. More...
 
void proximity6_load_settings (proximity6_t *ctx)
 Settings Load function. More...
 
uint8_t proximity6_check_interrupt (proximity6_t *ctx)
 Interrupt Check function. More...
 

Detailed Description

Function Documentation

◆ proximity6_cfg_setup()

void proximity6_cfg_setup ( proximity6_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ proximity6_check_interrupt()

uint8_t proximity6_check_interrupt ( proximity6_t ctx)

Interrupt Check function.

Parameters
ctxClick object.
Returns
State of INT pin

Function checks is interrupt occurred and returns the state of the INT pin. INT pin can be configured to show are data registers updated with the new values or not.

◆ proximity6_default_cfg()

void proximity6_default_cfg ( proximity6_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for Proximity6 click and sets the registers in default state.

◆ proximity6_display_data()

uint8_t proximity6_display_data ( proximity6_t ctx,
uint8_t *  data_value,
uint8_t  set_resolution 
)

Data Display function.

Parameters
ctxClick object.
dataValueBuffer where data be stored
setResolutionDetermines in which resolution the data be shown
Returns
0 - OK, 1 - Wrong resolution parameter

Function shows proximity data values in determined resolution as graphic view.

◆ proximity6_generic_read()

void proximity6_generic_read ( proximity6_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

This function reads data from the desired register.

◆ proximity6_generic_write()

void proximity6_generic_write ( proximity6_t ctx,
uint8_t  reg,
uint16_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

This function writes data to the desired register.

◆ proximity6_get_position()

void proximity6_get_position ( proximity6_t ctx,
uint8_t *  position 
)

Position Get function.

Parameters
ctxClick object.
positionBuffer where position data be stored

Function reads proximity data and checks from which side the object (body) affects on the sensor.

◆ proximity6_init()

PROXIMITY6_RETVAL proximity6_init ( proximity6_t ctx,
proximity6_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

This function initializes all necessary pins and peripherals used for this click.

◆ proximity6_load_settings()

void proximity6_load_settings ( proximity6_t ctx)

Settings Load function.

Parameters
ctxClick object.

Function loads settings which puts device in proper operating mode.

◆ proximity6_read_data()

uint8_t proximity6_read_data ( proximity6_t ctx,
uint16_t *  axis_out 
)

Data Read function.

Parameters
ctxClick object.
axisOutBuffer where data be stored
Returns
0 - OK, 1 - Device is in Standby or Idle Mode

Function reads proximity data when one or more data register is updated.

◆ proximity6_set_mode()

uint8_t proximity6_set_mode ( proximity6_t ctx,
uint8_t  select_mode 
)

Mode Set function.

Parameters
ctxClick object.
selectMode0 - Standby Mode, 1 - Proximity Mode, 2 - Sample Mode, 3 - Idle Mode
Returns
0 - OK, 1 - Wrong parameter value

Function puts the device in the desired operating mode.