TOP Contributors

  1. MIKROE (2784 codes)
  2. Alcides Ramos (405 codes)
  3. Shawon Shahryiar (307 codes)
  4. jm_palomino (133 codes)
  5. Bugz Bensce (97 codes)
  6. S P (73 codes)
  7. dany (71 codes)
  8. MikroBUS.NET Team (35 codes)
  9. NART SCHINACKOW (34 codes)
  10. Armstrong Subero (27 codes)

Most Downloaded

  1. Timer Calculator (141679 times)
  2. FAT32 Library (74728 times)
  3. Network Ethernet Library (59203 times)
  4. USB Device Library (49213 times)
  5. Network WiFi Library (44988 times)
  6. FT800 Library (44517 times)
  7. GSM click (31195 times)
  8. mikroSDK (30081 times)
  9. microSD click (27577 times)
  10. PID Library (27537 times)
Libstock prefers package manager

Package Manager

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]

< Back
mikroSDK Library

ROTARY R Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.14

mikroSDK Library: 2.0.0.0

Category: Rotary encoder

Downloaded: 386 times

Not followed.

License: MIT license  

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

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "ROTARY R Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "ROTARY R Click" changes.

Do you want to report abuse regarding "ROTARY R Click".

  • mikroSDK Library 1.0.0.0
  • Comments (0)

mikroSDK Library Blog


ROTARY R Click

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

rotaryr_click.png

Click Product page


Click library

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

Software Support

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

Standard key functions :

  • rotaryr_cfg_setup Config Object Initialization function.

    void rotaryr_cfg_setup ( rotaryr_cfg_t *cfg );
  • rotaryr_init Initialization function.

    ROTARYR_RETVAL rotaryr_init ( rotaryr_t *ctx, rotaryr_cfg_t *cfg );

Example key functions :

  • rotaryr_generic_transfer ROTARY R data transfer function.

    void rotaryr_generic_transfer ( rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
  • rotaryr_turn_on_led_by_position Function turn on led by position

    void rotaryr_turn_on_led_by_position ( rotaryr_t *ctx, uint8_t led_position );
  • rotaryr_button_push Function return 1 if button is pushed and return 0 if not

    uint8_t rotaryr_button_push ( rotaryr_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. */
    rotaryr_cfg_t rotaryr_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.

    rotaryr_cfg_setup( &rotaryr_cfg );
    ROTARYR_MAP_MIKROBUS( rotaryr_cfg, MIKROBUS_1 );
    err_t init_flag  = rotaryr_init( &rotaryr, &rotaryr_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 R Click, rotating and turn on/off led's, using the SPI interface.


void application_task ( void ) {
    rotaryr_turn_on_led_by_data( &rotaryr, led_data );

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

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

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

//     Rotate Clockwise and CounterClockwise
    if ( rotaryr_get_eca_state( &rotaryr ) == rotaryr_get_ecb_state( &rotaryr ) ) {
        old__rot_state = 0;
        start_status = rotaryr_get_eca_state( &rotaryr ) && rotaryr_get_ecb_state( &rotaryr );
    }
    else {
        new_rotate_state = 1;
        if ( new_rotate_state != old__rot_state ) {
            old__rot_state = 1;
            if ( start_status != rotaryr_get_eca_state( &rotaryr ) ) {
                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.RotaryR

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.


ALSO FROM THIS AUTHOR

XBEE Click

0

XBee Click is a compact add-on board providing wireless connectivity to end-point devices in ZigBee mesh networks. This board features the XB24CZ7PIS-004, a low-power Digi XBee® RF module delivering superior performance and interference immunity from Digi International. With its ultra-sensitive receiver, the XB24CZ7PIS-004 operates in the 2.4GHz ISM band (indoor/urban range of 60m and outdoor of 1200m), allowing the formation of robust mesh network optimized for use in the US, Canada, Europe, Australia, and Japan (worldwide acceptance). Alongside firmware updates, it supports commissioning and LED behaviors to aid device deployment and commissioning.

[Learn More]

BATT-MON 3 Click

0

BATT-MON 3 Click is a compact add-on board representing an advanced battery monitoring solution. This board features the BQ35100, battery fuel gauge, and end-of-service monitor from Texas Instruments. The BQ35100 provides highly configurable fuel gauging for non-rechargeable (primary) lithium batteries without requiring a forced battery discharge. It uses patented TI gauging algorithms to support the option to replace an old battery with a new one seamlessly. It provides accurate results with ultra-low average power consumption, alongside an I2C interface through which the host can read the gathered data.

[Learn More]

LLC SPI click

6

The LLC SPI click is a very useful Click board which can be utilized as the level converter for logic signals. The topology of this logic level conversion (LLC) circuit is perfectly suited for SPI communication between devices with unmatched voltages of their logic signals.

[Learn More]