Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-matrixkeypad/badge/?version=latest
:target: https://docs.circuitpython.org/projects/matrixkeypad/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad/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
This simple helper library lets you create objects that will scan and detect keypresses on passive matrix keypads
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-matrixkeypad/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-matrixkeypad
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-matrixkeypad
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-matrixkeypad
Usage Example
=============
.. code-block:: python
import adafruit_matrixkeypad
from digitalio import DigitalInOut
import board
# Classic 3x4 matrix keypad
cols = [DigitalInOut(x) for x in (board.D2, board.D0, board.D4)]
rows = [DigitalInOut(x) for x in (board.D1, board.D6, board.D5, board.D3)]
keys = ((1, 2, 3),
(4, 5, 6),
(7, 8, 9),
('*', 0, '#'))
keypad = adafruit_matrixkeypad.Matrix_Keypad(rows, cols, keys)
while True:
keys = keypad.pressed_keys
if keys:
print("Pressed: ", keys)
time.sleep(0.1)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/matrixkeypad/en/latest/>`_.
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/adafruit/adafruit_CircuitPython_MatrixKeypad/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-matrixkeypad",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, matrix, keypad, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/4a/f9/04cb67fb0c6363456968996256b6d6026eb956d34f2a5687504f8aac0aef/adafruit_circuitpython_matrixkeypad-1.2.17.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-matrixkeypad/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/matrixkeypad/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad/actions/\n :alt: Build Status\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\nThis simple helper library lets you create objects that will scan and detect keypresses on passive matrix keypads\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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/adafruit-circuitpython-matrixkeypad/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-matrixkeypad\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-matrixkeypad\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 .venv/bin/activate\n pip3 install adafruit-circuitpython-matrixkeypad\n\nUsage Example\n=============\n\n.. code-block:: python\n\n\timport adafruit_matrixkeypad\n\tfrom digitalio import DigitalInOut\n\timport board\n\n\t# Classic 3x4 matrix keypad\n\tcols = [DigitalInOut(x) for x in (board.D2, board.D0, board.D4)]\n\trows = [DigitalInOut(x) for x in (board.D1, board.D6, board.D5, board.D3)]\n\tkeys = ((1, 2, 3),\n\t\t(4, 5, 6),\n\t\t(7, 8, 9),\n\t\t('*', 0, '#'))\n\n\tkeypad = adafruit_matrixkeypad.Matrix_Keypad(rows, cols, keys)\n\n\twhile True:\n\t keys = keypad.pressed_keys\n\t if keys:\n\t\tprint(\"Pressed: \", keys)\n\t time.sleep(0.1)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/matrixkeypad/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/adafruit_CircuitPython_MatrixKeypad/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for passive matrix keypads.",
"version": "1.2.17",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MatrixKeypad"
},
"split_keywords": [
"adafruit",
" matrix",
" keypad",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "295c64013ee84d32b2086c5be3a28f6d5c58dc38ca251a251e711625ade14150",
"md5": "664d9f2affa1584b9597413ad2885d4c",
"sha256": "55152944bddc1603e3d463935ec8ca19f76c2bf22843f877e3f7954a2addcb86"
},
"downloads": -1,
"filename": "adafruit_circuitpython_matrixkeypad-1.2.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "664d9f2affa1584b9597413ad2885d4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4909,
"upload_time": "2024-10-07T22:06:46",
"upload_time_iso_8601": "2024-10-07T22:06:46.460687Z",
"url": "https://files.pythonhosted.org/packages/29/5c/64013ee84d32b2086c5be3a28f6d5c58dc38ca251a251e711625ade14150/adafruit_circuitpython_matrixkeypad-1.2.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4af904cb67fb0c6363456968996256b6d6026eb956d34f2a5687504f8aac0aef",
"md5": "24c89f27506e4528978adbb70f21ec85",
"sha256": "5da11d8bca1ae8ef6692ba9720cb1e0bf22f033cda4c2a1ac3f4fd2cd31027b3"
},
"downloads": -1,
"filename": "adafruit_circuitpython_matrixkeypad-1.2.17.tar.gz",
"has_sig": false,
"md5_digest": "24c89f27506e4528978adbb70f21ec85",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26135,
"upload_time": "2024-10-07T22:06:47",
"upload_time_iso_8601": "2024-10-07T22:06:47.321896Z",
"url": "https://files.pythonhosted.org/packages/4a/f9/04cb67fb0c6363456968996256b6d6026eb956d34f2a5687504f8aac0aef/adafruit_circuitpython_matrixkeypad-1.2.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:06:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MatrixKeypad",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-matrixkeypad"
}
JSON
