diff --git a/.pylintrc b/.pylintrc index 039eaec..d8f0ee8 100644 --- a/.pylintrc +++ b/.pylintrc @@ -52,7 +52,7 @@ confidence= # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" # disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation # 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 diff --git a/adafruit_il0373.py b/adafruit_il0373.py index e5824ae..964c18f 100644 --- a/adafruit_il0373.py +++ b/adafruit_il0373.py @@ -52,20 +52,20 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_IL0373.git" _START_SEQUENCE = ( - b"\x01\x05\x03\x00\x2b\x2b\x09" # power setting - b"\x06\x03\x17\x17\x17" # booster soft start - b"\x04\x80\xc8" # power on and wait 200 ms - b"\x00\x01\xcf" # panel setting - b"\x50\x01\x37" # CDI setting - b"\x30\x01\x29" # PLL - b"\x61\x03\x00\x00\x00" # Resolution - b"\x82\x81\x32\x0a" # VCM DC and delay 50ms + b"\x01\x05\x03\x00\x2b\x2b\x09" # power setting + b"\x06\x03\x17\x17\x17" # booster soft start + b"\x04\x80\xc8" # power on and wait 200 ms + b"\x00\x01\xcf" # panel setting + b"\x50\x01\x37" # CDI setting + b"\x30\x01\x29" # PLL + b"\x61\x03\x00\x00\x00" # Resolution + b"\x82\x81\x32\x0a" # VCM DC and delay 50ms ) _STOP_SEQUENCE = ( - b"\x50\x01\x17" # CDI setting - b"\x82\x01\x00" # VCM DC and delay 50ms - b"\x02\x00" # Power off + b"\x50\x01\x17" # CDI setting + b"\x82\x01\x00" # VCM DC and delay 50ms + b"\x02\x00" # Power off ) # pylint: disable=too-few-public-methods class IL0373(displayio.EPaperDisplay): @@ -88,15 +88,14 @@ class IL0373(displayio.EPaperDisplay): * *black_bits_inverted* (``bool``) -- Invert black bit values """ + def __init__(self, bus, swap_rams=False, **kwargs): start_sequence = bytearray(_START_SEQUENCE) width = kwargs["width"] height = kwargs["height"] if "rotation" in kwargs and kwargs["rotation"] % 180 != 0: - w = width - width = height - height = w + width, height = height, width start_sequence[26] = width & 0xFF start_sequence[27] = (height >> 8) & 0xFF start_sequence[28] = height & 0xFF @@ -110,11 +109,17 @@ def __init__(self, bus, swap_rams=False, **kwargs): write_color_ram_command = 0x13 color_bits_inverted = kwargs.pop("color_bits_inverted", True) black_bits_inverted = kwargs.pop("black_bits_inverted", False) - super().__init__(bus, start_sequence, _STOP_SEQUENCE, **kwargs, - ram_width=160, ram_height=296, - busy_state=False, - write_black_ram_command=write_black_ram_command, - write_color_ram_command=write_color_ram_command, - black_bits_inverted=black_bits_inverted, - color_bits_inverted=color_bits_inverted, - refresh_display_command=0x12) + super().__init__( + bus, + start_sequence, + _STOP_SEQUENCE, + **kwargs, + ram_width=160, + ram_height=296, + busy_state=False, + write_black_ram_command=write_black_ram_command, + write_color_ram_command=write_color_ram_command, + black_bits_inverted=black_bits_inverted, + color_bits_inverted=color_bits_inverted, + refresh_display_command=0x12, + ) diff --git a/docs/conf.py b/docs/conf.py index 6371f3d..2402cb5 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 = ["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 IL0373 Library' -copyright = u'2019 Scott Shawcroft' -author = u'Scott Shawcroft' +project = "Adafruit IL0373 Library" +copyright = "2019 Scott Shawcroft" +author = "Scott Shawcroft" # 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 = 'AdafruitIl0373Librarydoc' +htmlhelp_basename = "AdafruitIl0373Librarydoc" # -- 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, 'AdafruitIL0373Library.tex', u'AdafruitIL0373 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitIL0373Library.tex", + "AdafruitIL0373 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, 'AdafruitIL0373library', u'Adafruit IL0373 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitIL0373library", + "Adafruit IL0373 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, 'AdafruitIL0373Library', u'Adafruit IL0373 Library Documentation', - author, 'AdafruitIL0373Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitIL0373Library", + "Adafruit IL0373 Library Documentation", + author, + "AdafruitIL0373Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/il0373_1.54_color.py b/examples/il0373_1.54_color.py index a9142ed..c9dc19c 100644 --- a/examples/il0373_1.54_color.py +++ b/examples/il0373_1.54_color.py @@ -13,18 +13,20 @@ displayio.release_displays() # This pinout works on a Feather M4 and may need to be altered for other boards. -spi = board.SPI() # Uses SCK and MOSI +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 = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, - baudrate=1000000) +display_bus = displayio.FourWire( + spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000 +) time.sleep(1) -display = adafruit_il0373.IL0373(display_bus, width=152, height=152, busy_pin=epd_busy, - highlight_color=0xff0000) +display = adafruit_il0373.IL0373( + display_bus, width=152, height=152, busy_pin=epd_busy, highlight_color=0xFF0000 +) g = displayio.Group() diff --git a/examples/il0373_2.13_color.py b/examples/il0373_2.13_color.py index 94a017b..2accfc2 100755 --- a/examples/il0373_2.13_color.py +++ b/examples/il0373_2.13_color.py @@ -22,14 +22,20 @@ epd_busy = board.D6 # Create the displayio connection to the display pins -display_bus = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, - reset=epd_reset, baudrate=1000000) +display_bus = displayio.FourWire( + spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000 +) time.sleep(1) # Wait a bit # Create the display object - the third color is red (0xff0000) -display = adafruit_il0373.IL0373(display_bus, width=212, height=104, - rotation=90, busy_pin=epd_busy, - highlight_color=0xff0000) +display = adafruit_il0373.IL0373( + display_bus, + width=212, + height=104, + rotation=90, + busy_pin=epd_busy, + highlight_color=0xFF0000, +) # Create a display group for our screen objects g = displayio.Group() diff --git a/examples/il0373_2.9_color.py b/examples/il0373_2.9_color.py index 5f3fe12..5620814 100644 --- a/examples/il0373_2.9_color.py +++ b/examples/il0373_2.9_color.py @@ -21,14 +21,20 @@ epd_busy = board.D6 # Create the displayio connection to the display pins -display_bus = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, - reset=epd_reset, baudrate=1000000) +display_bus = displayio.FourWire( + spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000 +) time.sleep(1) # Wait a bit # Create the display object - the third color is red (0xff0000) -display = adafruit_il0373.IL0373(display_bus, width=296, height=128, - rotation=270, busy_pin=epd_busy, - highlight_color=0xff0000) +display = adafruit_il0373.IL0373( + display_bus, + width=296, + height=128, + rotation=270, + busy_pin=epd_busy, + highlight_color=0xFF0000, +) # Create a display group for our screen objects g = displayio.Group() diff --git a/examples/il0373_flexible_2.13_monochrome.py b/examples/il0373_flexible_2.13_monochrome.py index e521086..f7daade 100644 --- a/examples/il0373_flexible_2.13_monochrome.py +++ b/examples/il0373_flexible_2.13_monochrome.py @@ -13,18 +13,20 @@ displayio.release_displays() # This pinout works on a Feather M4 and may need to be altered for other boards. -spi = board.SPI() # Uses SCK and MOSI +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 = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, - baudrate=1000000) +display_bus = displayio.FourWire( + spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000 +) time.sleep(1) -display = adafruit_il0373.IL0373(display_bus, width=212, height=104, rotation=90, busy_pin=epd_busy, - swap_rams=True) +display = adafruit_il0373.IL0373( + display_bus, width=212, height=104, rotation=90, busy_pin=epd_busy, swap_rams=True +) g = displayio.Group() diff --git a/examples/il0373_flexible_2.9_monochrome.py b/examples/il0373_flexible_2.9_monochrome.py index 409915f..78d062a 100644 --- a/examples/il0373_flexible_2.9_monochrome.py +++ b/examples/il0373_flexible_2.9_monochrome.py @@ -13,18 +13,20 @@ displayio.release_displays() # This pinout works on a Feather M4 and may need to be altered for other boards. -spi = board.SPI() # Uses SCK and MOSI +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 = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, - baudrate=1000000) +display_bus = displayio.FourWire( + spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000 +) time.sleep(1) -display = adafruit_il0373.IL0373(display_bus, width=296, height=128, rotation=90, busy_pin=epd_busy, - swap_rams=True) +display = adafruit_il0373.IL0373( + display_bus, width=296, height=128, rotation=90, busy_pin=epd_busy, swap_rams=True +) g = displayio.Group() diff --git a/examples/il0373_simpletest.py b/examples/il0373_simpletest.py index 0892333..9d02952 100644 --- a/examples/il0373_simpletest.py +++ b/examples/il0373_simpletest.py @@ -15,11 +15,14 @@ epd_cs = board.D9 epd_dc = board.D10 -display_bus = displayio.FourWire(board.SPI(), command=epd_dc, chip_select=epd_cs, baudrate=1000000) +display_bus = displayio.FourWire( + board.SPI(), command=epd_dc, chip_select=epd_cs, baudrate=1000000 +) time.sleep(1) -display = adafruit_il0373.IL0373(display_bus, width=212, height=104, rotation=90, - highlight_color=0xff0000) +display = adafruit_il0373.IL0373( + display_bus, width=212, height=104, rotation=90, highlight_color=0xFF0000 +) g = displayio.Group() diff --git a/setup.py b/setup.py index e6237df..03d043e 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,51 +14,40 @@ here = path.abspath(path.dirname(__file__)) # Get the long description from the README file -with open(path.join(here, 'README.rst'), encoding='utf-8') as f: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() setup( - name='adafruit-circuitpython-il0373', - + name="adafruit-circuitpython-il0373", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython `displayio` driver for IL0373-based ePaper displays', + setup_requires=["setuptools_scm"], + description="CircuitPython `displayio` driver for IL0373-based ePaper displays", long_description=long_description, - long_description_content_type='text/x-rst', - + long_description_content_type="text/x-rst", # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_IL0373', - + url="https://github.com/adafruit/Adafruit_CircuitPython_IL0373", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=[ - 'Adafruit-Blinka' - ], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # Choose your license - license='MIT', - + license="MIT", # See https://pypi.python.org/pypi?%3Aaction=list_classifiers classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Topic :: Software Development :: Libraries', - 'Topic :: System :: Hardware', - 'License :: OSI Approved :: MIT License', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", ], - # What does your project relate to? - keywords='adafruit blinka circuitpython micropython il0373 displayio epd epaper', - + keywords="adafruit blinka circuitpython micropython il0373 displayio epd epaper", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['adafruit_il0373'], + py_modules=["adafruit_il0373"], )