Ideal for applications where both tactile and visual feedback are important, showing the position or level that the encoder is set to, like volume control, position sensing, and user interface controls
A
A
Hardware Overview
How does it work?
Rotary RGB Click is based on the LED ring composed of 16 individual RGB LEDs, the WS2812B-2020 from Worldsemi, alongside a high-quality rotary encoder from ALPS, the EC12D1564402, visually representing the encoder position and more. The WS2812B-2020s internal configuration includes an intelligent digital port data latch and signals to reshape the amplification drive circuit. It also consists of a precision internal oscillator and a voltage-programmable constant current control part, ensuring consistent pixel point light color height. The WS2812B-2020 is an LED with low driving voltage (5V from mikroBUS™ power rail is used as its main power supply), environmental protection and energy saving, high brightness, large scattering angle, good consistency, low power, long life, and other advantages. This Click board™ makes the perfect solution for the development of various interesting visual effects for any application, such as flexible
position, value indicator, and more. The data transfer protocol uses a single NZR communication mode via DO and DI pins of the mikroBUS™ socket. After the pixel Power-On reset sequence, the DI port of the WS2812B-2020 receives data from the host controller; the first pixel collects initial 24-bit data and then sent to the internal data latch, and the other data, which is reshaped by the internal signal reshaping amplification circuit is sent to the next cascade pixel through the DO port. After transmission for each pixel, the signal is reduced to 24bit. Pixel adopts auto reshaping transmit technology, making the pixel cascade number not limited to the signal transmission, only depending on the speed of signal transmission. The EC12D1564402 is a 15-pulse incremental rotary encoder with a push button. This encoder has unique mechanical specifications (debouncing time for its internal switches goes down to 2ms), and it can withstand a huge number of switching cycles,
up to 30.000. The supporting debouncing circuitry allows contacts to settle before the output is triggered fully. Rotating the encoder, it outputs A and B signals (out of phase to each other) on the two mikroBUS™ lines, ENA and ENB pins of the mikroBUS™ socket, alongside the push-button contact, which outputs through the SW pin of the mikroBUS™ socket. Four SN74LVC1T45 single-bit bus transceivers from Texas Instruments are used for logic-level translation of encoder and data transfer protocol signals. 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. 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.
Features overview
Development board
Nucleo-64 with STM32F091RC MCU offers a cost-effective and adaptable platform for developers to explore new ideas and prototype their designs. This board harnesses the versatility of the STM32 microcontroller, enabling users to select the optimal balance of performance and power consumption for their projects. It accommodates the STM32 microcontroller in the LQFP64 package and includes essential components such as a user LED, which doubles as an ARDUINO® signal, alongside user and reset push-buttons, and a 32.768kHz crystal oscillator for precise timing operations. Designed with expansion and flexibility in mind, the Nucleo-64 board features an ARDUINO® Uno V3 expansion connector and ST morpho extension pin
headers, granting complete access to the STM32's I/Os for comprehensive project integration. Power supply options are adaptable, supporting ST-LINK USB VBUS or external power sources, ensuring adaptability in various development environments. The board also has an on-board ST-LINK debugger/programmer with USB re-enumeration capability, simplifying the programming and debugging process. Moreover, the board is designed to simplify advanced development with its external SMPS for efficient Vcore logic supply, support for USB Device full speed or USB SNK/UFP full speed, and built-in cryptographic features, enhancing both the power efficiency and security of projects. Additional connectivity is
provided through dedicated connectors for external SMPS experimentation, a USB connector for the ST-LINK, and a MIPI® debug connector, expanding the possibilities for hardware interfacing and experimentation. Developers will find extensive support through comprehensive free software libraries and examples, courtesy of the STM32Cube MCU Package. This, combined with compatibility with a wide array of Integrated Development Environments (IDEs), including IAR Embedded Workbench®, MDK-ARM, and STM32CubeIDE, ensures a smooth and efficient development experience, allowing users to fully leverage the capabilities of the Nucleo-64 board in their projects.
Microcontroller Overview
MCU Card / MCU
Architecture
ARM Cortex-M0
MCU Memory (KB)
256
Silicon Vendor
STMicroelectronics
Pin count
64
RAM (Bytes)
32768
You complete me!
Accessories
Click Shield for Nucleo-64 comes equipped with two proprietary mikroBUS™ sockets, allowing all the Click board™ devices to be interfaced with the STM32 Nucleo-64 board with no effort. This way, Mikroe allows its users to add any functionality from our ever-growing range of Click boards™, such as WiFi, GSM, GPS, Bluetooth, ZigBee, environmental sensors, LEDs, speech recognition, motor control, movement sensors, and many more. More than 1537 Click boards™, which can be stacked and integrated, are at your disposal. The STM32 Nucleo-64 boards are based on the microcontrollers in 64-pin packages, a 32-bit MCU with an ARM Cortex M4 processor operating at 84MHz, 512Kb Flash, and 96KB SRAM, divided into two regions where the top section represents the ST-Link/V2 debugger and programmer while the bottom section of the board is an actual development board. These boards are controlled and powered conveniently through a USB connection to program and efficiently debug the Nucleo-64 board out of the box, with an additional USB cable connected to the USB mini port on the board. Most of the STM32 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 STM32 Nucleo-64 board with our Click Shield for Nucleo-64, you can access hundreds of Click boards™, working with 3.3V or 5V logic voltage levels.
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Click board™ Schematic
Step by step
Project assembly
Track your results in real time
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.
Software Support
Library Description
This library contains API for Rotary RGB Click driver.
Key functions:
rotaryrgb_set_led_pos_color
- This function sets the desired color for the selected LED position.rotaryrgb_set_all_leds_data
- This function, using the GPIO protocol, writes the desired array of 16 elements of data to control all LEDs.rotaryrgb_get_state_switch
- This function return rotary encoder switch signal, states of the SW(INT) pin.
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 Rotary RGB Click Example.
*
* # Description
* This library contains the API for the Rotary RGB Click driver
* to control LEDs states and a rotary encoder position readings.
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initialization of GPIO module and log UART.
* After the driver init, the app turn off all LEDs.
*
* ## Application Task
* This example demonstrates the use of the Rotary RGB Click board.
* The demo example shows the functionality of a rotary encoder used to control RGB LEDs.
* The switch controls the application of the colors,
* and the encoder mechanism controls the state of the LEDs.
*
* ## Additional Function
* - static void rotaryrgb_logic_zero ( void )
* - static void rotaryrgb_logic_one ( void )
* - static void rotaryrgb_switch_detection ( void )
* - static void rotaryrgb_encoder_mechanism ( void )
*
* @note
* Make sure the logic delays are defined for your system in the rotaryrgb_delays.h file.
*
* @author Nenad Filipovic
*
*/
#include "board.h"
#include "log.h"
#include "rotaryrgb.h"
#include "rotaryrgb_delays.h"
static rotaryrgb_t rotaryrgb; /**< Rotary RGB Click driver object. */
static log_t logger; /**< Logger object. */
static uint8_t start_rot_status = 0;
static uint8_t led_color_sel = 0;
static uint8_t old_state = 0;
static uint8_t new_state = 1;
static uint8_t old_rot_state = 0;
static uint8_t new_rot_state = 1;
static uint16_t led_pos = 1;
static uint32_t demo_color_table[ 8 ] =
{
ROTARYRGB_COLOR_WHITE_50,
ROTARYRGB_COLOR_RED_50,
ROTARYRGB_COLOR_GREEN_50,
ROTARYRGB_COLOR_BLUE_50,
ROTARYRGB_COLOR_LIGHT_BLUE_50,
ROTARYRGB_COLOR_YELLOW_50,
ROTARYRGB_COLOR_PURPLE_50,
ROTARYRGB_COLOR_OFF
};
/**
* @brief Rotary RGB logic zero function.
* @details This function generates a logic zero sequence char
* to control the LED light source.
* @return Nothing.
*/
static void rotaryrgb_logic_zero ( void );
/**
* @brief Rotary RGB logic one function.
* @details This function generates a logic one sequence char
* to control the LED light source.
* @return Nothing.
*/
static void rotaryrgb_logic_one ( void );
/**
* @brief Rotary RGB switch detection function.
* @details This function is used for the switch state detection.
* @return Nothing.
*/
static void rotaryrgb_switch_detection ( void );
/**
* @brief Rotary RGB encoder mechanism function.
* @details This function is used to control the state of the LEDs
* by detecting the rotation direction of the rotary encoder.
* @return Nothing.
*/
static void rotaryrgb_encoder_mechanism ( void );
void application_init ( void )
{
log_cfg_t log_cfg; /**< Logger config object. */
rotaryrgb_cfg_t rotaryrgb_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.
rotaryrgb_cfg_setup( &rotaryrgb_cfg, &rotaryrgb_logic_zero, &rotaryrgb_logic_one );
ROTARYRGB_MAP_MIKROBUS( rotaryrgb_cfg, MIKROBUS_1 );
if ( DIGITAL_OUT_UNSUPPORTED_PIN == rotaryrgb_init( &rotaryrgb, &rotaryrgb_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
rotaryrgb_set_all_led_color( &rotaryrgb, ROTARYRGB_COLOR_OFF );
Delay_ms( 100 );
log_info( &logger, " Application Task " );
Delay_ms( 100 );
}
void application_task ( void )
{
rotaryrgb_set_led_pos_color( &rotaryrgb, led_pos % 17, demo_color_table[ led_color_sel ] );
rotaryrgb_switch_detection( );
rotaryrgb_encoder_mechanism( );
}
int main ( void )
{
application_init( );
for ( ; ; )
{
application_task( );
}
return 0;
}
static void rotaryrgb_logic_zero ( void )
{
hal_ll_gpio_set_pin_output( &rotaryrgb.di_pin.pin );
DELAY_TOH;
hal_ll_gpio_clear_pin_output( &rotaryrgb.di_pin.pin );
DELAY_TOL;
}
static void rotaryrgb_logic_one ( void )
{
hal_ll_gpio_set_pin_output( &rotaryrgb.di_pin.pin );
DELAY_T1H;
hal_ll_gpio_clear_pin_output( &rotaryrgb.di_pin.pin );
DELAY_T1L;
}
static void rotaryrgb_switch_detection ( void )
{
if ( rotaryrgb_get_state_switch( &rotaryrgb ) )
{
new_state = 1;
if ( ( 1 == new_state ) && ( 0 == old_state ) )
{
old_state = 1;
led_color_sel++;
if ( 7 < led_color_sel )
{
led_color_sel = 0;
}
}
}
else
{
old_state = 0;
}
}
static void rotaryrgb_encoder_mechanism ( void )
{
if ( rotaryrgb_get_state_enb( &rotaryrgb ) == rotaryrgb_get_state_ena( &rotaryrgb ) )
{
old_rot_state = 0;
start_rot_status = rotaryrgb_get_state_enb( &rotaryrgb ) && rotaryrgb_get_state_ena( &rotaryrgb );
}
else
{
new_rot_state = 1;
if ( new_rot_state != old_rot_state )
{
old_rot_state = 1;
if ( start_rot_status != rotaryrgb_get_state_enb( &rotaryrgb ) )
{
led_pos++;
}
else
{
led_pos--;
}
if ( 0 == led_pos % 17 )
{
Delay_ms( 1 );
rotaryrgb_set_all_led_color( &rotaryrgb, ROTARYRGB_COLOR_OFF );
}
}
}
}
// ------------------------------------------------------------------------ END