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