Skip to content

added typing for image, scs, and, reverse_bit num #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 28, 2023
Merged

added typing for image, scs, and, reverse_bit num #23

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e163b97
added typing for image, scs, and, reverse_bit num
SebastienFauque Apr 25, 2023
2e27636
added future annotations for the DigitalInOut
SebastienFauque Apr 25, 2023
9cd001b
Added stubbed out type versions, fixed num types, added None return t…
SebastienFauque Apr 27, 2023
bf3a570
Moving __future__ due to failed CI.
SebastienFauque Apr 27, 2023
0b5469b
add typing import
FoamyGuy Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions adafruit_sharpmemorydisplay.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,17 @@

"""
# pylint: enable=line-too-long
from __future__ import annotations


try:
# pylint: disable=unused-import
import typing
from busio import SPI
from digitalio import DigitalInOut
from circuitpython_typing.pil import Image
except ImportError:
pass

import adafruit_framebuf
from adafruit_bus_device.spi_device import SPIDevice
Expand All @@ -45,7 +56,7 @@
_SHARPMEM_BIT_CLEAR = const(0x20) # in lsb


def reverse_bit(num):
def reverse_bit(num: int) -> int:
"""Turn an LSB byte to an MSB byte, and vice versa. Used for SPI as
it is LSB for the SHARP, but 99% of SPI implementations are MSB only!"""
result = 0
Expand All @@ -62,7 +73,15 @@ class SharpMemoryDisplay(adafruit_framebuf.FrameBuffer):

# pylint: disable=too-many-instance-attributes,abstract-method

def __init__(self, spi, scs_pin, width, height, *, baudrate=2000000):
def __init__(
self,
spi: SPI,
scs_pin: DigitalInOut,
width: int,
height: int,
*,
baudrate=2000000,
):
scs_pin.switch_to_output(value=True)
self.spi_device = SPIDevice(
spi, scs_pin, cs_active_value=True, baudrate=baudrate
Expand All @@ -78,7 +97,7 @@ def __init__(self, spi, scs_pin, width, height, *, baudrate=2000000):
# Set the vcom bit to a defined state
self._vcom = True

def show(self):
def show(self) -> None:
"""write out the frame buffer via SPI, we use MSB SPI only so some
bit-swapping is required.
"""
Expand All @@ -105,7 +124,7 @@ def show(self):
image_buffer.extend(self._buf)
spi.write(image_buffer)

def image(self, img):
def image(self, img: Image) -> None:
"""Set buffer to value of Python Imaging Library image. The image should
be in 1 bit mode and a size equal to the display size."""
# determine our effective width/height, taking rotation into account
Expand Down