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