proximity8  2.0.0.0
Functions

Functions

void proximity8_cfg_setup (proximity8_cfg_t *cfg)
 Config Object Initialization function. More...
 
PROXIMITY8_RETVAL proximity8_init (proximity8_t *ctx, proximity8_cfg_t *cfg)
 Initialization function. More...
 
void proximity8_default_cfg (proximity8_t *ctx)
 Click Default Configuration function. More...
 
void proximity8_generic_write (proximity8_t *ctx, uint8_t reg, uint16_t *data_buf, uint8_t len)
 Generic write function. More...
 
void proximity8_generic_read (proximity8_t *ctx, uint8_t reg, uint16_t *data_buf)
 Generic read function. More...
 
uint8_t proximity8_get_interrupt_state (proximity8_t *ctx)
 Get interrupt state on the INT pin. More...
 

Detailed Description

Function Documentation

◆ proximity8_cfg_setup()

void proximity8_cfg_setup ( proximity8_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.

◆ proximity8_default_cfg()

void proximity8_default_cfg ( proximity8_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for Proximity8 click.

◆ proximity8_generic_read()

void proximity8_generic_read ( proximity8_t ctx,
uint8_t  reg,
uint16_t *  data_buf 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf

This function reads data from the desired register.

◆ proximity8_generic_write()

void proximity8_generic_write ( proximity8_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.

◆ proximity8_get_interrupt_state()

uint8_t proximity8_get_interrupt_state ( proximity8_t ctx)

Get interrupt state on the INT pin.

Parameters
ctxClick object.
Returns
Interrupt state

This function returns Interrupt state.

◆ proximity8_init()

PROXIMITY8_RETVAL proximity8_init ( proximity8_t ctx,
proximity8_cfg_t cfg 
)

Initialization function.

Parameters
proximity8Click object.
cfgClick configuration structure.

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