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 678763d..4c79df1 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_RFM69/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 CircuitPython RFM69 packet radio module. This supports basic RadioHead-compatible sending and receiving of packets with RFM69 series radios (433/915Mhz). diff --git a/adafruit_rfm69.py b/adafruit_rfm69.py index aadc3d3..c59df96 100644 --- a/adafruit_rfm69.py +++ b/adafruit_rfm69.py @@ -47,8 +47,10 @@ https://github.com/adafruit/circuitpython/releases * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ + import random import time + import adafruit_bus_device.spi_device as spidev from micropython import const @@ -63,9 +65,10 @@ try: from typing import Callable, Optional, Type - from circuitpython_typing import WriteableBuffer, ReadableBuffer - from digitalio import DigitalInOut + from busio import SPI + from circuitpython_typing import ReadableBuffer, WriteableBuffer + from digitalio import DigitalInOut except ImportError: pass @@ -138,14 +141,7 @@ _TICKS_MAX = const(_TICKS_PERIOD - 1) _TICKS_HALFPERIOD = const(_TICKS_PERIOD // 2) -# Disable the silly too many instance members warning. Pylint has no knowledge -# of the context and is merely guessing at the proper amount of members. This -# is a complex chip which requires exposing many attributes and state. Disable -# the warning to work around the error. -# pylint: disable=too-many-instance-attributes - -# disable another pylint nit-pick -# pylint: disable=too-many-public-methods +# This is a complex chip which requires exposing many attributes and state. def ticks_diff(ticks1: int, ticks2: int) -> int: @@ -226,17 +222,11 @@ class _RegisterBits: # used by the parent RFM69 class instance vs. each having their own # buffer and taking too much memory). - # Quirk of pylint that it requires public methods for a class. This - # is a decorator class in Python and by design it has no public methods. - # Instead it uses dunder accessors like get and set below. For some - # reason pylint can't figure this out so disable the check. - # pylint: disable=too-few-public-methods + # This is a decorator class in Python and by design it has no public methods. + # Instead it uses dunder accessors like get and set below. - # Again pylint fails to see the true intent of this code and warns - # against private access by calling the write and read functions below. - # This is by design as this is an internally used class. Disable the - # check from pylint. - # pylint: disable=protected-access + # This is an internally used class that calls the read/write functions + # of the parent class. def __init__(self, address: int, *, offset: int = 0, bits: int = 1) -> None: assert 0 <= offset <= 7 @@ -287,20 +277,18 @@ def __set__(self, obj: Optional["RFM69"], val: int) -> None: mode_ready = _RegisterBits(_REG_IRQ_FLAGS1, offset=7) dio_0_mapping = _RegisterBits(_REG_DIO_MAPPING1, offset=6, bits=2) - # pylint: disable=too-many-statements - # pylint: disable=too-many-arguments - def __init__( # pylint: disable=invalid-name + def __init__( self, spi: SPI, cs: DigitalInOut, reset: DigitalInOut, frequency: int, *, - sync_word: bytes = b"\x2D\xD4", + sync_word: bytes = b"\x2d\xd4", preamble_length: int = 4, encryption_key: Optional[bytes] = None, high_power: bool = True, - baudrate: int = 2000000 + baudrate: int = 2000000, ) -> None: self._tx_power = 13 self.high_power = high_power @@ -312,7 +300,7 @@ def __init__( # pylint: disable=invalid-name self.reset() # Reset the chip. # Check the version of the chip. version = self._read_u8(_REG_VERSION) - if version not in (0x23, 0x24): + if version not in {0x23, 0x24}: raise RuntimeError("Invalid RFM69 version, check wiring!") self.idle() # Enter idle state. # Setup the chip in a similar way to the RadioHead RFM69 library. @@ -395,13 +383,8 @@ def __init__( # pylint: disable=invalid-name Fourth byte of the RadioHead header. """ - # pylint: enable=too-many-statements - - # pylint: disable=no-member # Reconsider this disable when it can be tested. - def _read_into( - self, address: int, buf: WriteableBuffer, length: Optional[int] = None - ) -> None: + def _read_into(self, address: int, buf: WriteableBuffer, length: Optional[int] = None) -> None: # Read a number of bytes from the specified address into the provided # buffer. If length is not specified (the default) the entire buffer # will be filled. @@ -418,9 +401,7 @@ def _read_u8(self, address: int) -> int: self._read_into(address, self._BUFFER, length=1) return self._BUFFER[0] - def _write_from( - self, address: int, buf: ReadableBuffer, length: Optional[int] = None - ) -> None: + def _write_from(self, address: int, buf: ReadableBuffer, length: Optional[int] = None) -> None: # Write a number of bytes to the provided address and taken from the # provided buffer. If no length is specified (the default) the entire # buffer is written. @@ -749,7 +730,6 @@ def payload_ready(self) -> bool: """Receive status""" return (self._read_u8(_REG_IRQ_FLAGS2) & 0x4) >> 2 - # pylint: disable=too-many-branches def send( self, data: ReadableBuffer, @@ -758,7 +738,7 @@ def send( destination: Optional[int] = None, node: Optional[int] = None, identifier: Optional[int] = None, - flags: Optional[int] = None + flags: Optional[int] = None, ) -> bool: """Send a string of data using the transmitter. You can only send 60 bytes at a time @@ -773,13 +753,8 @@ def send( Returns: True if success or False if the send timed out. """ - # Disable pylint warning to not use length as a check for zero. - # This is a puzzling warning as the below code is clearly the most - # efficient and proper way to ensure a precondition that the provided - # buffer be within an expected range of bounds. Disable this check. - # pylint: disable=len-as-condition + # Ensure the provided buffer is within the expected range of bounds. assert 0 < len(data) <= 60 - # pylint: enable=len-as-condition self.idle() # Stop receiving to clear FIFO and keep it clear. # Fill the FIFO with a packet to send. # Combine header and data to form payload @@ -859,7 +834,7 @@ def receive( keep_listening: bool = True, with_ack: bool = False, timeout: Optional[float] = None, - with_header: bool = False + with_header: bool = False, ) -> int: """Wait to receive a packet from the receiver. If a packet is found the payload bytes are returned, otherwise None is returned (which indicates the timeout elapsed with no @@ -904,11 +879,10 @@ def receive( if fifo_length < 5: packet = None else: - if ( - self.node != _RH_BROADCAST_ADDRESS - and packet[0] != _RH_BROADCAST_ADDRESS - and packet[0] != self.node - ): + if self.node != _RH_BROADCAST_ADDRESS and packet[0] not in { + _RH_BROADCAST_ADDRESS, + self.node, + }: packet = None # send ACK unless this was an ACK or a broadcast elif ( @@ -928,15 +902,11 @@ def receive( flags=(packet[3] | _RH_FLAGS_ACK), ) # reject Retries if we have seen this idetifier from this source before - if (self.seen_ids[packet[1]] == packet[2]) and ( - packet[3] & _RH_FLAGS_RETRY - ): + if (self.seen_ids[packet[1]] == packet[2]) and (packet[3] & _RH_FLAGS_RETRY): packet = None else: # save the packet identifier for this source self.seen_ids[packet[1]] = packet[2] - if ( - not with_header and packet is not None - ): # skip the header if not wanted + if not with_header and packet is not None: # skip the header if not wanted packet = packet[4:] # Listen again if necessary and return the result packet. if keep_listening: diff --git a/docs/api.rst b/docs/api.rst index 212b270..c12c996 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,11 @@ .. If you created a package, create one automodule per module in the package. +.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) +.. use this format as the module name: "adafruit_foo.foo" + +API Reference +############# + .. automodule:: adafruit_rfm69 :members: diff --git a/docs/conf.py b/docs/conf.py index fec9614..88ef604 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("..")) @@ -49,9 +47,7 @@ creation_year = "2017" 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 + " Tony DiCola" author = "Tony DiCola" diff --git a/examples/rfm69_header.py b/examples/rfm69_header.py index 973fe85..7202cdc 100644 --- a/examples/rfm69_header.py +++ b/examples/rfm69_header.py @@ -3,10 +3,10 @@ # Example to display raw packets including header -# import board import busio import digitalio + import adafruit_rfm69 # set the time interval (seconds) for sending packets @@ -28,9 +28,7 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # Wait to receive packets. print("Waiting for packets...") @@ -43,6 +41,6 @@ # Received a packet! # Print out the raw bytes of the packet: print("Received (raw header):", [hex(x) for x in packet[0:4]]) - print("Received (raw payload): {0}".format(packet[4:])) - print("RSSI: {0}".format(rfm69.last_rssi)) + print(f"Received (raw payload): {packet[4:]}") + print(f"RSSI: {rfm69.last_rssi}") # send reading after any packet received diff --git a/examples/rfm69_node1.py b/examples/rfm69_node1.py index e956c25..b3f10e7 100644 --- a/examples/rfm69_node1.py +++ b/examples/rfm69_node1.py @@ -4,11 +4,12 @@ # Example to send a packet periodically between addressed nodes import time + import board import busio import digitalio -import adafruit_rfm69 +import adafruit_rfm69 # set the time interval (seconds) for sending packets transmit_interval = 10 @@ -28,9 +29,7 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # set node addresses rfm69.node = 1 @@ -38,9 +37,7 @@ # initialize counter counter = 0 # send a broadcast message from my_node with ID = counter -rfm69.send( - bytes("Startup message {} from node {}".format(counter, rfm69.node), "UTF-8") -) +rfm69.send(bytes(f"Startup message {counter} from node {rfm69.node}", "UTF-8")) # Wait to receive packets. print("Waiting for packets...") @@ -53,16 +50,14 @@ # Received a packet! # Print out the raw bytes of the packet: print("Received (raw header):", [hex(x) for x in packet[0:4]]) - print("Received (raw payload): {0}".format(packet[4:])) - print("Received RSSI: {0}".format(rfm69.last_rssi)) + print(f"Received (raw payload): {packet[4:]}") + print(f"Received RSSI: {rfm69.last_rssi}") if time.monotonic() - now > transmit_interval: now = time.monotonic() counter = counter + 1 # send a mesage to destination_node from my_node rfm69.send( - bytes( - "message number {} from node {}".format(counter, rfm69.node), "UTF-8" - ), + bytes(f"message number {counter} from node {rfm69.node}", "UTF-8"), keep_listening=True, ) button_pressed = None diff --git a/examples/rfm69_node1_ack.py b/examples/rfm69_node1_ack.py index f5c6b3a..c34d8fb 100644 --- a/examples/rfm69_node1_ack.py +++ b/examples/rfm69_node1_ack.py @@ -4,9 +4,11 @@ # Example to send a packet periodically between addressed nodes with ACK import time + import board import busio import digitalio + import adafruit_rfm69 # set the time interval (seconds) for sending packets @@ -28,9 +30,7 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # set delay before sending ACK rfm69.ack_delay = 0.1 @@ -41,7 +41,7 @@ counter = 0 ack_failed_counter = 0 # send startup message from my_node -rfm69.send_with_ack(bytes("startup message from node {}".format(rfm69.node), "UTF-8")) +rfm69.send_with_ack(bytes(f"startup message from node {rfm69.node}", "UTF-8")) # Wait to receive packets. print("Waiting for packets...") @@ -55,8 +55,8 @@ # Received a packet! # Print out the raw bytes of the packet: print("Received (raw header):", [hex(x) for x in packet[0:4]]) - print("Received (raw payload): {0}".format(packet[4:])) - print("RSSI: {0}".format(rfm69.last_rssi)) + print(f"Received (raw payload): {packet[4:]}") + print(f"RSSI: {rfm69.last_rssi}") # send reading after any packet received if time.monotonic() - time_now > transmit_interval: # reset timeer @@ -64,7 +64,7 @@ counter += 1 # send a mesage to destination_node from my_node if not rfm69.send_with_ack( - bytes("message from node node {} {}".format(rfm69.node, counter), "UTF-8") + bytes(f"message from node node {rfm69.node} {counter}", "UTF-8") ): ack_failed_counter += 1 print(" No Ack: ", counter, ack_failed_counter) diff --git a/examples/rfm69_node1_bonnet.py b/examples/rfm69_node1_bonnet.py index dbc3770..2d3ab65 100644 --- a/examples/rfm69_node1_bonnet.py +++ b/examples/rfm69_node1_bonnet.py @@ -3,12 +3,12 @@ # Example to send a packet periodically between addressed nodes +# Import the SSD1306 module. +import adafruit_ssd1306 import board import busio import digitalio -# Import the SSD1306 module. -import adafruit_ssd1306 import adafruit_rfm69 # Button A @@ -68,9 +68,7 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # set node addresses rfm69.node = 1 @@ -78,9 +76,7 @@ # initialize counter counter = 0 # send a broadcast message from my_node with ID = counter -rfm69.send( - bytes("Startup message {} from node {}".format(counter, rfm69.node), "UTF-8") -) +rfm69.send(bytes(f"Startup message {counter} from node {rfm69.node}", "UTF-8")) # Wait to receive packets. print("Waiting for packets...") @@ -93,8 +89,8 @@ # Received a packet! # Print out the raw bytes of the packet: print("Received (raw header):", [hex(x) for x in packet[0:4]]) - print("Received (raw payload): {0}".format(packet[4:])) - print("Received RSSI: {0}".format(rfm69.last_rssi)) + print(f"Received (raw payload): {packet[4:]}") + print(f"Received RSSI: {rfm69.last_rssi}") # Check buttons if not btnA.value: button_pressed = "A" @@ -120,9 +116,7 @@ # send a mesage to destination_node from my_node rfm69.send( bytes( - "message number {} from node {} button {}".format( - counter, rfm69.node, button_pressed - ), + f"message number {counter} from node {rfm69.node} button {button_pressed}", "UTF-8", ), keep_listening=True, diff --git a/examples/rfm69_node2.py b/examples/rfm69_node2.py index 9d506eb..0453d90 100644 --- a/examples/rfm69_node2.py +++ b/examples/rfm69_node2.py @@ -4,9 +4,11 @@ # Example to send a packet periodically between addressed nodes import time + import board import busio import digitalio + import adafruit_rfm69 # Define radio parameters. @@ -25,9 +27,7 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # set node addresses rfm69.node = 2 @@ -35,7 +35,7 @@ # initialize counter counter = 0 # send a broadcast message from my_node with ID = counter -rfm69.send(bytes("startup message from node {} ".format(rfm69.node), "UTF-8")) +rfm69.send(bytes(f"startup message from node {rfm69.node} ", "UTF-8")) # Wait to receive packets. print("Waiting for packets...") @@ -49,8 +49,8 @@ # Received a packet! # Print out the raw bytes of the packet: print("Received (raw header):", [hex(x) for x in packet[0:4]]) - print("Received (raw payload): {0}".format(packet[4:])) - print("Received RSSI: {0}".format(rfm69.last_rssi)) + print(f"Received (raw payload): {packet[4:]}") + print(f"Received RSSI: {rfm69.last_rssi}") # send reading after any packet received counter = counter + 1 # after 10 messages send a response to destination_node from my_node with ID = counter&0xff @@ -59,7 +59,7 @@ rfm69.identifier = counter & 0xFF rfm69.send( bytes( - "message number {} from node {} ".format(counter, rfm69.node), + f"message number {counter} from node {rfm69.node} ", "UTF-8", ), keep_listening=True, diff --git a/examples/rfm69_node2_ack.py b/examples/rfm69_node2_ack.py index 4a72d3a..f2db133 100644 --- a/examples/rfm69_node2_ack.py +++ b/examples/rfm69_node2_ack.py @@ -4,9 +4,11 @@ # Example to receive addressed packed with ACK and send a response import time + import board import busio import digitalio + import adafruit_rfm69 # Define radio parameters. @@ -25,9 +27,7 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # set delay before transmitting ACK (seconds) rfm69.ack_delay = 0.1 @@ -48,14 +48,12 @@ # Received a packet! # Print out the raw bytes of the packet: print("Received (raw header):", [hex(x) for x in packet[0:4]]) - print("Received (raw payload): {0}".format(packet[4:])) - print("RSSI: {0}".format(rfm69.last_rssi)) + print(f"Received (raw payload): {packet[4:]}") + print(f"RSSI: {rfm69.last_rssi}") # send response 2 sec after any packet received time.sleep(2) counter += 1 # send a mesage to destination_node from my_node - if not rfm69.send_with_ack( - bytes("response from node {} {}".format(rfm69.node, counter), "UTF-8") - ): + if not rfm69.send_with_ack(bytes(f"response from node {rfm69.node} {counter}", "UTF-8")): ack_failed_counter += 1 print(" No Ack: ", counter, ack_failed_counter) diff --git a/examples/rfm69_rpi_interrupt.py b/examples/rfm69_rpi_interrupt.py index 7f7c6a5..ae61b41 100644 --- a/examples/rfm69_rpi_interrupt.py +++ b/examples/rfm69_rpi_interrupt.py @@ -6,21 +6,19 @@ # This example is for systems that support interrupts like the Raspberry Pi with "blinka" # CircuitPython does not support interrupts so it will not work on Circutpython boards import time + import board import busio import digitalio import RPi.GPIO as io + import adafruit_rfm69 # setup interrupt callback function def rfm69_callback(rfm69_irq): - global packet_received # pylint: disable=global-statement - print( - "IRQ detected on pin {0} payload_ready {1} ".format( - rfm69_irq, rfm69.payload_ready - ) - ) + global packet_received # noqa: PLW0603 + print(f"IRQ detected on pin {rfm69_irq} payload_ready {rfm69.payload_ready} ") # see if this was a payload_ready interrupt ignore if not if rfm69.payload_ready: packet = rfm69.receive(timeout=None) @@ -28,9 +26,9 @@ def rfm69_callback(rfm69_irq): # Received a packet! packet_received = True # Print out the raw bytes of the packet: - print("Received (raw bytes): {0}".format(packet)) + print(f"Received (raw bytes): {packet}") print([hex(x) for x in packet]) - print("RSSI: {0}".format(rfm69.last_rssi)) + print(f"RSSI: {rfm69.last_rssi}") # Define radio parameters. @@ -49,15 +47,13 @@ def rfm69_callback(rfm69_irq): # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # Print out some chip state: -print("Temperature: {0}C".format(rfm69.temperature)) -print("Frequency: {0}mhz".format(rfm69.frequency_mhz)) -print("Bit rate: {0}kbit/s".format(rfm69.bitrate / 1000)) -print("Frequency deviation: {0}hz".format(rfm69.frequency_deviation)) +print(f"Temperature: {rfm69.temperature}C") +print(f"Frequency: {rfm69.frequency_mhz}mhz") +print(f"Bit rate: {rfm69.bitrate / 1000}kbit/s") +print(f"Frequency deviation: {rfm69.frequency_deviation}hz") # configure the interrupt pin and event handling. RFM69_G0 = 22 diff --git a/examples/rfm69_rpi_simpletest.py b/examples/rfm69_rpi_simpletest.py index 333afb2..47c231f 100644 --- a/examples/rfm69_rpi_simpletest.py +++ b/examples/rfm69_rpi_simpletest.py @@ -11,7 +11,6 @@ import adafruit_rfm69 - # Define radio parameters. RADIO_FREQ_MHZ = 915.0 # Frequency of the radio in Mhz. Must match your # module! Can be a value like 915.0, 433.0, etc. @@ -33,15 +32,13 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # Print out some chip state: -print("Temperature: {0}C".format(rfm69.temperature)) -print("Frequency: {0}mhz".format(rfm69.frequency_mhz)) -print("Bit rate: {0}kbit/s".format(rfm69.bitrate / 1000)) -print("Frequency deviation: {0}hz".format(rfm69.frequency_deviation)) +print(f"Temperature: {rfm69.temperature}C") +print(f"Frequency: {rfm69.frequency_mhz}mhz") +print(f"Bit rate: {rfm69.bitrate / 1000}kbit/s") +print(f"Frequency deviation: {rfm69.frequency_deviation}hz") # Send a packet. Note you can only send a packet up to 60 bytes in length. # This is a limitation of the radio packet size, so if you need to send larger @@ -66,10 +63,10 @@ else: # Received a packet! # Print out the raw bytes of the packet: - print("Received (raw bytes): {0}".format(packet)) + print(f"Received (raw bytes): {packet}") # And decode to ASCII text and print it too. Note that you always # receive raw bytes and need to convert to a text format like ASCII # if you intend to do string processing on your data. Make sure the # sending side is sending ASCII data before you try to decode! packet_text = str(packet, "ascii") - print("Received (ASCII): {0}".format(packet_text)) + print(f"Received (ASCII): {packet_text}") diff --git a/examples/rfm69_simpletest.py b/examples/rfm69_simpletest.py index d160090..7b5bab9 100644 --- a/examples/rfm69_simpletest.py +++ b/examples/rfm69_simpletest.py @@ -10,7 +10,6 @@ import adafruit_rfm69 - # Define radio parameters. RADIO_FREQ_MHZ = 915.0 # Frequency of the radio in Mhz. Must match your # module! Can be a value like 915.0, 433.0, etc. @@ -35,15 +34,13 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # Print out some chip state: -print("Temperature: {0}C".format(rfm69.temperature)) -print("Frequency: {0}mhz".format(rfm69.frequency_mhz)) -print("Bit rate: {0}kbit/s".format(rfm69.bitrate / 1000)) -print("Frequency deviation: {0}hz".format(rfm69.frequency_deviation)) +print(f"Temperature: {rfm69.temperature}C") +print(f"Frequency: {rfm69.frequency_mhz}mhz") +print(f"Bit rate: {rfm69.bitrate / 1000}kbit/s") +print(f"Frequency deviation: {rfm69.frequency_deviation}hz") # Send a packet. Note you can only send a packet up to 60 bytes in length. # This is a limitation of the radio packet size, so if you need to send larger @@ -70,10 +67,10 @@ # Received a packet! LED.value = True # Print out the raw bytes of the packet: - print("Received (raw bytes): {0}".format(packet)) + print(f"Received (raw bytes): {packet}") # And decode to ASCII text and print it too. Note that you always # receive raw bytes and need to convert to a text format like ASCII # if you intend to do string processing on your data. Make sure the # sending side is sending ASCII data before you try to decode! packet_text = str(packet, "ascii") - print("Received (ASCII): {0}".format(packet_text)) + print(f"Received (ASCII): {packet_text}") diff --git a/examples/rfm69_transmit.py b/examples/rfm69_transmit.py index 1431b22..90e445a 100644 --- a/examples/rfm69_transmit.py +++ b/examples/rfm69_transmit.py @@ -4,9 +4,11 @@ # Example to send a packet periodically import time + import board import busio import digitalio + import adafruit_rfm69 # set the time interval (seconds) for sending packets @@ -28,14 +30,12 @@ # Optionally set an encryption key (16 byte AES key). MUST match both # on the transmitter and receiver (or be set to None to disable/the default). -rfm69.encryption_key = ( - b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" -) +rfm69.encryption_key = b"\x01\x02\x03\x04\x05\x06\x07\x08\x01\x02\x03\x04\x05\x06\x07\x08" # initialize counter counter = 0 # send a broadcast mesage -rfm69.send(bytes("message number {}".format(counter), "UTF-8")) +rfm69.send(bytes(f"message number {counter}", "UTF-8")) # Wait to receive packets. print("Waiting for packets...") @@ -49,7 +49,7 @@ if packet is not None: # Received a packet! # Print out the raw bytes of the packet: - print("Received (raw bytes): {0}".format(packet)) + print(f"Received (raw bytes): {packet}") # send reading after any packet received if time.monotonic() - time_now > transmit_interval: # reset timeer @@ -57,4 +57,4 @@ # clear flag to send data send_reading = False counter = counter + 1 - rfm69.send(bytes("message number {}".format(counter), "UTF-8")) + rfm69.send(bytes(f"message number {counter}", "UTF-8")) diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# 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 +] + +[format] +line-ending = "lf"