ambient10  2.0.0.0
Main Page

Ambient 10 click

Ambient 10 Click is a compact add-on board used to sense the amount of the present ambient light. This board features the APDS-9006-020, analog-output ambient light photosensor from Broadcom Limited.

click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Jul 2021.
  • Type : ADC type

Software Support

We provide a library for the Ambient10 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 from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Ambient10 Click driver.

Standard key functions :

Example key functions :

  • ambient10_set_vref This function sets the voltage reference for Ambient 10 click driver.
    err_t ambient10_set_vref ( ambient10_t *ctx, float vref );
  • ambient10_read_adc_voltage This function reads raw 12-bit ADC data and converts it to voltage by using I2C serial interface.
    err_t ambient10_read_adc_voltage ( ambient10_t *ctx, float *voltage );
  • ambient10_voltage_to_lux This function calculates illuminance (lux) based on the voltage input.
    uint16_t ambient10_voltage_to_lux ( ambient10_t *ctx, float voltage );

Example Description

This example demonstrates the use of Ambient 10 click board.

The demo application is composed of two sections :

Application Init

Initializes the driver and sets the voltage reference.

void application_init ( void )
{
log_cfg_t log_cfg;
ambient10_cfg_t ambient10_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
Delay_ms( 100 );
log_info( &logger, " Application Init " );
// Click initialization.
ambient10_cfg_setup( &ambient10_cfg );
AMBIENT10_MAP_MIKROBUS( ambient10_cfg, MIKROBUS_1 );
if ( ADC_ERROR == ambient10_init( &ambient10, &ambient10_cfg ) )
{
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Reads the ADC voltage and then calculates the illuminance from it. The calculated value of illuminance in lux is being displayed on the USB UART approximately once per second.

void application_task ( void )
{
float voltage = 0;
if ( AMBIENT10_OK == ambient10_read_an_pin_voltage ( &ambient10, &voltage ) )
{
log_printf( &logger, " Illuminance : %u Lux\r\n\n", ambient10_voltage_to_lux( &ambient10, voltage ) );
}
Delay_ms( 1000 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Ambient10

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. UART terminal is available in all MikroElektronika compilers.


AMBIENT10_VREF_3V3
#define AMBIENT10_VREF_3V3
Definition: ambient10.h:78
AMBIENT10_MAP_MIKROBUS
#define AMBIENT10_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: ambient10.h:106
ambient10_cfg_t
Ambient 10 Click configuration object.
Definition: ambient10.h:133
ambient10_cfg_setup
void ambient10_cfg_setup(ambient10_cfg_t *cfg)
Ambient 10 configuration object setup function.
ambient10_set_vref
err_t ambient10_set_vref(ambient10_t *ctx, float vref)
Ambient 10 set vref function.
application_task
void application_task(void)
Definition: main.c:62
ambient10_read_adc_voltage
err_t ambient10_read_adc_voltage(ambient10_t *ctx, float *voltage)
Ambient 10 read ADC voltage function.
ambient10_init
err_t ambient10_init(ambient10_t *ctx, ambient10_cfg_t *cfg)
Ambient 10 initialization function.
ambient10_read_an_pin_voltage
err_t ambient10_read_an_pin_voltage(ambient10_t *ctx, float *data_out)
Ambient 10 read AN pin voltage level function.
AMBIENT10_OK
@ AMBIENT10_OK
Definition: ambient10.h:152
ambient10_t
Ambient 10 Click context object.
Definition: ambient10.h:119
application_init
void application_init(void)
Definition: main.c:28
ambient10_voltage_to_lux
uint16_t ambient10_voltage_to_lux(ambient10_t *ctx, float voltage)
Ambient 10 voltage to illuminance function.