rotaryb2

\mainpage Main Page

---

Rotary B 2 Click

Rotary B 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 blue LEDs that can be used to represent the encoder position more visually.

Click Product page

---

Click library

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

Software Support

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

Standard key functions :

• rotaryb2_cfg_setup Config Object Initialization function.

void rotaryb2_cfg_setup ( rotaryb2_cfg_t *cfg );

• rotaryb2_init Initialization function.

err_t rotaryb2_init ( rotaryb2_t *ctx, rotaryb2_cfg_t *cfg );

• rotaryb2_default_cfg Click Default Configuration function.

err_t rotaryb2_default_cfg ( rotaryb2_t *ctx );

Example key functions :

• rotaryb2_set_led_pos This function turns on the LED for the selected LED position.

err_t rotaryb2_set_led_pos ( rotaryb2_t *ctx, uint8_t led_pos );

• rotaryb2_set_led_data This function, using SPI serial interface, writes a desired 16-bit data.

err_t rotaryb2_set_led_data ( rotaryb2_t *ctx, uint16_t data_in );

• rotaryb2_get_state_switch This function return rotary encoder switch signal, states of the SW(INT).

uint8_t rotaryb2_get_state_switch ( rotaryb2_t *ctx );

Example Description

This library contains the API for the Rotary B 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;  /**< Logger config object. */
    rotaryb2_cfg_t rotaryb2_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.
    rotaryb2_cfg_setup( &rotaryb2_cfg );
    ROTARYB2_MAP_MIKROBUS( rotaryb2_cfg, MIKROBUS_1 );
    if ( SPI_MASTER_ERROR == rotaryb2_init( &rotaryb2, &rotaryb2_cfg ) )
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }
    
    if ( ROTARYB2_ERROR == rotaryb2_default_cfg ( &rotaryb2 ) )
    {
        log_error( &logger, " Default configuration." );
        for ( ; ; );
    }
    
    log_info( &logger, " Application Task " );
}

Application Task

This example demonstrates the use of the Rotary B 2 Click board™. The demo example shows the functionality of a rotary encoder used to control LEDs.

void application_task ( void )
{
    if ( ROTARYB2_OK == rotaryb2_set_led_data( &rotaryb2, led_data ) )
    {
        rotaryb2_switch_detection( );
        rotaryb2_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.RotaryB2

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.

---