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 new file mode 100644 index 0000000..8de294e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2021 Adafruit Industries +# +# SPDX-License-Identifier: MIT + +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://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 + +Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code + +Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3915cff..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +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: PyLint - run: | - pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - - 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: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml new file mode 100644 index 0000000..0b1194f --- /dev/null +++ b/.github/workflows/failure-help-text.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Failure help text + +on: + workflow_run: + workflows: ["Build CI"] + types: + - completed + +jobs: + post-help: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} + steps: + - name: Post comment to help + uses: adafruit/circuitpython-action-library-ci-failed@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 0b90405..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.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 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 a2d294e..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,17 +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 -build*/ -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 aab5f1c..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,19 +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: stable + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: latest + - 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 + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 5c31f66..0000000 --- a/.pylintrc +++ /dev/null @@ -1,437 +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 -jobs=2 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,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=no - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/.readthedocs.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 62c85f6..c5d68e6 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-ble_broadcastnet/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/ble_broadcastnet/en/latest/ + :target: https://docs.circuitpython.org/projects/ble_broadcastnet/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,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/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 + Basic IOT over BLE advertisements. @@ -49,23 +53,25 @@ 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-ble-broadcastnet Usage Example ============= -Add a secrets.py file and then run ``ble_broadcastnet_blinka_bridge.py``. +Add a settings.toml file and then run ``ble_broadcastnet_blinka_bridge.py``. + +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. 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_ble_broadcastnet.py b/adafruit_ble_broadcastnet.py index 94f2911..3ffb494 100644 --- a/adafruit_ble_broadcastnet.py +++ b/adafruit_ble_broadcastnet.py @@ -12,26 +12,40 @@ * Author(s): Scott Shawcroft """ -import struct import os +import struct import time -from micropython import const + import adafruit_ble from adafruit_ble.advertising import Advertisement, LazyObjectField +from adafruit_ble.advertising.adafruit import ( + ADAFRUIT_COMPANY_ID, + MANUFACTURING_DATA_ADT, +) from adafruit_ble.advertising.standard import ManufacturerData, ManufacturerDataField -__version__ = "0.0.0-auto.0" +try: + from typing import Optional + + from _bleio import ScanEntry +except ImportError: + pass + +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet.git" -_ble = adafruit_ble.BLERadio() # pylint: disable=invalid-name -_sequence_number = 0 # pylint: disable=invalid-name +_ble = adafruit_ble.BLERadio() +_sequence_number = 0 -def broadcast(measurement, *, broadcast_time=0.1, extended=False): +def broadcast( + measurement: "AdafruitSensorMeasurement", *, broadcast_time: float = 0.1, extended: bool = False +) -> None: """Broadcasts the given measurement for the given broadcast time. If extended is False and the - measurement would be too long, it will be split into multiple measurements for transmission. + measurement would be too long, it will be split into multiple measurements for transmission, + each with the given broadcast time. """ - global _sequence_number # pylint: disable=global-statement,invalid-name + global _sequence_number # noqa: PLW0603 for submeasurement in measurement.split(252 if extended else 31): submeasurement.sequence_number = _sequence_number _ble.start_advertising(submeasurement, scan_response=None) @@ -44,21 +58,14 @@ def broadcast(measurement, *, broadcast_time=0.1, extended=False): if not hasattr(os, "environ") or ( "GITHUB_ACTION" not in os.environ and "READTHEDOCS" not in os.environ ): - if _ble._adapter.address: # pylint: disable=protected-access - device_address = "{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}".format( # pylint: disable=invalid-name - *reversed( - list( - _ble._adapter.address.address_bytes # pylint: disable=protected-access - ) - ) + if _ble._adapter.address: + device_address = "{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}".format( + *reversed(list(_ble._adapter.address.address_bytes)) ) else: - device_address = "000000000000" # pylint: disable=invalid-name + device_address = "000000000000" """Device address as a string.""" -_MANUFACTURING_DATA_ADT = const(0xFF) -_ADAFRUIT_COMPANY_ID = const(0x0822) - class AdafruitSensorMeasurement(Advertisement): """A collection of sensor measurements.""" @@ -66,16 +73,14 @@ class AdafruitSensorMeasurement(Advertisement): # This prefix matches all match_prefixes = ( # Matches the sequence number field header (length+ID) - struct.pack( - " None: + super().__init__(entry=entry) + if entry: + return + self.sequence_number = sequence_number - def __str__(self): + def __str__(self) -> str: parts = [] for attr in dir(self.__class__): attribute_instance = getattr(self.__class__, attr) if issubclass(attribute_instance.__class__, ManufacturerDataField): value = getattr(self, attr) if value is not None: - parts.append("{}={}".format(attr, str(value))) + parts.append(f"{attr}={str(value)}") return "<{} {} >".format(self.__class__.__name__, " ".join(parts)) - def __bytes__(self): - """The raw packet bytes.""" - # Must reorder the ManufacturerData contents so the sequence number field is always first. - # Necessary to ensure that match_prefixes works right to reconstruct on the receiver. - self.data_dict[255].data.move_to_end(3, last=False) - return super().__bytes__() - - def split(self, max_packet_size=31): + def split(self, max_packet_size: int = 31) -> "AdafruitSensorMeasurement": """Split the measurement into multiple measurements with the given max_packet_size. Yields each submeasurement.""" current_size = 8 # baseline for mfg data and sequence number diff --git a/docs/api.rst b/docs/api.rst index 3bef10b..9f7e736 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. 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_ble_broadcastnet :members: diff --git a/docs/conf.py b/docs/conf.py index 60da794..c457355 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 BLE_BroadcastNet Library" -copyright = "2020 Scott Shawcroft" +creation_year = "2020" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Scott Shawcroft" author = "Scott Shawcroft" # 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 da0358f..d9638a5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,8 +36,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/ble_broadcastnet_battery_level.py b/examples/ble_broadcastnet_battery_level.py index ac38480..da96c6f 100644 --- a/examples/ble_broadcastnet_battery_level.py +++ b/examples/ble_broadcastnet_battery_level.py @@ -2,9 +2,11 @@ # SPDX-License-Identifier: MIT import time + import analogio import board import microcontroller + import adafruit_ble_broadcastnet print("This is BroadcastNet sensor:", adafruit_ble_broadcastnet.device_address) @@ -14,16 +16,9 @@ while True: measurement = adafruit_ble_broadcastnet.AdafruitSensorMeasurement() - battery_voltage = ( - battery.value - / 2 ** 16 - * divider_ratio - * battery.reference_voltage # pylint: disable=no-member - ) + battery_voltage = battery.value / 2**16 * divider_ratio * battery.reference_voltage measurement.battery_voltage = int(battery_voltage * 1000) - measurement.temperature = ( - microcontroller.cpu.temperature # pylint: disable=no-member - ) + measurement.temperature = microcontroller.cpu.temperature print(measurement) adafruit_ble_broadcastnet.broadcast(measurement) diff --git a/examples/ble_broadcastnet_battery_level_neopixel.py b/examples/ble_broadcastnet_battery_level_neopixel.py index 5bd7a06..4e86b83 100644 --- a/examples/ble_broadcastnet_battery_level_neopixel.py +++ b/examples/ble_broadcastnet_battery_level_neopixel.py @@ -2,10 +2,12 @@ # SPDX-License-Identifier: MIT import time + import analogio import board import microcontroller import neopixel + import adafruit_ble_broadcastnet print("This is BroadcastNet sensor:", adafruit_ble_broadcastnet.device_address) @@ -17,21 +19,14 @@ while True: measurement = adafruit_ble_broadcastnet.AdafruitSensorMeasurement() - battery_voltage = ( - battery.value - / 2 ** 16 - * divider_ratio - * battery.reference_voltage # pylint: disable=no-member - ) + battery_voltage = battery.value / 2**16 * divider_ratio * battery.reference_voltage r = 16 - int(((battery_voltage - 3.6) / 0.6) * 16) r = min(16, max(r, 0)) g = int(((battery_voltage - 3.6) / 0.6) * 16) g = min(16, max(g, 0)) pixel[0] = r << 16 | g << 8 measurement.battery_voltage = int(battery_voltage * 1000) - measurement.temperature = ( - microcontroller.cpu.temperature # pylint: disable=no-member - ) + measurement.temperature = microcontroller.cpu.temperature print(measurement) adafruit_ble_broadcastnet.broadcast(measurement) pixel[0] = 0 diff --git a/examples/ble_broadcastnet_blinka_bridge.py b/examples/ble_broadcastnet_blinka_bridge.py index fed47ae..735a09f 100644 --- a/examples/ble_broadcastnet_blinka_bridge.py +++ b/examples/ble_broadcastnet_blinka_bridge.py @@ -2,15 +2,25 @@ # SPDX-License-Identifier: MIT """This example bridges from BLE to Adafruit IO on a Raspberry Pi.""" -from secrets import secrets # pylint: disable=no-name-in-module + import time +from os import getenv + +import adafruit_ble import requests from adafruit_ble.advertising.standard import ManufacturerDataField -import adafruit_ble +from adafruit_blinka import load_settings_toml + import adafruit_ble_broadcastnet -aio_auth_header = {"X-AIO-KEY": secrets["aio_key"]} -aio_base_url = "https://io.adafruit.com/api/v2/" + secrets["aio_username"] +# Get Adafruit IO keys, ensure these are setup in settings.toml +# (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.) +load_settings_toml() +aio_username = getenv("ADAFRUIT_AIO_USERNAME") +aio_key = getenv("ADAFRUIT_AIO_KEY") + +aio_auth_header = {"X-AIO-KEY": aio_key} +aio_base_url = f"https://io.adafruit.com/api/v2/{aio_username}" def aio_post(path, **kwargs): @@ -23,10 +33,6 @@ def aio_get(path, **kwargs): return requests.get(aio_base_url + path, **kwargs) -# Disable outer names check because we frequently collide. -# pylint: disable=redefined-outer-name - - def create_group(name): response = aio_post("/groups", json={"name": name}) if response.status_code != 201: @@ -38,9 +44,7 @@ def create_group(name): def create_feed(group_key, name): - response = aio_post( - "/groups/{}/feeds".format(group_key), json={"feed": {"name": name}} - ) + response = aio_post(f"/groups/{group_key}/feeds", json={"feed": {"name": name}}) if response.status_code != 201: print(name) print(response.content) @@ -50,7 +54,7 @@ def create_feed(group_key, name): def create_data(group_key, data): - response = aio_post("/groups/{}/data".format(group_key), json={"feeds": data}) + response = aio_post(f"/groups/{group_key}/data", json={"feeds": data}) if response.status_code == 429: print("Throttled!") return False @@ -125,9 +129,9 @@ def convert_to_feed_data(values, attribute_name, attribute_instance): number_missed = measurement.sequence_number - sequence_numbers[sensor_address] - 1 if number_missed < 0: number_missed += 256 - group_key = "bridge-{}-sensor-{}".format(bridge_address, sensor_address) + group_key = f"bridge-{bridge_address}-sensor-{sensor_address}" if sensor_address not in existing_feeds: - create_group("Bridge {} Sensor {}".format(bridge_address, sensor_address)) + create_group(f"Bridge {bridge_address} Sensor {sensor_address}") create_feed(group_key, "Missed Message Count") existing_feeds[sensor_address] = ["missed-message-count"] @@ -138,9 +142,7 @@ def convert_to_feed_data(values, attribute_name, attribute_instance): if attribute != "sequence_number": values = getattr(measurement, attribute) if values is not None: - data.extend( - convert_to_feed_data(values, attribute, attribute_instance) - ) + data.extend(convert_to_feed_data(values, attribute, attribute_instance)) for feed_data in data: if feed_data["key"] not in existing_feeds[sensor_address]: @@ -154,7 +156,7 @@ def convert_to_feed_data(values, attribute_name, attribute_instance): sequence_numbers[sensor_address] = measurement.sequence_number duration = time.monotonic() - start_time - print("Done logging measurement to IO. Took {} seconds".format(duration)) + print(f"Done logging measurement to IO. Took {duration} seconds") print() print("scan done") diff --git a/examples/ble_broadcastnet_bridge.py b/examples/ble_broadcastnet_bridge.py new file mode 100644 index 0000000..d33422d --- /dev/null +++ b/examples/ble_broadcastnet_bridge.py @@ -0,0 +1,194 @@ +# SPDX-FileCopyrightText: 2022 Scott Shawcroft for Adafruit Industries +# SPDX-License-Identifier: MIT + +"""This example bridges from BLE to Adafruit IO on a CircuitPython device that +supports both WiFi and BLE. (The first chip is the ESP32-S3.)""" + +import time +from os import getenv + +import adafruit_ble +import adafruit_connection_manager +import adafruit_requests as requests +import board +import wifi +from adafruit_ble.advertising.standard import ManufacturerDataField + +import adafruit_ble_broadcastnet + +# To get a status neopixel flashing, install the neopixel library as well. + +if hasattr(board, "NEOPIXEL"): + try: + import neopixel + import rainbowio + except ImportError: + print("No status pixel due to missing library") + neopixel = None + +# Get WiFi details and Adafruit IO keys, ensure these are setup in settings.toml +# (visit io.adafruit.com if you need to create an account, or if you need your Adafruit IO key.) +ssid = getenv("CIRCUITPY_WIFI_SSID") +password = getenv("CIRCUITPY_WIFI_PASSWORD") +aio_username = getenv("ADAFRUIT_AIO_USERNAME") +aio_key = getenv("ADAFRUIT_AIO_KEY") + +aio_auth_header = {"X-AIO-KEY": aio_key} +aio_base_url = f"https://io.adafruit.com/api/v2/{aio_username}" + +print(f"Connecting to {ssid}") +wifi.radio.connect(ssid, password) +print(f"Connected to {ssid}!") +print(f"My IP address is {wifi.radio.ipv4_address}") + +pool = adafruit_connection_manager.get_radio_socketpool(wifi.radio) +ssl_context = adafruit_connection_manager.get_radio_ssl_context(wifi.radio) +requests = requests.Session(pool, ssl_context) + +status_pixel = None +if neopixel and hasattr(board, "NEOPIXEL"): + status_pixel = neopixel.NeoPixel(board.NEOPIXEL, 1, brightness=0.02) + + +def aio_post(path, **kwargs): + kwargs["headers"] = aio_auth_header + return requests.post(aio_base_url + path, **kwargs) + + +def aio_get(path, **kwargs): + kwargs["headers"] = aio_auth_header + return requests.get(aio_base_url + path, **kwargs) + + +def create_group(name): + response = aio_post("/groups", json={"name": name}) + if response.status_code != 201: + print(name) + print(response.content) + print(response.status_code) + raise RuntimeError("unable to create new group") + return response.json()["key"] + + +def create_feed(group_key, name): + response = aio_post(f"/groups/{group_key}/feeds", json={"feed": {"name": name}}) + if response.status_code != 201: + print(name) + print(response.content) + print(response.status_code) + raise RuntimeError("unable to create new feed") + return response.json()["key"] + + +def create_data(group_key, data): + response = aio_post(f"/groups/{group_key}/data", json={"feeds": data}) + if response.status_code == 429: + print("Throttled!") + return False + if response.status_code != 200: + print(response.status_code, response.json()) + raise RuntimeError("unable to create new data") + response.close() + return True + + +def convert_to_feed_data(values, attribute_name, attribute_instance): + feed_data = [] + # Wrap single value entries for enumeration. + if not isinstance(values, tuple) or ( + attribute_instance.element_count > 1 and not isinstance(values[0], tuple) + ): + values = (values,) + for i, value in enumerate(values): + key = attribute_name.replace("_", "-") + "-" + str(i) + if isinstance(value, tuple): + for j in range(attribute_instance.element_count): + feed_data.append( + { + "key": key + "-" + attribute_instance.field_names[j], + "value": value[j], + } + ) + else: + feed_data.append({"key": key, "value": value}) + return feed_data + + +ble = adafruit_ble.BLERadio() +bridge_address = adafruit_ble_broadcastnet.device_address +print("This is BroadcastNet bridge:", bridge_address) +print() + +print("Fetching existing feeds for this bridge.") + +existing_feeds = {} +response = aio_get("/groups") +for group in response.json(): + if "-" not in group["key"]: + continue + pieces = group["key"].split("-") + if len(pieces) != 4 or pieces[0] != "bridge" or pieces[2] != "sensor": + continue + _, bridge, _, sensor_address = pieces + if bridge != bridge_address: + continue + existing_feeds[sensor_address] = [] + for feed in group["feeds"]: + feed_key = feed["key"].split(".")[-1] + existing_feeds[sensor_address].append(feed_key) + +print(existing_feeds) + +print("scanning") +print() +sequence_numbers = {} +# By providing Advertisement as well we include everything, not just specific advertisements. +for measurement in ble.start_scan( + adafruit_ble_broadcastnet.AdafruitSensorMeasurement, interval=0.5 +): + reversed_address = [measurement.address.address_bytes[i] for i in range(5, -1, -1)] + sensor_address = "{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}".format(*reversed_address) + if sensor_address not in sequence_numbers: + sequence_numbers[sensor_address] = measurement.sequence_number - 1 % 256 + # Skip if we are getting the same broadcast more than once. + if measurement.sequence_number == sequence_numbers[sensor_address]: + continue + number_missed = measurement.sequence_number - sequence_numbers[sensor_address] - 1 + if number_missed < 0: + number_missed += 256 + # Derive the status color from the sensor address. + if status_pixel: + status_pixel[0] = rainbowio.colorwheel(sum(reversed_address)) + group_key = f"bridge-{bridge_address}-sensor-{sensor_address}" + if sensor_address not in existing_feeds: + create_group(f"Bridge {bridge_address} Sensor {sensor_address}") + create_feed(group_key, "Missed Message Count") + existing_feeds[sensor_address] = ["missed-message-count"] + + data = [{"key": "missed-message-count", "value": number_missed}] + for attribute in dir(measurement.__class__): + attribute_instance = getattr(measurement.__class__, attribute) + if issubclass(attribute_instance.__class__, ManufacturerDataField): + if attribute != "sequence_number": + values = getattr(measurement, attribute) + if values is not None: + data.extend(convert_to_feed_data(values, attribute, attribute_instance)) + + for feed_data in data: + if feed_data["key"] not in existing_feeds[sensor_address]: + create_feed(group_key, feed_data["key"]) + existing_feeds[sensor_address].append(feed_data["key"]) + + start_time = time.monotonic() + print(group_key, data) + # Only update the previous sequence if we logged successfully. + if create_data(group_key, data): + sequence_numbers[sensor_address] = measurement.sequence_number + + duration = time.monotonic() - start_time + if status_pixel: + status_pixel[0] = 0x000000 + print(f"Done logging measurement to IO. Took {duration} seconds") + print() + +print("scan done") diff --git a/examples/ble_broadcastnet_cpb.py b/examples/ble_broadcastnet_cpb.py index 41c99d7..4e5f7d8 100644 --- a/examples/ble_broadcastnet_cpb.py +++ b/examples/ble_broadcastnet_cpb.py @@ -4,7 +4,9 @@ """This uses the CircuitPlayground Bluefruit as a sensor node.""" import time + from adafruit_circuitplayground import cp + import adafruit_ble_broadcastnet print("This is BroadcastNet sensor:", adafruit_ble_broadcastnet.device_address) @@ -13,7 +15,7 @@ measurement = adafruit_ble_broadcastnet.AdafruitSensorMeasurement() measurement.temperature = cp.temperature - # add sound level + measurement.sound_level = cp.sound_level measurement.light = cp.light measurement.value = cp.switch # measurement.acceleration = cp.acceleration diff --git a/examples/ble_broadcastnet_expo_backoff.py b/examples/ble_broadcastnet_expo_backoff.py index c840758..8f42480 100644 --- a/examples/ble_broadcastnet_expo_backoff.py +++ b/examples/ble_broadcastnet_expo_backoff.py @@ -2,15 +2,17 @@ # SPDX-License-Identifier: MIT """This example uses the internal temperature sensor and reports the battery voltage. However, it - reads the temperature more often but only reports it when it's changed by a degree since the last - report. When doing a report it will actually do multiple broadcasts and wait 2 ** n readings - until the next broadcast. The delay is reset every time the temp moves more than 1 degree.""" +reads the temperature more often but only reports it when it's changed by a degree since the last +report. When doing a report it will actually do multiple broadcasts and wait 2 ** n readings +until the next broadcast. The delay is reset every time the temp moves more than 1 degree.""" import math import time + import analogio import board import microcontroller + import adafruit_ble_broadcastnet print("This is BroadcastNet sensor:", adafruit_ble_broadcastnet.device_address) @@ -21,7 +23,7 @@ last_temperature = None consecutive = 1 while True: - temp = microcontroller.cpu.temperature # pylint: disable=no-member + temp = microcontroller.cpu.temperature if not last_temperature or abs(temp - last_temperature) > 1: consecutive = 1 last_temperature = temp @@ -31,14 +33,9 @@ # Repeatedly broadcast identical values to help ensure it is picked up by the bridge. Perform # exponential backoff as we get more confidence. exp = int(math.log(consecutive, 2)) - if 2 ** exp == consecutive: + if 2**exp == consecutive: measurement = adafruit_ble_broadcastnet.AdafruitSensorMeasurement() - battery_voltage = ( - battery.value - / 2 ** 16 - * divider_ratio - * battery.reference_voltage # pylint: disable=no-member - ) + battery_voltage = battery.value / 2**16 * divider_ratio * battery.reference_voltage measurement.battery_voltage = int(battery_voltage * 1000) measurement.temperature = temp print(measurement) diff --git a/examples/ble_broadcastnet_multisensor.py b/examples/ble_broadcastnet_multisensor.py index 0f6b4bb..fc9f854 100644 --- a/examples/ble_broadcastnet_multisensor.py +++ b/examples/ble_broadcastnet_multisensor.py @@ -4,13 +4,15 @@ """This is a complex sensor node that uses the sensors on a Clue and Feather Bluefruit Sense.""" import time -import board + import adafruit_bmp280 -import adafruit_sht31d # import adafruit_apds9960.apds9960 import adafruit_lis3mdl import adafruit_lsm6ds +import adafruit_sht31d +import board + import adafruit_ble_broadcastnet print("This is BroadcastNet sensor:", adafruit_ble_broadcastnet.device_address) diff --git a/examples/ble_broadcastnet_scan_test.py b/examples/ble_broadcastnet_scan_test.py index 6d85275..40c9c2d 100644 --- a/examples/ble_broadcastnet_scan_test.py +++ b/examples/ble_broadcastnet_scan_test.py @@ -4,13 +4,12 @@ """This example merely scans for broadcastnet packets to check that something is sending them.""" import adafruit_ble + import adafruit_ble_broadcastnet ble = adafruit_ble.BLERadio() print("scanning") # By providing Advertisement as well we include everything, not just specific advertisements. -for advert in ble.start_scan( - adafruit_ble_broadcastnet.AdafruitSensorMeasurement, interval=0.5 -): +for advert in ble.start_scan(adafruit_ble_broadcastnet.AdafruitSensorMeasurement, interval=0.5): print(advert) diff --git a/examples/ble_broadcastnet_simpletest.py b/examples/ble_broadcastnet_simpletest.py index a165881..13c98ed 100644 --- a/examples/ble_broadcastnet_simpletest.py +++ b/examples/ble_broadcastnet_simpletest.py @@ -2,19 +2,19 @@ # SPDX-License-Identifier: MIT """This is a basic sensor node that uses the internal temperature sensor and reports it every 10 - seconds.""" +seconds.""" import time + import microcontroller + import adafruit_ble_broadcastnet print("This is BroadcastNet sensor:", adafruit_ble_broadcastnet.device_address) while True: measurement = adafruit_ble_broadcastnet.AdafruitSensorMeasurement() - measurement.temperature = ( - microcontroller.cpu.temperature # pylint: disable=no-member - ) + measurement.temperature = microcontroller.cpu.temperature print(measurement) adafruit_ble_broadcastnet.broadcast(measurement) time.sleep(10) 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..6dfb54c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,46 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-ble-broadcastnet" +description = "Basic IOT over BLE advertisements." +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_BLE_BroadcastNet"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "ble_broadcastnet", + "IOT", + "BLE", +] +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] +py-modules = ["adafruit_ble_broadcastnet"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 816986c..4a3754b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,6 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-ble +adafruit-circuitpython-ble>=8.0.0 diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..1b887b1 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# 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 + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index 1c4bf0b..0000000 --- a/setup.py +++ /dev/null @@ -1,57 +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 -""" - -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-ble-broadcastnet", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Basic IOT over BLE advertisements.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-circuitpython-ble"], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython ble_broadcastnet IOT BLE", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_ble_broadcastnet"], -)