Public function

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

Detailed Description

Function Documentation

proximity8_cfg_setup()

void proximity8_cfg_setup

(

proximity8_cfg_t *

cfg

)

Config Object Initialization function.

Parameters

cfg	Click configuration structure.

@description 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

ctx	Click object.

@description 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

ctx	Click object.
reg	Register address.
data_buf	Output data buf

@description 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

ctx	Click object.
reg	Register address.
data_buf	Data buf to be written.
len	Number of the bytes in data buf.

@description 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

ctx	Click object.

Returns

Interrupt state

@description This function returns Interrupt state.

proximity8_init()

PROXIMITY8_RETVAL proximity8_init	(	proximity8_t *	ctx,
		proximity8_cfg_t *	cfg )

Initialization function.

Parameters

ctx	Click object.
cfg	Click configuration structure.

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