From 6c213ade04973380fa4d2cf79bdb99b1f6f44771 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Tue, 7 Apr 2020 15:02:31 -0500 Subject: [PATCH 001/110] build.yml: add black formatting check Signed-off-by: sommersoft --- .github/workflows/build.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1dad804..b6977a9 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,6 +43,9 @@ jobs: pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags + - name: Check formatting + run: | + black --check --target-version=py35 . - name: PyLint run: | pylint $( find . -path './adafruit*.py' ) From 0ebbb04f466500744e569fd8e3bdec30934bd46f Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Wed, 8 Apr 2020 14:37:14 -0400 Subject: [PATCH 002/110] Black reformatting with Python 3 target. --- docs/conf.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 23e06de..d31051d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -46,18 +46,18 @@ master_doc = "index" # General information about the project. -project = u"Adafruit DPS310 Library" -copyright = u"2020 Bryan Siepert" -author = u"Bryan Siepert" +project = "Adafruit DPS310 Library" +copyright = "2020 Bryan Siepert" +author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u"1.0" +version = "1.0" # The full version, including alpha/beta/rc tags. -release = u"1.0" +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -148,7 +148,7 @@ ( master_doc, "AdafruitDPS310Library.tex", - u"AdafruitDPS310 Library Documentation", + "AdafruitDPS310 Library Documentation", author, "manual", ), @@ -162,7 +162,7 @@ ( master_doc, "AdafruitDPS310library", - u"Adafruit DPS310 Library Documentation", + "Adafruit DPS310 Library Documentation", [author], 1, ) @@ -177,7 +177,7 @@ ( master_doc, "AdafruitDPS310Library", - u"Adafruit DPS310 Library Documentation", + "Adafruit DPS310 Library Documentation", author, "AdafruitDPS310Library", "One line description of project.", From 811f99f7d2c744bda3f9bc813eac655574f27e72 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Sat, 9 May 2020 08:55:52 +0300 Subject: [PATCH 003/110] correct temperature readings for ICs with a fuse bit problem --- adafruit_dps310.py | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 6dd6a19..6fdf55e 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -203,6 +203,10 @@ class DPS310: _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) + _reg0E = RWBits(8, 0x0E, 0) + _reg0F = RWBits(8, 0x0F, 0) + _reg62 = RWBits(8, 0x62, 0) + def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) @@ -253,6 +257,21 @@ def initialize(self): while (self._temp_ready is False) or (self._pressure_ready is False): sleep(0.001) + # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) + # similar to DpsClass::correctTemp(void) from infineon's c++ library + def _correct_temp(self): + """Correct temperature readings on ICs with a fuse bit problem""" + self._reg0E = 0xA5 + self._reg0F = 0x96 + self._reg62 = 0x02 + self._reg0E = 0 + self._reg0F = 0 + + # perform a temperature measurement + # the most recent temperature will be saved internally + # and used for compensation when calculating pressure + unused = self._raw_temperature + def _reset(self): """Perform a soft-reset on the sensor""" self._reset_register = 0x89 @@ -260,6 +279,7 @@ def _reset(self): sleep(0.010) while not self._sensor_ready: sleep(0.001) + self._correct_temp() @property def pressure(self): From 0ae21598ac4feaff937db4952d62d3f54824a620 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Sat, 9 May 2020 09:00:03 +0300 Subject: [PATCH 004/110] move calibration stuff from initialize() to reset() --- adafruit_dps310.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 6fdf55e..d628ebd 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -238,13 +238,9 @@ def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): self.initialize() def initialize(self): - """Reset the sensor to the default state""" + """Initialize the sensor to continuous measurement""" - self._reset() - self._read_calibration() - - # make sure we're using the temperature source used for calibration - self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit + self.reset() self.pressure_rate = Rate.RATE_64_HZ self.pressure_oversample_count = SampleCount.COUNT_64 @@ -272,14 +268,17 @@ def _correct_temp(self): # and used for compensation when calculating pressure unused = self._raw_temperature - def _reset(self): - """Perform a soft-reset on the sensor""" + def reset(self): + """Reset the sensor""" self._reset_register = 0x89 # wait for hardware reset to finish sleep(0.010) while not self._sensor_ready: sleep(0.001) self._correct_temp() + self._read_calibration() + # make sure we're using the temperature source used for calibration + self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit @property def pressure(self): From e03ab8d701092480caa9b33150bf72022bd3d7d5 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Sat, 9 May 2020 09:09:30 +0300 Subject: [PATCH 005/110] add self.wait_{temperature,pressure}_ready functions --- adafruit_dps310.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index d628ebd..a93c749 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -249,9 +249,8 @@ def initialize(self): self.mode = Mode.CONT_PRESTEMP # wait until we have at least one good measurement - - while (self._temp_ready is False) or (self._pressure_ready is False): - sleep(0.001) + self.wait_temperature_ready() + self.wait_pressure_ready() # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) # similar to DpsClass::correctTemp(void) from infineon's c++ library @@ -315,11 +314,19 @@ def temperature_ready(self): """Returns true if there is a temperature reading ready""" return self._temp_ready + def wait_temperature_ready(self): + while (self._temp_ready is False): + sleep(0.001) + @property def pressure_ready(self): """Returns true if pressure readings are ready""" return self._pressure_ready + def wait_pressure_ready(self): + while (self._pressure_ready is False): + sleep(0.001) + @property def mode(self): """The measurement mode. Must be a `Mode`. See the `Mode` documentation for details""" From e008d91861d8bfa83d8dcf58370c00d4f802c501 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Sat, 9 May 2020 09:21:03 +0300 Subject: [PATCH 006/110] readme / add caveat about resetting IC when changing mode and sample rates --- README.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.rst b/README.rst index b3c46b6..ce0baec 100644 --- a/README.rst +++ b/README.rst @@ -73,6 +73,16 @@ Usage Example print("") time.sleep(1.0) +Caveat: by default the library initializes the IC with constant temperature and pressure measurements at 64Hz with 64 samples. It is not possible to change the IC's mode, temperature_oversample_count or pressure_oversample_count on-the-fly so resetting the IC and operation parameteres is required. For instance, to set the mode to continuous pressure measurement at 1Hz with 2 samples: + +.. code-block:: python3 + + dps310.reset() + dps310.pressure_oversample_count = SampleCount.COUNT_2 + dps310.pressure_rate = Rate.RATE_1_HZ + dps310.mode = Mode.CONT_PRESSURE + dps310.wait_pressure_ready() + Contributing ============ From 3eab93e7e0f35bcedf2058d0b4ca15bea92401d6 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Sat, 9 May 2020 09:24:08 +0300 Subject: [PATCH 007/110] add low power weather station example --- examples/dps310_low_power_weather_station.py | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 examples/dps310_low_power_weather_station.py diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py new file mode 100644 index 0000000..6ab9205 --- /dev/null +++ b/examples/dps310_low_power_weather_station.py @@ -0,0 +1,28 @@ +# configure the sensor for continuous measurement for a +# low power weather station as recommended in the datasheet: +# https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf) + +import time +import board +import busio +import adafruit_dps310 + +i2c = busio.I2C(board.SCL, board.SDA) + +dps310 = adafruit_dps310.DPS310(i2c) + +dps310.reset() +dps310.pressure_oversample_count = SampleCount.COUNT_2 +dps310.pressure_rate = Rate.RATE_1_HZ +dps310.temperature_oversample_count = SampleCount.COUNT_16 +dps310.temperature_rate = Rate.RATE_1_HZ +dps310.mode = Mode.CONT_PRESTEMP +dps310.wait_temperature_ready() +dps310.wait_pressure_ready() + +while True: + print("Temperature = %.2f *C" % dps310.temperature) + print("Pressure = %.2f hPa" % dps310.pressure) + print("") + time.sleep(10.0) + From 85e178bbcd49c3b480fb6718fb90a51cac963146 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Sat, 9 May 2020 09:53:51 +0300 Subject: [PATCH 008/110] add mode test to wait_{pressure,temperature}_ready to avoid infinite wait --- adafruit_dps310.py | 20 ++++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index a93c749..8ced8d6 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -315,8 +315,14 @@ def temperature_ready(self): return self._temp_ready def wait_temperature_ready(self): - while (self._temp_ready is False): - sleep(0.001) + """Wait until a temperature measurement is available""" + if self._mode_bits == Mode.IDLE \ + or self._mode_bits == Mode.ONE_PRESSURE \ + or self._mode_bits == Mode.CONT_PRESSURE: + raise RuntimeError("Sensor mode is set to idle or pressure measurement, can't wait for a temperature measurement") + else: + while (self._temp_ready is False): + sleep(0.001) @property def pressure_ready(self): @@ -324,8 +330,14 @@ def pressure_ready(self): return self._pressure_ready def wait_pressure_ready(self): - while (self._pressure_ready is False): - sleep(0.001) + """Wait until a pressure measurement is available""" + if self._mode_bits == Mode.IDLE \ + or self._mode_bits == Mode.ONE_TEMPERATURE \ + or self._mode_bits == Mode.CONT_TEMP: + raise RuntimeError("Sensor mode is set to idle or temperature measurement, can't wait for a pressure measurement") + else: + while (self._pressure_ready is False): + sleep(0.001) @property def mode(self): From f30cee1a41d3cee5ae91d739d9eca7a3c4237488 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Tue, 12 May 2020 08:02:43 +0300 Subject: [PATCH 009/110] pylint fixes --- adafruit_dps310.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 8ced8d6..3e26a1f 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -203,8 +203,8 @@ class DPS310: _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) - _reg0E = RWBits(8, 0x0E, 0) - _reg0F = RWBits(8, 0x0F, 0) + _reg0e = RWBits(8, 0x0E, 0) + _reg0f = RWBits(8, 0x0F, 0) _reg62 = RWBits(8, 0x62, 0) def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): @@ -256,16 +256,16 @@ def initialize(self): # similar to DpsClass::correctTemp(void) from infineon's c++ library def _correct_temp(self): """Correct temperature readings on ICs with a fuse bit problem""" - self._reg0E = 0xA5 - self._reg0F = 0x96 + self._reg0e = 0xA5 + self._reg0f = 0x96 self._reg62 = 0x02 - self._reg0E = 0 - self._reg0F = 0 + self._reg0e = 0 + self._reg0f = 0 # perform a temperature measurement # the most recent temperature will be saved internally # and used for compensation when calculating pressure - unused = self._raw_temperature + _unused = self._raw_temperature def reset(self): """Reset the sensor""" @@ -319,10 +319,10 @@ def wait_temperature_ready(self): if self._mode_bits == Mode.IDLE \ or self._mode_bits == Mode.ONE_PRESSURE \ or self._mode_bits == Mode.CONT_PRESSURE: - raise RuntimeError("Sensor mode is set to idle or pressure measurement, can't wait for a temperature measurement") - else: - while (self._temp_ready is False): - sleep(0.001) + raise RuntimeError("Sensor mode is set to idle or pressure measurement,\ + can't wait for a temperature measurement") + while self._temp_ready is False: + sleep(0.001) @property def pressure_ready(self): @@ -334,10 +334,10 @@ def wait_pressure_ready(self): if self._mode_bits == Mode.IDLE \ or self._mode_bits == Mode.ONE_TEMPERATURE \ or self._mode_bits == Mode.CONT_TEMP: - raise RuntimeError("Sensor mode is set to idle or temperature measurement, can't wait for a pressure measurement") - else: - while (self._pressure_ready is False): - sleep(0.001) + raise RuntimeError("Sensor mode is set to idle or temperature measurement,\ + can't wait for a pressure measurement") + while self._pressure_ready is False: + sleep(0.001) @property def mode(self): From 178a0cfdb2ac4ea519d3431f34d4f9b1fe64fe90 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Tue, 12 May 2020 08:20:42 +0300 Subject: [PATCH 010/110] pylint/black fixes --- adafruit_dps310.py | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 3e26a1f..2d47d5b 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -316,11 +316,15 @@ def temperature_ready(self): def wait_temperature_ready(self): """Wait until a temperature measurement is available""" - if self._mode_bits == Mode.IDLE \ - or self._mode_bits == Mode.ONE_PRESSURE \ - or self._mode_bits == Mode.CONT_PRESSURE: - raise RuntimeError("Sensor mode is set to idle or pressure measurement,\ - can't wait for a temperature measurement") + if ( + self._mode_bits == Mode.IDLE + or self._mode_bits == Mode.ONE_PRESSURE + or self._mode_bits == Mode.CONT_PRESSURE + ): + raise RuntimeError( + "Sensor mode is set to idle or pressure measurement,\ + can't wait for a temperature measurement" + ) while self._temp_ready is False: sleep(0.001) @@ -331,11 +335,15 @@ def pressure_ready(self): def wait_pressure_ready(self): """Wait until a pressure measurement is available""" - if self._mode_bits == Mode.IDLE \ - or self._mode_bits == Mode.ONE_TEMPERATURE \ - or self._mode_bits == Mode.CONT_TEMP: - raise RuntimeError("Sensor mode is set to idle or temperature measurement,\ - can't wait for a pressure measurement") + if ( + self._mode_bits == Mode.IDLE + or self._mode_bits == Mode.ONE_TEMPERATURE + or self._mode_bits == Mode.CONT_TEMP + ): + raise RuntimeError( + "Sensor mode is set to idle or temperature measurement,\ + can't wait for a pressure measurement" + ) while self._pressure_ready is False: sleep(0.001) From 5ab5e920a79fdaf3d2fde5d19f22da638f6141d1 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Tue, 12 May 2020 08:30:25 +0300 Subject: [PATCH 011/110] pylint/black fix (remove trailing new line) --- examples/dps310_low_power_weather_station.py | 1 - 1 file changed, 1 deletion(-) diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 6ab9205..80944a2 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -25,4 +25,3 @@ print("Pressure = %.2f hPa" % dps310.pressure) print("") time.sleep(10.0) - From 43e0e072acf0270d1296dd6236503ada5fcf4aa6 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Tue, 12 May 2020 08:59:21 +0300 Subject: [PATCH 012/110] pylint: disable no-member for dynamically generated values --- README.rst | 6 +++--- examples/dps310_low_power_weather_station.py | 14 +++++++++----- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index ce0baec..f9fb794 100644 --- a/README.rst +++ b/README.rst @@ -78,9 +78,9 @@ Caveat: by default the library initializes the IC with constant temperature and .. code-block:: python3 dps310.reset() - dps310.pressure_oversample_count = SampleCount.COUNT_2 - dps310.pressure_rate = Rate.RATE_1_HZ - dps310.mode = Mode.CONT_PRESSURE + dps310.pressure_oversample_count = adafruit_dps310.SampleCount.COUNT_2 + dps310.pressure_rate = adafruit_dps310.Rate.RATE_1_HZ + dps310.mode = adafruit_dps310.Mode.CONT_PRESSURE dps310.wait_pressure_ready() diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 80944a2..b17edb9 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -2,6 +2,10 @@ # low power weather station as recommended in the datasheet: # https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf) +# (disable pylint warnings for adafruit_dps310.{SampleCount,Rate,Mode}.* +# as they are generated dynamically) +# pylint: disable=no-member + import time import board import busio @@ -12,11 +16,11 @@ dps310 = adafruit_dps310.DPS310(i2c) dps310.reset() -dps310.pressure_oversample_count = SampleCount.COUNT_2 -dps310.pressure_rate = Rate.RATE_1_HZ -dps310.temperature_oversample_count = SampleCount.COUNT_16 -dps310.temperature_rate = Rate.RATE_1_HZ -dps310.mode = Mode.CONT_PRESTEMP +dps310.pressure_oversample_count = adafruit_dps310.SampleCount.COUNT_2 +dps310.pressure_rate = adafruit_dps310.Rate.RATE_1_HZ +dps310.temperature_oversample_count = adafruit_dps310.SampleCount.COUNT_16 +dps310.temperature_rate = adafruit_dps310.Rate.RATE_1_HZ +dps310.mode = adafruit_dps310.Mode.CONT_PRESTEMP dps310.wait_temperature_ready() dps310.wait_pressure_ready() From d76bd2f3c12980ea9aec7f7c78350c4d3c2b13aa Mon Sep 17 00:00:00 2001 From: taradiddles Date: Wed, 13 May 2020 07:31:57 +0300 Subject: [PATCH 013/110] add docstrings for the `wait_nnn_ready` methods about which modes are supported --- adafruit_dps310.py | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 2d47d5b..774b6e7 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -315,7 +315,13 @@ def temperature_ready(self): return self._temp_ready def wait_temperature_ready(self): - """Wait until a temperature measurement is available""" + """Wait until a temperature measurement is available. + + To avoid waiting indefinitely this function raises an + error if the sensor isn't configured for temperate measurements, + ie. `Mode.ONE_TEMPERATURE`, `Mode.CONT_TEMP` or `Mode.CONT_PRESTEMP`. + See the `Mode` documentation for details. + """ if ( self._mode_bits == Mode.IDLE or self._mode_bits == Mode.ONE_PRESSURE @@ -334,7 +340,13 @@ def pressure_ready(self): return self._pressure_ready def wait_pressure_ready(self): - """Wait until a pressure measurement is available""" + """Wait until a pressure measurement is available + + To avoid waiting indefinitely this function raises an + error if the sensor isn't configured for pressure measurements, + ie. `Mode.ONE_PRESSURE`, `Mode.CONT_PRESSURE` or `Mode.CONT_PRESTEMP` + See the `Mode` documentation for details. + """ if ( self._mode_bits == Mode.IDLE or self._mode_bits == Mode.ONE_TEMPERATURE From 631dfa3c1961793122ad476550c0f5a582c3de64 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Wed, 13 May 2020 07:32:40 +0300 Subject: [PATCH 014/110] convert comments into docstring --- examples/dps310_low_power_weather_station.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index b17edb9..41ca3b3 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -1,6 +1,9 @@ -# configure the sensor for continuous measurement for a -# low power weather station as recommended in the datasheet: -# https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf) +""" +Configure the sensor for continuous measurement with rates, +sampling counts and mode optmized for low power, as recommended +in Infineon's datasheet: +https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf +""" # (disable pylint warnings for adafruit_dps310.{SampleCount,Rate,Mode}.* # as they are generated dynamically) From 59631d72c4fa6faede39b845960796cc7a949239 Mon Sep 17 00:00:00 2001 From: taradiddles Date: Wed, 13 May 2020 08:22:56 +0300 Subject: [PATCH 015/110] docstring/wait_nnn_read: single backticks to double backticks --- adafruit_dps310.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 774b6e7..222506f 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -319,7 +319,7 @@ def wait_temperature_ready(self): To avoid waiting indefinitely this function raises an error if the sensor isn't configured for temperate measurements, - ie. `Mode.ONE_TEMPERATURE`, `Mode.CONT_TEMP` or `Mode.CONT_PRESTEMP`. + ie. ``Mode.ONE_TEMPERATURE``, ``Mode.CONT_TEMP`` or ``Mode.CONT_PRESTEMP``. See the `Mode` documentation for details. """ if ( @@ -344,7 +344,7 @@ def wait_pressure_ready(self): To avoid waiting indefinitely this function raises an error if the sensor isn't configured for pressure measurements, - ie. `Mode.ONE_PRESSURE`, `Mode.CONT_PRESSURE` or `Mode.CONT_PRESTEMP` + ie. ``Mode.ONE_PRESSURE``, ``Mode.CONT_PRESSURE`` or ``Mode.CONT_PRESTEMP`` See the `Mode` documentation for details. """ if ( From eaa2f7e23ce8b500aefe7dcf1bb99535502b57d7 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 8 Jul 2020 16:49:04 -0400 Subject: [PATCH 016/110] Fixed discord invite link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f9fb794..5ddd4fb 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg - :target: https://discord.gg/nBQh6qu + :target: https://adafru.it/discord :alt: Discord .. image:: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/workflows/Build%20CI/badge.svg From 3c0532390beb532c02f8ab7c87805dfc25f6e34f Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Sun, 23 Aug 2020 11:01:51 -0500 Subject: [PATCH 017/110] remove bad-whitespace pylint directive --- adafruit_dps310.py | 1 - 1 file changed, 1 deletion(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 6dd6a19..f72b0f4 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -64,7 +64,6 @@ _DPS310_PRODREVID = 0x0D # Register that contains the part ID _DPS310_TMPCOEFSRCE = 0x28 # Temperature calibration src -# pylint: enable=bad-whitespace # pylint: disable=no-member,unnecessary-pass From aeefb838a64d7feff0211c7efe45e9fcc65a64a9 Mon Sep 17 00:00:00 2001 From: caternuson Date: Thu, 27 Aug 2020 11:02:25 -0700 Subject: [PATCH 018/110] add altitude property --- adafruit_dps310.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 32cdf53..7c9aabb 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -45,6 +45,7 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" # Common imports; remove if unused or pylint will complain +import math from time import sleep import adafruit_bus_device.i2c_device as i2c_device from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct @@ -234,6 +235,8 @@ def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): 1040384, 2088960, ) + self.sea_level_pressure = 1013.25 + """Pressure in hectoPascals at sea level. Used to calibrate `altitude`.""" self.initialize() def initialize(self): @@ -301,6 +304,13 @@ def pressure(self): final_pressure = pres_calc / 100 return final_pressure + @property + def altitude(self): + """The altitude based on the sea level pressure (`sea_level_pressure`) - 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 temperature(self): """The current temperature reading in degrees C""" From a2ec35b65b70823336023e8927f779a5b6e7ee49 Mon Sep 17 00:00:00 2001 From: caternuson Date: Thu, 27 Aug 2020 11:12:02 -0700 Subject: [PATCH 019/110] ahh...pylint, my old friend --- adafruit_dps310.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 7c9aabb..dfbde62 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -308,8 +308,7 @@ def pressure(self): def altitude(self): """The altitude based on the sea level pressure (`sea_level_pressure`) - 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)) + return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) @property def temperature(self): From 18e11166da89404d91530f3c804f21ba6e92f9fd Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 15:06:44 -0500 Subject: [PATCH 020/110] Added pre-commit and SPDX copyright Signed-off-by: dherrada --- .github/workflows/build.yml | 28 ++++++++++++++++++++++++---- .github/workflows/release.yml | 4 ++++ 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b6977a9..59baa53 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Build CI on: [pull_request, push] @@ -38,20 +42,36 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, black, & Sphinx + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - - name: Check formatting + - name: Pre-commit hooks run: | - black --check --target-version=py35 . + pre-commit run --all-files - name: PyLint run: | pylint $( find . -path './adafruit*.py' ) ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - 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 setup.py + id: need-pypi + run: | + echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + - name: Build Python package + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + run: | + pip install --upgrade setuptools wheel twine readme_renderer testresources + python setup.py sdist + python setup.py bdist_wheel --universal + twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 18efb9c..6d0015a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Release Actions on: From 0094cdf3823c0c81faa1f7eeb792fccaac2ccad2 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 16:06:47 -0500 Subject: [PATCH 021/110] Added pre-commit-config file Signed-off-by: dherrada --- .pre-commit-config.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..aab5f1c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +repos: +- repo: https://github.com/python/black + rev: stable + hooks: + - id: black +- repo: https://github.com/fsfe/reuse-tool + rev: latest + hooks: + - id: reuse +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace From 4d54ef597a2e6ba5bfd2c24dfbe8867f095743ce Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 14 Jan 2021 11:53:50 -0500 Subject: [PATCH 022/110] Ran pre-commit, added licenses --- .gitignore | 4 + .pylintrc | 4 + .readthedocs.yml | 4 + CODE_OF_CONDUCT.md | 14 +- LICENSES/CC-BY-4.0.txt | 324 +++++++++++++++++++ LICENSES/MIT.txt | 19 ++ LICENSES/Unlicense.txt | 20 ++ README.rst.license | 3 + adafruit_dps310.py | 29 +- docs/_static/favicon.ico.license | 3 + docs/api.rst.license | 3 + docs/conf.py | 4 + docs/examples.rst.license | 3 + docs/index.rst.license | 3 + examples/dps310_low_power_weather_station.py | 3 + examples/dps310_simpletest.py | 3 + requirements.txt | 4 + setup.py | 4 + 18 files changed, 424 insertions(+), 27 deletions(-) create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt create mode 100644 README.rst.license create mode 100644 docs/_static/favicon.ico.license create mode 100644 docs/api.rst.license create mode 100644 docs/examples.rst.license create mode 100644 docs/index.rst.license diff --git a/.gitignore b/.gitignore index e7e0f2d..5fb597b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ diff --git a/.pylintrc b/.pylintrc index d8f0ee8..5c31f66 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + python: version: 3 requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_dps310.py b/adafruit_dps310.py index dfbde62..1838832 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries # -# Copyright (c) 2020 Bryan Siepert for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `adafruit_dps310` ================================================================================ @@ -173,8 +156,8 @@ class DPS310: # pylint: disable=too-many-instance-attributes """Library for the DPS310 Precision Barometric Pressure Sensor. - :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. - :param address: The I2C slave address of the sensor + :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. + :param address: The I2C slave address of the sensor """ # Register definitions @@ -307,7 +290,7 @@ def pressure(self): @property def altitude(self): """The altitude based on the sea level pressure (`sea_level_pressure`) - which you must - enter ahead of time)""" + enter ahead of time)""" return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) @property diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index d31051d..feb5500 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + import os import sys diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 41ca3b3..59ddd80 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ Configure the sensor for continuous measurement with rates, sampling counts and mode optmized for low power, as recommended diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 31e33d9..204e6ee 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + import time import board import busio diff --git a/requirements.txt b/requirements.txt index d5d88a1..f162505 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka adafruit-circuitpython-busdevice adafruit-circuitpython-register diff --git a/setup.py b/setup.py index 07aeb5e..da2cdeb 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: From fc9578f917b7a70c91deb728a062e30f9c55f739 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Feb 2021 16:38:51 -0500 Subject: [PATCH 023/110] Hardcoded Black and REUSE versions Signed-off-by: dherrada --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index aab5f1c..07f886c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,11 +4,11 @@ repos: - repo: https://github.com/python/black - rev: stable + rev: 20.8b1 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: latest + rev: v0.12.1 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks From 38100cec165e96f671d7d52c746800f48bc09d7c Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 16:46:17 -0500 Subject: [PATCH 024/110] Removed pylint process from github workflow Signed-off-by: dherrada --- .github/workflows/build.yml | 8 ++------ .pre-commit-config.yaml | 15 +++++++++++++++ .pylintrc | 2 +- 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 59baa53..621d5ef 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,18 +42,14 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks run: | pre-commit run --all-files - - name: PyLint - run: | - pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - name: Archive bundles diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 07f886c..354c761 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,3 +17,18 @@ repos: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace +- repo: https://github.com/pycqa/pylint + rev: pylint-2.7.1 + hooks: + - id: pylint + name: pylint (library code) + types: [python] + exclude: "^(docs/|examples/|setup.py$)" +- repo: local + hooks: + - id: pylint_examples + name: pylint (examples code) + description: Run pylint rules on "examples/*.py" files + entry: /usr/bin/env bash -c + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + language: system diff --git a/.pylintrc b/.pylintrc index 5c31f66..9ed669e 100644 --- a/.pylintrc +++ b/.pylintrc @@ -250,7 +250,7 @@ ignore-comments=yes ignore-docstrings=yes # Ignore imports when computing similarities. -ignore-imports=no +ignore-imports=yes # Minimum lines number of a similarity. min-similarity-lines=4 From b6af89c835f17f223979ec17cadfca48011e7159 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 17:17:50 -0500 Subject: [PATCH 025/110] Re-added pylint install to build.yml Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 621d5ef..3baf502 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (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 + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks From 657d53962f2834a89fae972582d81f6944814b69 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 19 Mar 2021 13:42:44 -0400 Subject: [PATCH 026/110] "Increase duplicate code check threshold " --- .pylintrc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.pylintrc b/.pylintrc index 9ed669e..0238b90 100644 --- a/.pylintrc +++ b/.pylintrc @@ -22,8 +22,7 @@ ignore-patterns= #init-hook= # Use multiple processes to speed up Pylint. -# jobs=1 -jobs=2 +jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. @@ -253,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 09443cdcf133dd590134eddc79dd066ff7d65136 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sat, 24 Apr 2021 20:14:22 -0400 Subject: [PATCH 027/110] improving_docs --- README.rst | 3 +- adafruit_dps310.py | 42 +++++++++++++++----- docs/api.rst | 1 + docs/examples.rst | 10 +++++ docs/index.rst | 2 + examples/dps310_low_power_weather_station.py | 3 +- examples/dps310_simpletest.py | 4 +- 7 files changed, 49 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 5ddd4fb..69beed9 100644 --- a/README.rst +++ b/README.rst @@ -60,10 +60,9 @@ Usage Example import time import board - import busio import adafruit_dps310 - i2c = busio.I2C(board.SCL, board.SDA) + i2c = board.I2C() # uses board.SCL and board.SDA dps310 = adafruit_dps310.DPS310(i2c) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 1838832..0bd2b32 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -114,7 +114,7 @@ class Mode(CV): class Rate(CV): - """Options for `pressure_rate` and `temperature_rate`""" + """Options for :attr:`pressure_rate` and :attr:`temperature_rate`""" pass @@ -134,7 +134,7 @@ class Rate(CV): class SampleCount(CV): - """Options for `temperature_oversample_count` and `pressure_oversample_count`""" + """Options for :attr:`temperature_oversample_count` and :attr:`pressure_oversample_count`""" pass @@ -157,7 +157,31 @@ class DPS310: """Library for the DPS310 Precision Barometric Pressure Sensor. :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. - :param address: The I2C slave address of the sensor + :param int address: The I2C slave address of the sensor. Defaults to :const:`0x77` + + **Quickstart: Importing and using the DPS310** + + Here is an example of using the :class:`DPS310` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + import adafruit_dps310 + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + dps310 = adafruit_dps310.DPS310(i2c) + + Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. + + .. code-block:: python + + temperature = dps310.temperature + pressure = dps310.pressure """ # Register definitions @@ -219,7 +243,7 @@ def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): 2088960, ) self.sea_level_pressure = 1013.25 - """Pressure in hectoPascals at sea level. Used to calibrate `altitude`.""" + """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" self.initialize() def initialize(self): @@ -289,13 +313,13 @@ def pressure(self): @property def altitude(self): - """The altitude based on the sea level pressure (`sea_level_pressure`) - which you must - enter ahead of time)""" + """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - + which you must enter ahead of time)""" return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) @property def temperature(self): - """The current temperature reading in degrees C""" + """The current temperature reading in degrees Celsius""" _scaled_rawtemp = self._raw_temperature / self._temp_scale _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 return _temperature @@ -375,7 +399,7 @@ def pressure_rate(self, value): @property def pressure_oversample_count(self): - """The number of samples taken per pressure measurement. Must be a `SampleCount`""" + """The number of samples taken per pressure measurement. Must be a ``SampleCount``""" return self._pressure_osbits @pressure_oversample_count.setter @@ -400,7 +424,7 @@ def temperature_rate(self, value): @property def temperature_oversample_count(self): - """The number of samples taken per temperature measurement. Must be a `SampleCount`""" + """The number of samples taken per temperature measurement. Must be a ``SampleCount``""" return self._temp_osbits @temperature_oversample_count.setter diff --git a/docs/api.rst b/docs/api.rst index 0ead416..c41be33 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -6,3 +6,4 @@ .. automodule:: adafruit_dps310 :members: + :exclude-members: CV, SampleCount diff --git a/docs/examples.rst b/docs/examples.rst index 4c8130c..f38db7e 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -6,3 +6,13 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/dps310_simpletest.py :caption: examples/dps310_simpletest.py :linenos: + +Lower Power Weather Station +--------------------------- + +Example showing how to configure the sensor for continuous measurement with rates, +sampling counts and mode optimized for low power + +.. literalinclude:: ../examples/dps310_low_power_weather_station.py + :caption: examples/dps310_low_power_weather_station.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 5c28025..3b48c21 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,10 +23,12 @@ Table of Contents .. toctree:: :caption: Tutorials + Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor Learning Guide .. toctree:: :caption: Related Products + Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor .. toctree:: :caption: Other Links diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 59ddd80..53b75e2 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -14,10 +14,9 @@ import time import board -import busio import adafruit_dps310 -i2c = busio.I2C(board.SCL, board.SDA) +i2c = board.I2C() # uses board.SCL and board.SDA dps310 = adafruit_dps310.DPS310(i2c) diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 204e6ee..9245b70 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -3,11 +3,9 @@ import time import board -import busio import adafruit_dps310 -i2c = busio.I2C(board.SCL, board.SDA) - +i2c = board.I2C() # uses board.SCL and board.SDA dps310 = adafruit_dps310.DPS310(i2c) while True: From 7f72db6e04073a7fa7df5f46a5a622ba74763251 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sat, 24 Apr 2021 20:18:25 -0400 Subject: [PATCH 028/110] Changing address description --- adafruit_dps310.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 0bd2b32..6a372a9 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -157,7 +157,7 @@ class DPS310: """Library for the DPS310 Precision Barometric Pressure Sensor. :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. - :param int address: The I2C slave address of the sensor. Defaults to :const:`0x77` + :param int address: The I2C device address. Defaults to :const:`0x77` **Quickstart: Importing and using the DPS310** From 18caa0f7d18e96f34859b3f612e8aa7e3ce3b350 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 4 May 2021 10:28:12 -0400 Subject: [PATCH 029/110] Changing address description --- adafruit_dps310.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 6a372a9..67a93e7 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -15,14 +15,21 @@ **Hardware:** -* Adafruit's DPS310 Breakout: https://www.adafruit.com/product/4494 +* `Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor + https://www.adafruit.com/product/4494`_ (Product ID: 4494) **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: https://circuitpython.org/downloads -* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice -* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register""" + +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register + +""" __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" From 477c93262c6ffc161e8ff9b3a475448560d6b032 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Fri, 7 May 2021 22:41:57 -0400 Subject: [PATCH 030/110] adding note cocnerning M0 boards --- README.rst | 7 +++++++ adafruit_dps310.py | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 69beed9..4e00496 100644 --- a/README.rst +++ b/README.rst @@ -83,6 +83,13 @@ Caveat: by default the library initializes the IC with constant temperature and dps310.wait_pressure_ready() + +Known Issues +============ +Library extensive features might not be compatible with memory limited boards. Library might not +load in M0 boards. + + Contributing ============ diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 67a93e7..653d11d 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -16,7 +16,7 @@ **Hardware:** * `Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor - https://www.adafruit.com/product/4494`_ (Product ID: 4494) + `_ (Product ID: 4494) **Software and Dependencies:** From b7c45e76c0ef3f701c48e45c3d7f14c7c7d01de6 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sat, 8 May 2021 11:36:39 -0400 Subject: [PATCH 031/110] correcting note after reviewing --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 4e00496..e5ff9e4 100644 --- a/README.rst +++ b/README.rst @@ -87,7 +87,7 @@ Caveat: by default the library initializes the IC with constant temperature and Known Issues ============ Library extensive features might not be compatible with memory limited boards. Library might not -load in M0 boards. +load in SAMD21 boards and others with 32KB or RAM or less. Contributing From 06b17fded25cf17fa398c2d088946647a14af948 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sat, 8 May 2021 11:38:09 -0400 Subject: [PATCH 032/110] correcting typo --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e5ff9e4..dd3cbb5 100644 --- a/README.rst +++ b/README.rst @@ -87,7 +87,7 @@ Caveat: by default the library initializes the IC with constant temperature and Known Issues ============ Library extensive features might not be compatible with memory limited boards. Library might not -load in SAMD21 boards and others with 32KB or RAM or less. +load in SAMD21 boards and others with 32KB of RAM or less. Contributing From 47a5b34e15d6dc3b6db078bb6dd01105a3e5f632 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 18 May 2021 05:07:20 -0400 Subject: [PATCH 033/110] memory_reduction --- adafruit_dps310/__init__.py | 286 ++++++++++++++++++ .../dps310_featured.py | 226 ++------------ 2 files changed, 308 insertions(+), 204 deletions(-) create mode 100644 adafruit_dps310/__init__.py rename adafruit_dps310.py => adafruit_dps310/dps310_featured.py (57%) diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py new file mode 100644 index 0000000..b777182 --- /dev/null +++ b/adafruit_dps310/__init__.py @@ -0,0 +1,286 @@ +# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_dps310` +================================================================================ + +Library for the DPS310 Precision Barometric Pressure Sensor + +* Author(s): Bryan Siepert + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor + `_ (Product ID: 4494) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register + +""" + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" + +# Common imports; remove if unused or pylint will complain +import math +from time import sleep +from micropython import const +import adafruit_bus_device.i2c_device as i2c_device +from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct +from adafruit_register.i2c_bit import RWBit, ROBit +from adafruit_register.i2c_bits import RWBits, ROBits + +_DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address +_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier + +_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +_DPS310_PRSCFG = const(0x06) # Pressure configuration +_DPS310_TMPCFG = const(0x07) # Temperature configuration +_DPS310_MEASCFG = const(0x08) # Sensor configuration +_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +_DPS310_RESET = const(0x0C) # Soft reset +_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src + + +class DPS310: + # pylint: disable=too-many-instance-attributes + """Library for the DPS310 Precision Barometric Pressure Sensor. + Depending on your board memory availability you could use DPS310_Featured. + + :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. + :param int address: The I2C device address. Defaults to :const:`0x77` + + **Quickstart: Importing and using the DPS310** + + Here is an example of using the :class:`DPS310` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + import adafruit_dps310 + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + dps310 = adafruit_dps310.DPS310(i2c) + + Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. + + .. code-block:: python + + temperature = dps310.temperature + pressure = dps310.pressure + + """ + # Register definitions + _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") + _reset_register = UnaryStruct(_DPS310_RESET, ">B") + _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) # + + _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) + + _temp_osbits = RWBits(4, _DPS310_TMPCFG, 0) + + _temp_measurement_src_bit = RWBit(_DPS310_TMPCFG, 7) + + _pressure_shiftbit = RWBit(_DPS310_CFGREG, 2) + _temp_shiftbit = RWBit(_DPS310_CFGREG, 3) + + _coefficients_ready = RWBit(_DPS310_MEASCFG, 7) + _sensor_ready = RWBit(_DPS310_MEASCFG, 6) + _temp_ready = RWBit(_DPS310_MEASCFG, 5) + _pressure_ready = RWBit(_DPS310_MEASCFG, 4) + + _raw_pressure = ROBits(24, _DPS310_PRSB2, 0, 3, lsb_first=False) + _raw_temperature = ROBits(24, _DPS310_TMPB2, 0, 3, lsb_first=False) + + _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) + + _reg0e = RWBits(8, 0x0E, 0) + _reg0f = RWBits(8, 0x0F, 0) + _reg62 = RWBits(8, 0x62, 0) + + def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): + self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) + + if self._device_id != _DPS310_DEVICE_ID: + raise RuntimeError("Failed to find DPS310 - check your wiring!") + self._pressure_scale = None + self._temp_scale = None + self._c0 = None + self._c1 = None + self._c00 = None + self._c00 = None + self._c10 = None + self._c10 = None + self._c01 = None + self._c11 = None + self._c20 = None + self._c21 = None + self._c30 = None + self._oversample_scalefactor = ( + 524288, + 1572864, + 3670016, + 7864320, + 253952, + 516096, + 1040384, + 2088960, + ) + self.sea_level_pressure = 1013.25 + """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" + self.initialize() + + def initialize(self): + """Initialize the sensor to continuous measurement""" + + self.reset() + + self._pressure_osbits = 6 + self._pressure_shiftbit = True + self._pressure_scale = self._oversample_scalefactor[6] + + self._temp_osbits = 6 + self._temp_scale = self._oversample_scalefactor[6] + self._temp_shiftbit = True + + self._mode_bits = 7 + + # wait until we have at least one good measurement + self.wait_temperature_ready() + self.wait_pressure_ready() + + # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) + # similar to DpsClass::correctTemp(void) from infineon's c++ library + def _correct_temp(self): + """Correct temperature readings on ICs with a fuse bit problem""" + self._reg0e = 0xA5 + self._reg0f = 0x96 + self._reg62 = 0x02 + self._reg0e = 0 + self._reg0f = 0 + + # perform a temperature measurement + # the most recent temperature will be saved internally + # and used for compensation when calculating pressure + _unused = self._raw_temperature + + def reset(self): + """Reset the sensor""" + self._reset_register = 0x89 + # wait for hardware reset to finish + sleep(0.010) + while not self._sensor_ready: + sleep(0.001) + self._correct_temp() + self._read_calibration() + # make sure we're using the temperature source used for calibration + self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit + + @property + def pressure(self): + """Returns the current pressure reading in kPA""" + + temp_reading = self._raw_temperature + raw_temperature = self._twos_complement(temp_reading, 24) + pressure_reading = self._raw_pressure + raw_pressure = self._twos_complement(pressure_reading, 24) + _scaled_rawtemp = raw_temperature / self._temp_scale + + _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 + + p_red = raw_pressure / self._pressure_scale + + pres_calc = ( + self._c00 + + p_red * (self._c10 + p_red * (self._c20 + p_red * self._c30)) + + _scaled_rawtemp * (self._c01 + p_red * (self._c11 + p_red * self._c21)) + ) + + final_pressure = pres_calc / 100 + return final_pressure + + @property + def altitude(self): + """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - + which you must enter ahead of time)""" + return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) + + @property + def temperature(self): + """The current temperature reading in degrees Celsius""" + _scaled_rawtemp = self._raw_temperature / self._temp_scale + _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 + return _temperature + + def wait_temperature_ready(self): + """Wait until a temperature measurement is available.""" + + while self._temp_ready is False: + sleep(0.001) + + def wait_pressure_ready(self): + """Wait until a pressure measurement is available""" + + while self._pressure_ready is False: + sleep(0.001) + + @staticmethod + def _twos_complement(val, bits): + if val & (1 << (bits - 1)): + val -= 1 << bits + + return val + + def _read_calibration(self): + + while not self._coefficients_ready: + sleep(0.001) + + buffer = bytearray(19) + coeffs = [None] * 18 + for offset in range(18): + buffer = bytearray(2) + buffer[0] = 0x10 + offset + + with self.i2c_device as i2c: + + i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) + + coeffs[offset] = buffer[1] + + self._c0 = (coeffs[0] << 4) | ((coeffs[1] >> 4) & 0x0F) + self._c0 = self._twos_complement(self._c0, 12) + + self._c1 = self._twos_complement(((coeffs[1] & 0x0F) << 8) | coeffs[2], 12) + + self._c00 = (coeffs[3] << 12) | (coeffs[4] << 4) | ((coeffs[5] >> 4) & 0x0F) + self._c00 = self._twos_complement(self._c00, 20) + + self._c10 = ((coeffs[5] & 0x0F) << 16) | (coeffs[6] << 8) | coeffs[7] + self._c10 = self._twos_complement(self._c10, 20) + + self._c01 = self._twos_complement((coeffs[8] << 8) | coeffs[9], 16) + self._c11 = self._twos_complement((coeffs[10] << 8) | coeffs[11], 16) + self._c20 = self._twos_complement((coeffs[12] << 8) | coeffs[13], 16) + self._c21 = self._twos_complement((coeffs[14] << 8) | coeffs[15], 16) + self._c30 = self._twos_complement((coeffs[16] << 8) | coeffs[17], 16) diff --git a/adafruit_dps310.py b/adafruit_dps310/dps310_featured.py similarity index 57% rename from adafruit_dps310.py rename to adafruit_dps310/dps310_featured.py index 653d11d..16af1c0 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310/dps310_featured.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310` +`adafruit_dps310.dps310_featured` ================================================================================ Library for the DPS310 Precision Barometric Pressure Sensor @@ -34,26 +34,10 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" -# Common imports; remove if unused or pylint will complain -import math from time import sleep -import adafruit_bus_device.i2c_device as i2c_device -from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct -from adafruit_register.i2c_bit import RWBit, ROBit -from adafruit_register.i2c_bits import RWBits, ROBits - -_DPS310_DEFAULT_ADDRESS = 0x77 # DPS310 default i2c address -_DPS310_DEVICE_ID = 0x10 # DPS310 device identifier - -_DPS310_PRSB2 = 0x00 # Highest byte of pressure data -_DPS310_TMPB2 = 0x03 # Highest byte of temperature data -_DPS310_PRSCFG = 0x06 # Pressure configuration -_DPS310_TMPCFG = 0x07 # Temperature configuration -_DPS310_MEASCFG = 0x08 # Sensor configuration -_DPS310_CFGREG = 0x09 # Interrupt/FIFO configuration -_DPS310_RESET = 0x0C # Soft reset -_DPS310_PRODREVID = 0x0D # Register that contains the part ID -_DPS310_TMPCOEFSRCE = 0x28 # Temperature calibration src +from micropython import const +from adafruit_register.i2c_bits import RWBits +from adafruit_dps310 import DPS310 # pylint: disable=no-member,unnecessary-pass @@ -123,7 +107,7 @@ class Mode(CV): class Rate(CV): """Options for :attr:`pressure_rate` and :attr:`temperature_rate`""" - pass + pass # pylint: disable=unnecessary-pass Rate.add_values( @@ -159,96 +143,34 @@ class SampleCount(CV): ) ) # pylint: enable=unnecessary-pass -class DPS310: - # pylint: disable=too-many-instance-attributes - """Library for the DPS310 Precision Barometric Pressure Sensor. - - :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. - :param int address: The I2C device address. Defaults to :const:`0x77` - - **Quickstart: Importing and using the DPS310** - - Here is an example of using the :class:`DPS310` class. - First you will need to import the libraries to use the sensor - .. code-block:: python +_DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address +_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier - import board - import adafruit_dps310 +_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +_DPS310_PRSCFG = const(0x06) # Pressure configuration +_DPS310_TMPCFG = const(0x07) # Temperature configuration +_DPS310_MEASCFG = const(0x08) # Sensor configuration +_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +_DPS310_RESET = const(0x0C) # Soft reset +_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src - Once this is done you can define your `board.I2C` object and define your sensor object - .. code-block:: python - - i2c = board.I2C() # uses board.SCL and board.SDA - dps310 = adafruit_dps310.DPS310(i2c) - - Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. - - .. code-block:: python - - temperature = dps310.temperature - pressure = dps310.pressure +class DPS310_Featured(DPS310): + # pylint: disable=too-many-instance-attributes + """Library for the DPS310 Precision Barometric Pressure Sensor. + This class contains all the options available for the Sensor """ # Register definitions - _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") - _reset_register = UnaryStruct(_DPS310_RESET, ">B") - _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) - _pressure_ratebits = RWBits(3, _DPS310_PRSCFG, 4) - _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) - _temp_ratebits = RWBits(3, _DPS310_TMPCFG, 4) - _temp_osbits = RWBits(4, _DPS310_TMPCFG, 0) - - _temp_measurement_src_bit = RWBit(_DPS310_TMPCFG, 7) - - _pressure_shiftbit = RWBit(_DPS310_CFGREG, 2) - _temp_shiftbit = RWBit(_DPS310_CFGREG, 3) - - _coefficients_ready = RWBit(_DPS310_MEASCFG, 7) - _sensor_ready = RWBit(_DPS310_MEASCFG, 6) - _temp_ready = RWBit(_DPS310_MEASCFG, 5) - _pressure_ready = RWBit(_DPS310_MEASCFG, 4) - - _raw_pressure = ROBits(24, _DPS310_PRSB2, 0, 3, lsb_first=False) - _raw_temperature = ROBits(24, _DPS310_TMPB2, 0, 3, lsb_first=False) - - _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) - - _reg0e = RWBits(8, 0x0E, 0) - _reg0f = RWBits(8, 0x0F, 0) - _reg62 = RWBits(8, 0x62, 0) def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): - self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) - - if self._device_id != _DPS310_DEVICE_ID: - raise RuntimeError("Failed to find DPS310 - check your wiring!") - self._pressure_scale = None - self._temp_scale = None - self._c0 = None - self._c1 = None - self._c00 = None - self._c00 = None - self._c10 = None - self._c10 = None - self._c01 = None - self._c11 = None - self._c20 = None - self._c21 = None - self._c30 = None - self._oversample_scalefactor = ( - 524288, - 1572864, - 3670016, - 7864320, - 253952, - 516096, - 1040384, - 2088960, - ) + super().__init__(i2c_bus, _DPS310_DEFAULT_ADDRESS) + self.sea_level_pressure = 1013.25 """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" self.initialize() @@ -268,69 +190,6 @@ def initialize(self): self.wait_temperature_ready() self.wait_pressure_ready() - # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) - # similar to DpsClass::correctTemp(void) from infineon's c++ library - def _correct_temp(self): - """Correct temperature readings on ICs with a fuse bit problem""" - self._reg0e = 0xA5 - self._reg0f = 0x96 - self._reg62 = 0x02 - self._reg0e = 0 - self._reg0f = 0 - - # perform a temperature measurement - # the most recent temperature will be saved internally - # and used for compensation when calculating pressure - _unused = self._raw_temperature - - def reset(self): - """Reset the sensor""" - self._reset_register = 0x89 - # wait for hardware reset to finish - sleep(0.010) - while not self._sensor_ready: - sleep(0.001) - self._correct_temp() - self._read_calibration() - # make sure we're using the temperature source used for calibration - self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit - - @property - def pressure(self): - """Returns the current pressure reading in kPA""" - - temp_reading = self._raw_temperature - raw_temperature = self._twos_complement(temp_reading, 24) - pressure_reading = self._raw_pressure - raw_pressure = self._twos_complement(pressure_reading, 24) - _scaled_rawtemp = raw_temperature / self._temp_scale - - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - - p_red = raw_pressure / self._pressure_scale - - pres_calc = ( - self._c00 - + p_red * (self._c10 + p_red * (self._c20 + p_red * self._c30)) - + _scaled_rawtemp * (self._c01 + p_red * (self._c11 + p_red * self._c21)) - ) - - final_pressure = pres_calc / 100 - return final_pressure - - @property - def altitude(self): - """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - - which you must enter ahead of time)""" - return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) - - @property - def temperature(self): - """The current temperature reading in degrees Celsius""" - _scaled_rawtemp = self._raw_temperature / self._temp_scale - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - return _temperature - @property def temperature_ready(self): """Returns true if there is a temperature reading ready""" @@ -442,44 +301,3 @@ def temperature_oversample_count(self, value): self._temp_osbits = value self._temp_scale = self._oversample_scalefactor[value] self._temp_shiftbit = value > SampleCount.COUNT_8 - - @staticmethod - def _twos_complement(val, bits): - if val & (1 << (bits - 1)): - val -= 1 << bits - - return val - - def _read_calibration(self): - - while not self._coefficients_ready: - sleep(0.001) - - buffer = bytearray(19) - coeffs = [None] * 18 - for offset in range(18): - buffer = bytearray(2) - buffer[0] = 0x10 + offset - - with self.i2c_device as i2c: - - i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) - - coeffs[offset] = buffer[1] - - self._c0 = (coeffs[0] << 4) | ((coeffs[1] >> 4) & 0x0F) - self._c0 = self._twos_complement(self._c0, 12) - - self._c1 = self._twos_complement(((coeffs[1] & 0x0F) << 8) | coeffs[2], 12) - - self._c00 = (coeffs[3] << 12) | (coeffs[4] << 4) | ((coeffs[5] >> 4) & 0x0F) - self._c00 = self._twos_complement(self._c00, 20) - - self._c10 = ((coeffs[5] & 0x0F) << 16) | (coeffs[6] << 8) | coeffs[7] - self._c10 = self._twos_complement(self._c10, 20) - - self._c01 = self._twos_complement((coeffs[8] << 8) | coeffs[9], 16) - self._c11 = self._twos_complement((coeffs[10] << 8) | coeffs[11], 16) - self._c20 = self._twos_complement((coeffs[12] << 8) | coeffs[13], 16) - self._c21 = self._twos_complement((coeffs[14] << 8) | coeffs[15], 16) - self._c30 = self._twos_complement((coeffs[16] << 8) | coeffs[17], 16) From b979ab58eed2130cceb9d57057b7b65d9e4d07fd Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:32:42 -0400 Subject: [PATCH 034/110] Added pull request template Signed-off-by: dherrada --- .../adafruit_circuitpython_pr.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md new file mode 100644 index 0000000..71ef8f8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2021 Adafruit Industries +# +# SPDX-License-Identifier: MIT + +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 + +If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs + +Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code + +Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. From b9efae282455aec67744ad7a41db3885282cf01b Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:35:18 -0400 Subject: [PATCH 035/110] Added help text and problem matcher Signed-off-by: dherrada --- .github/workflows/build.yml | 2 ++ .github/workflows/failure-help-text.yml | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .github/workflows/failure-help-text.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3baf502..0ab7182 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,3 +71,5 @@ jobs: python setup.py sdist python setup.py bdist_wheel --universal twine check dist/* + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml new file mode 100644 index 0000000..0b1194f --- /dev/null +++ b/.github/workflows/failure-help-text.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Failure help text + +on: + workflow_run: + workflows: ["Build CI"] + types: + - completed + +jobs: + post-help: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} + steps: + - name: Post comment to help + uses: adafruit/circuitpython-action-library-ci-failed@v1 From a42e5317fa6420da14de3ceddb454f6fd965a360 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Wed, 19 May 2021 20:30:53 -0400 Subject: [PATCH 036/110] packaging_separate_files --- adafruit_dps310/__init__.py | 286 ------------------ adafruit_dps310/dps310_basic.py | 286 ++++++++++++++++++ ...310_featured.py => dps310_configurable.py} | 6 +- docs/api.rst | 6 + docs/examples.rst | 13 +- examples/dps310_simpletest.py | 4 +- examples/dps310_simpletest_configurable.py | 15 + 7 files changed, 324 insertions(+), 292 deletions(-) create mode 100644 adafruit_dps310/dps310_basic.py rename adafruit_dps310/{dps310_featured.py => dps310_configurable.py} (98%) create mode 100644 examples/dps310_simpletest_configurable.py diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py index b777182..e69de29 100644 --- a/adafruit_dps310/__init__.py +++ b/adafruit_dps310/__init__.py @@ -1,286 +0,0 @@ -# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -""" -`adafruit_dps310` -================================================================================ - -Library for the DPS310 Precision Barometric Pressure Sensor - -* Author(s): Bryan Siepert - -Implementation Notes --------------------- - -**Hardware:** - -* `Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor - `_ (Product ID: 4494) - -**Software and Dependencies:** - -* Adafruit CircuitPython firmware for the supported boards: - https://circuitpython.org/downloads - -* Adafruit's Bus Device library: - https://github.com/adafruit/Adafruit_CircuitPython_BusDevice - -* Adafruit's Register library: - https://github.com/adafruit/Adafruit_CircuitPython_Register - -""" - -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" - -# Common imports; remove if unused or pylint will complain -import math -from time import sleep -from micropython import const -import adafruit_bus_device.i2c_device as i2c_device -from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct -from adafruit_register.i2c_bit import RWBit, ROBit -from adafruit_register.i2c_bits import RWBits, ROBits - -_DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address -_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier - -_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data -_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data -_DPS310_PRSCFG = const(0x06) # Pressure configuration -_DPS310_TMPCFG = const(0x07) # Temperature configuration -_DPS310_MEASCFG = const(0x08) # Sensor configuration -_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration -_DPS310_RESET = const(0x0C) # Soft reset -_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID -_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src - - -class DPS310: - # pylint: disable=too-many-instance-attributes - """Library for the DPS310 Precision Barometric Pressure Sensor. - Depending on your board memory availability you could use DPS310_Featured. - - :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. - :param int address: The I2C device address. Defaults to :const:`0x77` - - **Quickstart: Importing and using the DPS310** - - Here is an example of using the :class:`DPS310` class. - First you will need to import the libraries to use the sensor - - .. code-block:: python - - import board - import adafruit_dps310 - - Once this is done you can define your `board.I2C` object and define your sensor object - - .. code-block:: python - - i2c = board.I2C() # uses board.SCL and board.SDA - dps310 = adafruit_dps310.DPS310(i2c) - - Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. - - .. code-block:: python - - temperature = dps310.temperature - pressure = dps310.pressure - - """ - # Register definitions - _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") - _reset_register = UnaryStruct(_DPS310_RESET, ">B") - _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) # - - _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) - - _temp_osbits = RWBits(4, _DPS310_TMPCFG, 0) - - _temp_measurement_src_bit = RWBit(_DPS310_TMPCFG, 7) - - _pressure_shiftbit = RWBit(_DPS310_CFGREG, 2) - _temp_shiftbit = RWBit(_DPS310_CFGREG, 3) - - _coefficients_ready = RWBit(_DPS310_MEASCFG, 7) - _sensor_ready = RWBit(_DPS310_MEASCFG, 6) - _temp_ready = RWBit(_DPS310_MEASCFG, 5) - _pressure_ready = RWBit(_DPS310_MEASCFG, 4) - - _raw_pressure = ROBits(24, _DPS310_PRSB2, 0, 3, lsb_first=False) - _raw_temperature = ROBits(24, _DPS310_TMPB2, 0, 3, lsb_first=False) - - _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) - - _reg0e = RWBits(8, 0x0E, 0) - _reg0f = RWBits(8, 0x0F, 0) - _reg62 = RWBits(8, 0x62, 0) - - def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): - self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) - - if self._device_id != _DPS310_DEVICE_ID: - raise RuntimeError("Failed to find DPS310 - check your wiring!") - self._pressure_scale = None - self._temp_scale = None - self._c0 = None - self._c1 = None - self._c00 = None - self._c00 = None - self._c10 = None - self._c10 = None - self._c01 = None - self._c11 = None - self._c20 = None - self._c21 = None - self._c30 = None - self._oversample_scalefactor = ( - 524288, - 1572864, - 3670016, - 7864320, - 253952, - 516096, - 1040384, - 2088960, - ) - self.sea_level_pressure = 1013.25 - """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" - self.initialize() - - def initialize(self): - """Initialize the sensor to continuous measurement""" - - self.reset() - - self._pressure_osbits = 6 - self._pressure_shiftbit = True - self._pressure_scale = self._oversample_scalefactor[6] - - self._temp_osbits = 6 - self._temp_scale = self._oversample_scalefactor[6] - self._temp_shiftbit = True - - self._mode_bits = 7 - - # wait until we have at least one good measurement - self.wait_temperature_ready() - self.wait_pressure_ready() - - # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) - # similar to DpsClass::correctTemp(void) from infineon's c++ library - def _correct_temp(self): - """Correct temperature readings on ICs with a fuse bit problem""" - self._reg0e = 0xA5 - self._reg0f = 0x96 - self._reg62 = 0x02 - self._reg0e = 0 - self._reg0f = 0 - - # perform a temperature measurement - # the most recent temperature will be saved internally - # and used for compensation when calculating pressure - _unused = self._raw_temperature - - def reset(self): - """Reset the sensor""" - self._reset_register = 0x89 - # wait for hardware reset to finish - sleep(0.010) - while not self._sensor_ready: - sleep(0.001) - self._correct_temp() - self._read_calibration() - # make sure we're using the temperature source used for calibration - self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit - - @property - def pressure(self): - """Returns the current pressure reading in kPA""" - - temp_reading = self._raw_temperature - raw_temperature = self._twos_complement(temp_reading, 24) - pressure_reading = self._raw_pressure - raw_pressure = self._twos_complement(pressure_reading, 24) - _scaled_rawtemp = raw_temperature / self._temp_scale - - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - - p_red = raw_pressure / self._pressure_scale - - pres_calc = ( - self._c00 - + p_red * (self._c10 + p_red * (self._c20 + p_red * self._c30)) - + _scaled_rawtemp * (self._c01 + p_red * (self._c11 + p_red * self._c21)) - ) - - final_pressure = pres_calc / 100 - return final_pressure - - @property - def altitude(self): - """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - - which you must enter ahead of time)""" - return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) - - @property - def temperature(self): - """The current temperature reading in degrees Celsius""" - _scaled_rawtemp = self._raw_temperature / self._temp_scale - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - return _temperature - - def wait_temperature_ready(self): - """Wait until a temperature measurement is available.""" - - while self._temp_ready is False: - sleep(0.001) - - def wait_pressure_ready(self): - """Wait until a pressure measurement is available""" - - while self._pressure_ready is False: - sleep(0.001) - - @staticmethod - def _twos_complement(val, bits): - if val & (1 << (bits - 1)): - val -= 1 << bits - - return val - - def _read_calibration(self): - - while not self._coefficients_ready: - sleep(0.001) - - buffer = bytearray(19) - coeffs = [None] * 18 - for offset in range(18): - buffer = bytearray(2) - buffer[0] = 0x10 + offset - - with self.i2c_device as i2c: - - i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) - - coeffs[offset] = buffer[1] - - self._c0 = (coeffs[0] << 4) | ((coeffs[1] >> 4) & 0x0F) - self._c0 = self._twos_complement(self._c0, 12) - - self._c1 = self._twos_complement(((coeffs[1] & 0x0F) << 8) | coeffs[2], 12) - - self._c00 = (coeffs[3] << 12) | (coeffs[4] << 4) | ((coeffs[5] >> 4) & 0x0F) - self._c00 = self._twos_complement(self._c00, 20) - - self._c10 = ((coeffs[5] & 0x0F) << 16) | (coeffs[6] << 8) | coeffs[7] - self._c10 = self._twos_complement(self._c10, 20) - - self._c01 = self._twos_complement((coeffs[8] << 8) | coeffs[9], 16) - self._c11 = self._twos_complement((coeffs[10] << 8) | coeffs[11], 16) - self._c20 = self._twos_complement((coeffs[12] << 8) | coeffs[13], 16) - self._c21 = self._twos_complement((coeffs[14] << 8) | coeffs[15], 16) - self._c30 = self._twos_complement((coeffs[16] << 8) | coeffs[17], 16) diff --git a/adafruit_dps310/dps310_basic.py b/adafruit_dps310/dps310_basic.py new file mode 100644 index 0000000..d7d9244 --- /dev/null +++ b/adafruit_dps310/dps310_basic.py @@ -0,0 +1,286 @@ +# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_dps310.dps310_basic` +================================================================================ + +Library for the DPS310 Precision Barometric Pressure Sensor + +* Author(s): Bryan Siepert, Jose David M. + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor + `_ (Product ID: 4494) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register + +""" + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" + +# Common imports; remove if unused or pylint will complain +import math +from time import sleep +from micropython import const +import adafruit_bus_device.i2c_device as i2c_device +from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct +from adafruit_register.i2c_bit import RWBit, ROBit +from adafruit_register.i2c_bits import RWBits, ROBits + +_DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address +_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier + +_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +_DPS310_PRSCFG = const(0x06) # Pressure configuration +_DPS310_TMPCFG = const(0x07) # Temperature configuration +_DPS310_MEASCFG = const(0x08) # Sensor configuration +_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +_DPS310_RESET = const(0x0C) # Soft reset +_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src + + +class DPS310: + # pylint: disable=too-many-instance-attributes + """Library for the DPS310 Precision Barometric Pressure Sensor. + Depending on your board memory availability you could use DPS310_Featured. + + :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. + :param int address: The I2C device address. Defaults to :const:`0x77` + + **Quickstart: Importing and using the DPS310** + + Here is an example of using the :class:`DPS310` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + import adafruit_dps310 + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + dps310 = adafruit_dps310.DPS310(i2c) + + Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. + + .. code-block:: python + + temperature = dps310.temperature + pressure = dps310.pressure + + """ + # Register definitions + _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") + _reset_register = UnaryStruct(_DPS310_RESET, ">B") + _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) # + + _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) + + _temp_osbits = RWBits(4, _DPS310_TMPCFG, 0) + + _temp_measurement_src_bit = RWBit(_DPS310_TMPCFG, 7) + + _pressure_shiftbit = RWBit(_DPS310_CFGREG, 2) + _temp_shiftbit = RWBit(_DPS310_CFGREG, 3) + + _coefficients_ready = RWBit(_DPS310_MEASCFG, 7) + _sensor_ready = RWBit(_DPS310_MEASCFG, 6) + _temp_ready = RWBit(_DPS310_MEASCFG, 5) + _pressure_ready = RWBit(_DPS310_MEASCFG, 4) + + _raw_pressure = ROBits(24, _DPS310_PRSB2, 0, 3, lsb_first=False) + _raw_temperature = ROBits(24, _DPS310_TMPB2, 0, 3, lsb_first=False) + + _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) + + _reg0e = RWBits(8, 0x0E, 0) + _reg0f = RWBits(8, 0x0F, 0) + _reg62 = RWBits(8, 0x62, 0) + + def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): + self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) + + if self._device_id != _DPS310_DEVICE_ID: + raise RuntimeError("Failed to find DPS310 - check your wiring!") + self._pressure_scale = None + self._temp_scale = None + self._c0 = None + self._c1 = None + self._c00 = None + self._c00 = None + self._c10 = None + self._c10 = None + self._c01 = None + self._c11 = None + self._c20 = None + self._c21 = None + self._c30 = None + self._oversample_scalefactor = ( + 524288, + 1572864, + 3670016, + 7864320, + 253952, + 516096, + 1040384, + 2088960, + ) + self.sea_level_pressure = 1013.25 + """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" + self.initialize() + + def initialize(self): + """Initialize the sensor to continuous measurement""" + + self.reset() + + self._pressure_osbits = 6 + self._pressure_shiftbit = True + self._pressure_scale = self._oversample_scalefactor[6] + + self._temp_osbits = 6 + self._temp_scale = self._oversample_scalefactor[6] + self._temp_shiftbit = True + + self._mode_bits = 7 + + # wait until we have at least one good measurement + self.wait_temperature_ready() + self.wait_pressure_ready() + + # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) + # similar to DpsClass::correctTemp(void) from infineon's c++ library + def _correct_temp(self): + """Correct temperature readings on ICs with a fuse bit problem""" + self._reg0e = 0xA5 + self._reg0f = 0x96 + self._reg62 = 0x02 + self._reg0e = 0 + self._reg0f = 0 + + # perform a temperature measurement + # the most recent temperature will be saved internally + # and used for compensation when calculating pressure + _unused = self._raw_temperature + + def reset(self): + """Reset the sensor""" + self._reset_register = 0x89 + # wait for hardware reset to finish + sleep(0.010) + while not self._sensor_ready: + sleep(0.001) + self._correct_temp() + self._read_calibration() + # make sure we're using the temperature source used for calibration + self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit + + @property + def pressure(self): + """Returns the current pressure reading in kPA""" + + temp_reading = self._raw_temperature + raw_temperature = self._twos_complement(temp_reading, 24) + pressure_reading = self._raw_pressure + raw_pressure = self._twos_complement(pressure_reading, 24) + _scaled_rawtemp = raw_temperature / self._temp_scale + + _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 + + p_red = raw_pressure / self._pressure_scale + + pres_calc = ( + self._c00 + + p_red * (self._c10 + p_red * (self._c20 + p_red * self._c30)) + + _scaled_rawtemp * (self._c01 + p_red * (self._c11 + p_red * self._c21)) + ) + + final_pressure = pres_calc / 100 + return final_pressure + + @property + def altitude(self): + """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - + which you must enter ahead of time)""" + return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) + + @property + def temperature(self): + """The current temperature reading in degrees Celsius""" + _scaled_rawtemp = self._raw_temperature / self._temp_scale + _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 + return _temperature + + def wait_temperature_ready(self): + """Wait until a temperature measurement is available.""" + + while self._temp_ready is False: + sleep(0.001) + + def wait_pressure_ready(self): + """Wait until a pressure measurement is available""" + + while self._pressure_ready is False: + sleep(0.001) + + @staticmethod + def _twos_complement(val, bits): + if val & (1 << (bits - 1)): + val -= 1 << bits + + return val + + def _read_calibration(self): + + while not self._coefficients_ready: + sleep(0.001) + + buffer = bytearray(19) + coeffs = [None] * 18 + for offset in range(18): + buffer = bytearray(2) + buffer[0] = 0x10 + offset + + with self.i2c_device as i2c: + + i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) + + coeffs[offset] = buffer[1] + + self._c0 = (coeffs[0] << 4) | ((coeffs[1] >> 4) & 0x0F) + self._c0 = self._twos_complement(self._c0, 12) + + self._c1 = self._twos_complement(((coeffs[1] & 0x0F) << 8) | coeffs[2], 12) + + self._c00 = (coeffs[3] << 12) | (coeffs[4] << 4) | ((coeffs[5] >> 4) & 0x0F) + self._c00 = self._twos_complement(self._c00, 20) + + self._c10 = ((coeffs[5] & 0x0F) << 16) | (coeffs[6] << 8) | coeffs[7] + self._c10 = self._twos_complement(self._c10, 20) + + self._c01 = self._twos_complement((coeffs[8] << 8) | coeffs[9], 16) + self._c11 = self._twos_complement((coeffs[10] << 8) | coeffs[11], 16) + self._c20 = self._twos_complement((coeffs[12] << 8) | coeffs[13], 16) + self._c21 = self._twos_complement((coeffs[14] << 8) | coeffs[15], 16) + self._c30 = self._twos_complement((coeffs[16] << 8) | coeffs[17], 16) diff --git a/adafruit_dps310/dps310_featured.py b/adafruit_dps310/dps310_configurable.py similarity index 98% rename from adafruit_dps310/dps310_featured.py rename to adafruit_dps310/dps310_configurable.py index 16af1c0..40f5823 100644 --- a/adafruit_dps310/dps310_featured.py +++ b/adafruit_dps310/dps310_configurable.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310.dps310_featured` +`adafruit_dps310.dps310_configurable` ================================================================================ Library for the DPS310 Precision Barometric Pressure Sensor @@ -37,7 +37,7 @@ from time import sleep from micropython import const from adafruit_register.i2c_bits import RWBits -from adafruit_dps310 import DPS310 +from adafruit_dps310.dps310_basic import DPS310 # pylint: disable=no-member,unnecessary-pass @@ -158,7 +158,7 @@ class SampleCount(CV): _DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src -class DPS310_Featured(DPS310): +class DPS310_Configurable(DPS310): # pylint: disable=too-many-instance-attributes """Library for the DPS310 Precision Barometric Pressure Sensor. This class contains all the options available for the Sensor diff --git a/docs/api.rst b/docs/api.rst index c41be33..9dbe960 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -6,4 +6,10 @@ .. automodule:: adafruit_dps310 :members: + +.. automodule:: adafruit_dps310.dps310_basic + :members: + +.. automodule:: adafruit_dps310.dps310_configurable + :members: :exclude-members: CV, SampleCount diff --git a/docs/examples.rst b/docs/examples.rst index f38db7e..c07fb9d 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,12 +1,23 @@ Simple test ------------ -Ensure your device works with this simple test. +Ensure your device works with this simple test. For low memory capacity boards .. literalinclude:: ../examples/dps310_simpletest.py :caption: examples/dps310_simpletest.py :linenos: +Simple test configurable +------------------------ + +This is a more advance example that shows the full feature library to use with boards +where memory allows to use them + +.. literalinclude:: ../examples/dps310_simpletest_configurable.py + :caption: examples/dps310_simpletest_configurable.py + :linenos: + + Lower Power Weather Station --------------------------- diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 9245b70..5653067 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -3,10 +3,10 @@ import time import board -import adafruit_dps310 +from adafruit_dps310.dps310_basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA -dps310 = adafruit_dps310.DPS310(i2c) +dps310 = DPS310(i2c) while True: print("Temperature = %.2f *C" % dps310.temperature) diff --git a/examples/dps310_simpletest_configurable.py b/examples/dps310_simpletest_configurable.py new file mode 100644 index 0000000..975972c --- /dev/null +++ b/examples/dps310_simpletest_configurable.py @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +import time +import board +from adafruit_dps310.dps310_configurable import DPS310_Configurable + +i2c = board.I2C() # uses board.SCL and board.SDA +dps310 = DPS310_Configurable(i2c) + +while True: + print("Temperature = %.2f *C" % dps310.temperature) + print("Pressure = %.2f hPa" % dps310.pressure) + print("") + time.sleep(1.0) From 10df0394efd686a3acad27c2384432a9fc05045e Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Thu, 20 May 2021 20:52:40 -0400 Subject: [PATCH 037/110] dps310_low_memory_footprint --- README.rst | 18 +++------ .../{dps310_basic.py => dps310.py} | 2 +- ...310_configurable.py => dps310_advanced.py} | 40 ++++++++++++++++--- docs/api.rst | 4 +- docs/examples.rst | 8 ++-- examples/dps310_low_power_weather_station.py | 17 ++++---- examples/dps310_simpletest.py | 2 +- ...rable.py => dps310_simpletest_advanced.py} | 6 +-- 8 files changed, 58 insertions(+), 39 deletions(-) rename adafruit_dps310/{dps310_basic.py => dps310.py} (99%) rename adafruit_dps310/{dps310_configurable.py => dps310_advanced.py} (89%) rename examples/{dps310_simpletest_configurable.py => dps310_simpletest_advanced.py} (61%) diff --git a/README.rst b/README.rst index dd3cbb5..9092116 100644 --- a/README.rst +++ b/README.rst @@ -60,11 +60,11 @@ Usage Example import time import board - import adafruit_dps310 + from adafruit_dps310.dps310 import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA - dps310 = adafruit_dps310.DPS310(i2c) + dps310 = DPS310(i2c) while True: print("Temperature = %.2f *C"%dps310.temperature) @@ -74,20 +74,12 @@ Usage Example Caveat: by default the library initializes the IC with constant temperature and pressure measurements at 64Hz with 64 samples. It is not possible to change the IC's mode, temperature_oversample_count or pressure_oversample_count on-the-fly so resetting the IC and operation parameteres is required. For instance, to set the mode to continuous pressure measurement at 1Hz with 2 samples: -.. code-block:: python3 - - dps310.reset() - dps310.pressure_oversample_count = adafruit_dps310.SampleCount.COUNT_2 - dps310.pressure_rate = adafruit_dps310.Rate.RATE_1_HZ - dps310.mode = adafruit_dps310.Mode.CONT_PRESSURE - dps310.wait_pressure_ready() - - Known Issues ============ -Library extensive features might not be compatible with memory limited boards. Library might not -load in SAMD21 boards and others with 32KB of RAM or less. +Library extensive features might not be compatible with memory limited boards. +For boards with more memory avalaible you could use the code present +in ``dps310_advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` Contributing diff --git a/adafruit_dps310/dps310_basic.py b/adafruit_dps310/dps310.py similarity index 99% rename from adafruit_dps310/dps310_basic.py rename to adafruit_dps310/dps310.py index d7d9244..2d5aec9 100644 --- a/adafruit_dps310/dps310_basic.py +++ b/adafruit_dps310/dps310.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310.dps310_basic` +`adafruit_dps310.dps310` ================================================================================ Library for the DPS310 Precision Barometric Pressure Sensor diff --git a/adafruit_dps310/dps310_configurable.py b/adafruit_dps310/dps310_advanced.py similarity index 89% rename from adafruit_dps310/dps310_configurable.py rename to adafruit_dps310/dps310_advanced.py index 40f5823..7b4b7ff 100644 --- a/adafruit_dps310/dps310_configurable.py +++ b/adafruit_dps310/dps310_advanced.py @@ -3,12 +3,13 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310.dps310_configurable` +`adafruit_dps310.dps310_advanced` ================================================================================ -Library for the DPS310 Precision Barometric Pressure Sensor +Library for the DPS310 Precision Barometric Pressure Sensor. This is the advanced +version. Includes some features not present in `adafruit_dps310.dps310` -* Author(s): Bryan Siepert +* Author(s): Bryan Siepert, Jose David M. Implementation Notes -------------------- @@ -37,7 +38,7 @@ from time import sleep from micropython import const from adafruit_register.i2c_bits import RWBits -from adafruit_dps310.dps310_basic import DPS310 +from adafruit_dps310.dps310 import DPS310 # pylint: disable=no-member,unnecessary-pass @@ -158,10 +159,37 @@ class SampleCount(CV): _DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src -class DPS310_Configurable(DPS310): +class DPS310_Advanced(DPS310): # pylint: disable=too-many-instance-attributes """Library for the DPS310 Precision Barometric Pressure Sensor. - This class contains all the options available for the Sensor + This class contains some of other configurable features + + :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. + :param int address: The I2C device address. Defaults to :const:`0x77` + + **Quickstart: Importing and using the DPS310** + + Here is an example of using the :class:`DPS310_Advanced` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_dps310.dps310_advanced import DPS310_Advanced as DPS310 + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + dps310 = DPS310(i2c) + + Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. + + .. code-block:: python + + temperature = dps310.temperature + pressure = dps310.pressure """ # Register definitions diff --git a/docs/api.rst b/docs/api.rst index 9dbe960..8896fce 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -7,9 +7,9 @@ .. automodule:: adafruit_dps310 :members: -.. automodule:: adafruit_dps310.dps310_basic +.. automodule:: adafruit_dps310.dps310 :members: -.. automodule:: adafruit_dps310.dps310_configurable +.. automodule:: adafruit_dps310.dps310_advanced :members: :exclude-members: CV, SampleCount diff --git a/docs/examples.rst b/docs/examples.rst index c07fb9d..d2c9992 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -7,14 +7,14 @@ Ensure your device works with this simple test. For low memory capacity boards :caption: examples/dps310_simpletest.py :linenos: -Simple test configurable +Simple test advanced ------------------------ This is a more advance example that shows the full feature library to use with boards -where memory allows to use them +where memory allows to use it -.. literalinclude:: ../examples/dps310_simpletest_configurable.py - :caption: examples/dps310_simpletest_configurable.py +.. literalinclude:: ../examples/dps310_simpletest_advanced.py + :caption: examples/dps310_simpletest_advanced.py :linenos: diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 53b75e2..016a626 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -3,7 +3,7 @@ """ Configure the sensor for continuous measurement with rates, -sampling counts and mode optmized for low power, as recommended +sampling counts and mode optimized for low power, as recommended in Infineon's datasheet: https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf """ @@ -14,18 +14,17 @@ import time import board -import adafruit_dps310 +from adafruit_dps310 import dps310_advanced i2c = board.I2C() # uses board.SCL and board.SDA - -dps310 = adafruit_dps310.DPS310(i2c) +dps310 = dps310_advanced.DPS310_Advanced(i2c) dps310.reset() -dps310.pressure_oversample_count = adafruit_dps310.SampleCount.COUNT_2 -dps310.pressure_rate = adafruit_dps310.Rate.RATE_1_HZ -dps310.temperature_oversample_count = adafruit_dps310.SampleCount.COUNT_16 -dps310.temperature_rate = adafruit_dps310.Rate.RATE_1_HZ -dps310.mode = adafruit_dps310.Mode.CONT_PRESTEMP +dps310.pressure_oversample_count = dps310_advanced.SampleCount.COUNT_2 +dps310.pressure_rate = dps310_advanced.Rate.RATE_1_HZ +dps310.temperature_oversample_count = dps310_advanced.SampleCount.COUNT_16 +dps310.temperature_rate = dps310_advanced.Rate.RATE_1_HZ +dps310.mode = dps310_advanced.Mode.CONT_PRESTEMP dps310.wait_temperature_ready() dps310.wait_pressure_ready() diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 5653067..03ce1af 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -1,9 +1,9 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT +from adafruit_dps310.dps310 import DPS310 import time import board -from adafruit_dps310.dps310_basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA dps310 = DPS310(i2c) diff --git a/examples/dps310_simpletest_configurable.py b/examples/dps310_simpletest_advanced.py similarity index 61% rename from examples/dps310_simpletest_configurable.py rename to examples/dps310_simpletest_advanced.py index 975972c..6c3de44 100644 --- a/examples/dps310_simpletest_configurable.py +++ b/examples/dps310_simpletest_advanced.py @@ -1,12 +1,12 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2021 Jose David M. # SPDX-License-Identifier: MIT import time import board -from adafruit_dps310.dps310_configurable import DPS310_Configurable +from adafruit_dps310.dps310_advanced import DPS310_Advanced as DPS310 i2c = board.I2C() # uses board.SCL and board.SDA -dps310 = DPS310_Configurable(i2c) +dps310 = DPS310(i2c) while True: print("Temperature = %.2f *C" % dps310.temperature) From e2cc742f65c844674cf7339af7c4f983a7f01726 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sun, 23 May 2021 18:40:49 -0400 Subject: [PATCH 038/110] dps310_basic_advanced --- .../{dps310_advanced.py => advanced.py} | 4 ++-- adafruit_dps310/{dps310.py => basic.py} | 2 +- docs/api.rst | 4 ++-- examples/dps310_low_power_weather_station.py | 14 +++++++------- examples/dps310_simpletest.py | 2 +- examples/dps310_simpletest_advanced.py | 2 +- 6 files changed, 14 insertions(+), 14 deletions(-) rename adafruit_dps310/{dps310_advanced.py => advanced.py} (99%) rename adafruit_dps310/{dps310.py => basic.py} (99%) diff --git a/adafruit_dps310/dps310_advanced.py b/adafruit_dps310/advanced.py similarity index 99% rename from adafruit_dps310/dps310_advanced.py rename to adafruit_dps310/advanced.py index 7b4b7ff..a03dce3 100644 --- a/adafruit_dps310/dps310_advanced.py +++ b/adafruit_dps310/advanced.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310.dps310_advanced` +`adafruit_dps310.advanced` ================================================================================ Library for the DPS310 Precision Barometric Pressure Sensor. This is the advanced @@ -38,7 +38,7 @@ from time import sleep from micropython import const from adafruit_register.i2c_bits import RWBits -from adafruit_dps310.dps310 import DPS310 +from adafruit_dps310.basic import DPS310 # pylint: disable=no-member,unnecessary-pass diff --git a/adafruit_dps310/dps310.py b/adafruit_dps310/basic.py similarity index 99% rename from adafruit_dps310/dps310.py rename to adafruit_dps310/basic.py index 2d5aec9..c44221d 100644 --- a/adafruit_dps310/dps310.py +++ b/adafruit_dps310/basic.py @@ -3,7 +3,7 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310.dps310` +`adafruit_dps310.basic` ================================================================================ Library for the DPS310 Precision Barometric Pressure Sensor diff --git a/docs/api.rst b/docs/api.rst index 8896fce..bdb631c 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -7,9 +7,9 @@ .. automodule:: adafruit_dps310 :members: -.. automodule:: adafruit_dps310.dps310 +.. automodule:: adafruit_dps310.basic :members: -.. automodule:: adafruit_dps310.dps310_advanced +.. automodule:: adafruit_dps310.advanced :members: :exclude-members: CV, SampleCount diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 016a626..facb550 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -14,17 +14,17 @@ import time import board -from adafruit_dps310 import dps310_advanced +from adafruit_dps310 import advanced i2c = board.I2C() # uses board.SCL and board.SDA -dps310 = dps310_advanced.DPS310_Advanced(i2c) +dps310 = advanced.DPS310_Advanced(i2c) dps310.reset() -dps310.pressure_oversample_count = dps310_advanced.SampleCount.COUNT_2 -dps310.pressure_rate = dps310_advanced.Rate.RATE_1_HZ -dps310.temperature_oversample_count = dps310_advanced.SampleCount.COUNT_16 -dps310.temperature_rate = dps310_advanced.Rate.RATE_1_HZ -dps310.mode = dps310_advanced.Mode.CONT_PRESTEMP +dps310.pressure_oversample_count = advanced.SampleCount.COUNT_2 +dps310.pressure_rate = advanced.Rate.RATE_1_HZ +dps310.temperature_oversample_count = advanced.SampleCount.COUNT_16 +dps310.temperature_rate = advanced.Rate.RATE_1_HZ +dps310.mode = advanced.Mode.CONT_PRESTEMP dps310.wait_temperature_ready() dps310.wait_pressure_ready() diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 03ce1af..5e18d55 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -1,7 +1,7 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -from adafruit_dps310.dps310 import DPS310 +from adafruit_dps310.basic import DPS310 import time import board diff --git a/examples/dps310_simpletest_advanced.py b/examples/dps310_simpletest_advanced.py index 6c3de44..b80579f 100644 --- a/examples/dps310_simpletest_advanced.py +++ b/examples/dps310_simpletest_advanced.py @@ -3,7 +3,7 @@ import time import board -from adafruit_dps310.dps310_advanced import DPS310_Advanced as DPS310 +from adafruit_dps310.advanced import DPS310_Advanced as DPS310 i2c = board.I2C() # uses board.SCL and board.SDA dps310 = DPS310(i2c) From 7354a4cf093b286a2d633680ea7e6a8b5cef85f2 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Sun, 23 May 2021 18:43:34 -0400 Subject: [PATCH 039/110] dps310_correcting_reference --- adafruit_dps310/advanced.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index a03dce3..9ef92b2 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -7,7 +7,7 @@ ================================================================================ Library for the DPS310 Precision Barometric Pressure Sensor. This is the advanced -version. Includes some features not present in `adafruit_dps310.dps310` +version. Includes some features not present in `adafruit_dps310.basic` * Author(s): Bryan Siepert, Jose David M. From 25f07362e5147bf17f5bb543aafd5f6189653d5a Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 May 2021 09:54:31 -0400 Subject: [PATCH 040/110] Moved CI to Python 3.7 Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0ab7182..c4c975d 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.6 + - name: Set up Python 3.7 uses: actions/setup-python@v1 with: - python-version: 3.6 + python-version: 3.7 - name: Versions run: | python3 --version From 1c05bc85be073f79062b369b24a578658b62f09c Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Mon, 24 May 2021 17:24:05 -0400 Subject: [PATCH 041/110] correcting_returning_units --- adafruit_dps310.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 653d11d..21af478 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -297,7 +297,7 @@ def reset(self): @property def pressure(self): - """Returns the current pressure reading in kPA""" + """Returns the current pressure reading in hPA""" temp_reading = self._raw_temperature raw_temperature = self._twos_complement(temp_reading, 24) From 9a6ce5376c1a983ce97d4e1aa81f3b4fbbb69615 Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:48:49 -0400 Subject: [PATCH 042/110] Update README.rst Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9092116..c96f6b5 100644 --- a/README.rst +++ b/README.rst @@ -78,7 +78,7 @@ Caveat: by default the library initializes the IC with constant temperature and Known Issues ============ Library extensive features might not be compatible with memory limited boards. -For boards with more memory avalaible you could use the code present +For boards with more memory available you could use the code present in ``dps310_advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` From 40f67673bca5f52404ef8f49078e3575d20460d6 Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:48:56 -0400 Subject: [PATCH 043/110] Update README.rst Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c96f6b5..a604159 100644 --- a/README.rst +++ b/README.rst @@ -60,7 +60,7 @@ Usage Example import time import board - from adafruit_dps310.dps310 import DPS310 + from adafruit_dps310.basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA From f3b8e0e9bf3d347494b6b72dfb64b20c0d24c1fc Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:49:08 -0400 Subject: [PATCH 044/110] Update README.rst Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a604159..cc9569d 100644 --- a/README.rst +++ b/README.rst @@ -79,7 +79,7 @@ Known Issues ============ Library extensive features might not be compatible with memory limited boards. For boards with more memory available you could use the code present -in ``dps310_advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` +in ``adafruit_dps310/dps310_advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` Contributing From 8f2013a67b1f223d7e9b1d73c1f28d31880a8055 Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:49:16 -0400 Subject: [PATCH 045/110] Update adafruit_dps310/advanced.py Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- adafruit_dps310/advanced.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 9ef92b2..61fa754 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -146,17 +146,17 @@ class SampleCount(CV): # pylint: enable=unnecessary-pass _DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address -_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier +#_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier -_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data -_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +#_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +#_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data _DPS310_PRSCFG = const(0x06) # Pressure configuration _DPS310_TMPCFG = const(0x07) # Temperature configuration -_DPS310_MEASCFG = const(0x08) # Sensor configuration -_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration -_DPS310_RESET = const(0x0C) # Soft reset -_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID -_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src +#_DPS310_MEASCFG = const(0x08) # Sensor configuration +#_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +#_DPS310_RESET = const(0x0C) # Soft reset +#_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +#_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src class DPS310_Advanced(DPS310): From 75345e95d7e51882fecba499ef7779a6aefd8c91 Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:49:33 -0400 Subject: [PATCH 046/110] Update adafruit_dps310/basic.py Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- adafruit_dps310/basic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index c44221d..a4c7500 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -80,7 +80,7 @@ class DPS310: .. code-block:: python i2c = board.I2C() # uses board.SCL and board.SDA - dps310 = adafruit_dps310.DPS310(i2c) + dps310 = DPS310(i2c) Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. From 591bb7906793961e6fa1c3f23707f999f1b9b78f Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:49:41 -0400 Subject: [PATCH 047/110] Update adafruit_dps310/basic.py Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- adafruit_dps310/basic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index a4c7500..67dbc3c 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -73,7 +73,7 @@ class DPS310: .. code-block:: python import board - import adafruit_dps310 + from adafruit_dps310.basic import DPS310 Once this is done you can define your `board.I2C` object and define your sensor object From d9cd8dedd424c80778967ef495bb01deab96d72c Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 07:50:15 -0400 Subject: [PATCH 048/110] Update adafruit_dps310/advanced.py Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- adafruit_dps310/advanced.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 61fa754..c270414 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -199,9 +199,6 @@ class DPS310_Advanced(DPS310): def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): super().__init__(i2c_bus, _DPS310_DEFAULT_ADDRESS) - self.sea_level_pressure = 1013.25 - """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" - self.initialize() def initialize(self): """Initialize the sensor to continuous measurement""" From ef9555e5495fe32d1a9e905b743ffea2607835e7 Mon Sep 17 00:00:00 2001 From: jposada202020 <34255413+jposada202020@users.noreply.github.com> Date: Tue, 25 May 2021 08:39:43 -0400 Subject: [PATCH 049/110] Update adafruit_dps310/basic.py Co-authored-by: James Carr <70200140+lesamouraipourpre@users.noreply.github.com> --- adafruit_dps310/basic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 67dbc3c..375da32 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -60,7 +60,7 @@ class DPS310: # pylint: disable=too-many-instance-attributes """Library for the DPS310 Precision Barometric Pressure Sensor. - Depending on your board memory availability you could use DPS310_Featured. + Depending on your board memory availability you could use DPS310_Advanced. :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. :param int address: The I2C device address. Defaults to :const:`0x77` From 36c7fca80646d5b3f39225c813124b6eb2c75285 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Thu, 27 May 2021 09:39:13 -0400 Subject: [PATCH 050/110] adding_sea_level_pressure_property --- README.rst | 12 ++++++++---- adafruit_dps310/advanced.py | 17 ++++++++--------- adafruit_dps310/basic.py | 19 ++++++++++++++++--- docs/conf.py | 6 +++++- 4 files changed, 37 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index cc9569d..4c7fa5c 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/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 + Library for the DPS310 Precision Barometric Pressure Sensor @@ -72,14 +76,14 @@ Usage Example print("") time.sleep(1.0) -Caveat: by default the library initializes the IC with constant temperature and pressure measurements at 64Hz with 64 samples. It is not possible to change the IC's mode, temperature_oversample_count or pressure_oversample_count on-the-fly so resetting the IC and operation parameteres is required. For instance, to set the mode to continuous pressure measurement at 1Hz with 2 samples: - Known Issues ============ -Library extensive features might not be compatible with memory limited boards. +Library extensive features might not be compatible with memory limited boards. For these kind of +boards you need to use the ``adafruit_dps310/basic.mpy``, the file needs to be in the ``mpy`` +format in order to fit in memory. For boards with more memory available you could use the code present -in ``adafruit_dps310/dps310_advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` +in ``adafruit_dps310/advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` Contributing diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index c270414..6d34050 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -146,17 +146,17 @@ class SampleCount(CV): # pylint: enable=unnecessary-pass _DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address -#_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier +# _DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier -#_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data -#_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +# _DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +# _DPS310_TMPB2 = const(0x03) # Highest byte of temperature data _DPS310_PRSCFG = const(0x06) # Pressure configuration _DPS310_TMPCFG = const(0x07) # Temperature configuration -#_DPS310_MEASCFG = const(0x08) # Sensor configuration -#_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration -#_DPS310_RESET = const(0x0C) # Soft reset -#_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID -#_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src +# _DPS310_MEASCFG = const(0x08) # Sensor configuration +# _DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +# _DPS310_RESET = const(0x0C) # Soft reset +# _DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +# _DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src class DPS310_Advanced(DPS310): @@ -199,7 +199,6 @@ class DPS310_Advanced(DPS310): def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): super().__init__(i2c_bus, _DPS310_DEFAULT_ADDRESS) - def initialize(self): """Initialize the sensor to continuous measurement""" diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 375da32..3cec65b 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -146,8 +146,8 @@ def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): 1040384, 2088960, ) - self.sea_level_pressure = 1013.25 - """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" + self._sea_level_pressure = 1013.25 + self.initialize() def initialize(self): @@ -223,7 +223,9 @@ def pressure(self): def altitude(self): """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - which you must enter ahead of time)""" - return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) + return 44330 * ( + 1.0 - math.pow(self.pressure / self._sea_level_pressure, 0.1903) + ) @property def temperature(self): @@ -232,6 +234,17 @@ def temperature(self): _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 return _temperature + @property + def sea_level_pressure(self): + """The local sea level pressure in hectoPascals (aka millibars). This is used + for calculation of :attr:`altitude`. Values are typically in the range + 980 - 1030.""" + return self._sea_level_pressure + + @sea_level_pressure.setter + def sea_level_pressure(self, value): + self._sea_level_pressure = value + def wait_temperature_ready(self): """Wait until a temperature measurement is available.""" diff --git a/docs/conf.py b/docs/conf.py index feb5500..7fc0e3f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,7 +25,11 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["adafruit_register", "adafruit_bus_device"] +autodoc_mock_imports = [ + "adafruit_register", + "adafruit_bus_device", + "micropython", +] intersphinx_mapping = { From 54e0496658b296fb25181d0f1e30be32e35205c4 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 7 Jun 2021 14:52:14 -0400 Subject: [PATCH 051/110] Moved default branch to main --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index dd3cbb5..832e8e7 100644 --- a/README.rst +++ b/README.rst @@ -94,7 +94,7 @@ Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Documentation From 833ebab1529c18db4925ba7945c9d68c3a8f0772 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Thu, 10 Jun 2021 11:45:04 -0400 Subject: [PATCH 052/110] adding_library_installation_description and changing_from `py_module to `packages` --- README.rst | 23 +++++++++++++++++++++++ setup.py | 2 +- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 4c7fa5c..e471535 100644 --- a/README.rst +++ b/README.rst @@ -57,6 +57,29 @@ To install in a virtual environment in your current project: source .env/bin/activate pip3 install adafruit-circuitpython-dps310 + +Installing to a connected CircuitPython Device +============================================== +Some devices, eg. the QT-PY, are very limited in memory. The DPS310 library contains +two variants - basic and advanced - which give different levels of functionality. + +Installing the DPS310 library could have the following outcomes: + + * It installs successfully and your code runs successfully. Woo-hoo! Continue with + your amazing project. + * It installs successfully and your code fails to run with a memory allocation + error. Try one of the following: + + * If your ``code.py`` is large, especially if it has lots of comments, you + can shrink it into a ``.mpy`` file instead. See the Adafruit + `Learn Guide `_ + on shrinking your code. + * Only use the basic DPS310 implementation, and remove the following file: + ``/lib/adafruit_dps310/advanced.mpy`` where is the + mounted location of your device. Make sure that your code only uses the basic + implementation. + + Usage Example ============= diff --git a/setup.py b/setup.py index da2cdeb..8d63b8b 100644 --- a/setup.py +++ b/setup.py @@ -58,5 +58,5 @@ # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_dps310"], + packages=["adafruit_dps310"], ) From 1645fe69b1ad78a93122a68b4352b086a1b90200 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 23 Sep 2021 17:52:55 -0400 Subject: [PATCH 053/110] Globally disabled consider-using-f-string pylint check Signed-off-by: dherrada --- .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 354c761..8810708 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,5 +30,5 @@ repos: name: pylint (examples code) description: Run pylint rules on "examples/*.py" files entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] language: system From 7d00a0635adf43ebbb43d8a3cb677a56ee8bd782 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 25 Oct 2021 11:15:04 -0500 Subject: [PATCH 054/110] add docs link to readme --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index 832e8e7..751501a 100644 --- a/README.rst +++ b/README.rst @@ -90,6 +90,11 @@ Library extensive features might not be compatible with memory limited boards. L load in SAMD21 boards and others with 32KB of RAM or less. +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + Contributing ============ From e22b07b3a601dd40beddc507fbcae44b6b038061 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Nov 2021 14:40:16 -0400 Subject: [PATCH 055/110] PATCH Pylint and readthedocs patch test Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- .pre-commit-config.yaml | 26 +++++++++++++++++--------- .pylintrc | 2 +- .readthedocs.yml | 2 +- docs/requirements.txt | 5 +++++ 5 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c4c975d..ca35544 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8810708..1b9fadc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,17 +18,25 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 + rev: v2.11.1 hooks: - id: pylint name: pylint (library code) types: [python] - exclude: "^(docs/|examples/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) + 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 - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] - language: system + 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 diff --git a/.pylintrc b/.pylintrc index 0238b90..e78bad2 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=12 +min-similarity-lines=4 [BASIC] diff --git a/.readthedocs.yml b/.readthedocs.yml index ffa84c4..49dcab3 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,4 +4,4 @@ python: version: 3 -requirements_file: requirements.txt +requirements_file: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..88e6733 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx>=4.0.0 From c11e8ad2bd792abcf7996d8b30677bab3cacb6ca Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 056/110] Disabled unspecified-encoding pylint check Signed-off-by: dherrada --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index e78bad2..cfd1c41 100644 --- a/.pylintrc +++ b/.pylintrc @@ -55,7 +55,7 @@ confidence= # 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 +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 # 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 From c5a1fb5a7346bdf7c102a6a3e583ff6ae3081f9d Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 8 Nov 2021 12:20:05 -0500 Subject: [PATCH 057/110] Linted --- adafruit_dps310.py | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/adafruit_dps310.py b/adafruit_dps310.py index 21af478..3151faa 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310.py @@ -37,7 +37,7 @@ # Common imports; remove if unused or pylint will complain import math from time import sleep -import adafruit_bus_device.i2c_device as i2c_device +from adafruit_bus_device import i2c_device from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct from adafruit_register.i2c_bit import RWBit, ROBit from adafruit_register.i2c_bits import RWBits, ROBits @@ -344,11 +344,7 @@ def wait_temperature_ready(self): ie. ``Mode.ONE_TEMPERATURE``, ``Mode.CONT_TEMP`` or ``Mode.CONT_PRESTEMP``. See the `Mode` documentation for details. """ - if ( - self._mode_bits == Mode.IDLE - or self._mode_bits == Mode.ONE_PRESSURE - or self._mode_bits == Mode.CONT_PRESSURE - ): + if self._mode_bits in (Mode.IDLE, Mode.ONE_PRESSURE, Mode.CONT_PRESSURE): raise RuntimeError( "Sensor mode is set to idle or pressure measurement,\ can't wait for a temperature measurement" @@ -369,11 +365,7 @@ def wait_pressure_ready(self): ie. ``Mode.ONE_PRESSURE``, ``Mode.CONT_PRESSURE`` or ``Mode.CONT_PRESTEMP`` See the `Mode` documentation for details. """ - if ( - self._mode_bits == Mode.IDLE - or self._mode_bits == Mode.ONE_TEMPERATURE - or self._mode_bits == Mode.CONT_TEMP - ): + if self._mode_bits in (Mode.IDLE, Mode.ONE_TEMPERATURE, Mode.CONT_TEMP): raise RuntimeError( "Sensor mode is set to idle or temperature measurement,\ can't wait for a pressure measurement" From 314fd0d21a8b25455fa05d6d42149c1f80e1586b Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 058/110] 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 659ca5f3c60e26ae910bcad99cbc75845fb1ddf4 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:00:49 -0600 Subject: [PATCH 059/110] 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 f2464bb5c5b21cc5437271ebd4c9949ffe6a3ecf Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 6 Jan 2022 16:55:16 -0600 Subject: [PATCH 060/110] merge main. fix pylint issues --- adafruit_dps310/basic.py | 2 +- examples/dps310_simpletest.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 3cec65b..7c8a8a4 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -38,7 +38,7 @@ import math from time import sleep from micropython import const -import adafruit_bus_device.i2c_device as i2c_device +from adafruit_bus_device import i2c_device from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct from adafruit_register.i2c_bit import RWBit, ROBit from adafruit_register.i2c_bits import RWBits, ROBits diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 5e18d55..fde0331 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -1,9 +1,9 @@ # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # SPDX-License-Identifier: MIT -from adafruit_dps310.basic import DPS310 import time import board +from adafruit_dps310.basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA dps310 = DPS310(i2c) From f1556ddb10e8bb11bf30b5ae0c82b99d06960afe Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 9 Jan 2022 16:00:00 -0600 Subject: [PATCH 061/110] provide default import --- adafruit_dps310/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py index e69de29..279c84a 100644 --- a/adafruit_dps310/__init__.py +++ b/adafruit_dps310/__init__.py @@ -0,0 +1 @@ +from adafruit_dps310.advanced import DPS310_Advanced as DPS310 \ No newline at end of file From 978b6fe8495c1076f8799a55a4bc42e68b871eec Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 9 Jan 2022 16:04:25 -0600 Subject: [PATCH 062/110] add copyright and comment for CI checks --- adafruit_dps310/__init__.py | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py index 279c84a..1a33f8c 100644 --- a/adafruit_dps310/__init__.py +++ b/adafruit_dps310/__init__.py @@ -1 +1,16 @@ -from adafruit_dps310.advanced import DPS310_Advanced as DPS310 \ No newline at end of file +# SPDX-FileCopyrightText: 2022 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_dps310` +================================================================================ +Dynamic progress bar widget for CircuitPython displays +* Author(s): Bryan Siepert, Jose David M. +Implementation Notes +-------------------- +**Software and Dependencies:** +* Adafruit CircuitPython firmware for the supported boards: + https://github.com/adafruit/circuitpython/releases +""" +from adafruit_dps310.advanced import DPS310_Advanced as DPS310 From 5c9f2063c443354a6a14ccafbd707d5b8a9683a6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 9 Jan 2022 16:07:37 -0600 Subject: [PATCH 063/110] correct docstring --- adafruit_dps310/__init__.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py index 1a33f8c..9a17e32 100644 --- a/adafruit_dps310/__init__.py +++ b/adafruit_dps310/__init__.py @@ -5,7 +5,8 @@ """ `adafruit_dps310` ================================================================================ -Dynamic progress bar widget for CircuitPython displays +Library for the DPS310 Precision Barometric Pressure Sensor + * Author(s): Bryan Siepert, Jose David M. Implementation Notes -------------------- From 5a2c1faea76aa539a447c2db8e1fca0da22504f9 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 9 Jan 2022 16:12:04 -0600 Subject: [PATCH 064/110] sphinx fix for docstring --- adafruit_dps310/__init__.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py index 9a17e32..1a476bf 100644 --- a/adafruit_dps310/__init__.py +++ b/adafruit_dps310/__init__.py @@ -1,17 +1,13 @@ -# SPDX-FileCopyrightText: 2022 Tim Cocks for Adafruit Industries +# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries # # SPDX-License-Identifier: MIT """ `adafruit_dps310` ================================================================================ + Library for the DPS310 Precision Barometric Pressure Sensor * Author(s): Bryan Siepert, Jose David M. -Implementation Notes --------------------- -**Software and Dependencies:** -* Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases """ from adafruit_dps310.advanced import DPS310_Advanced as DPS310 From deff414e1bc6bf85e3f9d490d2b6eda86fb3c7a0 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 065/110] 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 7fb27d6d8855f1f6565a65dbadb4071d5cf97328 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:16 -0500 Subject: [PATCH 066/110] 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 9232008..bd2a4b9 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-dsp310/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/dps310/en/latest/ + :target: https://docs.circuitpython.org/projects/dps310/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -112,7 +112,7 @@ in ``adafruit_dps310/advanced.py``. For usage refer to ``dps310_simpletest_advan 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 7fc0e3f..a3e71a5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -33,16 +33,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 3b48c21..a3c1b95 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 8d63b8b..c8606fd 100644 --- a/setup.py +++ b/setup.py @@ -48,8 +48,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit blinka circuitpython micropython dps310 pressure sensor barometric " From fb5437cb39026bf8c1c2729004390c59c5dbd1ec Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 9 Feb 2022 12:49:50 -0500 Subject: [PATCH 067/110] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index bd2a4b9..b81f7e7 100644 --- a/README.rst +++ b/README.rst @@ -114,14 +114,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From e11e7ce761e0517bfe89aaa75a7315600bc398f6 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 068/110] 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 8c4112e7f1aeb3dcf840492ab488d0059a1b2b0e Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 069/110] 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 1b1d156f06f4a6eca7302a502c3b95891ed39830 Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 29 Mar 2022 08:04:46 -0700 Subject: [PATCH 070/110] fix address --- adafruit_dps310/advanced.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 9ed7e94..9d90585 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -197,7 +197,7 @@ class DPS310_Advanced(DPS310): _temp_ratebits = RWBits(3, _DPS310_TMPCFG, 4) def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): - super().__init__(i2c_bus, _DPS310_DEFAULT_ADDRESS) + super().__init__(i2c_bus, address) def initialize(self): """Initialize the sensor to continuous measurement""" From a8f0009102a1fca19a40c3f1516b8ef8ff6e5498 Mon Sep 17 00:00:00 2001 From: caternuson Date: Tue, 29 Mar 2022 08:12:25 -0700 Subject: [PATCH 071/110] remove init --- adafruit_dps310/advanced.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 9d90585..47aaef3 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -196,9 +196,6 @@ class DPS310_Advanced(DPS310): _pressure_ratebits = RWBits(3, _DPS310_PRSCFG, 4) _temp_ratebits = RWBits(3, _DPS310_TMPCFG, 4) - def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): - super().__init__(i2c_bus, address) - def initialize(self): """Initialize the sensor to continuous measurement""" From ff8a17c577261ebefaf8e3de3ea0933af8829c72 Mon Sep 17 00:00:00 2001 From: Eva Herrada <33632497+evaherrada@users.noreply.github.com> Date: Thu, 21 Apr 2022 18:50:45 -0400 Subject: [PATCH 072/110] Update .gitignore --- .gitignore | 47 +++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 39 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 5fb597b..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +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 0dddbf94e3ff1dc5bc2773348525fc07cc6d378e Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:58:35 -0400 Subject: [PATCH 073/110] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index b81f7e7..c04ed80 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/dps310/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 a0285cc3aec2e4668cbd613a74e6897fac118d79 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:50:43 -0500 Subject: [PATCH 074/110] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c04ed80..a4eab37 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/dps310/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 631e70982558b92672b5af50ffb05245d47cc2ee Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:25:34 -0400 Subject: [PATCH 075/110] 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 8097a9bfcdfdf81f346dc7717b4eccc58d7798c8 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 076/110] 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 4cacbd6bc687e5ce4bf018c8d410e3b4c9dc1246 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 077/110] 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 e0007ba64770fcb6f694fafadd3e5e4e4cfe0c9b Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 078/110] 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 a3e71a5..84dd517 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,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 0b4f55cc25aa8502836ba7f16ca64cc177303463 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:17 -0400 Subject: [PATCH 079/110] 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 a3c1b95..63c6604 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 b0a44b68e4959f0f62b8730f94d82290f0aa5625 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 28 Jun 2022 21:09:38 -0400 Subject: [PATCH 080/110] Fix units in docstrings --- adafruit_dps310/basic.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 7c8a8a4..4a8afe3 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -198,7 +198,7 @@ def reset(self): @property def pressure(self): - """Returns the current pressure reading in kPA""" + """Returns the current pressure reading in hPA""" temp_reading = self._raw_temperature raw_temperature = self._twos_complement(temp_reading, 24) @@ -221,8 +221,8 @@ def pressure(self): @property def altitude(self): - """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - - which you must enter ahead of time)""" + """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) + in hPa - which you must enter ahead of time""" return 44330 * ( 1.0 - math.pow(self.pressure / self._sea_level_pressure, 0.1903) ) From 38d4829dddf820ba39e2846c0cc5b2f598aafe6b Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 28 Jun 2022 21:19:01 -0400 Subject: [PATCH 081/110] Update docstrings --- adafruit_dps310/basic.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 4a8afe3..0181659 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -198,7 +198,7 @@ def reset(self): @property def pressure(self): - """Returns the current pressure reading in hPA""" + """Returns the current pressure reading in hectoPascals (hPa)""" temp_reading = self._raw_temperature raw_temperature = self._twos_complement(temp_reading, 24) @@ -221,8 +221,10 @@ def pressure(self): @property def altitude(self): - """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - in hPa - which you must enter ahead of time""" + """The altitude in meters based on the sea level pressure + (:attr:`sea_level_pressure`) - which you must enter + ahead of time + """ return 44330 * ( 1.0 - math.pow(self.pressure / self._sea_level_pressure, 0.1903) ) From 49a3d696572b07414234245c7cd011ac2bbec1ab Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 28 Jun 2022 21:20:01 -0400 Subject: [PATCH 082/110] Reorganized and changed variable names for pressure property --- adafruit_dps310/basic.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 0181659..d62d212 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -202,18 +202,19 @@ def pressure(self): temp_reading = self._raw_temperature raw_temperature = self._twos_complement(temp_reading, 24) + pressure_reading = self._raw_pressure raw_pressure = self._twos_complement(pressure_reading, 24) - _scaled_rawtemp = raw_temperature / self._temp_scale - - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - p_red = raw_pressure / self._pressure_scale + scaled_rawtemp = raw_temperature / self._temp_scale + scaled_rawpres = raw_pressure / self._pressure_scale pres_calc = ( self._c00 - + p_red * (self._c10 + p_red * (self._c20 + p_red * self._c30)) - + _scaled_rawtemp * (self._c01 + p_red * (self._c11 + p_red * self._c21)) + + scaled_rawpres + * (self._c10 + scaled_rawpres * (self._c20 + scaled_rawpres * self._c30)) + + scaled_rawtemp + * (self._c01 + scaled_rawpres * (self._c11 + scaled_rawpres * self._c21)) ) final_pressure = pres_calc / 100 From 6c61ba762c9a69754baa220f8c30e57b8cbbcdb8 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:58:42 -0400 Subject: [PATCH 083/110] 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 a4eab37..cec262a 100644 --- a/README.rst +++ b/README.rst @@ -53,8 +53,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-dps310 From 5b5feeefb66a83ca4b44a66b4f7850ef814951b6 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:52 -0400 Subject: [PATCH 084/110] Switched to pyproject.toml --- .github/workflows/build.yml | 18 ++++++----- .github/workflows/release.yml | 17 ++++++---- optional_requirements.txt | 3 ++ pyproject.toml | 48 ++++++++++++++++++++++++++++ requirements.txt | 4 +-- setup.py | 60 ----------------------------------- 6 files changed, 73 insertions(+), 77 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..9479b15 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-dps310" +description = "Library for the DPS310 Precision Barometric Pressure Sensor" +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_DPS310"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "dps310", + "pressure", + "sensor", + "barometric", + "altimeter", + "altitude", +] +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] +packages = ["adafruit_dps310"] + +[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 c8606fd..0000000 --- a/setup.py +++ /dev/null @@ -1,60 +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 -""" - -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-dps310", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Library for the DPS310 Precision Barometric Pressure Sensor", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_DPS310", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-busdevice", - "adafruit-circuitpython-register", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython dps310 pressure sensor barometric " - "altimeter altitude", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - packages=["adafruit_dps310"], -) From fb52e0a6f4e8b4952db2559868a4a271f2a691bb Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 085/110] 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 9479b15..2339f12 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 99fa656944cd1ca5eddce266cfd02bd1eeb5ffd9 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:13 -0400 Subject: [PATCH 086/110] Update version string --- adafruit_dps310/advanced.py | 2 +- adafruit_dps310/basic.py | 2 +- pyproject.toml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 47aaef3..9bdfed2 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -32,7 +32,7 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" from time import sleep diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index d62d212..a45febc 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -31,7 +31,7 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" # Common imports; remove if unused or pylint will complain diff --git a/pyproject.toml b/pyproject.toml index 2339f12..35e7ef6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-dps310" description = "Library for the DPS310 Precision Barometric Pressure Sensor" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From 36939b7935c9dab20e07ff14b662b94db830f109 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:13 -0400 Subject: [PATCH 087/110] 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 424000a61b67a29949e7226277fda7197400e4e4 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:30 -0400 Subject: [PATCH 088/110] 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 84dd517..b62ff02 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("..")) @@ -55,7 +56,8 @@ # General information about the project. project = "Adafruit DPS310 Library" -copyright = "2020 Bryan Siepert" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for From f59f31b3e5ee1493d05febf9758e015c3b495484 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:20 -0400 Subject: [PATCH 089/110] 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 b62ff02..af51479 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,8 +56,14 @@ # General information about the project. project = "Adafruit DPS310 Library" +creation_year = "2020" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Bryan Siepert" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for From 1f8fbba824622a608c02e48630673b2d2d5094c6 Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Thu, 22 Sep 2022 12:43:22 -0400 Subject: [PATCH 090/110] Add Missing Type Annotations --- adafruit_dps310/advanced.py | 41 ++++++++++++++++++++++--------------- adafruit_dps310/basic.py | 32 +++++++++++++++++------------ 2 files changed, 43 insertions(+), 30 deletions(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 9bdfed2..036d366 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -40,6 +40,11 @@ from adafruit_register.i2c_bits import RWBits from adafruit_dps310.basic import DPS310 +try: + from typing import Tuple, Union +except ImportError: + pass + # pylint: disable=no-member,unnecessary-pass @@ -47,7 +52,9 @@ class CV: """struct helper""" @classmethod - def add_values(cls, value_tuples): + def add_values( + cls, value_tuples: Tuple[str, int, Union[str, int], Union[str, int, None]] + ): """Add CV values to the class""" cls.string = {} cls.lsb = {} @@ -59,7 +66,7 @@ def add_values(cls, value_tuples): cls.lsb[value] = lsb @classmethod - def is_valid(cls, value): + def is_valid(cls, value: int) -> bool: """Validate that a given value is a member""" return value in cls.string @@ -196,7 +203,7 @@ class DPS310_Advanced(DPS310): _pressure_ratebits = RWBits(3, _DPS310_PRSCFG, 4) _temp_ratebits = RWBits(3, _DPS310_TMPCFG, 4) - def initialize(self): + def initialize(self) -> None: """Initialize the sensor to continuous measurement""" self.reset() @@ -212,11 +219,11 @@ def initialize(self): self.wait_pressure_ready() @property - def temperature_ready(self): + def temperature_ready(self) -> bool: """Returns true if there is a temperature reading ready""" return self._temp_ready - def wait_temperature_ready(self): + def wait_temperature_ready(self) -> None: """Wait until a temperature measurement is available. To avoid waiting indefinitely this function raises an @@ -233,11 +240,11 @@ def wait_temperature_ready(self): sleep(0.001) @property - def pressure_ready(self): + def pressure_ready(self) -> bool: """Returns true if pressure readings are ready""" return self._pressure_ready - def wait_pressure_ready(self): + def wait_pressure_ready(self) -> None: """Wait until a pressure measurement is available To avoid waiting indefinitely this function raises an @@ -254,35 +261,35 @@ def wait_pressure_ready(self): sleep(0.001) @property - def mode(self): + def mode(self) -> int: """The measurement mode. Must be a `Mode`. See the `Mode` documentation for details""" return self._mode_bits @mode.setter - def mode(self, value): + def mode(self, value: int) -> None: if not Mode.is_valid(value): raise AttributeError("mode must be an `Mode`") self._mode_bits = value @property - def pressure_rate(self): + def pressure_rate(self) -> int: """Configure the pressure measurement rate. Must be a `Rate`""" return self._pressure_ratebits @pressure_rate.setter - def pressure_rate(self, value): + def pressure_rate(self, value: int) -> None: if not Rate.is_valid(value): raise AttributeError("pressure_rate must be a Rate") self._pressure_ratebits = value @property - def pressure_oversample_count(self): + def pressure_oversample_count(self) -> int: """The number of samples taken per pressure measurement. Must be a ``SampleCount``""" return self._pressure_osbits @pressure_oversample_count.setter - def pressure_oversample_count(self, value): + def pressure_oversample_count(self, value: int) -> None: if not SampleCount.is_valid(value): raise AttributeError("pressure_oversample_count must be a SampleCount") @@ -291,23 +298,23 @@ def pressure_oversample_count(self, value): self._pressure_scale = self._oversample_scalefactor[value] @property - def temperature_rate(self): + def temperature_rate(self) -> int: """Configure the temperature measurement rate. Must be a `Rate`""" return self._temp_ratebits @temperature_rate.setter - def temperature_rate(self, value): + def temperature_rate(self, value: int) -> None: if not Rate.is_valid(value): raise AttributeError("temperature_rate must be a Rate") self._temp_ratebits = value @property - def temperature_oversample_count(self): + def temperature_oversample_count(self) -> int: """The number of samples taken per temperature measurement. Must be a ``SampleCount``""" return self._temp_osbits @temperature_oversample_count.setter - def temperature_oversample_count(self, value): + def temperature_oversample_count(self, value: int) -> None: if not SampleCount.is_valid(value): raise AttributeError("temperature_oversample_count must be a SampleCount") diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index a45febc..95cf12d 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -43,6 +43,12 @@ from adafruit_register.i2c_bit import RWBit, ROBit from adafruit_register.i2c_bits import RWBits, ROBits +try: + import typing # pylint: disable=unused-import + from busio import I2C +except ImportError: + pass + _DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address _DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier @@ -118,7 +124,7 @@ class DPS310: _reg0f = RWBits(8, 0x0F, 0) _reg62 = RWBits(8, 0x62, 0) - def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): + def __init__(self, i2c_bus: I2C, address: int = _DPS310_DEFAULT_ADDRESS) -> None: self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) if self._device_id != _DPS310_DEVICE_ID: @@ -150,7 +156,7 @@ def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): self.initialize() - def initialize(self): + def initialize(self) -> None: """Initialize the sensor to continuous measurement""" self.reset() @@ -171,7 +177,7 @@ def initialize(self): # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) # similar to DpsClass::correctTemp(void) from infineon's c++ library - def _correct_temp(self): + def _correct_temp(self) -> None: """Correct temperature readings on ICs with a fuse bit problem""" self._reg0e = 0xA5 self._reg0f = 0x96 @@ -184,7 +190,7 @@ def _correct_temp(self): # and used for compensation when calculating pressure _unused = self._raw_temperature - def reset(self): + def reset(self) -> None: """Reset the sensor""" self._reset_register = 0x89 # wait for hardware reset to finish @@ -197,7 +203,7 @@ def reset(self): self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit @property - def pressure(self): + def pressure(self) -> float: """Returns the current pressure reading in hectoPascals (hPa)""" temp_reading = self._raw_temperature @@ -221,7 +227,7 @@ def pressure(self): return final_pressure @property - def altitude(self): + def altitude(self) -> float: """The altitude in meters based on the sea level pressure (:attr:`sea_level_pressure`) - which you must enter ahead of time @@ -231,43 +237,43 @@ def altitude(self): ) @property - def temperature(self): + def temperature(self) -> float: """The current temperature reading in degrees Celsius""" _scaled_rawtemp = self._raw_temperature / self._temp_scale _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 return _temperature @property - def sea_level_pressure(self): + def sea_level_pressure(self) -> int: """The local sea level pressure in hectoPascals (aka millibars). This is used for calculation of :attr:`altitude`. Values are typically in the range 980 - 1030.""" return self._sea_level_pressure @sea_level_pressure.setter - def sea_level_pressure(self, value): + def sea_level_pressure(self, value: int) -> None: self._sea_level_pressure = value - def wait_temperature_ready(self): + def wait_temperature_ready(self) -> None: """Wait until a temperature measurement is available.""" while self._temp_ready is False: sleep(0.001) - def wait_pressure_ready(self): + def wait_pressure_ready(self) -> None: """Wait until a pressure measurement is available""" while self._pressure_ready is False: sleep(0.001) @staticmethod - def _twos_complement(val, bits): + def _twos_complement(val: int, bits: int) -> int: if val & (1 << (bits - 1)): val -= 1 << bits return val - def _read_calibration(self): + def _read_calibration(self) -> None: while not self._coefficients_ready: sleep(0.001) From 497b56a8b3ec951167d5d04a036459cc0dbce74c Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Sun, 25 Sep 2022 20:31:58 -0400 Subject: [PATCH 091/110] rework CV Tuple to be Iterable --- adafruit_dps310/advanced.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 036d366..7bc1071 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -41,7 +41,7 @@ from adafruit_dps310.basic import DPS310 try: - from typing import Tuple, Union + from typing import Iterable, Optional, Tuple, Union except ImportError: pass @@ -53,7 +53,7 @@ class CV: @classmethod def add_values( - cls, value_tuples: Tuple[str, int, Union[str, int], Union[str, int, None]] + cls, value_tuples: Iterable[Tuple[str, int, Union[str, int], Optional[float]]] ): """Add CV values to the class""" cls.string = {} From 3c2ff50ec0613649ff7bdb5df235ca20c0b9d58a Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Tue, 27 Sep 2022 10:38:36 -0400 Subject: [PATCH 092/110] changed sea_level_pressure setter and getter to float --- adafruit_dps310/basic.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 95cf12d..db6b7d8 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -244,14 +244,14 @@ def temperature(self) -> float: return _temperature @property - def sea_level_pressure(self) -> int: + def sea_level_pressure(self) -> float: """The local sea level pressure in hectoPascals (aka millibars). This is used for calculation of :attr:`altitude`. Values are typically in the range 980 - 1030.""" return self._sea_level_pressure @sea_level_pressure.setter - def sea_level_pressure(self, value: int) -> None: + def sea_level_pressure(self, value: float) -> None: self._sea_level_pressure = value def wait_temperature_ready(self) -> None: From f145ce8b61d2533d553ea6b349ddc2574f6f9b09 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 093/110] 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 7aa6bc406fb5c201b1405f99271d0eeb015b5f15 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 094/110] 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 9d30d100c26f5653ef3fca87cfad5c3784414f1f 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 095/110] 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 28e9cf4b7637a838afb6f5fc88097f334a2ff16d 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 096/110] 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 1c19d0c5d6830c10b38590876da2adf632daee6f 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 097/110] 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 be5b3900b62f809596d630cb798dd9cd6ae35f65 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 18 Nov 2022 13:05:22 -0500 Subject: [PATCH 098/110] Added commented out board.STEMMA_I2C with explanation --- examples/dps310_low_power_weather_station.py | 1 + examples/dps310_simpletest.py | 1 + examples/dps310_simpletest_advanced.py | 1 + 3 files changed, 3 insertions(+) diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index facb550..01cdc85 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -17,6 +17,7 @@ from adafruit_dps310 import advanced i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller dps310 = advanced.DPS310_Advanced(i2c) dps310.reset() diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index fde0331..4fad858 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -6,6 +6,7 @@ from adafruit_dps310.basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller dps310 = DPS310(i2c) while True: diff --git a/examples/dps310_simpletest_advanced.py b/examples/dps310_simpletest_advanced.py index b80579f..eec8f82 100644 --- a/examples/dps310_simpletest_advanced.py +++ b/examples/dps310_simpletest_advanced.py @@ -6,6 +6,7 @@ from adafruit_dps310.advanced import DPS310_Advanced as DPS310 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller dps310 = DPS310(i2c) while True: From abeeee5689b34443896fb9a0d10b07f16458b68c 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 099/110] 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 b9dc369bf1422f225d52519fdab09b6bf4867052 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 100/110] 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 3f5beb9151d44233666d263a5133a8ea812b144d Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 101/110] 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 1dde965c4a4ec745637556e0ff9399b5acf4a29f Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:31:09 -0400 Subject: [PATCH 102/110] Run pre-commit --- adafruit_dps310/basic.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index db6b7d8..0a71a72 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -274,7 +274,6 @@ def _twos_complement(val: int, bits: int) -> int: return val def _read_calibration(self) -> None: - while not self._coefficients_ready: sleep(0.001) @@ -285,7 +284,6 @@ def _read_calibration(self) -> None: buffer[0] = 0x10 + offset with self.i2c_device as i2c: - i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) coeffs[offset] = buffer[1] From a3581360861d46cb0af992cc60707ce3d81aaa49 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Sun, 14 May 2023 13:00:32 -0400 Subject: [PATCH 103/110] Update .pylintrc, fix jQuery for docs Signed-off-by: Tekktrik --- .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 af51479..ccfb7cd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From a483c8ed34cfd9dd287a51ecc59b890140ee5c08 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:17:41 -0500 Subject: [PATCH 104/110] "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 ccfb7cd..249c90b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -113,19 +113,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 a4ff500c7e3c141bdeb48b8b89dcd6ea5b43b875 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 105/110] 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 d416e0e222f926f5e4e228ab3acd9a471087a9c1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 106/110] 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 249c90b..21d501e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,7 +116,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 6951f24179e4db1767d5779cee19a9ce3d9d5460 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 107/110] 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 5d65aa1a4fc92818ca1aa23338b96d5b17f97541 Mon Sep 17 00:00:00 2001 From: JPOSADA202020 Date: Sat, 25 Jan 2025 11:45:46 -0500 Subject: [PATCH 108/110] adding_displayio_example --- docs/examples.rst | 9 +++++ examples/dps310_displayio_simpletest.py | 44 +++++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 examples/dps310_displayio_simpletest.py diff --git a/docs/examples.rst b/docs/examples.rst index d2c9992..2fe988a 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -27,3 +27,12 @@ sampling counts and mode optimized for low power .. literalinclude:: ../examples/dps310_low_power_weather_station.py :caption: examples/dps310_low_power_weather_station.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/dps310_displayio_simpletest.py + :caption: examples/dps310_displayio_simpletest.py + :linenos: diff --git a/examples/dps310_displayio_simpletest.py b/examples/dps310_displayio_simpletest.py new file mode 100644 index 0000000..35d2176 --- /dev/null +++ b/examples/dps310_displayio_simpletest.py @@ -0,0 +1,44 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# SPDX-FileCopyrightText: 2024 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time +import board +from adafruit_display_text.bitmap_label import Label +from terminalio import FONT +from displayio import Group +from adafruit_dps310.basic import DPS310 + +# Simple demo of using the built-in display. +# create a main_group to hold anything we want to show on the display. +main_group = Group() +# Initialize I2C bus and sensor. +i2c = board.I2C() # uses board.SCL and board.SDA +dps310 = DPS310(i2c) + +# Create Label(s) to show the readings. If you have a very small +# display you may need to change to scale=1. +display_output_label = Label(FONT, text="", scale=2) + +# place the label(s) in the middle of the screen with anchored positioning +display_output_label.anchor_point = (0, 0) +display_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 60, +) + +# add the label(s) to the main_group +main_group.append(display_output_label) + +# set the main_group as the root_group of the built-in DISPLAY +board.DISPLAY.root_group = main_group + +# begin main loop +while True: + # update the text of the label(s) to show the sensor readings + display_output_label.text = ( + f"Temperature:{dps310.temperature:.2f} C\nPressure:{dps310.pressure:.2f} hPa" + ) + # wait for a bit + time.sleep(0.5) From 73c46d5a1d5a6ef5a0598c5c2e80e9ab6ef8ac18 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 22:10:05 +0000 Subject: [PATCH 109/110] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +- .pylintrc | 399 ------------------- README.rst | 6 +- adafruit_dps310/__init__.py | 1 + adafruit_dps310/advanced.py | 19 +- adafruit_dps310/basic.py | 20 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/dps310_displayio_simpletest.py | 4 +- examples/dps310_low_power_weather_station.py | 6 +- examples/dps310_simpletest.py | 2 + examples/dps310_simpletest_advanced.py | 2 + ruff.toml | 105 +++++ 14 files changed, 163 insertions(+), 466 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 cec262a..b99dd8d 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/actions :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff Library for the DPS310 Precision Barometric Pressure Sensor diff --git a/adafruit_dps310/__init__.py b/adafruit_dps310/__init__.py index 1a476bf..653502f 100644 --- a/adafruit_dps310/__init__.py +++ b/adafruit_dps310/__init__.py @@ -10,4 +10,5 @@ * Author(s): Bryan Siepert, Jose David M. """ + from adafruit_dps310.advanced import DPS310_Advanced as DPS310 diff --git a/adafruit_dps310/advanced.py b/adafruit_dps310/advanced.py index 7bc1071..b3e7910 100644 --- a/adafruit_dps310/advanced.py +++ b/adafruit_dps310/advanced.py @@ -36,8 +36,10 @@ __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" from time import sleep -from micropython import const + from adafruit_register.i2c_bits import RWBits +from micropython import const + from adafruit_dps310.basic import DPS310 try: @@ -45,16 +47,12 @@ except ImportError: pass -# pylint: disable=no-member,unnecessary-pass - class CV: """struct helper""" @classmethod - def add_values( - cls, value_tuples: Iterable[Tuple[str, int, Union[str, int], Optional[float]]] - ): + def add_values(cls, value_tuples: Iterable[Tuple[str, int, Union[str, int], Optional[float]]]): """Add CV values to the class""" cls.string = {} cls.lsb = {} @@ -97,7 +95,7 @@ class Mode(CV): """ - pass # pylint: disable=unnecessary-pass + pass Mode.add_values( @@ -150,7 +148,6 @@ class SampleCount(CV): ("COUNT_128", 7, 128, None), ) ) -# pylint: enable=unnecessary-pass _DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address # _DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier @@ -167,7 +164,6 @@ class SampleCount(CV): class DPS310_Advanced(DPS310): - # pylint: disable=too-many-instance-attributes """Library for the DPS310 Precision Barometric Pressure Sensor. This class contains some of other configurable features @@ -199,6 +195,7 @@ class DPS310_Advanced(DPS310): pressure = dps310.pressure """ + # Register definitions _pressure_ratebits = RWBits(3, _DPS310_PRSCFG, 4) _temp_ratebits = RWBits(3, _DPS310_TMPCFG, 4) @@ -231,7 +228,7 @@ def wait_temperature_ready(self) -> None: ie. ``Mode.ONE_TEMPERATURE``, ``Mode.CONT_TEMP`` or ``Mode.CONT_PRESTEMP``. See the `Mode` documentation for details. """ - if self._mode_bits in (Mode.IDLE, Mode.ONE_PRESSURE, Mode.CONT_PRESSURE): + if self._mode_bits in {Mode.IDLE, Mode.ONE_PRESSURE, Mode.CONT_PRESSURE}: raise RuntimeError( "Sensor mode is set to idle or pressure measurement,\ can't wait for a temperature measurement" @@ -252,7 +249,7 @@ def wait_pressure_ready(self) -> None: ie. ``Mode.ONE_PRESSURE``, ``Mode.CONT_PRESSURE`` or ``Mode.CONT_PRESTEMP`` See the `Mode` documentation for details. """ - if self._mode_bits in (Mode.IDLE, Mode.ONE_TEMPERATURE, Mode.CONT_TEMP): + if self._mode_bits in {Mode.IDLE, Mode.ONE_TEMPERATURE, Mode.CONT_TEMP}: raise RuntimeError( "Sensor mode is set to idle or temperature measurement,\ can't wait for a pressure measurement" diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py index 0a71a72..c6a6693 100644 --- a/adafruit_dps310/basic.py +++ b/adafruit_dps310/basic.py @@ -37,14 +37,16 @@ # Common imports; remove if unused or pylint will complain import math from time import sleep -from micropython import const + from adafruit_bus_device import i2c_device -from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct -from adafruit_register.i2c_bit import RWBit, ROBit -from adafruit_register.i2c_bits import RWBits, ROBits +from adafruit_register.i2c_bit import ROBit, RWBit +from adafruit_register.i2c_bits import ROBits, RWBits +from adafruit_register.i2c_struct import ROUnaryStruct, UnaryStruct +from micropython import const try: - import typing # pylint: disable=unused-import + import typing + from busio import I2C except ImportError: pass @@ -64,7 +66,6 @@ class DPS310: - # pylint: disable=too-many-instance-attributes """Library for the DPS310 Precision Barometric Pressure Sensor. Depending on your board memory availability you could use DPS310_Advanced. @@ -96,10 +97,11 @@ class DPS310: pressure = dps310.pressure """ + # Register definitions _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") _reset_register = UnaryStruct(_DPS310_RESET, ">B") - _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) # + _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) @@ -232,9 +234,7 @@ def altitude(self) -> float: (:attr:`sea_level_pressure`) - which you must enter ahead of time """ - return 44330 * ( - 1.0 - math.pow(self.pressure / self._sea_level_pressure, 0.1903) - ) + return 44330 * (1.0 - math.pow(self.pressure / self._sea_level_pressure, 0.1903)) @property def temperature(self) -> float: diff --git a/docs/api.rst b/docs/api.rst index bdb631c..297f7d0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_dps310 :members: diff --git a/docs/conf.py b/docs/conf.py index 21d501e..68e7b3d 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("..")) @@ -60,9 +58,7 @@ creation_year = "2020" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Bryan Siepert" author = "Bryan Siepert" diff --git a/examples/dps310_displayio_simpletest.py b/examples/dps310_displayio_simpletest.py index 35d2176..9e3bb37 100644 --- a/examples/dps310_displayio_simpletest.py +++ b/examples/dps310_displayio_simpletest.py @@ -4,10 +4,12 @@ # SPDX-License-Identifier: MIT import time + import board from adafruit_display_text.bitmap_label import Label -from terminalio import FONT from displayio import Group +from terminalio import FONT + from adafruit_dps310.basic import DPS310 # Simple demo of using the built-in display. diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 01cdc85..15a461b 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -8,12 +8,10 @@ https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf """ -# (disable pylint warnings for adafruit_dps310.{SampleCount,Rate,Mode}.* -# as they are generated dynamically) -# pylint: disable=no-member - import time + import board + from adafruit_dps310 import advanced i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 4fad858..1fa634f 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + from adafruit_dps310.basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/examples/dps310_simpletest_advanced.py b/examples/dps310_simpletest_advanced.py index eec8f82..a30574e 100644 --- a/examples/dps310_simpletest_advanced.py +++ b/examples/dps310_simpletest_advanced.py @@ -2,7 +2,9 @@ # SPDX-License-Identifier: MIT import time + import board + from adafruit_dps310.advanced import DPS310_Advanced as DPS310 i2c = board.I2C() # uses board.SCL and board.SDA diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions +] + +[format] +line-ending = "lf" From dd6d46245ee91ec204d312a770626f566573f54a Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 110/110] 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