Merge pull request #36 from tannewt/magtag2025

Support newer 2.9" grayscale

.gitattributes

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+.py text eol=lf
+.rst text eol=lf
+.txt text eol=lf
+.yaml text eol=lf
+.toml text eol=lf
+.license text eol=lf
+.md text eol=lf

.pre-commit-config.yaml

@@ -1,42 +1,21 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
 repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: end-of-file-fixer
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.4
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: pylint
-        name: pylint (library code)
-        types: [python]
-        args:
-          - --disable=consider-using-f-string
-        exclude: "^(docs/|examples/|tests/|setup.py$)"
-      - id: pylint
-        name: pylint (example code)
-        description: Run pylint rules on "examples/*.py" files
-        types: [python]
-        files: "^examples/"
-        args:
-          - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code
-      - id: pylint
-        name: pylint (test code)
-        description: Run pylint rules on "tests/*.py" files
-        types: [python]
-        files: "^tests/"
-        args:
-          - --disable=missing-docstring,consider-using-f-string,duplicate-code
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse

.pylintrc

@@ -1,399 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
-
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
-extension-pkg-whitelist=
-
-# Add files or directories to the ignore-list. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the ignore-list. The
-# regex matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint.
-jobs=1
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=pylint.extensions.no_self_use
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Specify a configuration file.
-#rcfile=
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
-disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=
-
-
-[REPORTS]
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio).You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
-[SPELLING]
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-# notes=FIXME,XXX,TODO
-notes=FIXME,XXX
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=board
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,_cb
-
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,future.builtins
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-# expected-line-ending-format=
-expected-line-ending-format=LF
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging  or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=yes
-
-# Minimum lines number of a similarity.
-min-similarity-lines=12
-
-
-[BASIC]
-
-# Regular expression matching correct argument names
-argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct attribute names
-attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct class names
-# class-rgx=[A-Z_][a-zA-Z0-9]+$
-class-rgx=[A-Z_][a-zA-Z0-9_]+$
-
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Regular expression matching correct function names
-function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Good variable names which should always be accepted, separated by a comma
-# good-names=i,j,k,ex,Run,_
-good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
-
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-property-classes=abc.abstractproperty
-
-# Regular expression matching correct variable names
-variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-
-[IMPORTS]
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-# max-attributes=7
-max-attributes=11
-
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=1
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=builtins.Exception

.readthedocs.yaml

@@ -8,8 +8,11 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
-  os: ubuntu-20.04
+  os: ubuntu-lts-latest
   tools:
     python: "3"
 

README.rst

@@ -16,9 +16,9 @@ Introduction
     :alt: Build Status
 
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff
 
 CircuitPython `displayio` driver for SSD1680-based ePaper displays
 
@@ -103,16 +103,8 @@ Usage Example
 
     g = displayio.Group()
 
-    # CircuitPython 6 & 7 compatible
-    f = open("/display-ruler.bmp", "rb")
-    pic = displayio.OnDiskBitmap(f)
-    t = displayio.TileGrid(
-        pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
-    )
-
-    # # CircuitPython 7 compatible only
-    # pic = displayio.OnDiskBitmap("/display-ruler.bmp")
-    # t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+    pic = displayio.OnDiskBitmap("/display-ruler.bmp")
+    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
 
     g.append(t)
 

adafruit_ssd1680.py

@@ -28,31 +28,34 @@ Implementation Notes
 
 """
 
+from epaperdisplay import EPaperDisplay
+
 try:
-    from epaperdisplay import EPaperDisplay
+    import typing
+
     from fourwire import FourWire
 except ImportError:
-    from displayio import EPaperDisplay
-    from displayio import FourWire
+    pass
 
 
 __version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_SSD1680.git"
 
 _START_SEQUENCE = (
-    b"\x12\x80\x14"  # soft reset and wait 20ms
-    b"\x11\x01\x03"  # Ram data entry mode
-    b"\x3C\x01\x05"  # border color
-    b"\x2c\x01\x36"  # Set vcom voltage
-    b"\x03\x01\x17"  # Set gate voltage
-    b"\x04\x03\x41\x00\x32"  # Set source voltage
-    b"\x4e\x01\x01"  # ram x count
-    b"\x4f\x02\x00\x00"  # ram y count
-    b"\x01\x03\x00\x00\x00"  # set display size
-    b"\x22\x01\xf4"  # display update mode
+    b"\x12\x80\x00\x14"  # soft reset and wait 20ms
+    b"\x11\x00\x01\x03"  # Ram data entry mode
+    b"\x3c\x00\x01\x03"  # border color
+    b"\x2c\x00\x01\x36"  # Set vcom voltage
+    b"\x03\x00\x01\x17"  # Set gate voltage
+    b"\x04\x00\x03\x41\xae\x32"  # Set source voltage
+    b"\x4e\x00\x01\x01"  # ram x count
+    b"\x4f\x00\x02\x00\x00"  # ram y count
+    b"\x01\x00\x03\x00\x00\x00"  # set display size
 )
 
-_STOP_SEQUENCE = b"\x10\x81\x01\x64"  # Deep Sleep
+_DISPLAY_UPDATE_MODE = b"\x22\x00\x01\xf4"  # display update mode
+
+_STOP_SEQUENCE = b"\x10\x80\x01\x01\x64"  # Deep Sleep
 
 
 # pylint: disable=too-few-public-methods
@@ -70,9 +73,17 @@ class SSD1680(EPaperDisplay):
           Display height
         * *rotation* (``int``) --
           Display rotation
+        * *vcom* (``int``) --
+          Set vcom voltage register value
+        * *vsh2* (``int``) --
+          Set vsh2 voltage register value
+        * *custom_lut* (``bytes``) --
+          Custom look-up table settings
     """
 
-    def __init__(self, bus: FourWire, **kwargs) -> None:
+    def __init__(
+        self, bus: FourWire, vcom: int = 0x36, vsh2: int = 0x00, custom_lut: bytes = b"", **kwargs
+    ) -> None:
         if "colstart" not in kwargs:
             kwargs["colstart"] = 8
         stop_sequence = bytearray(_STOP_SEQUENCE)
@@ -81,14 +92,23 @@ class SSD1680(EPaperDisplay):
         except RuntimeError:
             # No reset pin defined, so no deep sleeping
             stop_sequence = b""
+        load_lut = b""
+        display_update_mode = bytearray(_DISPLAY_UPDATE_MODE)
+        if custom_lut:
+            load_lut = b"\x32" + len(custom_lut).to_bytes(2) + custom_lut
+            display_update_mode[-1] = 0xC7
+
+        start_sequence = bytearray(_START_SEQUENCE + load_lut + display_update_mode)
+        start_sequence[15] = vcom
+
+        start_sequence[24] = vsh2
 
-        start_sequence = bytearray(_START_SEQUENCE)
         width = kwargs["width"]
         height = kwargs["height"]
         if "rotation" in kwargs and kwargs["rotation"] % 180 != 90:
             width, height = height, width
-        start_sequence[29] = (width - 1) & 0xFF
-        start_sequence[30] = ((width - 1) >> 8) & 0xFF
+        start_sequence[38] = (width - 1) & 0xFF
+        start_sequence[39] = ((width - 1) >> 8) & 0xFF
 
         super().__init__(
             bus,
@@ -106,5 +126,6 @@ class SSD1680(EPaperDisplay):
             set_current_row_command=0x4F,
             refresh_display_command=0x20,
             always_toggle_chip_select=False,
-            address_little_endian=True
+            address_little_endian=True,
+            two_byte_sequence_length=True,
         )

docs/api.rst

@@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: adafruit_ssd1680
    :members:

docs/conf.py

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -27,7 +25,7 @@ extensions = [
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-autodoc_mock_imports = ["displayio"]
+autodoc_mock_imports = ["epaperdisplay", "fourwire"]
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
@@ -50,9 +48,7 @@ project = "Adafruit  CircuitPython SSD1680 Library"
 creation_year = "2021"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
-    current_year
-    if current_year == creation_year
-    else creation_year + " - " + current_year
+    current_year if current_year == creation_year else creation_year + " - " + current_year
 )
 copyright = year_duration + " Melissa LeBlanc-Williams"
 author = "Melissa LeBlanc-Williams"
@@ -112,7 +108,6 @@ napoleon_numpy_docstring = False
 import sphinx_rtd_theme
 
 html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

examples/ssd1680_2.13_featherwing.py

@@ -15,15 +15,12 @@ Supported products:
 """
 
 import time
+
 import board
 import displayio
-import adafruit_ssd1680
+from fourwire import FourWire
 
-# For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.
-try:
-    from fourwire import FourWire
-except ImportError:
-    from displayio import FourWire
+import adafruit_ssd1680
 
 displayio.release_displays()
 
@@ -45,25 +42,25 @@ display = adafruit_ssd1680.SSD1680(
 
 g = displayio.Group()
 
-with open("/display-ruler.bmp", "rb") as f:
-    pic = displayio.OnDiskBitmap(f)
 
-    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
 
-    g.append(t)
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
 
-    display.root_group = g
+g.append(t)
 
-    display.refresh()
+display.root_group = g
 
-    print("refreshed")
+display.refresh()
 
-    time.sleep(display.time_to_refresh + 5)
-    # Always refresh a little longer. It's not a problem to refresh
-    # a few seconds more, but it's terrible to refresh too early
-    # (the display will throw an exception when if the refresh
-    # is too soon)
-    print("waited correct time")
+print("refreshed")
+
+time.sleep(display.time_to_refresh + 5)
+# Always refresh a little longer. It's not a problem to refresh
+# a few seconds more, but it's terrible to refresh too early
+# (the display will throw an exception when if the refresh
+# is too soon)
+print("waited correct time")
 
 
 # Keep the display the same

examples/ssd1680_2.13_mono_eink_bonnet.py

@@ -16,15 +16,12 @@ Supported products:
 """
 
 import time
+
 import board
 import displayio
-import adafruit_ssd1680
+from fourwire import FourWire
 
-# For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.
-try:
-    from fourwire import FourWire
-except ImportError:
-    from displayio import FourWire
+import adafruit_ssd1680
 
 displayio.release_displays()
 
@@ -35,12 +32,10 @@ epd_dc = board.D22
 epd_reset = board.D27  # Set to None for FeatherWing
 epd_busy = board.D17  # Set to None for FeatherWing
 
-display_bus = FourWire(
-    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
-)
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
 time.sleep(1)
 
-# For issues with display not updating top/bottom rows correctly set colstart to 8
+# For issues with display not updating top/bottom rows correctly try setting colstart to 8 or 0
 display = adafruit_ssd1680.SSD1680(
     display_bus,
     width=250,
@@ -48,28 +43,29 @@ display = adafruit_ssd1680.SSD1680(
     busy_pin=epd_busy,
     highlight_color=0xFF0000,
     rotation=90,
+    colstart=-8,
 )
 
 
 g = displayio.Group()
 
-with open("display-ruler.bmp", "rb") as f:
-    pic = displayio.OnDiskBitmap(f)
-    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
-    g.append(t)
 
-    display.root_group = g
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+g.append(t)
 
-    display.refresh()
+display.root_group = g
 
-    print("refreshed")
+display.refresh()
 
-    time.sleep(display.time_to_refresh + 5)
-    # Always refresh a little longer. It's not a problem to refresh
-    # a few seconds more, but it's terrible to refresh too early
-    # (the display will throw an exception when if the refresh
-    # is too soon)
-    print("waited correct time")
+print("refreshed")
+
+time.sleep(display.time_to_refresh + 5)
+# Always refresh a little longer. It's not a problem to refresh
+# a few seconds more, but it's terrible to refresh too early
+# (the display will throw an exception when if the refresh
+# is too soon)
+print("waited correct time")
 
 
 # Keep the display the same

examples/ssd1680_2.13_tricolor_breakout.py

@@ -12,15 +12,12 @@ Supported products:
 """
 
 import time
+
 import board
 import displayio
-import adafruit_ssd1680
+from fourwire import FourWire
 
-# For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.
-try:
-    from fourwire import FourWire
-except ImportError:
-    from displayio import FourWire
+import adafruit_ssd1680
 
 displayio.release_displays()
 
@@ -44,17 +41,17 @@ display = adafruit_ssd1680.SSD1680(
 
 g = displayio.Group()
 
-with open("/display-ruler.bmp", "rb") as f:
-    pic = displayio.OnDiskBitmap(f)
 
-    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
 
-    g.append(t)
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
 
-    display.root_group = g
+g.append(t)
 
-    display.refresh()
+display.root_group = g
 
-    print("refreshed")
+display.refresh()
 
-    time.sleep(120)
+print("refreshed")
+
+time.sleep(120)

examples/ssd1680_2.9_grayscale_magtag2025.py

@@ -0,0 +1,89 @@
+# SPDX-FileCopyrightText: 2025 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+"""Simple test script for 2.9" 296x128 display. This example runs it in 2bit grayscale mode."""
+
+import time
+
+import board
+import busio
+import displayio
+from fourwire import FourWire
+
+import adafruit_ssd1680
+
+displayio.release_displays()
+
+# This pinout works on a MagTag with the newer screen and may need to be altered for other boards.
+spi = busio.SPI(board.EPD_SCK, board.EPD_MOSI)  # Uses SCK and MOSI
+epd_cs = board.EPD_CS
+epd_dc = board.EPD_DC
+epd_reset = board.EPD_RESET
+epd_busy = board.EPD_BUSY
+
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
+time.sleep(1)
+
+ti_290mfgn_gray4_lut_code = (
+    b"\x2a\x60\x15\x00\x00\x00\x00\x00\x00\x00\x00\x00"  # VS L0
+    b"\x20\x60\x10\x00\x00\x00\x00\x00\x00\x00\x00\x00"  # VS L1
+    b"\x28\x60\x14\x00\x00\x00\x00\x00\x00\x00\x00\x00"  # VS L2
+    b"\x00\x60\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"  # VS L3
+    b"\x00\x90\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"  # VS L4
+    b"\x00\x02\x00\x05\x14\x00\x00"  # TP, SR, RP of Group0
+    b"\x1e\x1e\x00\x00\x00\x00\x01"  # TP, SR, RP of Group1
+    b"\x00\x02\x00\x05\x14\x00\x00"  # TP, SR, RP of Group2
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group3
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group4
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group5
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group6
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group7
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group8
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group9
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group10
+    b"\x00\x00\x00\x00\x00\x00\x00"  # TP, SR, RP of Group11
+    b"\x24\x22\x22\x22\x23\x32\x00\x00\x00"  # FR, XON
+)
+
+if len(ti_290mfgn_gray4_lut_code) != 153:
+    raise ValueError("ti_290mfgn_gray4_lut_code is not the correct length")
+
+# For issues with display not updating top/bottom rows correctly set colstart to 8, 0, or -8
+display = adafruit_ssd1680.SSD1680(
+    display_bus,
+    width=296,
+    height=128,
+    busy_pin=epd_busy,
+    rotation=270,
+    colstart=0,
+    vcom=0x28,
+    vsh2=0xAE,
+    custom_lut=ti_290mfgn_gray4_lut_code,
+    grayscale=True,
+)
+
+g = displayio.Group()
+
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+g.append(t)
+
+display.root_group = g
+
+display.refresh()
+
+print("refreshed")
+
+time.sleep(display.time_to_refresh + 5)
+# Always refresh a little longer. It's not a problem to refresh
+# a few seconds more, but it's terrible to refresh too early
+# (the display will throw an exception when if the refresh
+# is too soon)
+print("waited correct time")
+
+
+# Keep the display the same
+while True:
+    time.sleep(10)

examples/ssd1680_2.9_mono_magtag2025.py

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: 2025 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2021 Melissa LeBlanc-Williams for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+"""Simple test script for 2.9" 296x128 display. This example runs it in mono mode."""
+
+import time
+
+import board
+import busio
+import displayio
+from fourwire import FourWire
+
+import adafruit_ssd1680
+
+displayio.release_displays()
+
+# This pinout works on a MagTag with the newer screen and may need to be altered for other boards.
+spi = busio.SPI(board.EPD_SCK, board.EPD_MOSI)  # Uses SCK and MOSI
+epd_cs = board.EPD_CS
+epd_dc = board.EPD_DC
+epd_reset = board.EPD_RESET
+epd_busy = board.EPD_BUSY
+
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
+time.sleep(1)
+
+# For issues with display not updating top/bottom rows correctly set colstart to 8, 0, or -8
+display = adafruit_ssd1680.SSD1680(
+    display_bus, width=296, height=128, busy_pin=epd_busy, rotation=270, colstart=0
+)
+
+g = displayio.Group()
+
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+g.append(t)
+
+display.root_group = g
+
+display.refresh()
+
+print("refreshed")
+
+time.sleep(display.time_to_refresh + 5)
+# Always refresh a little longer. It's not a problem to refresh
+# a few seconds more, but it's terrible to refresh too early
+# (the display will throw an exception when if the refresh
+# is too soon)
+print("waited correct time")
+
+
+# Keep the display the same
+while True:
+    time.sleep(10)

examples/ssd1680_2.9_tricolor_breakout.py

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: Copyright (c) 2023 Jose D. Montoya
+#
+# SPDX-License-Identifier: Unlicense
+
+
+"""Simple test script for Adafruit 2.9" Tri-Color eInk Display Breakout
+Supported products:
+  * Adafruit 2.9" Tri-Color eInk Display Breakout
+    * https://www.adafruit.com/product/1028
+
+"""
+
+import time
+
+import board
+import displayio
+from fourwire import FourWire
+
+import adafruit_ssd1680
+
+displayio.release_displays()
+
+# This pinout works on a Metro M4 and may need to be altered for other boards.
+spi = board.SPI()  # Uses SCK and MOSI
+epd_cs = board.D9
+epd_dc = board.D10
+epd_reset = board.D5
+epd_busy = board.D6
+
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, baudrate=1000000)
+time.sleep(1)
+
+display = adafruit_ssd1680.SSD1680(
+    display_bus,
+    width=296,
+    height=128,
+    highlight_color=0xFF0000,
+    rotation=270,
+)
+
+g = displayio.Group()
+
+
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
+
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+
+g.append(t)
+
+display.root_group = g
+
+display.refresh()
+
+print("refreshed")
+
+time.sleep(120)

examples/ssd1680_four_corners.py

@@ -10,17 +10,14 @@
 # pylint: disable=no-member
 
 import time
+
 import board
 import busio
 import displayio
 import terminalio
-import adafruit_ssd1680
+from fourwire import FourWire
 
-# For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.
-try:
-    from fourwire import FourWire
-except ImportError:
-    from displayio import FourWire
+import adafruit_ssd1680
 
 displayio.release_displays()
 
@@ -33,9 +30,7 @@ epd_dc = board.EPD_DC
 epd_reset = board.EPD_RESET
 epd_busy = board.EPD_BUSY
 
-display_bus = FourWire(
-    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
-)
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
 display = adafruit_ssd1680.SSD1680(
     display_bus,
     width=250,

examples/ssd1680_simpletest.py

@@ -9,22 +9,20 @@ Supported products:
     * https://www.adafruit.com/product/4947
   * Adafruit 2.13" Tri-Color eInk Display FeatherWing
     * https://www.adafruit.com/product/4814
+  * Adafruit 2.13" Mono eInk Display Breakout
+    * https://www.adafruit.com/product/4197
   * Adafruit 2.13" Mono eInk Display FeatherWing
     * https://www.adafruit.com/product/4195
 
-
 """
 
 import time
+
 import board
 import displayio
-import adafruit_ssd1680
+from fourwire import FourWire
 
-# For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.
-try:
-    from fourwire import FourWire
-except ImportError:
-    from displayio import FourWire
+import adafruit_ssd1680
 
 displayio.release_displays()
 
@@ -35,12 +33,10 @@ epd_dc = board.D10
 epd_reset = board.D8  # Set to None for FeatherWing
 epd_busy = board.D7  # Set to None for FeatherWing
 
-display_bus = FourWire(
-    spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
-)
+display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
 time.sleep(1)
 
-# For issues with display not updating top/bottom rows correctly set colstart to 8
+# For issues with display not updating top/bottom rows correctly set colstart to 8, 0, or -8
 display = adafruit_ssd1680.SSD1680(
     display_bus,
     width=250,
@@ -48,28 +44,30 @@ display = adafruit_ssd1680.SSD1680(
     busy_pin=epd_busy,
     highlight_color=0xFF0000,
     rotation=270,
+    colstart=-8,  # Comment out for older displays
 )
 
 
 g = displayio.Group()
 
-with open("/display-ruler.bmp", "rb") as f:
-    pic = displayio.OnDiskBitmap(f)
-    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
-    g.append(t)
+# Note: Check the name of the file. Sometimes the dash is changed to an underscore
 
-    display.root_group = g
+pic = displayio.OnDiskBitmap("/display-ruler-640x360.bmp")
+t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
+g.append(t)
 
-    display.refresh()
+display.root_group = g
 
-    print("refreshed")
+display.refresh()
 
-    time.sleep(display.time_to_refresh + 5)
-    # Always refresh a little longer. It's not a problem to refresh
-    # a few seconds more, but it's terrible to refresh too early
-    # (the display will throw an exception when if the refresh
-    # is too soon)
-    print("waited correct time")
+print("refreshed")
+
+time.sleep(display.time_to_refresh + 5)
+# Always refresh a little longer. It's not a problem to refresh
+# a few seconds more, but it's terrible to refresh too early
+# (the display will throw an exception when if the refresh
+# is too soon)
+print("waited correct time")
 
 
 # Keep the display the same

ruff.toml

@@ -0,0 +1,100 @@
+# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+target-version = "py38"
+line-length = 100
+
+[lint]
+preview = true
+select = ["I", "PL", "UP"]
+
+extend-select = [
+  "D419",  # empty-docstring
+  "E501",  # line-too-long
+  "W291",  # trailing-whitespace
+  "PLC0414",  # useless-import-alias
+  "PLC2401",  # non-ascii-name
+  "PLC2801",  # unnecessary-dunder-call
+  "PLC3002",  # unnecessary-direct-lambda-call
+  "E999",  # syntax-error
+  "PLE0101",  # return-in-init
+  "F706",  # return-outside-function
+  "F704",  # yield-outside-function
+  "PLE0116",  # continue-in-finally
+  "PLE0117",  # nonlocal-without-binding
+  "PLE0241",  # duplicate-bases
+  "PLE0302",  # unexpected-special-method-signature
+  "PLE0604",  # invalid-all-object
+  "PLE0605",  # invalid-all-format
+  "PLE0643",  # potential-index-error
+  "PLE0704",  # misplaced-bare-raise
+  "PLE1141",  # dict-iter-missing-items
+  "PLE1142",  # await-outside-async
+  "PLE1205",  # logging-too-many-args
+  "PLE1206",  # logging-too-few-args
+  "PLE1307",  # bad-string-format-type
+  "PLE1310",  # bad-str-strip-call
+  "PLE1507",  # invalid-envvar-value
+  "PLE2502",  # bidirectional-unicode
+  "PLE2510",  # invalid-character-backspace
+  "PLE2512",  # invalid-character-sub
+  "PLE2513",  # invalid-character-esc
+  "PLE2514",  # invalid-character-nul
+  "PLE2515",  # invalid-character-zero-width-space
+  "PLR0124",  # comparison-with-itself
+  "PLR0202",  # no-classmethod-decorator
+  "PLR0203",  # no-staticmethod-decorator
+  "UP004",  # useless-object-inheritance
+  "PLR0206",  # property-with-parameters
+  "PLR0904",  # too-many-public-methods
+  "PLR0911",  # too-many-return-statements
+  "PLR0912",  # too-many-branches
+  "PLR0913",  # too-many-arguments
+  "PLR0914",  # too-many-locals
+  "PLR0915",  # too-many-statements
+  "PLR0916",  # too-many-boolean-expressions
+  "PLR1702",  # too-many-nested-blocks
+  "PLR1704",  # redefined-argument-from-local
+  "PLR1711",  # useless-return
+  "C416",  # unnecessary-comprehension
+  "PLR1733",  # unnecessary-dict-index-lookup
+  "PLR1736",  # unnecessary-list-index-lookup
+
+  # ruff reports this rule is unstable
+  #"PLR6301",  # no-self-use
+
+  "PLW0108",  # unnecessary-lambda
+  "PLW0120",  # useless-else-on-loop
+  "PLW0127",  # self-assigning-variable
+  "PLW0129",  # assert-on-string-literal
+  "B033",  # duplicate-value
+  "PLW0131",  # named-expr-without-context
+  "PLW0245",  # super-without-brackets
+  "PLW0406",  # import-self
+  "PLW0602",  # global-variable-not-assigned
+  "PLW0603",  # global-statement
+  "PLW0604",  # global-at-module-level
+
+  # fails on the try: import typing used by libraries
+  #"F401",  # unused-import
+
+  "F841",  # unused-variable
+  "E722",  # bare-except
+  "PLW0711",  # binary-op-exception
+  "PLW1501",  # bad-open-mode
+  "PLW1508",  # invalid-envvar-default
+  "PLW1509",  # subprocess-popen-preexec-fn
+  "PLW2101",  # useless-with-lock
+  "PLW3301",  # nested-min-max
+]
+
+ignore = [
+    "PLR2004", # magic-value-comparison
+    "UP030", # format literals
+    "PLW1514",  # unspecified-encoding
+
+]
+
+[format]
+line-ending = "lf"