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