From 44b2132642e3f288edcf9bbcff9af3da52fe5b5d Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Sat, 23 Feb 2019 12:05:56 -0500 Subject: [PATCH 1/6] Initial. --- .gitignore | 12 + .pylintrc | 433 +++++++++++++++++++ .readthedocs.yml | 3 + .travis.yml | 48 +++ CODE_OF_CONDUCT.md | 127 ++++++ LICENSE | 21 + README.md | 2 - README.rst | 90 ++++ adafruit_pyportal.py | 709 ++++++++++++++++++++++++++++++++ docs/_static/favicon.ico | Bin 0 -> 4414 bytes docs/api.rst | 8 + docs/conf.py | 162 ++++++++ docs/examples.rst | 8 + docs/index.rst | 47 +++ examples/pyportal_simpletest.py | 0 requirements.txt | 7 + setup.py | 70 ++++ 17 files changed, 1745 insertions(+), 2 deletions(-) create mode 100644 .gitignore create mode 100644 .pylintrc create mode 100644 .readthedocs.yml create mode 100644 .travis.yml create mode 100644 CODE_OF_CONDUCT.md create mode 100644 LICENSE delete mode 100644 README.md create mode 100644 README.rst create mode 100644 adafruit_pyportal.py create mode 100644 docs/_static/favicon.ico create mode 100644 docs/api.rst create mode 100644 docs/conf.py create mode 100644 docs/examples.rst create mode 100644 docs/index.rst create mode 100644 examples/pyportal_simpletest.py create mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..55f127b --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build* +bundles +*.DS_Store +.eggs +dist +**/*.egg-info \ No newline at end of file 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..c3a5e8f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,48 @@ +# 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: xenial +language: python +python: + - "3.6" + +cache: + pip: true + +# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true", +# or remove the env block entirely and remove the condition in the +# deploy block. +env: + - DEPLOY_PYPI="false" + +deploy: + - provider: releases + api_key: "$GITHUB_TOKEN" + file_glob: true + file: "$TRAVIS_BUILD_DIR/bundles/*" + skip_cleanup: true + overwrite: true + on: + tags: true + # TODO: Use 'travis encrypt --com -r adafruit/' to generate + # the encrypted password for adafruit-travis. Paste result below. + - provider: pypi + user: adafruit-travis + password: + secure: #-- PASTE ENCRYPTED PASSWORD HERE --# + on: + tags: true + condition: $DEPLOY_PYPI = "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_pyportal.py + - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py) + - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pyportal --library_location . + - cd docs && sphinx-build -E -W -b html . _build/html && cd .. 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..e58c11a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 Limor Fried 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 d483657..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Adafruit_CircuitPython_PyPortal -CircuitPython driver for Adafruit PyPortal. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..cdd6f51 --- /dev/null +++ b/README.rst @@ -0,0 +1,90 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pyportal/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/pyportal/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_PyPortal.svg?branch=master + :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_PyPortal + :alt: Build Status + +CircuitPython driver for Adafruit PyPortal. + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Bus Device `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Usage Example +============= + +See examples/pyportal_simpletest.py + +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-pyportal --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_pyportal.py b/adafruit_pyportal.py new file mode 100644 index 0000000..8893eea --- /dev/null +++ b/adafruit_pyportal.py @@ -0,0 +1,709 @@ +# The MIT License (MIT) +# +# Copyright (c) 2019 Limor Fried 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. +""" +`adafruit_pyportal` +================================================================================ + +CircuitPython driver for Adafruit PyPortal. + + +* Author(s): Limor Fried + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit PyPortal `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases + +* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +""" + +import os +import time +import gc +import rtc +import supervisor +import board +import busio +import pulseio +import audioio +import displayio +import neopixel +import microcontroller +from digitalio import DigitalInOut +import adafruit_touchscreen + +from adafruit_bitmap_font import bitmap_font +from adafruit_display_text.text_area import TextArea +from adafruit_esp32spi import adafruit_esp32spi +import adafruit_esp32spi.adafruit_esp32spi_requests as requests + +try: + from settings import settings +except ImportError: + print("""WiFi settings are kept in settings.py, please add them there! +the settings dictionary must contain 'ssid' and 'password' at a minimum""") + raise + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyPortal.git" + +# pylint: disable=line-too-long +IMAGE_CONVERTER_SERVICE = "http://res.cloudinary.com/schmarty/image/fetch/w_320,h_240,c_fill,f_bmp/" +#IMAGE_CONVERTER_SERVICE = "http://ec2-107-23-37-170.compute-1.amazonaws.com/rx/ofmt_bmp,rz_320x240/" +TIME_SERVICE_IPADDR = "http://worldtimeapi.org/api/ip" +TIME_SERVICE_LOCATION = "http://worldtimeapi.org/api/timezone/" +LOCALFILE = "local.txt" +# pylint: enable=line-too-long + + +class Fake_Requests: + """For requests using a local file instead of the network.""" + def __init__(self, filename): + self._filename = filename + with open(filename, "r") as file: + self.text = file.read() + + def json(self): + """json for local requests.""" + import json + return json.loads(self.text) + + +class PyPortal: + """Class representing the Adafruit PyPortal. + + :param url: The URL of your data source. Defaults to ``None``. + :param json_path: Defaults to ``None``. + :param regexp_path: Defaults to ``None``. + :param default_bg: The path to your default background file. Defaults to ``None``. + :param status_neopixel: The pin for the status NeoPixel. Use ``board.NeoPixel`` for the + on-board NeoPixel. Defaults to ``None``. + :param str text_font: The path to your font file for your text. + :param text_position: The position of your text on the display. + :param text_color: The color of the text. Defaults to ``None``. + :param text_wrap: The location where the text wraps. Defaults to ``None``. + :param text_maxlen: The max length of the text. Defaults to ``None``. + :param image_json_path: Defaults to ``None``. + :param image_resize: Defaults to ``None``. + :param image_position: The position of the image on the display. Defaults to ``None``. + :param time_between_requests: Defaults to ``None``. + :param success_callback: Defaults to ``None``. + :param str caption_text: The text of your caption. Defaults to ``None``. + :param str caption_font: The path to the font file for your caption. Defaults to ``None``. + :param caption_position: The position of your caption on the display. Defaults to ``None``. + :param caption_color: The color of your caption. Must be a hex value, e.g. ``0x808000``. + :param debug: Turn on debug features. Defaults to False. + + """ + # pylint: disable=too-many-instance-attributes, too-many-locals, too-many-branches, too-many-statements + def __init__(self, *, url=None, json_path=None, regexp_path=None, + default_bg=None, status_neopixel=None, + text_font=None, text_position=None, text_color=0x808080, + text_wrap=0, text_maxlen=0, + image_json_path=None, image_resize=None, image_position=None, + time_between_requests=60, success_callback=None, + caption_text=None, caption_font=None, caption_position=None, + caption_color=0x808080, + debug=False): + + self._debug = debug + + try: + self._backlight = pulseio.PWMOut(board.TFT_BACKLIGHT) + except ValueError: + self._backlight = None + self.set_backlight(1.0) # turn on backlight + + self._url = url + if json_path: + if isinstance(json_path[0], (list, tuple)): + self._json_path = json_path + else: + self._json_path = (json_path,) + else: + self._json_path = None + + self._regexp_path = regexp_path + self._time_between_requests = time_between_requests + self._success_callback = success_callback + + if status_neopixel: + self.neopix = neopixel.NeoPixel(status_neopixel, 1, brightness=0.2) + else: + self.neopix = None + self.neo_status(0) + + try: + os.stat(LOCALFILE) + self._uselocal = True + except OSError: + self._uselocal = False + + # Make ESP32 connection + if self._debug: + print("Init ESP32") + esp32_cs = DigitalInOut(microcontroller.pin.PB14) # PB14 + esp32_ready = DigitalInOut(microcontroller.pin.PB16) + esp32_gpio0 = DigitalInOut(microcontroller.pin.PB15) + esp32_reset = DigitalInOut(microcontroller.pin.PB17) + spi = busio.SPI(board.SCK, board.MOSI, board.MISO) + + if not self._uselocal: + self._esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset, + esp32_gpio0) + #self._esp._debug = 1 + for _ in range(3): # retries + try: + print("ESP firmware:", self._esp.firmware_version) + break + except RuntimeError: + print("Retrying ESP32 connection") + time.sleep(1) + self._esp.reset() + else: + raise RuntimeError("Was not able to find ESP32") + + requests.set_interface(self._esp) + + if self._debug: + print("Init display") + self.splash = displayio.Group(max_size=5) + board.DISPLAY.show(self.splash) + + if self._debug: + print("Init background") + self._bg_group = displayio.Group(max_size=1) + self._bg_file = None + self._default_bg = default_bg + self.set_background(self._default_bg) + self.splash.append(self._bg_group) + + self._qr_group = None + + if self._debug: + print("Init caption") + self._caption = None + if caption_font: + self._caption_font = bitmap_font.load_font(caption_font) + self.set_caption(caption_text, caption_position, caption_color) + + if text_font: + if isinstance(text_position[0], (list, tuple)): + num = len(text_position) + if not text_wrap: + text_wrap = [0] * num + if not text_maxlen: + text_maxlen = [0] * num + else: + num = 1 + text_position = (text_position,) + text_color = (text_color,) + text_wrap = (text_wrap,) + text_maxlen = (text_maxlen,) + self._text = [None] * num + self._text_color = [None] * num + self._text_position = [None] * num + self._text_wrap = [None] * num + self._text_maxlen = [None] * num + self._text_font = bitmap_font.load_font(text_font) + if self._debug: + print("Loading font glyphs") + # self._text_font.load_glyphs(b'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' + # b'0123456789:/-_,. ') + gc.collect() + + for i in range(num): + if self._debug: + print("Init text area", i) + self._text[i] = None + self._text_color[i] = text_color[i] + self._text_position[i] = text_position[i] + self._text_wrap[i] = text_wrap[i] + self._text_maxlen[i] = text_maxlen[i] + else: + self._text_font = None + self._text = None + + self._image_json_path = image_json_path + self._image_resize = image_resize + self._image_position = image_position + if image_json_path: + if self._debug: + print("Init image path") + if not self._image_position: + self._image_position = (0, 0) # default to top corner + if not self._image_resize: + self._image_resize = (320, 240) # default to full screen + + if self._debug: + print("Init touchscreen") + self.touchscreen = adafruit_touchscreen.Touchscreen(microcontroller.pin.PB01, + microcontroller.pin.PB08, + microcontroller.pin.PA06, + microcontroller.pin.PB00, + calibration=((5200, 59000), + (5800, 57000)), + size=(320, 240)) + + self.set_backlight(1.0) # turn on backlight + gc.collect() + + def set_background(self, filename): + """The background image. + + :param filename: The name of the chosen background image file. + + """ + print("Set background to ", filename) + try: + self._bg_group.pop() + except IndexError: + pass # s'ok, we'll fix to test once we can + + if not filename: + return # we're done, no background desired + if self._bg_file: + self._bg_file.close() + self._bg_file = open(filename, "rb") + background = displayio.OnDiskBitmap(self._bg_file) + try: + self._bg_sprite = displayio.TileGrid(background, + pixel_shader=displayio.ColorConverter(), + position=(0, 0)) + except AttributeError: + self._bg_sprite = displayio.Sprite(background, pixel_shader=displayio.ColorConverter(), + position=(0, 0)) + + self._bg_group.append(self._bg_sprite) + board.DISPLAY.refresh_soon() + gc.collect() + board.DISPLAY.wait_for_frame() + + def set_backlight(self, val): + """The backlight. + + :param val: The backlight brightness. Use a value between ``0`` and ``1``, where ``0`` is + off, and ``1`` is 100% brightness. + + """ + val = max(0, min(1.0, val)) + if self._backlight: + self._backlight.duty_cycle = int(val * 65535) + else: + board.DISPLAY.auto_brightness = False + board.DISPLAY.brightness = val + + def preload_font(self, glyphs=None): + """Preload font. + + :param glyphs: The font glyphs to load. Defaults to ``None``, uses built in glyphs if None. + + """ + if not glyphs: + glyphs = b'0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-!,. "\'?!' + print("Preloading font glyphs:", glyphs) + if self._text_font: + self._text_font.load_glyphs(glyphs) + + def set_caption(self, caption_text, caption_position, caption_color): + """A caption. Requires setting ``caption_font`` in init! + + :param caption_text: The text of the caption. + :param caption_position: The position of the caption text. + :param caption_color: The color of your caption text. Must be a hex value, + e.g. ``0x808000``. + + """ + if self._debug: + print("Setting caption to", caption_text) + + if (not caption_text) or (not self._caption_font) or (not caption_position): + return # nothing to do! + + if self._caption: + self._caption._update_text(str(caption_text)) # pylint: disable=protected-access, undefined-variable + board.DISPLAY.refresh_soon() + board.DISPLAY.wait_for_frame() + return + + self._caption = TextArea(self._caption_font, text=str(caption_text)) + self._caption.x = caption_position[0] + self._caption.y = caption_position[1] + self._caption.color = caption_color + self.splash.append(self._caption) + + def set_text(self, val, index=0): + """Display text. + + :param str val: The text to be displayed. + :param index: Defaults to 0. + + """ + if self._text_font: + string = str(val) + if self._text_maxlen[index]: + string = string[:self._text_maxlen[index]] + if self._text[index]: + # print("Replacing text area with :", string) + # self._text[index].text = string + # return + items = [] + while len(self.splash): # pylint: disable=len-as-condition + item = self.splash.pop() + if item == self._text[index]: + break + items.append(item) + self._text[index] = TextArea(self._text_font, text=string) + self._text[index].color = self._text_color[index] + self._text[index].x = self._text_position[index][0] + self._text[index].y = self._text_position[index][1] + self.splash.append(self._text[index]) + for g in items: + self.splash.append(g) + return + + if self._text_position[index]: # if we want it placed somewhere... + print("Making text area with string:", string) + self._text[index] = TextArea(self._text_font, text=string) + self._text[index].color = self._text_color[index] + self._text[index].x = self._text_position[index][0] + self._text[index].y = self._text_position[index][1] + self.splash.append(self._text[index]) + + def neo_status(self, value): + """The status NeoPixeel. + + :param value: The color to change the NeoPixel. + + """ + if self.neopix: + self.neopix.fill(value) + + @staticmethod + def play_file(file_name): + """Play a wav file. + + :param str file_name: The name of the wav file. + + """ + #self._speaker_enable.value = True + with audioio.AudioOut(board.AUDIO_OUT) as audio: + with open(file_name, "rb") as file: + with audioio.WaveFile(file) as wavefile: + audio.play(wavefile) + while audio.playing: + pass + #self._speaker_enable.value = False + + @staticmethod + def _json_traverse(json, path): + value = json + for x in path: + value = value[x] + gc.collect() + return value + + def get_local_time(self, location=None): + """The local time. + + :param str location: Your city and state, e.g. ``"New York, New York"``. + + """ + self._connect_esp() + api_url = None + if not location: + api_url = TIME_SERVICE_IPADDR + else: + api_url = TIME_SERVICE_LOCATION + location + response = requests.get(api_url) + time_json = response.json() + current_time = time_json['datetime'] + year_day = time_json['day_of_year'] + week_day = time_json['day_of_week'] + is_dst = time_json['dst'] + + the_date, the_time = current_time.split('T') + year, month, mday = [int(x) for x in the_date.split('-')] + the_time = the_time.split('.')[0] + hours, minutes, seconds = [int(x) for x in the_time.split(':')] + now = time.struct_time((year, month, mday, hours, minutes, seconds, week_day, year_day, + is_dst)) + print(now) + rtc.RTC().datetime = now + + # now clean up + time_json = None + response.close() + response = None + gc.collect() + + def wget(self, url, filename): + """Obtain a stream. + + :param url: The URL from which to obtain the data. + :param filename: The name of the file to save the data. + + """ + print("Fetching stream from", url) + + self.neo_status((100, 100, 0)) + r = requests.get(url, stream=True) + + if self._debug: + print(r.headers) + content_length = int(r.headers['content-length']) + remaining = content_length + print("Saving data to ", filename) + stamp = time.monotonic() + with open(filename, "wb") as file: + for i in r.iter_content(min(remaining, 12000)): # huge chunks! + self.neo_status((0, 100, 100)) + remaining -= len(i) + file.write(i) + if self._debug: + print("Read %d bytes, %d remaining" % (content_length-remaining, remaining)) + else: + print(".", end='') + if not remaining: + break + self.neo_status((100, 100, 0)) + + r.close() + stamp = time.monotonic() - stamp + print("Created file of %d bytes in %0.1f seconds" % (os.stat(filename)[6], stamp)) + self.neo_status((0, 0, 0)) + + def _connect_esp(self): + self.neo_status((0, 0, 100)) + while not self._esp.is_connected: + if self._debug: + print("Connecting to AP") + # settings dictionary must contain 'ssid' and 'password' at a minimum + self.neo_status((100, 0, 0)) # red = not connected + self._esp.connect(settings) + + def fetch(self): + """Fetch data.""" + json_out = None + image_url = None + values = [] + + gc.collect() + if self._debug: + print("Free mem: ", gc.mem_free()) # pylint: disable=no-member + + r = None + if self._uselocal: + print("*** USING LOCALFILE FOR DATA - NOT INTERNET!!! ***") + r = Fake_Requests(LOCALFILE) + + if not r: + self._connect_esp() + # great, lets get the data + print("Retrieving data...", end='') + self.neo_status((100, 100, 0)) # yellow = fetching data + gc.collect() + r = requests.get(self._url) + gc.collect() + self.neo_status((0, 0, 100)) # green = got data + print("Reply is OK!") + + if self._debug: + print(r.text) + + if self._image_json_path or self._json_path: + try: + gc.collect() + json_out = r.json() + gc.collect() + except ValueError: # failed to parse? + print("Couldn't parse json: ", r.text) + raise + except MemoryError: + supervisor.reload() + + if self._regexp_path: + import ure + + # extract desired text/values from json + if self._json_path: + for path in self._json_path: + values.append(PyPortal._json_traverse(json_out, path)) + elif self._regexp_path: + for regexp in self._regexp_path: + values.append(ure.search(regexp, r.text).group(1)) + else: + values = r.text + + if self._image_json_path: + try: + image_url = PyPortal._json_traverse(json_out, self._image_json_path) + except KeyError as error: + print("Error finding image data. '" + error.args[0] + "' not found.") + self.set_background(self._default_bg) + + # we're done with the requests object, lets delete it so we can do more! + json_out = None + r = None + gc.collect() + + if image_url: + try: + print("original URL:", image_url) + image_url = IMAGE_CONVERTER_SERVICE+image_url + print("convert URL:", image_url) + # convert image to bitmap and cache + #print("**not actually wgetting**") + self.wget(image_url, "/cache.bmp") + self.set_background("/cache.bmp") + except ValueError as error: + print("Error displaying cached image. " + error.args[0]) + self.set_background(self._default_bg) + finally: + image_url = None + gc.collect() + + # if we have a callback registered, call it now + if self._success_callback: + self._success_callback(values) + + # fill out all the text blocks + if self._text: + for i in range(len(self._text)): + string = None + try: + string = "{:,d}".format(int(values[i])) + except (TypeError, ValueError): + string = values[i] # ok its a string + if self._debug: + print("Drawing text", string) + if self._text_wrap[i]: + if self._debug: + print("Wrapping text") + string = '\n'.join(PyPortal.wrap_nicely(string, self._text_wrap[i])) + self.set_text(string, index=i) + if len(values) == 1: + return values[0] + return values + + def show_QR(self, qr_data, qr_size=128, position=None): # pylint: disable=invalid-name + """Display a QR code. + + :param qr_data: The data for the QR code. + :param int qr_size: The size of the QR code in pixels. + :param position: The position of the QR code on the display. + + """ + import adafruit_miniqr + + if not qr_data: # delete it + if self._qr_group: + try: + self._qr_group.pop() + except IndexError: + pass + board.DISPLAY.refresh_soon() + board.DISPLAY.wait_for_frame() + return + + if not position: + position = (0, 0) + if qr_size % 32 != 0: + raise RuntimeError("QR size must be divisible by 32") + + qrcode = adafruit_miniqr.QRCode() + qrcode.add_data(qr_data) + qrcode.make() + + # pylint: disable=invalid-name + # how big each pixel is, add 2 blocks on either side + BLOCK_SIZE = qr_size // (qrcode.matrix.width+4) + # Center the QR code in the middle + X_OFFSET = (qr_size - BLOCK_SIZE * qrcode.matrix.width) // 2 + Y_OFFSET = (qr_size - BLOCK_SIZE * qrcode.matrix.height) // 2 + + # monochome (2 color) palette + palette = displayio.Palette(2) + palette[0] = 0xFFFFFF + palette[1] = 0x000000 + + # bitmap the size of the matrix + borders, monochrome (2 colors) + qr_bitmap = displayio.Bitmap(qr_size, qr_size, 2) + + # raster the QR code + line = bytearray(qr_size // 8) # monochrome means 8 pixels per byte + for y in range(qrcode.matrix.height): # each scanline in the height + for i, _ in enumerate(line): # initialize it to be empty + line[i] = 0 + for x in range(qrcode.matrix.width): + if qrcode.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 + qr_bitmap._load_row(Y_OFFSET + y*BLOCK_SIZE+b, line) #pylint: disable=protected-access + # pylint: enable=invalid-name + + # display the bitmap using our palette + qr_sprite = displayio.Sprite(qr_bitmap, pixel_shader=palette, position=position) + if self._qr_group: + try: + self._qr_group.pop() + except IndexError: # later test if empty + pass + else: + self._qr_group = displayio.Group() + self.splash.append(self._qr_group) + self._qr_group.append(qr_sprite) + board.DISPLAY.refresh_soon() + board.DISPLAY.wait_for_frame() + + # return a list of lines with wordwrapping + @staticmethod + def wrap_nicely(string, max_chars): + """A list of lines with word wrapping. + + :param str string: The text to be wrapped. + :param int max_chars: The maximum number of characters on a line before wrapping. + + """ + words = string.split(' ') + the_lines = [] + the_line = "" + for w in words: + if len(the_line+' '+w) <= max_chars: + the_line += ' '+w + else: + the_lines.append(the_line) + the_line = ''+w + if the_line: # last line remaining + the_lines.append(the_line) + return the_lines diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..5aca98376a1f7e593ebd9cf41a808512c2135635 GIT binary patch literal 4414 zcmd^BX;4#F6n=SG-XmlONeGrD5E6J{RVh+e928U#MG!$jWvO+UsvWh`x&VqGNx*en zx=qox7Dqv{kPwo%fZC$dDwVpRtz{HzTkSs8QhG0)%Y=-3@Kt!4ag|JcIo?$-F|?bXVS9UDUyev>MVZQ(H8K4#;BQW-t2CPorj8^KJrMX}QK zp+e<;4ldpXz~=)2GxNy811&)gt-}Q*yVQpsxr@VMoA##{)$1~=bZ1MmjeFw?uT(`8 z^g=09<=zW%r%buwN%iHtuKSg|+r7HkT0PYN*_u9k1;^Ss-Z!RBfJ?Un4w(awqp2b3 z%+myoFis_lTlCrGx2z$0BQdh+7?!JK#9K9@Z!VrG zNj6gK5r(b4?YDOLw|DPRoN7bdP{(>GEG41YcN~4r_SUHU2hgVtUwZG@s%edC;k7Sn zC)RvEnlq~raE2mY2ko64^m1KQL}3riixh?#J{o)IT+K-RdHae2eRX91-+g!y`8^># z-zI0ir>P%Xon)!@xp-BK2bDYUB9k613NRrY6%lVjbFcQc*pRqiK~8xtkNPLxt}e?&QsTB}^!39t_%Qb)~Ukn0O%iC;zt z<&A-y;3h++)>c1br`5VFM~5(83!HKx$L+my8sW_c#@x*|*vB1yU)_dt3vH;2hqPWx zAl^6@?ipx&U7pf`a*>Yq6C85nb+B=Fnn+(id$W#WB^uHAcZVG`qg;rWB}ubvi(Y>D z$ei>REw$#xp0SHAd^|1hq&9HJ=jKK8^zTH~nk)G?yUcmTh9vUM6Y0LMw4(gYVY$D$ zGl&WY&H<)BbJ&3sYbKjx1j^=3-0Q#f^}(aP1?8^`&FUWMp|rmtpK)bLQ1Zo?^s4jqK=Lfg*9&geMGVQ z#^-*!V`fG@;H&{M9S8%+;|h&Qrxym0Ar>WT4BCVLR8cGXF=JmEYN(sNT(9vl+S|%g z8r7nXQ(95i^`=+XHo|){$vf2$?=`F$^&wFlYXyXg$B{a>$-Fp+V}+D;9k=~Xl~?C4 zAB-;RKXdUzBJE{V&d&%R>aEfFe;vxqI$0@hwVM}gFeQR@j}a>DDxR+n+-*6|_)k%% z*mSpDV|=5I9!&VC&9tD%fcVygWZV!iIo2qFtm#!*(s|@ZT33*Ad;+<|3^+yrp*;oH zBSYLV(H1zTU?2WjrCQoQW)Z>J2a=dTriuvezBmu16`tM2fm7Q@d4^iqII-xFpwHGI zn9CL}QE*1vdj2PX{PIuqOe5dracsciH6OlAZATvE8rj6ykqdIjal2 z0S0S~PwHb-5?OQ-tU-^KTG@XNrEVSvo|HIP?H;7ZhYeZkhSqh-{reE!5di;1zk$#Y zCe7rOnlzFYJ6Z#Hm$GoidKB=2HBCwm`BbZVeZY4ukmG%1uz7p2URs6c9j-Gjj^oQV zsdDb3@k2e`C$1I5ML5U0Qs0C1GAp^?!*`=|Nm(vWz3j*j*8ucum2;r0^-6Aca=Gv) zc%}&;!+_*S2tlnnJnz0EKeRmw-Y!@9ob!XQBwiv}^u9MkaXHvM=!<3YX;+2#5Cj5pp?FEK750S3BgeSDtaE^ zXUM@xoV6yBFKfzvY20V&Lr0yC + +.. 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/pyportal_simpletest.py b/examples/pyportal_simpletest.py new file mode 100644 index 0000000..e69de29 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..59a6957 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +Adafruit-Blinka +adafruit-circuitpython-busdevice +adafruit-circuitpython-touchscreen +adafruit-circuitpython-esp32spi +adafruit-circuitpython-bitmap-font +adafruit-circuitpython-display-text +adafruit-circuitpython-neopixel diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..b0452d0 --- /dev/null +++ b/setup.py @@ -0,0 +1,70 @@ +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='adafruit-circuitpython-pyportal', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='CircuitPython driver for Adafruit PyPortal.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_PyPortal', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka', + 'adafruit-circuitpython-busdevice', + 'adafruit-circuitpython-touchscreen', + 'adafruit-circuitpython-esp32spi', + 'adafruit-circuitpython-bitmapfont', + 'adafruit-circuitpython-displaytext', + 'adafruit-circuitpython-neopixel' + ], + + # Choose your license + license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries', + 'Topic :: System :: Hardware', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ], + + # What does your project relate to? + keywords='adafruit blinka circuitpython micropython pyportal iot internet display portal ' + 'wifi', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=['adafruit_pyportal'], +) From 235240015c28d352968777fcca6e112d06237580 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Sat, 23 Feb 2019 12:10:23 -0500 Subject: [PATCH 2/6] Remove non PyPI packages. --- requirements.txt | 2 -- 1 file changed, 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 59a6957..84ccba1 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,6 +2,4 @@ Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-touchscreen adafruit-circuitpython-esp32spi -adafruit-circuitpython-bitmap-font -adafruit-circuitpython-display-text adafruit-circuitpython-neopixel From f2293de26e3f602b016ab7d4ca6731d3e18b10fb Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Sat, 23 Feb 2019 12:14:59 -0500 Subject: [PATCH 3/6] Hidden linting. --- adafruit_pyportal.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/adafruit_pyportal.py b/adafruit_pyportal.py index 8893eea..d04f528 100644 --- a/adafruit_pyportal.py +++ b/adafruit_pyportal.py @@ -46,7 +46,6 @@ import os import time import gc -import rtc import supervisor import board import busio @@ -62,6 +61,7 @@ from adafruit_display_text.text_area import TextArea from adafruit_esp32spi import adafruit_esp32spi import adafruit_esp32spi.adafruit_esp32spi_requests as requests +import rtc try: from settings import settings @@ -135,7 +135,7 @@ def __init__(self, *, url=None, json_path=None, regexp_path=None, self._debug = debug try: - self._backlight = pulseio.PWMOut(board.TFT_BACKLIGHT) + self._backlight = pulseio.PWMOut(board.TFT_BACKLIGHT) # pylint: disable=no-member except ValueError: self._backlight = None self.set_backlight(1.0) # turn on backlight @@ -168,11 +168,13 @@ def __init__(self, *, url=None, json_path=None, regexp_path=None, # Make ESP32 connection if self._debug: print("Init ESP32") + # pylint: disable=no-member esp32_cs = DigitalInOut(microcontroller.pin.PB14) # PB14 esp32_ready = DigitalInOut(microcontroller.pin.PB16) esp32_gpio0 = DigitalInOut(microcontroller.pin.PB15) esp32_reset = DigitalInOut(microcontroller.pin.PB17) spi = busio.SPI(board.SCK, board.MOSI, board.MISO) + # pylint: enable=no-member if not self._uselocal: self._esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset, @@ -263,6 +265,7 @@ def __init__(self, *, url=None, json_path=None, regexp_path=None, if self._debug: print("Init touchscreen") + # pylint: disable=no-member self.touchscreen = adafruit_touchscreen.Touchscreen(microcontroller.pin.PB01, microcontroller.pin.PB08, microcontroller.pin.PA06, @@ -270,6 +273,7 @@ def __init__(self, *, url=None, json_path=None, regexp_path=None, calibration=((5200, 59000), (5800, 57000)), size=(320, 240)) + # pylint: enable=no-member self.set_backlight(1.0) # turn on backlight gc.collect() From 571d67c8a706859aa4f2d220890622cfc3a8725a Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Sat, 23 Feb 2019 12:18:15 -0500 Subject: [PATCH 4/6] More linting. --- adafruit_pyportal.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_pyportal.py b/adafruit_pyportal.py index d04f528..4cf6f5e 100644 --- a/adafruit_pyportal.py +++ b/adafruit_pyportal.py @@ -46,13 +46,8 @@ import os import time import gc -import supervisor import board import busio -import pulseio -import audioio -import displayio -import neopixel import microcontroller from digitalio import DigitalInOut import adafruit_touchscreen @@ -61,7 +56,12 @@ from adafruit_display_text.text_area import TextArea from adafruit_esp32spi import adafruit_esp32spi import adafruit_esp32spi.adafruit_esp32spi_requests as requests +import neopixel +import displayio +import audioio +import pulseio import rtc +import supervisor try: from settings import settings From 092210c5b3b8f1a4e291acf5b7b1b67086afd691 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Sat, 23 Feb 2019 12:22:19 -0500 Subject: [PATCH 5/6] all about that order. --- adafruit_pyportal.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/adafruit_pyportal.py b/adafruit_pyportal.py index 4cf6f5e..690faef 100644 --- a/adafruit_pyportal.py +++ b/adafruit_pyportal.py @@ -51,15 +51,16 @@ import microcontroller from digitalio import DigitalInOut import adafruit_touchscreen +import pulseio +import neopixel -from adafruit_bitmap_font import bitmap_font -from adafruit_display_text.text_area import TextArea from adafruit_esp32spi import adafruit_esp32spi import adafruit_esp32spi.adafruit_esp32spi_requests as requests -import neopixel +from adafruit_display_text.text_area import TextArea +from adafruit_bitmap_font import bitmap_font + import displayio import audioio -import pulseio import rtc import supervisor From b207d3c52ad914ee1afd98d235ceb4db09c23add Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Sat, 23 Feb 2019 12:27:21 -0500 Subject: [PATCH 6/6] Updated req.txt --- requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/requirements.txt b/requirements.txt index 84ccba1..7b80f3d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,5 @@ Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-touchscreen adafruit-circuitpython-esp32spi +adafruit-circuitpython-bitmap-font adafruit-circuitpython-neopixel