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