rotaryo2  2.1.0.0
Main Page

Rotary O 2 click

Rotary O 2 Click is a compact add-on board that allows you to add a precision input knob to your design. This board features the TLC5925, a low-power 16-channel constant-current LED sink driver from Texas Instruments that, combined with a high-quality rotary encoder from ALPS, the EC12D1564402, allows you to add a precision input knob to your design. It also features an LED ring composed of 16 individual orange LEDs that can visually represent the encoder position and more.

click Product page


Click library

  • Author : Nenad Filipovic
  • Date : Nov 2023.
  • Type : SPI type

Software Support

We provide a library for the Rotary O 2 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 Rotary O 2 Click driver.

Standard key functions :

Example key functions :

Example Description

This library contains the API for the Rotary O 2 Click driver to control LEDs states and a rotary encoder position readings.

The demo application is composed of two sections :

Application Init

Initialization of SPI module and log UART. After the driver init, the app executes a default configuration and turn off all LEDs.

void application_init ( void )
{
log_cfg_t log_cfg;
rotaryo2_cfg_t rotaryo2_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
rotaryo2_cfg_setup( &rotaryo2_cfg );
ROTARYO2_MAP_MIKROBUS( rotaryo2_cfg, MIKROBUS_1 );
if ( SPI_MASTER_ERROR == rotaryo2_init( &rotaryo2, &rotaryo2_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( ROTARYO2_ERROR == rotaryo2_default_cfg ( &rotaryo2 ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

This example demonstrates the use of the Rotary O 2 Click boardâ„¢. The demo example shows the functionality of a rotary encoder used to control LEDs.

void application_task ( void )
{
if ( ROTARYO2_OK == rotaryo2_set_led_data( &rotaryo2, led_data ) )
{
rotaryo2_switch_detection( );
rotaryo2_encoder_mechanism( );
}
}

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.RotaryO2

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. UART terminal is available in all MikroElektronika compilers.


rotaryo2_cfg_t
Rotary O 2 Click configuration object.
Definition: rotaryo2.h:171
rotaryo2_init
err_t rotaryo2_init(rotaryo2_t *ctx, rotaryo2_cfg_t *cfg)
Rotary O 2 initialization function.
rotaryo2_t
Rotary O 2 Click context object.
Definition: rotaryo2.h:153
rotaryo2_default_cfg
err_t rotaryo2_default_cfg(rotaryo2_t *ctx)
Rotary O 2 default configuration function.
ROTARYO2_ERROR
@ ROTARYO2_ERROR
Definition: rotaryo2.h:197
rotaryo2_get_state_switch
uint8_t rotaryo2_get_state_switch(rotaryo2_t *ctx)
Rotary O 2 get switch state function.
ROTARYO2_MAP_MIKROBUS
#define ROTARYO2_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: rotaryo2.h:136
application_task
void application_task(void)
Definition: main.c:114
rotaryo2_set_led_data
err_t rotaryo2_set_led_data(rotaryo2_t *ctx, uint16_t data_in)
Rotary O 2 set LED data function.
rotaryo2_cfg_setup
void rotaryo2_cfg_setup(rotaryo2_cfg_t *cfg)
Rotary O 2 configuration object setup function.
rotaryo2_set_led_pos
err_t rotaryo2_set_led_pos(rotaryo2_t *ctx, uint8_t led_pos)
Rotary O 2 set LED position function.
ROTARYO2_OK
@ ROTARYO2_OK
Definition: rotaryo2.h:196
application_init
void application_init(void)
Definition: main.c:78