Code Monkey home page Code Monkey logo

esp32encoder's Introduction

ESP32Encoder

Build Status

ESP32Encoder library that uses the ESP32 pulse counter hardware peripheral:

https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/peripherals/pcnt.html

There is only one interrupt for the peripheral, and that is managed by the library. The user has no interrupt interface, and no interrupts are generated on each pulse. Interrupts arrive when the 16 bit counter buffer overflows, so this library has a tiny interrupt footprint while providing support for up to 8 simultaneous quadrature encoders.

This hardware peripheral supports only 8 encoders.

Support

ESP32 and ESP32c2 are supported.

ESP32c3 does not have pulse counter hardware.

Documentation by Doxygen

ESP32Encoder Doxygen

Quadrature Explanation

For information on the type of encoder this library is for, see: https://en.wikipedia.org/wiki/Incremental_encoder

The modes of reading encoders in this library are full and half quadrature, and single edge count mode.

Image

Full performs a count increment on all 4 edges, half on the rising and falling of a single channel, and single counts just the rising edge of the A channel.

Pull Downs/Ups

To specify the weak pull resistor set the value useInternalWeakPullResistors with the enum types UP, DOWN, or NONE

ISR service CPU core

To specify the CPU core for the PCNT ISR service set the value isrServiceCpuCore to the desired core number. This can be usefull to prevent concurrency problems where the total count might not be updated correctly yet while it is read.

A note on KY-040 and similar

The "switch style" encoder wheels used by breakout modules such as:

https://usa.banggood.com/KY-040-360-Degrees-Rotary-Encoder-Module-with-1516_5mm-Potentiometer-Rotary-Knob-Cap-for-Brick-Sensor-Switch-p-1677837.html

need electrical debouncing in the range of 0.1 - 2 uf per encoder line to ground. This device bounces much more than the PCNT hardware modules debouncing time limits. Be sure to setFilter() to 1023 as well after attaching in order to get the maximum hardware debouncing.

esp32encoder's People

Contributors

ba58smith avatar bobbrez avatar guidoschreuder avatar jackjansen avatar jodaco67 avatar larroy avatar madhephaestus avatar manoukianv avatar positron96 avatar sp-link avatar systemofapwne avatar thijstriemstra avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.