diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0dd8629 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +__pycache__ +_build +*.pyc +.env +build* +bundles diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[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 +notes=FIXME,XXX + + +[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=board + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_,_cb + +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,future.builtins + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +# expected-line-ending-format= +expected-line-ending-format=LF + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module +max-module-lines=1000 + +# List of optional constructs for which whitespace checking is disabled. `dict- +# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. +# `trailing-comma` allows a space between comma and closing bracket: (a, ). +# `empty-line` allows space-only lines. +no-space-check=trailing-comma,dict-separator + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[SIMILARITIES] + +# Ignore comments when computing similarities. +ignore-comments=yes + +# Ignore docstrings when computing similarities. +ignore-docstrings=yes + +# Ignore imports when computing similarities. +ignore-imports=no + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[BASIC] + +# Naming hint for argument names +argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct argument names +argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for attribute names +attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct attribute names +attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class names +# class-name-hint=[A-Z_][a-zA-Z0-9]+$ +class-name-hint=[A-Z_][a-zA-Z0-9_]+$ + +# Regular expression matching correct class names +# class-rgx=[A-Z_][a-zA-Z0-9]+$ +class-rgx=[A-Z_][a-zA-Z0-9_]+$ + +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming hint for function names +function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct function names +function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Good variable names which should always be accepted, separated by a comma +# good-names=i,j,k,ex,Run,_ +good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ + +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ + +# Regular expression matching correct inline iteration names +inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ + +# Naming hint for method names +method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct method names +method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +property-classes=abc.abstractproperty + +# Naming hint for variable names +variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + +# Regular expression matching correct variable names +variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ + + +[IMPORTS] + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=optparse,tkinter.tix + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + + +[CLASSES] + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__,__new__,setUp + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict,_fields,_replace,_source,_make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Maximum number of attributes for a class (see R0902). +# max-attributes=7 +max-attributes=11 + +# Maximum number of boolean expressions in a if statement +max-bool-expr=5 + +# Maximum number of branch for function / method body +max-branches=12 + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of statements in function / method body +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=1 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when being caught. Defaults to +# "Exception" +overgeneral-exceptions=Exception diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..5490818 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,34 @@ +# 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. + +dist: trusty +sudo: false +language: python +python: + - "3.6" + +cache: + pip: true + +deploy: + provider: releases + api_key: $GITHUB_TOKEN + file_glob: true + file: $TRAVIS_BUILD_DIR/bundles/* + skip_cleanup: true + overwrite: true + on: + tags: true + +install: + - pip install -r requirements.txt + - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme + - pip install --force-reinstall pylint==1.9.2 + +script: + - pylint adafruit_miniqr.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-miniqr --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..8ee6e44 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +You may report in the following ways: + +In any situation, you may send an email to . + +On the Adafruit Discord, you may send an open message from any channel +to all Community Helpers by tagging @community helpers. You may also send an +open message from any channel, or a direct message to @kattni#1507, +@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or +@Andon#8175. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..289999f --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 ladyada for adafruit industries + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md deleted file mode 100644 index 8e74ffe..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_miniQR -A minimal QR code generator for types 1-9 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b624faa --- /dev/null +++ b/README.rst @@ -0,0 +1,95 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-miniqr/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/miniqr/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_miniQR.svg?branch=master + :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_miniQR + :alt: Build Status + +A non-hardware dependant miniature QR generator library. All native Python! + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Usage Example +============= + +.. code-block:: python + + import adafruit_miniqr + + qr = adafruit_miniqr.QRCode() + qr.add_data(b'https://www.adafruit.com') + qr.make() + print(qr.matrix) + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Building locally +================ + +Zip release files +----------------- + +To build this library locally you'll need to install the +`circuitpython-build-tools `_ package. + +.. 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-miniqr --library_location . + +Sphinx documentation +----------------------- + +Sphinx is used to build the documentation based on rST files and comments in the code. First, +install dependencies (feel free to reuse the virtual environment from above): + +.. code-block:: shell + + python3 -m venv .env + source .env/bin/activate + pip install Sphinx sphinx-rtd-theme + +Now, once you have the virtual environment activated: + +.. code-block:: shell + + cd docs + sphinx-build -E -W -b html . _build/html + +This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to +view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to +locally verify it will pass. diff --git a/adafruit_miniqr.py b/adafruit_miniqr.py new file mode 100644 index 0000000..939bdcd --- /dev/null +++ b/adafruit_miniqr.py @@ -0,0 +1,544 @@ +# The MIT License (MIT) +# +# Ported from the Javascript library by Sam Curren +# QRCode for Javascript +# http://d-project.googlecode.com/svn/trunk/misc/qrcode/js/qrcode.js +# +# Copyright (c) 2009 Kazuhiko Arase +# URL: http://www.d-project.com/ +# +# Minimized for CircuitPython by ladyada for adafruit industries +# +# Licensed under the MIT license: +# http://www.opensource.org/licenses/mit-license.php +# +# The word "QR Code" is registered trademark of +# DENSO WAVE INCORPORATED +# http://www.denso-wave.com/qrcode/faqpatent-e.html +# +# Permission is hereby granted, free of charge, to any person obtaining a copy +# of this software and associated documentation files (the "Software"), to deal +# in the Software without restriction, including without limitation the rights +# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +# copies of the Software, and to permit persons to whom the Software is +# furnished to do so, subject to the following conditions: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +# THE SOFTWARE. +""" +`adafruit_miniqr` +==================================================== + +A non-hardware dependant miniature QR generator library. All native Python! + +* Author(s): ladyada + +Implementation Notes +-------------------- + +**Hardware:** + +* Any! + +**Software and Dependencies:** + +* Python 3 + +""" + +# imports +import math + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_miniQR.git" + +# Consts! +M = 0 +L = 1 +H = 2 +Q = 3 + +_MODE_8BIT_BYTE = 1 << 2 +_PAD0 = 0xEC +_PAD1 = 0x11 + +# Optimized polynomial helpers + +def _glog(n): + """Lookup log(n) from pre-calculated byte table""" + if n < 1: + raise ValueError("glog(" + n + ")") + return LOG_TABLE[n] + +def _gexp(n): + """Lookup exp(n) from pre-calculated byte table""" + while n < 0: + n += 255 + while n >= 256: + n -= 255 + return EXP_TABLE[n] + +#pylint: disable=line-too-long +EXP_TABLE = b'\x01\x02\x04\x08\x10 @\x80\x1d:t\xe8\xcd\x87\x13&L\x98-Z\xb4u\xea\xc9\x8f\x03\x06\x0c\x180`\xc0\x9d\'N\x9c%J\x945j\xd4\xb5w\xee\xc1\x9f#F\x8c\x05\n\x14(P\xa0]\xbai\xd2\xb9o\xde\xa1_\xbea\xc2\x99/^\xbce\xca\x89\x0f\x1e|\xf8\xed\xc7\x93;v\xec\xc5\x973f\xcc\x85\x17.\\\xb8m\xda\xa9O\x9e!B\x84\x15*T\xa8M\x9a)R\xa4U\xaaI\x929r\xe4\xd5\xb7s\xe6\xd1\xbfc\xc6\x91?~\xfc\xe5\xd7\xb3{\xf6\xf1\xff\xe3\xdb\xabK\x961b\xc4\x957n\xdc\xa5W\xaeA\x82\x192d\xc8\x8d\x07\x0e\x1c8p\xe0\xdd\xa7S\xa6Q\xa2Y\xb2y\xf2\xf9\xef\xc3\x9b+V\xacE\x8a\t\x12$H\x90=z\xf4\xf5\xf7\xf3\xfb\xeb\xcb\x8b\x0b\x16,X\xb0}\xfa\xe9\xcf\x83\x1b6l\xd8\xadG\x8e\x01' + +LOG_TABLE = b'\x00\x00\x01\x19\x022\x1a\xc6\x03\xdf3\xee\x1bh\xc7K\x04d\xe0\x0e4\x8d\xef\x81\x1c\xc1i\xf8\xc8\x08Lq\x05\x8ae/\xe1$\x0f!5\x93\x8e\xda\xf0\x12\x82E\x1d\xb5\xc2}j\'\xf9\xb9\xc9\x9a\txM\xe4r\xa6\x06\xbf\x8bbf\xdd0\xfd\xe2\x98%\xb3\x10\x91"\x886\xd0\x94\xce\x8f\x96\xdb\xbd\xf1\xd2\x13\\\x838F@\x1eB\xb6\xa3\xc3H~nk:(T\xfa\x85\xba=\xca^\x9b\x9f\n\x15y+N\xd4\xe5\xacs\xf3\xa7W\x07p\xc0\xf7\x8c\x80c\rgJ\xde\xed1\xc5\xfe\x18\xe3\xa5\x99w&\xb8\xb4|\x11D\x92\xd9# \x89.7?\xd1[\x95\xbc\xcf\xcd\x90\x87\x97\xb2\xdc\xfc\xbea\xf2V\xd3\xab\x14*]\x9e\x84<9SGmA\xa2\x1f-C\xd8\xb7{\xa4v\xc4\x17I\xec\x7f\x0co\xf6l\xa1;R)\x9dU\xaa\xfb`\x86\xb1\xbb\xcc>Z\xcbY_\xb0\x9c\xa9\xa0Q\x0b\xf5\x16\xebzu,\xd7O\xae\xd5\xe9\xe6\xe7\xad\xe8t\xd6\xf4\xea\xa8PX\xaf' +#pylint: enable=line-too-long + +class QRCode: + """The generator class for QR code matrices""" + def __init__(self, *, qr_type=None, error_correct=L): + """Initialize an empty QR code. You can define the `qr_type` (size) + of the code matrix, or have the libary auto-select the smallest + match. Default `error_correct` is type L (7%), but you can select M, + Q or H.""" + self.type = qr_type + self.ECC = error_correct #pylint: disable=invalid-name + self.matrix = None + self.module_count = 0 + self.data_cache = None + self.data_list = [] + + def add_data(self, data): + """Add more data to the QR code, must be bytestring stype""" + self.data_list.append(data) + datalen = sum([len(x) for x in self.data_list]) + if not self.type: + for qr_type in range(1, 6): + rs_blocks = _get_rs_blocks(qr_type, self.ECC) + total_data_count = 0 + for block in rs_blocks: + total_data_count += block['data'] + if total_data_count > datalen: + self.type = qr_type + break + self.data_cache = None + + def make(self, *, test=False, mask_pattern=0): + """Perform the actual generation of the QR matrix. To keep things + small and speedy we don't generate all 8 mask patterns and pick + the best. Instead, please pass in a desired mask_pattern, the + default mask is 0.""" + self.module_count = self.type * 4 + 17 + self.matrix = QRBitMatrix(self.module_count, self.module_count) + + self._setup_position_probe_pattern(0, 0) + self._setup_position_probe_pattern(self.module_count - 7, 0) + self._setup_position_probe_pattern(0, self.module_count - 7) + self._setup_position_adjust_pattern() + self._setup_timing_pattern() + self._setup_type_info(test, mask_pattern) + + if self.type >= 7: + self._setup_type_number(test) + + if self.data_cache is None: + self.data_cache = QRCode._create_data(self.type, self.ECC, self.data_list) + self._map_data(self.data_cache, mask_pattern) + + def _setup_position_probe_pattern(self, row, col): + """Add the positition probe data pixels to the matrix""" + for r in range(-1, 8): + if (row + r <= -1 or self.module_count <= row + r): + continue + for c in range(-1, 8): #pylint: disable=invalid-name + if (col + c <= -1 or self.module_count <= col + c): + continue + test = ((r >= 0 and r <= 6 and (c == 0 or c == 6)) + or (c >= 0 and c <= 6 and (r == 0 or r == 6)) + or (r >= 2 and r <= 4 and c >= 2 and c <= 4)) + self.matrix[row+r, col+c] = test + def _setup_timing_pattern(self): + """Add the timing data pixels to the matrix""" + for r in range(8, self.module_count-8): + if (self.matrix[r, 6] != None): + continue + self.matrix[r, 6] = (r % 2 == 0) + + for c in range(8, self.module_count-8): #pylint: disable=invalid-name + if (self.matrix[6, c] != None): + continue + self.matrix[6, c] = (c % 2 == 0) + + def _setup_position_adjust_pattern(self): + """Add the position adjust data pixels to the matrix""" + pos = QRUtil.get_pattern_position(self.type) + + for row in pos: + for col in pos: + if (self.matrix[row, col] != None): + continue + + for r in range(-2, 3): + for c in range(-2, 3): #pylint: disable=invalid-name + test = (abs(r) == 2 or abs(c) == 2 or + (r == 0 and c == 0)) + self.matrix[row+r, col+c] = test + + def _setup_type_number(self, test): + """Add the type number pixels to the matrix""" + bits = QRUtil.get_BCH_type_number(self.type) + + for i in range(18): + mod = not test and ((bits >> i) & 1) == 1 + self.matrix[i // 3, i % 3 + self.module_count - 8 - 3] = mod + + for i in range(18): + mod = not test and ((bits >> i) & 1) == 1 + self.matrix[i % 3 + self.module_count - 8 - 3, i // 3] = mod + + def _setup_type_info(self, test, mask_pattern): + """Add the type info pixels to the matrix""" + data = (self.ECC << 3) | mask_pattern + bits = QRUtil.get_BCH_type_info(data) + + #// vertical + for i in range(15): + mod = not test and ((bits >> i) & 1) == 1 + if i < 6: + self.matrix[i, 8] = mod + elif i < 8: + self.matrix[i + 1, 8] = mod + else: + self.matrix[self.module_count - 15 + i, 8] = mod + + #// horizontal + for i in range(15): + mod = not test and ((bits >> i) & 1) == 1 + if i < 8: + self.matrix[8, self.module_count - i - 1] = mod + elif i < 9: + self.matrix[8, 15 - i - 1 + 1] = mod + else: + self.matrix[8, 15 - i - 1] = mod + + #// fixed module + self.matrix[self.module_count - 8, 8] = (not test) + + def _map_data(self, data, mask_pattern): + """Map the data onto the QR code""" + inc = -1 + row = self.module_count - 1 + bit_idx = 7 + byte_idx = 0 + + for col in range(self.module_count - 1, 0, -2): + if col == 6: + col -= 1 + + while True: + for c in range(2): #pylint: disable=invalid-name + if self.matrix[row, col - c] is None: + dark = False + if byte_idx < len(data): + dark = ((data[byte_idx] >> bit_idx) & 1) == 1 + mask = QRUtil.get_mask(mask_pattern, row, col - c) + if mask: + dark = not dark + self.matrix[row, col-c] = dark + bit_idx -= 1 + if bit_idx == -1: + byte_idx += 1 + bit_idx = 7 + row += inc + if row < 0 or self.module_count <= row: + row -= inc + inc = -inc + break + + @staticmethod + def _create_data(qr_type, ecc, data_list): + """Check and format data into bit buffer""" + rs_blocks = _get_rs_blocks(qr_type, ecc) + + buffer = QRBitBuffer() + + for data in data_list: + buffer.put(_MODE_8BIT_BYTE, 4) + buffer.put(len(data), 8) + for byte in data: + buffer.put(byte, 8) + + #// calc num max data. + total_data_count = 0 + for block in rs_blocks: + total_data_count += block['data'] + + if buffer.get_length_bits() > total_data_count * 8: + raise RuntimeError("Code length overflow: %d > %d" % + (buffer.get_length_bits(), total_data_count*8)) + + #// end code + if buffer.get_length_bits() + 4 <= total_data_count * 8: + buffer.put(0, 4) + + #// padding + while buffer.get_length_bits() % 8 != 0: + buffer.put_bit(False) + + #// padding + while True: + if buffer.get_length_bits() >= total_data_count*8: + break + buffer.put(_PAD0, 8) + if buffer.get_length_bits() >= total_data_count*8: + break + buffer.put(_PAD1, 8) + + return QRCode._create_bytes(buffer, rs_blocks) + + #pylint: disable=too-many-locals,too-many-branches + @staticmethod + def _create_bytes(buffer, rs_blocks): + """Perform error calculation math on bit buffer""" + offset = 0 + max_dc_count = 0 + max_ec_count = 0 + + dcdata = [0] * len(rs_blocks) + ecdata = [0] * len(rs_blocks) + + for r, block in enumerate(rs_blocks): + + dc_count = block['data'] + ec_count = block['total'] - dc_count + + max_dc_count = max(max_dc_count, dc_count) + max_ec_count = max(max_ec_count, ec_count) + + dcdata[r] = [0] * dc_count + + for i in range(len(dcdata[r])): + dcdata[r][i] = 0xff & buffer.buffer[i + offset] + offset += dc_count + + rs_poly = QRUtil.get_error_correct_polynomial(ec_count) + mod_poly = QRPolynomial(dcdata[r], rs_poly.get_length() - 1) + + while True: + if mod_poly.get_length() - rs_poly.get_length() < 0: + break + ratio = _glog(mod_poly.get(0)) - _glog(rs_poly.get(0)) + num = [0 for x in range(mod_poly.get_length())] + for i in range(mod_poly.get_length()): + num[i] = mod_poly.get(i) + for i in range(rs_poly.get_length()): + num[i] ^= _gexp(_glog(rs_poly.get(i)) + ratio) + mod_poly = QRPolynomial(num, 0) + + ecdata[r] = [0 for x in range(rs_poly.get_length()-1)] + for i in range(len(ecdata[r])): + mod_index = i + mod_poly.get_length() - len(ecdata[r]) + if mod_index >= 0: + ecdata[r][i] = mod_poly.get(mod_index) + else: + ecdata[r][i] = 0 + + total_code_count = 0 + for block in rs_blocks: + total_code_count += block['total'] + + data = [None] * total_code_count + index = 0 + + for i in range(max_dc_count): + for r in range(len(rs_blocks)): + if i < len(dcdata[r]): + data[index] = dcdata[r][i] + index += 1 + + for i in range(max_ec_count): + for r in range(len(rs_blocks)): + if i < len(ecdata[r]): + data[index] = ecdata[r][i] + index += 1 + + return data +#pylint: enable=too-many-locals,too-many-branches + +class QRUtil(object): + """A selection of bit manipulation tools for QR generation and BCH encoding""" + PATTERN_POSITION_TABLE = [b'', b'\x06\x12', b'\x06\x16', b'\x06\x1a', + b'\x06\x1e', b'\x06"', b'\x06\x16&', + b'\x06\x18*', b'\x06\x1a.', b'\x06\x1c2'] + + G15 = 0b10100110111 + G18 = 0b1111100100101 + G15_MASK = 0b101010000010010 +#pylint: disable=invalid-name + @staticmethod + def get_BCH_type_info(data): + """Encode with G15 BCH mask""" + d = data << 10 + while QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G15) >= 0: + d ^= QRUtil.G15 << (QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G15)) + + return ((data << 10) | d) ^ QRUtil.G15_MASK + @staticmethod + def get_BCH_type_number(data): + """Encode with G18 BCH mask""" + d = data << 12 + while QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G18) >= 0: + d ^= QRUtil.G18 << (QRUtil.get_BCH_digit(d) - QRUtil.get_BCH_digit(QRUtil.G18)) + return (data << 12) | d + @staticmethod + def get_BCH_digit(data): + """Count digits in data""" + digit = 0 + while data != 0: + digit += 1 + data >>= 1 + return digit +#pylint: enable=invalid-name + @staticmethod + def get_pattern_position(qr_type): + """The mask pattern position array for this QR type""" + return QRUtil.PATTERN_POSITION_TABLE[qr_type - 1] + @staticmethod + def get_mask(mask, i, j): + """Perform matching calculation on two vals for given pattern mask""" + #pylint: disable=multiple-statements, too-many-return-statements + if mask == 0: return (i + j) % 2 == 0 + if mask == 1: return i % 2 == 0 + if mask == 2: return j % 3 == 0 + if mask == 3: return (i + j) % 3 == 0 + if mask == 4: return (math.floor(i / 2) + math.floor(j / 3)) % 2 == 0 + if mask == 5: return (i * j) % 2 + (i * j) % 3 == 0 + if mask == 6: return ((i * j) % 2 + (i * j) % 3) % 2 == 0 + if mask == 7: return ((i * j) % 3 + (i + j) % 2) % 2 == 0 + raise ValueError("Bad mask pattern:" + mask) + #pylint: enable=multiple-statements, too-many-return-statements + @staticmethod + def get_error_correct_polynomial(ecc_length): + """ Generate a ecc polynomial""" + poly = QRPolynomial([1], 0) + for i in range(ecc_length): + poly = poly.multiply(QRPolynomial([1, _gexp(i)], 0)) + return poly + +class QRPolynomial: + """Structure for creating and manipulating error code polynomials""" + def __init__(self, num, shift): + """Create a QR polynomial""" + if not num: + raise Exception(num.length + "/" + shift) + offset = 0 + while offset < len(num) and num[offset] == 0: + offset += 1 + self.num = [0 for x in range(len(num)-offset+shift)] + for i in range(len(num) - offset): + self.num[i] = num[i + offset] + + def get(self, index): + """The exponent at the index location""" + return self.num[index] + def get_length(self): + """Length of the poly""" + return len(self.num) + def multiply(self, e): #pylint: disable=invalid-name + """Multiply two polynomials, returns a new one""" + num = [0 for x in range(self.get_length() + e.get_length() - 1)] + + for i in range(self.get_length()): + for j in range(e.get_length()): + num[i + j] ^= _gexp(_glog(self.get(i)) + _glog(e.get(j))) + + return QRPolynomial(num, 0) + +_QRRS_BLOCK_TABLE = (b'\x01\x1a\x10', b'\x01\x1a\x13', b'\x01\x1a\t', b'\x01\x1a\r', b'\x01,\x1c', b'\x01,"', b'\x01,\x10', b'\x01,\x16', b'\x01F,', b'\x01F7', b'\x02#\r', b'\x02#\x11', b'\x022 ', b'\x01dP', b'\x04\x19\t', b'\x022\x18', b'\x02C+', b'\x01\x86l', b'\x02!\x0b\x02"\x0c', b'\x02!\x0f\x02"\x10', b'\x04+\x1b', b'\x02VD', b'\x04+\x0f', b'\x04+\x13', b'\x041\x1f', b'\x02bN', b"\x04'\r\x01(\x0e", b'\x02 \x0e\x04!\x0f', b"\x02<&\x02='", b'\x02ya', b'\x04(\x0e\x02)\x0f', b'\x04(\x12\x02)\x13', b'\x03:$\x02;%', b'\x02\x92t', b'\x04$\x0c\x04%\r', b'\x04$\x10\x04%\x11') #pylint: disable=line-too-long + +def _get_rs_blocks(qr_type, ecc): + rs_block = _QRRS_BLOCK_TABLE[(qr_type - 1) * 4 + ecc] + + length = len(rs_block) // 3 + blocks = [] + for i in range(length): + count = rs_block[i * 3 + 0] + total = rs_block[i * 3 + 1] + data = rs_block[i * 3 + 2] + block = {'total' : total, 'data' : data} + for _ in range(count): + blocks.append(block) + return blocks + +class QRBitMatrix: + """A bit-packed storage class for matrices""" + def __init__(self, width, height): + self.width = width + self.height = height + if width > 60: + raise ValueError("Max 60 bits wide:", width) + self.buffer = [0] * self.height * 2 + self.used = [0] * self.height * 2 + + def __repr__(self): + b = "" + for y in range(self.height): + for x in range(self.width): + if self[x, y]: + b += 'X' + else: + b += '.' + b += '\n' + return b + + def __getitem__(self, key): + x, y = key + if y > self.width: + raise ValueError() + i = 2*x + (y // 30) + j = y % 30 + if not self.used[i] & (1 << j): + return None + return self.buffer[i] & (1 << j) + + def __setitem__(self, key, value): + x, y = key + if y > self.width: + raise ValueError() + i = 2*x + (y // 30) + j = y % 30 + if value: + self.buffer[i] |= 1 << j + else: + self.buffer[i] &= ~(1 << j) + self.used[i] |= 1 << j # buffer item was set + +class QRBitBuffer: + """Storage class for a length of individual bits""" + def __init__(self): + self.buffer = [] + self.length = 0 + + def __repr__(self): + return ".".join([str(n) for n in self.buffer]) + + def get(self, index): + """The bit value at a location""" + i = index // 8 + return self.buffer[i] & (1 << (7 - index % 8)) + + def put(self, num, length): + """Add a number of bits from a single integer value""" + for i in range(length): + self.put_bit(num & (1 << (length - i - 1))) + + def get_length_bits(self): + """Size of bit buffer""" + return self.length + + def put_bit(self, bit): + """Insert one bit at the end of the bit buffer""" + i = self.length // 8 + if len(self.buffer) <= i: + self.buffer.append(0) + if bit: + self.buffer[i] |= (0x80 >> (self.length % 8)) + self.length += 1 diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..1c520b6 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ + +.. If you created a package, create one automodule per module in the package. + +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +.. automodule:: adafruit_miniqr + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3e2a475 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,160 @@ +# -*- coding: utf-8 -*- + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ------------------------------------------------ + +# 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.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', +] + +# TODO: Please Read! +# 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. +templates_path = ['_templates'] + +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Adafruit miniQR Library' +copyright = u'2018 ladyada' +author = u'ladyada' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'1.0' +# The full version, including alpha/beta/rc tags. +release = u'1.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# 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 + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + +napoleon_numpy_docstring = False + +# -- Options for HTML output ---------------------------------------------- + +# 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 = ['.'] + +# 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'] + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +html_favicon = '_static/favicon.ico' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'AdafruitMiniqrLibrarydoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'AdafruitminiQRLibrary.tex', u'AdafruitminiQR Library Documentation', + author, 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'AdafruitminiQRlibrary', u'Adafruit miniQR Library Documentation', + [author], 1) +] + +# -- 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 = [ + (master_doc, 'AdafruitminiQRLibrary', u'Adafruit miniQR Library Documentation', + author, 'AdafruitminiQRLibrary', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..aa17e98 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/miniqr_simpletest.py + :caption: examples/miniqr_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b74e8ec --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,45 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + +.. toctree:: + :caption: Related Products + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/miniqr_displaytest.py b/examples/miniqr_displaytest.py new file mode 100644 index 0000000..ff0b512 --- /dev/null +++ b/examples/miniqr_displaytest.py @@ -0,0 +1,60 @@ +import board +import pulseio +import displayio +import adafruit_miniqr + +DISPLAY_W = 128 +DISPLAY_H = 128 + +backlight = pulseio.PWMOut(board.TFT_BACKLIGHT) +backlight.duty_cycle = 0 + +def draw_QR(matrix): + # how big each pixel is, add 2 blocks on either side + BLOCK_SIZE = DISPLAY_W // (matrix.width+4) + + # Center the QR code in the middle of the screen + X_OFFSET = (DISPLAY_W - BLOCK_SIZE * matrix.width) // 2 + Y_OFFSET = (DISPLAY_H - BLOCK_SIZE * matrix.height) // 2 + + # monochome (2 color) palette + palette = displayio.Palette(2) + palette[0] = 0xFFFFFF + palette[1] = 0x000000 + + # bitmap the size of the screen, monochrome (2 colors) + bitmap = displayio.Bitmap(DISPLAY_H, DISPLAY_W, 2) + + # raster the QR code + line = bytearray(DISPLAY_W // 8) # monochrome means 8 pixels per byte + for y in range(matrix.height): # each scanline in the height + for i, _ in enumerate(line): # initialize it to be empty + line[i] = 0 + for x in range(matrix.width): + if matrix[x, y]: + for b in range(BLOCK_SIZE): + _x = X_OFFSET + x * BLOCK_SIZE + b + line[_x // 8] |= 1 << (7-(_x % 8)) + + for b in range(BLOCK_SIZE): + # load this line of data in, as many time as block size + #pylint: disable=protected-access + bitmap._load_row(Y_OFFSET + y*BLOCK_SIZE+b, line) + + # display the bitmap using our palette + splash = displayio.Group() + face = displayio.Sprite(bitmap, pixel_shader=palette, position=(0, 0)) + splash.append(face) + board.DISPLAY.show(splash) + board.DISPLAY.wait_for_frame() + +qr = adafruit_miniqr.QRCode() +qr.add_data(b'https://www.adafruit.com/circuitpython') +qr.make() +draw_QR(qr.matrix) + +# turn on backlight +backlight.duty_cycle = 35000 + +while True: + pass diff --git a/examples/miniqr_simpletest.py b/examples/miniqr_simpletest.py new file mode 100644 index 0000000..4f63640 --- /dev/null +++ b/examples/miniqr_simpletest.py @@ -0,0 +1,34 @@ +import sys +import adafruit_miniqr + +# For drawing filled rectangles to the console: +out = sys.stdout +WHITE = "\x1b[1;47m \x1b[40m" +BLACK = " " + +def prettyprint_QR(matrix): + # white 4-pixel border at top + for _ in range(4): + for _ in range(matrix.width+8): + out.write(WHITE) + print() + for y in range(matrix.height): + out.write(WHITE*4) # 4-pixel border to left + for x in range(matrix.width): + if matrix[x, y]: + out.write(BLACK) + else: + out.write(WHITE) + out.write(WHITE*4) # 4-pixel bporder to right + print() + # white 4-pixel border at bottom + for _ in range(4): + for _ in range(matrix.width+8): + out.write(WHITE) + print() + +qr = adafruit_miniqr.QRCode(qr_type=3, error_correct=adafruit_miniqr.L) +qr.add_data(b'https://www.adafruit.com') +qr.make() +print(qr.matrix) +prettyprint_QR(qr.matrix) diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29