espp/encoder

0.21.0

uploaded 1 day ago
ABI Encoder component for ESP-IDF

readme

# ABI Encoder Component

The `AbiEncoder` allow the user a configurable container wrapping the `pulse
count
<https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-reference/peripherals/pcnt.html>`_
ESP peripheral api as it would be configured for an incremental encoder with
quadrature output (see `Wikipedia
<https://en.wikipedia.org/wiki/Incremental_encoder>`_). The AbiEncoder can be
configured to be either `LINEAR` or `ROTATIONAL`, and provides access to the
current `count` of the encoder (including the overflow underflow conditions).

## Example

The [example](./example) shows the use of the `espp::AbiEncoder` from the
`encoder` component. It showcases both the `EncoderType::ROTATIONAL` and
`EncoderType::LINEAR` uses of the `AbiEncoder`.

Links

Supports all targets

Maintainer

  • William Emfinger <waemfinger@gmail.com>

License: MIT

To add this component to your project, run:

idf.py add-dependency "espp/encoder^0.21.0"

or download archive

Stats

  • Archive size
    Archive size ~ 8.78 KB
  • Downloaded in total
    Downloaded in total 1 time
  • Downloaded this version
    This version: 1 time

Badge

espp/encoder version: 0.21.0
|