adafruit-mirror/Adafruit_CircuitPython_seesaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #140 from adafruit/use_ruff

Browse source 
change to ruff
This commit is contained in:
foamyguy 2025-05-15 10:45:39 -05:00 committed by GitHub
commit 5a4cd087cf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
38 changed files with 229 additions and 537 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.gitattributes vendored Normal file
View file

@ -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

43
.pre-commit-config.yaml
View file

@ -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

399
.pylintrc
View file

@ -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*(# )?<?https?://\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

6
README.rst
View file

@ -14,9 +14,9 @@ Introduction
:target: https://github.com/adafruit/Adafruit_CircuitPython_seesaw/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 module for use with the Adafruit ATSAMD09 seesaw.

1
adafruit_seesaw/analoginput.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods
"""
`adafruit_seesaw.analoginput`

1
adafruit_seesaw/attiny8x7.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,too-few-public-methods
"""
`adafruit_seesaw.attiny8x7` - Pin definition for Adafruit ATtiny8x7 Breakout with seesaw

1
adafruit_seesaw/attinyx16.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,too-few-public-methods
"""
`adafruit_seesaw.attinyx16` - Pin definition for Adafruit ATtinyx16 Breakout with seesaw
==================================================================================

1
adafruit_seesaw/crickit.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,too-few-public-methods
"""
`adafruit_seesaw.crickit` - Pin definition for Adafruit CRICKIT

1
adafruit_seesaw/digitalio.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods
"""
`adafruit_seesaw.digitalio`

13
adafruit_seesaw/keypad.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods
"""
`adafruit_seesaw.keypad`
@ -32,7 +31,6 @@ _KEYPAD_COUNT = const(0x04)
_KEYPAD_FIFO = const(0x10)
# pylint: disable=too-few-public-methods
class KeyEvent:
"""Holds information about a key event in its properties
@ -75,7 +73,7 @@ class Keypad(Seesaw):
@interrupt_enabled.setter
def interrupt_enabled(self, value):
if value not in (True, False):
if value not in {True, False}:
raise ValueError("interrupt_enabled must be True or False")
self._interrupt_enabled = value
@ -85,17 +83,14 @@ class Keypad(Seesaw):
self.write8(_KEYPAD_BASE, _KEYPAD_INTENCLR, 1)
@property
def count(self):
def count(self): # noqa: PLR6301
"""Retrieve or set the number of keys"""
return self.read8(_KEYPAD_BASE, _KEYPAD_COUNT)
# pylint: disable=unused-argument, no-self-use
@count.setter
def count(self, value):
def count(self, value): # noqa: PLR6301
raise AttributeError("count is read only")
# pylint: enable=unused-argument, no-self-use
def set_event(self, key, edge, enable):
"""Control which kinds of events are set
@ -103,7 +98,7 @@ class Keypad(Seesaw):
:param int edge: The type of event
:param bool enable: True to enable the event, False to disable it"""
if enable not in (True, False):
if enable not in {True, False}:
raise ValueError("event enable must be True or False")
if edge > 3 or edge < 0:
raise ValueError("invalid edge")

13
adafruit_seesaw/neopixel.py
View file

@ -2,13 +2,14 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods
"""
`adafruit_seesaw.neopixel`
====================================================
"""
import struct
from adafruit_pixelbuf import PixelBuf
try:
@ -64,15 +65,7 @@ class NeoPixel(PixelBuf):
Use one of the order constants such as RGBW."""
def __init__(
self,
seesaw,
pin,
n,
*,
bpp=None,
brightness=1.0,
auto_write=True,
pixel_order="GRB"
self, seesaw, pin, n, *, bpp=None, brightness=1.0, auto_write=True, pixel_order="GRB"
):
self._seesaw = seesaw
self._pin = pin

1
adafruit_seesaw/pwmout.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,too-few-public-methods
"""
`adafruit_seesaw.pwmout`

1
adafruit_seesaw/robohat.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,too-few-public-methods
"""
`adafruit_seesaw.robohat` - Pin definition for RoboHAT

2
adafruit_seesaw/rotaryio.py
View file

@ -2,8 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods
"""
`adafruit_seesaw.rotaryio`

1
adafruit_seesaw/samd09.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,too-few-public-methods
"""
`adafruit_seesaw.samd09` - Pin definition for Adafruit SAMD09 Breakout with seesaw

40
adafruit_seesaw/seesaw.py
View file

@ -27,7 +27,6 @@ Implementation Notes
# This code needs to be broken up into analogio, busio, digitalio, and pulseio
# compatible classes so we won't bother with some lints until then.
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods,no-name-in-module
import struct
import time
@ -149,7 +148,7 @@ class Seesaw:
self.sw_reset()
self.chip_id = self.read8(_STATUS_BASE, _STATUS_HW_ID)
if self.chip_id not in (
if self.chip_id not in {
_ATTINY806_HW_ID_CODE,
_ATTINY807_HW_ID_CODE,
_ATTINY816_HW_ID_CODE,
@ -157,42 +156,39 @@ class Seesaw:
_ATTINY1616_HW_ID_CODE,
_ATTINY1617_HW_ID_CODE,
_SAMD09_HW_ID_CODE,
):
}:
raise RuntimeError(
f"Seesaw hardware ID returned 0x{self.chip_id:x} is not "
"correct! Please check your wiring."
)
pid = self.get_version() >> 16
# pylint: disable=import-outside-toplevel
if pid == _CRICKIT_PID:
from adafruit_seesaw.crickit import Crickit_Pinmap
from adafruit_seesaw.crickit import Crickit_Pinmap # noqa: PLC0415
self.pin_mapping = Crickit_Pinmap
elif pid == _ROBOHATMM1_PID:
from adafruit_seesaw.robohat import MM1_Pinmap
from adafruit_seesaw.robohat import MM1_Pinmap # noqa: PLC0415
self.pin_mapping = MM1_Pinmap
elif (pid in (_5690_PID, _5681_PID, _5743_PID)) or (
self.chip_id
in (_ATTINY816_HW_ID_CODE, _ATTINY806_HW_ID_CODE, _ATTINY1616_HW_ID_CODE)
elif (pid in {_5690_PID, _5681_PID, _5743_PID}) or (
self.chip_id in {_ATTINY816_HW_ID_CODE, _ATTINY806_HW_ID_CODE, _ATTINY1616_HW_ID_CODE}
):
from adafruit_seesaw.attinyx16 import ATtinyx16_Pinmap
from adafruit_seesaw.attinyx16 import ATtinyx16_Pinmap # noqa: PLC0415
self.pin_mapping = ATtinyx16_Pinmap
elif self.chip_id == _SAMD09_HW_ID_CODE:
from adafruit_seesaw.samd09 import SAMD09_Pinmap
from adafruit_seesaw.samd09 import SAMD09_Pinmap # noqa: PLC0415
self.pin_mapping = SAMD09_Pinmap
elif self.chip_id in (
elif self.chip_id in {
_ATTINY817_HW_ID_CODE,
_ATTINY807_HW_ID_CODE,
_ATTINY1617_HW_ID_CODE,
):
from adafruit_seesaw.attiny8x7 import ATtiny8x7_Pinmap
}:
from adafruit_seesaw.attiny8x7 import ATtiny8x7_Pinmap # noqa: PLC0415
self.pin_mapping = ATtiny8x7_Pinmap
# pylint: enable=import-outside-toplevel
def sw_reset(self, post_reset_delay=0.5):
"""Trigger a software reset of the SeeSaw chip"""
@ -230,8 +226,8 @@ class Seesaw:
def digital_read(self, pin):
"""Get the value of an input pin by number"""
if pin >= 32:
return self.digital_read_bulk_b((1 << (pin - 32))) != 0
return self.digital_read_bulk((1 << pin)) != 0
return self.digital_read_bulk_b(1 << (pin - 32)) != 0
return self.digital_read_bulk(1 << pin) != 0
def digital_read_bulk(self, pins, delay=0.008):
"""Get the values of all the pins on the 'A' port as a bitmask"""
@ -445,19 +441,19 @@ class Seesaw:
def _get_eeprom_i2c_addr(self):
"""Return the EEPROM address used to store I2C address."""
chip_id = self.chip_id
if chip_id in (
if chip_id in {
_ATTINY806_HW_ID_CODE,
_ATTINY807_HW_ID_CODE,
_ATTINY816_HW_ID_CODE,
_ATTINY817_HW_ID_CODE,
):
}:
return 0x7F
if chip_id in (
if chip_id in {
_ATTINY1616_HW_ID_CODE,
_ATTINY1617_HW_ID_CODE,
):
}:
return 0xFF
if chip_id in (_SAMD09_HW_ID_CODE,):
if chip_id in {_SAMD09_HW_ID_CODE}:
return 0x3F
return None

4
adafruit_seesaw/tftshield18.py
View file

@ -2,7 +2,6 @@
#
# SPDX-License-Identifier: MIT
# pylint: disable=missing-docstring,invalid-name,too-many-public-methods
"""
`adafruit_seesaw.tftshield18` - Pin definitions for 1.8" TFT Shield V2
@ -10,6 +9,7 @@
"""
from collections import namedtuple
import board
try:
@ -44,7 +44,7 @@ Buttons = namedtuple("Buttons", "right down left up select a b c")
class TFTShield18(Seesaw):
_BACKLIGHT_ON = b"\xFF\xFF"
_BACKLIGHT_ON = b"\xff\xff"
_BACKLIGHT_OFF = b"\x00\x00"
try:

3
docs/api.rst
View file

@ -1,6 +1,9 @@
.. If you created a package, create one automodule per module in the package.
API Reference
#############
.. automodule:: adafruit_seesaw
:members:

8
docs/conf.py
View file

@ -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(".."))
@ -65,9 +63,7 @@ project = "Adafruit seesaw Library"
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 + " Dean Miller"
author = "Dean Miller"

4
examples/seesaw_analogin_test.py
View file

@ -6,9 +6,11 @@
# on Attiny8x7, analog in can be pins 0, 1, 2, 3, 6, 7, 18, 19, 20
import time
import board
from adafruit_seesaw.seesaw import Seesaw
from adafruit_seesaw.analoginput import AnalogInput
from adafruit_seesaw.seesaw import Seesaw
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller

3
examples/seesaw_ano_rotary_7segment_demo.py
View file

@ -5,7 +5,8 @@
import board
from adafruit_ht16k33 import segments
from adafruit_seesaw import seesaw, rotaryio, digitalio
from adafruit_seesaw import digitalio, rotaryio, seesaw
# For use with the STEMMA connector on QT Py RP2040
# import busio

3
examples/seesaw_ano_rotary_simpletest.py
View file

@ -4,7 +4,8 @@
"""I2C ANO rotary encoder simple test example."""
import board
from adafruit_seesaw import seesaw, rotaryio, digitalio
from adafruit_seesaw import digitalio, rotaryio, seesaw
# For use with the STEMMA connector on QT Py RP2040
# import busio

4
examples/seesaw_arcade_qt_multi_board.py
View file

@ -1,10 +1,12 @@
# SPDX-FileCopyrightText: 2022 Kattni Rembor for Adafruit Industries
# SPDX-License-Identifier: MIT
"""Arcade QT example for multiple boards that turns on button LED when button is pressed"""
import board
import digitalio
from adafruit_seesaw.seesaw import Seesaw
from adafruit_seesaw.digitalio import DigitalIO
from adafruit_seesaw.seesaw import Seesaw
# For most boards.
i2c = board.I2C() # uses board.SCL and board.SDA

5
examples/seesaw_arcade_qt_simpletest.py
View file

@ -1,12 +1,15 @@
# SPDX-FileCopyrightText: 2022 Kattni Rembor for Adafruit Industries
# SPDX-License-Identifier: MIT
"""Arcade QT example that pulses the button LED on button press"""
import time
import board
import digitalio
from adafruit_seesaw.seesaw import Seesaw
from adafruit_seesaw.digitalio import DigitalIO
from adafruit_seesaw.pwmout import PWMOut
from adafruit_seesaw.seesaw import Seesaw
# The delay on the PWM cycles. Increase to slow down the LED pulsing, decrease to speed it up.
delay = 0.01

3
examples/seesaw_attiny_simpletest.py
View file

@ -3,8 +3,11 @@
"""
Simple seesaw test for ATtiny8x7 breakout using built-in LED on pin 5.
"""
import time
import board
from adafruit_seesaw.seesaw import Seesaw
i2c = board.I2C() # uses board.SCL and board.SDA

9
examples/seesaw_crickit_test.py
View file

@ -3,8 +3,9 @@
import board
from adafruit_motor import servo
from adafruit_seesaw.seesaw import Seesaw
from adafruit_seesaw.pwmout import PWMOut
from adafruit_seesaw.seesaw import Seesaw
# from analogio import AnalogOut
# import board
@ -151,8 +152,7 @@ while True:
else:
ss.analog_write(_CRCKIT_M1_A2, 0)
ss.analog_write(_CRCKIT_M1_A1, counter * 512)
else:
if motor1_dir:
elif motor1_dir:
ss.analog_write(_CRCKIT_M1_A1, 0)
ss.analog_write(_CRCKIT_M1_A2, (255 - counter) * 512)
else:
@ -169,8 +169,7 @@ while True:
else:
ss.analog_write(_CRCKIT_M1_B2, 0)
ss.analog_write(_CRCKIT_M1_B1, counter * 512)
else:
if motor2_dir:
elif motor2_dir:
ss.analog_write(_CRCKIT_M1_B1, 0)
ss.analog_write(_CRCKIT_M1_B2, (255 - counter) * 512)
else:

4
examples/seesaw_digitalio_test.py
View file

@ -10,10 +10,12 @@
# https://learn.adafruit.com/adafruit-attiny817-seesaw/digital-input
import time
import board
import digitalio
from adafruit_seesaw.seesaw import Seesaw
from adafruit_seesaw.digitalio import DigitalIO
from adafruit_seesaw.seesaw import Seesaw
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller

2
examples/seesaw_eeprom_test.py
View file

@ -6,7 +6,9 @@
# THE LAST BYTE IS USED FOR I2C ADDRESS CHANGE!
import time
import board
from adafruit_seesaw import seesaw
i2c_bus = board.I2C() # uses board.SCL and board.SDA

2
examples/seesaw_gamepad_qt.py
View file

@ -4,8 +4,10 @@
# SPDX-License-Identifier: MIT
import time
import board
from micropython import const
from adafruit_seesaw.seesaw import Seesaw
BUTTON_X = const(6)

4
examples/seesaw_neopixel_test.py
View file

@ -11,9 +11,11 @@
# https://learn.adafruit.com/adafruit-attiny817-seesaw/neopixel
import time
import board
from rainbowio import colorwheel
from adafruit_seesaw import seesaw, neopixel
from adafruit_seesaw import neopixel, seesaw
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller

6
examples/seesaw_pc_joystick.py
View file

@ -3,8 +3,10 @@
# SPDX-License-Identifier: MIT
import time
import board
from micropython import const
from adafruit_seesaw.seesaw import Seesaw
BUTTON_1 = const(3)
@ -17,9 +19,7 @@ JOY1_Y = const(15)
JOY2_X = const(0)
JOY2_Y = const(16)
button_mask = const(
(1 << BUTTON_1) | (1 << BUTTON_2) | (1 << BUTTON_3) | (1 << BUTTON_4)
)
button_mask = const((1 << BUTTON_1) | (1 << BUTTON_2) | (1 << BUTTON_3) | (1 << BUTTON_4))
i2c_bus = board.STEMMA_I2C() # The built-in STEMMA QT connector on the microcontroller
# i2c_bus = board.I2C() # Uses board.SCL and board.SDA. Use with breadboard.

6
examples/seesaw_pwmout_test.py
View file

@ -12,8 +12,10 @@
# https://learn.adafruit.com/adafruit-attiny817-seesaw/pwmout
import time
import board
from adafruit_seesaw import seesaw, pwmout
from adafruit_seesaw import pwmout, seesaw
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller
@ -26,7 +28,7 @@ delay = 0.01
while True:
# The API PWM range is 0 to 65535, but we increment by 256 since our
# resolution is often only 8 bits underneath
for cycle in range(0, 65535, 256): #
for cycle in range(0, 65535, 256):
led.duty_cycle = cycle
time.sleep(delay)
for cycle in range(65534, 0, -256):

12
examples/seesaw_quadrotary.py
View file

@ -2,13 +2,15 @@
# SPDX-License-Identifier: MIT
"""Quad I2C rotary encoder NeoPixel color picker example."""
import board
from rainbowio import colorwheel
import digitalio
import adafruit_seesaw.seesaw
from rainbowio import colorwheel
import adafruit_seesaw.digitalio
import adafruit_seesaw.neopixel
import adafruit_seesaw.rotaryio
import adafruit_seesaw.digitalio
import adafruit_seesaw.seesaw
# For boards/chips that don't handle clock-stretching well, try running I2C at 50KHz
# import busio
@ -36,9 +38,7 @@ while True:
for n, rotary_pos in enumerate(positions):
if rotary_pos != last_positions[n]:
if switches[n].value: # Change the LED color if switch is not pressed
if (
rotary_pos > last_positions[n]
): # Advance forward through the colorwheel.
if rotary_pos > last_positions[n]: # Advance forward through the colorwheel.
colors[n] += 8
else:
colors[n] -= 8 # Advance backward through the colorwheel.

7
examples/seesaw_rotary_multiples.py
View file

@ -5,7 +5,8 @@
# solder the A0 jumper on the second QT Rotary Encoder board
import board
from adafruit_seesaw import seesaw, rotaryio, digitalio, neopixel
from adafruit_seesaw import digitalio, neopixel, rotaryio, seesaw
i2c = board.I2C() # uses board.SCL and board.SDA
# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller
@ -43,7 +44,7 @@ while True:
if position1 != last_position1:
last_position1 = position1
print("Position 1: {}".format(position1))
print(f"Position 1: {position1}")
if not button1.value and not button_held1:
button_held1 = True
@ -57,7 +58,7 @@ while True:
if position2 != last_position2:
last_position2 = position2
print("Position 2: {}".format(position2))
print(f"Position 2: {position2}")
if not button2.value and not button_held2:
button_held2 = True

7
examples/seesaw_rotary_neopixel.py
View file

@ -2,10 +2,11 @@
# SPDX-License-Identifier: MIT
"""I2C rotary encoder NeoPixel color picker and brightness setting example."""
import board
from rainbowio import colorwheel
from adafruit_seesaw import seesaw, neopixel, rotaryio, digitalio
from adafruit_seesaw import digitalio, neopixel, rotaryio, seesaw
# For use with the STEMMA connector on QT Py RP2040
# import busio
@ -42,9 +43,7 @@ while True:
color = (color + 256) % 256 # wrap around to 0-256
pixel.fill(colorwheel(color))
else: # If the button is pressed...
# ...change the brightness.
if position > last_position: # Increase the brightness.
elif position > last_position: # Increase the brightness.
pixel.brightness = min(1.0, pixel.brightness + 0.1)
else: # Decrease the brightness.
pixel.brightness = max(0, pixel.brightness - 0.1)

7
examples/seesaw_rotary_simpletest.py
View file

@ -4,7 +4,8 @@
"""I2C rotary encoder simple test example."""
import board
from adafruit_seesaw import seesaw, rotaryio, digitalio
from adafruit_seesaw import digitalio, rotaryio, seesaw
# For use with the STEMMA connector on QT Py RP2040
# import busio
@ -16,7 +17,7 @@ i2c = board.I2C() # uses board.SCL and board.SDA
seesaw = seesaw.Seesaw(i2c, addr=0x36)
seesaw_product = (seesaw.get_version() >> 16) & 0xFFFF
print("Found product {}".format(seesaw_product))
print(f"Found product {seesaw_product}")
if seesaw_product != 4991:
print("Wrong firmware loaded? Expected 4991")
@ -36,7 +37,7 @@ while True:
if position != last_position:
last_position = position
print("Position: {}".format(position))
print(f"Position: {position}")
if not button.value and not button_held:
button_held = True

1
examples/seesaw_simpletest.py
View file

@ -8,6 +8,7 @@
import time
import board
from adafruit_seesaw.seesaw import Seesaw
i2c_bus = board.I2C() # uses board.SCL and board.SDA

105
ruff.toml Normal file
View file

@ -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"