Intermediate
30 min

Customize your lighting solutions to meet specific project requirements using TLC59116 and TM4C129ENCPDT

The future of illumination starts now

LED Driver 9 Click with Fusion for Tiva v8

Published Sep 05, 2023

Click board™

LED Driver 9 Click

Dev. board

Fusion for Tiva v8

Compiler

NECTO Studio

MCU

TM4C129ENCPDT

Enhance user experience in your electronic projects with our LED driver's capability to deliver reliable and aesthetically pleasing lighting effects

A

A

Hardware Overview

How does it work?

LED Driver 9 Click is based on the TLC59116, an I2C bus-controlled 16-channel LED driver optimized for red/green/blue/amber (RGBA) color mixing and backlight application from Texas Instruments. It operates within a VCC supply voltage range where its outputs are 17V tolerant. Each LED output, 16 LED drivers presented on two 2x5 male headers, with a maximum output current of 120mA per channel, is programmable at OFF and ON state and has programmable individual LED brightness with group dimming and blinking. Each LED output has its individual PWM controller, which allows each LED to be set at a specific brightness value. An additional 8-bit resolution (256 steps) group PWM controller has a fixed frequency of

190Hz and an adjustable frequency between 24Hz to once every 10.73 seconds, with an adjustable duty cycle from 0% to 99.6%. LED Driver 9 Click communicates with MCU using a standard I2C 2-Wire interface, with a clock frequency up to 100kHz in the Standard, 400kHz in the Fast, and 1MHz in the Fast Mode Plus. The Software Reset feature allows the MCU to perform a reset of the TLC59116 through the I2C bus, identical to the Power-On Reset (POR) that initializes the registers to their default state, causing the outputs to be set high, which means that the LEDs are OFF. This allows a quick reconfiguring of all device registers to the same condition. Also, this Click board™ has a Reset pin routed to the RST pin on the

mikroBUS™ socket, which holds registers in their default states until the RST pin is set to a logic high state. At the top of this Click board™, there is also a terminal labeled Rext used to connect an external resistor to set the LED current. The TLC59116 scales up the reference current set by the external resistor to sink the output current at each output port. This Click board™ can be operated only with a 3.3V logic voltage level. The board must perform appropriate logic voltage level conversion before using MCUs with different logic levels. Also, it comes equipped with a library containing functions and an example code that can be used as a reference for further development.

LED Driver 9 Click top side image
LED Driver 9 Click bottom side image

Features overview

Development board

Fusion for TIVA v8 is a development board specially designed for the needs of rapid development of embedded applications. It supports a wide range of microcontrollers, such as different 32-bit ARM® Cortex®-M based MCUs from Texas Instruments, regardless of their number of pins, and a broad set of unique functions, such as the first-ever embedded debugger/programmer over a WiFi network. The development board is well organized and designed so that the end-user has all the necessary elements, such as switches, buttons, indicators, connectors, and others, in one place. Thanks to innovative manufacturing technology, Fusion for TIVA v8 provides a fluid and immersive working experience, allowing access

anywhere and under any circumstances at any time. Each part of the Fusion for TIVA v8 development board contains the components necessary for the most efficient operation of the same board. An advanced integrated CODEGRIP programmer/debugger module offers many valuable programming/debugging options, including support for JTAG, SWD, and SWO Trace (Single Wire Output)), and seamless integration with the Mikroe software environment. Besides, it also includes a clean and regulated power supply module for the development board. It can use a wide range of external power sources, including a battery, an external 12V power supply, and a power source via the USB Type-C (USB-C) connector.

Communication options such as USB-UART, USB HOST/DEVICE, CAN (on the MCU card, if supported), and Ethernet is also included. In addition, it also has the well-established mikroBUS™ standard, a standardized socket for the MCU card (SiBRAIN standard), and two display options for the TFT board line of products and character-based LCD. Fusion for TIVA v8 is an integral part of the Mikroe ecosystem for rapid development. Natively supported by Mikroe software tools, it covers many aspects of prototyping and development thanks to a considerable number of different Click boards™ (over a thousand boards), the number of which is growing every day.

Fusion for Tiva v8 horizontal image

Microcontroller Overview

MCU Card / MCU

default

Type

8th Generation

Architecture

ARM Cortex-M4

MCU Memory (KB)

1024

Silicon Vendor

Texas Instruments

Pin count

128

RAM (Bytes)

262144

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
PK3
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
NC
NC
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PD2
SCL
I2C Data
PD3
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

LED Driver 9 Click Schematic schematic

Step by step

Project assembly

Fusion for PIC v8 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Fusion for Tiva v8 as your development board.

Fusion for PIC v8 front image hardware assembly
GNSS2 Click front image hardware assembly
SiBRAIN for PIC32MZ1024EFK144 front image hardware assembly
GNSS2 Click complete accessories setup image hardware assembly
Board mapper by product7 hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
NECTO Compiler Selection Step Image hardware assembly
NECTO Output Selection Step Image hardware assembly
Necto image step 6 hardware assembly
Necto image step 7 hardware assembly
Necto image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Necto PreFlash Image hardware assembly

Software Support

Library Description

This library contains API for LED Driver 9 Click driver.

Key functions:

  • leddriver9_ledout_state - This function configures the LEDOUTx registers from the defined config structure

  • leddriver9_set_pwm - This function sets the PWM duty cycle on selected ledout channel

  • leddriver9_set_dimmer_pwm - This function sets the group PWM duty cycle ( GRPPWM ) which can be used for dimming already set PWM channels.

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 LEDDriver9 Click example
 *
 * # Description
 * This app demonstrates the configuration and control
 * of the LED Driver 9 Click board resulting in a nice
 * breathing effect.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * The initialization configures the UART LOG and I2C
 * drivers and adjusts the Led Driver 9 Click general
 * register settings.
 *
 * ## Application Task
 * The application task is a simple breathing effect on
 * all LED out channels.
 *
 * @author Stefan Nikolic
 *
 */

#include "board.h"
#include "log.h"
#include "leddriver9.h"

static leddriver9_t leddriver9;
static log_t logger;

static leddriver9_mode_reg_t dev_reg = { 0 };
static leddriver9_output_state_t output_state = { 0 };

static float max_duty = 20;
static float min_duty = 0;
static float duty_gradient = 0.1;
const uint8_t breathing_speed = 5;

void mode1_register_settings ( void );
void mode2_register_settings ( void );
void led_output_state ( void );

void application_init ( void ) {
    log_cfg_t log_cfg;                /**< Logger config object. */
    leddriver9_cfg_t leddriver9_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.

    leddriver9_cfg_setup( &leddriver9_cfg );
    LEDDRIVER9_MAP_MIKROBUS( leddriver9_cfg, MIKROBUS_1 );
    err_t init_flag = leddriver9_init( &leddriver9, &leddriver9_cfg );
    if ( init_flag == I2C_MASTER_ERROR ) {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    leddriver9_default_cfg( &leddriver9 );
    log_info( &logger, " Application Task " );
    
    mode1_register_settings( );
    mode2_register_settings( );
    Delay_ms ( 100 );
    
    led_output_state( );
    Delay_ms ( 100 );
}

void application_task ( void ) {
    float duty_cnt = min_duty;
    
    while ( duty_cnt <= max_duty ) {
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL0, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL1, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL2, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL3, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL4, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL5, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL6, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL7, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL8, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL9, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL10, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL11, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL12, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL13, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL14, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL15, duty_cnt );
        duty_cnt += duty_gradient;
        Delay_ms ( breathing_speed );
    }
    while ( duty_cnt > min_duty ) {
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL0, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL1, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL2, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL3, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL4, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL5, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL6, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL7, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL8, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL9, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL10, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL11, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL12, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL13, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL14, duty_cnt );
        leddriver9_set_pwm( &leddriver9, LEDDRIVER9_CHANNEL15, duty_cnt );
        duty_cnt -= duty_gradient;
        Delay_ms ( breathing_speed );
    }
}

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;
}

void mode1_register_settings ( void ) {
    dev_reg.mode_1.ALLCALL = 0;
    dev_reg.mode_1.SUB3 = 0;
    dev_reg.mode_1.SUB2 = 0;
    dev_reg.mode_1.SUB1 = 0;
    dev_reg.mode_1.OSC = 0;
    leddriver9_mode1_reg_write( &leddriver9, &dev_reg );
}

void mode2_register_settings ( void ) {
    dev_reg.mode_2.OCH = 0;
    dev_reg.mode_2.DMBLNK = 0;
    dev_reg.mode_2.EFCLR = 0;
    leddriver9_mode2_reg_write( &leddriver9, &dev_reg );
}

void led_output_state ( void ) {
    output_state.LEDOUT0.LDR0 = LEDDRIVER9_GROUP;
    output_state.LEDOUT0.LDR1 = LEDDRIVER9_GROUP;
    output_state.LEDOUT0.LDR2 = LEDDRIVER9_GROUP;
    output_state.LEDOUT0.LDR3 = LEDDRIVER9_GROUP;
    output_state.LEDOUT1.LDR4 = LEDDRIVER9_GROUP;
    output_state.LEDOUT1.LDR5 = LEDDRIVER9_GROUP;
    output_state.LEDOUT1.LDR6 = LEDDRIVER9_GROUP;
    output_state.LEDOUT1.LDR7 = LEDDRIVER9_GROUP;
    output_state.LEDOUT2.LDR8 = LEDDRIVER9_GROUP;
    output_state.LEDOUT2.LDR9 = LEDDRIVER9_GROUP;
    output_state.LEDOUT2.LDR10 = LEDDRIVER9_GROUP;
    output_state.LEDOUT2.LDR11 = LEDDRIVER9_GROUP;
    output_state.LEDOUT3.LDR12 = LEDDRIVER9_GROUP;
    output_state.LEDOUT3.LDR13 = LEDDRIVER9_GROUP;
    output_state.LEDOUT3.LDR14 = LEDDRIVER9_GROUP;
    output_state.LEDOUT3.LDR15 = LEDDRIVER9_GROUP;
    leddriver9_ledout_state( &leddriver9, &output_state );
}

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

Additional Support

Resources

Love this project?

'Buy This Kit' button takes you directly to the shopping cart where you can easily add or remove products.