TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141593 times)
  2. FAT32 Library (74582 times)
  3. Network Ethernet Library (59089 times)
  4. USB Device Library (49126 times)
  5. Network WiFi Library (44875 times)
  6. FT800 Library (44435 times)
  7. GSM click (31085 times)
  8. mikroSDK (29961 times)
  9. microSD click (27522 times)
  10. PID Library (27499 times)
Libstock prefers package manager

Package Manager

We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]

< Back
mikroSDK Library

Proximity Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.16

mikroSDK Library: 2.0.0.0

Category: Proximity

Downloaded: 414 times

Not followed.

License: MIT license  

Proximity Click features VCNL4010 proximity and ambient light sensor. It combines an infrared emitter and PIN photodiode for proximity measurement with a range of up to 20cm.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "Proximity Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "Proximity Click" changes.

Do you want to report abuse regarding "Proximity Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Proximity Click

Proximity Click features VCNL4010 proximity and ambient light sensor. It combines an infrared emitter and PIN photodiode for proximity measurement with a range of up to 20cm.

proximity_click.png

Click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Proximity 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Proximity Click driver.

Standard key functions :

  • Config Object Initialization function.

    void proximity_cfg_setup ( proximity_cfg_t *cfg );

  • Initialization function.

    PROXIMITY_RETVAL proximity_init ( proximity_t ctx, proximity_cfg_t cfg );

  • Click Default Configuration function.

    void proximity_default_cfg ( proximity_t *ctx );

Example key functions :

  • Functions for write data

    void proximity_write_data( proximity_t ctx, uint8_t w_addr, uint8_t wr_data, uint8_t n_len);

  • Functions for reads Proximity data

    uint16_t proximity_read_prox_data( proximity_t *ctx );

  • Functions for reads Ambient light

    uint16_t proximity_read_ambient_light( proximity_t *ctx );

Examples Description

Measures proximity data and ambient light.

The demo application is composed of two sections :

Application Init

Initialization driver init and sets chip on the default mode


void application_init ( void )
{
    log_cfg_t log_cfg;
    proximity_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.

    proximity_cfg_setup( &cfg );
    PROXIMITY_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    proximity_init( &proximity, &cfg );
    proximity_set_default_mode( &proximity );
}

Application Task

Reads Proximity data and Ambient light data and logs data to USBUART every 500 ms.


void application_task ( void )
{
    //  Task implementation.

    proximity_ambi_value = proximity_read_ambient_light( &proximity );
    proximity_proxi_value = proximity_read_prox_data( &proximity );

    log_printf( &logger, "Proximity:   %u\r\n", proximity_proxi_value);
    log_printf( &logger, " Ambient:   %u LUX\r\n ", proximity_ambi_value);

    Delay_ms ( 500 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Proximity

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


ALSO FROM THIS AUTHOR

8x8 click - Example

0

Simple example which demonstrates working with 8x8 click boards. 8x8 clicks are 8x8 LED matrix displays in form of add-on boards in mikroBUS form factor. Boards feature MAX7219 8-digit LED display driver module as well as 64 LED diodes.

[Learn More]

Nano LR Click

0

Nano LR Click is a compact add-on board that contains a long-range transceiver. This board features the EMB-LR1276S, RF technology-based SRD transceiver, which operates at a frequency of 868MHz from Embit.

[Learn More]

MP3 click

5

Simple example which demonstrates working with <b>MP3 click</b> board in mikroBUS form factor. Example will play MP3 file "sound.mp3" located on the microSD card.<br />

[Learn More]