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..f27b786 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,22 @@ # SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers # # 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/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: diff --git a/README.rst b/README.rst index 67ff2e3..432e05f 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ICM20X/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 Library for the ST ICM-20X Wide-Range 6-DoF Accelerometer and Gyro Family diff --git a/adafruit_icm20x.py b/adafruit_icm20x.py index 61bdb8f..3c07bf6 100644 --- a/adafruit_icm20x.py +++ b/adafruit_icm20x.py @@ -32,11 +32,18 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ICM20X.git" # Common imports; remove if unused or pylint will complain from time import sleep -from adafruit_bus_device import i2c_device -from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct, Struct -from adafruit_register.i2c_bit import RWBit, ROBit +from adafruit_bus_device import i2c_device +from adafruit_register.i2c_bit import ROBit, RWBit from adafruit_register.i2c_bits import RWBits +from adafruit_register.i2c_struct import ROUnaryStruct, Struct, UnaryStruct + +try: + from typing import Iterable, List, Optional, Tuple, Union + + from busio import I2C +except ImportError: + pass _ICM20649_DEFAULT_ADDRESS = 0x68 # icm20649 default i2c address _ICM20948_DEFAULT_ADDRESS = 0x69 # icm20649 default i2c address @@ -60,6 +67,11 @@ _ICM20X_REG_INT_ENABLE_0 = 0x10 # Interrupt enable register 0 _ICM20X_REG_INT_ENABLE_1 = 0x11 # Interrupt enable register 1 +_ICM20X_REG_INT_STATUS_0 = 0x19 # Interrupt status register 0 Wake on motion, DMP int, i2c int +_ICM20X_REG_INT_STATUS_1 = 0x1A # Interrupt status register 1 data register from all sensors +_ICM20X_REG_INT_STATUS_2 = 0x1B # Interrupt status register 2 FIFO overflow +_ICM20X_REG_INT_STATUS_3 = 0x1C # Interrupt status register 3 Watermark interrupt + # Bank 2 _ICM20X_GYRO_SMPLRT_DIV = 0x00 _ICM20X_GYRO_CONFIG_1 = 0x01 @@ -79,9 +91,7 @@ _ICM20X_I2C_SLV0_DO = 0x6 # Sets I2C microcontroller bus sensor 0 data out _ICM20X_I2C_SLV4_ADDR = 0x13 # Sets I2C address for I2C microcontroller bus sensor 4 -_ICM20X_I2C_SLV4_REG = ( - 0x14 # Sets register address for I2C microcontroller bus sensor 4 -) +_ICM20X_I2C_SLV4_REG = 0x14 # Sets register address for I2C microcontroller bus sensor 4 _ICM20X_I2C_SLV4_CTRL = 0x15 # Controls for I2C microcontroller bus sensor 4 _ICM20X_I2C_SLV4_DO = 0x16 # Sets I2C microcontroller bus sensor 4 data out _ICM20X_I2C_SLV4_DI = 0x17 # Sets I2C microcontroller bus sensor 4 data in @@ -96,7 +106,7 @@ class CV: """struct helper""" @classmethod - def add_values(cls, value_tuples): + def add_values(cls, value_tuples: Iterable[Tuple]) -> None: """Add CV values to the class""" cls.string = {} cls.lsb = {} @@ -108,7 +118,9 @@ def add_values(cls, value_tuples): cls.lsb[value] = lsb @classmethod - def is_valid(cls, value): + def is_valid( + cls, value: Union["AccelRange", "GyroRange", "GyroDLPFFreq", "AccelDLPFFreq"] + ) -> bool: """Validate that a given value is a member""" return value in cls.string @@ -159,6 +171,8 @@ class ICM20X: # pylint:disable=too-many-instance-attributes _lp_config_reg = UnaryStruct(_ICM20X_LP_CONFIG, ">B") + _data_ready = ROBit(_ICM20X_REG_INT_STATUS_1, 0) + _i2c_master_cycle_en = RWBit(_ICM20X_LP_CONFIG, 6) _accel_cycle_en = RWBit(_ICM20X_LP_CONFIG, 5) _gyro_cycle_en = RWBit(_ICM20X_LP_CONFIG, 4) @@ -212,14 +226,14 @@ class ICM20X: # pylint:disable=too-many-instance-attributes ) @property - def _bank(self): + def _bank(self) -> int: return self._bank_reg >> 4 @_bank.setter - def _bank(self, value): + def _bank(self, value: int) -> None: self._bank_reg = value << 4 - def __init__(self, i2c_bus, address): + def __init__(self, i2c_bus: I2C, address: int) -> None: self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) self._bank = 0 if not self._device_id in [_ICM20649_DEVICE_ID, _ICM20948_DEVICE_ID]: @@ -227,7 +241,7 @@ def __init__(self, i2c_bus, address): self.reset() self.initialize() - def initialize(self): + def initialize(self) -> None: """Configure the sensors with the default settings. For use after calling :meth:`reset`""" self._sleep = False @@ -237,7 +251,9 @@ def initialize(self): self.accelerometer_data_rate_divisor = 20 # ~53.57Hz self.gyro_data_rate_divisor = 10 # ~100Hz - def reset(self): + self._gravity = G_TO_ACCEL + + def reset(self) -> None: """Resets the internal registers and restores the default settings""" self._bank = 0 @@ -247,26 +263,30 @@ def reset(self): while self._reset: sleep(0.005) + def data_ready(self) -> None: + """Checks if new data is available""" + self._bank = 0 + return self._data_ready + @property - def _sleep(self): + def _sleep(self) -> None: self._bank = 0 sleep(0.005) self._sleep_reg = False sleep(0.005) @_sleep.setter - def _sleep(self, sleep_enabled): + def _sleep(self, sleep_enabled: bool) -> None: self._bank = 0 sleep(0.005) self._sleep_reg = sleep_enabled sleep(0.005) @property - def acceleration(self): + def acceleration(self) -> Tuple[float, float, float]: """The x, y, z acceleration values returned in a 3-tuple and are in :math:`m / s ^ 2.`""" self._bank = 0 raw_accel_data = self._raw_accel_data - sleep(0.005) x = self._scale_xl_data(raw_accel_data[0]) y = self._scale_xl_data(raw_accel_data[1]) @@ -275,9 +295,9 @@ def acceleration(self): return (x, y, z) @property - def gyro(self): + def gyro(self) -> Tuple[float, float, float]: """The x, y, z angular velocity values returned in a 3-tuple and - are in :math:`degrees / second`""" + are in :math:`radians / second`""" self._bank = 0 raw_gyro_data = self._raw_gyro_data x = self._scale_gyro_data(raw_gyro_data[0]) @@ -286,23 +306,20 @@ def gyro(self): return (x, y, z) - def _scale_xl_data(self, raw_measurement): - sleep(0.005) - return raw_measurement / AccelRange.lsb[self._cached_accel_range] * G_TO_ACCEL + def _scale_xl_data(self, raw_measurement: float) -> float: + return raw_measurement / AccelRange.lsb[self._cached_accel_range] * self._gravity - def _scale_gyro_data(self, raw_measurement): - return ( - raw_measurement / GyroRange.lsb[self._cached_gyro_range] - ) * _ICM20X_RAD_PER_DEG + def _scale_gyro_data(self, raw_measurement: float) -> float: + return (raw_measurement / GyroRange.lsb[self._cached_gyro_range]) * _ICM20X_RAD_PER_DEG @property - def accelerometer_range(self): + def accelerometer_range(self) -> AccelRange: """Adjusts the range of values that the sensor can measure, from +/- 4G to +/-30G Note that larger ranges will be less accurate. Must be an `AccelRange`""" return self._cached_accel_range @accelerometer_range.setter - def accelerometer_range(self, value): # pylint: disable=no-member + def accelerometer_range(self, value: AccelRange) -> None: # pylint: disable=no-member if not AccelRange.is_valid(value): raise AttributeError("range must be an `AccelRange`") self._bank = 2 @@ -313,14 +330,14 @@ def accelerometer_range(self, value): # pylint: disable=no-member self._bank = 0 @property - def gyro_range(self): + def gyro_range(self) -> GyroRange: """Adjusts the range of values that the sensor can measure, from 500 Degrees/second to 4000 degrees/s. Note that larger ranges will be less accurate. Must be a `GyroRange` """ return self._cached_gyro_range @gyro_range.setter - def gyro_range(self, value): + def gyro_range(self, value: GyroRange) -> None: if not GyroRange.is_valid(value): raise AttributeError("range must be a `GyroRange`") @@ -333,7 +350,7 @@ def gyro_range(self, value): sleep(0.100) # needed to let new range settle @property - def accelerometer_data_rate_divisor(self): + def accelerometer_data_rate_divisor(self) -> int: """ The divisor for the rate at which accelerometer measurements are taken in Hz @@ -356,7 +373,7 @@ def accelerometer_data_rate_divisor(self): return raw_rate_divisor @accelerometer_data_rate_divisor.setter - def accelerometer_data_rate_divisor(self, value): + def accelerometer_data_rate_divisor(self, value: int) -> None: # check that value <= 4095 self._bank = 2 sleep(0.005) @@ -364,7 +381,7 @@ def accelerometer_data_rate_divisor(self, value): sleep(0.005) @property - def gyro_data_rate_divisor(self): + def gyro_data_rate_divisor(self) -> int: """ The divisor for the rate at which gyro measurements are taken in Hz @@ -387,21 +404,21 @@ def gyro_data_rate_divisor(self): return raw_rate_divisor @gyro_data_rate_divisor.setter - def gyro_data_rate_divisor(self, value): + def gyro_data_rate_divisor(self, value: int) -> None: # check that value <= 255 self._bank = 2 sleep(0.005) self._gyro_rate_divisor = value sleep(0.005) - def _accel_rate_calc(self, divisor): # pylint:disable=no-self-use + def _accel_rate_calc(self, divisor: int) -> float: # pylint:disable=no-self-use return 1125 / (1 + divisor) - def _gyro_rate_calc(self, divisor): # pylint:disable=no-self-use + def _gyro_rate_calc(self, divisor: int) -> float: # pylint:disable=no-self-use return 1100 / (1 + divisor) @property - def accelerometer_data_rate(self): + def accelerometer_data_rate(self) -> float: """The rate at which accelerometer measurements are taken in Hz .. note:: @@ -419,15 +436,14 @@ def accelerometer_data_rate(self): return self._accel_rate_calc(self.accelerometer_data_rate_divisor) @accelerometer_data_rate.setter - def accelerometer_data_rate(self, value): + def accelerometer_data_rate(self, value: int) -> None: if value < self._accel_rate_calc(4095) or value > self._accel_rate_calc(0): - raise AttributeError( - "Accelerometer data rate must be between 0.27 and 1125.0" - ) - self.accelerometer_data_rate_divisor = value + raise AttributeError("Accelerometer data rate must be between 0.27 and 1125.0") + divisor = round((1125.0 - value) / value) + self.accelerometer_data_rate_divisor = divisor @property - def gyro_data_rate(self): + def gyro_data_rate(self) -> float: """The rate at which gyro measurements are taken in Hz .. note:: @@ -444,15 +460,14 @@ def gyro_data_rate(self): return self._gyro_rate_calc(self.gyro_data_rate_divisor) @gyro_data_rate.setter - def gyro_data_rate(self, value): + def gyro_data_rate(self, value: int) -> None: if value < self._gyro_rate_calc(4095) or value > self._gyro_rate_calc(0): raise AttributeError("Gyro data rate must be between 4.30 and 1100.0") - - divisor = round(((1125.0 - value) / value)) + divisor = round((1100.0 - value) / value) self.gyro_data_rate_divisor = divisor @property - def accel_dlpf_cutoff(self): + def accel_dlpf_cutoff(self) -> AccelDLPFFreq: """The cutoff frequency for the accelerometer's digital low pass filter. Signals above the given frequency will be filtered out. Must be an ``AccelDLPFCutoff``. Use AccelDLPFCutoff.DISABLED to disable the filter @@ -466,7 +481,7 @@ def accel_dlpf_cutoff(self): return self._accel_dlpf_config @accel_dlpf_cutoff.setter - def accel_dlpf_cutoff(self, cutoff_frequency): + def accel_dlpf_cutoff(self, cutoff_frequency: AccelDLPFFreq) -> None: if not AccelDLPFFreq.is_valid(cutoff_frequency): raise AttributeError("accel_dlpf_cutoff must be an `AccelDLPFFreq`") self._bank = 2 @@ -478,7 +493,7 @@ def accel_dlpf_cutoff(self, cutoff_frequency): self._accel_dlpf_config = cutoff_frequency @property - def gyro_dlpf_cutoff(self): + def gyro_dlpf_cutoff(self) -> GyroDLPFFreq: """The cutoff frequency for the gyro's digital low pass filter. Signals above the given frequency will be filtered out. Must be a ``GyroDLPFFreq``. Use GyroDLPFCutoff.DISABLED to disable the filter @@ -492,7 +507,7 @@ def gyro_dlpf_cutoff(self): return self._gyro_dlpf_config @gyro_dlpf_cutoff.setter - def gyro_dlpf_cutoff(self, cutoff_frequency): + def gyro_dlpf_cutoff(self, cutoff_frequency: GyroDLPFFreq) -> None: if not GyroDLPFFreq.is_valid(cutoff_frequency): raise AttributeError("gyro_dlpf_cutoff must be a `GyroDLPFFreq`") self._bank = 2 @@ -504,15 +519,24 @@ def gyro_dlpf_cutoff(self, cutoff_frequency): self._gyro_dlpf_config = cutoff_frequency @property - def _low_power(self): + def _low_power(self) -> bool: self._bank = 0 return self._low_power_en @_low_power.setter - def _low_power(self, enabled): + def _low_power(self, enabled: bool) -> None: self._bank = 0 self._low_power_en = enabled + @property + def gravity(self) -> float: + """The gravity magnitude in m/s^2.""" + return self._gravity + + @gravity.setter + def gravity(self, value: float) -> None: + self._gravity = value + class ICM20649(ICM20X): """Library for the ST ICM-20649 Wide-Range 6-DoF Accelerometer and Gyro. @@ -530,7 +554,7 @@ class ICM20649(ICM20X): import board import adafruit_icm20x - Once this is done you can define your `board.I2C` object and define your sensor object + Once this is done you can define your ``board.I2C`` object and define your sensor object .. code-block:: python @@ -547,7 +571,7 @@ class ICM20649(ICM20X): """ - def __init__(self, i2c_bus, address=_ICM20649_DEFAULT_ADDRESS): + def __init__(self, i2c_bus: I2C, address: int = _ICM20649_DEFAULT_ADDRESS): AccelRange.add_values( ( ("RANGE_4G", 0, 4, 8192), @@ -605,7 +629,7 @@ class ICM20948(ICM20X): # pylint:disable=too-many-instance-attributes import board import adafruit_icm20x - Once this is done you can define your `board.I2C` object and define your sensor object + Once this is done you can define your ``board.I2C`` object and define your sensor object .. code-block:: python @@ -646,7 +670,7 @@ class ICM20948(ICM20X): # pylint:disable=too-many-instance-attributes _slave4_do = UnaryStruct(_ICM20X_I2C_SLV4_DO, ">B") _slave4_di = UnaryStruct(_ICM20X_I2C_SLV4_DI, ">B") - def __init__(self, i2c_bus, address=_ICM20948_DEFAULT_ADDRESS): + def __init__(self, i2c_bus: I2C, address: int = _ICM20948_DEFAULT_ADDRESS): AccelRange.add_values( ( ("RANGE_2G", 0, 2, 16384), @@ -682,7 +706,7 @@ def __init__(self, i2c_bus, address=_ICM20948_DEFAULT_ADDRESS): # See their Python library here: # https://github.com/sparkfun/Qwiic_9DoF_IMU_ICM20948_Py @property - def _mag_configured(self): + def _mag_configured(self) -> bool: success = False for _i in range(5): success = self._mag_id() is not None @@ -693,11 +717,11 @@ def _mag_configured(self): # i2c microcontroller stuck, try resetting return False - def _reset_i2c_master(self): + def _reset_i2c_master(self) -> None: self._bank = 0 self._i2c_master_reset = True - def _magnetometer_enable(self): + def _magnetometer_enable(self) -> None: self._bank = 0 sleep(0.100) self._bypass_i2c_master = False @@ -714,7 +738,7 @@ def _magnetometer_enable(self): self._i2c_master_enable = True sleep(0.020) - def _magnetometer_init(self): + def _magnetometer_init(self) -> bool: self._magnetometer_enable() self.magnetometer_data_rate = ( MagDataRate.RATE_100HZ # pylint: disable=no-member @@ -728,7 +752,7 @@ def _magnetometer_init(self): return True # set up slave0 for reading into the bank 0 data registers - def _setup_mag_readout(self): + def _setup_mag_readout(self) -> None: self._bank = 3 self._slave0_addr = 0x8C sleep(0.005) @@ -737,16 +761,15 @@ def _setup_mag_readout(self): self._slave0_ctrl = 0x89 # enable sleep(0.005) - def _mag_id(self): + def _mag_id(self) -> int: return self._read_mag_register(0x01) @property - def magnetic(self): - """The current magnetic field strengths onthe X, Y, and Z axes in uT (micro-teslas)""" + def magnetic(self) -> Tuple[float, float, float]: + """The current magnetic field strengths on the X, Y, and Z axes in uT (micro-teslas)""" self._bank = 0 full_data = self._raw_mag_data - sleep(0.005) x = full_data[0] * _ICM20X_UT_PER_LSB y = full_data[1] * _ICM20X_UT_PER_LSB @@ -755,13 +778,13 @@ def magnetic(self): return (x, y, z) @property - def magnetometer_data_rate(self): + def magnetometer_data_rate(self) -> MagDataRate: """The rate at which the magnetometer takes measurements to update its output registers""" # read mag DR register self._read_mag_register(_AK09916_CNTL2) @magnetometer_data_rate.setter - def magnetometer_data_rate(self, mag_rate): + def magnetometer_data_rate(self, mag_rate: MagDataRate) -> None: # From https://www.y-ic.es/datasheet/78/SMDSW.020-2OZ.pdf page 9 # "When user wants to change operation mode, transit to Power-down mode first and then @@ -770,12 +793,13 @@ def magnetometer_data_rate(self, mag_rate): if not MagDataRate.is_valid(mag_rate): raise AttributeError("range must be an `MagDataRate`") self._write_mag_register( - _AK09916_CNTL2, MagDataRate.SHUTDOWN # pylint: disable=no-member + _AK09916_CNTL2, + MagDataRate.SHUTDOWN, # pylint: disable=no-member ) sleep(0.001) self._write_mag_register(_AK09916_CNTL2, mag_rate) - def _read_mag_register(self, register_addr, slave_addr=0x0C): + def _read_mag_register(self, register_addr: int, slave_addr: int = 0x0C) -> Optional[int]: self._bank = 3 slave_addr |= 0x80 # set top bit for read @@ -784,9 +808,7 @@ def _read_mag_register(self, register_addr, slave_addr=0x0C): sleep(0.005) self._slave4_reg = register_addr sleep(0.005) - self._slave4_ctrl = ( - 0x80 # enable, don't raise interrupt, write register value, no delay - ) + self._slave4_ctrl = 0x80 # enable, don't raise interrupt, write register value, no delay sleep(0.005) self._bank = 0 @@ -805,7 +827,7 @@ def _read_mag_register(self, register_addr, slave_addr=0x0C): sleep(0.005) return mag_register_data - def _write_mag_register(self, register_addr, value, slave_addr=0x0C): + def _write_mag_register(self, register_addr: int, value: int, slave_addr: int = 0x0C): self._bank = 3 self._slave4_addr = slave_addr @@ -814,9 +836,7 @@ def _write_mag_register(self, register_addr, value, slave_addr=0x0C): sleep(0.005) self._slave4_do = value sleep(0.005) - self._slave4_ctrl = ( - 0x80 # enable, don't raise interrupt, write register value, no delay - ) + self._slave4_ctrl = 0x80 # enable, don't raise interrupt, write register value, no delay sleep(0.005) self._bank = 0 diff --git a/docs/conf.py b/docs/conf.py index 34e42ef..b614ddb 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("..")) @@ -56,9 +54,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 + " Bryan Siepert" author = "Bryan Siepert" @@ -112,7 +108,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/examples.rst b/docs/examples.rst index 6bf07fe..b809298 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -16,6 +16,15 @@ Test using all the ICM20649 sensor capabilities :caption: examples/examples/icm20x_icm20649_full_test.py :linenos: +ICM20649 data rate test +----------------------- + +Test using all the ICM20649 sensor capabilities + +.. literalinclude:: ../examples/icm20x_icm20649_data_rate_test.py + :caption: examples/examples/icm20x_icm20649_data_rate_test.py + :linenos: + ICM20948 Simple test -------------------- @@ -51,3 +60,12 @@ Example showing ICM20948 sensor cycling between two magnetic data rates .. literalinclude:: ../examples/icm20x_icm20948_mag_data_rate_test.py :caption: examples/icm20x_icm20948_mag_data_rate_test.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/icm20x_icm20948_displayio_simpletest.py + :caption: examples/icm20x_icm20948_displayio_simpletest.py + :linenos: diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/icm20x_icm20649_data_rate_test.py b/examples/icm20x_icm20649_data_rate_test.py new file mode 100644 index 0000000..aeaef24 --- /dev/null +++ b/examples/icm20x_icm20649_data_rate_test.py @@ -0,0 +1,39 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +import time + +import board + +from adafruit_icm20x import ICM20649, AccelRange, GyroRange + +i2c = board.I2C() # uses board.SCL and board.SDA + +ism = ICM20649(i2c, address=0x69) + +ism.accelerometer_range = AccelRange.RANGE_4G +print("Accelerometer range set to: %d g" % AccelRange.string[ism.accelerometer_range]) + +ism.gyro_range = GyroRange.RANGE_500_DPS +print("Gyro range set to: %d DPS" % GyroRange.string[ism.gyro_range]) + +ism.gyro_data_rate = 1100 # 1100 max +ism.accelerometer_data_rate = 1125 # 1125 max + +print(f"Gyro rate: {ism.gyro_data_rate:f}") +print(f"Accel rate: {ism.accelerometer_data_rate:f}") + +ism.gravity = 9.8 + +previousTime = time.monotonic_ns() +while True: + if ism.data_ready: + currentTime = time.monotonic_ns() + print("\033[2J") + print( + "Accel X:{:5.2f} Y:{:5.2f} Z:{:5.2f} ms^2 " + "Gyro X:{:8.3f} Y:{:8.3f} Z:{:8.3f} degrees/s Sample Rate: {:8.1f} Hz".format( + *ism.acceleration, *ism.gyro, (1 / (currentTime - previousTime)) + ) + ) + previousTime = currentTime diff --git a/examples/icm20x_icm20649_full_test.py b/examples/icm20x_icm20649_full_test.py index 60f4392..d693805 100644 --- a/examples/icm20x_icm20649_full_test.py +++ b/examples/icm20x_icm20649_full_test.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + from adafruit_icm20x import ICM20649, AccelRange, GyroRange @@ -17,7 +19,7 @@ def printNewMax(value, current_max, axis): i2c = board.I2C() # uses board.SCL and board.SDA # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller -ism = ICM20649(i2c) +ism = ICM20649(i2c, address=0x69) ism.accelerometer_range = AccelRange.RANGE_30G print("Accelerometer range set to: %d g" % AccelRange.string[ism.accelerometer_range]) @@ -28,8 +30,8 @@ def printNewMax(value, current_max, axis): ax_max = ay_max = az_max = 0 gx_max = gy_max = gz_max = 0 -ism.gyro_data_rate = 125 -ism.accelerometer_data_rate = 4095 +ism.gyro_data_rate = 1100 +ism.accelerometer_data_rate = 1125 st = time.monotonic() while time.monotonic() - st < 0.250: print( diff --git a/examples/icm20x_icm20649_simpletest.py b/examples/icm20x_icm20649_simpletest.py index b3582ad..9806348 100644 --- a/examples/icm20x_icm20649_simpletest.py +++ b/examples/icm20x_icm20649_simpletest.py @@ -2,15 +2,17 @@ # SPDX-License-Identifier: MIT import time + import board + import adafruit_icm20x i2c = board.I2C() # uses board.SCL and board.SDA # i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller -icm = adafruit_icm20x.ICM20649(i2c) +icm = adafruit_icm20x.ICM20649(i2c, address=0x69) while True: - print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (icm.acceleration)) - print("Gyro X:%.2f, Y: %.2f, Z: %.2f rads/s" % (icm.gyro)) + print("Acceleration: X:{:.2f}, Y: {:.2f}, Z: {:.2f} m/s^2".format(*icm.acceleration)) + print("Gyro X:{:.2f}, Y: {:.2f}, Z: {:.2f} rads/s".format(*icm.gyro)) print("") time.sleep(0.5) diff --git a/examples/icm20x_icm20948_accel_data_rate_test.py b/examples/icm20x_icm20948_accel_data_rate_test.py index a68910d..d666f27 100644 --- a/examples/icm20x_icm20948_accel_data_rate_test.py +++ b/examples/icm20x_icm20948_accel_data_rate_test.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + from adafruit_icm20x import ICM20948 cycles = 200 diff --git a/examples/icm20x_icm20948_displayio_simpletest.py b/examples/icm20x_icm20948_displayio_simpletest.py new file mode 100644 index 0000000..2e05eb5 --- /dev/null +++ b/examples/icm20x_icm20948_displayio_simpletest.py @@ -0,0 +1,50 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# SPDX-FileCopyrightText: 2024 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time + +import board +from adafruit_display_text.bitmap_label import Label +from displayio import Group +from terminalio import FONT + +import adafruit_icm20x + +# Simple demo of using the built-in display. +# create a main_group to hold anything we want to show on the display. +main_group = Group() +# Initialize I2C bus and sensor. +i2c = board.I2C() # uses board.SCL and board.SDA +icm = adafruit_icm20x.ICM20948(i2c) + +# Create Label(s) to show the readings. If you have a very small +# display you may need to change to scale=1. +display_output_label = Label(FONT, text="", scale=2) + +# place the label(s) in the middle of the screen with anchored positioning +display_output_label.anchor_point = (0, 0) +display_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 60, +) + +# add the label(s) to the main_group +main_group.append(display_output_label) + +# set the main_group as the root_group of the built-in DISPLAY +board.DISPLAY.root_group = main_group + +# begin main loop +while True: + # update the text of the label(s) to show the sensor readings + acc_x, acc_y, acc_z = icm.acceleration + display_output_label.text = ( + f"Acceleration\n" + + f"x: {acc_x:.1f} m/s^2\n" + + f"y: {acc_y:.1f} m/s^2\n" + + f"z: {acc_z:.1f} m/s^2" + ) + # wait for a bit + time.sleep(0.5) diff --git a/examples/icm20x_icm20948_gyro_data_rate_test.py b/examples/icm20x_icm20948_gyro_data_rate_test.py index e521941..26ad366 100644 --- a/examples/icm20x_icm20948_gyro_data_rate_test.py +++ b/examples/icm20x_icm20948_gyro_data_rate_test.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + from adafruit_icm20x import ICM20948 cycles = 200 diff --git a/examples/icm20x_icm20948_mag_data_rate_test.py b/examples/icm20x_icm20948_mag_data_rate_test.py index ee867d6..db54691 100644 --- a/examples/icm20x_icm20948_mag_data_rate_test.py +++ b/examples/icm20x_icm20948_mag_data_rate_test.py @@ -3,8 +3,10 @@ # pylint: disable=no-member import time + import board -from adafruit_icm20x import MagDataRate, ICM20948 + +from adafruit_icm20x import ICM20948, MagDataRate cycles = 200 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/icm20x_icm20948_simpletest.py b/examples/icm20x_icm20948_simpletest.py index 06d2ac7..8322dd5 100644 --- a/examples/icm20x_icm20948_simpletest.py +++ b/examples/icm20x_icm20948_simpletest.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + import adafruit_icm20x i2c = board.I2C() # uses board.SCL and board.SDA @@ -10,8 +12,8 @@ icm = adafruit_icm20x.ICM20948(i2c) while True: - print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (icm.acceleration)) - print("Gyro X:%.2f, Y: %.2f, Z: %.2f rads/s" % (icm.gyro)) - print("Magnetometer X:%.2f, Y: %.2f, Z: %.2f uT" % (icm.magnetic)) + print("Acceleration: X:{:.2f}, Y: {:.2f}, Z: {:.2f} m/s^2".format(*icm.acceleration)) + print("Gyro X:{:.2f}, Y: {:.2f}, Z: {:.2f} rads/s".format(*icm.gyro)) + print("Magnetometer X:{:.2f}, Y: {:.2f}, Z: {:.2f} uT".format(*icm.magnetic)) print("") time.sleep(0.5) diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..db37c83 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,99 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +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 + +] + +[format] +line-ending = "lf"