We strongly encourage users to use Package manager for sharing their code on Libstock website, because it boosts your efficiency and leaves the end user with no room for error. [more info]
Rating:
Author: MIKROE
Last Updated: 2024-10-31
Package Version: 2.1.0.14
mikroSDK Library: 2.0.0.0
Category: Rotary encoder
Downloaded: 221 times
Not followed.
License: MIT license
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.
Do you want to subscribe in order to receive notifications regarding "ROTARY Y Click" changes.
Do you want to unsubscribe in order to stop receiving notifications regarding "ROTARY Y Click" changes.
Do you want to report abuse regarding "ROTARY Y Click".
DOWNLOAD LINK | RELATED COMPILER | CONTAINS |
---|---|---|
4535_rotary_y_click.zip [607.78KB] | mikroC AI for ARM GCC for ARM Clang for ARM mikroC AI for PIC mikroC AI for PIC32 XC32 GCC for RISC-V Clang for RISC-V mikroC AI for AVR mikroC AI for dsPIC XC16 |
|
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.
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.
This library contains API for RotaryY Click driver.
rotaryy_cfg_setup
Config Object Initialization function.
void rotaryy_cfg_setup ( rotaryy_cfg_t *cfg );
rotaryy_init
Initialization function.
ROTARYY_RETVAL rotaryy_init ( rotaryy_t *ctx, rotaryy_cfg_t *cfg );
rotaryy_generic_transfer
ROTARY B data transfer function.
void rotaryy_generic_transfer ( rotaryy_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
rotaryy_turn_on_led_by_position
Function turn on led by position
void rotaryy_turn_on_led_by_position ( rotaryy_t *ctx, uint8_t led_position );
rotaryy_button_push
Function return 1 if button is pushed and return 0 if not
uint8_t rotaryy_button_push ( rotaryy_t *ctx );
The demo application controls led on Click with rotary on board.
The demo application is composed of two sections :
Initializes SPI driver, set initial states, set RST logic high and performs device configuration.
void application_init ( void ) {
log_cfg_t log_cfg; /**< Logger config object. */
rotaryy_cfg_t rotaryy_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.
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;
}
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 );
}
}
}
}
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:
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.