Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-ruhrohrotaryio/badge/?version=latest
:target: https://circuitpython-ruhrohrotaryio.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/todbot/CircuitPython_RuhRohRotaryIO/workflows/Build%20CI/badge.svg
:target: https://github.com/todbot/CircuitPython_RuhRohRotaryIO/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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 <https://docs.circuitpython.org/en/latest/shared-bindings/rotaryio/index.html>`_"
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 <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/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:
.. code-block:: shell
pip3 install circup
With ``circup`` installed and your CircuitPython device connected use the
following command to install:
.. code-block:: shell
circup install ruhrohrotaryio
Or the following command to update an existing version:
.. code-block:: shell
circup update
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/circuitpython-ruhrohrotaryio/>`_.
To install for current user:
.. code-block:: shell
pip3 install circuitpython-ruhrohrotaryio
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install circuitpython-ruhrohrotaryio
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install circuitpython-ruhrohrotaryio
Usage Example
=============
.. code-block:: python
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 <https://circuitpython-ruhrohrotaryio.readthedocs.io/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/todbot/CircuitPython_RuhRohRotaryIO/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "circuitpython-ruhrohrotaryio",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ruhrohrotaryio,rotaryio,rotaryencoder,rotary,encoder,incrementalecoder",
"author": "",
"author_email": "Tod Kurt <tod@todbot.com>",
"download_url": "https://files.pythonhosted.org/packages/1b/4c/97561a7749777149f787f637309d09601244575f450a77bff9462b23325c/circuitpython-ruhrohrotaryio-1.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-ruhrohrotaryio/badge/?version=latest\n :target: https://circuitpython-ruhrohrotaryio.readthedocs.io/\n :alt: Documentation Status\n\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/todbot/CircuitPython_RuhRohRotaryIO/workflows/Build%20CI/badge.svg\n :target: https://github.com/todbot/CircuitPython_RuhRohRotaryIO/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nPretend to be ``rotaryio`` for boards that need non-sequential pins.\n\nOn RP2040-based boards like the Raspberry Pi Pico and QTPy RP2040,\nif you try to use \"`rotaryio <https://docs.circuitpython.org/en/latest/shared-bindings/rotaryio/index.html>`_\"\non pins whose GPIO numbers are not sequential, you will get a\n``RuntimeError: Pins must be sequential GPIO pins``.\n\n\nThis package acts just like ``rotaryio`` but uses ``keypad`` and some logic to read a rotary encoder.\nIt is not as fast or efficient as ``rotaryio`` but it will work on RP2040 boards.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install ruhrohrotaryio\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/circuitpython-ruhrohrotaryio/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install circuitpython-ruhrohrotaryio\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install circuitpython-ruhrohrotaryio\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .env/bin/activate\n pip3 install circuitpython-ruhrohrotaryio\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import os\n import time\n import board\n\n # works on both QTPY M0 and QTPY RP2040\n\n if os.uname().machine.find(\"rp2040\") > 0: # RP2040\n from ruhrohrotaryio import IncrementalEncoder\n else:\n from rotaryio import IncrementalEncoder\n\n encoder = IncrementalEncoder( board.A3, board.A1 )\n\n while True:\n print(encoder.position)\n time.sleep(0.1)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-ruhrohrotaryio.readthedocs.io/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/todbot/CircuitPython_RuhRohRotaryIO/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "pretend to be 'rotaryio' for boards that need non-sequential pins",
"version": "1.0",
"project_urls": {
"Homepage": "https://github.com/todbot/CircuitPython_RuhRohRotaryIO"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ruhrohrotaryio",
"rotaryio",
"rotaryencoder",
"rotary",
"encoder",
"incrementalecoder"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c04adf45120d97179a5f4c95250be708e4f273a66040d3b399864d91ac9c5b7f",
"md5": "5090638f93c76f9241f1d41ce8c4be15",
"sha256": "6ca45e8a17d766333f03156629ab35d6a3d61f69fa7c1c9d942e94811e798d5b"
},
"downloads": -1,
"filename": "circuitpython_ruhrohrotaryio-1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5090638f93c76f9241f1d41ce8c4be15",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5338,
"upload_time": "2023-10-15T20:04:18",
"upload_time_iso_8601": "2023-10-15T20:04:18.514011Z",
"url": "https://files.pythonhosted.org/packages/c0/4a/df45120d97179a5f4c95250be708e4f273a66040d3b399864d91ac9c5b7f/circuitpython_ruhrohrotaryio-1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1b4c97561a7749777149f787f637309d09601244575f450a77bff9462b23325c",
"md5": "aea2edddf9510e25f4c466410b50bef0",
"sha256": "55f1a4c6a427cbc446cb601c8e017284f088b5c7296717744bc38abcd32ce63f"
},
"downloads": -1,
"filename": "circuitpython-ruhrohrotaryio-1.0.tar.gz",
"has_sig": false,
"md5_digest": "aea2edddf9510e25f4c466410b50bef0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26834,
"upload_time": "2023-10-15T20:04:19",
"upload_time_iso_8601": "2023-10-15T20:04:19.831011Z",
"url": "https://files.pythonhosted.org/packages/1b/4c/97561a7749777149f787f637309d09601244575f450a77bff9462b23325c/circuitpython-ruhrohrotaryio-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-15 20:04:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "todbot",
"github_project": "CircuitPython_RuhRohRotaryIO",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "circuitpython-ruhrohrotaryio"
}
JSON
