proximity12  2.0.0.0
Main Page

Proximity 12 click

<PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU>

[click Product page](<CLICK_PRODUCT_PAGE_LINK>)


Click library

  • Author : Stefan Filipovic
  • Date : Jun 2021.
  • Type : I2C type

Software Support

We provide a library for the Proximity12 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 Proximity12 Click driver.

Standard key functions :

Example key functions :

Example Description

This function demonstrates the use of Proximity 12 click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and performs the click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
proximity12_cfg_t proximity12_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 115200;
log_init( &logger, &log_cfg );
Delay_ms( 100 );
log_info( &logger, " Application Init " );
// Click initialization.
proximity12_cfg_setup( &proximity12_cfg );
PROXIMITY12_MAP_MIKROBUS( proximity12_cfg, MIKROBUS_1 );
err_t init_flag = proximity12_init( &proximity12, &proximity12_cfg );
if ( I2C_MASTER_ERROR == init_flag )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
Delay_ms( 100 );
init_flag = proximity12_default_cfg ( &proximity12 );
if ( PROXIMITY12_ERROR == init_flag )
{
log_error( &logger, " Default Cfg Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Reads the proximity and ALS values and displays the results on the USB UART approximately every 100ms.

void application_task ( void )
{
uint16_t prox_data = 0;
err_t error_flag = proximity12_read_proximity ( &proximity12, &prox_data );
error_flag |= proximity12_read_als ( &proximity12, &als );
if ( PROXIMITY12_OK == error_flag )
{
log_printf( &logger, " - Proximity data -\r\n" );
log_printf( &logger, " Proximity: %u\r\n", prox_data );
log_printf( &logger, " - ALS data -\r\n" );
log_printf( &logger, " Clear: %lu - Red: %lu - Green: %lu - Blue: %lu\r\n", als.clear,
als.red,
als.green,
als.blue );
log_printf( &logger, " Leakage: %lu - Wideband: %lu - IR1: %lu - IR2: %lu\r\n\r\n", als.leakage,
als.wideband,
als.ir1,
als.ir2 );
}
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.Proximity12

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.


proximity12_als_data_t::green
uint32_t green
Definition: proximity12.h:343
proximity12_als_data_t::ir1
uint32_t ir1
Definition: proximity12.h:347
proximity12_read_als
err_t proximity12_read_als(proximity12_t *ctx, proximity12_als_data_t *als)
Proximity 12 read als data function.
proximity12_init
err_t proximity12_init(proximity12_t *ctx, proximity12_cfg_t *cfg)
Proximity 12 initialization function.
PROXIMITY12_MAP_MIKROBUS
#define PROXIMITY12_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: proximity12.h:283
application_task
void application_task(void)
Definition: main.c:65
proximity12_cfg_t
Proximity 12 Click configuration object.
Definition: proximity12.h:321
proximity12_als_data_t::leakage
uint32_t leakage
Definition: proximity12.h:345
proximity12_als_data_t
Proximity 12 ALS data object.
Definition: proximity12.h:340
proximity12_als_data_t::clear
uint32_t clear
Definition: proximity12.h:341
proximity12_als_data_t::blue
uint32_t blue
Definition: proximity12.h:344
PROXIMITY12_ERROR
@ PROXIMITY12_ERROR
Definition: proximity12.h:359
proximity12_set_led_isink
err_t proximity12_set_led_isink(proximity12_t *ctx, uint8_t scaler, uint8_t current)
Proximity 12 set led isink function.
application_init
void application_init(void)
Definition: main.c:28
proximity12_als_data_t::wideband
uint32_t wideband
Definition: proximity12.h:346
proximity12_cfg_setup
void proximity12_cfg_setup(proximity12_cfg_t *cfg)
Proximity 12 configuration object setup function.
proximity12_read_proximity
err_t proximity12_read_proximity(proximity12_t *ctx, uint16_t *prox_data)
Proximity 12 read proximity function.
PROXIMITY12_OK
@ PROXIMITY12_OK
Definition: proximity12.h:358
proximity12_als_data_t::red
uint32_t red
Definition: proximity12.h:342
proximity12_t
Proximity 12 Click context object.
Definition: proximity12.h:299
proximity12_default_cfg
err_t proximity12_default_cfg(proximity12_t *ctx)
Proximity 12 default configuration function.
proximity12_als_data_t::ir2
uint32_t ir2
Definition: proximity12.h:348