i2cdisplaybus/__init__.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 `i2cdisplaybus`
  10 ================================================================================
  11
  12 i2cdisplaybus 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 import time
  24 import busio
  25 import digitalio
  26 from circuitpython_typing import ReadableBuffer
  27 from displayio._constants import CHIP_SELECT_UNTOUCHED, DISPLAY_COMMAND
  28
  29 __version__ = "0.0.0+auto.0"
  30 __repo__ = "https://github.com/adafruit/Adafruit_Blinka_displayio.git"
  31
  32
  33 class I2CDisplayBus:
  34     """Manage updating a display over I2C in the background while Python code runs.
  35     It doesn’t handle display initialization.
  36     """
  37
  38     def __init__(self, i2c_bus: busio.I2C, *, device_address: int, reset=None):
  39         """Create a I2CDisplayBus object associated with the given I2C bus and reset pin.
  40
  41         The I2C bus and pins are then in use by the display until displayio.release_displays() is
  42         called even after a reload. (It does this so CircuitPython can use the display after your
  43         code is done.) So, the first time you initialize a display bus in code.py you should call
  44         :py:func`displayio.release_displays` first, otherwise it will error after the first
  45         code.py run.
  46         """
  47
  48         if reset is not None:
  49             self._reset = digitalio.DigitalInOut(reset)
  50             self._reset.switch_to_output(value=True)
  51         else:
  52             self._reset = None
  53         self._i2c = i2c_bus
  54         self._dev_addr = device_address
  55
  56     def __new__(cls, *args, **kwargs):
  57         from displayio import (  # pylint: disable=import-outside-toplevel, cyclic-import
  58             allocate_display_bus,
  59         )
  60
  61         display_bus_instance = super().__new__(cls)
  62         allocate_display_bus(display_bus_instance)
  63         return display_bus_instance
  64
  65     def _release(self):
  66         self.reset()
  67         self._i2c.deinit()
  68         if self._reset is not None:
  69             self._reset.deinit()
  70
  71     def reset(self) -> None:
  72         """
  73         Performs a hardware reset via the reset pin if one is present.
  74         """
  75
  76         if self._reset is None:
  77             return
  78
  79         self._reset.value = False
  80         time.sleep(0.0001)
  81         self._reset.value = True
  82
  83     def send(self, command: int, data: ReadableBuffer) -> None:
  84         """
  85         Sends the given command value followed by the full set of data. Display state,
  86         such as vertical scroll, set via ``send`` may or may not be reset once the code is
  87         done.
  88         """
  89         self._begin_transaction()
  90         # re-wrap in case of byte-string
  91         buffer = list(data) if isinstance(data, bytes) else data
  92         self._send(DISPLAY_COMMAND, CHIP_SELECT_UNTOUCHED, bytes([command] + buffer))
  93         self._end_transaction()
  94
  95     def _send(
  96         self,
  97         data_type: int,
  98         _chip_select: int,  # Chip select behavior
  99         data: ReadableBuffer,
 100     ):
 101         if data_type == DISPLAY_COMMAND:
 102             n = len(data)
 103             if n > 0:
 104                 command_bytes = bytearray(n * 2)
 105                 for i in range(n):
 106                     command_bytes[2 * i] = 0x80
 107                     command_bytes[2 * i + 1] = data[i]
 108
 109             try:
 110                 self._i2c.writeto(self._dev_addr, buffer=command_bytes)
 111             except OSError as error:
 112                 if error.errno == 121:
 113                     raise RuntimeError(
 114                         f"I2C write error to 0x{self._dev_addr:02x}"
 115                     ) from error
 116                 raise error
 117         else:
 118             data_bytes = bytearray(len(data) + 1)
 119             data_bytes[0] = 0x40
 120             data_bytes[1:] = data
 121             try:
 122                 self._i2c.writeto(self._dev_addr, buffer=data_bytes)
 123             except OSError as error:
 124                 if error.errno == 121:
 125                     raise RuntimeError(
 126                         f"I2C write error to 0x{self._dev_addr:02x}"
 127                     ) from error
 128                 raise error
 129
 130     def _free(self) -> bool:
 131         """Attempt to free the bus and return False if busy"""
 132         if not self._i2c.try_lock():
 133             return False
 134         self._i2c.unlock()
 135         return True
 136
 137     def _begin_transaction(self) -> bool:
 138         """Lock the bus before sending data."""
 139         return self._i2c.try_lock()
 140
 141     def _end_transaction(self) -> None:
 142         """Release the bus after sending data."""
 143         self._i2c.unlock()