From 9d1a8120460db2d63225e8d1d28d9062e88cde34 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 15:35:08 -0500 Subject: [PATCH 01/59] Updated readthedocs file --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 338427a..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From 73a48ccb2d358b3e80a2775ea4d51360505a6db8 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 12:59:09 -0600 Subject: [PATCH 02/59] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From fa97a950f264f1374e341e1a783d8af3e113854d Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 03/59] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 331b9e7..b607b17 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From bac826ea43e60dbc5f6c9933c398981e49ffc018 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:16 -0500 Subject: [PATCH 04/59] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 8 ++++---- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 315066e..f717b29 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-as7341/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/as7341/en/latest/ + :target: https://docs.circuitpython.org/projects/as7341/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -95,7 +95,7 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index f5b290d..2143ea9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,16 +29,16 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), + "python": ("https://docs.python.org/3", None), "BusDevice": ( - "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + "https://docs.circuitpython.org/projects/busdevice/en/latest/", None, ), "Register": ( - "https://circuitpython.readthedocs.io/projects/register/en/latest/", + "https://docs.circuitpython.org/projects/register/en/latest/", None, ), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 7a174ee..8ad4fff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,7 +34,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/setup.py b/setup.py index d6888c4..4da0ddd 100644 --- a/setup.py +++ b/setup.py @@ -49,8 +49,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit blinka circuitpython micropython as7341 Spectral sensor multi-channel " From a258fbebfdaaddc0634f3c75b1745c473aed31ef Mon Sep 17 00:00:00 2001 From: Neradoc Date: Sat, 5 Feb 2022 00:58:15 +0100 Subject: [PATCH 05/59] little fix in documentation --- adafruit_as7341.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 28cc57b..5767ebf 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -246,14 +246,14 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member .. code-block:: python - channel_415nm = channel_415nm - channel_445nm = channel_445nm - channel_480nm = channel_480nm - channel_515nm = channel_515nm - channel_555nm = channel_555nm - channel_590nm = channel_590nm - channel_630nm = channel_630nm - channel_680nm = channel_680nm + channel_415nm = sensor.channel_415nm + channel_445nm = sensor.channel_445nm + channel_480nm = sensor.channel_480nm + channel_515nm = sensor.channel_515nm + channel_555nm = sensor.channel_555nm + channel_590nm = sensor.channel_590nm + channel_630nm = sensor.channel_630nm + channel_680nm = sensor.channel_680nm """ From 969d9f3fdefda0d3641f9c20f4c35e518ebb7809 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 9 Feb 2022 12:38:00 -0500 Subject: [PATCH 06/59] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index f717b29..51da91f 100644 --- a/README.rst +++ b/README.rst @@ -97,14 +97,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From 3a75a519cae09a54ec4d50fc5dbde8e0f01f166a Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sat, 12 Feb 2022 16:02:58 -0700 Subject: [PATCH 07/59] Added type annotation hints --- adafruit_as7341.py | 218 ++++++++++++++++++++++++--------------------- 1 file changed, 117 insertions(+), 101 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 5767ebf..22733d3 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -43,67 +43,78 @@ from adafruit_register.i2c_bit import RWBit from adafruit_register.i2c_bits import ROBits, RWBits -_AS7341_DEVICE_ID = const(0b001001) # Correct content of WHO_AM_I register -_AS7341_I2CADDR_DEFAULT = const(0x39) # AS7341 default i2c address -_AS7341_CHIP_ID = const(0x09) # AS7341 default device id from WHOAMI -_AS7341_WHOAMI = const(0x92) # Chip ID register -_AS7341_CONFIG = const(0x70) # Enables LED control and sets light sensing mode -_AS7341_GPIO = const(0x73) # Connects photo diode to GPIO or INT pins -_AS7341_LED = const(0x74) # LED Register; Enables and sets current limit -_AS7341_ENABLE = const( +try: + # Only needed for typing + import busio # pylint: disable=unused-import + from typing import Tuple, Optional +except ImportError: + pass + + +_AS7341_DEVICE_ID: int = const(0b001001) # Correct content of WHO_AM_I register +_AS7341_I2CADDR_DEFAULT: int = const(0x39) # AS7341 default i2c address +_AS7341_CHIP_ID: int = const(0x09) # AS7341 default device id from WHOAMI +_AS7341_WHOAMI: int = const(0x92) # Chip ID register +_AS7341_CONFIG: int = const(0x70) # Enables LED control and sets light sensing mode +_AS7341_GPIO: int = const(0x73) # Connects photo diode to GPIO or INT pins +_AS7341_LED: int = const(0x74) # LED Register; Enables and sets current limit +_AS7341_ENABLE: int = const( 0x80 -) # Main enable register. Controls SMUX, Flicker Detection,Spectral and Power -_AS7341_ATIME = const(0x81) # Sets ADC integration step count -_AS7341_SP_LOW_TH_L = const(0x84) # Spectral measurement Low Threshold low byte -_AS7341_SP_LOW_TH_H = const(0x85) # 0 Spectral measurement Low Threshold high byte -_AS7341_SP_HIGH_TH_L = const(0x86) # Spectral measurement High Threshold low byte -_AS7341_SP_HIGH_TH_H = const(0x87) # Spectral measurement High Threshold low byte -_AS7341_STATUS = const( +) # Main enable register. Controls SMUX, Flicker Detection,Spectral and +# Power +_AS7341_ATIME: int = const(0x81) # Sets ADC integration step count +_AS7341_SP_LOW_TH_L: int = const(0x84) # Spectral measurement Low Threshold low byte +_AS7341_SP_LOW_TH_H: int = const(0x85) # 0 Spectral measurement Low Threshold high byte +_AS7341_SP_HIGH_TH_L: int = const(0x86) # Spectral measurement High Threshold low byte +_AS7341_SP_HIGH_TH_H: int = const(0x87) # Spectral measurement High Threshold low byte +_AS7341_STATUS: int = const( 0x93 ) # Interrupt status registers. Indicates the occourance of an interrupt -_AS7341_ASTATUS = const( +_AS7341_ASTATUS: int = const( 0x94 ) # Spectral Saturation and Gain status. Reading from here latches the data -_AS7341_CH0_DATA_L = const(0x95) # ADC Channel 0 Data -_AS7341_CH0_DATA_H = const(0x96) # ADC Channel 0 Data -_AS7341_CH1_DATA_L = const(0x97) # ADC Channel 1 Data -_AS7341_CH1_DATA_H = const(0x98) # ADC Channel 1 Data -_AS7341_CH2_DATA_L = const(0x99) # ADC Channel 2 Data -_AS7341_CH2_DATA_H = const(0x9A) # ADC Channel 2 Data -_AS7341_CH3_DATA_L = const(0x9B) # ADC Channel 3 Data -_AS7341_CH3_DATA_H = const(0x9C) # ADC Channel 3 Data -_AS7341_CH4_DATA_L = const(0x9D) # ADC Channel 4 Data -_AS7341_CH4_DATA_H = const(0x9E) # ADC Channel 4 Data -_AS7341_CH5_DATA_L = const(0x9F) # ADC Channel 5 Data -_AS7341_CH5_DATA_H = const(0xA0) # ADC Channel 5 Data -_AS7341_STATUS2 = const(0xA3) # Measurement status flags; saturation, validity -_AS7341_STATUS3 = const(0xA4) # Spectral interrupt source, high or low threshold -_AS7341_CFG0 = const( +_AS7341_CH0_DATA_L: int = const(0x95) # ADC Channel 0 Data +_AS7341_CH0_DATA_H: int = const(0x96) # ADC Channel 0 Data +_AS7341_CH1_DATA_L: int = const(0x97) # ADC Channel 1 Data +_AS7341_CH1_DATA_H: int = const(0x98) # ADC Channel 1 Data +_AS7341_CH2_DATA_L: int = const(0x99) # ADC Channel 2 Data +_AS7341_CH2_DATA_H: int = const(0x9A) # ADC Channel 2 Data +_AS7341_CH3_DATA_L: int = const(0x9B) # ADC Channel 3 Data +_AS7341_CH3_DATA_H: int = const(0x9C) # ADC Channel 3 Data +_AS7341_CH4_DATA_L: int = const(0x9D) # ADC Channel 4 Data +_AS7341_CH4_DATA_H: int = const(0x9E) # ADC Channel 4 Data +_AS7341_CH5_DATA_L: int = const(0x9F) # ADC Channel 5 Data +_AS7341_CH5_DATA_H: int = const(0xA0) # ADC Channel 5 Data +_AS7341_STATUS2: int = const(0xA3) # Measurement status flags; saturation, validity +_AS7341_STATUS3: int = const(0xA4) # Spectral interrupt source, high or low threshold +_AS7341_CFG0: int = const( 0xA9 ) # Sets Low power mode, Register bank, and Trigger lengthening -_AS7341_CFG1 = const(0xAA) # Controls ADC Gain -_AS7341_CFG6 = const(0xAF) # Used to configure Smux -_AS7341_CFG9 = const(0xB2) # flicker detect and SMUX command system ints -_AS7341_CFG12 = const(0xB5) # ADC channel for interrupts, persistence and auto-gain +_AS7341_CFG1: int = const(0xAA) # Controls ADC Gain +_AS7341_CFG6: int = const(0xAF) # Used to configure Smux +_AS7341_CFG9: int = const(0xB2) # flicker detect and SMUX command system ints +_AS7341_CFG12: int = const( + 0xB5 +) # ADC channel for interrupts, persistence and auto-gain _AS7341_PERS = const( 0xBD ) # number of measurements outside thresholds to trigger an interrupt _AS7341_GPIO2 = const( 0xBE ) # GPIO Settings and status: polarity, direction, sets output, reads -_AS7341_ASTEP_L = const(0xCA) # Integration step size ow byte -_AS7341_ASTEP_H = const(0xCB) # Integration step size high byte -_AS7341_FD_TIME1 = const(0xD8) # Flicker detection integration time low byte -_AS7341_FD_TIME2 = const(0xDA) # Flicker detection gain and high nibble -_AS7341_FD_STATUS = const( +_AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte +_AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte +_AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte +_AS7341_FD_TIME2: int = const(0xDA) # Flicker detection gain and high nibble +_AS7341_FD_STATUS: int = const( 0xDB ) # Flicker detection status; measurement valid, saturation, flicker -_AS7341_INTENAB = const(0xF9) # Enables individual interrupt types -_AS7341_CONTROL = const(0xFA) # Auto-zero, fifo clear, clear SAI active -_AS7341_FD_CFG0 = const(0xD7) # Enables FIFO for flicker detection +_AS7341_INTENAB: int = const(0xF9) # Enables individual interrupt types +_AS7341_CONTROL: int = const(0xFA) # Auto-zero, fifo clear, clear SAI active +_AS7341_FD_CFG0: int = const(0xD7) # Enables FIFO for flicker detection -def _low_bank(func): +def _low_bank(func) -> any: # pylint:disable=protected-access def _decorator(self, *args, **kwargs): self._low_bank_active = True @@ -118,7 +129,10 @@ class CV: """struct helper""" @classmethod - def add_values(cls, value_tuples): + def add_values( + cls, + value_tuples: Tuple[str, int, any, any], + ) -> None: """Add CV values to the class""" cls.string = {} cls.lsb = {} @@ -130,7 +144,7 @@ def add_values(cls, value_tuples): cls.lsb[value] = lsb @classmethod - def is_valid(cls, value): + def is_valid(cls, value: str) -> bool: """Validate that a given value is a member""" return value in cls.string @@ -257,44 +271,46 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member """ - _device_id = ROBits(6, _AS7341_WHOAMI, 2) + _device_id: ROBits = ROBits(6, _AS7341_WHOAMI, 2) - _smux_enable_bit = RWBit(_AS7341_ENABLE, 4) - _led_control_enable_bit = RWBit(_AS7341_CONFIG, 3) - _color_meas_enabled = RWBit(_AS7341_ENABLE, 1) - _power_enabled = RWBit(_AS7341_ENABLE, 0) + _smux_enable_bit: RWBit = RWBit(_AS7341_ENABLE, 4) + _led_control_enable_bit: RWBit = RWBit(_AS7341_CONFIG, 3) + _color_meas_enabled: RWBit = RWBit(_AS7341_ENABLE, 1) + _power_enabled: RWBit = RWBit(_AS7341_ENABLE, 0) - _low_bank_active = RWBit(_AS7341_CFG0, 4) - _smux_command = RWBits(2, _AS7341_CFG6, 3) - _fd_status = UnaryStruct(_AS7341_FD_STATUS, " None: """Configure the sensors with the default settings""" self._power_enabled = True @@ -315,7 +331,7 @@ def initialize(self): self.gain = Gain.GAIN_128X # pylint:disable=no-member @property - def all_channels(self): + def all_channels(self) -> Struct: """The current readings for all six ADC channels""" self._configure_f1_f4() @@ -329,66 +345,66 @@ def all_channels(self): return reads @property - def channel_415nm(self): + def channel_415nm(self) -> UnaryStruct: """The current reading for the 415nm band""" self._configure_f1_f4() return self._channel_0_data @property - def channel_445nm(self): + def channel_445nm(self) -> UnaryStruct: """The current reading for the 445nm band""" self._configure_f1_f4() return self._channel_1_data @property - def channel_480nm(self): + def channel_480nm(self) -> UnaryStruct: """The current reading for the 480nm band""" self._configure_f1_f4() return self._channel_2_data @property - def channel_515nm(self): + def channel_515nm(self) -> UnaryStruct: """The current reading for the 515nm band""" self._configure_f1_f4() return self._channel_3_data @property - def channel_555nm(self): + def channel_555nm(self) -> UnaryStruct: """The current reading for the 555nm band""" self._configure_f5_f8() return self._channel_0_data @property - def channel_590nm(self): + def channel_590nm(self) -> UnaryStruct: """The current reading for the 590nm band""" self._configure_f5_f8() return self._channel_1_data @property - def channel_630nm(self): + def channel_630nm(self) -> UnaryStruct: """The current reading for the 630nm band""" self._configure_f5_f8() return self._channel_2_data @property - def channel_680nm(self): + def channel_680nm(self) -> UnaryStruct: """The current reading for the 680nm band""" self._configure_f5_f8() return self._channel_3_data @property - def channel_clear(self): + def channel_clear(self) -> UnaryStruct: """The current reading for the clear sensor""" self._configure_f5_f8() return self._channel_4_data @property - def channel_nir(self): + def channel_nir(self) -> UnaryStruct: """The current reading for the NIR (near-IR) sensor""" self._configure_f5_f8() return self._channel_5_data - def _wait_for_data(self, timeout=1.0): + def _wait_for_data(self, timeout: int = 1.0) -> None: """Wait for sensor data to be ready""" start = monotonic() while not self._data_ready_bit: @@ -396,7 +412,7 @@ def _wait_for_data(self, timeout=1.0): raise RuntimeError("Timeout occurred waiting for sensor data") sleep(0.001) - def _write_register(self, addr, data): + def _write_register(self, addr: int, data: int) -> None: self._buffer[0] = addr self._buffer[1] = data @@ -404,7 +420,7 @@ def _write_register(self, addr, data): with self.i2c_device as i2c: i2c.write(self._buffer) - def _configure_f1_f4(self): + def _configure_f1_f4(self) -> None: """Configure the sensor to read from elements F1-F4, Clear, and NIR""" # disable SP_EN bit while making config changes if self._low_channels_configured: @@ -427,7 +443,7 @@ def _configure_f1_f4(self): self._low_channels_configured = True self._wait_for_data() - def _configure_f5_f8(self): + def _configure_f5_f8(self) -> None: """Configure the sensor to read from elements F5-F8, Clear, and NIR""" # disable SP_EN bit while making config changes if self._high_channels_configured: @@ -452,7 +468,7 @@ def _configure_f5_f8(self): self._wait_for_data() @property - def flicker_detected(self): + def flicker_detected(self) -> Optional[int]: """The flicker frequency detected in Hertz""" if not self._flicker_detection_1k_configured: AttributeError( @@ -468,20 +484,20 @@ def flicker_detected(self): # if we haven't returned yet either there was an error or an unknown frequency was detected @property - def flicker_detection_enabled(self): + def flicker_detection_enabled(self) -> bool: """The flicker detection status of the sensor. True if the sensor is configured\ to detect flickers. Currently only 1000Hz and 1200Hz flicker detection is supported """ return self._flicker_detection_1k_configured @flicker_detection_enabled.setter - def flicker_detection_enabled(self, flicker_enable): + def flicker_detection_enabled(self, flicker_enable: bool) -> None: if flicker_enable: self._configure_1k_flicker_detection() else: self._configure_f1_f4() # sane default - def _f1f4_clear_nir(self): + def _f1f4_clear_nir(self) -> None: """Configure SMUX for sensors F1-F4, Clear and NIR""" self._set_smux(SMUX_IN.NC_F3L, SMUX_OUT.DISABLED, SMUX_OUT.ADC2) self._set_smux(SMUX_IN.F1L_NC, SMUX_OUT.ADC0, SMUX_OUT.DISABLED) @@ -504,7 +520,7 @@ def _f1f4_clear_nir(self): self._set_smux(SMUX_IN.NC_DARK, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) self._set_smux(SMUX_IN.NIR_F, SMUX_OUT.ADC5, SMUX_OUT.DISABLED) - def _f5f8_clear_nir(self): + def _f5f8_clear_nir(self) -> None: # SMUX Config for F5,F6,F7,F8,NIR,Clear self._set_smux(SMUX_IN.NC_F3L, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) self._set_smux(SMUX_IN.F1L_NC, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) @@ -528,7 +544,7 @@ def _f5f8_clear_nir(self): self._set_smux(SMUX_IN.NIR_F, SMUX_OUT.ADC5, SMUX_OUT.DISABLED) # TODO: Convert as much of this as possible to properties or named attributes - def _configure_1k_flicker_detection(self): + def _configure_1k_flicker_detection(self) -> None: self._low_channels_configured = False self._high_channels_configured = False @@ -603,7 +619,7 @@ def _configure_1k_flicker_detection(self): self._flicker_detection_1k_configured = True - def _smux_template(self): + def _smux_template(self) -> None: # SMUX_OUT.DISABLED # SMUX_OUT.ADC0 # SMUX_OUT.ADC1 @@ -640,22 +656,22 @@ def _set_smux(self, smux_addr, smux_out1, smux_out2): self._write_register(smux_addr, smux_byte) @property - def gain(self): + def gain(self) -> Gain: """The ADC gain multiplier. Must be a valid :meth:`adafruit_as7341.Gain`""" return self._gain @gain.setter - def gain(self, gain_value): + def gain(self, gain_value: str) -> None: if not Gain.is_valid(gain_value): raise AttributeError("`gain` must be a valid `adafruit_as7341.Gain`") self._gain = gain_value @property - def _smux_enabled(self): + def _smux_enabled(self) -> RWBit: return self._smux_enable_bit @_smux_enabled.setter - def _smux_enabled(self, enable_smux): + def _smux_enabled(self, enable_smux: RWBit): self._low_bank_active = False self._smux_enable_bit = enable_smux while self._smux_enable_bit is True: @@ -663,7 +679,7 @@ def _smux_enabled(self, enable_smux): @property @_low_bank - def led_current(self): + def led_current(self) -> int: """The maximum allowed current through the attached LED in milliamps. Odd numbered values will be rounded down to the next lowest even number due to the internal configuration restrictions""" @@ -672,27 +688,27 @@ def led_current(self): @led_current.setter @_low_bank - def led_current(self, led_curent): - new_current = int((min(258, max(4, led_curent)) - 4) / 2) + def led_current(self, led_current: int) -> None: + new_current = int((min(258, max(4, led_current)) - 4) / 2) self._led_current_bits = new_current @property @_low_bank - def led(self): + def led(self) -> RWBit: """The attached LED. Set to True to turn on, False to turn off""" return self._led_enabled @led.setter @_low_bank - def led(self, led_on): + def led(self, led_on: RWBit) -> None: self._led_enabled = led_on @property @_low_bank - def _led_control_enabled(self): + def _led_control_enabled(self) -> RWBit: return self._led_control_enable_bit @_led_control_enabled.setter @_low_bank - def _led_control_enabled(self, enabled): + def _led_control_enabled(self, enabled: RWBit) -> None: self._led_control_enable_bit = enabled From 0517d45a23caad9a026da35817d931ecc593036e Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sun, 13 Feb 2022 10:00:24 -0700 Subject: [PATCH 08/59] More typing changes --- adafruit_as7341.py | 63 +++++++++++++++++++++++++++------------------- 1 file changed, 37 insertions(+), 26 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 22733d3..7ffdcfa 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -44,18 +44,23 @@ from adafruit_register.i2c_bits import ROBits, RWBits try: + from typing import Tuple, Optional, Any, Callable, TypeVar + # Only needed for typing import busio # pylint: disable=unused-import - from typing import Tuple, Optional + + TCallable = TypeVar('TCallable', bound=Callable[..., Any]) + except ImportError: pass - -_AS7341_DEVICE_ID: int = const(0b001001) # Correct content of WHO_AM_I register +# Correct content of WHO_AM_I register +_AS7341_DEVICE_ID: int = const(0b001001) _AS7341_I2CADDR_DEFAULT: int = const(0x39) # AS7341 default i2c address _AS7341_CHIP_ID: int = const(0x09) # AS7341 default device id from WHOAMI _AS7341_WHOAMI: int = const(0x92) # Chip ID register -_AS7341_CONFIG: int = const(0x70) # Enables LED control and sets light sensing mode +# Enables LED control and sets light sensing mode +_AS7341_CONFIG: int = const(0x70) _AS7341_GPIO: int = const(0x73) # Connects photo diode to GPIO or INT pins _AS7341_LED: int = const(0x74) # LED Register; Enables and sets current limit _AS7341_ENABLE: int = const( @@ -63,10 +68,14 @@ ) # Main enable register. Controls SMUX, Flicker Detection,Spectral and # Power _AS7341_ATIME: int = const(0x81) # Sets ADC integration step count -_AS7341_SP_LOW_TH_L: int = const(0x84) # Spectral measurement Low Threshold low byte -_AS7341_SP_LOW_TH_H: int = const(0x85) # 0 Spectral measurement Low Threshold high byte -_AS7341_SP_HIGH_TH_L: int = const(0x86) # Spectral measurement High Threshold low byte -_AS7341_SP_HIGH_TH_H: int = const(0x87) # Spectral measurement High Threshold low byte +# Spectral measurement Low Threshold low byte +_AS7341_SP_LOW_TH_L: int = const(0x84) +# 0 Spectral measurement Low Threshold high byte +_AS7341_SP_LOW_TH_H: int = const(0x85) +# Spectral measurement High Threshold low byte +_AS7341_SP_HIGH_TH_L: int = const(0x86) +# Spectral measurement High Threshold low byte +_AS7341_SP_HIGH_TH_H: int = const(0x87) _AS7341_STATUS: int = const( 0x93 ) # Interrupt status registers. Indicates the occourance of an interrupt @@ -104,7 +113,9 @@ ) # GPIO Settings and status: polarity, direction, sets output, reads _AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte _AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte -_AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte +_AS7341_FD_TIME1: int = const( + 0xD8 +) # Flicker detection integration time low byte _AS7341_FD_TIME2: int = const(0xDA) # Flicker detection gain and high nibble _AS7341_FD_STATUS: int = const( 0xDB @@ -114,9 +125,9 @@ _AS7341_FD_CFG0: int = const(0xD7) # Enables FIFO for flicker detection -def _low_bank(func) -> any: +def _low_bank(func: TCallable) -> Callable[[Any], TCallable]: # pylint:disable=protected-access - def _decorator(self, *args, **kwargs): + def _decorator(self, *args, **kwargs) -> TCallable: self._low_bank_active = True retval = func(self, *args, **kwargs) self._low_bank_active = False @@ -131,7 +142,7 @@ class CV: @classmethod def add_values( cls, - value_tuples: Tuple[str, int, any, any], + value_tuples: Tuple[str, int, int, Optional[float]], ) -> None: """Add CV values to the class""" cls.string = {} @@ -309,8 +320,8 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member """ def __init__( - self, i2c_bus: busio.I2C, address: Optional[int] = _AS7341_I2CADDR_DEFAULT - ): + self, i2c_bus: busio.I2C, address: int = _AS7341_I2CADDR_DEFAULT + ) -> None: self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) if not self._device_id in [_AS7341_DEVICE_ID]: @@ -331,7 +342,7 @@ def initialize(self) -> None: self.gain = Gain.GAIN_128X # pylint:disable=no-member @property - def all_channels(self) -> Struct: + def all_channels(self) -> Tuple[int, ...]: """The current readings for all six ADC channels""" self._configure_f1_f4() @@ -345,66 +356,66 @@ def all_channels(self) -> Struct: return reads @property - def channel_415nm(self) -> UnaryStruct: + def channel_415nm(self) -> int: """The current reading for the 415nm band""" self._configure_f1_f4() return self._channel_0_data @property - def channel_445nm(self) -> UnaryStruct: + def channel_445nm(self) -> int: """The current reading for the 445nm band""" self._configure_f1_f4() return self._channel_1_data @property - def channel_480nm(self) -> UnaryStruct: + def channel_480nm(self) -> int: """The current reading for the 480nm band""" self._configure_f1_f4() return self._channel_2_data @property - def channel_515nm(self) -> UnaryStruct: + def channel_515nm(self) -> int: """The current reading for the 515nm band""" self._configure_f1_f4() return self._channel_3_data @property - def channel_555nm(self) -> UnaryStruct: + def channel_555nm(self) -> int: """The current reading for the 555nm band""" self._configure_f5_f8() return self._channel_0_data @property - def channel_590nm(self) -> UnaryStruct: + def channel_590nm(self) -> int: """The current reading for the 590nm band""" self._configure_f5_f8() return self._channel_1_data @property - def channel_630nm(self) -> UnaryStruct: + def channel_630nm(self) -> int: """The current reading for the 630nm band""" self._configure_f5_f8() return self._channel_2_data @property - def channel_680nm(self) -> UnaryStruct: + def channel_680nm(self) -> int: """The current reading for the 680nm band""" self._configure_f5_f8() return self._channel_3_data @property - def channel_clear(self) -> UnaryStruct: + def channel_clear(self) -> int: """The current reading for the clear sensor""" self._configure_f5_f8() return self._channel_4_data @property - def channel_nir(self) -> UnaryStruct: + def channel_nir(self) -> int: """The current reading for the NIR (near-IR) sensor""" self._configure_f5_f8() return self._channel_5_data - def _wait_for_data(self, timeout: int = 1.0) -> None: + def _wait_for_data(self, timeout: Optional[int] = 1.0) -> None: """Wait for sensor data to be ready""" start = monotonic() while not self._data_ready_bit: From c72346bffe27d55777d2247e6646c5198207aaa4 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sun, 13 Feb 2022 10:01:11 -0700 Subject: [PATCH 09/59] committed formatting changes made by black --- adafruit_as7341.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 7ffdcfa..645d146 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -49,7 +49,7 @@ # Only needed for typing import busio # pylint: disable=unused-import - TCallable = TypeVar('TCallable', bound=Callable[..., Any]) + TCallable = TypeVar("TCallable", bound=Callable[..., Any]) except ImportError: pass @@ -113,9 +113,7 @@ ) # GPIO Settings and status: polarity, direction, sets output, reads _AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte _AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte -_AS7341_FD_TIME1: int = const( - 0xD8 -) # Flicker detection integration time low byte +_AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte _AS7341_FD_TIME2: int = const(0xDA) # Flicker detection gain and high nibble _AS7341_FD_STATUS: int = const( 0xDB From a03f0052c3077267edbeae56133f0192e841c291 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sun, 13 Feb 2022 10:19:05 -0700 Subject: [PATCH 10/59] additional type hint adjustments --- adafruit_as7341.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 645d146..ce687e7 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -657,7 +657,7 @@ def _smux_template(self) -> None: self._set_smux(SMUX_IN.NC_DARK, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) self._set_smux(SMUX_IN.NIR_F, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) - def _set_smux(self, smux_addr, smux_out1, smux_out2): + def _set_smux(self, smux_addr: int, smux_out1: int, smux_out2: int) -> None: """Connect a pair of sensors to an ADC channel""" low_nibble = smux_out1 high_nibble = smux_out2 << 4 @@ -665,7 +665,7 @@ def _set_smux(self, smux_addr, smux_out1, smux_out2): self._write_register(smux_addr, smux_byte) @property - def gain(self) -> Gain: + def gain(self) -> int: """The ADC gain multiplier. Must be a valid :meth:`adafruit_as7341.Gain`""" return self._gain @@ -676,11 +676,11 @@ def gain(self, gain_value: str) -> None: self._gain = gain_value @property - def _smux_enabled(self) -> RWBit: + def _smux_enabled(self) -> bool: return self._smux_enable_bit @_smux_enabled.setter - def _smux_enabled(self, enable_smux: RWBit): + def _smux_enabled(self, enable_smux: bool): self._low_bank_active = False self._smux_enable_bit = enable_smux while self._smux_enable_bit is True: @@ -703,21 +703,21 @@ def led_current(self, led_current: int) -> None: @property @_low_bank - def led(self) -> RWBit: + def led(self) -> bool: """The attached LED. Set to True to turn on, False to turn off""" return self._led_enabled @led.setter @_low_bank - def led(self, led_on: RWBit) -> None: + def led(self, led_on: bool) -> None: self._led_enabled = led_on @property @_low_bank - def _led_control_enabled(self) -> RWBit: + def _led_control_enabled(self) -> bool: return self._led_control_enable_bit @_led_control_enabled.setter @_low_bank - def _led_control_enabled(self, enabled: RWBit) -> None: + def _led_control_enabled(self, enabled: bool) -> None: self._led_control_enable_bit = enabled From 9d8a952f65862414595ddbe4884804198c6974f4 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Sun, 13 Feb 2022 15:23:28 -0700 Subject: [PATCH 11/59] Fixed type hint of `timeout` parameter to `_wait_for_data()` --- adafruit_as7341.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index ce687e7..672ffe6 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -413,7 +413,7 @@ def channel_nir(self) -> int: self._configure_f5_f8() return self._channel_5_data - def _wait_for_data(self, timeout: Optional[int] = 1.0) -> None: + def _wait_for_data(self, timeout: Optional[float] = 1.0) -> None: """Wait for sensor data to be ready""" start = monotonic() while not self._data_ready_bit: From faaa227c8354d39ae10cc32b9e71073f3e9a0ba3 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Mon, 14 Feb 2022 08:06:04 -0700 Subject: [PATCH 12/59] updated type hints for `_low_bank` decorator --- adafruit_as7341.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 672ffe6..5c30400 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -113,7 +113,9 @@ ) # GPIO Settings and status: polarity, direction, sets output, reads _AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte _AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte -_AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte +_AS7341_FD_TIME1: int = const( + 0xD8 +) # Flicker detection integration time low byte _AS7341_FD_TIME2: int = const(0xDA) # Flicker detection gain and high nibble _AS7341_FD_STATUS: int = const( 0xDB @@ -123,9 +125,9 @@ _AS7341_FD_CFG0: int = const(0xD7) # Enables FIFO for flicker detection -def _low_bank(func: TCallable) -> Callable[[Any], TCallable]: +def _low_bank(func: Any) -> Any: # pylint:disable=protected-access - def _decorator(self, *args, **kwargs) -> TCallable: + def _decorator(self, *args, **kwargs) -> Any: self._low_bank_active = True retval = func(self, *args, **kwargs) self._low_bank_active = False From 9296d634827c3ccab9ad46aa2ee793186cde7e74 Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Mon, 14 Feb 2022 08:06:56 -0700 Subject: [PATCH 13/59] committed formatting changes from black --- adafruit_as7341.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 5c30400..e0a2501 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -113,9 +113,7 @@ ) # GPIO Settings and status: polarity, direction, sets output, reads _AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte _AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte -_AS7341_FD_TIME1: int = const( - 0xD8 -) # Flicker detection integration time low byte +_AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte _AS7341_FD_TIME2: int = const(0xDA) # Flicker detection gain and high nibble _AS7341_FD_STATUS: int = const( 0xDB From 0eec363989420b1f336f8734d242b9f29e9ea78a Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 15 Feb 2022 10:07:00 -0500 Subject: [PATCH 14/59] Add table for Gain CV, remove unnecessary pass statements --- adafruit_as7341.py | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 5767ebf..828ed50 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -145,9 +145,35 @@ def is_valid(cls, value): class Gain(CV): - """Options for ``accelerometer_range``""" - - pass # pylint: disable=unnecessary-pass + """Options for ``accelerometer_range`` + + +-------------------------------+-------------------------+ + | Setting | Gain Value | + +===============================+=========================+ + | :py:const:`Gain.GAIN_0_5X` | 0.5 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_1X` | 1 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_2X` | 2 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_4X` | 4 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_8X` | 8 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_16X` | 16 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_32X` | 32 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_64X` | 64 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_128X` | 128 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_256X` | 256 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_512X` | 512 | + +-------------------------------+-------------------------+ + + """ Gain.add_values( @@ -170,8 +196,6 @@ class Gain(CV): class SMUX_OUT(CV): """Options for ``smux_out``""" - pass # pylint: disable=unnecessary-pass - SMUX_OUT.add_values( ( @@ -189,8 +213,6 @@ class SMUX_OUT(CV): class SMUX_IN(CV): """Options for ``smux_in``""" - pass # pylint: disable=unnecessary-pass - SMUX_IN.add_values( ( From da9e65ce62819bf93aea56e3709c63da423fb6d6 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 15 Feb 2022 10:22:31 -0500 Subject: [PATCH 15/59] Reformatted per pre-commit --- adafruit_as7341.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 828ed50..50d0ae7 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -172,7 +172,7 @@ class Gain(CV): +-------------------------------+-------------------------+ | :py:const:`Gain.GAIN_512X` | 512 | +-------------------------------+-------------------------+ - + """ From 0a48ee600326513aa335b6d59a820fb56843b0da Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Tue, 15 Feb 2022 08:23:16 -0700 Subject: [PATCH 16/59] Fixed type of `timeout` parameter to `_wait_for_data` --- adafruit_as7341.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index e0a2501..d912883 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -413,7 +413,7 @@ def channel_nir(self) -> int: self._configure_f5_f8() return self._channel_5_data - def _wait_for_data(self, timeout: Optional[float] = 1.0) -> None: + def _wait_for_data(self, timeout: float = 1.0) -> None: """Wait for sensor data to be ready""" start = monotonic() while not self._data_ready_bit: From e552ba100dc1f7440a0d574d141a5f8ae5b20e94 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 17/59] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From b236f3d4c64bdfd68fb4d9734968a11ce86adb4a Mon Sep 17 00:00:00 2001 From: Tammy Cravit Date: Tue, 15 Feb 2022 11:40:08 -0700 Subject: [PATCH 18/59] specified minimum Blinka version for typing --- requirements.txt | 2 +- setup.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index cc92861..e6b96f9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,6 @@ # # SPDX-License-Identifier: MIT -Adafruit-Blinka +Adafruit-Blinka>=6.20.4 adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py index 4da0ddd..a99921b 100644 --- a/setup.py +++ b/setup.py @@ -35,7 +35,7 @@ author="Adafruit Industries", author_email="circuitpython@adafruit.com", install_requires=[ - "Adafruit-Blinka", + "Adafruit-Blinka>=6.20.4", "adafruit-circuitpython-busdevice", "adafruit-circuitpython-register", ], From 7d49e9d8365b9064323f119722717bc8f577eae6 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 16 Feb 2022 13:06:00 -0500 Subject: [PATCH 19/59] Reveal Gain class for documentation --- docs/api.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index da202c1..4c70f7d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -6,4 +6,4 @@ .. automodule:: adafruit_as7341 :members: - :exclude-members: CV, Gain, SMUX_IN, SMUX_OUT + :exclude-members: CV, SMUX_IN, SMUX_OUT From 16cde520a75250a51b21765cfcd5363c7f6a4068 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 17 Feb 2022 09:39:15 -0500 Subject: [PATCH 20/59] Use rtype to clarify types returned because of __get__() `UnaryStruct` uses __get__() to return a different type, but this is unclear currently because now that these variable have type annotations, class variable utilizing ot are automatically typed as `UnaryStruct`. While one option is to manually document the class variables, I think it's preferable to use an attached docstring so the documentation and code don't ever get split up if one is removed for some reason. Using Sphinx `rtype` seems to be the best way to document it then. --- adafruit_as7341.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 0dd625b..a5ddfa3 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -325,12 +325,20 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member _all_channels: Struct = Struct(_AS7341_ASTATUS, " Date: Thu, 17 Feb 2022 22:23:36 -0500 Subject: [PATCH 21/59] Add Python version req, update Blinka version req --- requirements.txt | 2 +- setup.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index e6b96f9..cb26b23 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,6 +3,6 @@ # # SPDX-License-Identifier: MIT -Adafruit-Blinka>=6.20.4 +Adafruit-Blinka>=7.0.0 adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py index a99921b..35a3711 100644 --- a/setup.py +++ b/setup.py @@ -34,8 +34,9 @@ # Author details author="Adafruit Industries", author_email="circuitpython@adafruit.com", + python_requires=">=3.7.0" install_requires=[ - "Adafruit-Blinka>=6.20.4", + "Adafruit-Blinka>=7.0.0", "adafruit-circuitpython-busdevice", "adafruit-circuitpython-register", ], From a533db51092c494d26efa3ba1b2e8f0a110449d6 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 17 Feb 2022 22:28:31 -0500 Subject: [PATCH 22/59] Add missing comma --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 35a3711..5fb7e12 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ # Author details author="Adafruit Industries", author_email="circuitpython@adafruit.com", - python_requires=">=3.7.0" + python_requires=">=3.7.0", install_requires=[ "Adafruit-Blinka>=7.0.0", "adafruit-circuitpython-busdevice", From 940d308c279f7d533bac7a1ffb84f59fd524d2c0 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 23/59] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From fbc75178a32c0bce6aad028f61f1310875baa043 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:45:16 -0400 Subject: [PATCH 24/59] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 49 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 2c6ddfd..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,18 +1,47 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -.python-version -build*/ -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea .vscode +*~ From 971fc70fd40d00ca18ecbde5cd5e50bf0bca370f Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:58:19 -0400 Subject: [PATCH 25/59] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 51da91f..06ff468 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/as7341/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 8aa1bfb561f7724a699303590929b99397c48f9d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:49:09 -0500 Subject: [PATCH 26/59] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 06ff468..8dd14ca 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/as7341/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From d088925ddcdad5115d5b28e97ae64ae6bc94e19d Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:25:47 -0400 Subject: [PATCH 27/59] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7467c1d..3343606 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - 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 + - --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 + - --disable=missing-docstring,consider-using-f-string,duplicate-code From d9d95f9280d6956129708e2ec7f0d98efac12778 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 28/59] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index bd3976d..d411a3c 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 2c0bc61b366cea86a9a871c30b8c084a7183f0c4 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 29/59] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index d411a3c..66d688f 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# 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 blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From f1d5ca5ac4cec266aa9b923ffc777c468e8891aa Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 30/59] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 2143ea9..998f042 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,7 +68,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From 54cdc60d9ba26c6a77bf46d8969aba72e1d7c340 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:00 -0400 Subject: [PATCH 31/59] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 8ad4fff..c922948 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From 469a38c654a49afb0b96e8075c5a6ca4cb5573c2 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:58:28 -0400 Subject: [PATCH 32/59] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 8dd14ca..eefd09b 100644 --- a/README.rst +++ b/README.rst @@ -55,8 +55,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-as7341 Usage Example From 8eb87adf8f56350c94595b722a722097d5e28094 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:52 -0400 Subject: [PATCH 33/59] Switched to pyproject.toml --- .github/workflows/build.yml | 22 +++++++++++-- .github/workflows/release.yml | 17 ++++++---- optional_requirements.txt | 3 ++ pyproject.toml | 50 +++++++++++++++++++++++++--- requirements.txt | 7 ++-- setup.py | 62 ----------------------------------- 6 files changed, 82 insertions(+), 79 deletions(-) create mode 100644 optional_requirements.txt delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b607b17..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,13 +47,31 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . + - name: Archive bundles + uses: actions/upload-artifact@v2 + with: + name: bundles + path: ${{ github.workspace }}/bundles/ - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Check For pyproject.toml + id: need-pypi + run: | + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) + - name: Build Python package + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') + run: | + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build + twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml index f3c35ae..95a89fb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,48 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT -[tool.black] -target-version = ['py35'] +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-as7341" +description = "CircuitPython library for use with the Adafruit AS7341 breakout" +version = "0.0.0-auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_AS7341"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "as7341", + "Spectral", + "sensor", + "multi-channel", + "mux", + "calibration", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +py-modules = ["adafruit_as7341"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index cb26b23..995c612 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,7 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # -# SPDX-License-Identifier: MIT +# SPDX-License-Identifier: Unlicense Adafruit-Blinka>=7.0.0 -adafruit-circuitpython-busdevice adafruit-circuitpython-register +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py deleted file mode 100644 index 5fb7e12..0000000 --- a/setup.py +++ /dev/null @@ -1,62 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-as7341", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for use with the Adafruit AS7341 breakout", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_AS7341", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - python_requires=">=3.7.0", - install_requires=[ - "Adafruit-Blinka>=7.0.0", - "adafruit-circuitpython-busdevice", - "adafruit-circuitpython-register", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython as7341 Spectral sensor multi-channel " - "mux calibration", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_as7341"], -) From 271eb679a0eda14a3bfb04ab60969672c33dfcd3 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 34/59] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 95a89fb..013d146 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From d8f42a854a17a269b6002102fc523192312f7cd1 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:12 -0400 Subject: [PATCH 35/59] Update version string --- adafruit_as7341.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index a5ddfa3..6f7c696 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -32,7 +32,7 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AS7341.git" from time import sleep, monotonic diff --git a/pyproject.toml b/pyproject.toml index 013d146..dc50e48 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-as7341" description = "CircuitPython library for use with the Adafruit AS7341 breakout" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From e6c6fe09388b79c729cf396dc7d687bca4ee70d6 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:13 -0400 Subject: [PATCH 36/59] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From f8f2cadef75ac705355d4949e3306389e9848135 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:29 -0400 Subject: [PATCH 37/59] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 998f042..8a62636 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) @@ -51,7 +52,8 @@ # General information about the project. project = "Adafruit AS7341 Library" -copyright = "2020 Bryan Siepert" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for From f16d14a4f16c0b997d241759a6a728e6048e0383 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:20 -0400 Subject: [PATCH 38/59] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8a62636..c563ae4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,8 +52,14 @@ # General information about the project. project = "Adafruit AS7341 Library" +creation_year = "2020" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Bryan Siepert" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for From e7cda8d13f156fdb7c0513f2938c8432e03bc495 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:49 -0400 Subject: [PATCH 39/59] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From 0fa4d55ca76671b02bd8c1c57e0ebe3082c503c6 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:46:59 -0400 Subject: [PATCH 40/59] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3343606..4c43710 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From aa76bd8e903f4e891ab0e82fde6d76b95b3004cb Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:19 -0400 Subject: [PATCH 41/59] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c43710..0e5fccc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From a89873057b9c0132642d2cda66c92a14c677648e Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:43 -0400 Subject: [PATCH 42/59] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} From 887c18c4927ddc843403633a218d3232bd60e20e Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:32 -0400 Subject: [PATCH 43/59] Update .pylintrc for v2.15.5 --- .pylintrc | 43 +++---------------------------------------- 1 file changed, 3 insertions(+), 40 deletions(-) diff --git a/.pylintrc b/.pylintrc index 66d688f..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --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,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# 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 @@ -225,12 +225,6 @@ max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # 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 @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([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 -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -309,21 +284,12 @@ 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 -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ From 954f5495811a2d4275eed99e5929e8a4ea63ffbf Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 10 Nov 2022 15:07:09 -0500 Subject: [PATCH 44/59] Fixed linting --- adafruit_as7341.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 6f7c696..75800a4 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -49,7 +49,9 @@ # Only needed for typing import busio # pylint: disable=unused-import - TCallable = TypeVar("TCallable", bound=Callable[..., Any]) + TCallable = TypeVar( # pylint: disable=invalid-name + "TCallable", bound=Callable[..., Any] + ) except ImportError: pass From 79a475da40fd10a180a2bd5ab361b13e7e27d2ce Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 18 Nov 2022 13:05:21 -0500 Subject: [PATCH 45/59] Added commented out board.STEMMA_I2C with explanation --- examples/as7341_batched_readings.py | 1 + examples/as7341_flicker_detection.py | 1 + examples/as7341_led_test.py | 1 + examples/as7341_simpletest.py | 1 + 4 files changed, 4 insertions(+) diff --git a/examples/as7341_batched_readings.py b/examples/as7341_batched_readings.py index c39c756..6a0074a 100644 --- a/examples/as7341_batched_readings.py +++ b/examples/as7341_batched_readings.py @@ -5,6 +5,7 @@ from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS7341(i2c) diff --git a/examples/as7341_flicker_detection.py b/examples/as7341_flicker_detection.py index 5a9d1a8..38cac7d 100644 --- a/examples/as7341_flicker_detection.py +++ b/examples/as7341_flicker_detection.py @@ -5,6 +5,7 @@ from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS7341(i2c) sensor.flicker_detection_enabled = True diff --git a/examples/as7341_led_test.py b/examples/as7341_led_test.py index 4e09a08..5586453 100644 --- a/examples/as7341_led_test.py +++ b/examples/as7341_led_test.py @@ -6,6 +6,7 @@ import adafruit_as7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = adafruit_as7341.AS7341(i2c) print("out of init!") diff --git a/examples/as7341_simpletest.py b/examples/as7341_simpletest.py index 24847a3..52f012d 100644 --- a/examples/as7341_simpletest.py +++ b/examples/as7341_simpletest.py @@ -5,6 +5,7 @@ from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS7341(i2c) From 2b0f52969c5e7791d2f9735ee68721fc9b59dd3e Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Sep 2022 20:16:31 -0400 Subject: [PATCH 46/59] Add .venv to .gitignore Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From 15c6c2ed91258ac71a836f79e4a4018c161b089b Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 47/59] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From 5772169dfed00899b5162780265a4b0cb48ada8b Mon Sep 17 00:00:00 2001 From: garyk10 <52009419+garyk10@users.noreply.github.com> Date: Wed, 5 Apr 2023 20:26:00 -0400 Subject: [PATCH 48/59] using _all_channels to update efficiently When not changing between low and high, the _channel_#_data was not being updated. Also, the clear and nir data is available when _low_channels_configured, so no need to change to high. --- adafruit_as7341.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 75800a4..8c2aebf 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -436,13 +436,13 @@ def channel_680nm(self) -> int: @property def channel_clear(self) -> int: """The current reading for the clear sensor""" - self._configure_f5_f8() + self._all_channels return self._channel_4_data @property def channel_nir(self) -> int: """The current reading for the NIR (near-IR) sensor""" - self._configure_f5_f8() + self._all_channels return self._channel_5_data def _wait_for_data(self, timeout: float = 1.0) -> None: @@ -465,6 +465,7 @@ def _configure_f1_f4(self) -> None: """Configure the sensor to read from elements F1-F4, Clear, and NIR""" # disable SP_EN bit while making config changes if self._low_channels_configured: + self._all_channels return self._high_channels_configured = False self._flicker_detection_1k_configured = False @@ -488,6 +489,7 @@ def _configure_f5_f8(self) -> None: """Configure the sensor to read from elements F5-F8, Clear, and NIR""" # disable SP_EN bit while making config changes if self._high_channels_configured: + self._all_channels return self._low_channels_configured = False From 0afda19db2d26a74f38e2e726759e526cb0717b9 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 17 Apr 2023 16:21:42 -0500 Subject: [PATCH 49/59] catch return from all_channels --- adafruit_as7341.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 8c2aebf..4135b1b 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -436,13 +436,13 @@ def channel_680nm(self) -> int: @property def channel_clear(self) -> int: """The current reading for the clear sensor""" - self._all_channels + _ = self._all_channels return self._channel_4_data @property def channel_nir(self) -> int: """The current reading for the NIR (near-IR) sensor""" - self._all_channels + _ = self._all_channels return self._channel_5_data def _wait_for_data(self, timeout: float = 1.0) -> None: @@ -465,7 +465,7 @@ def _configure_f1_f4(self) -> None: """Configure the sensor to read from elements F1-F4, Clear, and NIR""" # disable SP_EN bit while making config changes if self._low_channels_configured: - self._all_channels + _ = self._all_channels return self._high_channels_configured = False self._flicker_detection_1k_configured = False @@ -489,7 +489,7 @@ def _configure_f5_f8(self) -> None: """Configure the sensor to read from elements F5-F8, Clear, and NIR""" # disable SP_EN bit while making config changes if self._high_channels_configured: - self._all_channels + _ = self._all_channels return self._low_channels_configured = False From f48b94008d813597352d0b35c6648264c1df5c0d Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 50/59] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0e5fccc..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 8cfb19bc2ee7627a98a725964e9822b014be8dec Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:23:28 -0400 Subject: [PATCH 51/59] Run pre-commit --- adafruit_as7341.py | 2 -- examples/as7341_flicker_detection.py | 1 - examples/as7341_simpletest.py | 1 - 3 files changed, 4 deletions(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 75800a4..9b61306 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -352,7 +352,6 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member def __init__( self, i2c_bus: busio.I2C, address: int = _AS7341_I2CADDR_DEFAULT ) -> None: - self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) if not self._device_id in [_AS7341_DEVICE_ID]: raise RuntimeError("Failed to find an AS7341 sensor - check your wiring!") @@ -454,7 +453,6 @@ def _wait_for_data(self, timeout: float = 1.0) -> None: sleep(0.001) def _write_register(self, addr: int, data: int) -> None: - self._buffer[0] = addr self._buffer[1] = data diff --git a/examples/as7341_flicker_detection.py b/examples/as7341_flicker_detection.py index 38cac7d..fa249a9 100644 --- a/examples/as7341_flicker_detection.py +++ b/examples/as7341_flicker_detection.py @@ -10,7 +10,6 @@ sensor.flicker_detection_enabled = True while True: - flicker_detected = sensor.flicker_detected if flicker_detected: print("Detected a %d Hz flicker" % flicker_detected) diff --git a/examples/as7341_simpletest.py b/examples/as7341_simpletest.py index 52f012d..b6fed31 100644 --- a/examples/as7341_simpletest.py +++ b/examples/as7341_simpletest.py @@ -15,7 +15,6 @@ def bar_graph(read_value): while True: - print("F1 - 415nm/Violet %s" % bar_graph(sensor.channel_415nm)) print("F2 - 445nm//Indigo %s" % bar_graph(sensor.channel_445nm)) print("F3 - 480nm//Blue %s" % bar_graph(sensor.channel_480nm)) From 28dc163512909c9ed21955c2b92b9444d6bba105 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Thu, 11 May 2023 08:27:21 -0400 Subject: [PATCH 52/59] Linted per pre-commit --- adafruit_as7341.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 9b61306..65e9535 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -510,7 +510,7 @@ def _configure_f5_f8(self) -> None: def flicker_detected(self) -> Optional[int]: """The flicker frequency detected in Hertz""" if not self._flicker_detection_1k_configured: - AttributeError( + raise AttributeError( "Flicker detection must be enabled to access `flicker_detected`" ) flicker_status = self._fd_status From 64aed090e8357032bdfcb012ce5f4374e23109b6 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 23:44:32 -0400 Subject: [PATCH 53/59] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index c563ae4..131b803 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 2be8aa13fc48a777d22e3f53b6bbb43d3b930c4d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 19 Sep 2023 18:33:10 -0500 Subject: [PATCH 54/59] fix rtd theme --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 131b803..51f197a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -115,19 +115,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +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, From 91a9ef3eaa28fc1e3014a5aa4e8f07d28faa3ddf Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 4 Dec 2023 11:17:44 -0600 Subject: [PATCH 55/59] unpin sphinx and add sphinx-rtd-theme to docs reqs --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 From 0a7b934ce8a0c0bcdda18abc5d376aa37ae9301b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 56/59] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 51f197a..02db48a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -118,7 +118,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, From 8534556bbbe8e1ab8cb3aa9f1090a70ad551dab0 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Wed, 8 Jan 2025 09:05:55 -0500 Subject: [PATCH 57/59] adding_displayio_example --- docs/examples.rst | 9 +++++ examples/as3741_displayio_simpletest.py | 47 +++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 examples/as3741_displayio_simpletest.py diff --git a/docs/examples.rst b/docs/examples.rst index 3129057..8fe8a59 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -33,3 +33,12 @@ Example in how to get all the channel readings at the same time .. literalinclude:: ../examples/as7341_batched_readings.py :caption: examples/as7341_batched_readings.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/as3741_displayio_simpletest.py + :caption: examples/as3741_displayio_simpletest.py + :linenos: diff --git a/examples/as3741_displayio_simpletest.py b/examples/as3741_displayio_simpletest.py new file mode 100644 index 0000000..67df1cb --- /dev/null +++ b/examples/as3741_displayio_simpletest.py @@ -0,0 +1,47 @@ +# 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 terminalio import FONT +from displayio import Group +from adafruit_as7341 import AS7341 + +# 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 +sensor = AS7341(i2c) +sensor.flicker_detection_enabled = True + +# 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 + flicker_detected = sensor.flicker_detected + if flicker_detected: + display_output_label.text = f"Detected a {flicker_detected} Hz flicker" + else: + display_output_label.text = "No flicker detected" + # wait for a bit + time.sleep(0.5) From 8269a3af02963337f66978fd89c1d39816f63d7d Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 58/59] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) 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: From 06a2b18a086f08be785050b887b5dd79ecb3ef58 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 19:00:45 +0000 Subject: [PATCH 59/59] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 ------------------------ README.rst | 6 +- adafruit_as7341.py | 44 +-- docs/api.rst | 3 + docs/conf.py | 8 +- examples/as3741_displayio_simpletest.py | 4 +- examples/as7341_batched_readings.py | 2 + examples/as7341_flicker_detection.py | 2 + examples/as7341_led_test.py | 2 + examples/as7341_simpletest.py | 2 + ruff.toml | 105 +++++++ 13 files changed, 161 insertions(+), 470 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml 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 eefd09b..9aed05e 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_AS7341/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 use with the Adafruit AS7341 breakout. **NOTE**: Due to the size of this library, it may not work on M0 (ex: Trinket M0) and other diff --git a/adafruit_as7341.py b/adafruit_as7341.py index ff38125..9b4e489 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -35,23 +35,21 @@ __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AS7341.git" -from time import sleep, monotonic -from micropython import const -from adafruit_bus_device import i2c_device +from time import monotonic, sleep -from adafruit_register.i2c_struct import UnaryStruct, Struct # , ROUnaryStruct +from adafruit_bus_device import i2c_device from adafruit_register.i2c_bit import RWBit from adafruit_register.i2c_bits import ROBits, RWBits +from adafruit_register.i2c_struct import Struct, UnaryStruct # , ROUnaryStruct +from micropython import const try: - from typing import Tuple, Optional, Any, Callable, TypeVar + from typing import Any, Callable, Optional, Tuple, TypeVar # Only needed for typing - import busio # pylint: disable=unused-import + import busio - TCallable = TypeVar( # pylint: disable=invalid-name - "TCallable", bound=Callable[..., Any] - ) + TCallable = TypeVar("TCallable", bound=Callable[..., Any]) except ImportError: pass @@ -98,21 +96,13 @@ _AS7341_CH5_DATA_H: int = const(0xA0) # ADC Channel 5 Data _AS7341_STATUS2: int = const(0xA3) # Measurement status flags; saturation, validity _AS7341_STATUS3: int = const(0xA4) # Spectral interrupt source, high or low threshold -_AS7341_CFG0: int = const( - 0xA9 -) # Sets Low power mode, Register bank, and Trigger lengthening +_AS7341_CFG0: int = const(0xA9) # Sets Low power mode, Register bank, and Trigger lengthening _AS7341_CFG1: int = const(0xAA) # Controls ADC Gain _AS7341_CFG6: int = const(0xAF) # Used to configure Smux _AS7341_CFG9: int = const(0xB2) # flicker detect and SMUX command system ints -_AS7341_CFG12: int = const( - 0xB5 -) # ADC channel for interrupts, persistence and auto-gain -_AS7341_PERS = const( - 0xBD -) # number of measurements outside thresholds to trigger an interrupt -_AS7341_GPIO2 = const( - 0xBE -) # GPIO Settings and status: polarity, direction, sets output, reads +_AS7341_CFG12: int = const(0xB5) # ADC channel for interrupts, persistence and auto-gain +_AS7341_PERS = const(0xBD) # number of measurements outside thresholds to trigger an interrupt +_AS7341_GPIO2 = const(0xBE) # GPIO Settings and status: polarity, direction, sets output, reads _AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte _AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte _AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte @@ -163,7 +153,7 @@ def is_valid(cls, value: str) -> bool: # class Flicker(CV): # """Options for ``flicker_detection_type``""" -# pass # pylint: disable=unnecessary-pass +# pass # Flicker.add_values((("FLICKER_100HZ", 0, 100, None), ("FLICKER_1000HZ", 1, 1000, None))) @@ -349,11 +339,9 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member * @return true: success false: failure """ - def __init__( - self, i2c_bus: busio.I2C, address: int = _AS7341_I2CADDR_DEFAULT - ) -> None: + def __init__(self, i2c_bus: busio.I2C, address: int = _AS7341_I2CADDR_DEFAULT) -> None: self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) - if not self._device_id in [_AS7341_DEVICE_ID]: + if self._device_id not in {_AS7341_DEVICE_ID}: raise RuntimeError("Failed to find an AS7341 sensor - check your wiring!") self.initialize() self._buffer = bytearray(2) @@ -512,9 +500,7 @@ def _configure_f5_f8(self) -> None: def flicker_detected(self) -> Optional[int]: """The flicker frequency detected in Hertz""" if not self._flicker_detection_1k_configured: - raise AttributeError( - "Flicker detection must be enabled to access `flicker_detected`" - ) + raise AttributeError("Flicker detection must be enabled to access `flicker_detected`") flicker_status = self._fd_status if flicker_status == 45: diff --git a/docs/api.rst b/docs/api.rst index 4c70f7d..e3ef55f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. 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_as7341 :members: :exclude-members: CV, SMUX_IN, SMUX_OUT diff --git a/docs/conf.py b/docs/conf.py index 02db48a..61aead2 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("..")) @@ -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" diff --git a/examples/as3741_displayio_simpletest.py b/examples/as3741_displayio_simpletest.py index 67df1cb..122d2ad 100644 --- a/examples/as3741_displayio_simpletest.py +++ b/examples/as3741_displayio_simpletest.py @@ -4,10 +4,12 @@ # SPDX-License-Identifier: MIT import time + import board from adafruit_display_text.bitmap_label import Label -from terminalio import FONT from displayio import Group +from terminalio import FONT + from adafruit_as7341 import AS7341 # Simple demo of using the built-in display. diff --git a/examples/as7341_batched_readings.py b/examples/as7341_batched_readings.py index 6a0074a..1c87cfb 100644 --- a/examples/as7341_batched_readings.py +++ b/examples/as7341_batched_readings.py @@ -1,7 +1,9 @@ # SPDX-FileCopyrightText: 2020 Bryan Siepert, written for Adafruit Industries # SPDX-License-Identifier: MIT from time import sleep + import board + from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/as7341_flicker_detection.py b/examples/as7341_flicker_detection.py index fa249a9..458f27f 100644 --- a/examples/as7341_flicker_detection.py +++ b/examples/as7341_flicker_detection.py @@ -1,7 +1,9 @@ # SPDX-FileCopyrightText: 2020 Bryan Siepert, written for Adafruit Industries # SPDX-License-Identifier: MIT from time import sleep + import board + from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/as7341_led_test.py b/examples/as7341_led_test.py index 5586453..27ea766 100644 --- a/examples/as7341_led_test.py +++ b/examples/as7341_led_test.py @@ -2,7 +2,9 @@ # # SPDX-License-Identifier: MIT from time import sleep + import board + import adafruit_as7341 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/as7341_simpletest.py b/examples/as7341_simpletest.py index b6fed31..a3d7c9a 100644 --- a/examples/as7341_simpletest.py +++ b/examples/as7341_simpletest.py @@ -1,7 +1,9 @@ # SPDX-FileCopyrightText: 2020 Bryan Siepert, written for Adafruit Industries # SPDX-License-Identifier: MIT from time import sleep + import board + from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions +] + +[format] +line-ending = "lf"