Intermediate
30 min

Enhance any setting or project with its radiant glow using LP5862 and PIC18F97J94

Dazzle and delight with a mesmerizing yellow

LED Ring 2 Click with CLICKER 4 for PIC18F

Published Feb 12, 2024

Click board™

LED Ring 2 Click

Dev. board

CLICKER 4 for PIC18F

Compiler

NECTO Studio

MCU

PIC18F97J94

Discover the endless lighting possibilities with our circular yellow LED ring, designed to bring brilliance to a wide range of applications

A

A

Hardware Overview

How does it work?

LED Ring 2 Click is based on the LP5862, a high-performance LED matrix driver from Texas Instruments. The LP5862 integrates 18 constant current sinks for driving 18 LEDs. A standard yellow LED is used as a light source, the SML-LX0402SYC-TR, with a peak wavelength of 590nm. With the help of two additional LP5862 drivers, it is realized, as shown on this board, an LED ring of 54 yellow LEDs arranged in a circular pattern. This Click board™ can significantly improve user experience in various animation and indication application areas like smart home, gaming equipment, and other human-machine interaction applications. This Click board™ communicates with an MCU using the standard I2C 2-Wire interface to read

data and configure settings, supporting Fast-Plus mode with a frequency of up to 1MHz. The LP5862 also supports the register-configurable PWM dimming method for efficiently adjusting LED light brightness. For PWM dimming, the integrated 8-bit or 16-bit configurable, >20kHz PWM generators for each LED enable smooth, vivid animation effects without audible noise. Each LED can also be mapped into an 8-bit group PWM to achieve group control with minimum data traffic. The VSY pin of the mikroBUS™ socket serves as a synchronization signal. The LP5862 also implements full addressable SRAM, supporting entire SRAM data refresh and partial SRAM data update on demand to minimize the data traffic.

Besides, the LP5862 implements the ghost cancellation circuit to eliminate upside and downside ghosting. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the VCC SEL jumper. This way, both 3.3V and 5V capable MCUs can use the communication lines properly. In addition, it is possible to select the LED supply voltage between either 3.3V or 5V voltage level set via the VLED SEL jumper. However, the 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 Ring 2 Click top side image
LED Ring 2 Click bottom side image

Features overview

Development board

Clicker 4 for PIC18F is a compact development board designed as a complete solution to build your own gadgets with unique functionalities quickly. It features a PIC18F97J94MCU, four mikroBUS™ sockets for Click boards™ connectivity, power management, and more, and it is a perfect solution for the rapid development of many different types of applications. At its core is an 8-bit PIC18F97J94 MCU, a powerful microcontroller produced by Microchip, based on the high-performance CPU with two external clock modes, up to 64MHz. It

provides sufficient processing power for the most demanding tasks, allowing Clicker 4 to adapt to any specific application requirements. Besides two 1x20 pin headers, four improved mikroBUS™ sockets represent the most distinctive connectivity feature, allowing access to a huge base of Click boards™, growing on a daily basis. Each section of Clicker 4 is clearly marked, offering an intuitive and clean interface. This makes working with the development board much simpler and, thus, faster. The usability of Clicker 4 doesn’t end with its ability

to accelerate the prototyping and application development stages: it is designed as a complete solution that can be implemented directly into any project, with no additional hardware modifications required. Four mounting holes [4.2mm/0.165”] at all four corners allow simple installation by using mounting screws. For most applications, a nice, stylish casing is all that is needed to turn the Clicker 4 development board into a fully functional, custom design.

Clicker 4 for PIC18F double image

Microcontroller Overview

MCU Card / MCU

default

Architecture

PIC

MCU Memory (KB)

128

Silicon Vendor

Microchip

Pin count

100

RAM (Bytes)

3862

Used MCU Pins

mikroBUS™ mapper

NC
NC
AN
NC
NC
RST
NC
NC
CS
NC
NC
SCK
NC
NC
MISO
NC
NC
MOSI
Power Supply
3.3V
3.3V
Ground
GND
GND
Synchronization Signal
PG4
PWM
NC
NC
INT
NC
NC
TX
NC
NC
RX
I2C Clock
PC3
SCL
I2C Data
PC4
SDA
Power Supply
5V
5V
Ground
GND
GND
1

Take a closer look

Click board™ Schematic

LED Ring 2 Click Schematic schematic

Step by step

Project assembly

Clicker 4 for STM32F4 front image hardware assembly

Start by selecting your development board and Click board™. Begin with the CLICKER 4 for PIC18F as your development board.

Clicker 4 for STM32F4 front image hardware assembly
Rotary O 2 Click front image hardware assembly
Clicker 4 STM32F4 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
Clicker 4 for STM32F4 HA 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

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 Ring 2 Click driver.

Key functions:

  • ledring2_set_led_brightness - LED Ring 2 set LED brightness function

  • ledring2_set_led_pos_state - LED Ring 2 set LED state function

  • ledring2_enable - LED Ring 2 enable 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 Ring 2 Click example
 *
 * # Description
 * This library contains API for LED Ring 2 Click driver.
 * The library initializes and defines the I2C bus drivers 
 * to write and read data from registers. 
 * The library also includes a function for controlling LEDs.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * The initialization of I2C module, log UART, and additional pins.
 * After the driver init, the app executes a default configuration.
 *
 * ## Application Task
 * This example demonstrates the use of the LED Ring 2 Click board™.
 * The demo example controls every LED and changes the LED brightness by PWM,
 * increasing its brightness from LED1 to LED54.
 *
 * @author Nenad Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "ledring2.h"

static ledring2_t ledring2;
static log_t logger;

void application_init ( void ) 
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    ledring2_cfg_t ledring2_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.
    ledring2_cfg_setup( &ledring2_cfg );
    LEDRING2_MAP_MIKROBUS( ledring2_cfg, MIKROBUS_1 );
    if ( I2C_MASTER_ERROR == ledring2_init( &ledring2, &ledring2_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    Delay_ms( 100 );
    
    if ( LEDRING2_ERROR == ledring2_default_cfg ( &ledring2 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    Delay_ms( 100 );
    log_info( &logger, " Application Task " );
    log_printf( &logger, " LED Ring 2 Click\r\n" );
}

void application_task ( void ) 
{
    for ( uint8_t led_pos = 1; led_pos < 55; led_pos++ )
    {
        if ( LEDRING2_OK == ledring2_set_led_brightness( &ledring2, led_pos, ( led_pos * 100 ) + 255 ) )
        {
            ledring2_set_vsync( &ledring2 );
            Delay_ms( 10 );
        }
    }
    Delay_ms( 1000 );
    
    for ( uint8_t led_pos = 54; led_pos > 0; led_pos-- )
    {
        if ( LEDRING2_OK == ledring2_set_led_brightness( &ledring2, led_pos, 0 ) )
        {
            ledring2_set_vsync( &ledring2 );
            Delay_ms( 10 );
        }
    }
    Delay_ms( 1000 );
}

void main ( void ) 
{
    application_init( );

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

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