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 (141361 times)
  2. FAT32 Library (74205 times)
  3. Network Ethernet Library (58776 times)
  4. USB Device Library (48854 times)
  5. Network WiFi Library (44564 times)
  6. FT800 Library (44149 times)
  7. GSM click (30883 times)
  8. mikroSDK (29739 times)
  9. PID Library (27372 times)
  10. microSD click (27309 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

Opto Encoder 4 Click

Rating:

0

Author: MIKROE

Last Updated: 2024-10-31

Package Version: 2.1.0.5

mikroSDK Library: 2.0.0.0

Category: Optical

Downloaded: 127 times

Not followed.

License: MIT license  

Opto Encoder 4 Click is a compact add-on board that contains an optical sensor/encoder that can be used for movement or rotation encoding. This board features the EE-SX4330, a transmissive photo-microsensor from OMRON. It is intended to be used with an encoder disk or similar device that will act as a barrier between the emitter and detector of the sensor. Usually, it will be the disk with perforations, which is commonly used to detect the rotation speed.

No Abuse Reported

Do you want to subscribe in order to receive notifications regarding "Opto Encoder 4 Click" changes.

Do you want to unsubscribe in order to stop receiving notifications regarding "Opto Encoder 4 Click" changes.

Do you want to report abuse regarding "Opto Encoder 4 Click".

  • Information
  • Comments (0)

mikroSDK Library Blog


Opto Encoder 4 Click

Opto Encoder 4 Click is a compact add-on board that contains an optical sensor/encoder that can be used for movement or rotation encoding. This board features the EE-SX4330, a transmissive photo-microsensor from OMRON. It is intended to be used with an encoder disk or similar device that will act as a barrier between the emitter and detector of the sensor. Usually, it will be the disk with perforations, which is commonly used to detect the rotation speed.

optoencoder4_click.png

Click Product page


Click library

  • Author : Stefan Filipovic
  • Date : Nov 2023.
  • Type : GPIO type

Software Support

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

Standard key functions :

  • optoencoder4_cfg_setup Config Object Initialization function.

    void optoencoder4_cfg_setup ( optoencoder4_cfg_t *cfg );
  • optoencoder4_init Initialization function.

    err_t optoencoder4_init ( optoencoder4_t *ctx, optoencoder4_cfg_t *cfg );

Example key functions :

  • optoencoder4_get_out_pin This function returns the output pin logic state.

    uint8_t optoencoder4_get_out_pin ( optoencoder4_t *ctx );
  • optoencoder4_get_our_pin This function returns the output pin reversed logic state.

    uint8_t optoencoder4_get_our_pin ( optoencoder4_t *ctx );

Example Description

This example demonstrates the use of Opto Encoder 4 Click board by processing the encoder output pin state and incrementing the step counter on falling edge.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger.


void application_init ( void )
{
    log_cfg_t log_cfg;  /**< Logger config object. */
    optoencoder4_cfg_t optoencoder4_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.
    optoencoder4_cfg_setup( &optoencoder4_cfg );
    OPTOENCODER4_MAP_MIKROBUS( optoencoder4_cfg, MIKROBUS_1 );
    if ( DIGITAL_OUT_UNSUPPORTED_PIN == optoencoder4_init( &optoencoder4, &optoencoder4_cfg ) ) 
    {
        log_error( &logger, " Communication init." );
        for ( ; ; );
    }

    log_info( &logger, " Application Task " );
}

Application Task

Increments the step counter on falling edge of the encoder output pin state and displays it on the USB UART.

void application_task ( void )
{
    static uint32_t step_cnt = 0;

    log_printf( &logger, " Step counter : %lu\r\n", step_cnt );

    // Increment counter on falling edge of output pin
    while ( !optoencoder4_get_out_pin ( &optoencoder4 ) );
    while ( optoencoder4_get_out_pin ( &optoencoder4 ) );

    step_cnt++;
}

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.OptoEncoder4

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. UART terminal is available in all MikroElektronika compilers.


ALSO FROM THIS AUTHOR

LED Driver 15 Click

0

LED Driver 15 Click is a compact add-on board that simplifies the control of multiple LEDs. This board features the MP3309C, a fully integrated synchronous boost white LED driver with an I2C interface from Monolithic Power Systems. The MP3309C offers high efficiency, delivers up to 40mA of LED current, and operates from a voltage of mikroBUS™ power rails, supporting up to 8 white LEDs in series. It also features a programmable switching frequency to optimize efficiency, supports analog and PWM dimming, and has multiple built-in protection functions that protect the circuit during abnormalities.

[Learn More]

WiFi NORA Click

0

WiFi NORA Click is a compact add-on board that provides WiFi and BLE connectivity for professional-grade applications. This board features the NORA-W366-00B6-00B, a dual-band WiFi module with Bluetooth Low Energy (BLE) from u-blox, offering support for WiFi 4 (802.11a/b/g/n) in both 2.4 and 5GHz bands and Bluetooth v5.3 with peripheral and central roles. It features a UART interface for easy integration with the host MCU, high-level AT command configuration, and robust security protocols, including WPA2/WPA3 and TLS encryption. The board also includes a user-configurable RGB LED indicator and buttons for bootloader and application mode selection.

[Learn More]

Thermo K click

0

THERMO K click carries the MCP9600 IC from Microchip and and depending on the type of probe it uses the click can measure temperatures from −200 °C to +1372 °C. The click is designed to run either on 3.3V or 5V power supply. It communicates with the target MCU through I2C interface.

[Learn More]