Add files via upload

Author: PerfecXX

README.rst

@@ -0,0 +1,49 @@
+MicroPython Simple Keypad
+=========================
+
+|MicroPython| |License|
+
+MicroPython library for interfacing with a keypad matrix
+
+Feature
+-------
+
+-  Supports any keypad matrix configuration.
+-  Easily customizable for different keypad layouts.
+-  Provides exception handling for error management.
+
+Example Usage
+-------------
+
+Example for 4x4 keypad metrix on MicroPython esp32.
+
+.. code:: python
+
+   from machine import Pin
+   from keypad import Keypad
+   from time import sleep
+
+   # Define GPIO pins for rows
+   row_pins = [Pin(25),Pin(26),Pin(27),Pin(14)]
+
+   # Define GPIO pins for columns
+   column_pins = [Pin(23),Pin(22),Pin(19),Pin(18)]
+
+   # Define keypad layout
+   keys = [
+       ['1', '2', '3', 'A'],
+       ['4', '5', '6', 'B'],
+       ['7', '8', '9', 'C'],
+       ['*', '0', '#', 'D']]
+
+   keypad = Keypad(row_pins, column_pins, keys)
+
+   while True:
+       key_pressed = keypad.read_keypad()
+       if key_pressed:
+           print("Key pressed:", key_pressed)
+       sleep(0.1)  # debounce and delay
+
+.. |MicroPython| image:: https://img.shields.io/badge/MicroPython-Ready-brightgreen.svg
+.. |License| image:: https://img.shields.io/badge/License-MIT-blue.svg
+   :target: https://opensource.org/licenses/MIT

keypad.py

@@ -0,0 +1,75 @@
+from machine import Pin
+from time import sleep
+
+__version__ = '1.0.3'
+__author__ = 'Teeraphat Kullanankanjana'
+
+class KeypadException(Exception):
+    """
+    Exception class for keypad-related errors.
+    """
+    pass
+
+class Keypad:
+    def __init__(self, row_pins, column_pins, keys):
+        """
+        Initialize the keypad object.
+
+        Args:
+            row_pins (list): List of row pins.
+            column_pins (list): List of column pins.
+            keys (list): 2D list representing the key layout.
+
+        Raises:
+            KeypadException: If pins or keys are not properly defined.
+        """
+        if not all(isinstance(pin, Pin) for pin in row_pins):
+            raise KeypadException("Row pins must be instances of Pin.")
+        
+        if not all(isinstance(pin, Pin) for pin in column_pins):
+            raise KeypadException("Column pins must be instances of Pin.")
+        
+        if not isinstance(keys, list) or not all(isinstance(row, list) for row in keys):
+            raise KeypadException("Keys must be a 2D list.")
+
+        self.row_pins = row_pins
+        self.column_pins = column_pins
+        self.keys = keys
+
+        for pin in self.row_pins:
+            pin.init(Pin.IN, Pin.PULL_UP)
+
+        for pin in self.column_pins:
+            pin.init(Pin.OUT)
+
+        if len(self.row_pins) != len(self.keys) or len(self.column_pins) != len(self.keys[0]):
+            raise KeypadException("Number of row/column pins does not match the key layout size.")
+
+    def read_keypad(self):
+        """
+        Read the keypad and return the pressed key.
+
+        Returns:
+            str or None: Pressed key or None if no key is pressed.
+
+        Raises:
+            KeypadException: If pins or keys are not properly defined.
+        """
+        if not self.column_pins:
+            raise KeypadException("No column pins defined.")
+        
+        if not self.row_pins:
+            raise KeypadException("No row pins defined.")
+        
+        if not self.keys:
+            raise KeypadException("No key layout defined.")
+
+        for col_pin in self.column_pins:
+            col_pin.value(0)  # Set column pin to LOW
+            for i, row_pin in enumerate(self.row_pins):
+                if not row_pin.value():  # If row pin reads LOW
+                    key_pressed = self.keys[i][self.column_pins.index(col_pin)]
+                    col_pin.value(1)  # Set column pin back to HIGH
+                    return key_pressed
+            col_pin.value(1)  # Set column pin back to HIGH
+        return None  # Return None if no key is pressed

setup.py

@@ -0,0 +1,33 @@
+import io
+from os.path import abspath, dirname, join
+import sys
+# Remove current dir from sys.path, otherwise setuptools will peek up our
+# module instead of system.
+sys.path.pop(0)
+from setuptools import setup
+
+HERE = dirname(abspath(__file__))
+LOAD_TEXT = lambda name: io.open(join(HERE, name), encoding='UTF-8').read()
+DESCRIPTION = '\n\n'.join(LOAD_TEXT(_) for _ in [
+    'README.rst'
+])
+
+setup(
+    name='micropython-simple-keypad',
+    py_modules=['keypad'],
+    version='1.0.3',
+    description='MicroPython library for interfacing with a keypad matrix',
+    long_description=DESCRIPTION,
+    keywords= ['keypad', 'esp32', 'esp8266' ,'micropython'],
+    url='https://github.com/PerfecXX/MicroPython-SimpleKeypad',
+    author='Teeraphat Kullanankanjana',
+    author_email='ku.teeraphat@hotmail.com',
+    maintainer='Teeraphat Kullanankanjana',
+    maintainer_email='ku.teeraphat@hotmail.com',
+    license='MIT',
+    classifiers = [
+        'Development Status :: 3 - Alpha', 
+        'Programming Language :: Python :: Implementation :: MicroPython',
+        'License :: OSI Approved :: MIT License',
+    ],
+)