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