ambient12

---

Ambient 12 Click

Ambient 12 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

---

Click Library

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

Software Support

Example Description

This example demonstrates the use of Ambient 12 Click board.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.Ambient12

Example Key Functions

• ambient12_cfg_setup Config Object Initialization function.

void ambient12_cfg_setup ( ambient12_cfg_t *cfg );

• ambient12_init Initialization function.

err_t ambient12_init ( ambient12_t *ctx, ambient12_cfg_t *cfg );

• ambient12_read_adc_voltage This function reads raw 12-bit ADC data and converts it to voltage by using I2C serial interface.

err_t ambient12_read_adc_voltage ( ambient12_t *ctx, float *voltage );

• ambient12_voltage_to_lux This function calculates illuminance (lux) based on the voltage input.

int32_t ambient12_voltage_to_lux ( ambient12_t *ctx, float voltage );

• ambient12_set_gain_mode This function sets the gain mode.

void ambient12_set_gain_mode ( ambient12_t *ctx, uint8_t mode );

Application Init

Initializes the driver and sets the gain mode to M-Gain which can detect the illuminance of up to 10000 lux.

void application_init ( void )
{
    log_cfg_t log_cfg;              /**< Logger config object. */
    ambient12_cfg_t ambient12_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 );
    Delay_ms ( 100 );
    log_info( &logger, " Application Init " );

    // Click initialization.
    ambient12_cfg_setup( &ambient12_cfg );
    AMBIENT12_MAP_MIKROBUS( ambient12_cfg, MIKROBUS_POSITION_AMBIENT12 );
    if ( ADC_ERROR == ambient12_init( &ambient12, &ambient12_cfg ) )
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    ambient12_set_gain_mode ( &ambient12, AMBIENT12_MODE_M_GAIN );
    log_printf( &logger, " M-Gain mode selected.\r\n Up to 10000 lux can be measured.\r\n" );
    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 ( AMBIENT12_OK == ambient12_read_adc_voltage ( &ambient12, &voltage ) )
    {
        log_printf( &logger, " Illuminance : %ld Lux\r\n\n", ambient12_voltage_to_lux( &ambient12, voltage ) );
    }
    
    Delay_ms ( 1000 );
}

Application Output

This Click board can be interfaced and monitored in two ways:

• Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
• UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.

---