proximity5

---

Proximity 5 Click

Proximity 5 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

• Author : MikroE Team
• Date : Feb 2020.
• Type : I2C type

Software Support

Example Description

This application enables usage of the proximity and ablient light sensing.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.Proximity5

Example Key Functions

• proximity5_cfg_setup Config Object Initialization function.

void proximity5_cfg_setup ( proximity5_cfg_t *cfg );

• proximity5_init Initialization function.

err_t proximity5_init ( proximity5_t *ctx, proximity5_cfg_t *cfg );

• proximity5_default_cfg Click Default Configuration function.

void proximity5_default_cfg ( proximity5_t *ctx );

• Starts the conversion and waits for the interrupt to finish.
• After the interrupt finishes the proximity data from the proximity registers
• proximity5_get_values is returned to a 3 member uint16_t array.

void proximity5_get_values ( proximity5_t *ctx, uint16_t *prox_val );

• proximity5_get_id Read the ID from the ID register of the sensor.

uint16_t proximity5_get_id ( proximity5_t *ctx );

• Generic function for reading both high and low register value
• proximity5_read_reg and returns those combined values to a 16bit variable.

uint16_t proximity5_read_reg ( proximity5_t *ctx, uint8_t addr );

Application Init

This application enables usage of the proximity and ablient light sensing

void application_init ( void )
{
    log_cfg_t log_cfg;
    proximity5_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    proximity5_cfg_setup( &cfg );
    PROXIMITY5_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    proximity5_init( &proximity5, &cfg );

    proximity5_default_cfg( &proximity5 );
}

Application Task

The proximity data is read from the sensor and it is printed to the UART.

void application_task ( void )
{
    //  Task implementation.

    uint16_t bff[ 4 ];

    proximity5_get_values( &proximity5, bff );
 
    log_printf( &logger, "PS1 %d  ", bff[ 0 ] );
    
    log_printf( &logger, "PS2 %d  ", bff[ 1 ] );
    
    log_printf( &logger, "PS3 %d \r\n\r\n", bff[ 2 ] );

    Delay_ms ( 500 );
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

---