displayio/parallelbus.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.parallelbus`
  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 __version__ = "0.0.0-auto.0"
  39 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  40
  41 # pylint: disable=unnecessary-pass, unused-argument
  42
  43
  44 class ParallelBus:
  45     """Manage updating a display over 8-bit parallel bus in the background while Python code
  46     runs. This protocol may be refered to as 8080-I Series Parallel Interface in datasheets.
  47     It doesn’t handle display initialization.
  48     """
  49
  50     def __init__(self, i2c_bus, *, device_address, reset=None):
  51         """Create a ParallelBus object associated with the given pins. The
  52         bus is inferred from data0 by implying the next 7 additional pins on a given GPIO
  53         port.
  54
  55         The parallel bus and pins are then in use by the display until
  56         displayio.release_displays() is called even after a reload. (It does this so
  57         CircuitPython can use the display after your code is done.) So, the first time you
  58         initialize a display bus in code.py you should call
  59         :py:func`displayio.release_displays` first, otherwise it will error after the first
  60         code.py run.
  61         """
  62         pass
  63
  64     def reset(self):
  65         """Performs a hardware reset via the reset pin. Raises an exception if called when
  66         no reset pin is available.
  67         """
  68         pass
  69
  70     def send(self, command, data):
  71         """Sends the given command value followed by the full set of data. Display state,
  72         such as vertical scroll, set via ``send`` may or may not be reset once the code is
  73         done.
  74         """
  75         pass