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.APQ8016:
  35     from adafruit_blinka.microcontroller.snapdragon.apq8016.pin import Pin
  36 elif detector.chip.IMX8MX:
  37     from adafruit_blinka.microcontroller.nxp_imx8m.pin import Pin
  38 elif detector.chip.HFU540:
  39     from adafruit_blinka.microcontroller.hfu540.pin import Pin
  40 elif detector.chip.A64:
  41     from adafruit_blinka.microcontroller.allwinner.a64.pin import Pin
  42 elif detector.chip.A33:
  43     from adafruit_blinka.microcontroller.allwinner.a33.pin import Pin
  44 elif detector.chip.MIPS24KEC:
  45     from adafruit_blinka.microcontroller.mips24kec.pin import Pin
  46 elif detector.chip.RK3308:
  47     from adafruit_blinka.microcontroller.rockchip.rk3308.pin import Pin
  48 elif detector.board.ftdi_ft232h:
  49     from adafruit_blinka.microcontroller.ft232h.pin import Pin
  50 elif detector.board.binho_nova:
  51     from adafruit_blinka.microcontroller.nova.pin import Pin
  52 elif detector.board.greatfet_one:
  53     from adafruit_blinka.microcontroller.nxp_lpc4330.pin import Pin
  54 elif detector.chip.STM32:
  55     from machine import Pin
  56 elif detector.board.microchip_mcp2221:
  57     from adafruit_blinka.microcontroller.mcp2221.pin import Pin
  58 from adafruit_blinka import Enum, ContextManaged
  59
  60
  61 class DriveMode(Enum):
  62     PUSH_PULL = None
  63     OPEN_DRAIN = None
  64
  65
  66 DriveMode.PUSH_PULL = DriveMode()
  67 DriveMode.OPEN_DRAIN = DriveMode()
  68
  69
  70 class Direction(Enum):
  71     INPUT = None
  72     OUTPUT = None
  73
  74
  75 Direction.INPUT = Direction()
  76 Direction.OUTPUT = Direction()
  77
  78
  79 class Pull(Enum):
  80     UP = None
  81     DOWN = None
  82     # NONE=None
  83
  84
  85 Pull.UP = Pull()
  86 Pull.DOWN = Pull()
  87
  88 # Pull.NONE = Pull()
  89
  90
  91 class DigitalInOut(ContextManaged):
  92     _pin = None
  93
  94     def __init__(self, pin):
  95         self._pin = Pin(pin.id)
  96         self.direction = Direction.INPUT
  97
  98     def switch_to_output(self, value=False, drive_mode=DriveMode.PUSH_PULL):
  99         self.direction = Direction.OUTPUT
 100         self.value = value
 101         self.drive_mode = drive_mode
 102
 103     def switch_to_input(self, pull=None):
 104         self.direction = Direction.INPUT
 105         self.pull = pull
 106
 107     def deinit(self):
 108         del self._pin
 109
 110     @property
 111     def direction(self):
 112         return self.__direction
 113
 114     @direction.setter
 115     def direction(self, dir):
 116         self.__direction = dir
 117         if dir is Direction.OUTPUT:
 118             self._pin.init(mode=Pin.OUT)
 119             self.value = False
 120             self.drive_mode = DriveMode.PUSH_PULL
 121         elif dir is Direction.INPUT:
 122             self._pin.init(mode=Pin.IN)
 123             self.pull = None
 124         else:
 125             raise AttributeError("Not a Direction")
 126
 127     @property
 128     def value(self):
 129         return self._pin.value() == 1
 130
 131     @value.setter
 132     def value(self, val):
 133         if self.direction is Direction.OUTPUT:
 134             self._pin.value(1 if val else 0)
 135         else:
 136             raise AttributeError("Not an output")
 137
 138     @property
 139     def pull(self):
 140         if self.direction is Direction.INPUT:
 141             return self.__pull
 142         else:
 143             raise AttributeError("Not an input")
 144
 145     @pull.setter
 146     def pull(self, pul):
 147         if self.direction is Direction.INPUT:
 148             self.__pull = pul
 149             if pul is Pull.UP:
 150                 self._pin.init(mode=Pin.IN, pull=Pin.PULL_UP)
 151             elif pul is Pull.DOWN:
 152                 if hasattr(Pin, "PULL_DOWN"):
 153                     self._pin.init(mode=Pin.IN, pull=Pin.PULL_DOWN)
 154                 else:
 155                     raise NotImplementedError(
 156                         "{} unsupported on {}".format(Pull.DOWN, board_id)
 157                     )
 158             elif pul is None:
 159                 self._pin.init(mode=Pin.IN, pull=None)
 160             else:
 161                 raise AttributeError("Not a Pull")
 162         else:
 163             raise AttributeError("Not an input")
 164
 165     @property
 166     def drive_mode(self):
 167         if self.direction is Direction.OUTPUT:
 168             return self.__drive_mode  #
 169         else:
 170             raise AttributeError("Not an output")
 171
 172     @drive_mode.setter
 173     def drive_mode(self, mod):
 174         self.__drive_mode = mod
 175         if mod is DriveMode.OPEN_DRAIN:
 176             self._pin.init(mode=Pin.OPEN_DRAIN)
 177         elif mod is DriveMode.PUSH_PULL:
 178             self._pin.init(mode=Pin.OUT)