rotaryy  2.0.0.0
Main Page

ROTARY Y click

Rotary click carries a 15-pulse incremental rotary encoder with detents, surrounded by a ring of 16 yellow LEDs. It’s a perfect solution for adding a precision input knob to your design. The encoder outputs A and B signals (out of phase to each other); the knob also acts as a push-button which sends an interrupt to the target board MCU. The LED ring is controlled through SPI lines (CS, SCK, MISO, MOSI). Rotary click can be used with either a 3.3V or 5V power supply.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Jun 2021.
  • Type : SPI type

Software Support

We provide a library for the RotaryY Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for RotaryY Click driver.

Standard key functions :

Example key functions :

Example Description

The demo application controls led on click with rotary 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.

void application_init ( void ) {
log_cfg_t log_cfg;
rotaryy_cfg_t rotaryy_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
rotaryy_cfg_setup( &rotaryy_cfg );
ROTARYY_MAP_MIKROBUS( rotaryy_cfg, MIKROBUS_1 );
err_t init_flag = rotaryy_init( &rotaryy, &rotaryy_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;
}

Application Task

Show functionality of Rotary Y Click, rotating and turn on/off led's, using the SPI interface.

void application_task ( void ) {
rotaryy_turn_on_led_by_data( &rotaryy, led_data );
// Push button
if ( rotaryy_button_push( &rotaryy ) ) {
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++ ) {
rotaryy_turn_on_led_by_data( &rotaryy, 0xAAAA );
Delay_ms ( 100 );
rotaryy_turn_on_led_by_data( &rotaryy, 0x5555 );
Delay_ms ( 100 );
}
for ( old_state = 0; old_state < 17; old_state++ ) {
rotaryy_turn_on_led_by_position( &rotaryy, old_state );
Delay_ms ( 100 );
}
led_state = 0;
led_data = rotaryy_get_led_data( led_state );
}
else {
led_data = rotaryy_get_led_data( led_state );
}
}
}
else {
old_state = 0;
}
// Rotate Clockwise and CounterClockwise
if ( rotaryy_get_eca_state( &rotaryy ) == rotaryy_get_ecb_state( &rotaryy ) ) {
old__rot_state = 0;
start_status = rotaryy_get_eca_state( &rotaryy ) && rotaryy_get_ecb_state( &rotaryy );
}
else {
new_rotate_state = 1;
if ( new_rotate_state != old__rot_state ) {
old__rot_state = 1;
if ( start_status != rotaryy_get_eca_state( &rotaryy ) ) {
led_data = ( led_data << 1 ) | ( led_data >> 15 );
}
else {
led_data = ( led_data >> 1 ) | ( led_data << 15 );
}
}
}
}

Note

In orther to use all of the clicks functionality, pull down INT pin.

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.RotaryY

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all MikroElektronika compilers, or any other terminal application of your choice, can be used to read the message.


rotaryy_turn_on_led_by_position
void rotaryy_turn_on_led_by_position(rotaryy_t *ctx, uint8_t led_position)
ROTARY Y turn on led by position function.
rotaryy_t
ROTARY Y Click context object.
Definition: rotaryy.h:108
rotaryy_turn_on_led_by_data
void rotaryy_turn_on_led_by_data(rotaryy_t *ctx, uint16_t write_data)
ROTARY Y generic data write function.
rotaryy_cfg_t
ROTARY Y Click configuration object.
Definition: rotaryy.h:133
application_task
void application_task(void)
Definition: main.c:78
rotaryy_cfg_setup
void rotaryy_cfg_setup(rotaryy_cfg_t *cfg)
ROTARY Y configuration object setup function.
ROTARYY_MAP_MIKROBUS
#define ROTARYY_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: rotaryy.h:90
rotaryy_button_push
uint8_t rotaryy_button_push(rotaryy_t *ctx)
Button push state.
rotaryy_init
err_t rotaryy_init(rotaryy_t *ctx, rotaryy_cfg_t *cfg)
ROTARY Y initialization function.
rotaryy_generic_transfer
void rotaryy_generic_transfer(rotaryy_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
ROTARY Y data transfer function.
application_init
void application_init(void)
Definition: main.c:40
rotaryy_get_ecb_state
uint8_t rotaryy_get_ecb_state(rotaryy_t *ctx)
State ecb pin.
rotaryy_get_led_data
uint16_t rotaryy_get_led_data(uint8_t current_led_state)
Get led data state.
rotaryy_get_eca_state
uint8_t rotaryy_get_eca_state(rotaryy_t *ctx)
State eca pin.