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