Enhance the lighting capabilities in your projects with KTD2691 and ATmega328P

Generate either a flash or a continuous torch light

Published Feb 14, 2024

Click board™

LED Flash 3 Click

Dev. board

Arduino UNO Rev3

Compiler

NECTO Studio

MCU

ATmega328P

Deliver quick bursts of intense light for photography needs or maintain a steady and constant illumination for navigation purposes

Hardware Overview

How does it work?

LED Flash 3 Click is based on the KTD2691, an inductorless single-flash LED driver from Kinetic Technologies. While working in flash mode, you can program the LED current over the software, but you can also use a hardware strobe pin to control this mode. The software can only program the torch mode and on/off ramp. There are various additional functionalities that this LED driver provides. This includes low voltage protection (LVP), a flash time-out function that sets the maximum time of one flash event, under voltage lock-out (UVLO), thermal shutdown, LED short protection, LED open protection, and more. The LED Flash 3 Click is

equipped with the XPCWHT-L1-R250-00A01, an Xlamp XP-C LED. The LED combines proven lighting-class performance and reliability. It features a white LED with a wide viewing angle and low thermal resistance. In addition, you can add an external similar LED over the available connector. The LED selection can be made over the LED SEL jumper. You can also select the LED driver voltage supply between the 3.3V and 5V over the VCC SEL jumper. LED Flash 3 Click uses a standard 2-wire I2C interface to communicate with the host MCU supporting standard and a fast mode with up to 400kHz clock frequency. The hardware strobe pin is

available over the STB pin. If using the STROBE pin to control the flash mode, there is an option to select when the flash mode is deactivated. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VIO SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. Also, this 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.

LED Flash 3 Click hardware overview image

Features overview

Development board

Arduino UNO is a versatile microcontroller board built around the ATmega328P chip. It offers extensive connectivity options for various projects, featuring 14 digital input/output pins, six of which are PWM-capable, along with six analog inputs. Its core components include a 16MHz ceramic resonator, a USB connection, a power jack, an

ICSP header, and a reset button, providing everything necessary to power and program the board. The Uno is ready to go, whether connected to a computer via USB or powered by an AC-to-DC adapter or battery. As the first USB Arduino board, it serves as the benchmark for the Arduino platform, with "Uno" symbolizing its status as the

first in a series. This name choice, meaning "one" in Italian, commemorates the launch of Arduino Software (IDE) 1.0. Initially introduced alongside version 1.0 of the Arduino Software (IDE), the Uno has since become the foundational model for subsequent Arduino releases, embodying the platform's evolution.

Microcontroller Overview

MCU Card / MCU

Architecture

AVR

MCU Memory (KB)

Silicon Vendor

Microchip

Pin count

RAM (Bytes)

2048

You complete me!

Accessories

Click Shield for Arduino UNO has two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the Arduino UNO board without effort. The Arduino Uno, a microcontroller board based on the ATmega328P, provides an affordable and flexible way for users to try out new concepts and build prototypes with the ATmega328P microcontroller from various combinations of performance, power consumption, and features. The Arduino Uno has 14 digital input/output pins (of which six can be used as PWM outputs), six analog inputs, a 16 MHz ceramic resonator (CSTCE16M0V53-R0), a USB connection, a power jack, an ICSP header, and reset button. Most of the ATmega328P microcontroller pins are brought to the IO pins on the left and right edge of the board, which are then connected to two existing mikroBUS™ sockets. This Click Shield also has several switches that perform functions such as selecting the logic levels of analog signals on mikroBUS™ sockets and selecting logic voltage levels of the mikroBUS™ sockets themselves. Besides, the user is offered the possibility of using any Click board™ with the help of existing bidirectional level-shifting voltage translators, regardless of whether the Click board™ operates at a 3.3V or 5V logic voltage level. Once you connect the Arduino UNO board with our Click Shield for Arduino UNO, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.

Used MCU Pins

mikroBUS™ mapper

RST

ID COMM

PB2

SCK

MISO

MOSI

Power Supply

3.3V

Ground

GND

Hardware Flash Enable

PD6

PWM

INT

I2C Clock

PC5

SCL

I2C Data

PC4

SDA

Power Supply

Ground

GND

Take a closer look

Click board™ Schematic

Step by step

Project assembly

Click Shield for Arduino UNO front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Arduino UNO Rev3 as your development board.

Arduino UNO Rev3 front image hardware assembly

Charger 27 Click front image hardware assembly

Board mapper by product8 hardware assembly

Necto No Display image step 8 hardware assembly

Debug Image Necto Step hardware assembly

Track your results in real time

Application Output

1. Application Output - In Debug mode, the 'Application Output' window enables real-time data monitoring, offering direct insight into execution results. Ensure proper data display by configuring the environment correctly using the provided tutorial.

2. UART Terminal - Use the UART Terminal to monitor data transmission via a USB to UART converter, allowing direct communication between the Click board™ and your development system. Configure the baud rate and other serial settings according to your project's requirements to ensure proper functionality. For step-by-step setup instructions, refer to the provided tutorial.

3. Plot Output - The Plot feature offers a powerful way to visualize real-time sensor data, enabling trend analysis, debugging, and comparison of multiple data points. To set it up correctly, follow the provided tutorial, which includes a step-by-step example of using the Plot feature to display Click board™ readings. To use the Plot feature in your code, use the function: plot(*insert_graph_name*, variable_name);. This is a general format, and it is up to the user to replace 'insert_graph_name' with the actual graph name and 'variable_name' with the parameter to be displayed.

Software Support

Library Description

This library contains API for LED Flash 3 Click driver.

Key functions:

ledflash3_write_reg - LED Flash 3 register writing function
ledflash3_set_flash_current - LED Flash 3 set flash current function
ledflash3_set_torch_current - LED Flash 3 set torch current function

Open Source

Code example

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.

/*!
 * @file main.c
 * @brief LED Flash 3 Click example
 *
 * # Description
 * This app demonstrate flash mode on LED Flash 3 Click.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * Initializes the driver and performs the Click default configuration.
 *
 * ## Application Task
 * Turning the LED on for a second and off for another second.
 *
 * @author Stefan Ilic
 *
 */

#include "board.h"
#include "log.h"
#include "ledflash3.h"

static ledflash3_t ledflash3;
static log_t logger;

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    ledflash3_cfg_t ledflash3_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.
    ledflash3_cfg_setup( &ledflash3_cfg );
    LEDFLASH3_MAP_MIKROBUS( ledflash3_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == ledflash3_init( &ledflash3, &ledflash3_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( LEDFLASH3_ERROR == ledflash3_default_cfg ( &ledflash3 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task ");
}

void application_task ( void ) 
{
    ledflash3_strobe_pin( &ledflash3 );
    Delay_ms ( 1000 );
    Delay_ms ( 1000 );
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

// ------------------------------------------------------------------------ END