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