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