displayio/i2cdisplay.py

   1 # SPDX-FileCopyrightText: 2020 Melissa LeBlanc-Williams for Adafruit Industries
   2 # SPDX-FileCopyrightText: 2020 Erik Tollerud
   3 # SPDX-FileCopyrightText: 2021 Jim Morris
   4 # SPDX-FileCopyrightText: 2021 James Carr
   5 #
   6 # SPDX-License-Identifier: MIT
   7
   8 """
   9 `displayio.i2cdisplay`
  10 ================================================================================
  11
  12 displayio for Blinka
  13
  14 **Software and Dependencies:**
  15
  16 * Adafruit Blinka:
  17   https://github.com/adafruit/Adafruit_Blinka/releases
  18
  19 * Author(s): Melissa LeBlanc-Williams, Erik Tollerud, James Carr
  20
  21 """
  22
  23 __version__ = "0.0.0-auto.0"
  24 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  25
  26
  27 import time
  28 import busio
  29 import digitalio
  30 import microcontroller
  31
  32 try:
  33     from typing import Optional
  34     from typing import ReadableBuffer
  35 except ImportError:
  36     pass
  37
  38
  39 class I2CDisplay:
  40     """Manage updating a display over I2C in the background while Python code runs.
  41     It doesn’t handle display initialization.
  42     """
  43
  44     def __init__(
  45         self,
  46         i2c_bus: busio.I2C,
  47         *,
  48         device_address: int,
  49         reset: Optional[microcontroller.Pin] = None
  50     ):
  51         """Create a I2CDisplay object associated with the given I2C bus and reset pin.
  52
  53         The I2C bus and pins are then in use by the display until displayio.release_displays() is
  54         called even after a reload. (It does this so CircuitPython can use the display after your
  55         code is done.) So, the first time you initialize a display bus in code.py you should call
  56         :py:func`displayio.release_displays` first, otherwise it will error after the first
  57         code.py run.
  58         """
  59
  60         if reset is not None:
  61             self._reset = digitalio.DigitalInOut(reset)
  62             self._reset.switch_to_output(value=True)
  63         else:
  64             self._reset = None
  65         self._i2c = i2c_bus
  66         self._dev_addr = device_address
  67
  68     def _release(self):
  69         self.reset()
  70         self._i2c.deinit()
  71         if self._reset is not None:
  72             self._reset.deinit()
  73
  74     def reset(self) -> None:
  75         """
  76         Performs a hardware reset via the reset pin if one is present.
  77         """
  78
  79         if self._reset is None:
  80             return
  81
  82         self._reset.value = False
  83         time.sleep(0.0001)
  84         self._reset.value = True
  85
  86     def begin_transaction(self) -> None:
  87         """
  88         Lock the bus before sending data.
  89         """
  90         while not self._i2c.try_lock():
  91             pass
  92
  93     def send(self, command: bool, data: ReadableBuffer) -> None:
  94         """
  95         Sends the given command value followed by the full set of data. Display state,
  96         such as vertical scroll, set via ``send`` may or may not be reset once the code is
  97         done.
  98         """
  99
 100         if command:
 101             n = len(data)
 102             if n > 0:
 103                 command_bytes = bytearray(n * 2)
 104                 for i in range(n):
 105                     command_bytes[2 * i] = 0x80
 106                     command_bytes[2 * i + 1] = data[i]
 107
 108                 self._i2c.writeto(self._dev_addr, buffer=command_bytes, stop=True)
 109
 110         else:
 111             data_bytes = bytearray(len(data) + 1)
 112             data_bytes[0] = 0x40
 113             data_bytes[1:] = data
 114             self._i2c.writeto(self._dev_addr, buffer=data_bytes, stop=True)
 115
 116     def end_transaction(self) -> None:
 117         """
 118         Release the bus after sending data.
 119         """
 120         self._i2c.unlock()