TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (402 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (129 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 (140768 times)
  2. FAT32 Library (73355 times)
  3. Network Ethernet Library (58200 times)
  4. USB Device Library (48384 times)
  5. Network WiFi Library (43976 times)
  6. FT800 Library (43538 times)
  7. GSM click (30467 times)
  8. mikroSDK (29170 times)
  9. PID Library (27166 times)
  10. microSD click (26848 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 5 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.17

mikroSDK Library: 2.0.0.0

Category: Proximity

Downloaded: 314 times

Not followed.

License: MIT license  

Proximity 5 Click is a very accurate and reliable proximity sensing (PS) and ambient light sensing (ALS) device, equipped with the state-of-the-art PS and ALS sensor.

No Abuse Reported

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

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

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

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Proximity 5 Click

Proximity 5 Click is a very accurate and reliable proximity sensing (PS) and ambient light sensing (ALS) device, equipped with the state-of-the-art PS and ALS sensor.

proximity5_click.png

Click Product page


Click library

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

Software Support

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

Standard key functions :

  • Config Object Initialization function.

    void proximity5_cfg_setup ( proximity5_cfg_t *cfg );

  • Initialization function.

    PROXIMITY5_RETVAL proximity5_init ( proximity5_t ctx, proximity5_cfg_t cfg );

  • Click Default Configuration function.

    void proximity5_default_cfg ( proximity5_t *ctx );

Example key functions :

  • Starts the conversion and waits for the interrupt to finish.

  • After the interrupt finishes the proximity data from the proximity registers

  • is returned to a 3 member uint16_t array.

    void proximity5_get_values ( proximity5_t ctx, uint16_t prox_val );

  • 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

  • and returns those combined values to a 16bit variable.

    uint16_t proximity5_read_reg ( proximity5_t *ctx, uint8_t addr );

Examples Description

The demo application is composed of two sections :

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 );
}  

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.Proximity5

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

LED Driver 15 Click

0

LED Driver 15 Click is a compact add-on board that simplifies the control of multiple LEDs. This board features the MP3309C, a fully integrated synchronous boost white LED driver with an I2C interface from Monolithic Power Systems. The MP3309C offers high efficiency, delivers up to 40mA of LED current, and operates from a voltage of mikroBUS™ power rails, supporting up to 8 white LEDs in series. It also features a programmable switching frequency to optimize efficiency, supports analog and PWM dimming, and has multiple built-in protection functions that protect the circuit during abnormalities.

[Learn More]

GNSS 5 Click

0

Determine your current position with GNSS 5 Click. It carries the NEO-M8N GNSS receiver module from u-blox.

[Learn More]

Pressure 18 Click

0

Pressure 18 Click is a compact add-on board that contains a board-mount pressure sensor. This board features the BMP384, a robust barometric pressure sensor delivering market-leading accuracy in a compact package from Bosch Sensortec. The BMP384 provides a relative accuracy of ±9Pa and typical absolute accuracy of ±50Pa with ultra-low noise, low power consumption, and a temperature coefficient offset of ±1Pa/K. It converts output data into a 24-bit digital value and sends the information via a configurable host interface that supports SPI and I2C serial communications. It measures pressure from 300hPa to 1250hPa over a wide operating temperature range.

[Learn More]