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

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

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

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

Functions
void	proximity15_cfg_setup (proximity15_cfg_t *cfg)
	Proximity 15 configuration object setup function.

err_t	proximity15_init (proximity15_t ctx, proximity15_cfg_t cfg)
	Proximity 15 initialization function.

err_t	proximity15_default_cfg (proximity15_t *ctx)
	Proximity 15 default configuration function.

err_t	proximity15_write_registers (proximity15_t ctx, uint16_t reg, uint8_t tx_buf, uint8_t tx_len)
	Proximity 15 write registers function.

err_t	proximity15_read_registers (proximity15_t ctx, uint16_t reg, uint8_t rx_buf, uint8_t rx_len)
	Proximity 15 read registers function.

err_t	proximity15_write_register (proximity15_t *ctx, uint16_t reg, uint8_t tx_data)
	Proximity 15 write register function.

err_t	proximity15_read_register (proximity15_t ctx, uint16_t reg, uint8_t rx_data)
	Proximity 15 read register function.

err_t	proximity15_check_communication (proximity15_t *ctx)
	Proximity 15 check communication function.

err_t	proximity15_software_reset (proximity15_t *ctx)
	Proximity 15 software reset function.

err_t	proximity15_get_distance (proximity15_t ctx, uint16_t distance)
	Proximity 15 get distance function.

void	proximity15_enable_sensor (proximity15_t *ctx)
	Proximity 15 enable sensor function.

void	proximity15_disable_sensor (proximity15_t *ctx)
	Proximity 15 disable sensor function.

uint8_t	proximity15_get_int_pin (proximity15_t *ctx)
	Proximity 15 get int pin function.

err_t	proximity15_start_ranging (proximity15_t *ctx)
	Proximity 15 start ranging function.

err_t	proximity15_stop_ranging (proximity15_t *ctx)
	Proximity 15 stop ranging function.

err_t	proximity15_clear_interrupt (proximity15_t *ctx)
	Proximity 15 clear interrupt function.

err_t	proximity15_set_inter_measurement_period (proximity15_t *ctx, uint16_t time_ms)
	Proximity 15 set inter measurement period function.

err_t	proximity15_set_distance_mode (proximity15_t *ctx, uint8_t mode)
	Proximity 15 set distance mode function.

err_t	proximity15_get_distance_mode (proximity15_t ctx, uint8_t mode)
	Proximity 15 get distance mode function.

err_t	proximity15_set_timing_budget (proximity15_t *ctx, proximity15_timing_budget_t time)
	Proximity 15 set timing budget function.

err_t	proximity15_get_timing_budget (proximity15_t ctx, proximity15_timing_budget_t time)
	Proximity 15 get timing budget function.

Detailed Description

API for configuring and manipulating Proximity 15 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

◆ proximity15_cfg_setup()

void proximity15_cfg_setup ( proximity15_cfg_t * cfg )

Proximity 15 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters

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

Returns: Nothing.

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

◆ proximity15_check_communication()

err_t proximity15_check_communication ( proximity15_t * ctx )

Proximity 15 check communication function.

This function checks the communication by reading and verifying the model ID and module type registers.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_clear_interrupt()

err_t proximity15_clear_interrupt ( proximity15_t * ctx )

Proximity 15 clear interrupt function.

This function clears the interrupt.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Call this function after a ranging data reading to arm the interrupt for the next data ready event.

◆ proximity15_default_cfg()

err_t proximity15_default_cfg ( proximity15_t * ctx )

Proximity 15 default configuration function.

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

Parameters

[in] ctx : Click context object. See proximity15_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.

◆ proximity15_disable_sensor()

void proximity15_disable_sensor ( proximity15_t * ctx )

Proximity 15 disable sensor function.

This function disables the sensor by setting XSH pin to LOW logic level.

Parameters

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

Returns: None.

Note: None.

◆ proximity15_enable_sensor()

void proximity15_enable_sensor ( proximity15_t * ctx )

Proximity 15 enable sensor function.

This function enables the sensor by setting XSH pin to HIGH logic level.

Parameters

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

Returns: None.

Note: None.

◆ proximity15_get_distance()

err_t proximity15_get_distance	(	proximity15_t *	ctx,
		uint16_t *	distance )

Proximity 15 get distance function.

This function waits for the data ready, then reads the distance measured by the sensor in milimeters and clears interrupts.

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[out]	distance	: Object distance in milimeters.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_get_distance_mode()

err_t proximity15_get_distance_mode	(	proximity15_t *	ctx,
		uint8_t *	mode )

Proximity 15 get distance mode function.

This function returns the current distance mode.

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[out]	mode	: `1` - Short mode, `2` - Long mode.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_get_int_pin()

uint8_t proximity15_get_int_pin ( proximity15_t * ctx )

Proximity 15 get int pin function.

This function returns the INT pin logic state.

Parameters

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

Returns: Pin logic state.

Note: None.

◆ proximity15_get_timing_budget()

err_t proximity15_get_timing_budget	(	proximity15_t *	ctx,
		proximity15_timing_budget_t *	time )

Proximity 15 get timing budget function.

This function returns the current timing budget in miliseconds.

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[out]	time	: Time value (enum 0-6). See proximity15_timing_budget_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_init()

err_t proximity15_init	(	proximity15_t *	ctx,
		proximity15_cfg_t *	cfg )

Proximity 15 initialization function.

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

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_read_register()

err_t proximity15_read_register	(	proximity15_t *	ctx,
		uint16_t	reg,
		uint8_t *	rx_data )

Proximity 15 read register function.

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

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[in]	reg	: Start register address.
[out]	rx_data	: Output read data.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_read_registers()

err_t proximity15_read_registers	(	proximity15_t *	ctx,
		uint16_t	reg,
		uint8_t *	rx_buf,
		uint8_t	rx_len )

Proximity 15 read registers 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 proximity15_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.

◆ proximity15_set_distance_mode()

err_t proximity15_set_distance_mode	(	proximity15_t *	ctx,
		uint8_t	mode )

Proximity 15 set distance mode function.

This function programs the distance mode.

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[in]	mode	: `1` - Short mode, `2` - Long mode ( Default ).

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Short mode can range up to 2 meters, while long mode ranges up to 6 meters when the timing budget and inter measurement are set to more than 200ms.

◆ proximity15_set_inter_measurement_period()

err_t proximity15_set_inter_measurement_period	(	proximity15_t *	ctx,
		uint16_t	time_ms )

Proximity 15 set inter measurement period function.

This function programs the inter measurement period in miliseconds.

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[in]	time_ms	: Inter measurement period in miliseconds ( Default: 100ms ).

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: Inter measurement period must be >= timing budget value. By default the timing budget is set to 50ms.

◆ proximity15_set_timing_budget()

err_t proximity15_set_timing_budget	(	proximity15_t *	ctx,
		proximity15_timing_budget_t	time )

Proximity 15 set timing budget function.

This function programs the timing budget in miliseconds.

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[in]	time	: Time value (enum 0-6). See proximity15_timing_budget_t object definition for detailed explanation.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_software_reset()

err_t proximity15_software_reset ( proximity15_t * ctx )

Proximity 15 software reset function.

This function performs the device software reset.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_start_ranging()

err_t proximity15_start_ranging ( proximity15_t * ctx )

Proximity 15 start ranging function.

This function starts the ranging distance operation.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: The ranging operation is continuous. The clear interrupt has to be done after each get data to allow the interrupt to raise when the next data is ready.

◆ proximity15_stop_ranging()

err_t proximity15_stop_ranging ( proximity15_t * ctx )

Proximity 15 stop ranging function.

This function stops the ranging distance operation.

Parameters

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

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_write_register()

err_t proximity15_write_register	(	proximity15_t *	ctx,
		uint16_t	reg,
		uint8_t	tx_data )

Proximity 15 write register function.

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

Parameters

[in]	ctx	: Click context object. See proximity15_t object definition for detailed explanation.
[in]	reg	: Start register address.
[in]	tx_data	: Data to be written.

Returns

0 - Success,
-1 - Error.

See #err_t definition for detailed explanation.

Note: None.

◆ proximity15_write_registers()

err_t proximity15_write_registers	(	proximity15_t *	ctx,
		uint16_t	reg,
		uint8_t *	tx_buf,
		uint8_t	tx_len )

Proximity 15 write registers 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 proximity15_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.

Topics

Functions

Detailed Description

Function Documentation

◆ proximity15_cfg_setup()

◆ proximity15_check_communication()

◆ proximity15_clear_interrupt()

◆ proximity15_default_cfg()

◆ proximity15_disable_sensor()

◆ proximity15_enable_sensor()

◆ proximity15_get_distance()

◆ proximity15_get_distance_mode()

◆ proximity15_get_int_pin()

◆ proximity15_get_timing_budget()

◆ proximity15_init()

◆ proximity15_read_register()

◆ proximity15_read_registers()

◆ proximity15_set_distance_mode()

◆ proximity15_set_inter_measurement_period()

◆ proximity15_set_timing_budget()

◆ proximity15_software_reset()

◆ proximity15_start_ranging()

◆ proximity15_stop_ranging()

◆ proximity15_write_register()

◆ proximity15_write_registers()