https://github.com/gmparis/alt_circuitpython_neokey

Alternative API for NeoKey I2C keypad
https://github.com/gmparis/alt_circuitpython_neokey

circuitpython i2c keyboard

Last synced: 14 days ago
JSON representation

Alternative API for NeoKey I2C keypad

• Host: GitHub
• URL: https://github.com/gmparis/alt_circuitpython_neokey
• Owner: gmparis
• License: mit
• Created: 2021-06-28T23:51:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-07-07T12:02:48.000Z (over 3 years ago)
• Last Synced: 2024-10-22T01:35:23.852Z (2 months ago)
• Topics: circuitpython, i2c, keyboard
• Language: Python
• Homepage:
• Size: 123 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/alt-circuitpython-neokey/badge/?version=latest

    :target: https://alt-circuitpython-neokey.readthedocs.io/

    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/gmparis/Alt_CircuitPython_NeoKey/workflows/Build%20CI/badge.svg

    :target: https://github.com/gmparis/Alt_CircuitPython_NeoKey/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

Alternative CircuitPython API for NeoKey I2C Keypad

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

* `Bus Device `_

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:

.. 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 alt_neokey

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

.. code-block:: py

   import board

   from alt_neokey.alt_neokey1x4 import NeoKey1x4

   i2c = board.I2C()

   neokey = NeoKey1x4(i2c)

   # set colors in main loop by processing event list

   while True:

      for event in neokey.read():

         if event.pressed:

            neokey[event.key_num].color = 0x0000FF

         else:

            neokey[event.key_num].color = 0

         print(event.key_num, event.pressed)

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.

Documentation

=============

For information on building library documentation, please check out

`this guide `_.