src/adafruit_blinka/microcontroller/fake_mcp2221/pin.py

   1 # SPDX-FileCopyrightText: 2021 Melissa LeBlanc-Williams for Adafruit Industries
   2 #
   3 # SPDX-License-Identifier: MIT
   4 """fake_mcp2221 pin names"""
   5 import random
   6 from .fake_mcp2221 import mcp2221
   7
   8
   9 class Pin:
  10     """A basic Pin class for use with a "fake" MCP2221."""
  11
  12     # pin modes
  13     OUT = 0
  14     IN = 1
  15     ADC = 2
  16     DAC = 3
  17     # pin values
  18     LOW = 0
  19     HIGH = 1
  20
  21     def __init__(self, pin_id=None):
  22         self.id = pin_id
  23         self._mode = None
  24         self._prv_val = False
  25
  26     def init(self, mode=IN, pull=None):
  27         """Initialize the Pin"""
  28         if self.id is None:
  29             raise RuntimeError("Can not init a None type pin.")
  30         if pull is not None:
  31             raise NotImplementedError(
  32                 "Internal pullups and pulldowns not supported on the MCP2221"
  33             )
  34         if mode in (Pin.IN, Pin.OUT):
  35             # All pins can do GPIO
  36             pass
  37         elif mode == Pin.ADC:
  38             # ADC only available on these pins
  39             if self.id not in (1, 2, 3):
  40                 raise ValueError("Pin does not have ADC capabilities")
  41             pass
  42             # Do nothing
  43         elif mode == Pin.DAC:
  44             # DAC only available on these pins
  45             if self.id not in (2, 3):
  46                 raise ValueError("Pin does not have DAC capabilities")
  47             pass
  48         else:
  49             raise ValueError("Incorrect pin mode: {}".format(mode))
  50         self._mode = mode
  51
  52     def value(self, val=None):
  53         """Set or return the Pin Value"""
  54         # Digital In / Out
  55         if self._mode in (Pin.IN, Pin.OUT):
  56             # digital read
  57             if val is None:
  58                 # The returned value toggles between True and false
  59                 self._prv_val = not self._prv_val
  60                 return self._prv_val
  61             # digital write
  62             if val in (Pin.LOW, Pin.HIGH):
  63                 # We don't need to do anything here - no data is produced
  64                 return None
  65             # nope
  66             raise ValueError("Invalid value for pin.")
  67         # Analog In
  68         if self._mode == Pin.ADC:
  69             if val is None:
  70                 # Returned value is between 0 and 65535 inclusive
  71                 # https://docs.circuitpython.org/en/latest/shared-bindings/analogio/index.html#analogio.AnalogIn.value
  72                 self._prv_val = random.randint(0, 65535)
  73                 return self._prv_val
  74             # read only
  75             raise AttributeError("'AnalogIn' object has no attribute 'value'")
  76         # Analog Out
  77         if self._mode == Pin.DAC:
  78             if val is None:
  79                 # write only
  80                 raise AttributeError("unreadable attribute")
  81             # We don't write to the DAC as this is a "fake" implementation
  82             return None
  83         raise RuntimeError(
  84             "No action for mode {} with value {}".format(self._mode, val)
  85         )
  86
  87
  88 # create pin instances for each pin
  89 G0 = Pin(0)
  90 G1 = Pin(1)
  91 G2 = Pin(2)
  92 G3 = Pin(3)
  93
  94 SCL = Pin()
  95 SDA = Pin()