API for configuring and manipulating Proximity 17 Click driver. More...

Topics
	Proximity 17 Registers List
	List of registers of Proximity 17 Click driver.

	Proximity 17 Registers Settings
	Settings for registers of Proximity 17 Click driver.

	Proximity 17 MikroBUS Map
	MikroBUS pin mapping of Proximity 17 Click driver.

Functions
void	proximity17_cfg_setup (proximity17_cfg_t *cfg)
	Proximity 17 configuration object setup function.

err_t	proximity17_init (proximity17_t ctx, proximity17_cfg_t cfg)
	Proximity 17 initialization function.

err_t	proximity17_default_cfg (proximity17_t *ctx)
	Proximity 17 default configuration function.

err_t	proximity17_generic_write (proximity17_t ctx, uint8_t reg, uint8_t tx_buf, uint8_t tx_len)
	Proximity 17 I2C writing function.

err_t	proximity17_generic_read (proximity17_t ctx, uint8_t reg, uint8_t rx_buf, uint8_t rx_len)
	Proximity 17 I2C reading function.

err_t	proximity17_write_register (proximity17_t *ctx, uint8_t reg, uint8_t data_in)
	Proximity 17 write register function.

err_t	proximity17_read_register (proximity17_t ctx, uint8_t reg, uint8_t data_out)
	Proximity 17 read register function.

err_t	proximity17_check_communication (proximity17_t *ctx)
	Proximity 17 check communication function.

err_t	proximity17_soft_reset (proximity17_t *ctx)
	Proximity 17 soft reset function.

err_t	proximity17_read_proximity (proximity17_t ctx, uint16_t prox_data)
	Proximity 17 read proximity function.

uint8_t	proximity17_get_int_pin (proximity17_t *ctx)
	Proximity 17 get int pin function.

Detailed Description

API for configuring and manipulating Proximity 17 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ proximity17_cfg_setup()

void proximity17_cfg_setup ( proximity17_cfg_t * cfg )

Proximity 17 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

[out] cfg : Click configuration structure. See proximity17_cfg_t object definition for detailed explanation.

Returns: Nothing.

Note: The all used pins will be set to unconnected state.

◆ proximity17_check_communication()

err_t proximity17_check_communication ( proximity17_t * ctx )

Proximity 17 check communication function.

This function checks the communication by reading and verifying the device ID on up to 10 tries.

Parameters

[in] ctx : Click context object. See proximity17_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_default_cfg()

err_t proximity17_default_cfg ( proximity17_t * ctx )

Proximity 17 default configuration function.

This function executes a default configuration of Proximity 17 click board.

Parameters

[in] ctx : Click context object. See proximity17_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: This function can consist any necessary configuration or setting to put device into operating mode.

◆ proximity17_generic_read()

err_t proximity17_generic_read	(	proximity17_t *	ctx,
		uint8_t	reg,
		uint8_t *	rx_buf,
		uint8_t	rx_len )

Proximity 17 I2C reading function.

This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See proximity17_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	rx_buf	: Output read data.
[in]	rx_len	: Number of bytes to be read.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_generic_write()

err_t proximity17_generic_write	(	proximity17_t *	ctx,
		uint8_t	reg,
		uint8_t *	tx_buf,
		uint8_t	tx_len )

Proximity 17 I2C writing function.

This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See proximity17_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	tx_buf	: Data to be written.
[in]	tx_len	: Number of bytes to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_get_int_pin()

uint8_t proximity17_get_int_pin ( proximity17_t * ctx )

Proximity 17 get int pin function.

This function returns the INT pin logic state.

Parameters

[in] ctx : Click context object. See proximity17_t object definition for detailed explanation.

Returns: Pin logic state.

Note: None.

◆ proximity17_init()

err_t proximity17_init	(	proximity17_t *	ctx,
		proximity17_cfg_t *	cfg )

Proximity 17 initialization function.

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

Parameters

[out]	ctx	: Click context object. See proximity17_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See proximity17_cfg_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_read_proximity()

err_t proximity17_read_proximity	(	proximity17_t *	ctx,
		uint16_t *	prox_data )

Proximity 17 read proximity function.

This function reads the raw proximity data. The higher the value, the closer the detected object is.

Parameters

[in]	ctx	: Click context object. See proximity17_t object definition for detailed explanation.
[out]	prox_data	: Proximity data 14-bit (10-bit in case APC is disabled).

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_read_register()

err_t proximity17_read_register	(	proximity17_t *	ctx,
		uint8_t	reg,
		uint8_t *	data_out )

Proximity 17 read register function.

This function reads data from the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See proximity17_t object definition for detailed explanation.
[in]	reg	: Register address.
[out]	data_out	: Output read data.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_soft_reset()

err_t proximity17_soft_reset ( proximity17_t * ctx )

Proximity 17 soft reset function.

This function executes the defice software reset command.

Parameters

[in] ctx : Click context object. See proximity17_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

◆ proximity17_write_register()

err_t proximity17_write_register	(	proximity17_t *	ctx,
		uint8_t	reg,
		uint8_t	data_in )

Proximity 17 write register function.

This function writes a desired data to the selected register by using I2C serial interface.

Parameters

[in]	ctx	: Click context object. See proximity17_t object definition for detailed explanation.
[in]	reg	: Register address.
[in]	data_in	: Data to be written.

Returns

0 - Success,
-1 - Error. See #err_t definition for detailed explanation.

Note: None.

Topics

Functions

Detailed Description

Function Documentation

◆ proximity17_cfg_setup()

◆ proximity17_check_communication()

◆ proximity17_default_cfg()

◆ proximity17_generic_read()

◆ proximity17_generic_write()

◆ proximity17_get_int_pin()

◆ proximity17_init()

◆ proximity17_read_proximity()

◆ proximity17_read_register()

◆ proximity17_soft_reset()

◆ proximity17_write_register()