diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -40,7 +40,7 @@ jobs: source actions-ci/install.sh - name: Pip install pylint, black, & Sphinx run: | - pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme + pip install pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_ssd1351.py b/adafruit_ssd1351.py index 0fc9d45..53698f9 100755 --- a/adafruit_ssd1351.py +++ b/adafruit_ssd1351.py @@ -53,7 +53,7 @@ _INIT_SEQUENCE = ( b"\xFD\x01\x12" # COMMAND_LOCK Unlock IC MCU b"\xFD\x01\xB1" # COMMAND_LOCK - b"\xAE\x00" # DISPLAY_OFF + b"\xAE\x00" # DISPLAY_OFF b"\xB2\x03\xA4\x00\x00" # DISPLAY_ENHANCEMENT b"\xB3\x01\xF0" # CLOCK_DIV b"\xCA\x01\x7F" # MUX_RATIO @@ -62,7 +62,7 @@ b"\xAB\x01\x01" # FUNCTION_SELECT b"\xB1\x01\x32" # PRECHARGE b"\xBE\x01\x05" # VCOMH - b"\xA6\x00" # NORMAL_DISPLAY + b"\xA6\x00" # NORMAL_DISPLAY b"\xC1\x03\xC8\x80\xC8" # CONTRAST_ABC (RGB) b"\xC7\x01\x0F" # CONTRAST_MASTER b"\xB4\x03\xA0\xB5\x55" # SET_VSL Set segment low volt @@ -74,7 +74,14 @@ # pylint: disable=too-few-public-methods class SSD1351(displayio.Display): """SSD1351 driver""" + def __init__(self, bus, **kwargs): - super().__init__(bus, _INIT_SEQUENCE, **kwargs, set_column_command=0x15, - set_row_command=0x75, write_ram_command=0x5C, - single_byte_bounds=True) + super().__init__( + bus, + _INIT_SEQUENCE, + **kwargs, + set_column_command=0x15, + set_row_command=0x75, + write_ram_command=0x5C, + single_byte_bounds=True, + ) diff --git a/docs/conf.py b/docs/conf.py index 89ede89..500ddef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,10 +11,10 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,29 +24,32 @@ # autodoc_mock_imports = ["digitalio", "busio"] autodoc_mock_imports = ["displayio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", None), + "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), +} # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit SSD1351 Library' -copyright = u'2019 Melissa LeBlanc-Williams' -author = u'Melissa LeBlanc-Williams' +project = "Adafruit SSD1351 Library" +copyright = "2019 Melissa LeBlanc-Williams" +author = "Melissa LeBlanc-Williams" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'1.0' +version = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -57,7 +61,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -69,7 +73,7 @@ add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -84,59 +88,62 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get('READTHEDOCS', None) == 'True' +on_rtd = os.environ.get("READTHEDOCS", None) == "True" if not on_rtd: # only import and set the theme if we're building docs locally try: import sphinx_rtd_theme - html_theme = 'sphinx_rtd_theme' - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.'] + + html_theme = "sphinx_rtd_theme" + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] except: - html_theme = 'default' - html_theme_path = ['.'] + html_theme = "default" + html_theme_path = ["."] else: - html_theme_path = ['.'] + 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # -html_favicon = '_static/favicon.ico' +html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitSsd1351Librarydoc' +htmlhelp_basename = "AdafruitSsd1351Librarydoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'AdafruitSSD1351Library.tex', u'AdafruitSSD1351 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitSSD1351Library.tex", + "AdafruitSSD1351 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitSSD1351library', u'Adafruit SSD1351 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitSSD1351library", + "Adafruit SSD1351 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitSSD1351Library', u'Adafruit SSD1351 Library Documentation', - author, 'AdafruitSSD1351Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitSSD1351Library", + "Adafruit SSD1351 Library Documentation", + author, + "AdafruitSSD1351Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/ssd1351_128x96_simpletest.py b/examples/ssd1351_128x96_simpletest.py index 454841c..50b4189 100644 --- a/examples/ssd1351_128x96_simpletest.py +++ b/examples/ssd1351_128x96_simpletest.py @@ -16,8 +16,9 @@ tft_cs = board.D5 tft_dc = board.D6 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, - reset=board.D9, baudrate=16000000) +display_bus = displayio.FourWire( + spi, command=tft_dc, chip_select=tft_cs, reset=board.D9, baudrate=16000000 +) display = SSD1351(display_bus, width=128, height=96) @@ -27,20 +28,16 @@ color_bitmap = displayio.Bitmap(128, 96, 1) color_palette = displayio.Palette(1) -color_palette[0] = 0x00FF00 # Bright Green +color_palette[0] = 0x00FF00 # Bright Green -bg_sprite = displayio.TileGrid(color_bitmap, - pixel_shader=color_palette, - x=0, y=0) +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) splash.append(bg_sprite) # Draw a smaller inner rectangle inner_bitmap = displayio.Bitmap(108, 76, 1) inner_palette = displayio.Palette(1) -inner_palette[0] = 0xAA0088 # Purple -inner_sprite = displayio.TileGrid(inner_bitmap, - pixel_shader=inner_palette, - x=10, y=10) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=10, y=10) splash.append(inner_sprite) # Draw a label diff --git a/examples/ssd1351_simpletest.py b/examples/ssd1351_simpletest.py index 34b0c79..ba8a9ae 100644 --- a/examples/ssd1351_simpletest.py +++ b/examples/ssd1351_simpletest.py @@ -16,8 +16,9 @@ tft_cs = board.D5 tft_dc = board.D6 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, - reset=board.D9, baudrate=16000000) +display_bus = displayio.FourWire( + spi, command=tft_dc, chip_select=tft_cs, reset=board.D9, baudrate=16000000 +) display = SSD1351(display_bus, width=128, height=128) @@ -27,20 +28,16 @@ color_bitmap = displayio.Bitmap(128, 128, 1) color_palette = displayio.Palette(1) -color_palette[0] = 0x00FF00 # Bright Green +color_palette[0] = 0x00FF00 # Bright Green -bg_sprite = displayio.TileGrid(color_bitmap, - pixel_shader=color_palette, - x=0, y=0) +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) splash.append(bg_sprite) # Draw a smaller inner rectangle inner_bitmap = displayio.Bitmap(108, 108, 1) inner_palette = displayio.Palette(1) -inner_palette[0] = 0xAA0088 # Purple -inner_sprite = displayio.TileGrid(inner_bitmap, - pixel_shader=inner_palette, - x=10, y=10) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=10, y=10) splash.append(inner_sprite) # Draw a label