Uncover the magic of this compact add-on board, combining rotary input control and dynamic LED lighting for captivating user experiences
A
A
Hardware Overview
How does it work?
Rotary O Click is based on two 74HC595 SPI-configurable 8-bit shift registers from Texas Instruments. Combined with a high-quality rotary encoder, the EC12D1564402 allows you to add a precision input knob to your design. The EC12D1564402 incremental rotary encoder is surrounded by a ring of 16 orange LEDs where a single rotation is divided into 15 discrete steps (in contrast to a potentiometer, a rotary encoder can be spun around continuously). This Click board™ is an ideal solution for building various HMI applications where precise input is required, but also for some interesting visual effects to any application. As mentioned, this Click board™ uses the EC12D1564402, a 15-pulse incremental rotary
encoder with a push-button, from ALPS. This encoder has unique mechanical specifications (debouncing time for its internal switches goes down to 2ms) and can withstand many switching cycles, up to 30.000. The supporting debouncing circuitry allows contacts to settle before the output is triggered fully. The 74HC595 controls each LED individually positioned in a ring around the encoder through a standard SPI interface with a maximum frequency of 5MHz. Rotating the encoder, it outputs A and B signals (out of phase to each other) on the two mikroBUS™ lines, AN and PWM pins of the mikroBUS™ socket, alongside the push-button contact, which outputs through the interrupt line of the mikroBUS™
socket. The 74HC595 also has a Reset feature used across the RST mikroBUS™ line. Finally, the Rotary O Click uses the 74LVC1T45, a single-bit, dual-power supply translating transceiver with three state outputs from Diodes Incorporated for rotary encoder voltage logic translation. This Click board™ can operate with either 3.3V or 5V logic voltage levels selected via the PWR 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
Curiosity PIC32 MZ EF development board is a fully integrated 32-bit development platform featuring the high-performance PIC32MZ EF Series (PIC32MZ2048EFM) that has a 2MB Flash, 512KB RAM, integrated FPU, Crypto accelerator, and excellent connectivity options. It includes an integrated programmer and debugger, requiring no additional hardware. Users can expand
functionality through MIKROE mikroBUS™ Click™ adapter boards, add Ethernet connectivity with the Microchip PHY daughter board, add WiFi connectivity capability using the Microchip expansions boards, and add audio input and output capability with Microchip audio daughter boards. These boards are fully integrated into PIC32’s powerful software framework, MPLAB Harmony,
which provides a flexible and modular interface to application development a rich set of inter-operable software stacks (TCP-IP, USB), and easy-to-use features. The Curiosity PIC32 MZ EF development board offers expansion capabilities making it an excellent choice for a rapid prototyping board in Connectivity, IOT, and general-purpose applications.
Microcontroller Overview
MCU Card / MCU
![default](https://dbp-cdn.mikroe.com/catalog/mcus/resources/PIC32MZ2048EFM100/PIC32MZ2048EFM100.jpg)
Architecture
PIC32
MCU Memory (KB)
2048
Silicon Vendor
Microchip
Pin count
100
RAM (Bytes)
524288
Used MCU Pins
mikroBUS™ mapper
Take a closer look
Schematic
![ROTARY O Click Schematic schematic](https://dbp-cdn.mikroe.com/catalog/click-boards/resources/1ee790a7-f1c3-694e-8322-0242ac120009/schematic.webp)
Step by step
Project assembly
Track your results in real time
Application Output
After loading the code example, pressing the "DEBUG" button builds and programs it on the selected setup.
![Application Output Step 1](https://dbp-cdn.mikroe.com/cms/shared-resources/1eed554e-d80f-6694-8cb9-02420a000272/AP-Step1.jpg)
After programming is completed, a header with buttons for various actions available in the IDE appears. By clicking the green "PLAY "button, we start reading the results achieved with Click board™.
![Application Output Step 3](https://dbp-cdn.mikroe.com/cms/shared-resources/1eed5550-3c0f-6800-a19f-02420a000272/AP-Step3.jpg)
Upon completion of programming, the Application Output tab is automatically opened, where the achieved result can be read. In case of an inability to perform the Debug function, check if a proper connection between the MCU used by the setup and the CODEGRIP programmer has been established. A detailed explanation of the CODEGRIP-board connection can be found in the CODEGRIP User Manual. Please find it in the RESOURCES section.
![Application Output Step 4](https://dbp-cdn.mikroe.com/cms/shared-resources/1eed5550-d4d0-6b20-a348-02420a000272/AP-Step4.jpg)
Software Support
Library Description
This library contains API for ROTARY O Click driver.
Key functions:
rotaryo_generic_transfer
- ROTARY data transfer functionrotaryo_turn_on_led_by_data
- Function turn on led by datarotaryo_turn_on_led_by_position
- Function turn on led by position
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 Rotary O Click example
*
* # Description
* The demo application controls led on click with rotory on board
*
* The demo application is composed of two sections :
*
* ## Application Init
* Initializes SPI driver, set initial states,
* set RST logic high and performs device configuration.
*
* ## Application Task
* Show functionality of Rotary O Click, rotating and turn on/off led's,
* using the SPI interface
*
* @note
* In order to use all of the clicks functionality, pull down INT pin.
*
* @author Stefan Ilic
*
*/
#include "board.h"
#include "log.h"
#include "rotaryo.h"
static rotaryo_t rotaryo;
static log_t logger;
static uint8_t start_status;
static uint8_t old_state;
static uint8_t new_state;
static uint8_t old__rot_state;
static uint8_t new_rotate_state;
static uint8_t led_state;
static uint16_t led_data;
void application_init ( void ) {
log_cfg_t log_cfg; /**< Logger config object. */
rotaryo_cfg_t rotaryo_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.
rotaryo_cfg_setup( &rotaryo_cfg );
ROTARYO_MAP_MIKROBUS( rotaryo_cfg, MIKROBUS_1 );
err_t init_flag = rotaryo_init( &rotaryo, &rotaryo_cfg );
if ( init_flag == SPI_MASTER_ERROR ) {
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_info( &logger, " Application Task " );
led_data = 0x0001;
old_state = 0;
new_state = 1;
old__rot_state = 0;
new_rotate_state = 1;
}
void application_task ( void ) {
rotaryo_turn_on_led_by_data( &rotaryo, led_data );
// Push button
if ( rotaryo_button_push( &rotaryo ) ) {
new_state = 1;
if ( new_state == 1 && old_state == 0 ) {
old_state = 1;
led_state = ( led_state + 1 ) % 5;
if ( led_state == 4 ) {
for ( old_state = 0; old_state < 17; old_state++ ) {
rotaryo_turn_on_led_by_data( &rotaryo, 0xAAAA );
Delay_ms( 100 );
rotaryo_turn_on_led_by_data( &rotaryo, 0x5555 );
Delay_ms( 100 );
}
for ( old_state = 0; old_state < 17; old_state++ ) {
rotaryo_turn_on_led_by_position( &rotaryo, old_state );
Delay_ms( 100 );
}
led_state = 0;
led_data = rotaryo_get_led_data( led_state );
}
else {
led_data = rotaryo_get_led_data( led_state );
}
}
}
else {
old_state = 0;
}
// Rotate Clockwise and CounterClockwise
if ( rotaryo_get_eca_state( &rotaryo ) == rotaryo_get_ecb_state( &rotaryo ) ) {
old__rot_state = 0;
start_status = rotaryo_get_eca_state( &rotaryo ) && rotaryo_get_ecb_state( &rotaryo );
}
else {
new_rotate_state = 1;
if ( new_rotate_state != old__rot_state ) {
old__rot_state = 1;
if ( start_status != rotaryo_get_eca_state( &rotaryo ) ) {
led_data = ( led_data << 1 ) | ( led_data >> 15 );
}
else {
led_data = ( led_data >> 1 ) | ( led_data << 15 );
}
}
}
}
void main ( void ) {
application_init( );
for ( ; ; ) {
application_task( );
}
}
// ------------------------------------------------------------------------ END