diff --git a/.gitignore b/.gitignore index 92d3065..73f174b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ __pycache__ _build *.pyc +.env +build* +bundles + diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..e274ba9 --- /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,i,j,k,n,ex,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=2 + + +[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 330d48e..f6243ea 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,53 +1,30 @@ -# Travis CI configuration for automated .mpy file generation. -# Author: Tony DiCola -# License: Public Domain -# This configuration will work with Travis CI (travis-ci.org) to automacially -# build .mpy files 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 -# that should be generated. 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! -# 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: - - "max7219.mpy" + file_glob: true + file: bundles/* skip_cleanup: true on: tags: true -before_install: -- sudo apt-get -yqq update -- sudo apt-get install -y build-essential git python python-pip -- git clone https://github.com/adafruit/micropython.git -- make -C micropython/mpy-cross -- export PATH=$PATH:$PWD/micropython/mpy-cross/ -- sudo pip install shyaml +install: + - pip install pylint circuitpython-build-tools -before_deploy: -- shyaml get-values deploy.file < .travis.yml | sed 's/.mpy/.py/' | xargs -L1 mpy-cross +script: + - pylint adafruit_max7219/*.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max7219 --library_location . diff --git a/adafruit_max7219/__init__.py b/adafruit_max7219/__init__.py index 8b13789..e69de29 100644 --- a/adafruit_max7219/__init__.py +++ b/adafruit_max7219/__init__.py @@ -1 +0,0 @@ - diff --git a/adafruit_max7219/bcddigits.py b/adafruit_max7219/bcddigits.py index 7c1ef70..3318c11 100644 --- a/adafruit_max7219/bcddigits.py +++ b/adafruit_max7219/bcddigits.py @@ -26,6 +26,10 @@ ==================================================== """ from adafruit_max7219 import max7219 +from micropython import const + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git" _DECODEMODE = const(9) _SCANLIMIT = const(11) @@ -40,93 +44,91 @@ class BCDDigits(max7219.MAX7219): def __init__(self, spi, cs, nDigits=1): """ :param object spi: an spi busio or spi bitbangio object - :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select signal + :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select + signal :param int nDigits: number of led 7-segment digits; default 1; max 8 """ - self.nD = nDigits - super().__init__(self.nD, 8 ,spi ,cs) + self._ndigits = nDigits + super().__init__(self._ndigits, 8, spi, cs) def init_display(self): - - for cmd, data in ( - (_SHUTDOWN, 0), - (_DISPLAYTEST, 0), - (_SCANLIMIT, 7), - (_DECODEMODE, (2**self.nD)-1), - (_SHUTDOWN, 1), - ): - self.write_cmd(cmd, data) + + for cmd, data in ((_SHUTDOWN, 0), + (_DISPLAYTEST, 0), + (_SCANLIMIT, 7), + (_DECODEMODE, (2**self._ndigits)-1), + (_SHUTDOWN, 1), + ): + self.write_cmd(cmd, data) self.clear_all() self.show() - def set_digit(self, d, v): + def set_digit(self, dpos, value): """ set one digit in the display - :param int d: the digit position; zero-based - :param int v: integer ranging from 0->15 + :param int dpos: the digit position; zero-based + :param int value: integer ranging from 0->15 """ - d = self.nD - d - 1 + dpos = self._ndigits - dpos - 1 for i in range(4): - #print('digit {} pixel {} value {}'.format(d,i+4,v & 0x01)) - self.pixel(d,i,v & 0x01) - v >>= 1 - - def set_digits(self, s, ds): + #print('digit {} pixel {} value {}'.format(dpos,i+4,v & 0x01)) + self.pixel(dpos, i, value & 0x01) + value >>= 1 + + def set_digits(self, start, values): """ set the display from a list :param int s: digit to start display zero-based :param list ds: list of integer values ranging from 0->15 """ - for d in ds: + for value in values: #print('set digit {} start {}'.format(d,start)) - self.set_digit(s,d) - s += 1 + self.set_digit(start, value) + start += 1 - def show_dot(self,d, col=None): + def show_dot(self, dpos, bit_value=None): """ set the decimal point for a digit - :param int d: the digit to set the decimal point zero-based - :param int col: value > zero lights the decimal point, else unlights the point + :param int dpos: the digit to set the decimal point zero-based + :param int value: value > zero lights the decimal point, else unlights the point """ - if d < self.nD and d >= 0: - #print('set dot {} = {}'.format((self.nD - d -1),col)) - self.pixel(self.nD-d-1, 7,col) + if dpos < self._ndigits and dpos >= 0: + #print('set dot {} = {}'.format((self._ndigits - d -1),col)) + self.pixel(self._ndigits-dpos-1, 7, bit_value) def clear_all(self): """ clear all digits and decimal points """ self.fill(1) - for i in range(self.nD): + for i in range(self._ndigits): self.show_dot(i) - def show_str(self,s,str): + def show_str(self, start, strg): """ displays a numeric str in the display. shows digits 0-9, -, and . - :param int s: start position to show the numeric string + :param int start: start position to show the numeric string :param string str: the numeric string """ - ci = s - for i in range (len(str)): - c = str[i] + cpos = start + for char in strg: # print('c {}'.format(c)) - v = 0x0f # assume blank - if c >= '0' and c<='9': - v = int(c) - elif c == '-': - v = 10 # minus sign - elif c == '.': - self.show_dot(ci-1,1) + value = 0x0f # assume blank + if char >= '0' and char <= '9': + value = int(char) + elif char == '-': + value = 10 # minus sign + elif char == '.': + self.show_dot(cpos-1, 1) continue - self.set_digit(ci,v) - ci += 1 - - def show_help(self, s): + self.set_digit(cpos, value) + cpos += 1 + + def show_help(self, start): """ display the word HELP in the display - :param int s: start position to show HELP + :param int start: start position to show HELP """ - digits = [12,11,13,14] - self.set_digits(s,digits) - + digits = [12, 11, 13, 14] + self.set_digits(start, digits) diff --git a/adafruit_max7219/matrices.py b/adafruit_max7219/matrices.py index 333d2ad..b22700b 100644 --- a/adafruit_max7219/matrices.py +++ b/adafruit_max7219/matrices.py @@ -26,6 +26,10 @@ ==================================================== """ from adafruit_max7219 import max7219 +from micropython import const + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git" _DECODEMODE = const(9) _SCANLIMIT = const(11) @@ -33,35 +37,36 @@ _DISPLAYTEST = const(15) class Matrix8x8(max7219.MAX7219): + """Driver for a 8x8 LED matrix based on the MAX7219 chip""" def __init__(self, spi, cs): """ :param object spi: an spi busio or spi bitbangio object :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select signal """ - super().__init__(8,8,spi,cs) + super().__init__(8, 8, spi, cs) def init_display(self): - for cmd, data in ( - (_SHUTDOWN, 0), - (_DISPLAYTEST, 0), - (_SCANLIMIT, 7), - (_DECODEMODE, 0), - (_SHUTDOWN, 1), - ): + for cmd, data in ((_SHUTDOWN, 0), + (_DISPLAYTEST, 0), + (_SCANLIMIT, 7), + (_DECODEMODE, 0), + (_SHUTDOWN, 1), + ): self.write_cmd(cmd, data) self.fill(0) self.show() - def text(self, str, x, y, col=1): + def text(self, strg, xpos, ypos, bit_value=1): """ draw text in the 8x8 matrix. - :param int x: x position of LED in matrix - :param int y: y position of LED in matrix - :param string str: string to place in to display + :param int xpos: x position of LED in matrix + :param int ypos: y position of LED in matrix + :param string strg: string to place in to display + :param bit_value: > 1 sets the text, otherwise resets """ - self.framebuf.text(str, x, y, col) + self.framebuf.text(strg, xpos, ypos, bit_value) def clear_all(self): """ diff --git a/adafruit_max7219/max7219.py b/adafruit_max7219/max7219.py index f32173f..a95ad5f 100644 --- a/adafruit_max7219/max7219.py +++ b/adafruit_max7219/max7219.py @@ -23,7 +23,7 @@ `adafruit_max7219.MAX7219` - MAX7219 LED Matrix/Digit Display Driver ======================================================================== CircuitPython library to support MAX7219 LED Matrix/Digit Display Driver. -This library supports the use of the MAX7219-based display in CircuitPython, +This library supports the use of the MAX7219-based display in CircuitPython, either an 8x8 matrix or a 8 digit 7-segment numeric display. see also @@ -38,9 +38,11 @@ Implementation Notes -------------------- **Hardware:** -* Adafruit `MAX7219CNG LED Matrix/Digit Display Driver - MAX7219 `_ (Product ID: 453) +* Adafruit `MAX7219CNG LED Matrix/Digit Display Driver - +MAX7219 `_ (Product ID: 453) **Software and Dependencies:** -* Adafruit CircuitPython firmware (1.0.0+) for the ESP8622 and M0-based boards: https://github.com/adafruit/circuitpython/releases +* Adafruit CircuitPython firmware (1.0.0+) for the ESP8622 and M0-based boards: +https://github.com/adafruit/circuitpython/releases * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice **Notes:** #. Datasheet: https://cdn-shop.adafruit.com/datasheets/MAX7219.pdf @@ -50,6 +52,10 @@ import digitalio from adafruit_bus_device import spi_device +from micropython import const + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git" # register definitions _DIGIT0 = const(1) @@ -57,66 +63,77 @@ class MAX7219: - - def __init__(self, w, h, spi, cs, + """ MAX2719 - driver for displays based on max719 chip_select""" + def __init__(self, width, height, spi, cs, *, baudrate=8000000, polarity=0, phase=0): """ - :param int w: the number of pixels wide - :param int h: the number of pixels high + :param int width: the number of pixels wide + :param int height: the number of pixels high :param object spi: an spi busio or spi bitbangio object - :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select signal + :param ~digitalio.DigitalInOut chip_select: digital in/out to use as chip select signal + :param baudrate: for SPIDevice baudrate (default 8000000) + :param polarity: for SPIDevice polarity (default 0) + :param phase: for SPIDevice phase (default 0) """ - - self.cs = cs - self.cs.direction = digitalio.Direction.OUTPUT - - self.spiDevice = spi_device.SPIDevice(spi, cs, baudrate=baudrate, - polarity=polarity, phase=phase) - - self.buffer = bytearray((h // 8) * w) - self.framebuf = framebuf.FrameBuffer1(self.buffer, w, h) - - self.w = w - self.h = h + + self._chip_select = cs + self._chip_select.direction = digitalio.Direction.OUTPUT + + self._spi_device = spi_device.SPIDevice(spi, cs, baudrate=baudrate, + polarity=polarity, phase=phase) + + self._buffer = bytearray((height // 8) * width) + self.framebuf = framebuf.FrameBuffer1(self._buffer, width, height) + + self.width = width + self.height = height self.init_display() + def init_display(self): + """must be implement by derived class""" + pass + def brightness(self, value): """ control the brightness of the display :param int value: 0->15 dimmest to brightest """ - if not 0<= value <= 15: + if not 0 <= value <= 15: raise ValueError("Brightness out of range") self.write_cmd(_INTENSITY, value) def show(self): """ - update the display with recent changes in buffer + update the display with recent changes in buffer """ - for y in range(8): - self.write_cmd(_DIGIT0 + y, self.buffer[y]) + for ypos in range(8): + self.write_cmd(_DIGIT0 + ypos, self._buffer[ypos]) - def fill(self, col): + def fill(self, bit_value): """ set all buffer bits to a col - :param int col: value > 0 set the buffer bit, else clears the buffer bit + :param bit_value: int value > 0 set the buffer bit, else clears the buffer bit """ - self.framebuf.fill(col) + self.framebuf.fill(bit_value) - def pixel(self, x, y, col=None): + def pixel(self, xpos, ypos, bit_value=None): """ set one buffer bit - :param int col: value > 0 set the buffer bit, else clears the buffer bit + :param xpos: x position to set bit + :param ypos: y position to set bit + :param bit_value: int value > 0 sets the buffer bit, else clears the buffer bit """ - col = 0x01 if col else 0x00 - self.framebuf.pixel(x, y, col) + bit_value = 0x01 if bit_value else 0x00 + self.framebuf.pixel(xpos, ypos, bit_value) + + def scroll(self, delta_x, delta_y): + """scolls the display using delta_x,delta_y""" + self.framebuf.scroll(delta_x, delta_y) - def scroll(self, dx, dy): - self.framebuf.scroll(dx, dy) - def write_cmd(self, cmd, data): + """writes a command to spi device""" #print('cmd {} data {}'.format(cmd,data)) - self.cs.value = False - with self.spiDevice as spiDevice: - spiDevice.write(bytearray([cmd, data])) + self._chip_select.value = False + with self._spi_device as my_spi_device: + my_spi_device.write(bytearray([cmd, data]))