rgbring

---

RGB Ring Click

RGB Ring 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 : Aug 2024.
• Type : GPIO type

Software Support

Example Description

This example demonstrates the use of RGB Ring Click board by controling an RGB ring by cycling through a set of predefined colors. Each color is displayed by lighting up the LEDs in sequence around the ring. After the last LED is lit, the code waits for a button press before moving on to the next color in the sequence. The button press triggers the transition to the next color in the array.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.RGBRing

Example Key Functions

• rgbring_cfg_setup Config Object Initialization function.

void rgbring_cfg_setup ( rgbring_cfg_t *cfg );

• rgbring_init Initialization function.

err_t rgbring_init ( rgbring_t *ctx, rgbring_logic_t logic_zero, rgbring_logic_t logic_one, rgbring_cfg_t *cfg );

• rgbring_default_cfg Click Default Configuration function.

err_t rgbring_default_cfg ( rgbring_t *ctx );

• rgbring_get_int_pin This function returns the INT pin logic state.

uint8_t rgbring_get_int_pin ( rgbring_t *ctx );

• rgbring_set_led_color This function sets the color of the selected LED in the LED matrix.

void rgbring_set_led_color ( rgbring_t *ctx, uint8_t led_num, uint32_t rgb );

• rgbring_write_led_matrix This function writes the LED matrix data from the Click context object.

err_t rgbring_write_led_matrix ( rgbring_t *ctx );

Application Init

Initializes the driver and performs the Click default configuration which sets the color to black (all LEDs off).

void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    rgbring_cfg_t rgbring_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.
    rgbring_cfg_setup( &rgbring_cfg );
    RGBRING_MAP_MIKROBUS( rgbring_cfg, MIKROBUS_1 );
    if ( DIGITAL_OUT_UNSUPPORTED_PIN == 
         rgbring_init( &rgbring, &rgbring_logic_zero, &rgbring_logic_one, &rgbring_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    if ( RGBRING_ERROR == rgbring_default_cfg ( &rgbring ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

Application Task

Controls an LED ring by cycling through colors and waits for user input to change the ring's color. The button press is required to move to the next color in the sequence. The current color's name and RGB value are logged to the USB UART.

void application_task ( void )
{
    static uint32_t color_num = 0;
    static int8_t led_cnt = 0;

    log_printf( &logger, " Color: %s [%.6LX]\r\n", color[ color_num ].name, color[ color_num ].rgb );
    Delay_ms ( 100 );
    for ( led_cnt = RGBRING_LED_7; led_cnt >= RGBRING_LED_0; led_cnt-- )
    {
        rgbring_set_led_color ( &rgbring, led_cnt, color[ color_num ].rgb );
        rgbring_write_led_matrix ( &rgbring );
        Delay_ms ( 100 );
    }
    if ( ++color_num >= RGBRING_NUM_COLORS )
    {
        color_num = 0;
    }

    log_printf ( &logger, " Press button to change ring color\r\n\n" );
    while ( RGBRING_BUTTON_RELESED == rgbring_get_int_pin ( &rgbring ) );
}

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.

---