Convert ambient light into the most accurate Lux values
A
A
Hardware Overview
How does it work?
Ambient 19 Click is based on the APM-16D24-310-DF8/TR8, a digital I2C interface sensor that integrates Ambient Light Sensor (ALS), Proximity Sensor (PS), and Infrared LED (IR LED) from Everlight Electronics. The ALS can sense ambient light intensity that matches the human eye's response and enable the device to implement display dimming or lighting brightness control functions, helping to reduce power consumption. Also, the proximity sensor uses an IR LED reflection function to detect "away or close" to the object, triggering the device to turn ON/OFF or some other specific function. Three photodiodes are built in the APM-16D24-310-DF8/TR8, where each photodiode responds to different light spectra. This feature can distinguish different light sources and derive different illuminance conversion formulas according to various light sources.
Also, it has a flexible and wide operating range for the ambient light sensor with a maximum resolution of 0.0023lux/count and full detectable illumination of 57880Lux. An integrated proximity function has an adjustable number of IR pulses from 1 to 256 alongside a flexible IR LED driving current to meet different application requirements. An integrated filter also reduces unwanted IR signals and environmental noise. The APM-16D24-310-DF8/TR8 does not require a specific Power-Up sequence but requires a voltage of 1.8V for its interface and logic part to work correctly. Therefore, a small regulating LDO, the MAX8511, is used, providing a 1.8V out of either 5V or 3.3V mikroBUS™ power rails. Ambient 19 Click communicates with MCU using the standard I2C 2-Wire interface with a maximum clock frequency of 400kHz, fully adjustable through software registers.
Since the sensor for operation requires a power supply of 3.3V, this Click board™ also features the PCA9306 and SN74LVC1T45 voltage-level translators. The I2C interface bus lines are routed to the voltage-level translators allowing this Click board™ to work with both 3.3V and 5V MCUs properly. It also possesses an additional interrupt signal, routed on the INT pin of the mikroBUS™ socket, indicating when a specific interrupt event occurs, such as detecting a meaningful change in light intensity. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. However, the Click board™ comes equipped with a library containing easy-to-use functions and an example code that can be used, as a reference, for further development.
![Ambient 19 Click top side image](https://dbp-cdn.mikroe.com/catalog/click-boards/resources/1edc054c-7a27-66f2-877f-02420a00048b/01-ambient-19-click-front.png)
![Ambient 19 Click lateral side image](https://dbp-cdn.mikroe.com/catalog/click-boards/resources/1edc054d-4a8e-63ae-a6d3-02420a00048b/02-ambient-19-click-side.png)
![Ambient 19 Click bottom side image](https://dbp-cdn.mikroe.com/catalog/click-boards/resources/1edc054e-283b-6a12-82f7-02420a00048b/03-ambient-19-click-back.png)
Features overview
Development board
Clicker 4 for STM32 is a compact development board designed as a complete solution that brings the flexibility of add-on Click boards™ to your favorite microcontroller, making it a perfect starter kit for implementing your ideas. It comes with an onboard 32-bit ARM Cortex-M4 microcontroller, the STM32F767BI from STMicroelectronics, four mikroBUS™ sockets for Click board™ connectivity, a USB connector, LED indicators, buttons, a debugger/programmer connector, two 23-pin headers for interfacing with external electronics, and more. Thanks to innovative manufacturing technology, it allows you to build gadgets with
unique functionalities and features quickly. Each part of the Clicker 4 for STM32 development kit contains the components necessary for the most efficient operation of the same board. In addition to the possibility of choosing the Clicker 4 for STM32 programming method, using an external CODEGRIP or mikroProg programmer connected to the onboard JTAG/SWD header, the Clicker 4 board also includes a clean and regulated power supply block. It provides several ways of board-powering; through the USB Type-C (USB-C) connector using a power supply delivered by the USB HOST (i.e., personal computer), USB wall
adapter, or a Li-Po/Li-Ion battery via an onboard battery connector. All communication methods that mikroBUS™ itself supports are on this board (plus USB-DEVICE), including the well-established mikroBUS™ socket, several user-configurable buttons, and LED indicators. Clicker 4 for STM32 is an integral part of the Mikroe ecosystem, allowing you to create a new application in minutes. Natively supported by Mikroe software tools, it covers many aspects of prototyping thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.
Microcontroller Overview
MCU Card / MCU
![default](https://dbp-cdn.mikroe.com/catalog/mcus/resources/STM32F767BI.jpg)
Architecture
ARM Cortex-M7
MCU Memory (KB)
2048
Silicon Vendor
STMicroelectronics
Pin count
208
RAM (Bytes)
524288
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Schematic
![Ambient 19 Click Schematic schematic](https://dbp-cdn.mikroe.com/catalog/click-boards/resources/1ee7909e-1472-665c-a038-0242ac120009/schematic.webp)
Step by step
Project assembly
Track your results in real time
Application Output
After loading the code example, pressing the "DEBUG" button builds and programs it on the selected setup.
![Application Output Step 1](https://dbp-cdn.mikroe.com/cms/shared-resources/1eed554e-d80f-6694-8cb9-02420a000272/AP-Step1.jpg)
After programming is completed, a header with buttons for various actions available in the IDE appears. By clicking the green "PLAY "button, we start reading the results achieved with Click board™.
![Application Output Step 3](https://dbp-cdn.mikroe.com/cms/shared-resources/1eed5550-3c0f-6800-a19f-02420a000272/AP-Step3.jpg)
Upon completion of programming, the Application Output tab is automatically opened, where the achieved result can be read. In case of an inability to perform the Debug function, check if a proper connection between the MCU used by the setup and the CODEGRIP programmer has been established. A detailed explanation of the CODEGRIP-board connection can be found in the CODEGRIP User Manual. Please find it in the RESOURCES section.
![Application Output Step 4](https://dbp-cdn.mikroe.com/cms/shared-resources/1eed5550-d4d0-6b20-a348-02420a000272/AP-Step4.jpg)
Software Support
Library Description
This library contains API for Ambient 19 Click driver.
Key functions:
ambient19_measure_light_level
This function reads the raw ALS data from two channels and then measures the light level in lux based on those readings.ambient19_read_raw_proximity
This function reads the raw PS and IR data of the proximity sensor.ambient19_clear_interrupts
This function clears all interrupts by clearing the INT_FLAG register.
Open Source
Code example
This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.
/*!
* @file main.c
* @brief Ambient19 Click example
*
* # Description
* This example demonstrates the use of Ambient 19 click board by measuring
* the ambient light level in Lux.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes the driver and performs the click default configuration.
*
* ## Application Task
* Waits for the data ready interrupt, then reads the ambient light level in Lux as well as
* the raw proximity data of PS and IR leds and displays the results on the USB UART.
* By default, the data ready interrupt triggers upon every ADC cycle which will be
* performed every 500ms approximately.
*
* @author Stefan Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "ambient19.h"
static ambient19_t ambient19;
static log_t logger;
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
ambient19_cfg_t ambient19_cfg; /**< Click config object. */
/**
* 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.
ambient19_cfg_setup( &ambient19_cfg );
AMBIENT19_MAP_MIKROBUS( ambient19_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == ambient19_init( &ambient19, &ambient19_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( AMBIENT19_ERROR == ambient19_default_cfg ( &ambient19 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
void application_task ( void )
{
if ( !ambient19_get_int_pin ( &ambient19 ) )
{
uint16_t lux, ps_data, ir_data;
if ( AMBIENT19_OK == ambient19_measure_light_level ( &ambient19, &lux ) )
{
log_printf ( &logger, "\r\n Ambient light level [Lux]: %u\r\n", lux );
}
if ( AMBIENT19_OK == ambient19_read_raw_proximity ( &ambient19, &ps_data, &ir_data ) )
{
log_printf ( &logger, " PS data: %u\r\n", ps_data );
log_printf ( &logger, " IR data: %u\r\n", ir_data );
}
ambient19_clear_interrupts ( &ambient19 );
}
}
void main ( void )
{
application_init( );
for ( ; ; )
{
application_task( );
}
}
// ------------------------------------------------------------------------ END