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 (141237 times)
  2. FAT32 Library (74038 times)
  3. Network Ethernet Library (58662 times)
  4. USB Device Library (48767 times)
  5. Network WiFi Library (44489 times)
  6. FT800 Library (44034 times)
  7. GSM click (30784 times)
  8. mikroSDK (29606 times)
  9. PID Library (27342 times)
  10. microSD click (27223 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: 381 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

CapSense 2 Click

0

CapSense 2 Click is a compact add-on board that easily integrates projected capacitive touch into user's applications. This board features the CAP1114, a multi-channel capacitive touch sensor that takes human body capacitance as an input and directly provides the real-time sensor information via the I2C serial interface from Microchip. This board contains capacitive sensing elements, a 7-segment slider, two buttons, and four LED indicators that visually detect the activation on some of these parts. This Click board™ offers reliable and accurate sensing for any application that uses capacitive touch sensing functions.

[Learn More]

BLE 7 Click

0

The BLE 7 Click is a Click board™ witch provide BT/BLE connectivity for any embedded application. BLE 7 Click based on the BGX13S22GA-V31, a SiP module from Silicon Labs with a buit-in antenna. Click board™ an ultra-small, high-performing, Bluetooth low energy module for easy integration of Bluetooth low energy connectivity (BLE) into various electronic devices. Given its features, this Click can be used for health, sports, and wellness devices as well as Industrial, home, and building automation; and smart phone, tablet, and PC accessories.

[Learn More]

NFC Click

0

NFC Click is a mikroBUS™ add-on board with a versatile near field communications controller from NXP — the PN7120 IC. NFC devices are used in contactless payment systems, electronic ticketing, smartcards, but also in retail and advertising — inexpensive NFC tags can be embedded into packaging labels, flyers or posters.

[Learn More]