ambient23 2.1.0.0
Main Page

Ambient 23 click

PRVIH_PAR_RECENICA_SA_PRODUCT_PAGE_DA_ISPRATE_CELINU

[click Product page](CLICK_PRODUCT_PAGE_LINK)


Click library

  • Author : Stefan Ilic
  • Date : Apr 2023.
  • Type : I2C type

Software Support

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

Standard key functions :

Example key functions :

  • ambient23_reg_read Ambient 23 register reading function.
    err_t ambient23_reg_read ( ambient23_t *ctx, uint8_t reg, uint16_t *data_out );
    err_t ambient23_reg_read(ambient23_t *ctx, uint8_t reg, uint16_t *data_out)
    Ambient 23 register reading function.
  • ambient23_get_conversion_data Ambient 23 get conversion data function.
    err_t ambient23_get_conversion_data ( ambient23_t *ctx );
  • ambient23_read_light_data Ambient 23 get light data function.
    err_t ambient23_read_light_data ( ambient23_t *ctx, float *light_data );
    err_t ambient23_read_light_data(ambient23_t *ctx, float *light_data)
    Ambient 23 get light data function.

Example Description

This example demonstrates the use of Ambient 23 click board by measuring

the ambient light level in Lux.

The demo application is composed of two sections :

Application Init

Initializes the driver, checks communication by reading part ID

and performs the click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
ambient23_cfg_t ambient23_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
ambient23_cfg_setup( &ambient23_cfg );
AMBIENT23_MAP_MIKROBUS( ambient23_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == ambient23_init( &ambient23, &ambient23_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
uint16_t part_id = 0;
ambient23_reg_read( &ambient23, AMBIENT23_REG_DEVICE_ID, &part_id );
if ( AMBIENT23_PART_ID != ( uint8_t ) part_id )
{
log_error( &logger, " Communication error." );
for ( ; ; );
}
if ( AMBIENT23_ERROR == ambient23_default_cfg ( &ambient23 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
@ AMBIENT23_ERROR
Definition: ambient23.h:215
#define AMBIENT23_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: ambient23.h:173
#define AMBIENT23_REG_DEVICE_ID
Definition: ambient23.h:62
#define AMBIENT23_PART_ID
Ambient 23 device ID.
Definition: ambient23.h:142
void application_init(void)
Definition: main.c:30

Application Task

Measuring ambient light level by reading data from the Ambient 23 click board

and displaying it using UART Serial terminal.

void application_task ( void )
{
float data_tmp;
ambient23_read_light_data( &ambient23, &data_tmp );
log_printf( &logger, "Data: %.2f lux\r\n", data_tmp );
Delay_ms( 1000 );
}
void application_task(void)
Definition: main.c:74

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

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.