From 22eeabb28fc3c583d5a6ca8550af6a824f6946de Mon Sep 17 00:00:00 2001 From: sdomoszlai13 Date: Wed, 10 May 2023 11:18:23 +0200 Subject: [PATCH] Added requested type annotations for ssd1608.py. --- adafruit_epd/ssd1608.py | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/adafruit_epd/ssd1608.py b/adafruit_epd/ssd1608.py index 0bb4b7b..0ad6e26 100644 --- a/adafruit_epd/ssd1608.py +++ b/adafruit_epd/ssd1608.py @@ -14,6 +14,15 @@ import adafruit_framebuf from adafruit_epd.epd import Adafruit_EPD +try: + """Needed for type annotations""" + from typing import Union, Any + from busio import SPI + from digitalio import DigitalInOut + +except ImportError: + pass + __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_EPD.git" @@ -57,8 +66,17 @@ class Adafruit_SSD1608(Adafruit_EPD): # pylint: disable=too-many-arguments def __init__( - self, width, height, spi, *, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin - ): + self, + width: int, + height: int, + spi: SPI, + *, + cs_pin: DigitalInOut, + dc_pin: DigitalInOut, + sramcs_pin: DigitalInOut, + rst_pin: DigitalInOut, + busy_pin: DigitalInOut + ) -> None: super().__init__( width, height, spi, cs_pin, dc_pin, sramcs_pin, rst_pin, busy_pin ) @@ -80,13 +98,13 @@ def __init__( self.set_color_buffer(0, True) # pylint: enable=too-many-arguments - def begin(self, reset=True): + def begin(self, reset: bool = True) -> None: """Begin communication with the display and set basic settings""" if reset: self.hardware_reset() self.power_down() - def busy_wait(self): + def busy_wait(self) -> None: """Wait for display to be done with current task, either by polling the busy pin, or pausing""" if self._busy: @@ -95,7 +113,7 @@ def busy_wait(self): else: time.sleep(0.5) - def power_up(self): + def power_up(self) -> None: """Power up the display in preparation for writing RAM and updating""" self.hardware_reset() self.busy_wait() @@ -125,12 +143,12 @@ def power_up(self): self.command(_SSD1608_WRITE_LUT, _LUT_DATA) self.busy_wait() - def power_down(self): + def power_down(self) -> None: """Power down the display - required when not actively displaying!""" self.command(_SSD1608_DEEP_SLEEP, bytearray([0x01])) time.sleep(0.1) - def update(self): + def update(self) -> None: """Update the display from internal memory""" self.command(_SSD1608_DISP_CTRL2, bytearray([0xC7])) self.command(_SSD1608_MASTER_ACTIVATE) @@ -138,7 +156,7 @@ def update(self): if not self._busy: time.sleep(3) # wait 3 seconds - def write_ram(self, index): + def write_ram(self, index: Union[0]) -> Any: """Send the one byte command for starting the RAM write process. Returns the byte read at the same time over SPI. index is the RAM buffer, can be 0 or 1 for tri-color displays.""" @@ -146,7 +164,9 @@ def write_ram(self, index): return self.command(_SSD1608_WRITE_RAM, end=False) raise RuntimeError("RAM index must be 0") - def set_ram_address(self, x, y): # pylint: disable=unused-argument, no-self-use + def set_ram_address( + self, x: int, y: int + ) -> None: # pylint: disable=unused-argument, no-self-use """Set the RAM address location, not used on this chipset but required by the superclass""" # Set RAM X address counter