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 df12bcd..0d0ef6e 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_SGP40/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 library for the Adafruit SGP40 Air Quality Sensor / VOC Index Sensor Breakouts diff --git a/adafruit_sgp40/__init__.py b/adafruit_sgp40/__init__.py index 70f298e..0360353 100644 --- a/adafruit_sgp40/__init__.py +++ b/adafruit_sgp40/__init__.py @@ -29,14 +29,17 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ -from time import sleep + from struct import unpack_from +from time import sleep + from adafruit_bus_device import i2c_device try: from typing import List, Optional - from circuitpython_typing import ReadableBuffer + from busio import I2C + from circuitpython_typing import ReadableBuffer except ImportError: pass @@ -47,7 +50,7 @@ # no point in generating this each time # Generated from temp 25c, humidity 50% -_READ_CMD = b"\x26\x0F\x80\x00\xA2\x66\x66\x93" +_READ_CMD = b"\x26\x0f\x80\x00\xa2\x66\x66\x93" class SGP40: @@ -231,9 +234,7 @@ def measure_raw(self, temperature: float = 25, relative_humidity: float = 50): self._measure_command = bytearray(_cmd) return self.raw - def measure_index( - self, temperature: float = 25, relative_humidity: float = 50 - ) -> int: + def measure_index(self, temperature: float = 25, relative_humidity: float = 50) -> int: """Measure VOC index after humidity compensation :param float temperature: The temperature in degrees Celsius, defaults to :const:`25` :param float relative_humidity: The relative humidity in percentage, defaults to :const:`50` @@ -246,7 +247,6 @@ def measure_index( :return int The VOC index measured, ranged from 0 to 500 """ # import/setup algorithm only on use of index - # pylint: disable=import-outside-toplevel from adafruit_sgp40.voc_algorithm import ( VOCAlgorithm, ) @@ -321,9 +321,7 @@ def _generate_crc(crc_buffer: ReadableBuffer) -> int: crc ^= byte for _ in range(8): if crc & 0x80: - crc = ( - crc << 1 - ) ^ 0x31 # 0x31 is the Seed for SGP40's CRC polynomial + crc = (crc << 1) ^ 0x31 # 0x31 is the Seed for SGP40's CRC polynomial else: crc = crc << 1 return crc & 0xFF # Returns only bottom 8 bits diff --git a/adafruit_sgp40/voc_algorithm.py b/adafruit_sgp40/voc_algorithm.py index 13d26d6..c3ea587 100644 --- a/adafruit_sgp40/voc_algorithm.py +++ b/adafruit_sgp40/voc_algorithm.py @@ -11,6 +11,7 @@ * Author(s): yangfeng """ + from micropython import const try: @@ -54,7 +55,6 @@ class DFRobot_vocalgorithmParams: """Class for voc index algorithm""" - # pylint: disable=all # Complex math conversion from C def __init__(self) -> None: @@ -125,7 +125,7 @@ def _fix16_mul(self, inarg0: float, inarg1: float) -> int: BD = B * D product_hi = AC + (AD_CB >> 16) ad_cb_temp = ((AD_CB) << 16) & 0xFFFFFFFF - product_lo = ((BD + ad_cb_temp)) & 0xFFFFFFFF + product_lo = (BD + ad_cb_temp) & 0xFFFFFFFF if product_lo < BD: product_hi = product_hi + 1 if (product_hi >> 31) != (product_hi >> 15): @@ -241,12 +241,8 @@ def _fix16_exp(self, x: float) -> int: return res def vocalgorithm_init(self) -> None: - self.params.mvoc_index_offset = self._f16( - _VOCALGORITHM_VOC_INDEX_OFFSET_DEFAULT - ) - self.params.mtau_mean_variance_hours = self._f16( - _VOCALGORITHM_TAU_MEAN_VARIANCE_HOURS - ) + self.params.mvoc_index_offset = self._f16(_VOCALGORITHM_VOC_INDEX_OFFSET_DEFAULT) + self.params.mtau_mean_variance_hours = self._f16(_VOCALGORITHM_TAU_MEAN_VARIANCE_HOURS) self.params.mgating_max_duration_minutes = self._f16( _VOCALGORITHM_GATING_MAX_DURATION_MINUTES ) @@ -269,9 +265,7 @@ def _vocalgorithm__init_instances(self) -> None: self._vocalgorithm__mean_variance_estimator__get_mean(), ) self._vocalgorithm__sigmoid_scaled__init() - self._vocalgorithm__sigmoid_scaled__set_parameters( - self.params.mvoc_index_offset - ) + self._vocalgorithm__sigmoid_scaled__set_parameters(self.params.mvoc_index_offset) self._vocalgorithm__adaptive_lowpass__init() self._vocalgorithm__adaptive_lowpass__set_parameters() @@ -298,27 +292,21 @@ def _vocalgorithm_set_tuning_parameters( ) -> None: self.params.mvoc_index_offset = self._fix16_from_int(voc_index_offset) self.params.mtau_mean_variance_hours = self._fix16_from_int(learning_time_hours) - self.params.mgating_max_duration_minutes = self._fix16_from_int( - gating_max_duration_minutes - ) + self.params.mgating_max_duration_minutes = self._fix16_from_int(gating_max_duration_minutes) self.params.msraw_std_initial = self._fix16_from_int(std_initial) self._vocalgorithm__init_instances() def vocalgorithm_process(self, sraw: int) -> int: if self.params.muptime <= self._f16(_VOCALGORITHM_INITIAL_BLACKOUT): - self.params.muptime = self.params.muptime + self._f16( - _VOCALGORITHM_SAMPLING_INTERVAL - ) + self.params.muptime = self.params.muptime + self._f16(_VOCALGORITHM_SAMPLING_INTERVAL) else: if (sraw > 0) and (sraw < 65000): if sraw < 20001: sraw = 20001 elif sraw > 52767: sraw = 52767 - self.params.msraw = self._fix16_from_int((sraw - 20000)) - self.params.mvoc_index = self._vocalgorithm__mox_model__process( - self.params.msraw - ) + self.params.msraw = self._fix16_from_int(sraw - 20000) + self.params.mvoc_index = self._vocalgorithm__mox_model__process(self.params.msraw) self.params.mvoc_index = self._vocalgorithm__sigmoid_scaled__process( self.params.mvoc_index ) @@ -335,7 +323,7 @@ def vocalgorithm_process(self, sraw: int) -> int: self._vocalgorithm__mean_variance_estimator__get_std(), self._vocalgorithm__mean_variance_estimator__get_mean(), ) - voc_index = self._fix16_cast_to_int((self.params.mvoc_index + self._f16(0.5))) + voc_index = self._fix16_cast_to_int(self.params.mvoc_index + self._f16(0.5)) return voc_index def _vocalgorithm__mean_variance_estimator__init(self) -> None: @@ -362,33 +350,18 @@ def _vocalgorithm__mean_variance_estimator__set_parameters( self.params.m_mean_variance_estimator_std = std_initial self.params.m_mean_variance_estimator_gamma = self._fix16_div( self._f16( - ( - _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING - * (_VOCALGORITHM_SAMPLING_INTERVAL / 3600.0) - ) - ), - ( - tau_mean_variance_hours - + self._f16((_VOCALGORITHM_SAMPLING_INTERVAL / 3600.0)) + _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING + * (_VOCALGORITHM_SAMPLING_INTERVAL / 3600.0) ), + (tau_mean_variance_hours + self._f16(_VOCALGORITHM_SAMPLING_INTERVAL / 3600.0)), ) self.params.m_mean_variance_estimator_gamma_initial_mean = self._f16( - ( - ( - _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING - * _VOCALGORITHM_SAMPLING_INTERVAL - ) - / (_VOCALGORITHM_TAU_INITIAL_MEAN + _VOCALGORITHM_SAMPLING_INTERVAL) - ) + (_VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING * _VOCALGORITHM_SAMPLING_INTERVAL) + / (_VOCALGORITHM_TAU_INITIAL_MEAN + _VOCALGORITHM_SAMPLING_INTERVAL) ) self.params.m_mean_variance_estimator_gamma_initial_variance = self._f16( - ( - ( - _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING - * _VOCALGORITHM_SAMPLING_INTERVAL - ) - / (_VOCALGORITHM_TAU_INITIAL_VARIANCE + _VOCALGORITHM_SAMPLING_INTERVAL) - ) + (_VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING * _VOCALGORITHM_SAMPLING_INTERVAL) + / (_VOCALGORITHM_TAU_INITIAL_VARIANCE + _VOCALGORITHM_SAMPLING_INTERVAL) ) self.params.m_mean_variance_estimator_gamma_mean = self._f16(0.0) self.params.m_mean_variance_estimator__gamma_variance = self._f16(0.0) @@ -417,10 +390,7 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( self, voc_index_from_prior: int ) -> None: uptime_limit = self._f16( - ( - _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__FIX16_MAX - - _VOCALGORITHM_SAMPLING_INTERVAL - ) + _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__FIX16_MAX - _VOCALGORITHM_SAMPLING_INTERVAL ) if self.params.m_mean_variance_estimator_uptime_gamma < uptime_limit: self.params.m_mean_variance_estimator_uptime_gamma = ( @@ -439,10 +409,8 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( self._f16(_VOCALGORITHM_INITI_DURATION_MEAN), self._f16(_VOCALGORITHM_INITI_TRANSITION_MEAN), ) - sigmoid_gamma_mean = ( - self._vocalgorithm__mean_variance_estimator___sigmoid__process( - self.params.m_mean_variance_estimator_uptime_gamma - ) + sigmoid_gamma_mean = self._vocalgorithm__mean_variance_estimator___sigmoid__process( + self.params.m_mean_variance_estimator_uptime_gamma ) gamma_mean = self.params.m_mean_variance_estimator_gamma + ( self._fix16_mul( @@ -455,12 +423,7 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( ) gating_threshold_mean = self._f16(_VOCALGORITHM_GATING_THRESHOLD) + ( self._fix16_mul( - self._f16( - ( - _VOCALGORITHM_GATING_THRESHOLD_INITIAL - - _VOCALGORITHM_GATING_THRESHOLD - ) - ), + self._f16(_VOCALGORITHM_GATING_THRESHOLD_INITIAL - _VOCALGORITHM_GATING_THRESHOLD), self._vocalgorithm__mean_variance_estimator___sigmoid__process( self.params.m_mean_variance_estimator_uptime_gating ), @@ -472,10 +435,8 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( self._f16(_VOCALGORITHM_GATING_THRESHOLD_TRANSITION), ) - sigmoid_gating_mean = ( - self._vocalgorithm__mean_variance_estimator___sigmoid__process( - voc_index_from_prior - ) + sigmoid_gating_mean = self._vocalgorithm__mean_variance_estimator___sigmoid__process( + voc_index_from_prior ) self.params.m_mean_variance_estimator_gamma_mean = self._fix16_mul( sigmoid_gating_mean, gamma_mean @@ -487,10 +448,8 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( self._f16(_VOCALGORITHM_INITI_TRANSITION_VARIANCE), ) - sigmoid_gamma_variance = ( - self._vocalgorithm__mean_variance_estimator___sigmoid__process( - self.params.m_mean_variance_estimator_uptime_gamma - ) + sigmoid_gamma_variance = self._vocalgorithm__mean_variance_estimator___sigmoid__process( + self.params.m_mean_variance_estimator_uptime_gamma ) gamma_variance = self.params.m_mean_variance_estimator_gamma + ( @@ -505,12 +464,7 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( gating_threshold_variance = self._f16(_VOCALGORITHM_GATING_THRESHOLD) + ( self._fix16_mul( - self._f16( - ( - _VOCALGORITHM_GATING_THRESHOLD_INITIAL - - _VOCALGORITHM_GATING_THRESHOLD - ) - ), + self._f16(_VOCALGORITHM_GATING_THRESHOLD_INITIAL - _VOCALGORITHM_GATING_THRESHOLD), self._vocalgorithm__mean_variance_estimator___sigmoid__process( self.params.m_mean_variance_estimator_uptime_gating ), @@ -523,10 +477,8 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( self._f16(_VOCALGORITHM_GATING_THRESHOLD_TRANSITION), ) - sigmoid_gating_variance = ( - self._vocalgorithm__mean_variance_estimator___sigmoid__process( - voc_index_from_prior - ) + sigmoid_gating_variance = self._vocalgorithm__mean_variance_estimator___sigmoid__process( + voc_index_from_prior ) self.params.m_mean_variance_estimator__gamma_variance = self._fix16_mul( @@ -537,12 +489,12 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( self.params.m_mean_variance_estimator_gating_duration_minutes + ( self._fix16_mul( - self._f16((_VOCALGORITHM_SAMPLING_INTERVAL / 60.0)), + self._f16(_VOCALGORITHM_SAMPLING_INTERVAL / 60.0), ( ( self._fix16_mul( (self._f16(1.0) - sigmoid_gating_mean), - self._f16((1.0 + _VOCALGORITHM_GATING_MAX_RATIO)), + self._f16(1.0 + _VOCALGORITHM_GATING_MAX_RATIO), ) ) - self._f16(_VOCALGORITHM_GATING_MAX_RATIO) @@ -551,12 +503,8 @@ def _vocalgorithm__mean_variance_estimator___calculate_gamma( ) ) - if self.params.m_mean_variance_estimator_gating_duration_minutes < self._f16( - 0.0 - ): - self.params.m_mean_variance_estimator_gating_duration_minutes = self._f16( - 0.0 - ) + if self.params.m_mean_variance_estimator_gating_duration_minutes < self._f16(0.0): + self.params.m_mean_variance_estimator_gating_duration_minutes = self._f16(0.0) if ( self.params.m_mean_variance_estimator_gating_duration_minutes @@ -582,9 +530,7 @@ def _vocalgorithm__mean_variance_estimator__process( self.params.m_mean_variance_estimator_mean = self._f16(0.0) sraw = sraw - self.params.m_mean_variance_estimator_sraw_offset - self._vocalgorithm__mean_variance_estimator___calculate_gamma( - voc_index_from_prior - ) + self._vocalgorithm__mean_variance_estimator___calculate_gamma(voc_index_from_prior) delta_sgp = self._fix16_div( (sraw - self.params.m_mean_variance_estimator_mean), self._f16(_VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING), @@ -597,65 +543,55 @@ def _vocalgorithm__mean_variance_estimator__process( if c > self._f16(1440.0): additional_scaling = self._f16(4.0) self.params.m_mean_variance_estimator_std = self._fix16_mul( + self._fix16_sqrt( + self._fix16_mul( + additional_scaling, + ( + self._f16(_VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING) + - self.params.m_mean_variance_estimator__gamma_variance + ), + ) + ), self._fix16_sqrt( ( self._fix16_mul( - additional_scaling, + self.params.m_mean_variance_estimator_std, ( - self._f16( - _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING + self._fix16_div( + self.params.m_mean_variance_estimator_std, + ( + self._fix16_mul( + self._f16( + _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING + ), + additional_scaling, + ) + ), ) - - self.params.m_mean_variance_estimator__gamma_variance ), ) ) - ), - self._fix16_sqrt( - ( - ( - self._fix16_mul( - self.params.m_mean_variance_estimator_std, - ( - self._fix16_div( - self.params.m_mean_variance_estimator_std, - ( - self._fix16_mul( - self._f16( - _VOCALGORITHM_MEAN_VARIANCE_ESTIMATOR__GAMMA_SCALING - ), - additional_scaling, - ) - ), - ) - ), - ) - ) - + ( - self._fix16_mul( - ( - self._fix16_div( - ( - self._fix16_mul( - self.params.m_mean_variance_estimator__gamma_variance, - delta_sgp, - ) - ), - additional_scaling, - ) - ), - delta_sgp, - ) + + ( + self._fix16_mul( + ( + self._fix16_div( + ( + self._fix16_mul( + self.params.m_mean_variance_estimator__gamma_variance, + delta_sgp, + ) + ), + additional_scaling, + ) + ), + delta_sgp, ) ) ), ) self.params.m_mean_variance_estimator_mean = ( self.params.m_mean_variance_estimator_mean - + ( - self._fix16_mul( - self.params.m_mean_variance_estimator_gamma_mean, delta_sgp - ) - ) + + (self._fix16_mul(self.params.m_mean_variance_estimator_gamma_mean, delta_sgp)) ) def _vocalgorithm__mean_variance_estimator___sigmoid__init(self) -> None: @@ -670,9 +606,7 @@ def _vocalgorithm__mean_variance_estimator___sigmoid__set_parameters( self.params.m_mean_variance_estimator_sigmoid_k = K self.params.m_mean_variance_estimator_sigmoid_x0 = X0 - def _vocalgorithm__mean_variance_estimator___sigmoid__process( - self, sample: int - ) -> int: + def _vocalgorithm__mean_variance_estimator___sigmoid__process(self, sample: int) -> int: x = self._fix16_mul( self.params.m_mean_variance_estimator_sigmoid_k, (sample - self.params.m_mean_variance_estimator_sigmoid_x0), @@ -690,9 +624,7 @@ def _vocalgorithm__mean_variance_estimator___sigmoid__process( def _vocalgorithm__mox_model__init(self) -> None: self._vocalgorithm__mox_model__set_parameters(self._f16(1.0), self._f16(0.0)) - def _vocalgorithm__mox_model__set_parameters( - self, SRAW_STD: int, SRAW_MEAN: int - ) -> None: + def _vocalgorithm__mox_model__set_parameters(self, SRAW_STD: int, SRAW_MEAN: int) -> None: self.params.m_mox_model_sraw_std = SRAW_STD self.params.m_mox_model_sraw_mean = SRAW_MEAN @@ -701,12 +633,7 @@ def _vocalgorithm__mox_model__process(self, sraw: int) -> int: ( self._fix16_div( (sraw - self.params.m_mox_model_sraw_mean), - ( - -( - self.params.m_mox_model_sraw_std - + self._f16(_VOCALGORITHM_SRAW_STD_BONUS) - ) - ), + (-(self.params.m_mox_model_sraw_std + self._f16(_VOCALGORITHM_SRAW_STD_BONUS))), ) ), self._f16(_VOCALGORITHM_VOC_INDEX_GAIN), @@ -727,56 +654,47 @@ def _vocalgorithm__sigmoid_scaled__process(self, sample: int) -> int: return self._f16(_VOCALGORITHM_SIGMOID_L) elif x > self._f16(50.0): return self._f16(0.0) - else: - if sample >= self._f16(0.0): - shift = self._fix16_div( - ( - self._f16(_VOCALGORITHM_SIGMOID_L) - - ( - self._fix16_mul( - self._f16(5.0), self.params.m_sigmoid_scaled_offset - ) - ) - ), - self._f16(4.0), + elif sample >= self._f16(0.0): + shift = self._fix16_div( + ( + self._f16(_VOCALGORITHM_SIGMOID_L) + - (self._fix16_mul(self._f16(5.0), self.params.m_sigmoid_scaled_offset)) + ), + self._f16(4.0), + ) + return ( + self._fix16_div( + (self._f16(_VOCALGORITHM_SIGMOID_L) + shift), + (self._f16(1.0) + self._fix16_exp(x)), ) - return ( + ) - shift + else: + return self._fix16_mul( + ( + self._fix16_div( + self.params.m_sigmoid_scaled_offset, + self._f16(_VOCALGORITHM_VOC_INDEX_OFFSET_DEFAULT), + ) + ), + ( self._fix16_div( - (self._f16(_VOCALGORITHM_SIGMOID_L) + shift), + self._f16(_VOCALGORITHM_SIGMOID_L), (self._f16(1.0) + self._fix16_exp(x)), ) - ) - shift - else: - return self._fix16_mul( - ( - self._fix16_div( - self.params.m_sigmoid_scaled_offset, - self._f16(_VOCALGORITHM_VOC_INDEX_OFFSET_DEFAULT), - ) - ), - ( - self._fix16_div( - self._f16(_VOCALGORITHM_SIGMOID_L), - (self._f16(1.0) + self._fix16_exp(x)), - ) - ), - ) + ), + ) def _vocalgorithm__adaptive_lowpass__init(self) -> None: self._vocalgorithm__adaptive_lowpass__set_parameters() def _vocalgorithm__adaptive_lowpass__set_parameters(self) -> None: self.params.m_adaptive_lowpass_a1 = self._f16( - ( - _VOCALGORITHM_SAMPLING_INTERVAL - / (_VOCALGORITHM_LP_TAU_FAST + _VOCALGORITHM_SAMPLING_INTERVAL) - ) + _VOCALGORITHM_SAMPLING_INTERVAL + / (_VOCALGORITHM_LP_TAU_FAST + _VOCALGORITHM_SAMPLING_INTERVAL) ) self.params.m_adaptive_lowpass_a2 = self._f16( - ( - _VOCALGORITHM_SAMPLING_INTERVAL - / (_VOCALGORITHM_LP_TAU_SLOW + _VOCALGORITHM_SAMPLING_INTERVAL) - ) + _VOCALGORITHM_SAMPLING_INTERVAL + / (_VOCALGORITHM_LP_TAU_SLOW + _VOCALGORITHM_SAMPLING_INTERVAL) ) self.params.m_adaptive_lowpass_initialized = 0 @@ -800,19 +718,13 @@ def _vocalgorithm__adaptive_lowpass__process(self, sample: int) -> int: ) ) + (self._fix16_mul(self.params.m_adaptive_lowpass_a2, sample)) - abs_delta = ( - self.params.m_adaptive_lowpass_x1 - self.params.m_adaptive_lowpass_x2 - ) + abs_delta = self.params.m_adaptive_lowpass_x1 - self.params.m_adaptive_lowpass_x2 if abs_delta < self._f16(0.0): abs_delta = -abs_delta - F1 = self._fix16_exp( - (self._fix16_mul(self._f16(_VOCALGORITHM_LP_ALPHA), abs_delta)) - ) + F1 = self._fix16_exp(self._fix16_mul(self._f16(_VOCALGORITHM_LP_ALPHA), abs_delta)) tau_a = ( - self._fix16_mul( - self._f16((_VOCALGORITHM_LP_TAU_SLOW - _VOCALGORITHM_LP_TAU_FAST)), F1 - ) + self._fix16_mul(self._f16(_VOCALGORITHM_LP_TAU_SLOW - _VOCALGORITHM_LP_TAU_FAST), F1) ) + self._f16(_VOCALGORITHM_LP_TAU_FAST) a3 = self._fix16_div( self._f16(_VOCALGORITHM_SAMPLING_INTERVAL), diff --git a/docs/api.rst b/docs/api.rst index 13308f2..3bcd469 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_sgp40 :members: diff --git a/docs/conf.py b/docs/conf.py index 194c935..fd1f79f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -55,9 +53,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" diff --git a/examples/sgp40_indextest.py b/examples/sgp40_indextest.py index da9901c..7ac8d63 100644 --- a/examples/sgp40_indextest.py +++ b/examples/sgp40_indextest.py @@ -2,8 +2,10 @@ # # SPDX-License-Identifier: Unlicense import time -import board + import adafruit_bme280 +import board + import adafruit_sgp40 # Boards i2c bus diff --git a/examples/sgp40_simpletest.py b/examples/sgp40_simpletest.py index 9f4a253..966dc6d 100644 --- a/examples/sgp40_simpletest.py +++ b/examples/sgp40_simpletest.py @@ -2,7 +2,9 @@ # # SPDX-License-Identifier: Unlicense import time + import board + import adafruit_sgp40 # If you have a temperature sensor, like the bme280, import that here as well diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..0e62805 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import should be at the top-level of a file +] + +[format] +line-ending = "lf"