diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,66 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal - twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 6d0015a..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,85 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 9647e71..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,48 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 43d1385..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black - rev: 20.8b1 + - repo: https://github.com/python/black + rev: 23.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v1.1.2 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: v2.11.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint + rev: v2.17.4 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - - --disable=consider-using-f-string,duplicate-code + - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code diff --git a/.pylintrc b/.pylintrc index cfd1c41..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --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,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ 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 @@ -252,43 +246,27 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [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_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # 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_]*))$ @@ -309,21 +284,12 @@ 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]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # 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_]*))$ @@ -433,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..88bca9f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-20.04 + tools: + python: "3" + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt diff --git a/README.rst b/README.rst index 1eb7686..cc86400 100644 --- a/README.rst +++ b/README.rst @@ -3,10 +3,10 @@ Introduction ============ .. image :: https://readthedocs.org/projects/adafruit-circuitpython-max7219/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/max7219/en/latest/ + :target: https://docs.circuitpython.org/projects/max7219/en/latest/ :alt: Documentation Status -.. image :: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord @@ -14,6 +14,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_MAX7219/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + CircuitPython driver for the MAX7219 LED matrix driver chip. See `here `_ for the equivalent MicroPython driver. @@ -49,74 +53,21 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-max7219 Usage Example ============= -adafruit_max7219.Matrix8x8 Example ----------------------------------- - -.. code-block:: python - - from adafruit_max7219 import matrices - from board import TX, RX, A2 - import busio - import digitalio - import time - - clk = RX - din = TX - cs = digitalio.DigitalInOut(A2) - - spi = busio.SPI(clk, MOSI=din) - display = matrices.Matrix8x8(spi, cs) - while True: - display.brightness(3) - - display.fill(1) - display.pixel(3, 3) - display.pixel(3, 4) - display.pixel(4, 3) - display.pixel(4, 4) - display.show() - time.sleep(3.0) - - display.clear_all() - s = 'Hello, World!' - for c in range(len(s)*8): - display.fill(0) - display.text(s,-c,0) - display.show() - time.sleep(0.25) - - -adafruit_max7219.BCDDigits Example ----------------------------------- - -.. code-block:: python - - from adafruit_max7219 import bcddigits - from board import TX, RX, A2 - import bitbangio - import digitalio - - clk = RX - din = TX - cs = digitalio.DigitalInOut(A2) - - spi = bitbangio.SPI(clk, MOSI=din) - display = bcddigits.BCDDigits(spi, cs, nDigits=8) - display.clear_all() - display.show_str(0,'{:9.2f}'.format(-1234.56)) - display.show() +See the ``examples/`` folder example uses of this library. Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ @@ -124,8 +75,3 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. diff --git a/adafruit_max7219/bcddigits.py b/adafruit_max7219/bcddigits.py index 19749f5..cb00441 100644 --- a/adafruit_max7219/bcddigits.py +++ b/adafruit_max7219/bcddigits.py @@ -17,7 +17,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git" _DECODEMODE = const(9) @@ -41,12 +41,11 @@ def __init__(self, spi: busio.SPI, cs: digitalio.DigitalInOut, nDigits: int = 1) super().__init__(self._ndigits, 8, spi, cs) def init_display(self) -> None: - for cmd, data in ( (_SHUTDOWN, 0), (_DISPLAYTEST, 0), (_SCANLIMIT, 7), - (_DECODEMODE, (2 ** self._ndigits) - 1), + (_DECODEMODE, (2**self._ndigits) - 1), (_SHUTDOWN, 1), ): self.write_cmd(cmd, data) diff --git a/adafruit_max7219/matrices.py b/adafruit_max7219/matrices.py index e1b0d5d..3294688 100644 --- a/adafruit_max7219/matrices.py +++ b/adafruit_max7219/matrices.py @@ -1,23 +1,25 @@ # SPDX-FileCopyrightText: 2017 Dan Halbert for Adafruit Industries +# SPDX-FileCopyrightText: 2021 Daniel Flanagan # # SPDX-License-Identifier: MIT """ -`adafruit_max7219.matrices.Matrix8x8` +`adafruit_max7219.matrices` ==================================================== """ from micropython import const +from adafruit_framebuf import BitmapFont from adafruit_max7219 import max7219 try: # Used only for typing - import typing # pylint: disable=unused-import + from typing import Tuple import digitalio import busio except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git" _DECODEMODE = const(9) @@ -50,7 +52,15 @@ def init_display(self) -> None: self.fill(0) self.show() - def text(self, strg: str, xpos: int, ypos: int, bit_value: int = 1) -> None: + def text( + self, + strg: str, + xpos: int, + ypos: int, + bit_value: int = 1, + *, + font_name: str = "font5x8.bin" + ) -> None: """ Draw text in the 8x8 matrix. @@ -58,11 +68,236 @@ def text(self, strg: str, xpos: int, ypos: int, bit_value: int = 1) -> None: :param int xpos: x position of LED in matrix :param int ypos: y position of LED in matrix :param int bit_value: > 1 sets the text, otherwise resets + :param str font_name: path to binary font file (default: "font5x8.bin"). + The font can only be set once, if you want a different font you must + re-initialize the matrix. """ - self.framebuf.text(strg, xpos, ypos, bit_value) + self.framebuf.text(strg, xpos, ypos, bit_value, font_name=font_name) def clear_all(self) -> None: """ Clears all matrix leds. """ self.fill(0) + + +class CustomMatrix(max7219.ChainableMAX7219): + """ + Driver for a custom 8x8 LED matrix constellation based on daisy chained MAX7219 chips. + + :param ~busio.SPI spi: an spi busio or spi bitbangio object + :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select signal + :param int width: the number of pixels wide + :param int height: the number of pixels high + :param int rotation: the number of times to rotate the coordinate system (default 1) + """ + + def __init__( + self, + spi: busio.SPI, + cs: digitalio.DigitalInOut, + width: int, + height: int, + *, + rotation: int = 1 + ): + super().__init__(width, height, spi, cs) + + self.y_offset = width // 8 + self.y_index = self._calculate_y_coordinate_offsets() + + self.framebuf.rotation = rotation + self.framebuf.fill_rect = self._fill_rect + self._font = None + + def _calculate_y_coordinate_offsets(self) -> None: + y_chunks = [] + for _ in range(self.chain_length // (self.width // 8)): + y_chunks.append([]) + chunk = 0 + chunk_size = 0 + for index in range(self.chain_length * 8): + y_chunks[chunk].append(index) + chunk_size += 1 + if chunk_size >= (self.width // 8): + chunk_size = 0 + chunk += 1 + if chunk >= len(y_chunks): + chunk = 0 + + y_index = [] + for chunk in y_chunks: + y_index += chunk + return y_index + + def init_display(self) -> None: + 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 clear_all(self) -> None: + """ + Clears all matrix leds. + """ + self.fill(0) + + # pylint: disable=inconsistent-return-statements + def pixel(self, xpos: int, ypos: int, bit_value: int = None) -> None: + """ + Set one buffer bit + + :param int xpos: x position to set bit + :param int ypos: y position to set bit + :param int bit_value: value > 0 sets the buffer bit, else clears the buffer bit + """ + if xpos < 0 or ypos < 0 or xpos >= self.width or ypos >= self.height: + return + buffer_x, buffer_y = self._pixel_coords_to_framebuf_coords(xpos, ypos) + return super().pixel(buffer_x, buffer_y, bit_value=bit_value) + + def _pixel_coords_to_framebuf_coords(self, xpos: int, ypos: int) -> Tuple[int]: + """ + Convert matrix pixel coordinates into coordinates in the framebuffer + + :param int xpos: x position + :param int ypos: y position + :return: framebuffer coordinates (x, y) + :rtype: Tuple[int] + """ + return (xpos - ((xpos // 8) * 8)) % 8, xpos // 8 + self.y_index[ + ypos * self.y_offset + ] + + def _get_pixel(self, xpos: int, ypos: int) -> int: + """ + Get value of a matrix pixel + + :param int xpos: x position + :param int ypos: y position + :return: value of pixel in matrix + :rtype: int + """ + x, y = self._pixel_coords_to_framebuf_coords(xpos, ypos) + buffer_value = self._buffer[-1 * y - 1] + return ((buffer_value & 2**x) >> x) & 1 + + # Adafruit Circuit Python Framebuf Scroll Function + # Authors: Kattni Rembor, Melissa LeBlanc-Williams and Tony DiCola, for Adafruit Industries + # License: MIT License (https://opensource.org/licenses/MIT) + def scroll(self, delta_x: int, delta_y: int) -> None: + """ + Srcolls the display using delta_x, delta_y. + + :param int delta_x: positions to scroll in the x direction + :param int delta_y: positions to scroll in the y direction + """ + if delta_x < 0: + shift_x = 0 + xend = self.width + delta_x + dt_x = 1 + else: + shift_x = self.width - 1 + xend = delta_x - 1 + dt_x = -1 + if delta_y < 0: + y = 0 + yend = self.height + delta_y + dt_y = 1 + else: + y = self.height - 1 + yend = delta_y - 1 + dt_y = -1 + while y != yend: + x = shift_x + while x != xend: + self.pixel(x, y, self._get_pixel(x - delta_x, y - delta_y)) + x += dt_x + y += dt_y + + def rect( + self, x: int, y: int, width: int, height: int, color: int, fill: bool = False + ) -> None: + """ + Draw a rectangle at the given position of the given size, color, and fill. + + :param int x: x position + :param int y: y position + :param int width: width of rectangle + :param int height: height of rectangle + :param int color: color of rectangle + :param bool fill: 1 pixel outline or filled rectangle (default: False) + """ + # pylint: disable=too-many-arguments + for row in range(height): + y_pos = row + y + for col in range(width): + x_pos = col + x + if fill: + self.pixel(x_pos, y_pos, color) + elif y_pos in (y, y + height - 1) or x_pos in (x, x + width - 1): + self.pixel(x_pos, y_pos, color) + else: + continue + + def _fill_rect(self, x: int, y: int, width: int, height: int, color: int) -> None: + """ + Draw a filled rectangle at the given position of the given size, color. + + :param int x: x position + :param int y: y position + :param int width: width of rectangle + :param int height: height of rectangle + :param int color: color of rectangle + """ + # pylint: disable=too-many-arguments + return self.rect(x, y, width, height, color, True) + + # Adafruit Circuit Python Framebuf Text Function + # Authors: Kattni Rembor, Melissa LeBlanc-Williams and Tony DiCola, for Adafruit Industries + # License: MIT License (https://opensource.org/licenses/MIT) + def text( + self, + strg: str, + xpos: int, + ypos: int, + color: int = 1, + *, + font_name: str = "font5x8.bin", + size: int = 1 + ) -> None: + """ + Draw text in the matrix. + + :param str strg: 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 int color: > 1 sets the text, otherwise resets + :param str font_name: path to binary font file (default: "font5x8.bin") + :param int size: size of the font, acts as a multiplier + """ + for chunk in strg.split("\n"): + if not self._font or self._font.font_name != font_name: + # load the font! + self._font = BitmapFont(font_name) + width = self._font.font_width + height = self._font.font_height + for i, char in enumerate(chunk): + char_x = xpos + (i * (width + 1)) * size + if ( + char_x + (width * size) > 0 + and char_x < self.width + and ypos + (height * size) > 0 + and ypos < self.height + ): + self._font.draw_char( + char, char_x, ypos, self.framebuf, color, size=size + ) + ypos += height * size diff --git a/adafruit_max7219/max7219.py b/adafruit_max7219/max7219.py index 57837db..cf505b9 100644 --- a/adafruit_max7219/max7219.py +++ b/adafruit_max7219/max7219.py @@ -1,5 +1,6 @@ # SPDX-FileCopyrightText: 2016 Philip R. Moyer for Adafruit Industries # SPDX-FileCopyrightText: 2016 Radomir Dopieralski for Adafruit Industries +# SPDX-FileCopyrightText: 2021 Daniel Flanagan # # SPDX-License-Identifier: MIT @@ -13,6 +14,7 @@ See Also ========= * matrices.Maxtrix8x8 is a class support an 8x8 led matrix display +* matrices.CustomMatrix is a class support a custom sized constellation of 8x8 led matrix displays * bcddigits.BCDDigits is a class that support the 8 digit 7-segment display Beware that most CircuitPython compatible hardware are 3.3v logic level! Make @@ -50,7 +52,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git" # register definitions @@ -60,7 +62,7 @@ class MAX7219: """ - MAX2719 - driver for displays based on max719 chip_select + MAX7219 - driver for displays based on max7219 chip_select :param int width: the number of pixels wide :param int height: the number of pixels high @@ -76,13 +78,12 @@ def __init__( width: int, height: int, spi: busio.SPI, - cs: digitalio.DigitalInOut, + cs: digitalio.DigitalInOut, # pylint: disable=invalid-name *, baudrate: int = 8000000, polarity: int = 0, phase: int = 0 ): - self._chip_select = cs self._chip_select.direction = digitalio.Direction.OUTPUT @@ -157,3 +158,66 @@ def write_cmd(self, cmd: int, data: int) -> None: self._chip_select.value = False with self._spi_device as my_spi_device: my_spi_device.write(bytearray([cmd, data])) + + +class ChainableMAX7219(MAX7219): + """ + Daisy Chainable MAX7219 - driver for cascading displays based on max7219 chip_select + + :param int width: the number of pixels wide + :param int height: the number of pixels high + :param ~busio.SPI spi: an spi busio or spi bitbangio object + :param ~digitalio.DigitalInOut chip_select: digital in/out to use as chip select signal + :param int baudrate: for SPIDevice baudrate (default 8000000) + :param int polarity: for SPIDevice polarity (default 0) + :param int phase: for SPIDevice phase (default 0) + """ + + def __init__( + self, + width: int, + height: int, + spi: busio.SPI, + cs: digitalio.DigitalInOut, + *, + baudrate: int = 8000000, + polarity: int = 0, + phase: int = 0 + ): + self.chain_length = (height // 8) * (width // 8) + + super().__init__( + width, height, spi, cs, baudrate=baudrate, polarity=polarity, phase=phase + ) + self._buffer = bytearray(self.chain_length * 8) + self.framebuf = framebuf.FrameBuffer1(self._buffer, self.chain_length * 8, 8) + + def write_cmd(self, cmd: int, data: int) -> None: + """ + Writes a command to spi device. + + :param int cmd: register address to write data to + :param int data: data to be written to commanded register + """ + # print('cmd {} data {}'.format(cmd,data)) + self._chip_select.value = False + with self._spi_device as my_spi_device: + for _ in range(self.chain_length): + my_spi_device.write(bytearray([cmd, data])) + + def show(self) -> None: + """ + Updates the display. + """ + for ypos in range(8): + self._chip_select.value = False + with self._spi_device as my_spi_device: + for chip in range(self.chain_length): + my_spi_device.write( + bytearray( + [ + _DIGIT0 + ypos, + self._buffer[ypos * self.chain_length + chip], + ] + ) + ) diff --git a/docs/api.rst b/docs/api.rst index 90c64dc..995ba9d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -3,6 +3,7 @@ .. automodule:: adafruit_max7219.max7219 :members: + :show-inheritance: .. automodule:: adafruit_max7219.matrices :members: diff --git a/docs/conf.py b/docs/conf.py index cc6a713..a6fc869 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) @@ -16,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", ] @@ -24,14 +26,15 @@ # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. autodoc_mock_imports = ["framebuf"] +autodoc_member_order = "bysource" intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), + "python": ("https://docs.python.org/3", None), "BusDevice": ( - "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + "https://docs.circuitpython.org/projects/busdevice/en/latest/", None, ), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. @@ -44,7 +47,14 @@ # General information about the project. project = "Adafruit MAX7219 Library" -copyright = "2017, Adafruit CiruitPython and Bundle contributors" +creation_year = "2017" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Adafruit CiruitPython and Bundle contributors" author = "Michael McWethy" # The version info for the project you're documenting, acts as replacement for @@ -61,7 +71,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -92,19 +102,9 @@ # 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" - -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(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # 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, diff --git a/docs/examples.rst b/docs/examples.rst index 9d6e998..66ab429 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -10,3 +10,7 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/max7219_showbcddigits.py :caption: examples/max7219_showbcddigits.py :linenos: + +.. literalinclude:: ../examples/max7219_custommatrixtest.py + :caption: examples/max7219_custommatrixtest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 1fff48a..2005853 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,8 +32,9 @@ Table of Contents .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/max7219_custommatrixtest.py b/examples/max7219_custommatrixtest.py new file mode 100644 index 0000000..2a390f2 --- /dev/null +++ b/examples/max7219_custommatrixtest.py @@ -0,0 +1,61 @@ +# SPDX-FileCopyrightText: 2021 Daniel Flanagan +# SPDX-License-Identifier: MIT + +import time +import board +import digitalio +from adafruit_max7219 import matrices + + +# You may need to change the chip select pin depending on your wiring +spi = board.SPI() +cs = digitalio.DigitalInOut(board.D4) + +matrix = matrices.CustomMatrix(spi, cs, 32, 8) +while True: + print("Cycle Start") + # all lit up + matrix.fill(True) + matrix.show() + time.sleep(0.5) + + # all off + matrix.fill(False) + matrix.show() + time.sleep(0.5) + + # snake across panel + for y in range(8): + for x in range(32): + if not y % 2: + matrix.pixel(x, y, 1) + else: + matrix.pixel(31 - x, y, 1) + matrix.show() + time.sleep(0.05) + + # show a string one character at a time + adafruit = "Adafruit" + matrix.fill(0) + for i, char in enumerate(adafruit[:3]): + matrix.text(char, i * 6, 0) + matrix.show() + time.sleep(1.0) + matrix.fill(0) + for i, char in enumerate(adafruit[3:]): + matrix.text(char, i * 6, 0) + matrix.show() + time.sleep(1.0) + + # scroll the last character off the display + for i in range(32): + matrix.scroll(-1, 0) + matrix.show() + time.sleep(0.25) + + # scroll a string across the display + for pixel_position in range(len(adafruit) * 8): + matrix.fill(0) + matrix.text(adafruit, -pixel_position, 0) + matrix.show() + time.sleep(0.25) diff --git a/examples/max7219_showbcddigits.py b/examples/max7219_showbcddigits.py index cb84981..b7979aa 100644 --- a/examples/max7219_showbcddigits.py +++ b/examples/max7219_showbcddigits.py @@ -3,16 +3,14 @@ import time import random -from board import TX, RX, A1 -import busio +import board import digitalio from adafruit_max7219 import bcddigits -mosi = TX -clk = RX -cs = digitalio.DigitalInOut(A1) -spi = busio.SPI(clk, MOSI=mosi) +# You may need to change the chip select pin depending on your wiring +spi = board.SPI() +cs = digitalio.DigitalInOut(board.D4) leds = bcddigits.BCDDigits(spi, cs, nDigits=8) while True: diff --git a/examples/max7219_simpletest.py b/examples/max7219_simpletest.py index 0d4f5df..251967e 100644 --- a/examples/max7219_simpletest.py +++ b/examples/max7219_simpletest.py @@ -2,16 +2,14 @@ # SPDX-License-Identifier: MIT import time -from board import TX, RX, A1 -import busio +import board import digitalio from adafruit_max7219 import matrices -mosi = TX -clk = RX -cs = digitalio.DigitalInOut(A1) -spi = busio.SPI(clk, MOSI=mosi) +# You may need to change the chip select pin depending on your wiring +spi = board.SPI() +cs = digitalio.DigitalInOut(board.D4) matrix = matrices.Matrix8x8(spi, cs) while True: diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..23f6ed3 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-max7219" +description = "CircuitPython library for MAX7219 LED matrix driver." +version = "0.0.0+auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219"} +keywords = [ + "adafruit", + "max7219", + "LED", + "matrix", + "breakout", + "hardware", + "micropython", + "circuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_max7219"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 32df5a7..22f317d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/setup.py b/setup.py deleted file mode 100644 index 46d40bc..0000000 --- a/setup.py +++ /dev/null @@ -1,56 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -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: - long_description = f.read() - -setup( - name="adafruit-circuitpython-max7219", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for MAX7219 LED matrix driver.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_MAX7219", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"], - # Choose your license - 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", - ], - # What does your project relate to? - keywords="adafruit max7219 LED matrix breakout hardware micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - packages=["adafruit_max7219"], -)