Skip to content

Latest commit

 

History

History
141 lines (108 loc) · 4.35 KB

README.md

File metadata and controls

141 lines (108 loc) · 4.35 KB

Rotary O 2 Click

Rotary O 2 Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

Click Library

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

Software Support

Example Description

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

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.RotaryO2

Example Key Functions

  • rotaryo2_cfg_setup Config Object Initialization function.
void rotaryo2_cfg_setup ( rotaryo2_cfg_t *cfg );
  • rotaryo2_init Initialization function.
err_t rotaryo2_init ( rotaryo2_t *ctx, rotaryo2_cfg_t *cfg );
  • rotaryo2_default_cfg Click Default Configuration function.
err_t rotaryo2_default_cfg ( rotaryo2_t *ctx );
  • rotaryo2_set_led_pos This function turns on the LED for the selected LED position.
err_t rotaryo2_set_led_pos ( rotaryo2_t *ctx, uint8_t led_pos );
  • rotaryo2_set_led_data This function, using SPI serial interface, writes a desired 16-bit data.
err_t rotaryo2_set_led_data ( rotaryo2_t *ctx, uint16_t data_in );
  • rotaryo2_get_state_switch This function return rotary encoder switch signal, states of the SW(INT).
uint8_t rotaryo2_get_state_switch ( rotaryo2_t *ctx );

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. */
    rotaryo2_cfg_t rotaryo2_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.
    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( );
    }
}

Application Output

This Click board can be interfaced and monitored in two ways:

  • Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
  • UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.