displayio/fourwire.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2020 Melissa LeBlanc-Williams for Adafruit Industries
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22
  23 """
  24 `displayio.fourwire`
  25 ================================================================================
  26
  27 displayio for Blinka
  28
  29 **Software and Dependencies:**
  30
  31 * Adafruit Blinka:
  32   https://github.com/adafruit/Adafruit_Blinka/releases
  33
  34 * Author(s): Melissa LeBlanc-Williams
  35
  36 """
  37
  38 import time
  39 import digitalio
  40
  41 __version__ = "0.0.0-auto.0"
  42 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  43
  44
  45 class FourWire:
  46     """Manage updating a display over SPI four wire protocol in the background while
  47     Python code runs. It doesn’t handle display initialization.
  48     """
  49
  50     def __init__(
  51         self,
  52         spi_bus,
  53         *,
  54         command,
  55         chip_select,
  56         reset=None,
  57         baudrate=24000000,
  58         polarity=0,
  59         phase=0
  60     ):
  61         """Create a FourWire object associated with the given pins.
  62
  63         The SPI bus and pins are then in use by the display until
  64         displayio.release_displays() is called even after a reload. (It does this so
  65         CircuitPython can use the display after your code is done.)
  66         So, the first time you initialize a display bus in code.py you should call
  67         :py:func`displayio.release_displays` first, otherwise it will error after the
  68         first code.py run.
  69         """
  70         self._dc = digitalio.DigitalInOut(command)
  71         self._dc.switch_to_output(value=False)
  72         self._chip_select = digitalio.DigitalInOut(chip_select)
  73         self._chip_select.switch_to_output(value=True)
  74         self._frequency = baudrate
  75         self._polarity = polarity
  76         self._phase = phase
  77
  78         if reset is not None:
  79             self._reset = digitalio.DigitalInOut(reset)
  80             self._reset.switch_to_output(value=True)
  81         else:
  82             self._reset = None
  83         self._spi = spi_bus
  84
  85     def _release(self):
  86         self.reset()
  87         self._spi.deinit()
  88         self._dc.deinit()
  89         self._chip_select.deinit()
  90         if self._reset is not None:
  91             self._reset.deinit()
  92
  93     def reset(self):
  94         """Performs a hardware reset via the reset pin.
  95         Raises an exception if called when no reset pin is available.
  96         """
  97         if self._reset is not None:
  98             self._reset.value = False
  99             time.sleep(0.001)
 100             self._reset.value = True
 101             time.sleep(0.001)
 102         else:
 103             raise RuntimeError("No reset pin defined")
 104
 105     def send(self, is_command, data, *, toggle_every_byte=False):
 106         """Sends the given command value followed by the full set of data. Display state,
 107         such as vertical scroll, set via ``send`` may or may not be reset once the code is
 108         done.
 109         """
 110         self._dc.value = not is_command
 111         if toggle_every_byte:
 112             for byte in data:
 113                 self._spi.write(bytes([byte]))
 114                 self._chip_select.value = True
 115                 time.sleep(0.000001)
 116                 self._chip_select.value = False
 117         else:
 118             self._spi.write(data)
 119
 120     def begin_transaction(self):
 121         """Begin the SPI transaction by locking, configuring, and setting Chip Select
 122         """
 123         while not self._spi.try_lock():
 124             pass
 125         self._spi.configure(
 126             baudrate=self._frequency, polarity=self._polarity, phase=self._phase
 127         )
 128         self._chip_select.value = False
 129
 130     def end_transaction(self):
 131         """End the SPI transaction by unlocking and setting Chip Select
 132         """
 133         self._chip_select.value = True
 134         self._spi.unlock()