TOP Contributors

  1. MIKROE (2762 codes)
  2. Alcides Ramos (374 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (118 codes)
  5. Bugz Bensce (90 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 (139254 times)
  2. FAT32 Library (71751 times)
  3. Network Ethernet Library (57122 times)
  4. USB Device Library (47430 times)
  5. Network WiFi Library (43082 times)
  6. FT800 Library (42403 times)
  7. GSM click (29835 times)
  8. mikroSDK (28078 times)
  9. PID Library (26885 times)
  10. microSD click (26198 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

Ambient 2 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.20

mikroSDK Library: 2.0.0.0

Category: Optical

Downloaded: 336 times

Not followed.

License: MIT license  

Ambient 2 Click carries TI’s OPT3001 Ambient Light sensor. It’s a small (2mm x 2mm) single-chip lux meter that measures only the visible part of the light spectrum from any kind of source (mimicking the way humans see light).

No Abuse Reported

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

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

Do you want to report abuse regarding "Ambient 2 Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


Ambient 2 Click

Ambient 2 Click carries TI’s OPT3001 Ambient Light sensor. It’s a small (2mm x 2mm) single-chip lux meter that measures only the visible part of the light spectrum from any kind of source (mimicking the way humans see light).

ambient2_click.png

Click Product page


Click library

  • Author : Nemanja Medakovic
  • Date : Oct 2019.
  • Type : I2C type

Software Support

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

Standard key functions :

  • Configuration Object Setup function.

    void ambient2_cfg_setup ( ambient2_cfg_t *cfg );

  • Click Initialization function.

    ambient2_err_t ambient2_init( ambient2_t ctx, ambient2_cfg_t cfg );

  • Click Default Configuration function.

    void ambient2_default_cfg ( ambient2_t *ctx );

Example key functions :

  • Generic Write function.

    void ambient2_generic_write( ambient2_t *ctx, ambient2_reg_addr_t reg_addr, ambient2_data_t data_in );

  • Generic Read function.

    ambient2_data_t ambient2_generic_read( ambient2_t *ctx, ambient2_reg_addr_t reg_addr );

  • Sensor Results Read function.

    void ambient2_get_sens_results( ambient2_t *ctx );

Examples Description

This is a example which demonstrates the use of Ambient 2 Click board. This example measures and calculates abmient light from OPT3001 sensor.

The demo application is composed of two sections :

Application Init

Initializes I2C driver and all used pins for Ambient 2 Click. Also executes a default configuration for this Click, which means that Click will work in continuous conversion mode, in automatic full scale range, with conversion time of 800ms.


void application_init( void )
{
    ambient2_cfg_t ambient2_cfg;
    log_cfg_t console_cfg;

    //  Click initialization.
    ambient2_cfg_setup( &ambient2_cfg );
    AMBIENT2_MAP_MIKROBUS( ambient2_cfg, MIKROBUS_1 );
    ambient2_init( &ambient2, &ambient2_cfg );
    ambient2_default_cfg( &ambient2 );

    /** 
     * 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( console_cfg );
    log_init( &console, &console_cfg );
    log_write( &console, "* * *  Ambient 2 initialization done  * * *", LOG_FORMAT_LINE );
    log_write( &console, "*******************************************", LOG_FORMAT_LINE );
}

Application Task

Reads sensor data every time when conversion cycle was done and data was ready for reading. Sends results to the uart terminal.


void application_task( void )
{
    if ( ambient2_generic_read( &ambient2, AMBIENT2_REG_CONFIGURATION ) & AMBIENT2_FLAG_MASK_CONV_READY )
    {
        ambient2_get_sens_results( &ambient2 );

        log_printf( &console, "** Ambient Light Sensor : %.2f lux **\r\n", ambient2.sens_data.amb_light_lx );
        log_printf( &console, "** Ambient Light Range : %.2f lux **\r\n", ambient2.sens_data.amb_light_range );
        log_printf( &console, "** Ambient Light Percents : %d %% **\r\n\n", ambient2.sens_data.amb_light_per );
    }
}  

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

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

BUCK Click

0

BUCK Click is a buck switching regulator that accepts a wide input voltage range of up to 40V and steps it down to 3.3V or 5V.

[Learn More]

UV click

5

With UV click you can measure Ultraviolet light intensity both indoors and outdoors. The photodiode on the ML8511 IC is sensitive to UV-A (365–315 nm) and UV-B (315-280) rays. You can use UV click to design devices that protect the user against excesive sun exposure, or for industrial purposes where UV light is used for sterilization.

[Learn More]

Haptic click

2

Haptic click carries a Haptic Driver for ERM and LRA vibration motors. The board carries screw terminals for connecting said motors, as well as an audio interface (3.5mm jack). Haptic click communicates with the target MCU through mikroBUSâ„¢ I2C (SCL, SDA), EN (CS) and PWM pins. The board is designed to use either a 3.3V or 5V power supply.

[Learn More]