Introduction

Documentation Status Discord Build Status Code Style: Black

Alternative CircuitPython API for NeoKey I2C Keypad

Dependencies

This driver depends on:

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 alt_neokey

Or the following command to update an existing version:

circup update

Usage Example

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.

Indices and tables