proximity19  2.1.0.0
Main Page

Proximity 19 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Nenad Filipovic
  • Date : Jan 2024.
  • Type : I2C type

Software Support

We provide a library for the Proximity 19 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Proximity 19 Click driver.

Standard key functions :

Example key functions :

Example Description

This example demonstrates the use of the Proximity 19 click board by measuring and displaying the distance data.

The demo application is composed of two sections :

Application Init

Initialization of I2C module and log UART. After the driver init, the app executes a default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
proximity19_cfg_t proximity19_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
proximity19_cfg_setup( &proximity19_cfg );
PROXIMITY19_MAP_MIKROBUS( proximity19_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == proximity19_init( &proximity19, &proximity19_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( PROXIMITY19_ERROR == proximity19_default_cfg ( &proximity19 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

The demo app measures the distance between the sensor and the object in millimeters and displays the result approximately every 100 milliseconds. Results are being sent to the UART Terminal, where you can track their changes.

void application_task ( void )
{
float distance = 0;
if ( PROXIMITY19_OK == proximity19_get_distance( &proximity19, &distance ) )
{
log_printf( &logger, " Distance: %.2f [mm] \r\n\n", distance );
}
Delay_ms( 100 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Proximity19

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


proximity19_set_ps_gain
err_t proximity19_set_ps_gain(proximity19_t *ctx, uint8_t ps_gain)
Proximity 19 set PS gain function.
PROXIMITY19_MAP_MIKROBUS
#define PROXIMITY19_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: proximity19.h:206
proximity19_cfg_setup
void proximity19_cfg_setup(proximity19_cfg_t *cfg)
Proximity 19 configuration object setup function.
application_task
void application_task(void)
Definition: main.c:67
proximity19_cfg_t
Proximity 19 Click configuration object.
Definition: proximity19.h:239
PROXIMITY19_OK
@ PROXIMITY19_OK
Definition: proximity19.h:256
proximity19_default_cfg
err_t proximity19_default_cfg(proximity19_t *ctx)
Proximity 19 default configuration function.
proximity19_t
Proximity 19 Click context object.
Definition: proximity19.h:219
proximity19_set_period
err_t proximity19_set_period(proximity19_t *ctx, uint8_t period)
Proximity 19 set period function.
PROXIMITY19_ERROR
@ PROXIMITY19_ERROR
Definition: proximity19.h:257
application_init
void application_init(void)
Definition: main.c:31
proximity19_get_distance
err_t proximity19_get_distance(proximity19_t *ctx, float *distance)
Proximity 19 get distance function.
proximity19_init
err_t proximity19_init(proximity19_t *ctx, proximity19_cfg_t *cfg)
Proximity 19 initialization function.