rotaryg

\mainpage Main Page

---

ROTARY G Click

Rotary Click carries a 15-pulse incremental rotary encoder with detents, surrounded by a ring of 16 green 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 RotaryG 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 RotaryG Click driver.

Standard key functions :

• rotaryg_cfg_setup Config Object Initialization function.

void rotaryg_cfg_setup ( rotaryg_cfg_t *cfg );

• rotaryg_init Initialization function.

ROTARYG_RETVAL rotaryg_init ( rotaryg_t *ctx, rotaryg_cfg_t *cfg );

Example key functions :

• rotaryg_generic_transfer ROTARY G data transfer function.

void rotaryg_generic_transfer ( rotaryg_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );

• rotaryg_turn_on_led_by_position Function turn on led by position

void rotaryg_turn_on_led_by_position ( rotaryg_t *ctx, uint8_t led_position );

• rotaryg_button_push Function return 1 if button is pushed and return 0 if not

uint8_t rotaryg_button_push ( rotaryg_t *ctx );

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;  /**< Logger config object. */
    rotaryg_cfg_t rotaryg_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.

    rotaryg_cfg_setup( &rotaryg_cfg );
    ROTARYG_MAP_MIKROBUS( rotaryg_cfg, MIKROBUS_1 );
    err_t init_flag  = rotaryg_init( &rotaryg, &rotaryg_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 G Click, rotating and turn on/off led's, using the SPI interface.

void application_task ( void ) {
    rotaryg_turn_on_led_by_data( &rotaryg, led_data );

//     Push button
    if ( rotaryg_button_push( &rotaryg ) ) {
        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++ ) {
                    rotaryg_turn_on_led_by_data( &rotaryg, 0xAAAA );
                    Delay_ms ( 100 );
                    rotaryg_turn_on_led_by_data( &rotaryg, 0x5555 );
                    Delay_ms ( 100 );
                }

                for ( old_state = 0; old_state < 17; old_state++ ) {
                    rotaryg_turn_on_led_by_position( &rotaryg, old_state );
                    Delay_ms ( 100 );
                }

                led_state = 0;
                led_data = rotaryg_get_led_data( led_state );
            }
            else {
                led_data = rotaryg_get_led_data( led_state );
            }
        }
    }
    else {
        old_state = 0;
    }

//     Rotate Clockwise and CounterClockwise
    if ( rotaryg_get_eca_state( &rotaryg ) == rotaryg_get_ecb_state( &rotaryg ) ) {
        old__rot_state = 0;
        start_status = rotaryg_get_eca_state( &rotaryg ) && rotaryg_get_ecb_state( &rotaryg );
    }
    else {
        new_rotate_state = 1;
        if ( new_rotate_state != old__rot_state ) {
            old__rot_state = 1;
            if ( start_status != rotaryg_get_eca_state( &rotaryg ) ) {
                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.RotaryG

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.

---