diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c4c975d..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,66 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit - run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal - twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 6d0015a..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,85 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 9647e71..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,48 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8810708..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,34 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black - rev: 20.8b1 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 - hooks: - - id: pylint - name: pylint (library code) - types: [python] - exclude: "^(docs/|examples/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) - description: Run pylint rules on "examples/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] - language: system + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 0238b90..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[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 - -# 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,bad-continuation - -# 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=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# 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.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..255dafd --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-lts-latest + tools: + python: "3" + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index ffa84c4..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: requirements.txt diff --git a/README.rst b/README.rst index 486cef8..a679ee3 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-esp-atcontrol/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/esp-atcontrol/en/latest/ + :target: https://docs.circuitpython.org/projects/esp-atcontrol/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord @@ -13,6 +13,13 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol/actions/ :alt: Build Status +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff + +This library is no longer supported! The library is being left available for continued usage, however, Adafruit is no longer supporting it. +=========================================================================================================================================== + Use the ESP AT command sent to communicate with the Interwebs. Its slow, but works to get data into CircuitPython Command set: https://www.espressif.com/sites/default/files/documentation/4a-esp8266_at_instruction_set_en.pdf @@ -25,6 +32,8 @@ Dependencies This driver depends on: * `Adafruit CircuitPython `_ +* `Adafruit CircuitPython ConnectionManager `_ +* `Adafruit CircuitPython Requests `_ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading @@ -51,8 +60,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-esp-atcontrol Usage Example @@ -64,7 +73,9 @@ See examples folder for full demos Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ @@ -72,8 +83,3 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. diff --git a/adafruit_espatcontrol/__init__.py b/adafruit_espatcontrol/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/adafruit_espatcontrol/adafruit_espatcontrol.py b/adafruit_espatcontrol/adafruit_espatcontrol.py index 309663f..0bbcd06 100644 --- a/adafruit_espatcontrol/adafruit_espatcontrol.py +++ b/adafruit_espatcontrol/adafruit_espatcontrol.py @@ -34,9 +34,17 @@ import gc import time -from digitalio import Direction -__version__ = "0.0.0-auto.0" +from digitalio import DigitalInOut, Direction + +try: + from typing import Dict, List, Optional, Union + + import busio +except ImportError: + pass + +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_espATcontrol.git" @@ -50,7 +58,6 @@ class ESP_ATcontrol: AT command firmware, you can use esptool or our CircuitPython miniesptool to upload firmware""" - # pylint: disable=too-many-public-methods, too-many-instance-attributes MODE_STATION = 1 MODE_SOFTAP = 2 MODE_SOFTAPSTATION = 3 @@ -59,21 +66,28 @@ class ESP_ATcontrol: TYPE_UDP = "UDP" TYPE_SSL = "SSL" TLS_MODE = "SSL" - STATUS_APCONNECTED = 2 - STATUS_SOCKETOPEN = 3 - STATUS_SOCKETCLOSED = 4 - STATUS_NOTCONNECTED = 5 + STATUS_APCONNECTED = 2 # CIPSTATUS method + STATUS_WIFI_APCONNECTED = 2 # CWSTATE method + STATUS_SOCKETOPEN = 3 # CIPSTATUS method + STATUS_SOCKET_OPEN = 3 # CIPSTATE method + STATUS_SOCKETCLOSED = 4 # CIPSTATUS method + STATUS_SOCKET_CLOSED = 4 # CIPSTATE method + STATUS_NOTCONNECTED = 5 # CIPSTATUS method + STATUS_WIFI_NOTCONNECTED = 1 # CWSTATE method + STATUS_WIFI_DISCONNECTED = 4 # CWSTATE method + USER_AGENT = "esp-idf/1.0 esp32" def __init__( self, - uart, - default_baudrate, + uart: busio.UART, + default_baudrate: int, *, - run_baudrate=None, - rts_pin=None, - reset_pin=None, - debug=False + run_baudrate: Optional[int] = None, + rts_pin: Optional[DigitalInOut] = None, + reset_pin: Optional[DigitalInOut] = None, + debug: bool = False, + use_cipstatus: bool = False, ): """This function doesn't try to do any sync'ing, just sets up # the hardware, that way nothing can unexpectedly fail!""" @@ -99,8 +113,10 @@ def __init__( self._ipdpacket = bytearray(1500) self._ifconfig = [] self._initialized = False + self._conntype = None + self._use_cipstatus = use_cipstatus - def begin(self): + def begin(self) -> None: """Initialize the module by syncing, resetting if necessary, setting up the desired baudrate, turning on single-socket mode, and configuring SSL support. Required before using the module but we dont do in __init__ @@ -123,33 +139,92 @@ def begin(self): except OKError: # ESP32 doesnt use CIPSSLSIZE, its ok! self.at_response("AT+CIPSSLCCONF?") + + try: + self.at_response("AT+CWSTATE?", retries=1, timeout=3) + except OKError: + # ESP8285's use CIPSTATUS and have no CWSTATE or CWIPSTATUS functions + self._use_cipstatus = True + if self._debug: + print("No CWSTATE support, using CIPSTATUS, it's ok!") + self._initialized = True return except OKError: pass # retry - def connect(self, secrets): + def connect( + self, secrets: Dict[str, Union[str, int]], timeout: int = 15, retries: int = 3 + ) -> None: """Repeatedly try to connect to an access point with the details in the passed in 'secrets' dictionary. Be sure 'ssid' and 'password' are defined in the secrets dict! If 'timezone' is set, we'll also configure SNTP""" # Connect to WiFi if not already + try: + if not self._initialized: + self.begin() + AP = self.remote_AP + if AP[0] != secrets["ssid"]: + self.join_AP( + secrets["ssid"], + secrets["password"], + timeout=timeout, + retries=retries, + ) + print("Connected to", secrets["ssid"]) + if "timezone" in secrets: + tzone = secrets["timezone"] + ntp = None + if "ntp_server" in secrets: + ntp = secrets["ntp_server"] + self.sntp_config(True, tzone, ntp) + print("My IP Address:", self.local_ip) + else: + print("Already connected to", AP[0]) + return # yay! + except (RuntimeError, OKError) as exp: + print("Failed to connect\n", exp) + raise + + def connect_enterprise( + self, secrets: Dict[str, Union[str, int]], timeout: int = 15, retries: int = 3 + ) -> None: + """Repeatedly try to connect to an enterprise access point with the details in + the passed in 'secrets' dictionary. Be sure 'ssid','password','username','identity' + and 'method' are defined in the secrets dict! If 'timezone' is set, we'll also + configure SNTP""" + # Connect to WiFi if not already retries = 3 + if self._debug: + print("In connect_enterprise()") while True: try: if not self._initialized or retries == 0: self.begin() retries = 3 - AP = self.remote_AP # pylint: disable=invalid-name - print("Connected to", AP[0]) + AP = self.remote_AP + if AP[0] is not None: + print("Connected to", AP[0]) if AP[0] != secrets["ssid"]: - self.join_AP(secrets["ssid"], secrets["password"]) + if self._debug: + print("Doing Enterprise connection sequence") + self.join_AP_Enterprise( + secrets["ssid"], + secrets["username"], + secrets["identity"], + secrets["password"], + secrets["method"], + timeout=timeout, + retries=retries, + ) if "timezone" in secrets: tzone = secrets["timezone"] ntp = None if "ntp_server" in secrets: ntp = secrets["ntp_server"] self.sntp_config(True, tzone, ntp) + print("Connected to", self.remote_AP[0]) print("My IP Address:", self.local_ip) return # yay! except (RuntimeError, OKError) as exp: @@ -157,10 +232,18 @@ def connect(self, secrets): retries -= 1 continue + def set_autoconnect(self, autoconnect: bool) -> None: + """Set the auto connection status if the wifi connects automatically on powerup""" + if autoconnect is True: + auto_flag = "1" + else: + auto_flag = "0" + self.at_response("AT+CWAUTOCONN=" + auto_flag) + # *************************** SOCKET SETUP **************************** @property - def cipmux(self): + def cipmux(self) -> int: """The IP socket multiplexing setting. 0 for one socket, 1 for multi-socket""" replies = self.at_response("AT+CIPMUX?", timeout=3).split(b"\r\n") for reply in replies: @@ -168,20 +251,55 @@ def cipmux(self): return int(reply[8:]) raise RuntimeError("Bad response to CIPMUX?") - def socket_connect(self, conntype, remote, remote_port, *, keepalive=10, retries=1): + def socket_connect( + self, + conntype: str, + remote: str, + remote_port: int, + *, + keepalive: int = 10, + retries: int = 1, + ) -> bool: """Open a socket. conntype can be TYPE_TCP, TYPE_UDP, or TYPE_SSL. Remote can be an IP address or DNS (we'll do the lookup for you. Remote port - is integer port on other side. We can't set the local port""" + is integer port on other side. We can't set the local port. + + Note that this method is usually called by the requests-package, which + does not know anything about conntype. So it is mandatory to set + the conntype manually before calling this method if the conntype-parameter + is not provided. + + If requests are done using ESPAT_WiFiManager, the conntype is set there + depending on the protocol (http/https).""" + + # if caller does not provide conntype, use default conntype from + # object if set, otherwise fall back to old buggy logic + if not conntype and self._conntype: + conntype = self._conntype + elif not conntype: + # old buggy code from espatcontrol_socket + # added here for compatibility with old code + if remote_port == 80: + conntype = self.TYPE_TCP + elif remote_port == 443: + conntype = self.TYPE_SSL + # to cater for MQTT over TCP + elif remote_port == 1883: + conntype = self.TYPE_TCP + # lets just do one connection at a time for now + if conntype == self.TYPE_UDP: + # always disconnect for TYPE_UDP + self.socket_disconnect() while True: stat = self.status - if stat in (self.STATUS_APCONNECTED, self.STATUS_SOCKETCLOSED): + if stat in {self.STATUS_APCONNECTED, self.STATUS_SOCKETCLOSED}: break if stat == self.STATUS_SOCKETOPEN: self.socket_disconnect() else: time.sleep(1) - if not conntype in (self.TYPE_TCP, self.TYPE_UDP, self.TYPE_SSL): + if conntype not in {self.TYPE_TCP, self.TYPE_UDP, self.TYPE_SSL}: raise RuntimeError("Connection type must be TCP, UDL or SSL") cmd = ( 'AT+CIPSTART="' @@ -193,13 +311,21 @@ def socket_connect(self, conntype, remote, remote_port, *, keepalive=10, retries + "," + str(keepalive) ) + if self._debug is True: + print("socket_connect(): Going to send command") replies = self.at_response(cmd, timeout=10, retries=retries).split(b"\r\n") for reply in replies: - if reply == b"CONNECT" and self.status == self.STATUS_SOCKETOPEN: + if reply == b"CONNECT" and ( + conntype in {self.TYPE_TCP, self.TYPE_SSL} + and self.status == self.STATUS_SOCKETOPEN + or conntype == self.TYPE_UDP + ): + self._conntype = conntype return True + return False - def socket_send(self, buffer, timeout=1): + def socket_send(self, buffer: bytes, timeout: int = 1) -> bool: """Send data over the already-opened socket, buffer must be bytes""" cmd = "AT+CIPSEND=%d" % len(buffer) self.at_response(cmd, timeout=5, retries=1) @@ -218,6 +344,8 @@ def socket_send(self, buffer, timeout=1): raise RuntimeError("Didn't get data prompt for sending") self._uart.reset_input_buffer() self._uart.write(buffer) + if self._conntype == self.TYPE_UDP: + return True stamp = time.monotonic() response = b"" while (time.monotonic() - stamp) < timeout: @@ -232,8 +360,7 @@ def socket_send(self, buffer, timeout=1): # Get newlines off front and back, then split into lines return True - def socket_receive(self, timeout=5): - # pylint: disable=too-many-nested-blocks, too-many-branches + def socket_receive(self, timeout: int = 5) -> bytearray: """Check for incoming data over the open socket, returns bytes""" incoming_bytes = None bundle = [] @@ -254,22 +381,17 @@ def socket_receive(self, timeout=5): continue i += 1 # look for the IPD message - if (ipd_start in self._ipdpacket) and chr( - self._ipdpacket[i - 1] - ) == ":": + if (ipd_start in self._ipdpacket) and chr(self._ipdpacket[i - 1]) == ":": try: ipd = str(self._ipdpacket[5 : i - 1], "utf-8") incoming_bytes = int(ipd) if self._debug: print("Receiving:", incoming_bytes) except ValueError as err: - raise RuntimeError( - "Parsing error during receive", ipd - ) from err + raise RuntimeError("Parsing error during receive", ipd) from err i = 0 # reset the input buffer now that we know the size elif i > 20: i = 0 # Hmm we somehow didnt get a proper +IPD packet? start over - else: self.hw_flow(False) # stop the flow # read as much as we can! @@ -286,20 +408,20 @@ def socket_receive(self, timeout=5): break # We've received all the data. Don't wait until timeout. else: # no data waiting self.hw_flow(True) # start the floooow - totalsize = sum([len(x) for x in bundle]) + totalsize = sum(len(x) for x in bundle) ret = bytearray(totalsize) i = 0 for x in bundle: for char in x: ret[i] = char i += 1 - for x in bundle: - del x + del bundle gc.collect() return ret - def socket_disconnect(self): + def socket_disconnect(self) -> None: """Close any open socket, if there is one""" + self._conntype = None try: self.at_response("AT+CIPCLOSE", retries=1) except OKError: @@ -307,7 +429,9 @@ def socket_disconnect(self): # *************************** SNTP SETUP **************************** - def sntp_config(self, enable, timezone=None, server=None): + def sntp_config( + self, enable: bool, timezone: Optional[int] = None, server: Optional[str] = None + ) -> None: """Configure the built in ESP SNTP client with a UTC-offset number (timezone) and server as IP or hostname.""" cmd = "AT+CIPSNTPCFG=" @@ -322,7 +446,7 @@ def sntp_config(self, enable, timezone=None, server=None): self.at_response(cmd, timeout=3) @property - def sntp_time(self): + def sntp_time(self) -> Union[bytes, None]: """Return a string with time/date information using SNTP, may return 1970 'bad data' on the first few minutes, without warning!""" replies = self.at_response("AT+CIPSNTPTIME?", timeout=5).split(b"\r\n") @@ -334,7 +458,7 @@ def sntp_time(self): # *************************** WIFI SETUP **************************** @property - def is_connected(self): + def is_connected(self) -> bool: """Initialize module if not done yet, and check if we're connected to an access point, returns True or False""" if not self._initialized: @@ -343,27 +467,112 @@ def is_connected(self): self.echo(False) self.baudrate = self.baudrate stat = self.status - if stat in ( + if stat in { self.STATUS_APCONNECTED, self.STATUS_SOCKETOPEN, self.STATUS_SOCKETCLOSED, - ): + }: + if self._debug: + print("is_connected(): status says connected") return True except (OKError, RuntimeError): pass + if self._debug: + print("is_connected(): status says not connected") return False @property - def status(self): + def status(self) -> Union[int, None]: """The IP connection status number (see AT+CIPSTATUS datasheet for meaning)""" - replies = self.at_response("AT+CIPSTATUS", timeout=5).split(b"\r\n") + if self._use_cipstatus: + replies = self.at_response("AT+CIPSTATUS", timeout=5).split(b"\r\n") + for reply in replies: + if reply.startswith(b"STATUS:"): + if self._debug: + print(f"CIPSTATUS state is {int(reply[7:8])}") + return int(reply[7:8]) + else: + status_w = self.status_wifi + status_s = self.status_socket + + # debug only, Check CIPSTATUS messages against CWSTATE/CIPSTATE + if self._debug: + replies = self.at_response("AT+CIPSTATUS", timeout=5).split(b"\r\n") + for reply in replies: + if reply.startswith(b"STATUS:"): + cipstatus = int(reply[7:8]) + print(f"STATUS: CWSTATE: {status_w}, CIPSTATUS: {cipstatus}, CIPSTATE: {status_s}") + + # Produce a cipstatus-compatible status code + # Codes are not the same between CWSTATE/CIPSTATUS so in some combinations + # we just pick what we hope is best. + if status_w in { + self.STATUS_WIFI_NOTCONNECTED, + self.STATUS_WIFI_DISCONNECTED, + }: + if self._debug: + print(f"STATUS returning {self.STATUS_NOTCONNECTED}") + return self.STATUS_NOTCONNECTED + + if status_s == self.STATUS_SOCKET_OPEN: + if self._debug: + print(f"STATUS returning {self.STATUS_SOCKETOPEN}") + return self.STATUS_SOCKETOPEN + + if status_w == self.STATUS_WIFI_APCONNECTED: + if self._debug: + print(f"STATUS returning {self.STATUS_APCONNECTED}") + return self.STATUS_APCONNECTED + + # handle extra codes from CWSTATE + if status_w == 0: # station has not started any Wi-Fi connection. + if self._debug: + print("STATUS returning 1") + return 1 # this cipstatus had no previous handler variable + + if ( + status_w == 1 + ): # station has connected to an AP, but does not get an IPv4 address yet. + if self._debug: + print("STATUS returning 1") + return 1 # this cipstatus had no previous handler variable + + if status_w == 3: # station is in Wi-Fi connecting or reconnecting state. + if self._debug: + print(f"STATUS returning {self.STATUS_NOTCONNECTED}") + return self.STATUS_NOTCONNECTED + + if status_s == self.STATUS_SOCKET_CLOSED: + if self._debug: + print(f"STATUS returning {self.STATUS_SOCKET_CLOSED}") + return self.STATUS_SOCKET_CLOSED + + return None + + @property + def status_wifi(self) -> Union[int, None]: + """The WIFI connection status number (see AT+CWSTATE datasheet for meaning)""" + replies = self.at_response("AT+CWSTATE?", timeout=5).split(b"\r\n") for reply in replies: - if reply.startswith(b"STATUS:"): - return int(reply[7:8]) + if reply.startswith(b"+CWSTATE:"): + state_info = reply.split(b",") + if self._debug: + print(f"State reply is {reply}, state_info[1] is {int(state_info[0][9:10])}") + return int(state_info[0][9:10]) return None @property - def mode(self): + def status_socket(self) -> Union[int, None]: + """The Socket connection status number (see AT+CIPSTATE for meaning)""" + replies = self.at_response("AT+CIPSTATE?", timeout=5).split(b"\r\n") + for reply in replies: + # If there are any +CIPSTATE lines that means it's an open socket + if reply.startswith(b"+CIPSTATE:"): + return self.STATUS_SOCKET_OPEN + return self.STATUS_SOCKET_CLOSED + + @property + def mode(self) -> Union[int, None]: """What mode we're in, can be MODE_STATION, MODE_SOFTAP or MODE_SOFTAPSTATION""" if not self._initialized: self.begin() @@ -374,16 +583,26 @@ def mode(self): raise RuntimeError("Bad response to CWMODE?") @mode.setter - def mode(self, mode): + def mode(self, mode: int) -> None: """Station or AP mode selection, can be MODE_STATION, MODE_SOFTAP or MODE_SOFTAPSTATION""" if not self._initialized: self.begin() - if not mode in (1, 2, 3): + if mode not in {1, 2, 3}: raise RuntimeError("Invalid Mode") self.at_response("AT+CWMODE=%d" % mode, timeout=3) @property - def local_ip(self): + def conntype(self) -> Union[str, None]: + """The configured connection-type""" + return self._conntype + + @conntype.setter + def conntype(self, conntype: str) -> None: + """set connection-type for subsequent socket_connect()""" + self._conntype = conntype + + @property + def local_ip(self) -> Union[str, None]: """Our local IP address as a dotted-quad string""" reply = self.at_response("AT+CIFSR").strip(b"\r\n") for line in reply.split(b"\r\n"): @@ -391,7 +610,7 @@ def local_ip(self): return str(line[14:-1], "utf-8") raise RuntimeError("Couldn't find IP address") - def ping(self, host): + def ping(self, host: str) -> Union[int, None]: """Ping the IP or hostname given, returns ms time or None on failure""" reply = self.at_response('AT+PING="%s"' % host.strip('"'), timeout=5) for line in reply.split(b"\r\n"): @@ -404,7 +623,7 @@ def ping(self, host): return None raise RuntimeError("Couldn't ping") - def nslookup(self, host): + def nslookup(self, host: str) -> Union[str, None]: """Return a dotted-quad IP address strings that matches the hostname""" reply = self.at_response('AT+CIPDOMAIN="%s"' % host.strip('"'), timeout=3) for line in reply.split(b"\r\n"): @@ -415,7 +634,7 @@ def nslookup(self, host): # *************************** AP SETUP **************************** @property - def remote_AP(self): # pylint: disable=invalid-name + def remote_AP(self) -> List[Union[int, str, None]]: """The name of the access point we're connected to, as a string""" stat = self.status if stat != self.STATUS_APCONNECTED: @@ -434,29 +653,120 @@ def remote_AP(self): # pylint: disable=invalid-name return reply return [None] * 4 - def join_AP(self, ssid, password): # pylint: disable=invalid-name + def join_AP(self, ssid: str, password: str, timeout: int = 15, retries: int = 3) -> None: """Try to join an access point by name and password, will return immediately if we're already connected and won't try to reconnect""" # First make sure we're in 'station' mode so we can connect to AP's + if self._debug: + print("In join_AP()") if self.mode != self.MODE_STATION: self.mode = self.MODE_STATION router = self.remote_AP if router and router[0] == ssid: return # we're already connected! - for _ in range(3): - reply = self.at_response( - 'AT+CWJAP="' + ssid + '","' + password + '"', timeout=15, retries=3 - ) - if b"WIFI CONNECTED" not in reply: - print("no CONNECTED") - raise RuntimeError("Couldn't connect to WiFi") - if b"WIFI GOT IP" not in reply: - print("no IP") - raise RuntimeError("Didn't get IP address") - return - - def scan_APs(self, retries=3): # pylint: disable=invalid-name + reply = self.at_response( + 'AT+CWJAP="' + ssid + '","' + password + '"', + timeout=timeout, + retries=retries, + ) + if b"WIFI CONNECTED" not in reply: + print("no CONNECTED") + raise RuntimeError("Couldn't connect to WiFi") + if b"WIFI GOT IP" not in reply: + print("no IP") + raise RuntimeError("Didn't get IP address") + return + + def join_AP_Enterprise( + self, + ssid: str, + username: str, + identity: str, + password: str, + method: int, + timeout: int = 30, + retries: int = 3, + ) -> None: + """Try to join an Enterprise access point by name and password, will return + immediately if we're already connected and won't try to reconnect""" + # Not sure how to verify certificates so we set that to not verify. + certificate_security = 0 # Bit0: Client certificate.Bit1: Server certificate. + + if self._debug: + print("In join_AP_Enterprise()") + if self.mode != self.MODE_STATION: + self.mode = self.MODE_STATION + + router = self.remote_AP + if router and router[0] == ssid: + return # we're already connected! + reply = self.at_response( + 'AT+CWJEAP="' + + ssid + + '",' + + str(method) + + ',"' + + identity + + '","' + + username + + '","' + + password + + '",' + + str(certificate_security), + timeout=timeout, + retries=retries, + ) + if b"WIFI CONNECTED" not in reply: + print("no CONNECTED") + raise RuntimeError("Couldn't connect to Enterprise WiFi") + if b"WIFI GOT IP" not in reply: + print("no IP") + raise RuntimeError("Didn't get IP address") + return + + def disconnect(self, timeout: int = 5, retries: int = 3): + """Disconnect from the AP. Tries whether connected or not.""" + # If we're not connected we likely don't get a "WIFI DISCONNECT" and just get the OK + # Note it still tries to disconnect even if it says we're not connected. + if not self._initialized: + self.begin() + stat = self.status + if stat in { + self.STATUS_APCONNECTED, + self.STATUS_SOCKETOPEN, + self.STATUS_SOCKETCLOSED, + }: + wait_for_disconnect = True + else: + wait_for_disconnect = False + if self._debug is True: + print("disconnect(): Not connected, not waiting for disconnect message") + reply = self.at_response("AT+CWQAP", timeout=timeout, retries=retries) + # Don't bother waiting for disconnect message if we weren't connected already + # sometimes the "WIFI DISCONNECT" shows up in the reply and sometimes it doesn't. + if wait_for_disconnect is True: + if b"WIFI DISCONNECT" in reply: + if self._debug is True: + print(f"disconnect(): Got WIFI DISCONNECT: {reply}") + else: + stamp = time.monotonic() + response = b"" + while (time.monotonic() - stamp) < timeout: + if self._uart.in_waiting: + response += self._uart.read(1) + self.hw_flow(False) + if response[-15:] == b"WIFI DISCONNECT": + break + else: + self.hw_flow(True) + if self._debug: + if response[-15:] == b"WIFI DISCONNECT": + print(f"disconnect(): Got WIFI DISCONNECT: {response}") + else: + print(f"disconnect(): Timed out wating for WIFI DISCONNECT: {response}") + + def scan_APs(self, retries: int = 3) -> Union[List[List[bytes]], None]: """Ask the module to scan for access points and return a list of lists with name, RSSI, MAC addresses, etc""" for _ in range(retries): @@ -482,11 +792,11 @@ def scan_APs(self, retries=3): # pylint: disable=invalid-name # ************************** AT LOW LEVEL **************************** @property - def version(self): + def version(self) -> Union[str, None]: """The cached version string retrieved via the AT+GMR command""" return self._version - def get_version(self): + def get_version(self) -> Union[str, None]: """Request the AT firmware version string and parse out the version number""" reply = self.at_response("AT+GMR", timeout=3).strip(b"\r\n") @@ -499,17 +809,16 @@ def get_version(self): self._version = str(line, "utf-8") return self._version - def hw_flow(self, flag): + def hw_flow(self, flag: bool) -> None: """Turn on HW flow control (if available) on to allow data, or off to stop""" if self._rts_pin: self._rts_pin.value = not flag - def at_response(self, at_cmd, timeout=5, retries=3): + def at_response(self, at_cmd: str, timeout: int = 5, retries: int = 3) -> bytes: """Send an AT command, check that we got an OK response, and then cut out the reply lines to return. We can set a variable timeout (how long we'll wait for response) and how many times to retry before giving up""" - # pylint: disable=too-many-branches for _ in range(retries): self.hw_flow(True) # allow any remaning data to stream in time.sleep(0.1) # wait for uart data @@ -523,18 +832,17 @@ def at_response(self, at_cmd, timeout=5, retries=3): response = b"" while (time.monotonic() - stamp) < timeout: if self._uart.in_waiting: - response += self._uart.read(self._uart.in_waiting) + response += self._uart.read(1) self.hw_flow(False) if response[-4:] == b"OK\r\n": break if response[-7:] == b"ERROR\r\n": break - if "AT+CWJAP=" in at_cmd: + if "AT+CWJAP=" in at_cmd or "AT+CWJEAP=" in at_cmd: if b"WIFI GOT IP\r\n" in response: break - else: - if b"WIFI CONNECTED\r\n" in response: - break + elif b"WIFI CONNECTED\r\n" in response: + break if b"ERR CODE:" in response: break else: @@ -545,16 +853,22 @@ def at_response(self, at_cmd, timeout=5, retries=3): # special case, AT+CWJAP= does not return an ok :P if "AT+CWJAP=" in at_cmd and b"WIFI GOT IP\r\n" in response: return response + # special case, AT+CWJEAP= does not return an ok :P + if "AT+CWJEAP=" in at_cmd and b"WIFI GOT IP\r\n" in response: + return response + if "AT+CWQAP=" in at_cmd and b"WIFI DISCONNECT" in response: + return response # special case, ping also does not return an OK if "AT+PING" in at_cmd and b"ERROR\r\n" in response: return response - if response[-4:] != b"OK\r\n": + # special case, does return OK but in fact it is busy + if "AT+CIFSR" in at_cmd and b"busy" in response or response[-4:] != b"OK\r\n": time.sleep(1) continue return response[:-4] raise OKError("No OK response to " + at_cmd) - def sync(self): + def sync(self) -> bool: """Check if we have AT commmand sync by sending plain ATs""" try: self.at_response("AT", timeout=1) @@ -563,12 +877,12 @@ def sync(self): return False @property - def baudrate(self): + def baudrate(self) -> int: """The baudrate of our UART connection""" return self._uart.baudrate @baudrate.setter - def baudrate(self, baudrate): + def baudrate(self, baudrate: int) -> None: """Change the modules baudrate via AT commands and then check that we're still sync'd.""" at_cmd = "AT+UART_CUR=" + str(baudrate) + ",8,1,0," @@ -588,34 +902,50 @@ def baudrate(self, baudrate): if not self.sync(): raise RuntimeError("Failed to resync after Baudrate change") - def echo(self, echo): + def echo(self, echo: bool) -> None: """Set AT command echo on or off""" if echo: self.at_response("ATE1", timeout=1) else: self.at_response("ATE0", timeout=1) - def soft_reset(self): + def soft_reset(self, timeout: int = 5) -> bool: """Perform a software reset by AT command. Returns True if we successfully performed, false if failed to reset""" try: self._uart.reset_input_buffer() reply = self.at_response("AT+RST", timeout=1) - if reply.strip(b"\r\n") == b"AT+RST": - time.sleep(2) - self._uart.reset_input_buffer() - return True + if self._debug: + print(f"Resetting with AT+RST, reply was {reply}") + stamp = time.monotonic() + response = b"" + while (time.monotonic() - stamp) < timeout: + if self._uart.in_waiting: + response += self._uart.read(1) + self.hw_flow(False) + if response[-5:] == b"ready": + break + else: + self.hw_flow(True) + if self._debug: + if response[-5:] == b"ready": + print(f"soft_reset(): Got ready: {response}") + else: + print(f"soft_reset(): imed out waiting for ready: {response}") + self._uart.reset_input_buffer() + self.sync() + return True except OKError: pass # fail, see below return False - def factory_reset(self): + def factory_reset(self) -> None: """Perform a hard reset, then send factory restore settings request""" self.hard_reset() self.at_response("AT+RESTORE", timeout=1) self._initialized = False - def hard_reset(self): + def hard_reset(self) -> None: """Perform a hardware reset by toggling the reset pin, if it was defined in the initialization of this object""" if self._reset_pin: @@ -627,3 +957,18 @@ def hard_reset(self): time.sleep(3) # give it a few seconds to wake up self._uart.reset_input_buffer() self._initialized = False + + def deep_sleep(self, duration_ms: int) -> bool: + """Execute deep-sleep command. + Passing zero as argument will put the chip into deep-sleep forever + until the RST-pin is pulled low (method hard_reset()). + This is the typical use-case for an ESP8266 as coprocessor. + + Note that a similar method in the Arduino-libs expects microseconds. + """ + cmd = "AT+GSLP=" + str(duration_ms) + try: + self.at_response(cmd, retries=1) + return True + except OKError: + return False diff --git a/adafruit_espatcontrol/adafruit_espatcontrol_socket.py b/adafruit_espatcontrol/adafruit_espatcontrol_socket.py index 1761191..6dd4339 100644 --- a/adafruit_espatcontrol/adafruit_espatcontrol_socket.py +++ b/adafruit_espatcontrol/adafruit_espatcontrol_socket.py @@ -3,22 +3,37 @@ # SPDX-License-Identifier: MIT """A 'socket' compatible interface thru the ESP AT command set""" + from micropython import const -_the_interface = None # pylint: disable=invalid-name +try: + from typing import List, Optional, Tuple + + from .adafruit_espatcontrol import ESP_ATcontrol +except ImportError: + pass + +_the_interface = None -def set_interface(iface): +def set_interface(iface: ESP_ATcontrol) -> None: """Helper to set the global internet interface""" - global _the_interface # pylint: disable=global-statement, invalid-name + global _the_interface # noqa: PLW0603 _the_interface = iface SOCK_STREAM = const(1) AF_INET = const(2) -# pylint: disable=too-many-arguments, unused-argument -def getaddrinfo(host, port, family=0, socktype=0, proto=0, flags=0): + +def getaddrinfo( + host: str, + port: int, + family: int = 0, + socktype: int = 0, + proto: int = 0, + flags: int = 0, +) -> List[Tuple[int, int, int, str, Tuple[str, int]]]: """Given a hostname and a port name, return a 'socket.getaddrinfo' compatible list of tuples. Honestly, we ignore anything but host & port""" if not isinstance(port, int): @@ -27,15 +42,17 @@ def getaddrinfo(host, port, family=0, socktype=0, proto=0, flags=0): return [(AF_INET, socktype, proto, "", (ipaddr, port))] -# pylint: enable=too-many-arguments, unused-argument - - -# pylint: disable=unused-argument, redefined-builtin, invalid-name class socket: """A simplified implementation of the Python 'socket' class, for connecting through an interface to a remote device""" - def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None): + def __init__( + self, + family: int = AF_INET, + type: int = SOCK_STREAM, + proto: int = 0, + fileno: Optional[int] = None, + ) -> None: if family != AF_INET: raise RuntimeError("Only AF_INET family supported") if type != SOCK_STREAM: @@ -43,29 +60,21 @@ def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, fileno=None): self._buffer = b"" self.settimeout(0) - def connect(self, address, conntype=None): + def connect(self, address: Tuple[str, int], conntype: Optional[str] = None) -> None: """Connect the socket to the 'address' (which should be dotted quad IP). 'conntype' - is an extra that may indicate SSL or not, depending on the underlying interface""" + is an extra that may indicate SSL or not, depending on the underlying interface + """ host, port = address - # Determine the conntype from port if not specified. - if conntype is None: - if port == 80: - conntype = "TCP" - elif port == 443: - conntype = "SSL" - - if not _the_interface.socket_connect( - conntype, host, port, keepalive=10, retries=3 - ): + if not _the_interface.socket_connect(conntype, host, port, keepalive=10, retries=3): raise RuntimeError("Failed to connect to host", host) self._buffer = b"" - def send(self, data): # pylint: disable=no-self-use + def send(self, data: bytes) -> None: # noqa: PLR6301 """Send some data to the socket""" _the_interface.socket_send(data) - def readline(self): + def readline(self) -> bytes: """Attempt to return as many bytes as we can up to but not including '\r\n'""" if b"\r\n" not in self._buffer: # there's no line already in there, read some more @@ -74,7 +83,7 @@ def readline(self): firstline, self._buffer = self._buffer.split(b"\r\n", 1) return firstline - def recv(self, num=0): + def recv(self, num: int = 0) -> bytes: """Read up to 'num' bytes from the socket, this may be buffered internally! If 'num' isnt specified, return everything in the buffer.""" if num == 0: @@ -83,24 +92,17 @@ def recv(self, num=0): self._buffer = b"" else: if self._buffer == b"": - self._buffer = self._buffer + _the_interface.socket_receive( - timeout=self._timeout - ) + self._buffer = self._buffer + _the_interface.socket_receive(timeout=self._timeout) ret = self._buffer[:num] self._buffer = self._buffer[num:] return ret - def close(self): + def close(self) -> None: """Close the socket, after reading whatever remains""" # read whatever's left - self._buffer = self._buffer + _the_interface.socket_receive( - timeout=self._timeout - ) + self._buffer = self._buffer + _the_interface.socket_receive(timeout=self._timeout) _the_interface.socket_disconnect() - def settimeout(self, value): + def settimeout(self, value: int) -> None: """Set the read timeout for sockets, if value is 0 it will block""" self._timeout = value - - -# pylint: enable=unused-argument, redefined-builtin, invalid-name diff --git a/adafruit_espatcontrol/adafruit_espatcontrol_wifimanager.py b/adafruit_espatcontrol/adafruit_espatcontrol_wifimanager.py index 3f1342a..5136b37 100755 --- a/adafruit_espatcontrol/adafruit_espatcontrol_wifimanager.py +++ b/adafruit_espatcontrol/adafruit_espatcontrol_wifimanager.py @@ -11,10 +11,18 @@ * Author(s): Melissa LeBlanc-Williams, ladyada, Jerry Needell """ -# pylint: disable=no-name-in-module +import adafruit_connection_manager +import adafruit_requests -import adafruit_requests as requests -import adafruit_espatcontrol.adafruit_espatcontrol_socket as socket +import adafruit_espatcontrol.adafruit_espatcontrol_socket as pool +from adafruit_espatcontrol.adafruit_espatcontrol import ESP_ATcontrol + +try: + from typing import Any, Dict, Optional, Tuple, Union + + from circuitpython_typing.led import FillBasedLED +except ImportError: + pass class ESPAT_WiFiManager: @@ -22,53 +30,80 @@ class ESPAT_WiFiManager: A class to help manage the Wifi connection """ - def __init__(self, esp, secrets, status_pixel=None, attempts=2): + def __init__( + self, + esp: ESP_ATcontrol, + secrets: Dict[str, Union[str, int]], + status_pixel: Optional[FillBasedLED] = None, + attempts: int = 2, + enterprise: bool = False, + debug: bool = False, + ): """ :param ESP_SPIcontrol esp: The ESP object we are using :param dict secrets: The WiFi and Adafruit IO secrets dict (See examples) :param status_pixel: (Optional) The pixel device - A NeoPixel or DotStar (default=None) :type status_pixel: NeoPixel or DotStar - :param int attempts: (Optional) Failed attempts before resetting the ESP32 (default=2) + :param int attempts: (Optional) Unused, only for compatibility for old code + :param bool enterprise: (Optional) If True, try to connect to Enterprise AP + :param bool debug: (Optional) Print debug messages during operation """ # Read the settings self._esp = esp - self.debug = False + self.debug = debug self.secrets = secrets self.attempts = attempts - requests.set_socket(socket, esp) self.statuspix = status_pixel self.pixel_status(0) + self.enterprise = enterprise + + # create requests session + ssl_context = adafruit_connection_manager.create_fake_ssl_context(pool, self._esp) + self._requests = adafruit_requests.Session(pool, ssl_context) - def reset(self): + def reset(self, hard_reset: bool = True, soft_reset: bool = False) -> None: """ Perform a hard reset on the ESP """ + self.pixel_status((100, 100, 100)) if self.debug: print("Resetting ESP") - self._esp.hard_reset() + if hard_reset is True: + self._esp.hard_reset() + if soft_reset is True: + self._esp.soft_reset() + self.pixel_status(0) - def connect(self): + def connect(self, timeout: int = 15, retries: int = 3) -> None: """ Attempt to connect to WiFi using the current settings """ - failure_count = 0 - while not self._esp.is_connected: - try: - if self.debug: - print("Connecting to AP...") - self.pixel_status((100, 0, 0)) - self._esp.connect(self.secrets) - failure_count = 0 - self.pixel_status((0, 100, 0)) - except (ValueError, RuntimeError) as error: - print("Failed to connect, retrying\n", error) - failure_count += 1 - if failure_count >= self.attempts: - failure_count = 0 - self.reset() - continue - - def get(self, url, **kw): + try: + if self.debug: + print("Connecting to AP...") + self.pixel_status((100, 0, 0)) + if self.enterprise is False: + self._esp.connect(self.secrets, timeout=timeout, retries=retries) + else: + self._esp.connect_enterprise(self.secrets, timeout=timeout, retries=retries) + self.pixel_status((0, 100, 0)) + except (ValueError, RuntimeError) as error: + print("Failed to connect\n", error) + raise + + def set_conntype(self, url: str) -> None: + """set the connection-type according to protocol""" + self._esp.conntype = ( + ESP_ATcontrol.TYPE_SSL if url.startswith("https") else ESP_ATcontrol.TYPE_TCP + ) + + def disconnect(self) -> None: + """ + Disconnect the Wifi from the AP if any + """ + self._esp.disconnect() + + def get(self, url: str, **kw: Any) -> adafruit_requests.Response: """ Pass the Get request to requests and update Status NeoPixel @@ -83,11 +118,12 @@ def get(self, url, **kw): if not self._esp.is_connected: self.connect() self.pixel_status((0, 0, 100)) - return_val = requests.get(url, **kw) + self.set_conntype(url) + return_val = self._requests.get(url, **kw) self.pixel_status(0) return return_val - def post(self, url, **kw): + def post(self, url: str, **kw: Any) -> adafruit_requests.Response: """ Pass the Post request to requests and update Status NeoPixel @@ -99,13 +135,20 @@ def post(self, url, **kw): :return: The response from the request :rtype: Response """ + if self.debug: + print("in post()") if not self._esp.is_connected: + if self.debug: + print("post(): not connected, trying to connect") self.connect() self.pixel_status((0, 0, 100)) - return_val = requests.post(url, **kw) + self.set_conntype(url) + return_val = self._requests.post(url, **kw) + self.pixel_status(0) + return return_val - def put(self, url, **kw): + def put(self, url: str, **kw: Any) -> adafruit_requests.Response: """ Pass the put request to requests and update Status NeoPixel @@ -120,11 +163,12 @@ def put(self, url, **kw): if not self._esp.is_connected: self.connect() self.pixel_status((0, 0, 100)) - return_val = requests.put(url, **kw) + self.set_conntype(url) + return_val = self._requests.put(url, **kw) self.pixel_status(0) return return_val - def patch(self, url, **kw): + def patch(self, url: str, **kw: Any) -> adafruit_requests.Response: """ Pass the patch request to requests and update Status NeoPixel @@ -139,11 +183,12 @@ def patch(self, url, **kw): if not self._esp.is_connected: self.connect() self.pixel_status((0, 0, 100)) - return_val = requests.patch(url, **kw) + self.set_conntype(url) + return_val = self._requests.patch(url, **kw) self.pixel_status(0) return return_val - def delete(self, url, **kw): + def delete(self, url: str, **kw: Any) -> adafruit_requests.Response: """ Pass the delete request to requests and update Status NeoPixel @@ -158,11 +203,12 @@ def delete(self, url, **kw): if not self._esp.is_connected: self.connect() self.pixel_status((0, 0, 100)) - return_val = requests.delete(url, **kw) + self.set_conntype(url) + return_val = self._requests.delete(url, **kw) self.pixel_status(0) return return_val - def ping(self, host, ttl=250): + def ping(self, host: str, ttl: int = 250) -> Union[int, None]: """ Pass the Ping request to the ESP32, update Status NeoPixel, return response time @@ -178,7 +224,7 @@ def ping(self, host, ttl=250): self.pixel_status(0) return response_time - def pixel_status(self, value): + def pixel_status(self, value: Union[int, Tuple[int, int, int]]) -> None: """ Change Status NeoPixel if it was defined diff --git a/docs/api.rst b/docs/api.rst index 0698504..e9c5c09 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. 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" +API Reference +############# + .. automodule:: adafruit_espatcontrol.adafruit_espatcontrol :members: diff --git a/docs/conf.py b/docs/conf.py index 63fadd4..8eb0876 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,8 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys @@ -16,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -29,8 +29,8 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. @@ -43,7 +43,12 @@ # General information about the project. project = "Adafruit espATcontrol Library" -copyright = "2018 ladyada" +creation_year = "2018" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for @@ -60,7 +65,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -92,19 +97,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/index.rst b/docs/index.rst index f53529b..1fd0d96 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,8 +29,9 @@ Table of Contents .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..979f568 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/esp_atcontrol_AIO_no_wifimanager-enterprise.py b/examples/esp_atcontrol_AIO_no_wifimanager-enterprise.py new file mode 100644 index 0000000..4d4ac9c --- /dev/null +++ b/examples/esp_atcontrol_AIO_no_wifimanager-enterprise.py @@ -0,0 +1,89 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +# Note, you must create a feed called "test" in your AdafruitIO account. +# Your secrets file must contain your aio_username and aio_key + +import time + +import adafruit_connection_manager +import adafruit_requests +import board +import busio +from digitalio import DigitalInOut, Direction + +import adafruit_espatcontrol.adafruit_espatcontrol_socket as pool + +# ESP32 AT +from adafruit_espatcontrol import adafruit_espatcontrol + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None +else: + RX = board.TX + TX = board.RX + resetpin = DigitalInOut(board.D4) + rtspin = DigitalInOut(board.D5) + uart = busio.UART(board.TX, board.RX, baudrate=11520, timeout=0.1, receiver_buffer_size=512) + esp_boot = DigitalInOut(board.D9) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + +print("ESP AT commands") +esp = adafruit_espatcontrol.ESP_ATcontrol( + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag +) + +ssl_context = adafruit_connection_manager.create_fake_ssl_context(pool, esp) +requests = adafruit_requests.Session(pool, ssl_context) + +counter = 0 + +while True: + try: + while not esp.is_connected: + print("Connecting...") + esp.connect_enterprise(secrets) + print("Posting data...", end="") + data = counter + feed = "example" + payload = {"value": data} + response = requests.post( + "https://io.adafruit.com/api/v2/" + + secrets["aio_username"] + + "/feeds/" + + feed + + "/data", + json=payload, + headers={"X-AIO-KEY": secrets["aio_key"]}, + ) + print(response.json()) + response.close() + counter = counter + 1 + print("OK") + except (ValueError, RuntimeError, adafruit_espatcontrol.OKError) as e: + print("Failed to get data, retrying\n", e) + esp.soft_reset() + continue + response = None + time.sleep(15) diff --git a/examples/esp_atcontrol_AIO_wifimanager_enterprise.py b/examples/esp_atcontrol_AIO_wifimanager_enterprise.py new file mode 100644 index 0000000..08f48d1 --- /dev/null +++ b/examples/esp_atcontrol_AIO_wifimanager_enterprise.py @@ -0,0 +1,93 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +# Note, you must create a feed called "test" in your AdafruitIO account. +# Your secrets file must contain your aio_username and aio_key + +import time + +import board +import busio +import neopixel +from digitalio import DigitalInOut, Direction + +# ESP32 AT +from adafruit_espatcontrol import ( + adafruit_espatcontrol, + adafruit_espatcontrol_wifimanager, +) + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +pixel_status = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.3, auto_write=True) + +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None +else: + RX = board.TX + TX = board.RX + resetpin = DigitalInOut(board.D4) + rtspin = DigitalInOut(board.D5) + uart = busio.UART(board.TX, board.RX, timeout=0.1) + esp_boot = DigitalInOut(board.D9) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = pixel_status + +print("ESP AT commands") +esp = adafruit_espatcontrol.ESP_ATcontrol( + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag +) +wifi = adafruit_espatcontrol_wifimanager.ESPAT_WiFiManager( + esp, secrets, status_light, enterprise=True, debug=debugflag +) +wifi.disconnect() +wifi.reset(soft_reset=True) + +counter = 0 + +while True: + try: + print("Posting data...", end="") + data = counter + feed = "example" + payload = {"value": data} + response = wifi.post( + "https://io.adafruit.com/api/v2/" + + secrets["aio_username"] + + "/feeds/" + + feed + + "/data", + json=payload, + headers={"X-AIO-KEY": secrets["aio_key"]}, + ) + print(response.json()) + response.close() + + counter = counter + 1 + print("OK") + wifi.disconnect() + + except (ValueError, RuntimeError, adafruit_espatcontrol.OKError) as e: + print("Failed to get data, retrying\n", e) + wifi.reset(soft_reset=True) + continue + response = None + time.sleep(15) diff --git a/examples/esp_atcontrol_aio_post.py b/examples/esp_atcontrol_aio_post.py index 68983f3..a349913 100644 --- a/examples/esp_atcontrol_aio_post.py +++ b/examples/esp_atcontrol_aio_post.py @@ -1,11 +1,14 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT +# Note, you must create a feed called "test" in your AdafruitIO account. +# Your secrets file must contain your aio_username and aio_key + import time + import board import busio -from digitalio import DigitalInOut -from digitalio import Direction +from digitalio import DigitalInOut, Direction # ESP32 AT from adafruit_espatcontrol import ( @@ -13,7 +16,6 @@ adafruit_espatcontrol_wifimanager, ) - # Get wifi details and more from a secrets.py file try: from secrets import secrets @@ -21,21 +23,34 @@ print("WiFi secrets are kept in secrets.py, please add them there!") raise +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False -# With a Particle Argon -RX = board.ESP_TX -TX = board.ESP_RX -resetpin = DigitalInOut(board.ESP_WIFI_EN) -rtspin = DigitalInOut(board.ESP_CTS) -uart = busio.UART(TX, RX, timeout=0.1) -esp_boot = DigitalInOut(board.ESP_BOOT_MODE) -esp_boot.direction = Direction.OUTPUT -esp_boot.value = True -status_light = None +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None +else: + RX = board.ESP_TX + TX = board.ESP_RX + resetpin = DigitalInOut(board.ESP_WIFI_EN) + rtspin = DigitalInOut(board.ESP_CTS) + uart = busio.UART(TX, RX, timeout=0.1) + esp_boot = DigitalInOut(board.ESP_BOOT_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None print("ESP AT commands") esp = adafruit_espatcontrol.ESP_ATcontrol( - uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=False + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag ) wifi = adafruit_espatcontrol_wifimanager.ESPAT_WiFiManager(esp, secrets, status_light) diff --git a/examples/esp_atcontrol_cheerlights.py b/examples/esp_atcontrol_cheerlights.py index 08d3cc1..456bb07 100644 --- a/examples/esp_atcontrol_cheerlights.py +++ b/examples/esp_atcontrol_cheerlights.py @@ -2,13 +2,12 @@ # SPDX-License-Identifier: MIT import time + +import adafruit_fancyled.adafruit_fancyled as fancy import board import busio -from digitalio import DigitalInOut -from digitalio import Direction - import neopixel -import adafruit_fancyled.adafruit_fancyled as fancy +from digitalio import DigitalInOut, Direction # ESP32 SPI from adafruit_espatcontrol import ( @@ -16,7 +15,6 @@ adafruit_espatcontrol_wifimanager, ) - # Get wifi details and more from a secrets.py file try: from secrets import secrets @@ -24,21 +22,38 @@ print("WiFi secrets are kept in secrets.py, please add them there!") raise - -# With a Particle Argon -RX = board.ESP_TX -TX = board.ESP_RX -resetpin = DigitalInOut(board.ESP_WIFI_EN) -rtspin = DigitalInOut(board.ESP_CTS) -uart = busio.UART(TX, RX, timeout=0.1) -esp_boot = DigitalInOut(board.ESP_BOOT_MODE) -esp_boot.direction = Direction.OUTPUT -esp_boot.value = True -status_light = None +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + pixel_pin = board.NEOPIXEL + num_pixels = 1 +else: + RX = board.ESP_TX + TX = board.ESP_RX + resetpin = DigitalInOut(board.ESP_WIFI_EN) + rtspin = DigitalInOut(board.ESP_CTS) + uart = busio.UART(TX, RX, timeout=0.1) + esp_boot = DigitalInOut(board.ESP_BOOT_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + pixel_pin = board.A1 + num_pixels = 16 print("ESP AT commands") esp = adafruit_espatcontrol.ESP_ATcontrol( - uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=False + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag ) wifi = adafruit_espatcontrol_wifimanager.ESPAT_WiFiManager(esp, secrets, status_light) @@ -47,8 +62,8 @@ DATA_LOCATION = ["feeds", 0, "field2"] -# neopixels -pixels = neopixel.NeoPixel(board.A1, 16, brightness=0.3) +# Setup and Clear neopixels +pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.3) pixels.fill(0) # we'll save the value in question @@ -77,7 +92,7 @@ green = color >> 8 & 0xFF blue = color & 0xFF gamma_corrected = fancy.gamma_adjust(fancy.CRGB(red, green, blue)).pack() - + print(f"Setting LED To: G:{green},R:{red},B:{blue},Gamma:{gamma_corrected}") pixels.fill(gamma_corrected) last_value = value response = None diff --git a/examples/esp_atcontrol_countviewer.py b/examples/esp_atcontrol_countviewer.py index 0a75aa8..5b898c4 100644 --- a/examples/esp_atcontrol_countviewer.py +++ b/examples/esp_atcontrol_countviewer.py @@ -6,16 +6,19 @@ stars, price of bitcoin, twitter followers... if you can find something that spits out JSON data, we can display it! """ + import gc import time + +import adafruit_connection_manager +import adafruit_requests import board import busio -from digitalio import DigitalInOut -from digitalio import Direction import neopixel from adafruit_ht16k33 import segments -import adafruit_requests as requests -import adafruit_espatcontrol.adafruit_espatcontrol_socket as socket +from digitalio import DigitalInOut, Direction + +import adafruit_espatcontrol.adafruit_espatcontrol_socket as pool from adafruit_espatcontrol import adafruit_espatcontrol # Get wifi details and more from a secrets.py file @@ -27,7 +30,8 @@ # CONFIGURATION PLAY_SOUND_ON_CHANGE = False -NEOPIXELS_ON_CHANGE = False +NEOPIXELS_ON_CHANGE = True +DISPLAY_ATTACHED = False TIME_BETWEEN_QUERY = 60 # in seconds # Some data sources and JSON locations to try out @@ -63,17 +67,36 @@ # "screen_names=adafruit" # DATA_LOCATION = [0, "followers_count"] - -# With a Particle Argon -RX = board.ESP_TX -TX = board.ESP_RX -resetpin = DigitalInOut(board.ESP_WIFI_EN) -rtspin = DigitalInOut(board.ESP_CTS) -uart = busio.UART(TX, RX, timeout=0.1) -esp_boot = DigitalInOut(board.ESP_BOOT_MODE) -esp_boot.direction = Direction.OUTPUT -esp_boot.value = True - +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + pixel_pin = board.NEOPIXEL + num_pixels = 1 + pixel_type = "RGBW/GRBW" +else: + RX = board.ESP_TX + TX = board.ESP_RX + resetpin = DigitalInOut(board.ESP_WIFI_EN) + rtspin = DigitalInOut(board.ESP_CTS) + uart = busio.UART(TX, RX, timeout=0.1) + esp_boot = DigitalInOut(board.ESP_BOOT_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + pixel_pin = board.A1 + num_pixels = 16 + pixel_type = "RGB/GRB" # Create the connection to the co-processor and reset esp = adafruit_espatcontrol.ESP_ATcontrol( @@ -81,24 +104,27 @@ ) esp.hard_reset() -requests.set_socket(socket, esp) +ssl_context = adafruit_connection_manager.create_fake_ssl_context(pool, esp) +requests = adafruit_requests.Session(pool, ssl_context) -# Create the I2C interface. -i2c = busio.I2C(board.SCL, board.SDA) -# Attach a 7 segment display and display -'s so we know its not live yet -display = segments.Seg7x4(i2c) -display.print("----") +# display +if DISPLAY_ATTACHED: + # Create the I2C interface. + i2c = busio.I2C(board.SCL, board.SDA) + # Attach a 7 segment display and display -'s so we know its not live yet + display = segments.Seg7x4(i2c) + display.print("----") # neopixels if NEOPIXELS_ON_CHANGE: - pixels = neopixel.NeoPixel(board.A1, 16, brightness=0.4, pixel_order=(1, 0, 2, 3)) - pixels.fill(0) + pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.4, pixel_order=(1, 0, 2, 3)) + pixels.fill(20) # music! if PLAY_SOUND_ON_CHANGE: import audioio - wave_file = open("coin.wav", "rb") # pylint: disable=consider-using-with + wave_file = open("coin.wav", "rb") wave = audioio.WaveFile(wave_file) # we'll save the value in question @@ -111,7 +137,12 @@ def chime_light(): """Light up LEDs and play a tune""" if NEOPIXELS_ON_CHANGE: for i in range(0, 100, 10): - pixels.fill((i, i, i)) + if pixel_type == "RGB/GRB": + pixels.fill((i, i, i)) + elif pixel_type == "RGBW/GRBW": + pixels.fill((i, i, i, i)) + pixels.show() + time.sleep(1) if PLAY_SOUND_ON_CHANGE: with audioio.AudioOut(board.A0) as audio: audio.play(wave) @@ -119,7 +150,12 @@ def chime_light(): pass if NEOPIXELS_ON_CHANGE: for i in range(100, 0, -10): - pixels.fill((i, i, i)) + if pixel_type == "RGB/GRB": + pixels.fill((i, i, i)) + elif pixel_type == "RGBW/GRBW": + pixels.fill((i, i, i, i)) + pixels.show() + time.sleep(1) pixels.fill(0) @@ -148,8 +184,11 @@ def chime_light(): value = value[x] if not value: continue - print(times, the_time, "value:", value) - display.print(int(value)) + print(f"Times:{times}. The Time:{the_time}. Value: {value}") + if DISPLAY_ATTACHED: + display.print(int(value)) + else: + print(f"INT Value:{int(value)}") if last_value != value: chime_light() # animate the neopixels @@ -159,5 +198,6 @@ def chime_light(): # normally we wouldn't have to do this, but we get bad fragments r = value = None gc.collect() - print(gc.mem_free()) # pylint: disable=no-member + print(f"GC MEM:{gc.mem_free()}") + print(f"Sleeping for: {TIME_BETWEEN_QUERY} Seconds") time.sleep(TIME_BETWEEN_QUERY) diff --git a/examples/esp_atcontrol_countviewer_enterprise.py b/examples/esp_atcontrol_countviewer_enterprise.py new file mode 100644 index 0000000..b59c704 --- /dev/null +++ b/examples/esp_atcontrol_countviewer_enterprise.py @@ -0,0 +1,210 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This example will access an API, grab a number like hackaday skulls, github +stars, price of bitcoin, twitter followers... if you can find something that +spits out JSON data, we can display it! +""" + +import gc +import time + +import adafruit_connection_manager +import adafruit_requests +import board +import busio +import neopixel +from digitalio import DigitalInOut, Direction + +import adafruit_espatcontrol.adafruit_espatcontrol_socket as pool +from adafruit_espatcontrol import adafruit_espatcontrol + +try: + from adafruit_ht16k33 import segments +except ImportError: + pass + + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# CONFIGURATION +PLAY_SOUND_ON_CHANGE = False +NEOPIXELS_ON_CHANGE = True +DISPLAY_ATTACHED = False +TIME_BETWEEN_QUERY = 60 # in seconds + +# Some data sources and JSON locations to try out + +# Bitcoin value in USD +# DATA_SOURCE = "http://api.coindesk.com/v1/bpi/currentprice.json" +# DATA_LOCATION = ["bpi", "USD", "rate_float"] + +# Github stars! You can query 1ce a minute without an API key token +# DATA_SOURCE = "https://api.github.com/repos/adafruit/circuitpython" +# if 'github_token' in secrets: +# DATA_SOURCE += "?access_token="+secrets['github_token'] +# DATA_LOCATION = ["stargazers_count"] + +# Youtube stats +# CHANNEL_ID = "UCpOlOeQjj7EsVnDh3zuCgsA" # this isn't a secret but you have to look it up +# DATA_SOURCE = "https://www.googleapis.com/youtube/v3/channels/?part=statistics&id=" \ +# + CHANNEL_ID +"&key="+secrets['youtube_token'] +# #try also 'viewCount' or 'videoCount +# DATA_LOCATION = ["items", 0, "statistics", "subscriberCount"] + + +# # Subreddit subscribers +# DATA_SOURCE = "https://www.reddit.com/r/circuitpython/about.json" +# DATA_LOCATION = ["data", "subscribers"] + +# Hackaday Skulls (likes), requires an API key +# DATA_SOURCE = "https://api.hackaday.io/v1/projects/1340?api_key="+secrets['hackaday_token'] +# DATA_LOCATION = ["skulls"] + +# Twitter followers +DATA_SOURCE = ( + "http://cdn.syndication.twimg.com/widgets/followbutton/info.json?" + "screen_names=adafruit" +) +DATA_LOCATION = [0, "followers_count"] + +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = True + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + pixel_pin = board.NEOPIXEL + num_pixels = 1 + pixel_type = "RGBW/GRBW" +else: + RX = board.TX + TX = board.RX + resetpin = DigitalInOut(board.D4) + rtspin = DigitalInOut(board.D5) + uart = busio.UART(board.TX, board.RX, baudrate=11520, timeout=0.1, receiver_buffer_size=512) + esp_boot = DigitalInOut(board.D9) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + pixel_pin = board.A1 + num_pixels = 16 + pixel_type = "RGB/GRB" + +# Create the connection to the co-processor and reset +esp = adafruit_espatcontrol.ESP_ATcontrol( + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag +) +esp.soft_reset() +esp.disconnect() + +ssl_context = adafruit_connection_manager.create_fake_ssl_context(pool, esp) +requests = adafruit_requests.Session(pool, ssl_context) + +# display +if DISPLAY_ATTACHED: + # Create the I2C interface. + i2c = busio.I2C(board.SCL, board.SDA) + # Attach a 7 segment display and display -'s so we know its not live yet + display = segments.Seg7x4(i2c) + display.print("----") + +# neopixels +if NEOPIXELS_ON_CHANGE: + pixels = neopixel.NeoPixel(pixel_pin, num_pixels, brightness=0.4, pixel_order=(1, 0, 2, 3)) + pixels.fill(20) + +# music! +if PLAY_SOUND_ON_CHANGE: + import audioio + + wave_file = open("coin.wav", "rb") + wave = audioio.WaveFile(wave_file) + +# we'll save the value in question +last_value = value = None +the_time = None +times = 0 + + +def chime_light(): + """Light up LEDs and play a tune""" + if NEOPIXELS_ON_CHANGE: + for i in range(0, 100, 10): + if pixel_type == "RGB/GRB": + pixels.fill((i, i, i)) + elif pixel_type == "RGBW/GRBW": + pixels.fill((i, i, i, i)) + pixels.show() + time.sleep(1) + if PLAY_SOUND_ON_CHANGE: + with audioio.AudioOut(board.A0) as audio: + audio.play(wave) + while audio.playing: + pass + if NEOPIXELS_ON_CHANGE: + for i in range(100, 0, -10): + if pixel_type == "RGB/GRB": + pixels.fill((i, i, i)) + elif pixel_type == "RGBW/GRBW": + pixels.fill((i, i, i, i)) + pixels.show() + time.sleep(1) + pixels.fill(0) + + +while True: + try: + while not esp.is_connected: + # secrets dictionary must contain 'ssid' and 'password' at a minimum + esp.connect_enterprise(secrets) + + the_time = esp.sntp_time + + # great, lets get the data + print("Retrieving data source...", end="") + r = requests.get(DATA_SOURCE) + print("Reply is OK!") + except (ValueError, RuntimeError, adafruit_espatcontrol.OKError) as e: + print("Failed to get data, retrying\n", e) + continue + # print('-'*40,) + # print("Headers: ", r.headers) + # print("Text:", r.text) + # print('-'*40) + + value = r.json() + for x in DATA_LOCATION: + value = value[x] + if not value: + continue + print(f"Times:{times}. The Time:{the_time}. Value: {value}") + if DISPLAY_ATTACHED: + display.print(int(value)) + else: + print(f"INT Value:{int(value)}") + + if last_value != value: + chime_light() # animate the neopixels + last_value = value + times += 1 + + # normally we wouldn't have to do this, but we get bad fragments + r = value = None + gc.collect() + print(f"GC MEM:{gc.mem_free()}") + print(f"Sleeping for: {TIME_BETWEEN_QUERY} Seconds") + time.sleep(TIME_BETWEEN_QUERY) diff --git a/examples/esp_atcontrol_localtime.py b/examples/esp_atcontrol_localtime.py index ba7bc1c..10e4ad7 100644 --- a/examples/esp_atcontrol_localtime.py +++ b/examples/esp_atcontrol_localtime.py @@ -2,18 +2,17 @@ # SPDX-License-Identifier: MIT import time + import board import busio -from digitalio import DigitalInOut -from digitalio import Direction import rtc +from digitalio import DigitalInOut, Direction from adafruit_espatcontrol import ( adafruit_espatcontrol, adafruit_espatcontrol_wifimanager, ) - # Get wifi details and more from a secrets.py file try: from secrets import secrets @@ -21,22 +20,38 @@ print("WiFi secrets are kept in secrets.py, please add them there!") raise - -# With a Particle Argon -RX = board.ESP_TX -TX = board.ESP_RX -resetpin = DigitalInOut(board.ESP_WIFI_EN) -rtspin = DigitalInOut(board.ESP_CTS) -uart = busio.UART(TX, RX, timeout=0.1) -esp_boot = DigitalInOut(board.ESP_BOOT_MODE) -esp_boot.direction = Direction.OUTPUT -esp_boot.value = True -status_light = None - +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False + +# How Long to sleep between polling +sleep_duration = 5 + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + +else: + RX = board.ESP_TX + TX = board.ESP_RX + resetpin = DigitalInOut(board.ESP_WIFI_EN) + rtspin = DigitalInOut(board.ESP_CTS) + uart = busio.UART(TX, RX, timeout=0.1) + esp_boot = DigitalInOut(board.ESP_BOOT_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None print("ESP AT commands") esp = adafruit_espatcontrol.ESP_ATcontrol( - uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=False + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag ) wifi = adafruit_espatcontrol_wifimanager.ESPAT_WiFiManager(esp, secrets, status_light) @@ -61,21 +76,20 @@ json = response.json() current_time = json["datetime"] the_date, the_time = current_time.split("T") -year, month, mday = [int(x) for x in the_date.split("-")] +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(":")] +hours, minutes, seconds = (int(x) for x in the_time.split(":")) # We can also fill in these extra nice things year_day = json["day_of_year"] week_day = json["day_of_week"] is_dst = json["dst"] -now = time.struct_time( - (year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst) -) +now = time.struct_time((year, month, mday, hours, minutes, seconds, week_day, year_day, is_dst)) print(now) the_rtc.datetime = now while True: print(time.localtime()) - time.sleep(1) + print(f"Sleeping for: {sleep_duration} Seconds") + time.sleep(sleep_duration) diff --git a/examples/esp_atcontrol_simple_enterprise.py b/examples/esp_atcontrol_simple_enterprise.py new file mode 100644 index 0000000..3db4b21 --- /dev/null +++ b/examples/esp_atcontrol_simple_enterprise.py @@ -0,0 +1,89 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +import time + +import adafruit_connection_manager +import adafruit_requests +import board +import busio +from digitalio import DigitalInOut, Direction + +import adafruit_espatcontrol.adafruit_espatcontrol_socket as pool +from adafruit_espatcontrol import adafruit_espatcontrol + +# Get wifi details and more from a secrets.py file +try: + from secrets import secrets +except ImportError: + print("WiFi secrets are kept in secrets.py, please add them there!") + raise + +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False + +# How long between queries +TIME_BETWEEN_QUERY = 60 # in seconds + +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None +else: + RX = board.TX + TX = board.RX + resetpin = DigitalInOut(board.D4) + rtspin = DigitalInOut(board.D5) + uart = busio.UART(board.TX, board.RX, baudrate=11520, timeout=0.1, receiver_buffer_size=512) + esp_boot = DigitalInOut(board.D9) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None + +print("ESP AT commands") +esp = adafruit_espatcontrol.ESP_ATcontrol( + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag +) + +URL = "http://wifitest.adafruit.com/testwifi/index.html" +print("ESP AT GET URL", URL) + +print("Resetting ESP module") +esp.hard_reset() +esp.soft_reset() +esp.disconnect() +# time.sleep(20) +esp.set_autoconnect(False) + +ssl_context = adafruit_connection_manager.create_fake_ssl_context(pool, esp) +requests = adafruit_requests.Session(pool, ssl_context) + +while True: + try: + print(f"Checking connection to {secrets['ssid']}...") + while not esp.is_connected: + print("Connecting...") + esp.connect_enterprise(secrets) + # great, lets get the data + print("Retrieving URL...", end="") + r = requests.get(URL) + print("Status:", r.status_code) + print("Content type:", r.headers["content-type"]) + print("Content size:", r.headers["content-length"]) + print("Encoding:", r.encoding) + print("Text:", r.text) + print("Disconnecting from WiFi") + esp.disconnect() + esp.disconnect() + print(f"Sleeping for: {TIME_BETWEEN_QUERY} Seconds") + time.sleep(TIME_BETWEEN_QUERY) + except (ValueError, RuntimeError, adafruit_espatcontrol.OKError) as e: + print("Failed to get data, retrying\n", e) + continue diff --git a/examples/esp_atcontrol_simpletest.py b/examples/esp_atcontrol_simpletest.py index d3bb914..8b538f3 100644 --- a/examples/esp_atcontrol_simpletest.py +++ b/examples/esp_atcontrol_simpletest.py @@ -2,12 +2,12 @@ # SPDX-License-Identifier: MIT import time + import board import busio -from digitalio import DigitalInOut -from digitalio import Direction -from adafruit_espatcontrol import adafruit_espatcontrol +from digitalio import DigitalInOut, Direction +from adafruit_espatcontrol import adafruit_espatcontrol # Get wifi details and more from a secrets.py file try: @@ -15,22 +15,34 @@ except ImportError: print("WiFi secrets are kept in secrets.py, please add them there!") raise +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False - -# With a Particle Argon -RX = board.ESP_TX -TX = board.ESP_RX -resetpin = DigitalInOut(board.ESP_WIFI_EN) -rtspin = DigitalInOut(board.ESP_CTS) -uart = busio.UART(TX, RX, timeout=0.1) -esp_boot = DigitalInOut(board.ESP_BOOT_MODE) -esp_boot.direction = Direction.OUTPUT -esp_boot.value = True +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True +else: + RX = board.ESP_TX + TX = board.ESP_RX + resetpin = DigitalInOut(board.ESP_WIFI_EN) + rtspin = DigitalInOut(board.ESP_CTS) + uart = busio.UART(TX, RX, timeout=0.1) + esp_boot = DigitalInOut(board.ESP_BOOT_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True print("ESP AT commands") +# For Boards that do not have an rtspin like challenger_rp2040_wifi set rtspin to False. esp = adafruit_espatcontrol.ESP_ATcontrol( - uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=False + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag ) print("Resetting ESP module") esp.hard_reset() @@ -39,6 +51,9 @@ while True: try: if first_pass: + # Some ESP do not return OK on AP Scan. + # See https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol/issues/48 + # Comment out the next 3 lines if you get a No OK response to AT+CWLAP print("Scanning for AP's") for ap in esp.scan_APs(): print(ap) diff --git a/examples/esp_atcontrol_webclient.py b/examples/esp_atcontrol_webclient.py index 68e05f5..ba7ae73 100644 --- a/examples/esp_atcontrol_webclient.py +++ b/examples/esp_atcontrol_webclient.py @@ -2,14 +2,15 @@ # SPDX-License-Identifier: MIT import time + +import adafruit_connection_manager +import adafruit_requests import board import busio -from digitalio import DigitalInOut -from digitalio import Direction -import adafruit_requests as requests -import adafruit_espatcontrol.adafruit_espatcontrol_socket as socket -from adafruit_espatcontrol import adafruit_espatcontrol +from digitalio import DigitalInOut, Direction +import adafruit_espatcontrol.adafruit_espatcontrol_socket as pool +from adafruit_espatcontrol import adafruit_espatcontrol # Get wifi details and more from a secrets.py file try: @@ -18,21 +19,37 @@ print("WiFi secrets are kept in secrets.py, please add them there!") raise +# Debug Level +# Change the Debug Flag if you have issues with AT commands +debugflag = False -# With a Particle Argon -RX = board.ESP_TX -TX = board.ESP_RX -resetpin = DigitalInOut(board.ESP_WIFI_EN) -rtspin = DigitalInOut(board.ESP_CTS) -uart = busio.UART(TX, RX, timeout=0.1) -esp_boot = DigitalInOut(board.ESP_BOOT_MODE) -esp_boot.direction = Direction.OUTPUT -esp_boot.value = True +# How long between queries +TIME_BETWEEN_QUERY = 60 # in seconds +if board.board_id == "challenger_rp2040_wifi": + RX = board.ESP_RX + TX = board.ESP_TX + resetpin = DigitalInOut(board.WIFI_RESET) + rtspin = False + uart = busio.UART(TX, RX, baudrate=11520, receiver_buffer_size=2048) + esp_boot = DigitalInOut(board.WIFI_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None +else: + RX = board.ESP_TX + TX = board.ESP_RX + resetpin = DigitalInOut(board.ESP_WIFI_EN) + rtspin = DigitalInOut(board.ESP_CTS) + uart = busio.UART(TX, RX, timeout=0.1) + esp_boot = DigitalInOut(board.ESP_BOOT_MODE) + esp_boot.direction = Direction.OUTPUT + esp_boot.value = True + status_light = None print("ESP AT commands") esp = adafruit_espatcontrol.ESP_ATcontrol( - uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=False + uart, 115200, reset_pin=resetpin, rts_pin=rtspin, debug=debugflag ) URL = "http://wifitest.adafruit.com/testwifi/index.html" @@ -41,7 +58,8 @@ print("Resetting ESP module") esp.hard_reset() -requests.set_socket(socket, esp) +ssl_context = adafruit_connection_manager.create_fake_ssl_context(pool, esp) +requests = adafruit_requests.Session(pool, ssl_context) while True: try: @@ -57,8 +75,8 @@ print("Content size:", r.headers["content-length"]) print("Encoding:", r.encoding) print("Text:", r.text) - - time.sleep(60) + print(f"Sleeping for: {TIME_BETWEEN_QUERY} Seconds") + time.sleep(TIME_BETWEEN_QUERY) except (ValueError, RuntimeError, adafruit_espatcontrol.OKError) as e: print("Failed to get data, retrying\n", e) continue diff --git a/examples/secrets_enterprise.py b/examples/secrets_enterprise.py new file mode 100644 index 0000000..ceae755 --- /dev/null +++ b/examples/secrets_enterprise.py @@ -0,0 +1,17 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +# This file is where you keep secret settings, passwords, and tokens! +# If you put them in the code you risk committing that info or sharing it + +secrets = { + "ssid": "your-ssid", + "password": "your-password", + "identity": "your-identity", + "username": "your-username", + "method": 1, # 0 = EAP-TLS, 1=EAP-PEAP, 2=EAP-TTLSs + "timezone": -2, # this is offset from UTC + "github_token": "abcdefghij0123456789", + "aio_username": "your-aio-username", + "aio_key": "your-aio-key", +} diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..59bdcae --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-esp-atcontrol" +description = "CircuitPython driver for communicating using ESP AT command set." +version = "0.0.0+auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol"} +keywords = [ + "adafruit", + "software", + "esp", + "at", + "atcontrol", + "internet", + "communication", + "micropython", + "circuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_espatcontrol"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 802d985..13401af 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,9 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka +adafruit-circuitpython-typing>=1.4.0 +adafruit-circuitpython-connectionmanager +adafruit-circuitpython-requests pyserial diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..8e34805 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,110 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR1702", # Too many nested blocks + "PLR0911", # Too many return statements + "PLW0603", # Using the global statement to update variable is discouraged + "PLR6301", # Method could be a function, class method, or static method + "PLW2901", # 'for' loop variable overwritten by assignment target +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index 4570391..0000000 --- a/setup.py +++ /dev/null @@ -1,56 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-esp-atcontrol", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython driver for communicating using ESP AT command set.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "pyserial"], - # 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 software esp at atcontrol internet communication micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - packages=["adafruit_espatcontrol"], -)