diff --git a/.hgignore b/.hgignore deleted file mode 100644 index 4a609f6..0000000 --- a/.hgignore +++ /dev/null @@ -1,14 +0,0 @@ -syntax: glob -*.pyc -*~ -.*.swp -docs/_build/* -build/* -dist/* -bin/* -lib/* -include/* -local -*.egg-info -cache/* -*.DS_Store diff --git a/.pylintrc b/.pylintrc index e274ba9..81d8170 100644 --- a/.pylintrc +++ b/.pylintrc @@ -119,7 +119,8 @@ spelling-store-unknown-words=no [MISCELLANEOUS] # List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO +# notes=FIXME,XXX,TODO +notes=FIXME,XXX [TYPECHECK] @@ -300,7 +301,7 @@ 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,_ +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 @@ -422,7 +423,7 @@ max-returns=6 max-statements=50 # Minimum number of public methods for a class (see R0903). -min-public-methods=2 +min-public-methods=1 [EXCEPTIONS] diff --git a/.travis.yml b/.travis.yml index f6243ea..883fd7f 100644 --- a/.travis.yml +++ b/.travis.yml @@ -18,6 +18,7 @@ deploy: file_glob: true file: bundles/* skip_cleanup: true + overwrite: true on: tags: true @@ -26,5 +27,5 @@ install: script: - pylint adafruit_max7219/*.py - - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/*.py) + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max7219 --library_location . diff --git a/LICENSE b/LICENSE index 44bba11..f72e5ef 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2016 Radomir Dopieralski +Copyright (c) 2017 Radomir Dopieralski, Michael McWethy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.rst b/README.rst index 00d0126..c13d03f 100644 --- a/README.rst +++ b/README.rst @@ -6,10 +6,6 @@ Introduction :target: https://circuitpython.readthedocs.io/projects/max7219/en/latest/ :alt: Documentation Status -.. image :: https://badges.gitter.im/adafruit/circuitpython.svg - :target: https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge - :alt: Gitter - .. image :: https://img.shields.io/discord/327254708534116352.svg :target: https://adafru.it/discord :alt: Discord @@ -91,6 +87,13 @@ adafruit_max7219.BCDDigits Example display.show_str(0,'{:9.2f}'.format(-1234.56)) display.show() +API Reference +============= + +.. toctree:: + :maxdepth: 2 + + api Contributing ============ @@ -99,10 +102,26 @@ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. -API Reference -============= +Building locally +================ -.. toctree:: - :maxdepth: 2 +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. - api +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install circuitpython-build-tools + +Once installed, make sure you are in the virtual environment: + +.. code-block:: shell + + source .env/bin/activate + +Then run the build: + +.. code-block:: shell + + circuitpython-build-bundles --filename_prefix adafruit-circuitpython-max7219 --library_location . diff --git a/api.rst b/api.rst index 04e7798..daac829 100644 --- a/api.rst +++ b/api.rst @@ -3,104 +3,13 @@ Module classes ============== Matrices -******** +++++++++ .. module:: adafruit_max7219.matrices - -.. class:: Matrix8x8(spi, cs) - - Driver for a single MAX7219-based 8x8 LED matrix. - - :param object spi: an spi busio or spi bitbangio object - :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select signal - - .. method:: brightness(value) - - control the brightness of the display - - :param int value: 0->15 dimmest to brightest - - .. method:: fill(color) - - Fill the whole matrix with a specified color. - - :param int color: None or False or 0 turn LED off, anything else turns LED on - - .. method:: pixel(x, y, color=None) - - Set the color of a single pixel. - - :param int x: x postiion of LED in matrix - :param int y: y position of LED in matrix - :param int color: value > zero lights the decimal point, else unlights the point - - .. method:: text(x, y, str) - - Position and set text on display; used for text scrolling - - :param int x: x postiion of LED in matrix - :param int y: y position of LED in matrix - :param string str: string to place in to display - - .. method:: clear_all() - - sets all leds to off; same as fill(0) - - .. method:: show() - - Update the display. - + :members: BCDDigits -********* - -.. module:: adafruit_max7219.bcddigits - -.. class:: BCDDigits(spi, cs, nDigits=1) - - Driver for one to 8 MAX7219-based 7-Segment LED display. - - :param object spi: an spi busio or spi bitbangio object - :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 - - .. method:: set_digit(d, v) - - set one digit in the display - - :param int d: the digit position; zero-based - :param int v: integer ranging from 0->15 - - .. method:: show_dot(d, col=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 - - .. method:: show_str(s,str) - - displays a numeric str in the display. shows digits 0-9, -, and . - - :param int s: start position to show the numeric string - :param string str: the numeric string - - .. method:: show_help(s) - - display the word HELP in the display - - :param int s: start position to show HELP - - .. method:: brightness(value) - - control the brightness of the display - - :param int value: 0->15 dimmest to brightest - - .. method:: clear_all() - - sets all leds to off - - .. method:: show() ++++++++++ - Update the display. +.. module:: adafruit_max7219.bcddigits.py + :members diff --git a/conf.py b/conf.py index b35cc39..84a3ade 100644 --- a/conf.py +++ b/conf.py @@ -15,6 +15,11 @@ 'sphinx.ext.viewcode', ] +# Uncomment the below if you use native CircuitPython modules such as +# 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 = ["digitalio", "busio"] + intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} # Add any paths that contain templates here, relative to this directory. diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 7c031a9..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,177 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = _build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext - -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - -clean: - rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/AdafruitMAX7219.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/AdafruitMAX7219.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/AdafruitMAX7219" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/AdafruitMAX7219" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index 53e33a4..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,260 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Adafruit MAX7219 documentation build configuration file, created by -# sphinx-quickstart on Wed Oct 19 11:56:51 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.viewcode', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Adafruit MAX7219' -copyright = u'2017, Adafruit CiruitPython and Bundle contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '1.0' -# The full version, including alpha/beta/rc tags. -release = '1.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ['_build'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'default' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitMAX7219doc' - - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'AdafruitMAX7219.tex', u'Adafruit MAX7219 Documentation', - u'Michael McWethy', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'adafruitmax7219', u'Adafruit MAX7219 Documentation', - [u'Michael McWethy'], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'AdafruitMAX7219', u'Adafruit MAX7219 Documentation', - u'Michael McWethy', 'AdafruitMAX7219', 'Python driver classes for MAX7219 chip.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False diff --git a/docs/examples.rst b/docs/examples.rst deleted file mode 100644 index d925767..0000000 --- a/docs/examples.rst +++ /dev/null @@ -1,61 +0,0 @@ -Examples -******** - -For software SPI:: - -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) - - -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() diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 4b57392..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. Adafruit MAX7219 documentation master file, created by - sphinx-quickstart on Wed Oct 19 11:56:51 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Adafruit MAX7219's documentation! -============================================ - -Contents: - -.. toctree:: - :maxdepth: 2 - - matrix - examples - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index a8d55b5..0000000 --- a/docs/make.bat +++ /dev/null @@ -1,242 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=_build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . -set I18NSPHINXOPTS=%SPHINXOPTS% . -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\AdafruitMAX7219.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\AdafruitMAX7219.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %BUILDDIR%/.. - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -:end diff --git a/docs/matrix.rst b/docs/matrix.rst deleted file mode 100644 index 04e7798..0000000 --- a/docs/matrix.rst +++ /dev/null @@ -1,106 +0,0 @@ - -Module classes -============== - -Matrices -******** - -.. module:: adafruit_max7219.matrices - -.. class:: Matrix8x8(spi, cs) - - Driver for a single MAX7219-based 8x8 LED matrix. - - :param object spi: an spi busio or spi bitbangio object - :param ~digitalio.DigitalInOut cs: digital in/out to use as chip select signal - - .. method:: brightness(value) - - control the brightness of the display - - :param int value: 0->15 dimmest to brightest - - .. method:: fill(color) - - Fill the whole matrix with a specified color. - - :param int color: None or False or 0 turn LED off, anything else turns LED on - - .. method:: pixel(x, y, color=None) - - Set the color of a single pixel. - - :param int x: x postiion of LED in matrix - :param int y: y position of LED in matrix - :param int color: value > zero lights the decimal point, else unlights the point - - .. method:: text(x, y, str) - - Position and set text on display; used for text scrolling - - :param int x: x postiion of LED in matrix - :param int y: y position of LED in matrix - :param string str: string to place in to display - - .. method:: clear_all() - - sets all leds to off; same as fill(0) - - .. method:: show() - - Update the display. - - -BCDDigits -********* - -.. module:: adafruit_max7219.bcddigits - -.. class:: BCDDigits(spi, cs, nDigits=1) - - Driver for one to 8 MAX7219-based 7-Segment LED display. - - :param object spi: an spi busio or spi bitbangio object - :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 - - .. method:: set_digit(d, v) - - set one digit in the display - - :param int d: the digit position; zero-based - :param int v: integer ranging from 0->15 - - .. method:: show_dot(d, col=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 - - .. method:: show_str(s,str) - - displays a numeric str in the display. shows digits 0-9, -, and . - - :param int s: start position to show the numeric string - :param string str: the numeric string - - .. method:: show_help(s) - - display the word HELP in the display - - :param int s: start position to show HELP - - .. method:: brightness(value) - - control the brightness of the display - - :param int value: 0->15 dimmest to brightest - - .. method:: clear_all() - - sets all leds to off - - .. method:: show() - - Update the display. diff --git a/examples/showbcddigits.py b/examples/showbcddigits.py new file mode 100644 index 0000000..4bf0563 --- /dev/null +++ b/examples/showbcddigits.py @@ -0,0 +1,86 @@ +import time +import random +from board import TX, RX, A2 +import busio +import digitalio +from adafruit_max7219 import bcddigits + +mosi = TX +clk = RX +cs = digitalio.DigitalInOut(A2) + +spi = busio.SPI(clk, MOSI=mosi) + +leds = bcddigits.BCDDigits(spi, cs, nDigits=8) +while True: + # clear display and dim 0 + leds.brightness(0) + leds.clear_all() + + # place 8-digit number on display + value = 12345678 + leds.show_str(0, '{:8}'.format(value)) + leds.show() + + # increase the brightness slowly + for i in range(16): + leds.brightness(i) + time.sleep(0.5) + + leds.brightness(3) + + # show "-HELP-90" on display + leds.show_str(6, '90') # show 90 starting at position 6 + leds.set_digit(0, 10) # show - at position 0 + leds.set_digit(1, 12) # show H at position 1 + leds.set_digit(2, 11) # show E at position 2 + leds.set_digit(3, 13) # show L at position 3 + leds.set_digit(4, 14) # show P at position 4 + leds.set_digit(5, 10) # show - at position 5 + + leds.show() + time.sleep(1.0) + + leds.clear_all() + leds.brightness(5) + + # set the two dots and two 4-digit numbers + leds.show_dot(2, 1) + leds.show_dot(6, 1) + leds.show_str(0, ' 72.5') + leds.show_str(4, '-10.8') + + leds.show() + time.sleep(1.0) + + leds.brightness(10) + leds.clear_all() + # show a 4 character numeric string + leds.show_str(0, ' 0') + leds.show() + time.sleep(1.0) + + leds.clear_all() + # show 0->8 + for digit in range(8): + leds.set_digit(digit, digit) + + leds.show() + time.sleep(1.0) + + # show random 8-digit numbers via show_str + for _ in range(10): + number = random.uniform(-1.0, 1.0) + number *= 10000.0 + number_string = '{:9.3f}'.format(number) + leds.clear_all() + leds.show_str(0, number_string) + leds.show() + time.sleep(1.0) + + # show the help string + leds.clear_all() + leds.show_help(2) + leds.show() + + time.sleep(1.0) diff --git a/examples/showmatrix.py b/examples/showmatrix.py new file mode 100644 index 0000000..4be719c --- /dev/null +++ b/examples/showmatrix.py @@ -0,0 +1,56 @@ +import time +from board import TX, RX, A2 +import busio +import digitalio +from adafruit_max7219 import matrices + +mosi = TX +clk = RX +cs = digitalio.DigitalInOut(A2) + +spi = busio.SPI(clk, MOSI=mosi) + +matrix = matrices.Matrix8x8(spi, cs) +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) + + # one column of leds lit + for i in range(8): + matrix.pixel(1, i, 1) + matrix.show() + time.sleep(0.5) + # now scroll the column to the right + for j in range(8): + matrix.scroll(1, 0) + matrix.show() + time.sleep(0.5) + + # show a string one character at a time + adafruit = 'Adafruit' + for char in adafruit: + matrix.fill(0) + matrix.text(char, 0, 0) + matrix.show() + time.sleep(1.0) + + # scroll the last character off the display + for i in range(8): + matrix.scroll(-1, 0) + matrix.show() + time.sleep(0.5) + + # 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/readthedocs.yml b/readthedocs.yml index a3a16c1..f4243ad 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,2 +1,3 @@ +python: + version: 3 requirements_file: requirements.txt - diff --git a/setup.py b/setup.py deleted file mode 100644 index 372d9d2..0000000 --- a/setup.py +++ /dev/null @@ -1,18 +0,0 @@ -from distutils.core import setup - - -setup( - name='micropython-adafruit-max7219', - py_modules=['max7219'], - version="1.0", - description="Driver for MicroPython for the MAX7219 LED matrix.", - long_description="""\ -Driver for a single MAX7219-based LED matrix.""", - author='Radomir Dopieralski', - author_email='micropython@sheep.art.pl', - classifiers = [ - 'Development Status :: 6 - Mature', - 'Programming Language :: Python :: 3', - 'License :: OSI Approved :: MIT License', - ], -)