optoencoder2

---

Opto Encoder 2 Click

Opto Encoder 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 : MikroE Team
• Date : Dec 2019.
• Type : GPIO type

Software Support

Example Description

This application is used to encode motion or rotation.

Example Libraries

• MikroSDK.Board
• MikroSDK.Log
• Click.OptoEncoder2

Example Key Functions

• optoencoder2_cfg_setup Config Object Initialization function.

void optoencoder2_cfg_setup ( optoencoder2_cfg_t *cfg ); 

• optoencoder2_init Initialization function.

err_t optoencoder2_init ( optoencoder2_t *ctx, optoencoder2_cfg_t *cfg );

• optoencoder2_pwm_get Getting PWM pin state

uint8_t optoencoder2_pwm_get ( optoencoder2_t *ctx );

• optoencoder2_int_get Getting INT pin state

uint8_t optoencoder2_int_get ( optoencoder2_t *ctx );

• optoencoder2_get_position Getting encoder position

int32_t optoencoder2_get_position ( optoencoder2_t *ctx );

Application Init

Initializes GPIO driver and resets encoder counter to 0 (zero).

void application_init ( void )
{
    log_cfg_t log_cfg;
    optoencoder2_cfg_t cfg;

    /** 
     * 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.
    optoencoder2_cfg_setup( &cfg );
    OPTOENCODER2_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    optoencoder2_init( &optoencoder2, &cfg );

    optoencoder2_zero_counter( &optoencoder2 );
}

Application Task

If motion is detected - encoder increments or decrements position on each rising edge on Channel A (INT pin) and logs encoder position.

void application_task ( )
{
    int32_t encoder_position = 0;
    uint8_t stop_flag = 0;

    stop_flag = optoencoder2_isr( &optoencoder2, 100 );
    encoder_position = optoencoder2_get_position( &optoencoder2 );
    
    if ( stop_flag == 0 )
    {
        log_printf( &logger, "Position: %ld \r\n", encoder_position );
    }
}

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.

---