displayio/i2cdisplay.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.i2cdisplay`
  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 I2CDisplay:
  45     """Manage updating a display over I2C in the background while Python code runs.
  46     It doesn’t handle display initialization.
  47     """
  48
  49     def __init__(self, i2c_bus, *, device_address, reset=None):
  50         """Create a I2CDisplay object associated with the given I2C bus and reset pin.
  51
  52         The I2C bus and pins are then in use by the display until displayio.release_displays() is
  53         called even after a reload. (It does this so CircuitPython can use the display after your
  54         code is done.) So, the first time you initialize a display bus in code.py you should call
  55         :py:func`displayio.release_displays` first, otherwise it will error after the first
  56         code.py run.
  57         """
  58         pass
  59
  60     def reset(self):
  61         """Performs a hardware reset via the reset pin. Raises an exception if called
  62         when no reset pin is available.
  63         """
  64         pass
  65
  66     def send(self, command, data):
  67         """Sends the given command value followed by the full set of data. Display state,
  68         such as vertical scroll, set via send may or may not be reset once the code is
  69         done.
  70         """
  71         pass