circuitpython-ruhrohrotaryio 1.0

pretend to be 'rotaryio' for boards that need non-sequential pins

Introduction

Pretend to be rotaryio for boards that need non-sequential pins.

On RP2040-based boards like the Raspberry Pi Pico and QTPy RP2040, if you try to use “rotaryio” on pins whose GPIO numbers are not sequential, you will get a RuntimeError: Pins must be sequential GPIO pins.

This package acts just like rotaryio but uses keypad and some logic to read a rotary encoder. It is not as fast or efficient as rotaryio but it will work on RP2040 boards.

Dependencies

This driver depends on:

• Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install ruhrohrotaryio

Or the following command to update an existing version:

circup update

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-ruhrohrotaryio

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-ruhrohrotaryio

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-ruhrohrotaryio

Usage Example

import os
import time
import board

# works on both QTPY M0 and QTPY RP2040

if os.uname().machine.find("rp2040") > 0:  # RP2040
    from ruhrohrotaryio import IncrementalEncoder
else:
    from rotaryio import IncrementalEncoder

encoder = IncrementalEncoder( board.A3, board.A1 )

while True:
    print(encoder.position)
    time.sleep(0.1)

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.