Add missing modules to the API documentation

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

diff --git a/src/microcontroller/__init__.py b/src/microcontroller/__init__.py
index 56396a00463b6186260250f552e326c38bed9129..fda16cc109c9c1d7c9409e89b2cbe36c4efa10b0 100755 (executable)
--- a/src/microcontroller/__init__.py
+++ b/src/microcontroller/__init__.py
@@ -1,5 +1,11 @@
-"""Microcontroller pins"""
+"""
+`microcontroller` - Pin references and cpu functionality
+========================================================

 
 

+* Author(s): Melissa LeBlanc-Williams
+"""
+
+import sys

 import time
 
 from adafruit_platformdetect.constants import chips as ap_chip
 import time
 
 from adafruit_platformdetect.constants import chips as ap_chip


@@ -13,11 +19,16 @@ def delay_us(delay):
 
 
 class Pin(Enum):
 
 
 class Pin(Enum):

-    """Reference Pin object"""
+    """
+    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"""
 
     def __init__(self, pin_id):
         """Identifier for pin, referencing platform-specific pin id"""

-        self._id = pin_id
+        self.id = pin_id

 
     def __repr__(self):
         # pylint: disable=import-outside-toplevel, cyclic-import
 
     def __repr__(self):
         # pylint: disable=import-outside-toplevel, cyclic-import


@@ -43,16 +54,22 @@ if chip_id == ap_chip.ESP8266:
     from adafruit_blinka.microcontroller.esp8266 import *
 elif chip_id == ap_chip.STM32F405:
     from adafruit_blinka.microcontroller.stm32.stm32f405 import *
     from adafruit_blinka.microcontroller.esp8266 import *
 elif chip_id == ap_chip.STM32F405:
     from adafruit_blinka.microcontroller.stm32.stm32f405 import *

+elif chip_id == ap_chip.RP2040:
+    from adafruit_blinka.microcontroller.rp2040 import *

 elif chip_id == ap_chip.BCM2XXX:
     from adafruit_blinka.microcontroller.bcm283x import *
 elif chip_id == ap_chip.DRA74X:
     from adafruit_blinka.microcontroller.dra74x.pin import *
 elif chip_id == ap_chip.AM33XX:
     from adafruit_blinka.microcontroller.am335x import *
 elif chip_id == ap_chip.BCM2XXX:
     from adafruit_blinka.microcontroller.bcm283x import *
 elif chip_id == ap_chip.DRA74X:
     from adafruit_blinka.microcontroller.dra74x.pin import *
 elif chip_id == ap_chip.AM33XX:
     from adafruit_blinka.microcontroller.am335x import *

+elif chip_id == ap_chip.JH71x0:
+    from adafruit_blinka.microcontroller.starfive.JH71x0 import *

 elif chip_id == ap_chip.SUN8I:
     from adafruit_blinka.microcontroller.allwinner.h3 import *
 elif chip_id == ap_chip.H5:
     from adafruit_blinka.microcontroller.allwinner.h5.pin import *
 elif chip_id == ap_chip.SUN8I:
     from adafruit_blinka.microcontroller.allwinner.h3 import *
 elif chip_id == ap_chip.H5:
     from adafruit_blinka.microcontroller.allwinner.h5.pin import *

+elif chip_id == ap_chip.H6:
+    from adafruit_blinka.microcontroller.allwinner.h6.pin import *

 elif chip_id == ap_chip.H616:
     from adafruit_blinka.microcontroller.allwinner.h616.pin import *
 elif chip_id == ap_chip.SAMA5:
 elif chip_id == ap_chip.H616:
     from adafruit_blinka.microcontroller.allwinner.h616.pin import *
 elif chip_id == ap_chip.SAMA5:


@@ -81,6 +98,8 @@ elif chip_id == ap_chip.RK3308:
     from adafruit_blinka.microcontroller.rockchip.rk3308.pin import *
 elif chip_id == ap_chip.RK3399:
     from adafruit_blinka.microcontroller.rockchip.rk3399.pin import *
     from adafruit_blinka.microcontroller.rockchip.rk3308.pin import *
 elif chip_id == ap_chip.RK3399:
     from adafruit_blinka.microcontroller.rockchip.rk3399.pin import *

+elif chip_id == ap_chip.RK3328:
+    from adafruit_blinka.microcontroller.rockchip.rk3328.pin import *

 elif chip_id == ap_chip.H5:
     from adafruit_blinka.microcontroller.allwinner.h5.pin import *
 elif chip_id == ap_chip.IMX8MX:
 elif chip_id == ap_chip.H5:
     from adafruit_blinka.microcontroller.allwinner.h5.pin import *
 elif chip_id == ap_chip.IMX8MX:


@@ -94,9 +113,9 @@ elif chip_id == ap_chip.BINHO:
 elif chip_id == ap_chip.LPC4330:
     from adafruit_blinka.microcontroller.nxp_lpc4330 import *
 elif chip_id == ap_chip.MIPS24KC:
 elif chip_id == ap_chip.LPC4330:
     from adafruit_blinka.microcontroller.nxp_lpc4330 import *
 elif chip_id == ap_chip.MIPS24KC:

-    from adafruit_blinka.microcontroller.atheros.ar9331.pin import *
+    from adafruit_blinka.microcontroller.atheros.ar9331 import *

 elif chip_id == ap_chip.MIPS24KEC:
 elif chip_id == ap_chip.MIPS24KEC:

-    from adafruit_blinka.microcontroller.mips24kec.pin import *
+    from adafruit_blinka.microcontroller.mips24kec import *

 elif chip_id == ap_chip.FT232H:
     from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import *
 elif chip_id == ap_chip.FT2232H:
 elif chip_id == ap_chip.FT232H:
     from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import *
 elif chip_id == ap_chip.FT2232H:


@@ -107,5 +126,7 @@ elif chip_id == ap_chip.STM32MP157:
     from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import *
 elif chip_id == ap_chip.MT8167:
     from adafruit_blinka.microcontroller.mt8167.pin import *
     from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import *
 elif chip_id == ap_chip.MT8167:
     from adafruit_blinka.microcontroller.mt8167.pin import *

+elif "sphinx" in sys.modules:
+    pass

 else:
     raise NotImplementedError("Microcontroller not supported:", chip_id)
 else:
     raise NotImplementedError("Microcontroller not supported:", chip_id)