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