Update digitalio.py

[Adafruit_Blinka-hackapet.git] / src / digitalio.py

diff --git a/src/digitalio.py b/src/digitalio.py
index ab9b761881f59c9e39eb8722d312ac9cb2bee02e..08d154967f2a456accfdb622c7cc9b08015f71d0 100755 (executable)
--- a/src/digitalio.py
+++ b/src/digitalio.py
@@ -1,6 +1,6 @@
 """
 """

-`digitalio` - Digital input and output control
-=================================================
+`digitalio` - Digital input and output control (GPIO)
+=====================================================

 
 See `CircuitPython:digitalio` in CircuitPython for more details.
 
 
 See `CircuitPython:digitalio` in CircuitPython for more details.
 


@@ -15,13 +15,69 @@ if detector.chip.BCM2XXX:
     from adafruit_blinka.microcontroller.bcm283x.pin import Pin
 elif detector.chip.AM33XX:
     from adafruit_blinka.microcontroller.am335x.pin import Pin
     from adafruit_blinka.microcontroller.bcm283x.pin import Pin
 elif detector.chip.AM33XX:
     from adafruit_blinka.microcontroller.am335x.pin import Pin

+elif detector.chip.DRA74X:
+    from adafruit_blinka.microcontroller.dra74x.pin import Pin

 elif detector.chip.SUN8I:
 elif detector.chip.SUN8I:

-    from adafruit_blinka.microcontroller.allwinner_h3.pin import Pin
-elif detector.chip.STM32:
+    from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
+elif detector.chip.SAMA5:
+    from adafruit_blinka.microcontroller.sama5.pin import Pin
+elif detector.chip.T210:
+    from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
+elif detector.chip.T186:
+    from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
+elif detector.chip.T194:
+    from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
+elif detector.chip.S905:
+    from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
+elif detector.chip.S905X3:
+    from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
+elif detector.chip.S922X:
+    from adafruit_blinka.microcontroller.amlogic.s922x.pin import Pin
+elif detector.chip.EXYNOS5422:
+    from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin
+elif detector.chip.APQ8016:
+    from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
+elif detector.chip.IMX8MX:
+    from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
+elif detector.chip.IMX6ULL:
+    from adafruit_blinka.microcontroller.nxp_imx6ull.pin import Pin
+elif detector.chip.HFU540:
+    from adafruit_blinka.microcontroller.hfu540.pin import Pin
+elif detector.chip.A64:
+    from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
+elif detector.chip.A33:
+    from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
+elif detector.chip.MIPS24KEC:
+    from adafruit_blinka.microcontroller.mips24kec.pin import Pin
+elif detector.chip.RK3308:
+    from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
+elif detector.board.ftdi_ft232h:
+    from adafruit_blinka.microcontroller.ft232h.pin import Pin
+elif detector.board.binho_nova:
+    from adafruit_blinka.microcontroller.nova.pin import Pin
+elif detector.board.greatfet_one:
+    from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
+elif detector.chip.STM32F405:

     from machine import Pin
     from machine import Pin

+elif detector.board.microchip_mcp2221:
+    from adafruit_blinka.microcontroller.mcp2221.pin import Pin
+elif detector.chip.PENTIUM_N3710:
+    from adafruit_blinka.microcontroller.pentium.n3710.pin import Pin
+elif detector.chip.STM32MP157:
+    from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import Pin
+elif detector.chip.MT8167:
+    from adafruit_blinka.microcontroller.mt8167.pin import Pin
+elif detector.chip.H5:
+    from adafruit_blinka.microcontroller.allwinner.h5.pin import Pin
+elif detector.chip.H616:
+    from adafruit_blinka.microcontroller.allwinner.h616.pin import Pin
+

 from adafruit_blinka import Enum, ContextManaged
 
 from adafruit_blinka import Enum, ContextManaged
 

+

 class DriveMode(Enum):
 class DriveMode(Enum):

+    """Drive Mode Enumeration"""
+

     PUSH_PULL = None
     OPEN_DRAIN = None
 
     PUSH_PULL = None
     OPEN_DRAIN = None
 


@@ -31,6 +87,8 @@ DriveMode.OPEN_DRAIN = DriveMode()
 
 
 class Direction(Enum):
 
 
 class Direction(Enum):

+    """Direction Enumeration"""
+

     INPUT = None
     OUTPUT = None
 
     INPUT = None
     OUTPUT = None
 


@@ -40,18 +98,22 @@ Direction.OUTPUT = Direction()
 
 
 class Pull(Enum):
 
 
 class Pull(Enum):

+    """PullUp/PullDown Enumeration"""
+

     UP = None
     DOWN = None
     UP = None
     DOWN = None

-    #NONE=None
+    # NONE=None

 
 
 Pull.UP = Pull()
 Pull.DOWN = Pull()
 
 
 
 Pull.UP = Pull()
 Pull.DOWN = Pull()
 

-#Pull.NONE = Pull()
+# Pull.NONE = Pull()

 
 
 class DigitalInOut(ContextManaged):
 
 
 class DigitalInOut(ContextManaged):

+    """DigitalInOut CircuitPython compatibility implementation"""
+

     _pin = None
 
     def __init__(self, pin):
     _pin = None
 
     def __init__(self, pin):


@@ -59,29 +121,33 @@ class DigitalInOut(ContextManaged):
         self.direction = Direction.INPUT
 
     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
         self.direction = Direction.INPUT
 
     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):

+        """Switch the Digital Pin Mode to Output"""

         self.direction = Direction.OUTPUT
         self.value = value
         self.drive_mode = drive_mode
 
     def switch_to_input(self, pull=None):
         self.direction = Direction.OUTPUT
         self.value = value
         self.drive_mode = drive_mode
 
     def switch_to_input(self, pull=None):

+        """Switch the Digital Pin Mode to Input"""

         self.direction = Direction.INPUT
         self.pull = pull
 
     def deinit(self):
         self.direction = Direction.INPUT
         self.pull = pull
 
     def deinit(self):

+        """Deinitialize the Digital Pin"""

         del self._pin
 
     @property
     def direction(self):
         del self._pin
 
     @property
     def direction(self):

+        """Get or Set the Digital Pin Direction"""

         return self.__direction
 
     @direction.setter
         return self.__direction
 
     @direction.setter

-    def direction(self, dir):
-        self.__direction = dir
-        if dir is Direction.OUTPUT:
+    def direction(self, value):
+        self.__direction = value
+        if value is Direction.OUTPUT:

             self._pin.init(mode=Pin.OUT)
             self.value = False
             self.drive_mode = DriveMode.PUSH_PULL
             self._pin.init(mode=Pin.OUT)
             self.value = False
             self.drive_mode = DriveMode.PUSH_PULL

-        elif dir is Direction.INPUT:
+        elif value is Direction.INPUT:

             self._pin.init(mode=Pin.IN)
             self.pull = None
         else:
             self._pin.init(mode=Pin.IN)
             self.pull = None
         else:


@@ -89,7 +155,8 @@ class DigitalInOut(ContextManaged):
 
     @property
     def value(self):
 
     @property
     def value(self):

-        return self._pin.value() is 1
+        """Get or Set the Digital Pin Value"""
+        return self._pin.value() == 1

 
     @value.setter
     def value(self, val):
 
     @value.setter
     def value(self, val):


@@ -100,10 +167,10 @@ class DigitalInOut(ContextManaged):
 
     @property
     def pull(self):
 
     @property
     def pull(self):

+        """Get or Set the Digital Pin Direction"""

         if self.direction is Direction.INPUT:
             return self.__pull
         if self.direction is Direction.INPUT:
             return self.__pull

-        else:
-            raise AttributeError("Not an input")
+        raise AttributeError("Not an input")

 
     @pull.setter
     def pull(self, pul):
 
     @pull.setter
     def pull(self, pul):


@@ -115,8 +182,9 @@ class DigitalInOut(ContextManaged):
                 if hasattr(Pin, "PULL_DOWN"):
                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
                 else:
                 if hasattr(Pin, "PULL_DOWN"):
                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
                 else:

-                    raise NotImplementedError("{} unsupported on {}".format(
-                        Pull.DOWN, board_id))
+                    raise NotImplementedError(
+                        "{} unsupported on {}".format(Pull.DOWN, board_id)
+                    )

             elif pul is None:
                 self._pin.init(mode=Pin.IN, pull=None)
             else:
             elif pul is None:
                 self._pin.init(mode=Pin.IN, pull=None)
             else:


@@ -126,10 +194,10 @@ class DigitalInOut(ContextManaged):
 
     @property
     def drive_mode(self):
 
     @property
     def drive_mode(self):

+        """Get or Set the Digital Pin Drive Mode"""

         if self.direction is Direction.OUTPUT:
             return self.__drive_mode  #
         if self.direction is Direction.OUTPUT:
             return self.__drive_mode  #

-        else:
-            raise AttributeError("Not an output")
+        raise AttributeError("Not an output")

 
     @drive_mode.setter
     def drive_mode(self, mod):
 
     @drive_mode.setter
     def drive_mode(self, mod):