src/digitalio.py

   1 """
   2 `digitalio` - Digital input and output control
   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.STM32:
  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
  63 from adafruit_blinka import Enum, ContextManaged
  64
  65
  66 class DriveMode(Enum):
  67     """Drive Mode Enumeration"""
  68
  69     PUSH_PULL = None
  70     OPEN_DRAIN = None
  71
  72
  73 DriveMode.PUSH_PULL = DriveMode()
  74 DriveMode.OPEN_DRAIN = DriveMode()
  75
  76
  77 class Direction(Enum):
  78     """Direction Enumeration"""
  79
  80     INPUT = None
  81     OUTPUT = None
  82
  83
  84 Direction.INPUT = Direction()
  85 Direction.OUTPUT = Direction()
  86
  87
  88 class Pull(Enum):
  89     """PullUp/PullDown Enumeration"""
  90
  91     UP = None
  92     DOWN = None
  93     # NONE=None
  94
  95
  96 Pull.UP = Pull()
  97 Pull.DOWN = Pull()
  98
  99 # Pull.NONE = Pull()
 100
 101
 102 class DigitalInOut(ContextManaged):
 103     """DigitalInOut CircuitPython compatibility implementation"""
 104
 105     _pin = None
 106
 107     def __init__(self, pin):
 108         self._pin = Pin(pin.id)
 109         self.direction = Direction.INPUT
 110
 111     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
 112         """Switch the Digital Pin Mode to Output"""
 113         self.direction = Direction.OUTPUT
 114         self.value = value
 115         self.drive_mode = drive_mode
 116
 117     def switch_to_input(self, pull=None):
 118         """Switch the Digital Pin Mode to Input"""
 119         self.direction = Direction.INPUT
 120         self.pull = pull
 121
 122     def deinit(self):
 123         """Deinitialize the Digital Pin"""
 124         del self._pin
 125
 126     @property
 127     def direction(self):
 128         """Get or Set the Digital Pin Direction"""
 129         return self.__direction
 130
 131     @direction.setter
 132     def direction(self, value):
 133         self.__direction = value
 134         if value is Direction.OUTPUT:
 135             self._pin.init(mode=Pin.OUT)
 136             self.value = False
 137             self.drive_mode = DriveMode.PUSH_PULL
 138         elif value is Direction.INPUT:
 139             self._pin.init(mode=Pin.IN)
 140             self.pull = None
 141         else:
 142             raise AttributeError("Not a Direction")
 143
 144     @property
 145     def value(self):
 146         """Get or Set the Digital Pin Value"""
 147         return self._pin.value() == 1
 148
 149     @value.setter
 150     def value(self, val):
 151         if self.direction is Direction.OUTPUT:
 152             self._pin.value(1 if val else 0)
 153         else:
 154             raise AttributeError("Not an output")
 155
 156     @property
 157     def pull(self):
 158         """Get or Set the Digital Pin Direction"""
 159         if self.direction is Direction.INPUT:
 160             return self.__pull
 161         raise AttributeError("Not an input")
 162
 163     @pull.setter
 164     def pull(self, pul):
 165         if self.direction is Direction.INPUT:
 166             self.__pull = pul
 167             if pul is Pull.UP:
 168                 self._pin.init(mode=Pin.IN, pull=Pin.PULL_UP)
 169             elif pul is Pull.DOWN:
 170                 if hasattr(Pin, "PULL_DOWN"):
 171                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
 172                 else:
 173                     raise NotImplementedError(
 174                         "{} unsupported on {}".format(Pull.DOWN, board_id)
 175                     )
 176             elif pul is None:
 177                 self._pin.init(mode=Pin.IN, pull=None)
 178             else:
 179                 raise AttributeError("Not a Pull")
 180         else:
 181             raise AttributeError("Not an input")
 182
 183     @property
 184     def drive_mode(self):
 185         """Get or Set the Digital Pin Drive Mode"""
 186         if self.direction is Direction.OUTPUT:
 187             return self.__drive_mode  #
 188         raise AttributeError("Not an output")
 189
 190     @drive_mode.setter
 191     def drive_mode(self, mod):
 192         self.__drive_mode = mod
 193         if mod is DriveMode.OPEN_DRAIN:
 194             self._pin.init(mode=Pin.OPEN_DRAIN)
 195         elif mod is DriveMode.PUSH_PULL:
 196             self._pin.init(mode=Pin.OUT)