optoencoder2  2.0.0.0
Main Page

Opto Encoder 2 Click

Opto Encoder 2 Click is a linear incremental optical sensor/encoder Click which can be used for the movement or rotation encoding.

Click Product page


Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : GPIO type

Software Support

We provide a library for the OptoEncoder2 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for OptoEncoder2 Click driver.

Standard key functions :

Example key functions :

Examples Description

This application is used to encode motion or rotation.

The demo application is composed of two sections :

Application Init

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

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info(&logger, "---- Application Init ----");
// Click initialization.
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.

{
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 );
}
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

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

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.


optoencoder2_init
err_t optoencoder2_init(optoencoder2_t *ctx, optoencoder2_cfg_t *cfg)
Initialization function.
optoencoder2_isr
uint8_t optoencoder2_isr(optoencoder2_t *ctx, uint8_t n_cycles)
Incrementing/decrementing encoder counter.
optoencoder2_cfg_t
Click configuration structure definition.
Definition: optoencoder2.h:103
OPTOENCODER2_MAP_MIKROBUS
#define OPTOENCODER2_MAP_MIKROBUS(cfg, mikrobus)
Definition: optoencoder2.h:65
optoencoder2_pwm_get
uint8_t optoencoder2_pwm_get(optoencoder2_t *ctx)
Getting PWM pin state.
optoencoder2_t
Click ctx object definition.
Definition: optoencoder2.h:89
optoencoder2_get_position
int32_t optoencoder2_get_position(optoencoder2_t *ctx)
Getting encoder position.
optoencoder2_int_get
uint8_t optoencoder2_int_get(optoencoder2_t *ctx)
Getting INT pin state.
optoencoder2_cfg_setup
void optoencoder2_cfg_setup(optoencoder2_cfg_t *cfg)
Config Object Initialization function.
application_task
void application_task()
Definition: main.c:59
application_init
void application_init(void)
Definition: main.c:33
optoencoder2_zero_counter
void optoencoder2_zero_counter(optoencoder2_t *ctx)
Reset encoder counter.