From 5f2efcec8b56979e21d283b80f0e4aabf495e65a Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 01/65] Updated readthedocs file Signed-off-by: dherrada --- .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 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From 1d388b244fc7606e4b029b8c703ea7c930802051 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 12:59:40 -0600 Subject: [PATCH 02/65] 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 cf823bf6ef86d1408c0aaf2a6b2994d82ba4943c Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Wed, 22 Dec 2021 09:44:37 -0500 Subject: [PATCH 03/65] Update adafruit_bmp280.py --- adafruit_bmp280.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 5d0cd6c..d3a25fe 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -25,12 +25,9 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ import math +import struct from time import sleep -try: - import struct -except ImportError: - import ustruct as struct from micropython import const __version__ = "0.0.0-auto.0" From e3ef4b6a62d7fcc0a15e2910f9d14a5187a69559 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 04/65] 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 ca35544..474520d 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 7e930523715c262ffdda9e5a9916f3f300f12814 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:16 -0500 Subject: [PATCH 05/65] 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 7ab59ab..8cdb78c 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-bmp280/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/bmp280/en/latest/ + :target: https://docs.circuitpython.org/projects/bmp280/en/latest/ :alt: Documentation Status .. image :: https://img.shields.io/discord/327254708534116352.svg @@ -84,7 +84,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 edaf3e5..ebbc15a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -21,16 +21,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 9b9c6dd..912c6bd 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 3a8f246..9bc11fc 100644 --- a/setup.py +++ b/setup.py @@ -45,8 +45,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 bmp280 barometric pressure temperature hardware sensor micropython circuitpython", From 70b2eb4c3d02176d386afea17498a9bb9dd33fb2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Fri, 4 Feb 2022 21:10:47 -0500 Subject: [PATCH 06/65] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 7ab59ab..396d2ee 100644 --- a/README.rst +++ b/README.rst @@ -86,6 +86,8 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_.Travis will. This is a good way to + Contributing ============ @@ -93,8 +95,3 @@ 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 `_.Travis will. This is a good way to -locally verify it will pass. From 0ceeac86e96d5c44de4231b8031a1de2dc054940 Mon Sep 17 00:00:00 2001 From: Dan Halbert Date: Fri, 4 Feb 2022 21:16:42 -0500 Subject: [PATCH 07/65] remove trailing newlines in doc --- README.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/README.rst b/README.rst index 396d2ee..0238900 100644 --- a/README.rst +++ b/README.rst @@ -94,4 +94,3 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - From 163b21ea4a40ef1d5d4294b9455931e53db374e3 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Thu, 10 Feb 2022 11:59:05 -0500 Subject: [PATCH 08/65] Post-patch cleanup Manual fix after patch consolidating Documentation sections of READMEs --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7354537..a1565a0 100644 --- a/README.rst +++ b/README.rst @@ -86,7 +86,7 @@ Documentation API documentation for this library can be found on `Read the Docs `_. -For information on building library documentation, please check out `this guide `_.Travis will. This is a good way to +For information on building library documentation, please check out `this guide `_. Contributing ============ From 23c8a8833f2a60b1c3bcaf7fa1c8aaa7507161d8 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 09/65] 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 0eda7156476c43547af052581d7f30a85dda30d6 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 10/65] 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 b01a1c62731214a5ec84f2fafe8a5182741450d1 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 29 Mar 2022 18:15:43 -0400 Subject: [PATCH 11/65] "Reformatted per new black version" --- adafruit_bmp280.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index d3a25fe..92a800d 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -177,15 +177,15 @@ def _write_ctrl_meas(self): self._write_register_byte(_REGISTER_CTRL_MEAS, self._ctrl_meas) def _get_status(self): - """Get the value from the status register in the device """ + """Get the value from the status register in the device""" return self._read_byte(_REGISTER_STATUS) def _read_config(self): - """Read the value from the config register in the device """ + """Read the value from the config register in the device""" return self._read_byte(_REGISTER_CONFIG) def _write_config(self): - """Write the value to the config register in the device """ + """Write the value to the config register in the device""" normal_flag = False if self._mode == MODE_NORMAL: # Writes to the config register may be ignored while in Normal mode @@ -274,7 +274,7 @@ def iir_filter(self, value): @property def _config(self): - """Value to be written to the device's config register """ + """Value to be written to the device's config register""" config = 0 if self.mode == MODE_NORMAL: config += self._t_standby << 5 @@ -284,7 +284,7 @@ def _config(self): @property def _ctrl_meas(self): - """Value to be written to the device's ctrl_meas register """ + """Value to be written to the device's ctrl_meas register""" ctrl_meas = self.overscan_temperature << 5 ctrl_meas += self.overscan_pressure << 2 ctrl_meas += self.mode From f77c0c8205303dcc7e94d9591b201fdc8442bc14 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Sat, 9 Apr 2022 23:09:42 -0400 Subject: [PATCH 12/65] Tasks: 1-5, lines 210-272 --- adafruit_bmp280.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 92a800d..768d156 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -204,7 +204,7 @@ def mode(self): return self._mode @mode.setter - def mode(self, value): + def mode(self, value : int): if not value in _BMP280_MODES: raise ValueError("Mode '%s' not supported" % (value)) self._mode = value @@ -219,7 +219,7 @@ def standby_period(self): return self._t_standby @standby_period.setter - def standby_period(self, value): + def standby_period(self, value : int): if not value in _BMP280_STANDBY_TCS: raise ValueError("Standby Period '%s' not supported" % (value)) if self._t_standby == value: @@ -236,7 +236,7 @@ def overscan_temperature(self): return self._overscan_temperature @overscan_temperature.setter - def overscan_temperature(self, value): + def overscan_temperature(self, value : int): if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_temperature = value @@ -251,7 +251,7 @@ def overscan_pressure(self): return self._overscan_pressure @overscan_pressure.setter - def overscan_pressure(self, value): + def overscan_pressure(self, value : int): if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_pressure = value @@ -266,7 +266,7 @@ def iir_filter(self): return self._iir_filter @iir_filter.setter - def iir_filter(self, value): + def iir_filter(self, value : int): if not value in _BMP280_IIR_FILTERS: raise ValueError("IIR Filter '%s' not supported" % (value)) self._iir_filter = value From 3510969dae1c5927875e7a4664f62ce26d611d95 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Sat, 9 Apr 2022 23:27:55 -0400 Subject: [PATCH 13/65] Task 6-12, lines 377-454 --- adafruit_bmp280.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 768d156..d780ac8 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -371,11 +371,11 @@ def _read_coefficients(self): # print("%d %d %d" % (self._pressure_calib[6], self._pressure_calib[7], # self._pressure_calib[8])) - def _read_byte(self, register): + def _read_byte(self, register : int): """Read a byte register value and return it""" return self._read_register(register, 1)[0] - def _read24(self, register): + def _read24(self, register : int): """Read an unsigned 24-bit value as a floating point and return it.""" ret = 0.0 for b in self._read_register(register, 3): @@ -383,11 +383,11 @@ def _read24(self, register): ret += float(b & 0xFF) return ret - def _read_register(self, register, length): + def _read_register(self, register : int, length : int): """Low level register reading, not implemented in base class""" raise NotImplementedError() - def _write_register_byte(self, register, value): + def _write_register_byte(self, register : int, value : int): """Low level register writing, not implemented in base class""" raise NotImplementedError() @@ -433,7 +433,7 @@ class Adafruit_BMP280_I2C(Adafruit_BMP280): # pylint: disable=invalid-name """ - def __init__(self, i2c, address=0x77): + def __init__(self, i2c : int, address=0x77): from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel i2c_device, ) @@ -441,7 +441,7 @@ def __init__(self, i2c, address=0x77): self._i2c = i2c_device.I2CDevice(i2c, address) super().__init__() - def _read_register(self, register, length): + def _read_register(self, register : int, length : int): """Low level register reading over I2C, returns a list of values""" with self._i2c as i2c: i2c.write(bytes([register & 0xFF])) @@ -450,7 +450,7 @@ def _read_register(self, register, length): # print("$%02X => %s" % (register, [hex(i) for i in result])) return result - def _write_register_byte(self, register, value): + def _write_register_byte(self, register : int, value : int): """Low level register writing over I2C, writes one 8-bit value""" with self._i2c as i2c: i2c.write(bytes([register & 0xFF, value & 0xFF])) From 3ac35bc23e3932f44a7fce936237cd2c08493836 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Sat, 9 Apr 2022 23:48:02 -0400 Subject: [PATCH 14/65] completed remaining tasks for this issue. added return values imported SPI and DigitalInOut to use the types for __init__ on BMP_SPI. imported 'optional' from typing for the same function. --- adafruit_bmp280.py | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index d780ac8..a7a8b40 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -30,6 +30,15 @@ from micropython import const +# Used only for type annotations. +from busio import SPI +from digitalio import DigitalInOut + +try: + from typing import Optional +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BMP280.git" @@ -371,11 +380,11 @@ def _read_coefficients(self): # print("%d %d %d" % (self._pressure_calib[6], self._pressure_calib[7], # self._pressure_calib[8])) - def _read_byte(self, register : int): + def _read_byte(self, register : int) -> int: """Read a byte register value and return it""" return self._read_register(register, 1)[0] - def _read24(self, register : int): + def _read24(self, register : int) -> float: """Read an unsigned 24-bit value as a floating point and return it.""" ret = 0.0 for b in self._read_register(register, 3): @@ -441,7 +450,7 @@ def __init__(self, i2c : int, address=0x77): self._i2c = i2c_device.I2CDevice(i2c, address) super().__init__() - def _read_register(self, register : int, length : int): + def _read_register(self, register : int, length : int) -> bytearray: """Low level register reading over I2C, returns a list of values""" with self._i2c as i2c: i2c.write(bytes([register & 0xFF])) @@ -502,7 +511,7 @@ class Adafruit_BMP280_SPI(Adafruit_BMP280): """ - def __init__(self, spi, cs, baudrate=100000): + def __init__(self, spi : SPI, cs : Optional[DigitalInOut] = None, baudrate=100000) -> bytearray: from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel spi_device, ) @@ -510,7 +519,7 @@ def __init__(self, spi, cs, baudrate=100000): self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate) super().__init__() - def _read_register(self, register, length): + def _read_register(self, register : int, length : int): """Low level register reading over SPI, returns a list of values""" register = (register | 0x80) & 0xFF # Read single, bit 7 high. with self._spi as spi: @@ -521,7 +530,7 @@ def _read_register(self, register, length): # print("$%02X => %s" % (register, [hex(i) for i in result])) return result - def _write_register_byte(self, register, value): + def _write_register_byte(self, register : int, value : int): """Low level register writing over SPI, writes one 8-bit value""" register &= 0x7F # Write, bit 7 low. with self._spi as spi: From 1c52a8ad9ab2a7126b2f012e474709d6853dd278 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Sat, 9 Apr 2022 23:50:12 -0400 Subject: [PATCH 15/65] added license --- adafruit_bmp280.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index a7a8b40..039e091 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -2,6 +2,10 @@ # # SPDX-License-Identifier: MIT +# SPDX-FileCopyrightText: 2022 Bill Van Leeuwen for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """ `adafruit_bmp280` =============================================================================== From b121d566df8571277aae491b90d297fa4ad5eefe Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Sun, 10 Apr 2022 00:03:36 -0400 Subject: [PATCH 16/65] changes made by autotesting --- adafruit_bmp280.py | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 039e091..0d8aac9 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -217,7 +217,7 @@ def mode(self): return self._mode @mode.setter - def mode(self, value : int): + def mode(self, value: int): if not value in _BMP280_MODES: raise ValueError("Mode '%s' not supported" % (value)) self._mode = value @@ -232,7 +232,7 @@ def standby_period(self): return self._t_standby @standby_period.setter - def standby_period(self, value : int): + def standby_period(self, value: int): if not value in _BMP280_STANDBY_TCS: raise ValueError("Standby Period '%s' not supported" % (value)) if self._t_standby == value: @@ -249,7 +249,7 @@ def overscan_temperature(self): return self._overscan_temperature @overscan_temperature.setter - def overscan_temperature(self, value : int): + def overscan_temperature(self, value: int): if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_temperature = value @@ -264,7 +264,7 @@ def overscan_pressure(self): return self._overscan_pressure @overscan_pressure.setter - def overscan_pressure(self, value : int): + def overscan_pressure(self, value: int): if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_pressure = value @@ -279,7 +279,7 @@ def iir_filter(self): return self._iir_filter @iir_filter.setter - def iir_filter(self, value : int): + def iir_filter(self, value: int): if not value in _BMP280_IIR_FILTERS: raise ValueError("IIR Filter '%s' not supported" % (value)) self._iir_filter = value @@ -384,11 +384,11 @@ def _read_coefficients(self): # print("%d %d %d" % (self._pressure_calib[6], self._pressure_calib[7], # self._pressure_calib[8])) - def _read_byte(self, register : int) -> int: + def _read_byte(self, register: int) -> int: """Read a byte register value and return it""" return self._read_register(register, 1)[0] - def _read24(self, register : int) -> float: + def _read24(self, register: int) -> float: """Read an unsigned 24-bit value as a floating point and return it.""" ret = 0.0 for b in self._read_register(register, 3): @@ -396,11 +396,11 @@ def _read24(self, register : int) -> float: ret += float(b & 0xFF) return ret - def _read_register(self, register : int, length : int): + def _read_register(self, register: int, length: int): """Low level register reading, not implemented in base class""" raise NotImplementedError() - def _write_register_byte(self, register : int, value : int): + def _write_register_byte(self, register: int, value: int): """Low level register writing, not implemented in base class""" raise NotImplementedError() @@ -446,7 +446,7 @@ class Adafruit_BMP280_I2C(Adafruit_BMP280): # pylint: disable=invalid-name """ - def __init__(self, i2c : int, address=0x77): + def __init__(self, i2c: int, address=0x77): from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel i2c_device, ) @@ -454,7 +454,7 @@ def __init__(self, i2c : int, address=0x77): self._i2c = i2c_device.I2CDevice(i2c, address) super().__init__() - def _read_register(self, register : int, length : int) -> bytearray: + def _read_register(self, register: int, length: int) -> bytearray: """Low level register reading over I2C, returns a list of values""" with self._i2c as i2c: i2c.write(bytes([register & 0xFF])) @@ -463,7 +463,7 @@ def _read_register(self, register : int, length : int) -> bytearray: # print("$%02X => %s" % (register, [hex(i) for i in result])) return result - def _write_register_byte(self, register : int, value : int): + def _write_register_byte(self, register: int, value: int): """Low level register writing over I2C, writes one 8-bit value""" with self._i2c as i2c: i2c.write(bytes([register & 0xFF, value & 0xFF])) @@ -515,7 +515,9 @@ class Adafruit_BMP280_SPI(Adafruit_BMP280): """ - def __init__(self, spi : SPI, cs : Optional[DigitalInOut] = None, baudrate=100000) -> bytearray: + def __init__( + self, spi: SPI, cs: Optional[DigitalInOut] = None, baudrate=100000 + ) -> bytearray: from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel spi_device, ) @@ -523,7 +525,7 @@ def __init__(self, spi : SPI, cs : Optional[DigitalInOut] = None, baudrate=10000 self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate) super().__init__() - def _read_register(self, register : int, length : int): + def _read_register(self, register: int, length: int): """Low level register reading over SPI, returns a list of values""" register = (register | 0x80) & 0xFF # Read single, bit 7 high. with self._spi as spi: @@ -534,7 +536,7 @@ def _read_register(self, register : int, length : int): # print("$%02X => %s" % (register, [hex(i) for i in result])) return result - def _write_register_byte(self, register : int, value : int): + def _write_register_byte(self, register: int, value: int): """Low level register writing over SPI, writes one 8-bit value""" register &= 0x7F # Write, bit 7 low. with self._spi as spi: From 3441f1ff940d2b9d5d297325fd34cff54c784bbd Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 11:32:51 -0400 Subject: [PATCH 17/65] Moved type annotation imports into try/except --- adafruit_bmp280.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 0d8aac9..247a5d2 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -34,12 +34,14 @@ from micropython import const -# Used only for type annotations. -from busio import SPI -from digitalio import DigitalInOut try: from typing import Optional + + # Used only for type annotations. + from busio import SPI + from digitalio import DigitalInOut + except ImportError: pass From 6881ccc7539217b7df443d5e3fb64be0d3d09cac Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 11:44:27 -0400 Subject: [PATCH 18/65] added type annotation return values for getters up to line 300 --- adafruit_bmp280.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 247a5d2..2898576 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -191,11 +191,11 @@ def _write_ctrl_meas(self): """ self._write_register_byte(_REGISTER_CTRL_MEAS, self._ctrl_meas) - def _get_status(self): + def _get_status(self) -> int: """Get the value from the status register in the device""" return self._read_byte(_REGISTER_STATUS) - def _read_config(self): + def _read_config(self) -> int: """Read the value from the config register in the device""" return self._read_byte(_REGISTER_CONFIG) @@ -211,7 +211,7 @@ def _write_config(self): self.mode = MODE_NORMAL @property - def mode(self): + def mode(self) -> int: """ Operation mode Allowed values are set in the MODE enum class @@ -226,7 +226,7 @@ def mode(self, value: int): self._write_ctrl_meas() @property - def standby_period(self): + def standby_period(self) -> int: """ Control the inactive period when in Normal mode Allowed standby periods are set the STANDBY enum class @@ -243,7 +243,7 @@ def standby_period(self, value: int): self._write_config() @property - def overscan_temperature(self): + def overscan_temperature(self) -> int: """ Temperature Oversampling Allowed values are set in the OVERSCAN enum class @@ -258,7 +258,7 @@ def overscan_temperature(self, value: int): self._write_ctrl_meas() @property - def overscan_pressure(self): + def overscan_pressure(self) -> int: """ Pressure Oversampling Allowed values are set in the OVERSCAN enum class @@ -266,14 +266,14 @@ def overscan_pressure(self): return self._overscan_pressure @overscan_pressure.setter - def overscan_pressure(self, value: int): + def overscan_pressure(self, value: int) -> int: if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_pressure = value self._write_ctrl_meas() @property - def iir_filter(self): + def iir_filter(self) -> int: """ Controls the time constant of the IIR filter Allowed values are set in the IIR_FILTER enum class @@ -288,7 +288,7 @@ def iir_filter(self, value: int): self._write_config() @property - def _config(self): + def _config(self) -> int: """Value to be written to the device's config register""" config = 0 if self.mode == MODE_NORMAL: @@ -298,7 +298,7 @@ def _config(self): return config @property - def _ctrl_meas(self): + def _ctrl_meas(self) -> int: """Value to be written to the device's ctrl_meas register""" ctrl_meas = self.overscan_temperature << 5 ctrl_meas += self.overscan_pressure << 2 From 84f1bb4cf70bb4bccf6969c8a8585f2842239521 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 11:53:44 -0400 Subject: [PATCH 19/65] added return values to the remaining setters --- adafruit_bmp280.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 2898576..1d3fa5f 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -306,7 +306,7 @@ def _ctrl_meas(self) -> int: return ctrl_meas @property - def measurement_time_typical(self): + def measurement_time_typical(self) -> float: """Typical time in milliseconds required to complete a measurement in normal mode""" meas_time_ms = 1 if self.overscan_temperature != OVERSCAN_DISABLE: @@ -316,7 +316,7 @@ def measurement_time_typical(self): return meas_time_ms @property - def measurement_time_max(self): + def measurement_time_max(self) -> float: """Maximum time in milliseconds required to complete a measurement in normal mode""" meas_time_ms = 1.25 if self.overscan_temperature != OVERSCAN_DISABLE: @@ -326,13 +326,13 @@ def measurement_time_max(self): return meas_time_ms @property - def temperature(self): + def temperature(self) -> float: """The compensated temperature in degrees Celsius.""" self._read_temperature() return self._t_fine / 5120.0 @property - def pressure(self): + def pressure(self) -> Optional[float]: """ The compensated pressure in hectoPascals. returns `None` if pressure measurement is disabled @@ -363,7 +363,7 @@ def pressure(self): return pressure @property - def altitude(self): + def altitude(self) -> float: """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - which you must enter ahead of time)""" p = self.pressure # in Si units for hPascal From afbd53527d6bc0b129ea6064653ad2f65f10a585 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 11:54:29 -0400 Subject: [PATCH 20/65] Grammar mistake in last commit message. Getters instead of setters Revert "added return values to the remaining setters" This reverts commit 84f1bb4cf70bb4bccf6969c8a8585f2842239521. --- adafruit_bmp280.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 1d3fa5f..2898576 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -306,7 +306,7 @@ def _ctrl_meas(self) -> int: return ctrl_meas @property - def measurement_time_typical(self) -> float: + def measurement_time_typical(self): """Typical time in milliseconds required to complete a measurement in normal mode""" meas_time_ms = 1 if self.overscan_temperature != OVERSCAN_DISABLE: @@ -316,7 +316,7 @@ def measurement_time_typical(self) -> float: return meas_time_ms @property - def measurement_time_max(self) -> float: + def measurement_time_max(self): """Maximum time in milliseconds required to complete a measurement in normal mode""" meas_time_ms = 1.25 if self.overscan_temperature != OVERSCAN_DISABLE: @@ -326,13 +326,13 @@ def measurement_time_max(self) -> float: return meas_time_ms @property - def temperature(self) -> float: + def temperature(self): """The compensated temperature in degrees Celsius.""" self._read_temperature() return self._t_fine / 5120.0 @property - def pressure(self) -> Optional[float]: + def pressure(self): """ The compensated pressure in hectoPascals. returns `None` if pressure measurement is disabled @@ -363,7 +363,7 @@ def pressure(self) -> Optional[float]: return pressure @property - def altitude(self) -> float: + def altitude(self): """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - which you must enter ahead of time)""" p = self.pressure # in Si units for hPascal From 330cbb0d6cac275626288ecc3333d006538b68a0 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 11:57:25 -0400 Subject: [PATCH 21/65] added return types for remaining getters --- adafruit_bmp280.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 2898576..1d3fa5f 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -306,7 +306,7 @@ def _ctrl_meas(self) -> int: return ctrl_meas @property - def measurement_time_typical(self): + def measurement_time_typical(self) -> float: """Typical time in milliseconds required to complete a measurement in normal mode""" meas_time_ms = 1 if self.overscan_temperature != OVERSCAN_DISABLE: @@ -316,7 +316,7 @@ def measurement_time_typical(self): return meas_time_ms @property - def measurement_time_max(self): + def measurement_time_max(self) -> float: """Maximum time in milliseconds required to complete a measurement in normal mode""" meas_time_ms = 1.25 if self.overscan_temperature != OVERSCAN_DISABLE: @@ -326,13 +326,13 @@ def measurement_time_max(self): return meas_time_ms @property - def temperature(self): + def temperature(self) -> float: """The compensated temperature in degrees Celsius.""" self._read_temperature() return self._t_fine / 5120.0 @property - def pressure(self): + def pressure(self) -> Optional[float]: """ The compensated pressure in hectoPascals. returns `None` if pressure measurement is disabled @@ -363,7 +363,7 @@ def pressure(self): return pressure @property - def altitude(self): + def altitude(self) -> float: """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - which you must enter ahead of time)""" p = self.pressure # in Si units for hPascal From d54396bd11a5a2959391547c939f5e223813e468 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 12:30:42 -0400 Subject: [PATCH 22/65] added return types. all 'None' to setters and other functions. changed a return type from int to None which i set wrong in an earlier commit --- adafruit_bmp280.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 1d3fa5f..80e51b6 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -136,7 +136,7 @@ class Adafruit_BMP280: # pylint: disable=invalid-name """ - def __init__(self): + def __init__(self) -> None: # Check device ID. chip_id = self._read_byte(_REGISTER_CHIPID) if _CHIP_ID != chip_id: @@ -155,7 +155,7 @@ def __init__(self): """Pressure in hectoPascals at sea level. Used to calibrate `altitude`.""" self._t_fine = None - def _read_temperature(self): + def _read_temperature(self) -> None: # perform one measurement if self.mode != MODE_NORMAL: self.mode = MODE_FORCE @@ -179,12 +179,12 @@ def _read_temperature(self): self._t_fine = int(var1 + var2) # print("t_fine: ", self.t_fine) - def _reset(self): + def _reset(self) -> None: """Soft reset the sensor""" self._write_register_byte(_REGISTER_SOFTRESET, 0xB6) sleep(0.004) # Datasheet says 2ms. Using 4ms just to be safe - def _write_ctrl_meas(self): + def _write_ctrl_meas(self) -> None: """ Write the values to the ctrl_meas register in the device ctrl_meas sets the pressure and temperature data acquisition options @@ -199,7 +199,7 @@ def _read_config(self) -> int: """Read the value from the config register in the device""" return self._read_byte(_REGISTER_CONFIG) - def _write_config(self): + def _write_config(self) -> None: """Write the value to the config register in the device""" normal_flag = False if self._mode == MODE_NORMAL: @@ -219,7 +219,7 @@ def mode(self) -> int: return self._mode @mode.setter - def mode(self, value: int): + def mode(self, value: int) -> None: if not value in _BMP280_MODES: raise ValueError("Mode '%s' not supported" % (value)) self._mode = value @@ -234,7 +234,7 @@ def standby_period(self) -> int: return self._t_standby @standby_period.setter - def standby_period(self, value: int): + def standby_period(self, value: int) -> None: if not value in _BMP280_STANDBY_TCS: raise ValueError("Standby Period '%s' not supported" % (value)) if self._t_standby == value: @@ -251,7 +251,7 @@ def overscan_temperature(self) -> int: return self._overscan_temperature @overscan_temperature.setter - def overscan_temperature(self, value: int): + def overscan_temperature(self, value: int) -> None: if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_temperature = value @@ -266,7 +266,7 @@ def overscan_pressure(self) -> int: return self._overscan_pressure @overscan_pressure.setter - def overscan_pressure(self, value: int) -> int: + def overscan_pressure(self, value: int) -> None: if not value in _BMP280_OVERSCANS: raise ValueError("Overscan value '%s' not supported" % (value)) self._overscan_pressure = value @@ -281,7 +281,7 @@ def iir_filter(self) -> int: return self._iir_filter @iir_filter.setter - def iir_filter(self, value: int): + def iir_filter(self, value: int) -> None: if not value in _BMP280_IIR_FILTERS: raise ValueError("IIR Filter '%s' not supported" % (value)) self._iir_filter = value From 7b1afa36a81e8b9cb0e96d3781a37f2abafc2467 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 12:32:32 -0400 Subject: [PATCH 23/65] finished all type annotations in the base BMP280 class --- adafruit_bmp280.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 80e51b6..7597cd8 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -370,7 +370,7 @@ def altitude(self) -> float: return 44330 * (1.0 - math.pow(p / self.sea_level_pressure, 0.1903)) ####################### Internal helpers ################################ - def _read_coefficients(self): + def _read_coefficients(self) -> None: """Read & save the calibration coefficients""" coeff = self._read_register(_REGISTER_DIG_T1, 24) coeff = list(struct.unpack(" float: ret += float(b & 0xFF) return ret - def _read_register(self, register: int, length: int): + def _read_register(self, register: int, length: int) -> None: """Low level register reading, not implemented in base class""" raise NotImplementedError() - def _write_register_byte(self, register: int, value: int): + def _write_register_byte(self, register: int, value: int) -> None: """Low level register writing, not implemented in base class""" raise NotImplementedError() From 532f1449acb3ac45d5c21db05ca5cf3b34a45b6f Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 12:35:57 -0400 Subject: [PATCH 24/65] changed the init func in the I2C class to have proper type. imported I2C from busio.i2c --- adafruit_bmp280.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 7597cd8..e588cbb 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -39,7 +39,7 @@ from typing import Optional # Used only for type annotations. - from busio import SPI + from busio import SPI, I2C from digitalio import DigitalInOut except ImportError: @@ -448,7 +448,7 @@ class Adafruit_BMP280_I2C(Adafruit_BMP280): # pylint: disable=invalid-name """ - def __init__(self, i2c: int, address=0x77): + def __init__(self, i2c: I2C, address: int = 0x77) -> None: from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel i2c_device, ) From 034be01a5a07284dd01bce440b485839deaab601 Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 12:39:38 -0400 Subject: [PATCH 25/65] corrected the Optional[DigitalInOut] to not default as none for the init func on the SPI class. Added return types for a few more fucntions --- adafruit_bmp280.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index e588cbb..b6ae583 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -465,7 +465,7 @@ def _read_register(self, register: int, length: int) -> bytearray: # print("$%02X => %s" % (register, [hex(i) for i in result])) return result - def _write_register_byte(self, register: int, value: int): + def _write_register_byte(self, register: int, value: int) -> None: """Low level register writing over I2C, writes one 8-bit value""" with self._i2c as i2c: i2c.write(bytes([register & 0xFF, value & 0xFF])) @@ -518,7 +518,7 @@ class Adafruit_BMP280_SPI(Adafruit_BMP280): """ def __init__( - self, spi: SPI, cs: Optional[DigitalInOut] = None, baudrate=100000 + self, spi: SPI, cs: Optional[DigitalInOut], baudrate=100000 ) -> bytearray: from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel spi_device, @@ -527,7 +527,7 @@ def __init__( self._spi = spi_device.SPIDevice(spi, cs, baudrate=baudrate) super().__init__() - def _read_register(self, register: int, length: int): + def _read_register(self, register: int, length: int) -> bytearray: """Low level register reading over SPI, returns a list of values""" register = (register | 0x80) & 0xFF # Read single, bit 7 high. with self._spi as spi: @@ -538,7 +538,7 @@ def _read_register(self, register: int, length: int): # print("$%02X => %s" % (register, [hex(i) for i in result])) return result - def _write_register_byte(self, register: int, value: int): + def _write_register_byte(self, register: int, value: int) -> None: """Low level register writing over SPI, writes one 8-bit value""" register &= 0x7F # Write, bit 7 low. with self._spi as spi: From 893e8988df5c43ef3d74cf485185b3c18deec63c Mon Sep 17 00:00:00 2001 From: "billvanleeuwen424@gmail.com" Date: Mon, 11 Apr 2022 17:37:36 -0400 Subject: [PATCH 26/65] Changed init func on line 520 as per review comments --- adafruit_bmp280.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index b6ae583..f7b0a78 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -517,9 +517,7 @@ class Adafruit_BMP280_SPI(Adafruit_BMP280): """ - def __init__( - self, spi: SPI, cs: Optional[DigitalInOut], baudrate=100000 - ) -> bytearray: + def __init__(self, spi: SPI, cs: DigitalInOut, baudrate=100000) -> None: from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel spi_device, ) From 1c81260efade9f2f1931c7d2e0d941fd83cd626a Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 27/65] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 9647e71..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From f923e1d4bdeb2661c09ca248d9aaf694a13ffb8f Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:58:28 -0400 Subject: [PATCH 28/65] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a1565a0..6bd9d66 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/bmp280/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 2253a27ec2ca0a4b395f3b7e8f3cbc4a2546a124 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:49:39 -0500 Subject: [PATCH 29/65] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 6bd9d66..c55736a 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/bmp280/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 f2aa5b5ac28efe3ed571a7881d7ecf62e0c9639b Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:19:52 -0400 Subject: [PATCH 30/65] 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 7d0cd64f922d74433882483522f5ebec7aad1d43 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 31/65] 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 cfd1c41..f006a4a 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 0581427b6f23699c10482895a25240305e92e350 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 32/65] 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 f006a4a..f772971 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 d40ef309320f14b58d1361cddf03e66fea077249 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 33/65] 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 ebbc15a..045a643 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,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 04638d84e461d7e84f20a272a7c9bec869c117cf Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:09 -0400 Subject: [PATCH 34/65] 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 912c6bd..6c3e21a 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 0ddaae7c443acb91192613deeb50f946d567887d Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:58:36 -0400 Subject: [PATCH 35/65] 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 c55736a..f9fca95 100644 --- a/README.rst +++ b/README.rst @@ -49,8 +49,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-bmp280 Usage Example From 10ef29322cadea740dfbd1e730115c073b231dc6 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:00:25 -0400 Subject: [PATCH 36/65] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index f9fca95..c7925e5 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BMP280/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 + CircuitPython driver from BMP280 Temperature and Barometic Pressure sensor Installation and Dependencies From 9bd28c14d85335478c46f11a2e82cc5ceca75cc5 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:52 -0400 Subject: [PATCH 37/65] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++------ .github/workflows/release.yml | 17 ++++++----- optional_requirements.txt | 3 ++ pyproject.toml | 47 ++++++++++++++++++++++++++++++ requirements.txt | 4 +-- setup.py | 54 ----------------------------------- 6 files changed, 72 insertions(+), 71 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ 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 @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - 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: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + 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: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 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 new file mode 100644 index 0000000..510cba9 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-bmp280" +description = "CircuitPython driver for the BMP280." +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_BMP280"} +keywords = [ + "adafruit", + "bmp280", + "barometric", + "pressure", + "temperature", + "hardware", + "sensor", + "micropython", + "circuitpython", +] +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_bmp280"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index f162505..fcef575 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-busdevice adafruit-circuitpython-register +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py deleted file mode 100644 index 9bc11fc..0000000 --- a/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 -""" - -# Always prefer setuptools over distutils -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-bmp280", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython driver for the BMP280.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_BMP280", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"], - # 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 bmp280 barometric pressure temperature hardware sensor micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_bmp280"], -) From 57e72873d6591724140762926225566f0e5487f0 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 38/65] 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 510cba9..b6f0a9b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 36a8712bedb036ed6ba08b6608e93f461a7bf154 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:13 -0400 Subject: [PATCH 39/65] Update version string --- adafruit_bmp280.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index f7b0a78..6ab9b1b 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -45,7 +45,7 @@ except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BMP280.git" # I2C ADDRESS/BITS/SETTINGS diff --git a/pyproject.toml b/pyproject.toml index b6f0a9b..38995eb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-bmp280" description = "CircuitPython driver for the BMP280." -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From cf7a726afc6078a60f517f1bfb732ea5dd19e94c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:13 -0400 Subject: [PATCH 40/65] 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 36e778685a9b14987d359ff67c402cef6295d1b9 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:30 -0400 Subject: [PATCH 41/65] 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 045a643..ff3f183 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("..")) @@ -43,7 +44,8 @@ # General information about the project. project = "Adafruit BMP280 Library" -copyright = "2017 ladyada" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From d1f292183bec11da199b4457f09477d12c6567c7 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:20 -0400 Subject: [PATCH 42/65] 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 ff3f183..11ddadd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,14 @@ # General information about the project. project = "Adafruit BMP280 Library" +creation_year = "2017" current_year = str(datetime.datetime.now().year) -copyright = current_year + " ladyada" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From cbbe69b0e7162fcda0faf5b483bda9a89b709f3d 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 43/65] 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 6d8c6ac91a0d3dae048d8f313a8a401b3ef4b137 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 44/65] 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 952b90c5be3c7519d4028a669a4fe619b28c8e3f 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 45/65] 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 3f05c7b69b6f1eb04f37aebba651941961786fc5 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 46/65] 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 10d8e3600c1e9d86066b35eb043837c7106e714c 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 47/65] Update .pylintrc for v2.15.5 --- .pylintrc | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.pylintrc b/.pylintrc index f772971..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -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 732541cfcfc0c02f4163d2f159a504f2bfa5c5cb Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 18 Nov 2022 13:05:21 -0500 Subject: [PATCH 48/65] Added commented out board.STEMMA_I2C with explanation --- examples/bmp280_normal_mode.py | 1 + examples/bmp280_simpletest.py | 1 + 2 files changed, 2 insertions(+) diff --git a/examples/bmp280_normal_mode.py b/examples/bmp280_normal_mode.py index b5d87c8..bc1babb 100644 --- a/examples/bmp280_normal_mode.py +++ b/examples/bmp280_normal_mode.py @@ -12,6 +12,7 @@ # Create sensor object, communicating over the board's default I2C bus i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller bmp280 = adafruit_bmp280.Adafruit_BMP280_I2C(i2c) # OR Create sensor object, communicating over the board's default SPI bus diff --git a/examples/bmp280_simpletest.py b/examples/bmp280_simpletest.py index 004f737..e2b138a 100644 --- a/examples/bmp280_simpletest.py +++ b/examples/bmp280_simpletest.py @@ -11,6 +11,7 @@ # Create sensor object, communicating over the board's default I2C bus i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller bmp280 = adafruit_bmp280.Adafruit_BMP280_I2C(i2c) # OR Create sensor object, communicating over the board's default SPI bus From 514c386a08c6030e90fb626e3aed89c8e25e2da4 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 49/65] 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 9c9721c21f6bff5d8e97d7ea24c9a0605f47263c 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 50/65] 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 826eed3da0e9c854f98cef8a5289e191319a455f Mon Sep 17 00:00:00 2001 From: Andrew Smith Date: Mon, 8 May 2023 17:07:17 -0700 Subject: [PATCH 51/65] Add Calculated Sea Level Pressure based on Altitude --- adafruit_bmp280.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 6ab9b1b..9586f50 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -368,6 +368,14 @@ def altitude(self) -> float: - which you must enter ahead of time)""" p = self.pressure # in Si units for hPascal return 44330 * (1.0 - math.pow(p / self.sea_level_pressure, 0.1903)) + + @property + def p0(self, altitude_m=0.0) -> float: + """The calculated sea level pressure based on altitude (:attr:`altitude`) + - which you must enter ahead of time)""" + p = self.pressure # in Si units for hPascal + p0 = p / math.pow(1.0 - altitude_m/44330.0, 5.255) + return p0 ####################### Internal helpers ################################ def _read_coefficients(self) -> None: From 0437e0517382e5b1b733760bff375a6b72804177 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 52/65] 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 30f3f8fbde9e37bfa38d6ddaad97b2044d2518e6 Mon Sep 17 00:00:00 2001 From: Andrew Smith Date: Sat, 13 May 2023 11:00:43 -0700 Subject: [PATCH 53/65] Update to Altitude setter --- adafruit_bmp280.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 9586f50..ebf8f76 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -369,13 +369,10 @@ def altitude(self) -> float: p = self.pressure # in Si units for hPascal return 44330 * (1.0 - math.pow(p / self.sea_level_pressure, 0.1903)) - @property - def p0(self, altitude_m=0.0) -> float: - """The calculated sea level pressure based on altitude (:attr:`altitude`) - - which you must enter ahead of time)""" + @altitude.setter + def altitude(self, value: float) -> None: p = self.pressure # in Si units for hPascal - p0 = p / math.pow(1.0 - altitude_m/44330.0, 5.255) - return p0 + self.sea_level_pressure = p / math.pow(1.0 - value/44330.0, 5.255) ####################### Internal helpers ################################ def _read_coefficients(self) -> None: From 480912ac032eafbb0ce923642522f5c848d5d9f1 Mon Sep 17 00:00:00 2001 From: Andrew Smith Date: Sun, 14 May 2023 13:56:16 -0700 Subject: [PATCH 54/65] formatted with black --- adafruit_bmp280.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index ebf8f76..2af58b9 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -368,11 +368,11 @@ def altitude(self) -> float: - which you must enter ahead of time)""" p = self.pressure # in Si units for hPascal return 44330 * (1.0 - math.pow(p / self.sea_level_pressure, 0.1903)) - + @altitude.setter def altitude(self, value: float) -> None: p = self.pressure # in Si units for hPascal - self.sea_level_pressure = p / math.pow(1.0 - value/44330.0, 5.255) + self.sea_level_pressure = p / math.pow(1.0 - value / 44330.0, 5.255) ####################### Internal helpers ################################ def _read_coefficients(self) -> None: From 0106817f511c068227c0fedb6b51714ff8bce4d0 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 22:01:02 -0400 Subject: [PATCH 55/65] 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 11ddadd..0cd3e46 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.viewcode", ] 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 2e81b1cbb4456eb570cb128c12109588d3914dc2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:22:32 -0500 Subject: [PATCH 56/65] "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 0cd3e46..ebe301b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,19 +100,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 ee4b5fafead993dc9ba22ccd07545ca530812bfc Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 57/65] unpin sphinx and add sphinx-rtd-theme to docs reqs Signed-off-by: foamyguy --- 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 2651d73aa2a51244b992dfd78c82125c843db997 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 58/65] 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 ebe301b..6d0c4e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -103,7 +103,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 2a3d158b62401bc20e4943b2144583e5b6048579 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 11 Dec 2024 10:46:20 -0600 Subject: [PATCH 59/65] change CS pin to D5 --- examples/bmp280_normal_mode.py | 2 +- examples/bmp280_simpletest.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/bmp280_normal_mode.py b/examples/bmp280_normal_mode.py index bc1babb..e2ac59c 100644 --- a/examples/bmp280_normal_mode.py +++ b/examples/bmp280_normal_mode.py @@ -17,7 +17,7 @@ # OR Create sensor object, communicating over the board's default SPI bus # spi = busio.SPI() -# bmp_cs = digitalio.DigitalInOut(board.D10) +# bmp_cs = digitalio.DigitalInOut(board.D5) # bmp280 = adafruit_bmp280.Adafruit_BMP280_SPI(spi, bmp_cs) # change this to match the location's pressure (hPa) at sea level diff --git a/examples/bmp280_simpletest.py b/examples/bmp280_simpletest.py index e2b138a..8af6f62 100644 --- a/examples/bmp280_simpletest.py +++ b/examples/bmp280_simpletest.py @@ -16,7 +16,7 @@ # OR Create sensor object, communicating over the board's default SPI bus # spi = board.SPI() -# bmp_cs = digitalio.DigitalInOut(board.D10) +# bmp_cs = digitalio.DigitalInOut(board.D5) # bmp280 = adafruit_bmp280.Adafruit_BMP280_SPI(spi, bmp_cs) # change this to match the location's pressure (hPa) at sea level From c229d64e8121ac36985b52f528ed8ed252e367d5 Mon Sep 17 00:00:00 2001 From: JPOSADA202020 Date: Thu, 12 Dec 2024 08:22:42 -0500 Subject: [PATCH 60/65] adding_displayio_example --- docs/examples.rst | 9 +++++ examples/bmp280_displayio_simpletest.py | 48 +++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 examples/bmp280_displayio_simpletest.py diff --git a/docs/examples.rst b/docs/examples.rst index fb3b0db..3155cf0 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -16,3 +16,12 @@ parameters supported by the sensor. .. literalinclude:: ../examples/bmp280_normal_mode.py :caption: examples/bmp280_normal_mode.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/bmp280_displayio_simpletest.py + :caption: examples/bmp280_displayio_simpletest.py + :linenos: diff --git a/examples/bmp280_displayio_simpletest.py b/examples/bmp280_displayio_simpletest.py new file mode 100644 index 0000000..8ef3468 --- /dev/null +++ b/examples/bmp280_displayio_simpletest.py @@ -0,0 +1,48 @@ +# 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 +import adafruit_bmp280 + +# Simple demo of the BMP280 barometric pressure sensor. +# 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 +bmp280 = adafruit_bmp280.Adafruit_BMP280_I2C(i2c) + +# change this to match the location's pressure (hPa) at sea level +bmp280.sea_level_pressure = 1013.25 + +# Create two Labels to show the readings. If you have a very small +# display you may need to change to scale=1. +tempandpress_output_label = Label(FONT, text="", scale=2) +altitude_output_label = Label(FONT, text="", scale=2) + +# place the labels in the middle of the screen with anchored positioning +tempandpress_output_label.anchor_point = (0, 0) +tempandpress_output_label.anchored_position = (4, board.DISPLAY.height // 2) +altitude_output_label.anchor_point = (0, 0) +altitude_output_label.anchored_position = (4, board.DISPLAY.height // 2 + 20) + + +# add the label to the main_group +main_group.append(tempandpress_output_label) +main_group.append(altitude_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 label.text property to change the text on the display + tempandpress_output_label.text = f"Temperature:{bmp280.temperature:0.1f} C, Pressure:{bmp280.pressure:0.1f} hPa" + altitude_output_label.text = f"Altitude:{bmp280.altitude:0.2f} mts" + # wait for a bit + time.sleep(2.0) From a39983ef6e6cd23b1f3748fde62b72fbff063c80 Mon Sep 17 00:00:00 2001 From: JPOSADA202020 Date: Thu, 12 Dec 2024 08:27:44 -0500 Subject: [PATCH 61/65] fixinf_line --- examples/bmp280_displayio_simpletest.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/bmp280_displayio_simpletest.py b/examples/bmp280_displayio_simpletest.py index 8ef3468..9f62dc9 100644 --- a/examples/bmp280_displayio_simpletest.py +++ b/examples/bmp280_displayio_simpletest.py @@ -42,7 +42,9 @@ # begin main loop while True: # Update the label.text property to change the text on the display - tempandpress_output_label.text = f"Temperature:{bmp280.temperature:0.1f} C, Pressure:{bmp280.pressure:0.1f} hPa" + tempandpress_output_label.text = ( + f"Temperature:{bmp280.temperature:0.1f} C, Pressure:{bmp280.pressure:0.1f} hPa" + ) altitude_output_label.text = f"Altitude:{bmp280.altitude:0.2f} mts" # wait for a bit time.sleep(2.0) From 417a68c6eb3aa3efa671024977ed91db15f7fc5f Mon Sep 17 00:00:00 2001 From: JPOSADA202020 Date: Thu, 12 Dec 2024 11:39:21 -0500 Subject: [PATCH 62/65] improving_labels_loc --- examples/bmp280_displayio_simpletest.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/examples/bmp280_displayio_simpletest.py b/examples/bmp280_displayio_simpletest.py index 9f62dc9..853559c 100644 --- a/examples/bmp280_displayio_simpletest.py +++ b/examples/bmp280_displayio_simpletest.py @@ -27,7 +27,10 @@ # place the labels in the middle of the screen with anchored positioning tempandpress_output_label.anchor_point = (0, 0) -tempandpress_output_label.anchored_position = (4, board.DISPLAY.height // 2) +tempandpress_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 40, +) altitude_output_label.anchor_point = (0, 0) altitude_output_label.anchored_position = (4, board.DISPLAY.height // 2 + 20) @@ -43,7 +46,7 @@ while True: # Update the label.text property to change the text on the display tempandpress_output_label.text = ( - f"Temperature:{bmp280.temperature:0.1f} C, Pressure:{bmp280.pressure:0.1f} hPa" + f"Temperature:{bmp280.temperature:0.1f} C \nPressure:{bmp280.pressure:0.1f} hPa" ) altitude_output_label.text = f"Altitude:{bmp280.altitude:0.2f} mts" # wait for a bit From f4bba4fe2326d0bbeb9c121614c7e807076f4c13 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 63/65] 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 f2811931bac6b5483eb9597391e226c2a65433e5 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 19:38:19 +0000 Subject: [PATCH 64/65] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 ------------------------ README.rst | 6 +- adafruit_bmp280.py | 22 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/bmp280_displayio_simpletest.py | 4 +- examples/bmp280_normal_mode.py | 3 + examples/bmp280_simpletest.py | 4 +- ruff.toml | 105 +++++++ 11 files changed, 152 insertions(+), 456 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 c7925e5..e3ec000 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BMP280/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 driver from BMP280 Temperature and Barometic Pressure sensor diff --git a/adafruit_bmp280.py b/adafruit_bmp280.py index 2af58b9..6080e19 100644 --- a/adafruit_bmp280.py +++ b/adafruit_bmp280.py @@ -28,18 +28,18 @@ https://github.com/adafruit/circuitpython/releases * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ + import math import struct from time import sleep from micropython import const - try: from typing import Optional # Used only for type annotations. - from busio import SPI, I2C + from busio import I2C, SPI from digitalio import DigitalInOut except ImportError: @@ -125,7 +125,7 @@ ) -class Adafruit_BMP280: # pylint: disable=invalid-name +class Adafruit_BMP280: """Base BMP280 object. Use :class:`Adafruit_BMP280_I2C` or :class:`Adafruit_BMP280_SPI` instead of this. This checks the BMP280 was found, reads the coefficients and enables the sensor for continuous reads @@ -162,13 +162,9 @@ def _read_temperature(self) -> None: # Wait for conversion to complete while self._get_status() & 0x08: sleep(0.002) - raw_temperature = ( - self._read24(_REGISTER_TEMPDATA) / 16 - ) # lowest 4 bits get dropped + raw_temperature = self._read24(_REGISTER_TEMPDATA) / 16 # lowest 4 bits get dropped # print("raw temp: ", UT) - var1 = ( - raw_temperature / 16384.0 - self._temp_calib[0] / 1024.0 - ) * self._temp_calib[1] + var1 = (raw_temperature / 16384.0 - self._temp_calib[0] / 1024.0) * self._temp_calib[1] # print(var1) var2 = ( (raw_temperature / 131072.0 - self._temp_calib[0] / 8192.0) @@ -412,7 +408,7 @@ def _write_register_byte(self, register: int, value: int) -> None: raise NotImplementedError() -class Adafruit_BMP280_I2C(Adafruit_BMP280): # pylint: disable=invalid-name +class Adafruit_BMP280_I2C(Adafruit_BMP280): """Driver for I2C connected BMP280. :param ~busio.I2C i2c: The I2C bus the BMP280 is connected to. @@ -454,7 +450,7 @@ class Adafruit_BMP280_I2C(Adafruit_BMP280): # pylint: disable=invalid-name """ def __init__(self, i2c: I2C, address: int = 0x77) -> None: - from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel + from adafruit_bus_device import ( # noqa: PLC0415 i2c_device, ) @@ -523,7 +519,7 @@ class Adafruit_BMP280_SPI(Adafruit_BMP280): """ def __init__(self, spi: SPI, cs: DigitalInOut, baudrate=100000) -> None: - from adafruit_bus_device import ( # pylint: disable=import-outside-toplevel + from adafruit_bus_device import ( # noqa: PLC0415 spi_device, ) @@ -534,7 +530,6 @@ def _read_register(self, register: int, length: int) -> bytearray: """Low level register reading over SPI, returns a list of values""" register = (register | 0x80) & 0xFF # Read single, bit 7 high. with self._spi as spi: - # pylint: disable=no-member spi.write(bytearray([register])) result = bytearray(length) spi.readinto(result) @@ -545,5 +540,4 @@ def _write_register_byte(self, register: int, value: int) -> None: """Low level register writing over SPI, writes one 8-bit value""" register &= 0x7F # Write, bit 7 low. with self._spi as spi: - # pylint: disable=no-member spi.write(bytes([register, value & 0xFF])) diff --git a/docs/api.rst b/docs/api.rst index eb00ef4..c76db1c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,8 @@ .. If you created a package, create one automodule per module in the package. +API Reference +############# + .. automodule:: adafruit_bmp280 :members: diff --git a/docs/conf.py b/docs/conf.py index 6d0c4e0..e0751e8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -48,9 +46,7 @@ creation_year = "2017" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " ladyada" author = "ladyada" diff --git a/examples/bmp280_displayio_simpletest.py b/examples/bmp280_displayio_simpletest.py index 853559c..47afcf4 100644 --- a/examples/bmp280_displayio_simpletest.py +++ b/examples/bmp280_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 + import adafruit_bmp280 # Simple demo of the BMP280 barometric pressure sensor. diff --git a/examples/bmp280_normal_mode.py b/examples/bmp280_normal_mode.py index e2ac59c..a59eda6 100644 --- a/examples/bmp280_normal_mode.py +++ b/examples/bmp280_normal_mode.py @@ -6,8 +6,11 @@ parameters supported by the sensor. Refer to the BMP280 datasheet to understand what these parameters do """ + import time + import board + import adafruit_bmp280 # Create sensor object, communicating over the board's default I2C bus diff --git a/examples/bmp280_simpletest.py b/examples/bmp280_simpletest.py index 8af6f62..f45682c 100644 --- a/examples/bmp280_simpletest.py +++ b/examples/bmp280_simpletest.py @@ -2,8 +2,10 @@ # SPDX-License-Identifier: MIT """Simpletest Example that shows how to get temperature, - pressure, and altitude readings from a BMP280""" +pressure, and altitude readings from a BMP280""" + import time + import board # import digitalio # For use with SPI 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" From f722b7e547f82d04892413e2a7a2b8b81ded595b Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 65/65] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy