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/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +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: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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 ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. 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=pylint.extensions.no_self_use - -# 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,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# 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 - -# 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] - -# Regular expression matching correct argument names -argument-rgx=(([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 - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-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 - -# 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 - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-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 - -# 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=builtins.Exception diff --git a/README.rst b/README.rst index 87e50bd..c5d68e6 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BLE_BroadcastNet/actions :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. 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. diff --git a/adafruit_ble_broadcastnet.py b/adafruit_ble_broadcastnet.py index e3f93ba..3ffb494 100644 --- a/adafruit_ble_broadcastnet.py +++ b/adafruit_ble_broadcastnet.py @@ -12,19 +12,21 @@ * Author(s): Scott Shawcroft """ -import struct import os +import struct import time + import adafruit_ble from adafruit_ble.advertising import Advertisement, LazyObjectField -from adafruit_ble.advertising.standard import ManufacturerData, ManufacturerDataField from adafruit_ble.advertising.adafruit import ( - MANUFACTURING_DATA_ADT, ADAFRUIT_COMPANY_ID, + MANUFACTURING_DATA_ADT, ) +from adafruit_ble.advertising.standard import ManufacturerData, ManufacturerDataField try: from typing import Optional + from _bleio import ScanEntry except ImportError: pass @@ -32,21 +34,18 @@ __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: "AdafruitSensorMeasurement", - *, - broadcast_time: float = 0.1, - extended: bool = False + 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, 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) @@ -59,16 +58,12 @@ def broadcast( 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.""" @@ -162,9 +157,7 @@ class AdafruitSensorMeasurement(Advertisement): sound_level = ManufacturerDataField(0x0A16, " None: + def __init__(self, *, entry: Optional[ScanEntry] = None, sequence_number: int = 0) -> None: super().__init__(entry=entry) if entry: return @@ -177,7 +170,7 @@ def __str__(self) -> str: 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 split(self, max_packet_size: int = 31) -> "AdafruitSensorMeasurement": 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 b837fbf..c457355 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -48,9 +46,7 @@ creation_year = "2020" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Scott Shawcroft" author = "Scott Shawcroft" diff --git a/examples/ble_broadcastnet_battery_level.py b/examples/ble_broadcastnet_battery_level.py index 367fd52..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 f01c585..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 30007fb..735a09f 100644 --- a/examples/ble_broadcastnet_blinka_bridge.py +++ b/examples/ble_broadcastnet_blinka_bridge.py @@ -2,12 +2,15 @@ # SPDX-License-Identifier: MIT """This example bridges from BLE to Adafruit IO on a Raspberry Pi.""" -from os import getenv + import time +from os import getenv + +import adafruit_ble import requests from adafruit_ble.advertising.standard import ManufacturerDataField from adafruit_blinka import load_settings_toml -import adafruit_ble + import adafruit_ble_broadcastnet # Get Adafruit IO keys, ensure these are setup in settings.toml @@ -30,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: @@ -45,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) @@ -57,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 @@ -132,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"] @@ -145,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]: @@ -161,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 index 3d66f76..d33422d 100644 --- a/examples/ble_broadcastnet_bridge.py +++ b/examples/ble_broadcastnet_bridge.py @@ -2,15 +2,18 @@ # 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.)""" -from os import getenv +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 -from adafruit_ble.advertising.standard import ManufacturerDataField -import adafruit_ble 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. @@ -57,10 +60,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: @@ -72,9 +71,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) @@ -84,7 +81,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 @@ -162,9 +159,9 @@ def convert_to_feed_data(values, attribute_name, attribute_instance): # Derive the status color from the sensor address. if status_pixel: status_pixel[0] = rainbowio.colorwheel(sum(reversed_address)) - 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"] @@ -175,9 +172,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]: @@ -193,7 +188,7 @@ def convert_to_feed_data(values, attribute_name, attribute_instance): duration = time.monotonic() - start_time if status_pixel: status_pixel[0] = 0x000000 - 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_cpb.py b/examples/ble_broadcastnet_cpb.py index d049054..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) diff --git a/examples/ble_broadcastnet_expo_backoff.py b/examples/ble_broadcastnet_expo_backoff.py index 865a8d4..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 @@ -33,12 +35,7 @@ exp = int(math.log(consecutive, 2)) 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/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"