Intermediate
30 min

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

The future of illumination starts now

LED Driver 9 Click with Curiosity Nano with PIC18F57Q43

Published Feb 13, 2024

Click board™

LED Driver 9 Click

Dev Board

Curiosity Nano with PIC18F57Q43

Compiler

NECTO Studio

MCU

PIC18F57Q43

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

PIC18F57Q43 Curiosity Nano evaluation kit is a cutting-edge hardware platform designed to evaluate microcontrollers within the PIC18-Q43 family. Central to its design is the inclusion of the powerful PIC18F57Q43 microcontroller (MCU), offering advanced functionalities and robust performance. Key features of this evaluation kit include a yellow user LED and a responsive

mechanical user switch, providing seamless interaction and testing. The provision for a 32.768kHz crystal footprint ensures precision timing capabilities. With an onboard debugger boasting a green power and status LED, programming and debugging become intuitive and efficient. Further enhancing its utility is the Virtual serial port (CDC) and a debug GPIO channel (DGI

GPIO), offering extensive connectivity options. Powered via USB, this kit boasts an adjustable target voltage feature facilitated by the MIC5353 LDO regulator, ensuring stable operation with an output voltage ranging from 1.8V to 5.1V, with a maximum output current of 500mA, subject to ambient temperature and voltage constraints.

PIC18F57Q43 Curiosity Nano double side image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC

MCU Memory (KB)

128

Silicon Vendor

Microchip

Pin count

48

RAM (Bytes)

8196

You complete me!

Accessories

Curiosity Nano Base for Click boards is a versatile hardware extension platform created to streamline the integration between Curiosity Nano kits and extension boards, tailored explicitly for the mikroBUS™-standardized Click boards and Xplained Pro extension boards. This innovative base board (shield) offers seamless connectivity and expansion possibilities, simplifying experimentation and development. Key features include USB power compatibility from the Curiosity Nano kit, alongside an alternative external power input option for enhanced flexibility. The onboard Li-Ion/LiPo charger and management circuit ensure smooth operation for battery-powered applications, simplifying usage and management. Moreover, the base incorporates a fixed 3.3V PSU dedicated to target and mikroBUS™ power rails, alongside a fixed 5.0V boost converter catering to 5V power rails of mikroBUS™ sockets, providing stable power delivery for various connected devices.

Curiosity Nano Base for Click boards accessories 1 image

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
Reset
PA7
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
PB2
SCL
I2C Data
PB1
SDA
NC
NC
5V
Ground
GND
GND
1

Take a closer look

Schematic

LED Driver 9 Click Schematic schematic

Step by step

Project assembly

Curiosity Nano Base for Click boards front image hardware assembly

Start by selecting your development board and Click board™. Begin with the Curiosity Nano with PIC18F57Q43 as your development board.

Curiosity Nano Base for Click boards front image hardware assembly
Charger 27 Click front image hardware assembly
PIC18F47Q10 Curiosity Nano front image hardware assembly
Prog-cut hardware assembly
Charger 27 Click complete accessories setup image hardware assembly
Curiosity Nano with PICXXX Access MB 1 - upright/background hardware assembly
Necto image step 2 hardware assembly
Necto image step 3 hardware assembly
Necto image step 4 hardware assembly
Necto image step 5 hardware assembly
Necto image step 6 hardware assembly
PIC18F57Q43 Curiosity MCU Step hardware assembly
Necto No Display image step 8 hardware assembly
Necto image step 9 hardware assembly
Necto image step 10 hardware assembly
Debug Image Necto Step hardware assembly

Track your results in real time

Application Output via Debug Mode

1. Once the code example is loaded, pressing the "DEBUG" button initiates the build process, programs it on the created setup, and enters Debug mode.

2. After the programming is completed, a header with buttons for various actions within the IDE becomes visible. Clicking the green "PLAY" button starts reading the results achieved with the Click board™. The achieved results are displayed in the Application Output tab.

DEBUG_Application_Output

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

This example can be found in NECTO Studio. Feel free to download the code, or you can copy the code below.

/*!
 * @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 );
    }
}

void main ( void ) {
    application_init( );

    for ( ; ; ) {
        application_task( );
    }
}

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.