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