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