Update pin.py

[Adafruit_Blinka-hackapet.git] / src / adafruit_blinka / microcontroller / generic_micropython / __init__.py

diff --git a/src/adafruit_blinka/microcontroller/generic_micropython/__init__.py b/src/adafruit_blinka/microcontroller/generic_micropython/__init__.py
index 8b137891791fe96927ad78e64b0aad7bded08bdc..cb3683c4e69fc246c70335d69424d9b945859d90 100644 (file)
--- a/src/adafruit_blinka/microcontroller/generic_micropython/__init__.py
+++ b/src/adafruit_blinka/microcontroller/generic_micropython/__init__.py
@@ -1 +1,33 @@
+# SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+"""Genereic Pin class for use with MicroPython boards"""
+from adafruit_blinka import Enum
 
+
+class Pin(Enum):
+    """
+    Identifies an IO pin on the microcontroller.
+
+    They are fixed by the hardware so they cannot be constructed on demand. Instead, use board or
+    microcontroller.pin to reference the desired pin.
+    """
+
+    def __init__(self, pin_id):
+        """Identifier for pin, referencing platform-specific pin id"""
+        self.id = pin_id
+
+    def __repr__(self):
+        # pylint: disable=import-outside-toplevel, cyclic-import
+        import board
+        import microcontroller.pin
+
+        for key in dir(board):
+            if getattr(board, key) is self:
+                return "board.{}".format(key)
+        # pylint: enable=import-outside-toplevel, cyclic-import
+
+        for key in dir(microcontroller.pin):
+            if getattr(microcontroller.pin, key) is self:
+                return "microcontroller.pin.{}".format(key)
+        return repr(self)