diff --git a/.gitignore b/.gitignore index 5ca0973..31d9b4c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ .DS_Store - +.env +build* +bundles diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..946d694 --- /dev/null +++ b/.pylintrc @@ -0,0 +1,432 @@ +[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 blacklist. They should be base names, not +# paths. +ignore=CVS + +# Add files or directories matching the regex patterns to the blacklist. 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 +jobs=2 + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + +# 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,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 + +# 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 + + +[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= + +# 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*(# )??$ + +# 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 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# 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=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([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 + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-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 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# 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 + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-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 + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# 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=Exception diff --git a/.travis.yml b/.travis.yml index e36d213..6943df8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,59 +1,30 @@ -# Travis CI configuration for automated .mpy file generation. -# Version: 2.0 (support for both .mpy and packages) -# Author: Tony DiCola -# License: Public Domain -# This configuration will work with Travis CI (travis-ci.org) to automacially -# build .mpy files and packages for MicroPython when a new tagged release is -# created. This file is relatively generic and can be shared across multiple -# repositories by following these steps: -# 1. Copy this file into a .travis.yml file in the root of the repository. -# 2. Change the deploy > file section below to list each of the .mpy files or -# package .zip files that should be generated. -# For each .mpy file listed the config will automatically look for .py files -# with the same name as the source for generating the .mpy files. Note that -# the .mpy extension should be lower case! -# For each .zip file listed the config will assume a folder with the same -# name exists (minus the .zip extension) and will recursively walk the folder -# to generate .mpy versions of all .py files EXCEPT __init__.py (not supported -# right now because of a bug). Then a zip of the directory will be generated -# with just the .mpy and __init__.py files. -# 3. Commit the .travis.yml file and push it to GitHub. -# 4. Go to travis-ci.org and find the repository (it needs to be setup to access -# your github account, and your github account needs access to write to the -# repo). Flip the 'ON' switch on for Travis and the repo, see the Travis -# docs for more details: https://docs.travis-ci.com/user/getting-started/ -# 5. Get a GitHub 'personal access token' which has at least 'public_repo' or -# 'repo' scope: https://help.github.com/articles/creating-an-access-token-for-command-line-use/ -# Keep this token safe and secure! Anyone with the token will be able to -# access and write to your GitHub repositories. Travis will use the token -# to attach the .mpy files to the release. -# 6. In the Travis CI settings for the repository that was enabled find the -# environment variable editing page: https://docs.travis-ci.com/user/environment-variables/#Defining-Variables-in-Repository-Settings -# Add an environment variable named GITHUB_TOKEN and set it to the value -# of the GitHub personal access token above. Keep 'Display value in build -# log' flipped off. -# 7. That's it! Tag a release and Travis should go to work to add .mpy files -# to the release. It takes about a 2-3 minutes for a worker to spin up, -# build mpy-cross, and add the binaries to the release. -language: generic +# This is a common .travis.yml for generating library release zip files for +# CircuitPython library releases using circuitpython-build-tools. +# See https://github.com/adafruit/circuitpython-build-tools for detailed setup +# instructions. -sudo: true +dist: trusty +sudo: false +language: python +python: + - "3.6" + +cache: + pip: true deploy: provider: releases api_key: $GITHUB_TOKEN - file: - - adafruit_rgb_display.zip + file_glob: true + file: bundles/* skip_cleanup: true on: tags: true -before_install: - - wget https://raw.githubusercontent.com/adafruit/MicroPython_TravisCI_Deploy/master/install_dependencies.sh - - chmod +x install_dependencies.sh - - source install_dependencies.sh +install: + - pip install pylint circuitpython-build-tools -before_deploy: - - wget https://raw.githubusercontent.com/adafruit/MicroPython_TravisCI_Deploy/master/build_release.sh - - chmod +x build_release.sh - - ./build_release.sh +script: + - pylint adafruit_rgb_display/*.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rgb-display --library_location . diff --git a/adafruit_rgb_display/__init__.py b/adafruit_rgb_display/__init__.py index c5994bb..2928b41 100644 --- a/adafruit_rgb_display/__init__.py +++ b/adafruit_rgb_display/__init__.py @@ -1 +1,2 @@ +"""Auto imports for Adafruit_CircuitPython_RGB_Display""" from adafruit_rgb_display.rgb import color565 diff --git a/adafruit_rgb_display/hx8353.py b/adafruit_rgb_display/hx8353.py index eece456..1ad96d8 100644 --- a/adafruit_rgb_display/hx8353.py +++ b/adafruit_rgb_display/hx8353.py @@ -1,4 +1,10 @@ +"""A simple driver for the HX8353-based displays.""" from adafruit_rgb_display.rgb import DisplaySPI +from micropython import const + + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git" _SWRESET = const(0x01) _NORON = const(0x13) @@ -15,7 +21,7 @@ class HX8353(DisplaySPI): """ - A simple driver for the ST7735-based displays. + A simple driver for the HX8353-based displays. >>> import busio >>> import digitalio @@ -23,7 +29,8 @@ class HX8353(DisplaySPI): >>> from adafruit_rgb_display import color565 >>> import adafruit_rgb_display.hx8353 as hx8353 >>> spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI, MISO=board.MISO) - >>> display = hx8353.HX8383(spi, cs=digitalio.DigitalInOut(board.GPIO0), dc=digitalio.DigitalInOut(board.GPIO15)) + >>> display = hx8353.HX8383(spi, cs=digitalio.DigitalInOut(board.GPIO0), + ... dc=digitalio.DigitalInOut(board.GPIO15)) >>> display.fill(0x7521) >>> display.pixel(64, 64, 0) """ @@ -38,5 +45,6 @@ class HX8353(DisplaySPI): _ENCODE_PIXEL = ">H" _ENCODE_POS = ">HH" + #pylint: disable-msg=useless-super-delegation, too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=128, height=128): super().__init__(spi, dc, cs, rst, width, height) diff --git a/adafruit_rgb_display/ili9341.py b/adafruit_rgb_display/ili9341.py index 31b76b6..84af160 100644 --- a/adafruit_rgb_display/ili9341.py +++ b/adafruit_rgb_display/ili9341.py @@ -1,3 +1,5 @@ +"""A simple driver for the ILI9341/ILI9340-based displays.""" + try: import struct except ImportError: @@ -5,6 +7,9 @@ from adafruit_rgb_display.rgb import DisplaySPI +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git" + class ILI9341(DisplaySPI): """ @@ -16,7 +21,8 @@ class ILI9341(DisplaySPI): >>> from adafruit_rgb_display import color565 >>> import adafruit_rgb_display.ili9341 as ili9341 >>> spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI, MISO=board.MISO) - >>> display = ili9341.ILI9341(spi, cs=digitalio.DigitalInOut(board.GPIO0), dc=digitalio.DigitalInOut(board.GPIO15)) + >>> display = ili9341.ILI9341(spi, cs=digitalio.DigitalInOut(board.GPIO0), + ... dc=digitalio.DigitalInOut(board.GPIO15)) >>> display.fill(color565(0xff, 0x11, 0x22)) >>> display.pixel(120, 160, 0) """ @@ -54,14 +60,18 @@ class ILI9341(DisplaySPI): _ENCODE_POS = ">HH" _DECODE_PIXEL = ">BBB" + #pylint: disable-msg=too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=240, height=320, baudrate=16000000, polarity=0, phase=0): super().__init__(spi, dc, cs, rst=rst, width=width, height=height, baudrate=baudrate, polarity=polarity, phase=phase) self._scroll = 0 + #pylint: enable-msg=too-many-arguments - def scroll(self, dy=None): + def scroll(self, dy=None): #pylint: disable-msg=invalid-name + """Scroll the display by delta y""" if dy is None: return self._scroll self._scroll = (self._scroll + dy) % self.height - self._write(0x37, struct.pack('>H', self._scroll)) + self.write(0x37, struct.pack('>H', self._scroll)) + return None diff --git a/adafruit_rgb_display/rgb.py b/adafruit_rgb_display/rgb.py index 694599e..8df0966 100644 --- a/adafruit_rgb_display/rgb.py +++ b/adafruit_rgb_display/rgb.py @@ -1,5 +1,6 @@ -from micropython import const +""" Base class for all RGB Display devices """ import time +from micropython import const try: import struct except ImportError: @@ -7,6 +8,8 @@ import adafruit_bus_device.spi_device as spi_device +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git" # This is the size of the buffer to be used for fill operations, in 16-bit # units. We use 256, which is 512 bytes — size of the DMA buffer on SAMD21. @@ -14,22 +17,27 @@ def color565(r, g, b): + """Format color code for device""" return (r & 0xf8) << 8 | (g & 0xfc) << 3 | b >> 3 class DummyPin: """A fake gpio pin for when you want to skip pins.""" def init(self, *args, **kwargs): + """Dummy Pin init""" pass def low(self): + """Dummy low Pin method""" pass def high(self): + """Dummy high Pin method""" pass -class Display: +class Display: #pylint: disable-msg=no-member + """Base class for all RGB display devices""" _PAGE_SET = None _COLUMN_SET = None _RAM_WRITE = None @@ -47,21 +55,24 @@ def __init__(self, width, height): def init(self): """Run the initialization commands.""" for command, data in self._INIT: - self._write(command, data) + self.write(command, data) + #pylint: disable-msg=invalid-name,too-many-arguments def _block(self, x0, y0, x1, y1, data=None): """Read or write a block of data.""" - self._write(self._COLUMN_SET, self._encode_pos(x0, x1)) - self._write(self._PAGE_SET, self._encode_pos(y0, y1)) + self.write(self._COLUMN_SET, self._encode_pos(x0, x1)) + self.write(self._PAGE_SET, self._encode_pos(y0, y1)) if data is None: size = struct.calcsize(self._DECODE_PIXEL) - return self._read(self._RAM_READ, - (x1 - x0 + 1) * (y1 - y0 + 1) * size) - self._write(self._RAM_WRITE, data) + return self.read(self._RAM_READ, + (x1 - x0 + 1) * (y1 - y0 + 1) * size) + self.write(self._RAM_WRITE, data) + return None + #pylint: enable-msg=invalid-name,too-many-arguments - def _encode_pos(self, a, b): + def _encode_pos(self, x, y): """Encode a postion into bytes.""" - return struct.pack(self._ENCODE_POS, a, b) + return struct.pack(self._ENCODE_POS, x, y) def _encode_pixel(self, color): """Encode a pixel color into bytes.""" @@ -75,24 +86,27 @@ def pixel(self, x, y, color=None): """Read or write a pixel.""" if color is None: return self._decode_pixel(self._block(x, y, x, y)) - if not 0 <= x < self.width or not 0 <= y < self.height: - return - self._block(x, y, x, y, self._encode_pixel(color)) + if 0 <= x < self.width and 0 <= y < self.height: + self._block(x, y, x, y, self._encode_pixel(color)) + return None + + #pylint: disable-msg=too-many-arguments def fill_rectangle(self, x, y, width, height, color): """Draw a filled rectangle.""" x = min(self.width - 1, max(0, x)) y = min(self.height - 1, max(0, y)) - w = min(self.width - x, max(1, width)) - h = min(self.height - y, max(1, height)) - self._block(x, y, x + w - 1, y + h - 1, b'') - chunks, rest = divmod(w * h, _BUFFER_SIZE) + width = min(self.width - x, max(1, width)) + height = min(self.height - y, max(1, height)) + self._block(x, y, x + width - 1, y + height - 1, b'') + chunks, rest = divmod(width * height, _BUFFER_SIZE) pixel = self._encode_pixel(color) if chunks: data = pixel * _BUFFER_SIZE - for count in range(chunks): - self._write(None, data) - self._write(None, pixel * rest) + for _ in range(chunks): + self.write(None, data) + self.write(None, pixel * rest) + #pylint: enable-msg=too-many-arguments def fill(self, color=0): """Fill whole screen.""" @@ -108,37 +122,43 @@ def vline(self, x, y, height, color): class DisplaySPI(Display): + """Base class for SPI type devices""" + #pylint: disable-msg=too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=1, height=1, baudrate=1000000, polarity=0, phase=0): self.spi_device = spi_device.SPIDevice(spi, cs, baudrate=baudrate, polarity=polarity, phase=phase) - self.dc = dc + self.dc_pin = dc self.rst = rst - self.dc.switch_to_output(value=0) + self.dc_pin.switch_to_output(value=0) if self.rst: self.rst.switch_to_output(value=0) self.reset() super().__init__(width, height) + #pylint: enable-msg=too-many-arguments def reset(self): + """Reset the device""" self.rst.value = 0 time.sleep(0.050) # 50 milliseconds self.rst.value = 1 time.sleep(0.050) # 50 milliseconds - def _write(self, command=None, data=None): + def write(self, command=None, data=None): + """SPI write to the device: commands and data""" if command is not None: - self.dc.value = 0 + self.dc_pin.value = 0 with self.spi_device as spi: spi.write(bytearray([command])) if data is not None: - self.dc.value = 1 + self.dc_pin.value = 1 with self.spi_device as spi: spi.write(data) - def _read(self, command=None, count=0): + def read(self, command=None, count=0): + """SPI read from device with optional command""" data = bytearray(count) - self.dc.value = 0 + self.dc_pin.value = 0 with self.spi_device as spi: if command is not None: spi.write(bytearray([command])) diff --git a/adafruit_rgb_display/s6d02a1.py b/adafruit_rgb_display/s6d02a1.py index 6bdd724..5709950 100644 --- a/adafruit_rgb_display/s6d02a1.py +++ b/adafruit_rgb_display/s6d02a1.py @@ -1,4 +1,10 @@ +"""A simple driver for the S6D02A1-based displays.""" + from adafruit_rgb_display.rgb import DisplaySPI +from micropython import const + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git" _SWRESET = const(0x01) _DISPON = const(0x29) @@ -12,7 +18,7 @@ class S6D02A1(DisplaySPI): """ - A simple driver for the ST7735-based displays. + A simple driver for the S6D02A1-based displays. >>> import busio >>> import digitalio @@ -20,7 +26,8 @@ class S6D02A1(DisplaySPI): >>> from adafruit_rgb_display import color565 >>> import adafruit_rgb_display.s6d02a1 as s6d02a1 >>> spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI, MISO=board.MISO) - >>> display = s6d02a1.S6D02A1(spi, cs=digitalio.DigitalInOut(board.GPIO0), dc=digitalio.DigitalInOut(board.GPIO15), rst=digitalio.DigitalInOut(board.GPIO16)) + >>> display = s6d02a1.S6D02A1(spi, cs=digitalio.DigitalInOut(board.GPIO0), + ... dc=digitalio.DigitalInOut(board.GPIO15), rst=digitalio.DigitalInOut(board.GPIO16)) >>> display.fill(0x7521) >>> display.pixel(64, 64, 0) """ @@ -38,5 +45,6 @@ class S6D02A1(DisplaySPI): _ENCODE_PIXEL = ">H" _ENCODE_POS = ">HH" + #pylint: disable-msg=useless-super-delegation, too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=128, height=160): super().__init__(spi, dc, cs, rst, width, height) diff --git a/adafruit_rgb_display/ssd1331.py b/adafruit_rgb_display/ssd1331.py index 4cc3a1c..fb918c4 100644 --- a/adafruit_rgb_display/ssd1331.py +++ b/adafruit_rgb_display/ssd1331.py @@ -99,7 +99,7 @@ def __init__(self, spi, dc, cs, rst=None, width=96, height=64): def write(self, command=None, data=None): """write procedure specific to SSD1331""" - self.dc.value = command is None + self.dc_pin.value = command is None with self.spi_device as spi: if command is not None: spi.write(bytearray([command])) diff --git a/adafruit_rgb_display/ssd1351.py b/adafruit_rgb_display/ssd1351.py index 0d8e6ca..f824921 100644 --- a/adafruit_rgb_display/ssd1351.py +++ b/adafruit_rgb_display/ssd1351.py @@ -1,5 +1,9 @@ +"""A simple driver for the SSD1351-based displays.""" from adafruit_rgb_display.rgb import DisplaySPI +from micropython import const +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git" _SETCOLUMN = const(0x15) _SETROW = const(0x75) @@ -44,7 +48,8 @@ class SSD1351(DisplaySPI): >>> from adafruit_rgb_display import color565 >>> import adafruit_rgb_display.ssd1351 as ssd1351 >>> spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI, MISO=board.MISO) - >>> display = ssd1351.SSD1351(spi, cs=digitalio.DigitalInOut(board.GPIO0), dc=digitalio.DigitalInOut(board.GPIO15), rst=digitalio.DigitalInOut(board.GPIO16)) + >>> display = ssd1351.SSD1351(spi, cs=digitalio.DigitalInOut(board.GPIO0), + ... dc=digitalio.DigitalInOut(board.GPIO15), rst=digitalio.DigitalInOut(board.GPIO16)) >>> display.fill(0x7521) >>> display.pixel(32, 32, 0) """ @@ -80,5 +85,6 @@ class SSD1351(DisplaySPI): _ENCODE_PIXEL = ">H" _ENCODE_POS = ">BB" + #pylint: disable-msg=useless-super-delegation, too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=128, height=128): super().__init__(spi, dc, cs, rst, width, height) diff --git a/adafruit_rgb_display/st7735.py b/adafruit_rgb_display/st7735.py index 748bed3..62cd9ec 100644 --- a/adafruit_rgb_display/st7735.py +++ b/adafruit_rgb_display/st7735.py @@ -1,55 +1,60 @@ +"""A simple driver for the ST7735-based displays.""" + from adafruit_rgb_display.rgb import DisplaySPI try: import struct except ImportError: import ustruct as struct - - -_NOP=const(0x00) -_SWRESET=const(0x01) -_RDDID=const(0x04) -_RDDST=const(0x09) - -_SLPIN=const(0x10) -_SLPOUT=const(0x11) -_PTLON=const(0x12) -_NORON=const(0x13) - -_INVOFF=const(0x20) -_INVON=const(0x21) -_DISPOFF=const(0x28) -_DISPON=const(0x29) -_CASET=const(0x2A) -_RASET=const(0x2B) -_RAMWR=const(0x2C) -_RAMRD=const(0x2E) - -_PTLAR=const(0x30) -_COLMOD=const(0x3A) -_MADCTL=const(0x36) - -_FRMCTR1=const(0xB1) -_FRMCTR2=const(0xB2) -_FRMCTR3=const(0xB3) -_INVCTR=const(0xB4) -_DISSET5=const(0xB6) - -_PWCTR1=const(0xC0) -_PWCTR2=const(0xC1) -_PWCTR3=const(0xC2) -_PWCTR4=const(0xC3) -_PWCTR5=const(0xC4) -_VMCTR1=const(0xC5) - -_RDID1=const(0xDA) -_RDID2=const(0xDB) -_RDID3=const(0xDC) -_RDID4=const(0xDD) - -_PWCTR6=const(0xFC) - -_GMCTRP1=const(0xE0) -_GMCTRN1=const(0xE1) +from micropython import const + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display.git" + +_NOP = const(0x00) +_SWRESET = const(0x01) +_RDDID = const(0x04) +_RDDST = const(0x09) + +_SLPIN = const(0x10) +_SLPOUT = const(0x11) +_PTLON = const(0x12) +_NORON = const(0x13) + +_INVOFF = const(0x20) +_INVON = const(0x21) +_DISPOFF = const(0x28) +_DISPON = const(0x29) +_CASET = const(0x2A) +_RASET = const(0x2B) +_RAMWR = const(0x2C) +_RAMRD = const(0x2E) + +_PTLAR = const(0x30) +_COLMOD = const(0x3A) +_MADCTL = const(0x36) + +_FRMCTR1 = const(0xB1) +_FRMCTR2 = const(0xB2) +_FRMCTR3 = const(0xB3) +_INVCTR = const(0xB4) +_DISSET5 = const(0xB6) + +_PWCTR1 = const(0xC0) +_PWCTR2 = const(0xC1) +_PWCTR3 = const(0xC2) +_PWCTR4 = const(0xC3) +_PWCTR5 = const(0xC4) +_VMCTR1 = const(0xC5) + +_RDID1 = const(0xDA) +_RDID2 = const(0xDB) +_RDID3 = const(0xDC) +_RDID4 = const(0xDD) + +_PWCTR6 = const(0xFC) + +_GMCTRP1 = const(0xE0) +_GMCTRN1 = const(0xE1) class ST7735(DisplaySPI): @@ -62,7 +67,8 @@ class ST7735(DisplaySPI): >>> from adafruit_rgb_display import color565 >>> import adafruit_rgb_display.st7735 as st7735 >>> spi = busio.SPI(clock=board.SCK, MOSI=board.MOSI, MISO=board.MISO) - >>> display = st7735.ST7735(spi, cs=digitalio.DigitalInOut(board.GPIO0), dc=digitalio.DigitalInOut(board.GPIO15), rst=digitalio.DigitalInOut(board.GPIO16)) + >>> display = st7735.ST7735(spi, cs=digitalio.DigitalInOut(board.GPIO0), + ... dc=digitalio.DigitalInOut(board.GPIO15), rst=digitalio.DigitalInOut(board.GPIO16)) >>> display.fill(0x7521) >>> display.pixel(64, 64, 0) """ @@ -98,11 +104,13 @@ class ST7735(DisplaySPI): _ENCODE_PIXEL = ">H" _ENCODE_POS = ">HH" + #pylint: disable-msg=useless-super-delegation, too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=128, height=128): super().__init__(spi, dc, cs, rst, width, height) class ST7735R(ST7735): + """A simple driver for the ST7735R-based displays.""" _INIT = ( (_SWRESET, None), (_SLPOUT, None), @@ -130,6 +138,7 @@ class ST7735R(ST7735): b'\x2E\x2E\x37\x3F\x00\x00\x02\x10'), ) + #pylint: disable-msg=useless-super-delegation, too-many-arguments def __init__(self, spi, dc, cs, rst=None, width=128, height=160): super().__init__(spi, dc, cs, rst, width, height) @@ -138,10 +147,9 @@ def init(self): cols = struct.pack('>HH', 0, self.width - 1) rows = struct.pack('>HH', 0, self.height - 1) for command, data in ( - (_CASET, cols), - (_RASET, rows), - - (_NORON, None), - (_DISPON, None), + (_CASET, cols), + (_RASET, rows), + (_NORON, None), + (_DISPON, None), ): - self._write(command, data) + self.write(command, data) diff --git a/examples/esp8266_tft_featherwing.py b/examples/esp8266_tft_featherwing.py index ae90050..9933fe4 100644 --- a/examples/esp8266_tft_featherwing.py +++ b/examples/esp8266_tft_featherwing.py @@ -5,7 +5,7 @@ import busio import digitalio -from board import * +from board import SCK, MOSI, MISO, GPIO0, GPIO15 from adafruit_rgb_display import color565 import adafruit_rgb_display.ili9341 as ili9341 @@ -34,6 +34,6 @@ # Pause 2 seconds. time.sleep(2) # Clear the screen blue. - display.fill(color565(0,0,255)) + display.fill(color565(0, 0, 255)) # Pause 2 seconds. time.sleep(2)