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