src/digitalio.py

   1 """
   2 `digitalio` - Digital input and output control (GPIO)
   3 =====================================================
   4
   5 See `CircuitPython:digitalio` in CircuitPython for more details.
   6
   7 * Author(s): cefn
   8 """
   9
  10 from adafruit_blinka.agnostic import board_id, detector
  11
  12 # pylint: disable=ungrouped-imports,wrong-import-position
  13
  14 if detector.chip.BCM2XXX:
  15     from adafruit_blinka.microcontroller.bcm283x.pin import Pin
  16 elif detector.chip.AM33XX:
  17     from adafruit_blinka.microcontroller.am335x.pin import Pin
  18 elif detector.chip.JH71x0:
  19     from adafruit_blinka.microcontroller.starfive.JH71x0.pin import Pin
  20 elif detector.chip.DRA74X:
  21     from adafruit_blinka.microcontroller.dra74x.pin import Pin
  22 elif detector.chip.SUN8I:
  23     from adafruit_blinka.microcontroller.allwinner.h3.pin import Pin
  24 elif detector.chip.SAMA5:
  25     from adafruit_blinka.microcontroller.sama5.pin import Pin
  26 elif detector.chip.T210:
  27     from adafruit_blinka.microcontroller.tegra.t210.pin import Pin
  28 elif detector.chip.T186:
  29     from adafruit_blinka.microcontroller.tegra.t186.pin import Pin
  30 elif detector.chip.T194:
  31     from adafruit_blinka.microcontroller.tegra.t194.pin import Pin
  32 elif detector.chip.S905:
  33     from adafruit_blinka.microcontroller.amlogic.s905.pin import Pin
  34 elif detector.chip.S905X3:
  35     from adafruit_blinka.microcontroller.amlogic.s905x3.pin import Pin
  36 elif detector.chip.S922X:
  37     from adafruit_blinka.microcontroller.amlogic.s922x.pin import Pin
  38 elif detector.chip.EXYNOS5422:
  39     from adafruit_blinka.microcontroller.samsung.exynos5422.pin import Pin
  40 elif detector.chip.APQ8016:
  41     from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
  42 elif detector.chip.IMX8MX:
  43     from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
  44 elif detector.chip.IMX6ULL:
  45     from adafruit_blinka.microcontroller.nxp_imx6ull.pin import Pin
  46 elif detector.chip.HFU540:
  47     from adafruit_blinka.microcontroller.hfu540.pin import Pin
  48 elif detector.chip.A64:
  49     from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
  50 elif detector.chip.A33:
  51     from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
  52 elif detector.chip.MIPS24KEC:
  53     from adafruit_blinka.microcontroller.mips24kec.pin import Pin
  54 elif detector.chip.RK3308:
  55     from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
  56 elif detector.chip.RK3399:
  57     from adafruit_blinka.microcontroller.rockchip.rk3399.pin import Pin
  58 elif detector.chip.RK3328:
  59     from adafruit_blinka.microcontroller.rockchip.rk3328.pin import Pin
  60 elif detector.board.ftdi_ft232h:
  61     from adafruit_blinka.microcontroller.ftdi_mpsse.ft232h.pin import Pin
  62 elif detector.board.ftdi_ft2232h:
  63     from adafruit_blinka.microcontroller.ftdi_mpsse.ft2232h.pin import Pin
  64 elif detector.board.binho_nova:
  65     from adafruit_blinka.microcontroller.nova.pin import Pin
  66 elif detector.board.greatfet_one:
  67     from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
  68 elif detector.chip.STM32F405:
  69     from machine import Pin
  70 elif detector.chip.RP2040:
  71     from machine import Pin
  72 elif detector.board.microchip_mcp2221:
  73     from adafruit_blinka.microcontroller.mcp2221.pin import Pin
  74 elif detector.chip.PENTIUM_N3710:
  75     from adafruit_blinka.microcontroller.pentium.n3710.pin import Pin
  76 elif detector.chip.STM32MP157:
  77     from adafruit_blinka.microcontroller.stm32.stm32mp157.pin import Pin
  78 elif detector.chip.MT8167:
  79     from adafruit_blinka.microcontroller.mt8167.pin import Pin
  80 elif detector.chip.H5:
  81     from adafruit_blinka.microcontroller.allwinner.h5.pin import Pin
  82 elif detector.chip.H6:
  83     from adafruit_blinka.microcontroller.allwinner.h6.pin import Pin
  84 elif detector.chip.H616:
  85     from adafruit_blinka.microcontroller.allwinner.h616.pin import Pin
  86 elif detector.board.pico_u2if:
  87     from adafruit_blinka.microcontroller.rp2040_u2if.pin import Pin
  88 elif (
  89     detector.board.feather_u2if
  90     or detector.board.qtpy_u2if
  91     or detector.board.itsybitsy_u2if
  92     or detector.board.macropad_u2if
  93     or detector.board.qt2040_trinkey_u2if
  94 ):
  95     from adafruit_blinka.microcontroller.rp2040_u2if.pin import Pin
  96
  97 from adafruit_blinka import Enum, ContextManaged
  98
  99
 100 class DriveMode(Enum):
 101     """Drive Mode Enumeration"""
 102
 103     PUSH_PULL = None
 104     OPEN_DRAIN = None
 105
 106
 107 DriveMode.PUSH_PULL = DriveMode()
 108 DriveMode.OPEN_DRAIN = DriveMode()
 109
 110
 111 class Direction(Enum):
 112     """Direction Enumeration"""
 113
 114     INPUT = None
 115     OUTPUT = None
 116
 117
 118 Direction.INPUT = Direction()
 119 Direction.OUTPUT = Direction()
 120
 121
 122 class Pull(Enum):
 123     """PullUp/PullDown Enumeration"""
 124
 125     UP = None
 126     DOWN = None
 127     # NONE=None
 128
 129
 130 Pull.UP = Pull()
 131 Pull.DOWN = Pull()
 132
 133 # Pull.NONE = Pull()
 134
 135
 136 class DigitalInOut(ContextManaged):
 137     """DigitalInOut CircuitPython compatibility implementation"""
 138
 139     _pin = None
 140
 141     def __init__(self, pin):
 142         self._pin = Pin(pin.id)
 143         self.direction = Direction.INPUT
 144
 145     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
 146         """Switch the Digital Pin Mode to Output"""
 147         self.direction = Direction.OUTPUT
 148         self.value = value
 149         self.drive_mode = drive_mode
 150
 151     def switch_to_input(self, pull=None):
 152         """Switch the Digital Pin Mode to Input"""
 153         self.direction = Direction.INPUT
 154         self.pull = pull
 155
 156     def deinit(self):
 157         """Deinitialize the Digital Pin"""
 158         del self._pin
 159
 160     @property
 161     def direction(self):
 162         """Get or Set the Digital Pin Direction"""
 163         return self.__direction
 164
 165     @direction.setter
 166     def direction(self, value):
 167         self.__direction = value
 168         if value is Direction.OUTPUT:
 169             self._pin.init(mode=Pin.OUT)
 170             self.value = False
 171             self.drive_mode = DriveMode.PUSH_PULL
 172         elif value is Direction.INPUT:
 173             self._pin.init(mode=Pin.IN)
 174             self.pull = None
 175         else:
 176             raise AttributeError("Not a Direction")
 177
 178     @property
 179     def value(self):
 180         """The Digital Pin Value"""
 181         return self._pin.value() == 1
 182
 183     @value.setter
 184     def value(self, val):
 185         if self.direction is Direction.OUTPUT:
 186             self._pin.value(1 if val else 0)
 187         else:
 188             raise AttributeError("Not an output")
 189
 190     @property
 191     def pull(self):
 192         """The pin pull direction"""
 193         if self.direction is Direction.INPUT:
 194             return self.__pull
 195         raise AttributeError("Not an input")
 196
 197     @pull.setter
 198     def pull(self, pul):
 199         if self.direction is Direction.INPUT:
 200             self.__pull = pul
 201             if pul is Pull.UP:
 202                 self._pin.init(mode=Pin.IN, pull=Pin.PULL_UP)
 203             elif pul is Pull.DOWN:
 204                 if hasattr(Pin, "PULL_DOWN"):
 205                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
 206                 else:
 207                     raise NotImplementedError(
 208                         "{} unsupported on {}".format(Pull.DOWN, board_id)
 209                     )
 210             elif pul is None:
 211                 self._pin.init(mode=Pin.IN, pull=None)
 212             else:
 213                 raise AttributeError("Not a Pull")
 214         else:
 215             raise AttributeError("Not an input")
 216
 217     @property
 218     def drive_mode(self):
 219         """The Digital Pin Drive Mode"""
 220         if self.direction is Direction.OUTPUT:
 221             return self.__drive_mode  #
 222         raise AttributeError("Not an output")
 223
 224     @drive_mode.setter
 225     def drive_mode(self, mod):
 226         self.__drive_mode = mod
 227         if mod is DriveMode.OPEN_DRAIN:
 228             self._pin.init(mode=Pin.OPEN_DRAIN)
 229         elif mod is DriveMode.PUSH_PULL:
 230             self._pin.init(mode=Pin.OUT)