From 305f2cb17b156a44d9e49b8c1d4b2f85d76fd909 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 01/68] 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 9100ea96eb08bc2d03b0c13f5d7f1832ccce3d43 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 16 Nov 2021 22:34:04 -0500 Subject: [PATCH 02/68] Add type hints --- adafruit_vl6180x.py | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 49aab78..c6ba4c4 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -29,6 +29,12 @@ from adafruit_bus_device import i2c_device +try: + import typing # pylint: disable=unused-import + from busio import I2C +except ImportError: + pass + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" @@ -85,7 +91,7 @@ class VL6180X: default value will be assumed. """ - def __init__(self, i2c, address=_VL6180X_DEFAULT_I2C_ADDR): + def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR) -> None: self._device = i2c_device.I2CDevice(i2c, address) if self._read_8(_VL6180X_REG_IDENTIFICATION_MODEL_ID) != 0xB4: raise RuntimeError("Could not find VL6180X, is it connected and powered?") @@ -93,7 +99,7 @@ def __init__(self, i2c, address=_VL6180X_DEFAULT_I2C_ADDR): self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) @property - def range(self): + def range(self) -> int: """Read the range of an object in front of sensor and return it in mm.""" # wait for device to be ready for range measurement while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: @@ -109,7 +115,7 @@ def range(self): self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) return range_ - def read_lux(self, gain): + def read_lux(self, gain: int) -> float: """Read the lux (light value) from the sensor and return it. Must specify the gain value to use for the lux reading: - ALS_GAIN_1 = 1x @@ -164,7 +170,7 @@ def read_lux(self, gain): return lux @property - def range_status(self): + def range_status(self) -> int: """Retrieve the status/error from a previous range read. This will return a constant value such as: @@ -182,7 +188,7 @@ def range_status(self): """ return self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) >> 4 - def _load_settings(self): + def _load_settings(self) -> None: # private settings from page 24 of app note self._write_8(0x0207, 0x01) self._write_8(0x0208, 0x01) @@ -238,12 +244,12 @@ def _load_settings(self): self._write_8(0x0014, 0x24) # Configures interrupt on 'New Sample # Ready threshold event' - def _write_8(self, address, data): + def _write_8(self, address: int, data: int) -> None: # Write 1 byte of data from the specified 16-bit register address. with self._device: self._device.write(bytes([(address >> 8) & 0xFF, address & 0xFF, data])) - def _write_16(self, address, data): + def _write_16(self, address: int, data: int) -> None: # Write a 16-bit big endian value to the specified 16-bit register # address. with self._device as i2c: @@ -258,7 +264,7 @@ def _write_16(self, address, data): ) ) - def _read_8(self, address): + def _read_8(self, address: int) -> int: # Read and return a byte from the specified 16-bit register address. with self._device as i2c: result = bytearray(1) @@ -266,7 +272,7 @@ def _read_8(self, address): i2c.readinto(result) return result[0] - def _read_16(self, address): + def _read_16(self, address: int) -> int: # Read and return a 16-bit unsigned big endian value read from the # specified 16-bit register address. with self._device as i2c: From de087a77562c72b98bffb258c1cf450284e45d77 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 16 Nov 2021 23:22:06 -0500 Subject: [PATCH 03/68] Add manual offset getting/setting --- adafruit_vl6180x.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index c6ba4c4..f1d7349 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -55,6 +55,7 @@ _VL6180X_REG_RESULT_RANGE_VAL = const(0x062) _VL6180X_REG_RESULT_RANGE_STATUS = const(0x04D) _VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO = const(0x04F) +_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) # User-facing constants: ALS_GAIN_1 = const(0x06) @@ -97,6 +98,7 @@ def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR) -> None: raise RuntimeError("Could not find VL6180X, is it connected and powered?") self._load_settings() self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) + self._offset = self._read_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET) @property def range(self) -> int: @@ -115,6 +117,20 @@ def range(self) -> int: self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) return range_ + @property + def manual_offset(self) -> int: + """Read and sets the manual offset for the sensor, in millimeters""" + return self._offset + + @manual_offset.setter + def manual_offset(self, offset: int) -> None: + if not -128 <= offset <= 127: + raise ValueError("Offset out of range (-128 ... 127)") + if offset < 0: + offset = ~ (abs(offset) - 1) + self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, offset) + self._offset = offset + def read_lux(self, gain: int) -> float: """Read the lux (light value) from the sensor and return it. Must specify the gain value to use for the lux reading: From 977a013fe353c99b37a6ead513c44005ba61f6cf Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Wed, 17 Nov 2021 09:24:21 -0500 Subject: [PATCH 04/68] Changed property to "offset" --- adafruit_vl6180x.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index f1d7349..1ac04b1 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -118,12 +118,12 @@ def range(self) -> int: return range_ @property - def manual_offset(self) -> int: + def offset(self) -> int: """Read and sets the manual offset for the sensor, in millimeters""" return self._offset - @manual_offset.setter - def manual_offset(self, offset: int) -> None: + @offset.setter + def offset(self, offset: int) -> None: if not -128 <= offset <= 127: raise ValueError("Offset out of range (-128 ... 127)") if offset < 0: From 74c318fa9352ef8e184cf3c16fdd9cfd59c92810 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Wed, 17 Nov 2021 09:25:12 -0500 Subject: [PATCH 05/68] Remove read of offset in __init__ Datasheet says it doesn't keep between resets --- adafruit_vl6180x.py | 1 - 1 file changed, 1 deletion(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 1ac04b1..cbe0255 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -98,7 +98,6 @@ def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR) -> None: raise RuntimeError("Could not find VL6180X, is it connected and powered?") self._load_settings() self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) - self._offset = self._read_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET) @property def range(self) -> int: From ba462ae8285dc20da1335d673dd19e98b1c1e487 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Wed, 17 Nov 2021 09:25:25 -0500 Subject: [PATCH 06/68] Allow setting of offset during __init__ --- adafruit_vl6180x.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index cbe0255..e51886d 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -92,12 +92,13 @@ class VL6180X: default value will be assumed. """ - def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR) -> None: + def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0) -> None: self._device = i2c_device.I2CDevice(i2c, address) if self._read_8(_VL6180X_REG_IDENTIFICATION_MODEL_ID) != 0xB4: raise RuntimeError("Could not find VL6180X, is it connected and powered?") self._load_settings() self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) + self.offset = offset @property def range(self) -> int: From 4e569402f699add49f405475663efcf1c40cda31 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Wed, 17 Nov 2021 09:27:32 -0500 Subject: [PATCH 07/68] Reformatted per pre-commit --- adafruit_vl6180x.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index e51886d..74ba264 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -92,7 +92,9 @@ class VL6180X: default value will be assumed. """ - def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0) -> None: + def __init__( + self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0 + ) -> None: self._device = i2c_device.I2CDevice(i2c, address) if self._read_8(_VL6180X_REG_IDENTIFICATION_MODEL_ID) != 0xB4: raise RuntimeError("Could not find VL6180X, is it connected and powered?") @@ -121,13 +123,13 @@ def range(self) -> int: def offset(self) -> int: """Read and sets the manual offset for the sensor, in millimeters""" return self._offset - + @offset.setter def offset(self, offset: int) -> None: if not -128 <= offset <= 127: raise ValueError("Offset out of range (-128 ... 127)") if offset < 0: - offset = ~ (abs(offset) - 1) + offset = ~(abs(offset) - 1) self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, offset) self._offset = offset From ce7e81daf9975da24b8f2e2e6e566c5dcb83e99a Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 Nov 2021 00:35:30 -0500 Subject: [PATCH 08/68] Create example for adding manual offset --- examples/vl6180x_offsettest.py | 38 ++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 examples/vl6180x_offsettest.py diff --git a/examples/vl6180x_offsettest.py b/examples/vl6180x_offsettest.py new file mode 100644 index 0000000..ab04132 --- /dev/null +++ b/examples/vl6180x_offsettest.py @@ -0,0 +1,38 @@ +# SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries +# SPDX-License-Identifier: MIT + +# Demo of reading the range and lux from the VL6180x distance sensor and +# printing it every second. + +import time + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance, with an offset value determined by manual calibration. +sensor = adafruit_vl6180x.VL6180X(i2c, offset=10) + +# Main loop prints the range and lux every second: +while True: + # Read the range in millimeters and print it. + range_mm = sensor.range + print("Range: {0}mm".format(range_mm)) + # Read the light, note this requires specifying a gain value: + # - adafruit_vl6180x.ALS_GAIN_1 = 1x + # - adafruit_vl6180x.ALS_GAIN_1_25 = 1.25x + # - adafruit_vl6180x.ALS_GAIN_1_67 = 1.67x + # - adafruit_vl6180x.ALS_GAIN_2_5 = 2.5x + # - adafruit_vl6180x.ALS_GAIN_5 = 5x + # - adafruit_vl6180x.ALS_GAIN_10 = 10x + # - adafruit_vl6180x.ALS_GAIN_20 = 20x + # - adafruit_vl6180x.ALS_GAIN_40 = 40x + light_lux = sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1) + print("Light (1x gain): {0}lux".format(light_lux)) + # Delay for a second. + time.sleep(1.0) From 3d5b2b8109bb3abc91bfa66224fa7529eae9f52b Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Nov 2021 13:33:26 -0500 Subject: [PATCH 09/68] Simplify packing offset into byte using struct.pack() --- adafruit_vl6180x.py | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 74ba264..6b5d18a 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -28,6 +28,7 @@ from micropython import const from adafruit_bus_device import i2c_device +import struct try: import typing # pylint: disable=unused-import @@ -126,11 +127,7 @@ def offset(self) -> int: @offset.setter def offset(self, offset: int) -> None: - if not -128 <= offset <= 127: - raise ValueError("Offset out of range (-128 ... 127)") - if offset < 0: - offset = ~(abs(offset) - 1) - self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, offset) + self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0]) self._offset = offset def read_lux(self, gain: int) -> float: From edbd33bd37948684e6c75fedfa932b35977bd138 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Nov 2021 13:35:14 -0500 Subject: [PATCH 10/68] Reformatted per pre-commit, --- adafruit_vl6180x.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 6b5d18a..4a0d93d 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -127,7 +127,9 @@ def offset(self) -> int: @offset.setter def offset(self, offset: int) -> None: - self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0]) + self._write_8( + _VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0] + ) self._offset = offset def read_lux(self, gain: int) -> float: From 12d539408a92c95b6cb0ae4ba4ebc52e75a369b3 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Nov 2021 13:35:24 -0500 Subject: [PATCH 11/68] Move import of struct --- adafruit_vl6180x.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 4a0d93d..93482dc 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -25,10 +25,10 @@ https://github.com/adafruit/circuitpython/releases * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ +import struct from micropython import const from adafruit_bus_device import i2c_device -import struct try: import typing # pylint: disable=unused-import From feb10e41d47445f720539ccbe92b6710596ac77e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:11:04 -0600 Subject: [PATCH 12/68] 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 008ac3a91760b4309b1a1261ba2346f5e09aca53 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 Nov 2021 20:16:50 -0500 Subject: [PATCH 13/68] Convert offset example to calibration example --- examples/vl6180x_calibrationtest.py | 35 ++++++++++++++++++++++++++ examples/vl6180x_offsettest.py | 38 ----------------------------- 2 files changed, 35 insertions(+), 38 deletions(-) create mode 100644 examples/vl6180x_calibrationtest.py delete mode 100644 examples/vl6180x_offsettest.py diff --git a/examples/vl6180x_calibrationtest.py b/examples/vl6180x_calibrationtest.py new file mode 100644 index 0000000..0a61d50 --- /dev/null +++ b/examples/vl6180x_calibrationtest.py @@ -0,0 +1,35 @@ +# SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries +# SPDX-License-Identifier: MIT + +# Demo of calibrating the part to part range offset per Application Note 4545 +# for the VL6180X sensor + +import time + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance, with explicit offset of 0 to clear the system offset +sensor = adafruit_vl6180x.VL6180X(i2c, offset=0) + +# Place a target at 50mm away from VL6180X Collect a number of range measurements +# with the target in place and calculate mean of the range reseults. For a +# reliable measurement, take at least 10 measurements. +measurements = [] +for msmt in range(10): + range_mm = sensor.range + measurements.append(range_mm) + time.sleep(1.0) +average_msmt = sum(measurements)/10 + +# Calculate the offset required: +calibration_offset = 50 - average_msmt + +# Apply offset +sensor.offset = calibration_offset diff --git a/examples/vl6180x_offsettest.py b/examples/vl6180x_offsettest.py deleted file mode 100644 index ab04132..0000000 --- a/examples/vl6180x_offsettest.py +++ /dev/null @@ -1,38 +0,0 @@ -# SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries -# SPDX-License-Identifier: MIT - -# Demo of reading the range and lux from the VL6180x distance sensor and -# printing it every second. - -import time - -import board -import busio - -import adafruit_vl6180x - - -# Create I2C bus. -i2c = busio.I2C(board.SCL, board.SDA) - -# Create sensor instance, with an offset value determined by manual calibration. -sensor = adafruit_vl6180x.VL6180X(i2c, offset=10) - -# Main loop prints the range and lux every second: -while True: - # Read the range in millimeters and print it. - range_mm = sensor.range - print("Range: {0}mm".format(range_mm)) - # Read the light, note this requires specifying a gain value: - # - adafruit_vl6180x.ALS_GAIN_1 = 1x - # - adafruit_vl6180x.ALS_GAIN_1_25 = 1.25x - # - adafruit_vl6180x.ALS_GAIN_1_67 = 1.67x - # - adafruit_vl6180x.ALS_GAIN_2_5 = 2.5x - # - adafruit_vl6180x.ALS_GAIN_5 = 5x - # - adafruit_vl6180x.ALS_GAIN_10 = 10x - # - adafruit_vl6180x.ALS_GAIN_20 = 20x - # - adafruit_vl6180x.ALS_GAIN_40 = 40x - light_lux = sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1) - print("Light (1x gain): {0}lux".format(light_lux)) - # Delay for a second. - time.sleep(1.0) From 3ccf54dd7ef7b41e9c7f27ac09b042e0e5b36b25 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 Nov 2021 20:17:16 -0500 Subject: [PATCH 14/68] Add commented out line in simple test for initializing sensor with offset --- examples/vl6180x_simpletest.py | 1 + 1 file changed, 1 insertion(+) diff --git a/examples/vl6180x_simpletest.py b/examples/vl6180x_simpletest.py index cb02bea..6c3961a 100644 --- a/examples/vl6180x_simpletest.py +++ b/examples/vl6180x_simpletest.py @@ -17,6 +17,7 @@ # Create sensor instance. sensor = adafruit_vl6180x.VL6180X(i2c) +# sensor = adafruit_vl6180x.VL6180X(i2c) # This would add a +10 millimeter offset to all measurements: # Main loop prints the range and lux every second: while True: From 82a0669934c680cbd9d46770b6dd67c8ca24fb39 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 Nov 2021 20:19:26 -0500 Subject: [PATCH 15/68] Reformatted per black --- examples/vl6180x_calibrationtest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/vl6180x_calibrationtest.py b/examples/vl6180x_calibrationtest.py index 0a61d50..8289b71 100644 --- a/examples/vl6180x_calibrationtest.py +++ b/examples/vl6180x_calibrationtest.py @@ -26,7 +26,7 @@ range_mm = sensor.range measurements.append(range_mm) time.sleep(1.0) -average_msmt = sum(measurements)/10 +average_msmt = sum(measurements) / 10 # Calculate the offset required: calibration_offset = 50 - average_msmt From 74360e762dc5f618e3c9b8c9b6d2ce56ac9b0941 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 Nov 2021 20:19:43 -0500 Subject: [PATCH 16/68] Shorten line per pylint --- examples/vl6180x_simpletest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/vl6180x_simpletest.py b/examples/vl6180x_simpletest.py index 6c3961a..9bc0649 100644 --- a/examples/vl6180x_simpletest.py +++ b/examples/vl6180x_simpletest.py @@ -17,7 +17,7 @@ # Create sensor instance. sensor = adafruit_vl6180x.VL6180X(i2c) -# sensor = adafruit_vl6180x.VL6180X(i2c) # This would add a +10 millimeter offset to all measurements: +# sensor = adafruit_vl6180x.VL6180X(i2c) # This would add a +10 millimeter offset to measurements: # Main loop prints the range and lux every second: while True: From 4fa94aec378a8f6fc6121b2aaad3cb213dadc706 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Wed, 24 Nov 2021 10:38:39 -0500 Subject: [PATCH 17/68] Add offset to commented out code, expand explanation --- examples/vl6180x_simpletest.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/examples/vl6180x_simpletest.py b/examples/vl6180x_simpletest.py index 9bc0649..2b06f4a 100644 --- a/examples/vl6180x_simpletest.py +++ b/examples/vl6180x_simpletest.py @@ -17,7 +17,9 @@ # Create sensor instance. sensor = adafruit_vl6180x.VL6180X(i2c) -# sensor = adafruit_vl6180x.VL6180X(i2c) # This would add a +10 millimeter offset to measurements: +# You can add an offset to distance measurements here (e.g. calibration) +# Swapping for the following would add a +10 millimeter offset to measurements: +# sensor = adafruit_vl6180x.VL6180X(i2c, offset=10) # Main loop prints the range and lux every second: while True: From b10a5dbce8cd013582b1a7762e245c1ebed887ce Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 18/68] 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 9351d773d108b944e7fa29d3ddf81e091d4622ca Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:17 -0500 Subject: [PATCH 19/68] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 6 +++--- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 6 insertions(+), 8 deletions(-) diff --git a/README.rst b/README.rst index 1c7aa04..014d90d 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl6180x/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/ + :target: https://docs.circuitpython.org/projects/vl6180x/en/latest/ :alt: Documentation Status .. image :: https://img.shields.io/discord/327254708534116352.svg @@ -61,7 +61,7 @@ See examples/vl6180x_simpletest.py for a demo of the usage. 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 58e82b2..e17b943 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -26,12 +26,12 @@ # autodoc_mock_imports = ["micropython", "adafruit_bus_device"] 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, ), - "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 8cf3d6b..823e20f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,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 7c90051..22df8a9 100644 --- a/setup.py +++ b/setup.py @@ -45,8 +45,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit vl6180x time flight distance sensor" From ec6bdcc7c02adfe3a1ce4a18275b085a9cdb9780 Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Sun, 30 Jan 2022 23:08:29 +0100 Subject: [PATCH 20/68] Added support for continuous mode and history buffering --- adafruit_vl6180x.py | 138 +++++++++++++++++++++++----- docs/examples.rst | 42 ++++++++- examples/vl6180x_calibrationtest.py | 2 +- examples/vl6180x_continuoustest.py | 36 ++++++++ examples/vl6180x_historytest.py | 38 ++++++++ examples/vl6180x_performancetest.py | 57 ++++++++++++ 6 files changed, 289 insertions(+), 24 deletions(-) create mode 100644 examples/vl6180x_continuoustest.py create mode 100644 examples/vl6180x_historytest.py create mode 100644 examples/vl6180x_performancetest.py diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 93482dc..47db96d 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -9,7 +9,7 @@ CircuitPython module for the VL6180X distance sensor. See examples/simpletest.py for a demo of the usage. -* Author(s): Tony DiCola +* Author(s): Tony DiCola, Jonas Schatz Implementation Notes -------------------- @@ -26,12 +26,16 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ import struct +import time + from micropython import const from adafruit_bus_device import i2c_device try: - import typing # pylint: disable=unused-import + import logging + import time + from typing import Optional, List from busio import I2C except ImportError: pass @@ -40,23 +44,31 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" - -# Internal constants: -_VL6180X_DEFAULT_I2C_ADDR = const(0x29) +# Registers _VL6180X_REG_IDENTIFICATION_MODEL_ID = const(0x000) + +_VL6180X_REG_SYSTEM_HISTORY_CTRL = const(0x012) _VL6180X_REG_SYSTEM_INTERRUPT_CONFIG = const(0x014) _VL6180X_REG_SYSTEM_INTERRUPT_CLEAR = const(0x015) _VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET = const(0x016) + _VL6180X_REG_SYSRANGE_START = const(0x018) +_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD = const(0x01B) +_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) + _VL6180X_REG_SYSALS_START = const(0x038) _VL6180X_REG_SYSALS_ANALOGUE_GAIN = const(0x03F) _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI = const(0x040) _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO = const(0x041) -_VL6180X_REG_RESULT_ALS_VAL = const(0x050) -_VL6180X_REG_RESULT_RANGE_VAL = const(0x062) + _VL6180X_REG_RESULT_RANGE_STATUS = const(0x04D) _VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO = const(0x04F) -_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) +_VL6180X_REG_RESULT_ALS_VAL = const(0x050) +_VL6180X_REG_RESULT_HISTORY_BUFFER_0 = const(0x052) +_VL6180X_REG_RESULT_RANGE_VAL = const(0x062) + +# Internal constants: +_VL6180X_DEFAULT_I2C_ADDR = const(0x29) # User-facing constants: ALS_GAIN_1 = const(0x06) @@ -82,7 +94,7 @@ class VL6180X: - """Create an instance of the VL6180X distance sensor. You must pass in + """Create an instance of the VL6180X distance sensor. You must pass in the following parameters: :param i2c: An instance of the I2C bus connected to the sensor. @@ -103,22 +115,82 @@ def __init__( self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) self.offset = offset + # Reset a sensor that crashed while in continuous mode + if self.continuous_mode_enabled: + self.stop_range_continuous() + time.sleep(0.1) + + # Activate history buffer for range measurement + self._write_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL, 0x01) + @property def range(self) -> int: """Read the range of an object in front of sensor and return it in mm.""" - # wait for device to be ready for range measurement - while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: - pass - # Start a range measurement - self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) - # Poll until bit 2 is set - while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: - pass - # read range in mm - range_ = self._read_8(_VL6180X_REG_RESULT_RANGE_VAL) - # clear interrupt - self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) - return range_ + if self.continuous_mode_enabled: + return self._read_range_continuous() + return self._read_range_single() + + @property + def range_from_history(self) -> Optional[int]: + """ Read the latest range data from history + To do so, you don't have to wait for a complete measurement. """ + + if not self.range_history_enabled: + return None + + return self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0) + + @property + def ranges_from_history(self) -> Optional[List[int]]: + """ Read the last 16 range measurements from history """ + + if not self.range_history_enabled: + return None + + return [self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) for age in range(16)] + + @property + def range_history_enabled(self) -> bool: + """ Checks if history buffer stores range data """ + + history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) + + if history_ctrl & 0x0: + logging.info('History buffering not enabled') + return False + + if (history_ctrl > 1) & 0x1: + logging.info('History buffer stores ALS data, not range') + return False + + return True + + def start_range_continuous(self, period: int = 100) -> None: + """ Start continuous range mode + :param period: Time delay between measurements in ms + """ + # Set range between measurements + period_reg: int = 0 + if period > 10: + if period < 2250: + period_reg = (period // 10) - 1 + else: + period_reg = 254 + self._write_8(_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD, period_reg) + + # Start continuous range measurement + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x03) + + def stop_range_continuous(self) -> None: + """ Stop continuous range mode. It is advised to wait for about 0.3s + afterwards to avoid issues with the interrupt flags """ + if self.continuous_mode_enabled: + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) + + @property + def continuous_mode_enabled(self) -> bool: + """ Checks if continuous mode is enabled """ + return self._read_8(_VL6180X_REG_SYSRANGE_START) > 1 & 0x1 @property def offset(self) -> int: @@ -132,6 +204,28 @@ def offset(self, offset: int) -> None: ) self._offset = offset + def _read_range_single(self) -> int: + """ Read the range when in single-shot mode""" + while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: + pass + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) + return self._read_range_continuous() + + def _read_range_continuous(self) -> int: + """ Read the range when in continuous mode""" + + # Poll until bit 2 is set + while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: + pass + + # read range in mm + range_ = self._read_8(_VL6180X_REG_RESULT_RANGE_VAL) + + # clear interrupt + self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) + + return range_ + def read_lux(self, gain: int) -> float: """Read the lux (light value) from the sensor and return it. Must specify the gain value to use for the lux reading: diff --git a/docs/examples.rst b/docs/examples.rst index 5856981..a13fe94 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,4 +1,4 @@ -Simple test +Simple Test ------------ Ensure your device works with this simple test. @@ -6,3 +6,43 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/vl6180x_simpletest.py :caption: examples/vl6180x_simpletest.py :linenos: + + +Calibration Test +------------ + +Demo of calibrating the part to part range offset per Application Note 4545 for the VL6180X sensor. + +.. literalinclude:: ../examples/vl6180x_calibrationtest.py + :caption: examples/vl6180x_calibrationtest.py + :linenos: + + +Continuous Test +------------ + +Demo of reading the range from the VL6180x distance sensor in continuous mode. + +.. literalinclude:: ../examples/vl6180x_continuoustest.py + :caption: examples/vl6180x_continuoustest.py + :linenos: + + +History Test +------------ + +Demo of reading the range from the history buffer of the VL6180x distance sensor. + +.. literalinclude:: ../examples/vl6180x_historytest.py + :caption: examples/vl6180x_historytest.py + :linenos: + + +Performance Test +------------ + +Demo of reading the range from the VL6180x distance sensor in different access modes (single shot, continuous, history). + +.. literalinclude:: ../examples/vl6180x_performancetest.py + :caption: examples/vl6180x_performancetest.py + :linenos: diff --git a/examples/vl6180x_calibrationtest.py b/examples/vl6180x_calibrationtest.py index 8289b71..c3e5630 100644 --- a/examples/vl6180x_calibrationtest.py +++ b/examples/vl6180x_calibrationtest.py @@ -19,7 +19,7 @@ sensor = adafruit_vl6180x.VL6180X(i2c, offset=0) # Place a target at 50mm away from VL6180X Collect a number of range measurements -# with the target in place and calculate mean of the range reseults. For a +# with the target in place and calculate mean of the range results. For a # reliable measurement, take at least 10 measurements. measurements = [] for msmt in range(10): diff --git a/examples/vl6180x_continuoustest.py b/examples/vl6180x_continuoustest.py new file mode 100644 index 0000000..2d2d3fb --- /dev/null +++ b/examples/vl6180x_continuoustest.py @@ -0,0 +1,36 @@ +# SPDX-FileCopyrightText: 2018 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the VL6180x distance sensor in +# continuous mode + +import time + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Starting continuous mode +print('Starting continuous mode') +sensor.start_range_continuous(20) + +# Main loop prints the range and lux every 0.01 seconds +for _ in range(100): + # Read the range in millimeters and print it. + range_mm = sensor.range + print("Range: {0}mm".format(range_mm)) + + # Delay for 10 ms + time.sleep(0.01) + +# Stop continuous mode. This is advised as the sensor +# wouldn't stop measuring after the program has ended +sensor.stop_range_continuous() diff --git a/examples/vl6180x_historytest.py b/examples/vl6180x_historytest.py new file mode 100644 index 0000000..6a237b3 --- /dev/null +++ b/examples/vl6180x_historytest.py @@ -0,0 +1,38 @@ +# SPDX-FileCopyrightText: 2022 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the history buffer of the VL6180x +# distance sensor + +import time +from typing import List + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Starting continuous mode +print('Starting continuous mode') +sensor.start_range_continuous() + +# Main loop prints the ranges every 0.01 seconds for about 5 seconds +# You should see changes 'ripple through' the history array +for _ in range(500): + # Read the range in millimeters and print it. + ranges_mm: List[int] = sensor.ranges_from_history + print(ranges_mm) + + # Delay for 10 ms so that the loop is not too fast + time.sleep(0.01) + +# Stop continuous mode. This is advised as the sensor +# wouldn't stop measuring after the program has ended +sensor.stop_range_continuous() diff --git a/examples/vl6180x_performancetest.py b/examples/vl6180x_performancetest.py new file mode 100644 index 0000000..314d8a9 --- /dev/null +++ b/examples/vl6180x_performancetest.py @@ -0,0 +1,57 @@ +# SPDX-FileCopyrightText: 2022 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the VL6180x distance sensor in +# different access modes (single shot, continuous, history) + +import time + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Define the number of measurements +# n_measurements = 1000 will run for about 2 minutes +n_measurements: int = 100 + +# Single shot +print('Starting single-shot measurement...') +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range +print('Performed {} measurements in single-shot mode in {}s\n' + .format(n_measurements, time.time() - start)) + +# Sleep is required, otherwise the sensor might freeze when switching to +# continuous mode too quickly after the last single shot +time.sleep(2) + +# Continuous with no delay between measurements +print('Starting continuous measurement...') +sensor.start_range_continuous(0) +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range +print('Performed {} measurements in continuous mode in {}s\n' + .format(n_measurements, time.time() - start)) + +# Continuous, reading data from history. +# Note: This is fast, since you don't have to wait for the measurement to be +# finished. On the downside, you will read the same value multiple times +print('Starting continuous measurement with history enabled...') +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range_from_history +print('Performed {} measurements in continuous mode, reading form history, in {}s\n' + .format(n_measurements, time.time() - start)) + +sensor.stop_range_continuous() +print('Finished') From c9851cb96d8a9a2eb7a67867cb4e921277e7b7e2 Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Sun, 30 Jan 2022 23:08:29 +0100 Subject: [PATCH 21/68] Added support for continuous mode and history buffering --- adafruit_vl6180x.py | 137 +++++++++++++++++++++++----- docs/examples.rst | 42 ++++++++- examples/vl6180x_calibrationtest.py | 2 +- examples/vl6180x_continuoustest.py | 36 ++++++++ examples/vl6180x_historytest.py | 38 ++++++++ examples/vl6180x_performancetest.py | 57 ++++++++++++ 6 files changed, 288 insertions(+), 24 deletions(-) create mode 100644 examples/vl6180x_continuoustest.py create mode 100644 examples/vl6180x_historytest.py create mode 100644 examples/vl6180x_performancetest.py diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 93482dc..a9f6fb0 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -9,7 +9,7 @@ CircuitPython module for the VL6180X distance sensor. See examples/simpletest.py for a demo of the usage. -* Author(s): Tony DiCola +* Author(s): Tony DiCola, Jonas Schatz Implementation Notes -------------------- @@ -26,12 +26,15 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ import struct +import time + from micropython import const from adafruit_bus_device import i2c_device try: - import typing # pylint: disable=unused-import + import logging + from typing import Optional, List from busio import I2C except ImportError: pass @@ -40,23 +43,31 @@ __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" - -# Internal constants: -_VL6180X_DEFAULT_I2C_ADDR = const(0x29) +# Registers _VL6180X_REG_IDENTIFICATION_MODEL_ID = const(0x000) + +_VL6180X_REG_SYSTEM_HISTORY_CTRL = const(0x012) _VL6180X_REG_SYSTEM_INTERRUPT_CONFIG = const(0x014) _VL6180X_REG_SYSTEM_INTERRUPT_CLEAR = const(0x015) _VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET = const(0x016) + _VL6180X_REG_SYSRANGE_START = const(0x018) +_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD = const(0x01B) +_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) + _VL6180X_REG_SYSALS_START = const(0x038) _VL6180X_REG_SYSALS_ANALOGUE_GAIN = const(0x03F) _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI = const(0x040) _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO = const(0x041) -_VL6180X_REG_RESULT_ALS_VAL = const(0x050) -_VL6180X_REG_RESULT_RANGE_VAL = const(0x062) + _VL6180X_REG_RESULT_RANGE_STATUS = const(0x04D) _VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO = const(0x04F) -_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) +_VL6180X_REG_RESULT_ALS_VAL = const(0x050) +_VL6180X_REG_RESULT_HISTORY_BUFFER_0 = const(0x052) +_VL6180X_REG_RESULT_RANGE_VAL = const(0x062) + +# Internal constants: +_VL6180X_DEFAULT_I2C_ADDR = const(0x29) # User-facing constants: ALS_GAIN_1 = const(0x06) @@ -82,7 +93,7 @@ class VL6180X: - """Create an instance of the VL6180X distance sensor. You must pass in + """Create an instance of the VL6180X distance sensor. You must pass in the following parameters: :param i2c: An instance of the I2C bus connected to the sensor. @@ -103,22 +114,82 @@ def __init__( self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) self.offset = offset + # Reset a sensor that crashed while in continuous mode + if self.continuous_mode_enabled: + self.stop_range_continuous() + time.sleep(0.1) + + # Activate history buffer for range measurement + self._write_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL, 0x01) + @property def range(self) -> int: """Read the range of an object in front of sensor and return it in mm.""" - # wait for device to be ready for range measurement - while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: - pass - # Start a range measurement - self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) - # Poll until bit 2 is set - while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: - pass - # read range in mm - range_ = self._read_8(_VL6180X_REG_RESULT_RANGE_VAL) - # clear interrupt - self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) - return range_ + if self.continuous_mode_enabled: + return self._read_range_continuous() + return self._read_range_single() + + @property + def range_from_history(self) -> Optional[int]: + """ Read the latest range data from history + To do so, you don't have to wait for a complete measurement. """ + + if not self.range_history_enabled: + return None + + return self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0) + + @property + def ranges_from_history(self) -> Optional[List[int]]: + """ Read the last 16 range measurements from history """ + + if not self.range_history_enabled: + return None + + return [self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) for age in range(16)] + + @property + def range_history_enabled(self) -> bool: + """ Checks if history buffer stores range data """ + + history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) + + if history_ctrl & 0x0: + logging.info('History buffering not enabled') + return False + + if (history_ctrl > 1) & 0x1: + logging.info('History buffer stores ALS data, not range') + return False + + return True + + def start_range_continuous(self, period: int = 100) -> None: + """ Start continuous range mode + :param period: Time delay between measurements in ms + """ + # Set range between measurements + period_reg: int = 0 + if period > 10: + if period < 2250: + period_reg = (period // 10) - 1 + else: + period_reg = 254 + self._write_8(_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD, period_reg) + + # Start continuous range measurement + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x03) + + def stop_range_continuous(self) -> None: + """ Stop continuous range mode. It is advised to wait for about 0.3s + afterwards to avoid issues with the interrupt flags """ + if self.continuous_mode_enabled: + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) + + @property + def continuous_mode_enabled(self) -> bool: + """ Checks if continuous mode is enabled """ + return self._read_8(_VL6180X_REG_SYSRANGE_START) > 1 & 0x1 @property def offset(self) -> int: @@ -132,6 +203,28 @@ def offset(self, offset: int) -> None: ) self._offset = offset + def _read_range_single(self) -> int: + """ Read the range when in single-shot mode""" + while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: + pass + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) + return self._read_range_continuous() + + def _read_range_continuous(self) -> int: + """ Read the range when in continuous mode""" + + # Poll until bit 2 is set + while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: + pass + + # read range in mm + range_ = self._read_8(_VL6180X_REG_RESULT_RANGE_VAL) + + # clear interrupt + self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) + + return range_ + def read_lux(self, gain: int) -> float: """Read the lux (light value) from the sensor and return it. Must specify the gain value to use for the lux reading: diff --git a/docs/examples.rst b/docs/examples.rst index 5856981..a13fe94 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,4 +1,4 @@ -Simple test +Simple Test ------------ Ensure your device works with this simple test. @@ -6,3 +6,43 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/vl6180x_simpletest.py :caption: examples/vl6180x_simpletest.py :linenos: + + +Calibration Test +------------ + +Demo of calibrating the part to part range offset per Application Note 4545 for the VL6180X sensor. + +.. literalinclude:: ../examples/vl6180x_calibrationtest.py + :caption: examples/vl6180x_calibrationtest.py + :linenos: + + +Continuous Test +------------ + +Demo of reading the range from the VL6180x distance sensor in continuous mode. + +.. literalinclude:: ../examples/vl6180x_continuoustest.py + :caption: examples/vl6180x_continuoustest.py + :linenos: + + +History Test +------------ + +Demo of reading the range from the history buffer of the VL6180x distance sensor. + +.. literalinclude:: ../examples/vl6180x_historytest.py + :caption: examples/vl6180x_historytest.py + :linenos: + + +Performance Test +------------ + +Demo of reading the range from the VL6180x distance sensor in different access modes (single shot, continuous, history). + +.. literalinclude:: ../examples/vl6180x_performancetest.py + :caption: examples/vl6180x_performancetest.py + :linenos: diff --git a/examples/vl6180x_calibrationtest.py b/examples/vl6180x_calibrationtest.py index 8289b71..c3e5630 100644 --- a/examples/vl6180x_calibrationtest.py +++ b/examples/vl6180x_calibrationtest.py @@ -19,7 +19,7 @@ sensor = adafruit_vl6180x.VL6180X(i2c, offset=0) # Place a target at 50mm away from VL6180X Collect a number of range measurements -# with the target in place and calculate mean of the range reseults. For a +# with the target in place and calculate mean of the range results. For a # reliable measurement, take at least 10 measurements. measurements = [] for msmt in range(10): diff --git a/examples/vl6180x_continuoustest.py b/examples/vl6180x_continuoustest.py new file mode 100644 index 0000000..2d2d3fb --- /dev/null +++ b/examples/vl6180x_continuoustest.py @@ -0,0 +1,36 @@ +# SPDX-FileCopyrightText: 2018 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the VL6180x distance sensor in +# continuous mode + +import time + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Starting continuous mode +print('Starting continuous mode') +sensor.start_range_continuous(20) + +# Main loop prints the range and lux every 0.01 seconds +for _ in range(100): + # Read the range in millimeters and print it. + range_mm = sensor.range + print("Range: {0}mm".format(range_mm)) + + # Delay for 10 ms + time.sleep(0.01) + +# Stop continuous mode. This is advised as the sensor +# wouldn't stop measuring after the program has ended +sensor.stop_range_continuous() diff --git a/examples/vl6180x_historytest.py b/examples/vl6180x_historytest.py new file mode 100644 index 0000000..6a237b3 --- /dev/null +++ b/examples/vl6180x_historytest.py @@ -0,0 +1,38 @@ +# SPDX-FileCopyrightText: 2022 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the history buffer of the VL6180x +# distance sensor + +import time +from typing import List + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Starting continuous mode +print('Starting continuous mode') +sensor.start_range_continuous() + +# Main loop prints the ranges every 0.01 seconds for about 5 seconds +# You should see changes 'ripple through' the history array +for _ in range(500): + # Read the range in millimeters and print it. + ranges_mm: List[int] = sensor.ranges_from_history + print(ranges_mm) + + # Delay for 10 ms so that the loop is not too fast + time.sleep(0.01) + +# Stop continuous mode. This is advised as the sensor +# wouldn't stop measuring after the program has ended +sensor.stop_range_continuous() diff --git a/examples/vl6180x_performancetest.py b/examples/vl6180x_performancetest.py new file mode 100644 index 0000000..314d8a9 --- /dev/null +++ b/examples/vl6180x_performancetest.py @@ -0,0 +1,57 @@ +# SPDX-FileCopyrightText: 2022 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the VL6180x distance sensor in +# different access modes (single shot, continuous, history) + +import time + +import board +import busio + +import adafruit_vl6180x + + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Define the number of measurements +# n_measurements = 1000 will run for about 2 minutes +n_measurements: int = 100 + +# Single shot +print('Starting single-shot measurement...') +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range +print('Performed {} measurements in single-shot mode in {}s\n' + .format(n_measurements, time.time() - start)) + +# Sleep is required, otherwise the sensor might freeze when switching to +# continuous mode too quickly after the last single shot +time.sleep(2) + +# Continuous with no delay between measurements +print('Starting continuous measurement...') +sensor.start_range_continuous(0) +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range +print('Performed {} measurements in continuous mode in {}s\n' + .format(n_measurements, time.time() - start)) + +# Continuous, reading data from history. +# Note: This is fast, since you don't have to wait for the measurement to be +# finished. On the downside, you will read the same value multiple times +print('Starting continuous measurement with history enabled...') +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range_from_history +print('Performed {} measurements in continuous mode, reading form history, in {}s\n' + .format(n_measurements, time.time() - start)) + +sensor.stop_range_continuous() +print('Finished') From cacf12b5d89bc7378cf38dc69deef0f55590eb6c Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Sun, 30 Jan 2022 23:53:37 +0100 Subject: [PATCH 22/68] Removed unused import --- adafruit_vl6180x.py | 1 - 1 file changed, 1 deletion(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 47db96d..a9f6fb0 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -34,7 +34,6 @@ try: import logging - import time from typing import Optional, List from busio import I2C except ImportError: From f3da49ea04e0288f7bb5fc669c79c80f6ddb664a Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Sat, 5 Feb 2022 00:28:38 +0100 Subject: [PATCH 23/68] Reformatted files for black --- adafruit_vl6180x.py | 20 ++++++++++++-------- examples/vl6180x_continuoustest.py | 2 +- examples/vl6180x_historytest.py | 2 +- examples/vl6180x_performancetest.py | 29 +++++++++++++++++++---------- 4 files changed, 33 insertions(+), 20 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index cc12f76..7bb42a8 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -26,6 +26,7 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ import struct +import time from micropython import const @@ -130,8 +131,8 @@ def range(self) -> int: @property def range_from_history(self) -> Optional[int]: - """ Read the latest range data from history - To do so, you don't have to wait for a complete measurement. """ + """Read the latest range data from history + To do so, you don't have to wait for a complete measurement.""" if not self.range_history_enabled: return None @@ -145,7 +146,10 @@ def ranges_from_history(self) -> Optional[List[int]]: if not self.range_history_enabled: return None - return [self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) for age in range(16)] + return [ + self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) + for age in range(16) + ] @property def range_history_enabled(self) -> bool: @@ -154,17 +158,17 @@ def range_history_enabled(self) -> bool: history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) if history_ctrl & 0x0: - logging.info('History buffering not enabled') + logging.info("History buffering not enabled") return False if (history_ctrl > 1) & 0x1: - logging.info('History buffer stores ALS data, not range') + logging.info("History buffer stores ALS data, not range") return False return True def start_range_continuous(self, period: int = 100) -> None: - """ Start continuous range mode + """Start continuous range mode :param period: Time delay between measurements in ms """ # Set range between measurements @@ -180,8 +184,8 @@ def start_range_continuous(self, period: int = 100) -> None: self._write_8(_VL6180X_REG_SYSRANGE_START, 0x03) def stop_range_continuous(self) -> None: - """ Stop continuous range mode. It is advised to wait for about 0.3s - afterwards to avoid issues with the interrupt flags """ + """Stop continuous range mode. It is advised to wait for about 0.3s + afterwards to avoid issues with the interrupt flags""" if self.continuous_mode_enabled: self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) diff --git a/examples/vl6180x_continuoustest.py b/examples/vl6180x_continuoustest.py index 2d2d3fb..d638915 100644 --- a/examples/vl6180x_continuoustest.py +++ b/examples/vl6180x_continuoustest.py @@ -19,7 +19,7 @@ sensor = adafruit_vl6180x.VL6180X(i2c) # Starting continuous mode -print('Starting continuous mode') +print("Starting continuous mode") sensor.start_range_continuous(20) # Main loop prints the range and lux every 0.01 seconds diff --git a/examples/vl6180x_historytest.py b/examples/vl6180x_historytest.py index 6a237b3..c82d65c 100644 --- a/examples/vl6180x_historytest.py +++ b/examples/vl6180x_historytest.py @@ -20,7 +20,7 @@ sensor = adafruit_vl6180x.VL6180X(i2c) # Starting continuous mode -print('Starting continuous mode') +print("Starting continuous mode") sensor.start_range_continuous() # Main loop prints the ranges every 0.01 seconds for about 5 seconds diff --git a/examples/vl6180x_performancetest.py b/examples/vl6180x_performancetest.py index 314d8a9..933a256 100644 --- a/examples/vl6180x_performancetest.py +++ b/examples/vl6180x_performancetest.py @@ -23,35 +23,44 @@ n_measurements: int = 100 # Single shot -print('Starting single-shot measurement...') +print("Starting single-shot measurement...") start = time.time() for i in range(n_measurements): range_mm = sensor.range -print('Performed {} measurements in single-shot mode in {}s\n' - .format(n_measurements, time.time() - start)) +print( + "Performed {} measurements in single-shot mode in {}s\n".format( + n_measurements, time.time() - start + ) +) # Sleep is required, otherwise the sensor might freeze when switching to # continuous mode too quickly after the last single shot time.sleep(2) # Continuous with no delay between measurements -print('Starting continuous measurement...') +print("Starting continuous measurement...") sensor.start_range_continuous(0) start = time.time() for i in range(n_measurements): range_mm = sensor.range -print('Performed {} measurements in continuous mode in {}s\n' - .format(n_measurements, time.time() - start)) +print( + "Performed {} measurements in continuous mode in {}s\n".format( + n_measurements, time.time() - start + ) +) # Continuous, reading data from history. # Note: This is fast, since you don't have to wait for the measurement to be # finished. On the downside, you will read the same value multiple times -print('Starting continuous measurement with history enabled...') +print("Starting continuous measurement with history enabled...") start = time.time() for i in range(n_measurements): range_mm = sensor.range_from_history -print('Performed {} measurements in continuous mode, reading form history, in {}s\n' - .format(n_measurements, time.time() - start)) +print( + "Performed {} measurements in continuous mode, reading form history, in {}s\n".format( + n_measurements, time.time() - start + ) +) sensor.stop_range_continuous() -print('Finished') +print("Finished") From 044f8f714f0f883069ac861054c48890caa56aae Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Sat, 5 Feb 2022 00:34:42 +0100 Subject: [PATCH 24/68] Fixed too short title underlines --- docs/examples.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/examples.rst b/docs/examples.rst index a13fe94..c348e59 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -9,7 +9,7 @@ Ensure your device works with this simple test. Calibration Test ------------- +----------------- Demo of calibrating the part to part range offset per Application Note 4545 for the VL6180X sensor. @@ -19,7 +19,7 @@ Demo of calibrating the part to part range offset per Application Note 4545 for Continuous Test ------------- +---------------- Demo of reading the range from the VL6180x distance sensor in continuous mode. @@ -29,7 +29,7 @@ Demo of reading the range from the VL6180x distance sensor in continuous mode. History Test ------------- +------------- Demo of reading the range from the history buffer of the VL6180x distance sensor. @@ -39,7 +39,7 @@ Demo of reading the range from the history buffer of the VL6180x distance sensor Performance Test ------------- +----------------- Demo of reading the range from the VL6180x distance sensor in different access modes (single shot, continuous, history). From dd125e11be05531d78eb702ee255b7e891097241 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 10 Feb 2022 09:34:22 -0500 Subject: [PATCH 25/68] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 014d90d..a3a2b95 100644 --- a/README.rst +++ b/README.rst @@ -63,14 +63,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 a016dc4030539b953874c783f39e37517939edfc Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Fri, 11 Feb 2022 20:01:46 +0100 Subject: [PATCH 26/68] Replaced logging with print statements --- adafruit_vl6180x.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 7bb42a8..ea14a44 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -33,7 +33,6 @@ from adafruit_bus_device import i2c_device try: - import logging from typing import Optional, List from busio import I2C except ImportError: @@ -158,11 +157,11 @@ def range_history_enabled(self) -> bool: history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) if history_ctrl & 0x0: - logging.info("History buffering not enabled") + print("History buffering not enabled") return False if (history_ctrl > 1) & 0x1: - logging.info("History buffer stores ALS data, not range") + print("History buffer stores ALS data, not range") return False return True From 43b0735afbf651fa5ba20924cbf49cf8ee85ede5 Mon Sep 17 00:00:00 2001 From: Jonas Schatz Date: Sat, 12 Feb 2022 00:37:39 +0100 Subject: [PATCH 27/68] Removed typing in history example --- examples/vl6180x_historytest.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/examples/vl6180x_historytest.py b/examples/vl6180x_historytest.py index c82d65c..e2e1a46 100644 --- a/examples/vl6180x_historytest.py +++ b/examples/vl6180x_historytest.py @@ -5,7 +5,6 @@ # distance sensor import time -from typing import List import board import busio @@ -26,8 +25,8 @@ # Main loop prints the ranges every 0.01 seconds for about 5 seconds # You should see changes 'ripple through' the history array for _ in range(500): - # Read the range in millimeters and print it. - ranges_mm: List[int] = sensor.ranges_from_history + # Read the last 16 ranges from the history buffer as a List[int] + ranges_mm = sensor.ranges_from_history print(ranges_mm) # Delay for 10 ms so that the loop is not too fast From b63af0d39b5080cea4967129c7fc821c814ab64f Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 28/68] 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 96132c854617f9b01275a17a4d48e76708c406f5 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 24 Feb 2022 14:57:09 -0500 Subject: [PATCH 29/68] Add parameters and types to docstrings --- adafruit_vl6180x.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index ea14a44..9e2121f 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -95,12 +95,13 @@ class VL6180X: """Create an instance of the VL6180X distance sensor. You must pass in the following parameters: - :param i2c: An instance of the I2C bus connected to the sensor. + :param ~I2C i2c: An instance of the I2C bus connected to the sensor. Optionally you can specify: - :param address: The I2C address of the sensor. If not specified the sensor's + :param int address: The I2C address of the sensor. If not specified the sensor's default value will be assumed. + :param int offset: The offset to be applied to measurements, in mm """ def __init__( @@ -168,7 +169,8 @@ def range_history_enabled(self) -> bool: def start_range_continuous(self, period: int = 100) -> None: """Start continuous range mode - :param period: Time delay between measurements in ms + + :param int period: Time delay between measurements, in milliseconds """ # Set range between measurements period_reg: int = 0 @@ -238,6 +240,8 @@ def read_lux(self, gain: int) -> float: - ALS_GAIN_10 = 10x - ALS_GAIN_20 = 20x - ALS_GAIN_40 = 40x + + :param int gain: The gain value to use """ reg = self._read_8(_VL6180X_REG_SYSTEM_INTERRUPT_CONFIG) reg &= ~0x38 From 1b3592d53b1429f1d0c53d8912a035a3474e454d Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 24 Feb 2022 14:57:34 -0500 Subject: [PATCH 30/68] Update gain and error description to use tables --- adafruit_vl6180x.py | 49 +++++++++++++++++++++++++++------------------ 1 file changed, 30 insertions(+), 19 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 9e2121f..e3c1beb 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -232,16 +232,22 @@ def _read_range_continuous(self) -> int: def read_lux(self, gain: int) -> float: """Read the lux (light value) from the sensor and return it. Must specify the gain value to use for the lux reading: - - ALS_GAIN_1 = 1x - - ALS_GAIN_1_25 = 1.25x - - ALS_GAIN_1_67 = 1.67x - - ALS_GAIN_2_5 = 2.5x - - ALS_GAIN_5 = 5x - - ALS_GAIN_10 = 10x - - ALS_GAIN_20 = 20x - - ALS_GAIN_40 = 40x + + ================= ===== + Setting Value + ================= ===== + ``ALS_GAIN_1`` 1x + ``ALS_GAIN_1_25`` 1.25x + ``ALS_GAIN_1_67`` 1.67x + ``ALS_GAIN_2_5`` 2.5x + ``ALS_GAIN_5`` 5x + ``ALS_GAIN_10`` 10x + ``ALS_GAIN_20`` 20x + ``ALS_GAIN_40`` 40x + ================= ===== :param int gain: The gain value to use + """ reg = self._read_8(_VL6180X_REG_SYSTEM_INTERRUPT_CONFIG) reg &= ~0x38 @@ -290,17 +296,22 @@ def range_status(self) -> int: """Retrieve the status/error from a previous range read. This will return a constant value such as: - - ERROR_NONE - No error - - ERROR_SYSERR_1 - System error 1 (see datasheet) - - ERROR_SYSERR_5 - System error 5 (see datasheet) - - ERROR_ECEFAIL - ECE failure - - ERROR_NOCONVERGE - No convergence - - ERROR_RANGEIGNORE - Outside range ignored - - ERROR_SNR - Too much noise - - ERROR_RAWUFLOW - Raw value underflow - - ERROR_RAWOFLOW - Raw value overflow - - ERROR_RANGEUFLOW - Range underflow - - ERROR_RANGEOFLOW - Range overflow + ===================== ============================== + Error Description + ===================== ============================== + ``ERROR_NONE`` No error + ``ERROR_SYSERR_1`` System error 1 (see datasheet) + ``ERROR_SYSERR_5`` System error 5 (see datasheet) + ``ERROR_ECEFAIL`` ECE failure + ``ERROR_NOCONVERGE`` No convergence + ``ERROR_RANGEIGNORE`` Outside range ignored + ``ERROR_SNR`` Too much noise + ``ERROR_RAWUFLOW`` Raw value underflow + ``ERROR_RAWOFLOW`` Raw value overflow + ``ERROR_RANGEUFLOW`` Range underflow + ``ERROR_RANGEOFLOW`` Range overflow + ===================== ============================== + """ return self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) >> 4 From f3712c9e692058d0aff51e6336898f6f33fafdc2 Mon Sep 17 00:00:00 2001 From: tekktrik <89490472+tekktrik@users.noreply.github.com> Date: Mon, 28 Feb 2022 20:23:46 -0500 Subject: [PATCH 31/68] Update vl6180x_performancetest.py --- examples/vl6180x_performancetest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/vl6180x_performancetest.py b/examples/vl6180x_performancetest.py index 933a256..1501817 100644 --- a/examples/vl6180x_performancetest.py +++ b/examples/vl6180x_performancetest.py @@ -39,7 +39,7 @@ # Continuous with no delay between measurements print("Starting continuous measurement...") -sensor.start_range_continuous(0) +sensor.start_range_continuous(20) start = time.time() for i in range(n_measurements): range_mm = sensor.range From 67669715f95e8ed343c282195b16450579fe0a7d Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 28 Feb 2022 20:51:14 -0500 Subject: [PATCH 32/68] Add ValueError to start_range_continuous() Refactors `start_range_continuous()` and also adds throwing ValueError if out of range. --- adafruit_vl6180x.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index e3c1beb..f953da7 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -170,15 +170,16 @@ def range_history_enabled(self) -> bool: def start_range_continuous(self, period: int = 100) -> None: """Start continuous range mode - :param int period: Time delay between measurements, in milliseconds + :param int period: Time delay between measurements, in milliseconds; the value you will be floored + to the nearest 10 milliseconds (setting to 157 ms sets it to 150 ms). Range is 10 - 2550 ms. """ # Set range between measurements - period_reg: int = 0 - if period > 10: - if period < 2250: - period_reg = (period // 10) - 1 - else: - period_reg = 254 + if not 10 <= period <= 2550: + raise ValueError( + "Delay must be in 10 millisecond increments between 10 and 2550 milliseconds" + ) + + period_reg = (period // 10) - 1 self._write_8(_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD, period_reg) # Start continuous range measurement From 374eaf9bc002f2dadda3d755ace69f036ec87697 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 28 Feb 2022 20:58:12 -0500 Subject: [PATCH 33/68] Fix line length lint warnings --- adafruit_vl6180x.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index f953da7..bf83d7a 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -170,8 +170,9 @@ def range_history_enabled(self) -> bool: def start_range_continuous(self, period: int = 100) -> None: """Start continuous range mode - :param int period: Time delay between measurements, in milliseconds; the value you will be floored - to the nearest 10 milliseconds (setting to 157 ms sets it to 150 ms). Range is 10 - 2550 ms. + :param int period: Time delay between measurements, in milliseconds; the value you + will be floored to the nearest 10 milliseconds (setting to 157 ms sets it to 150 + ms). Range is 10 - 2550 ms. """ # Set range between measurements if not 10 <= period <= 2550: From d61f58c4e2501a7d6c83ff9640b48150c1309544 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 34/68] 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 ac3985251625f6075155edb4a7ed7a7383fa7247 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 29 Mar 2022 18:16:44 -0400 Subject: [PATCH 35/68] "Reformatted per new black version" --- adafruit_vl6180x.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index e3c1beb..20a7a7b 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -141,7 +141,7 @@ def range_from_history(self) -> Optional[int]: @property def ranges_from_history(self) -> Optional[List[int]]: - """ Read the last 16 range measurements from history """ + """Read the last 16 range measurements from history""" if not self.range_history_enabled: return None @@ -153,7 +153,7 @@ def ranges_from_history(self) -> Optional[List[int]]: @property def range_history_enabled(self) -> bool: - """ Checks if history buffer stores range data """ + """Checks if history buffer stores range data""" history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) @@ -192,7 +192,7 @@ def stop_range_continuous(self) -> None: @property def continuous_mode_enabled(self) -> bool: - """ Checks if continuous mode is enabled """ + """Checks if continuous mode is enabled""" return self._read_8(_VL6180X_REG_SYSRANGE_START) > 1 & 0x1 @property @@ -208,14 +208,14 @@ def offset(self, offset: int) -> None: self._offset = offset def _read_range_single(self) -> int: - """ Read the range when in single-shot mode""" + """Read the range when in single-shot mode""" while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: pass self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) return self._read_range_continuous() def _read_range_continuous(self) -> int: - """ Read the range when in continuous mode""" + """Read the range when in continuous mode""" # Poll until bit 2 is set while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: From ce07b1af5eb479efc6643fae5a5a85087ec7bdaf Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 36/68] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 9647e71..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From 003a5063d2c65886ee35960bfe42d6997eb6a59f Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:59:34 -0400 Subject: [PATCH 37/68] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index a3a2b95..9953b33 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :target: https://docs.circuitpython.org/projects/vl6180x/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 afcb59e2c17fca004677737fa8aa70140276a812 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 14:00:51 -0500 Subject: [PATCH 38/68] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9953b33..f3113e7 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :target: https://docs.circuitpython.org/projects/vl6180x/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 d65207fadc88990037cbab94440544fcb6842ce4 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:19:55 -0400 Subject: [PATCH 39/68] 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 d122b52f3d294d11a1093b330db0c6a794534f69 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 40/68] 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 c09963a943b19bb27e430616de5587cce66d0e98 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 41/68] 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 4e3f26f9451528da0e56ccb83407ba9672e1b2e4 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 42/68] 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 e17b943..b47a9d7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,7 +61,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 f697487bf7e17e18e65fbc334495d1982cb0d545 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:35:12 -0400 Subject: [PATCH 43/68] 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 823e20f..76d766b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From 7f42b451ac82263c3a9aa3bbc4214966fa08db22 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:59:32 -0400 Subject: [PATCH 44/68] 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 f3113e7..7cae5de 100644 --- a/README.rst +++ b/README.rst @@ -49,8 +49,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-vl6180x Usage Example From 6897e90f54c972f41391e9ce4c12432af10959dc Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:01:15 -0400 Subject: [PATCH 45/68] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 7cae5de..d4fe2fc 100644 --- a/README.rst +++ b/README.rst @@ -14,6 +14,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + CircuitPython module for the VL6180X distance sensor. See examples/vl6180x_simpletest.py for a demo of the usage. From d8f35859bdef871105328bf7a7504d704e3ece72 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:54 -0400 Subject: [PATCH 46/68] Switched to pyproject.toml --- .github/workflows/build.yml | 18 +++++++----- .github/workflows/release.yml | 17 ++++++----- optional_requirements.txt | 3 ++ pyproject.toml | 47 ++++++++++++++++++++++++++++++ requirements.txt | 2 +- setup.py | 55 ----------------------------------- 6 files changed, 71 insertions(+), 71 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c99b9ae --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-vl6180x" +description = "CircuitPython library for VL6180X time of flight distance 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_VL6180X"} +keywords = [ + "adafruit", + "vl6180x", + "time", + "flight", + "distance", + "sensorbreakout", + "hardware", + "micropython", + "circuitpython", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +py-modules = ["adafruit_vl6180x"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index f675e3b..a45c547 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/setup.py b/setup.py deleted file mode 100644 index 22df8a9..0000000 --- a/setup.py +++ /dev/null @@ -1,55 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -# Always prefer setuptools over distutils -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-vl6180x", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for VL6180X time of flight distance sensor.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_VL6180X", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit vl6180x time flight distance sensor" - "breakout hardware micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_vl6180x"], -) From ba177bd4f96eb9ae87a5bda4fb9296b387f16c0a Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 47/68] 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 c99b9ae..b43a796 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 128e839cedba74db760fb06345a9e6f1f4512b95 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:15 -0400 Subject: [PATCH 48/68] Update version string --- adafruit_vl6180x.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 58082c3..baf9245 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -39,7 +39,7 @@ pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" # Registers diff --git a/pyproject.toml b/pyproject.toml index b43a796..1b7a583 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-vl6180x" description = "CircuitPython library for VL6180X time of flight distance 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 8458772938219718e1f0de16c36cb9c2d2ee7e83 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:14 -0400 Subject: [PATCH 49/68] 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 9caf94a0560acda44158441245f1920bbcad6eba Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:32 -0400 Subject: [PATCH 50/68] 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 b47a9d7..f0a513a 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("..")) @@ -44,7 +45,8 @@ # General information about the project. project = "Adafruit VL6180X Library" -copyright = "2017 Tony DiCola" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Tony DiCola" author = "Tony DiCola" # The version info for the project you're documenting, acts as replacement for From 8b7a343942667d6fd3b72e80327cc0af4847e3ac Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:22 -0400 Subject: [PATCH 51/68] 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 f0a513a..590cf97 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,8 +45,14 @@ # General information about the project. project = "Adafruit VL6180X Library" +creation_year = "2017" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Tony DiCola" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Tony DiCola" author = "Tony DiCola" # The version info for the project you're documenting, acts as replacement for From 5048df65ab19c9a842161c341a1d41e20dffb51a Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:50 -0400 Subject: [PATCH 52/68] 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 a042f598a29c16a457ff49085b8b4c84ce512be1 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:47:00 -0400 Subject: [PATCH 53/68] 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 7edb7f7302ea81f12481960bdc6d338d294d78e5 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:20 -0400 Subject: [PATCH 54/68] 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 aa355609300b6b37ce5d0018848c264195622530 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:45 -0400 Subject: [PATCH 55/68] 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 436560d71eb1550d61db69bc602cc58e3e71083b Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:33 -0400 Subject: [PATCH 56/68] 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 b0bdc4fe29fbe30ad346dc46ad2da082b036e7e7 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 57/68] 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 c19bcee708a7394bcd19fae0ca57fffd906a3664 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 58/68] 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 63e774f01e9e942a1757646d8a4e82b4b973c8a7 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 59/68] 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 0b7ce4c93df20e12b1a8360432ce69d6874bbe9f Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 21:40:26 -0400 Subject: [PATCH 60/68] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index 590cf97..affccea 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", ] diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 0f41fa6061354a7e5e128cc8224c33f4cbea6c84 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:18:51 -0500 Subject: [PATCH 61/68] "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 affccea..c28d104 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,19 +101,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 9f8d6017fc5d9a322c4c49a2b6b125bbcbbe7223 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 62/68] 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 c99fb3647c2d985258c9b377829e8b7b08500bde Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 63/68] 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 c28d104..11c0b0f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,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 be2d50fc8404b9efc1836cbb979c6b1d7454906a Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Fri, 13 Dec 2024 08:20:33 -0500 Subject: [PATCH 64/68] adding_displayio_example --- docs/examples.rst | 9 +++++ examples/vl6180x_displayio_simpletest.py | 50 ++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 examples/vl6180x_displayio_simpletest.py diff --git a/docs/examples.rst b/docs/examples.rst index c348e59..9311dfe 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -46,3 +46,12 @@ Demo of reading the range from the VL6180x distance sensor in different access m .. literalinclude:: ../examples/vl6180x_performancetest.py :caption: examples/vl6180x_performancetest.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/vl6180x_displayio_simpletest.py + :caption: examples/vl6180x_displayio_simpletest.py + :linenos: diff --git a/examples/vl6180x_displayio_simpletest.py b/examples/vl6180x_displayio_simpletest.py new file mode 100644 index 0000000..6d88085 --- /dev/null +++ b/examples/vl6180x_displayio_simpletest.py @@ -0,0 +1,50 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# SPDX-FileCopyrightText: 2024 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time +import board +from adafruit_display_text.bitmap_label import Label +from terminalio import FONT +from displayio import Group +import adafruit_vl6180x + +# Simple demo of the vl6180x distance sensor. +# create a main_group to hold anything we want to show on the display. +main_group = Group() +# Initialize I2C bus and sensor. +i2c = board.I2C() # uses board.SCL and board.SDA +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Create two Labels to show the readings. If you have a very small +# display you may need to change to scale=1. +range_output_label = Label(FONT, text="", scale=2) +light_lux_output_label = Label(FONT, text="", scale=2) + +# place the labels in the middle of the screen with anchored positioning +range_output_label.anchor_point = (0, 0) +range_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 40, +) +light_lux_output_label.anchor_point = (0, 0) +light_lux_output_label.anchored_position = (4, board.DISPLAY.height // 2) + + +# add the label to the main_group +main_group.append(range_output_label) +main_group.append(light_lux_output_label) + +# set the main_group as the root_group of the built-in DISPLAY +board.DISPLAY.root_group = main_group + +# begin main loop +while True: + # Update the label.text property to change the text on the display + range_output_label.text = f"Range:{sensor.range} mm" + light_lux_output_label.text = ( + f"Lux:{sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1)} lux" + ) + # wait for a bit + time.sleep(1.0) From 980d4a207ecf6249445fd7cd59f4184ce312a56a Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 2 Jan 2025 14:49:58 -0600 Subject: [PATCH 65/68] minimum 20ms continuous read mode --- adafruit_vl6180x.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index baf9245..4983a41 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -172,12 +172,12 @@ def start_range_continuous(self, period: int = 100) -> None: :param int period: Time delay between measurements, in milliseconds; the value you will be floored to the nearest 10 milliseconds (setting to 157 ms sets it to 150 - ms). Range is 10 - 2550 ms. + ms). Range is 20 - 2550 ms. """ # Set range between measurements - if not 10 <= period <= 2550: + if not 20 <= period <= 2550: raise ValueError( - "Delay must be in 10 millisecond increments between 10 and 2550 milliseconds" + "Delay must be in 10 millisecond increments between 20 and 2550 milliseconds" ) period_reg = (period // 10) - 1 From 9f5f9f044fddfed1bf471a5fc6ceb62dabc2eb3e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 66/68] 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 e053c9059bcb091fb33477c4e3918ce9e52582e2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 15 May 2025 19:17:21 +0000 Subject: [PATCH 67/68] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 ----------------------- README.rst | 6 +- adafruit_vl6180x.py | 24 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/vl6180x_calibrationtest.py | 1 - examples/vl6180x_continuoustest.py | 3 +- examples/vl6180x_displayio_simpletest.py | 8 +- examples/vl6180x_historytest.py | 1 - examples/vl6180x_performancetest.py | 17 +- examples/vl6180x_simpletest.py | 5 +- ruff.toml | 107 ++++++ 14 files changed, 155 insertions(+), 481 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 d4fe2fc..cddc190 100644 --- a/README.rst +++ b/README.rst @@ -14,9 +14,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/actions/ :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff CircuitPython module for the VL6180X distance sensor. See examples/vl6180x_simpletest.py for a demo of the usage. diff --git a/adafruit_vl6180x.py b/adafruit_vl6180x.py index 4983a41..d11623e 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -25,15 +25,16 @@ https://github.com/adafruit/circuitpython/releases * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ + import struct import time -from micropython import const - from adafruit_bus_device import i2c_device +from micropython import const try: - from typing import Optional, List + from typing import List, Optional + from busio import I2C except ImportError: pass @@ -104,9 +105,7 @@ class VL6180X: :param int offset: The offset to be applied to measurements, in mm """ - def __init__( - self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0 - ) -> None: + def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0) -> None: self._device = i2c_device.I2CDevice(i2c, address) if self._read_8(_VL6180X_REG_IDENTIFICATION_MODEL_ID) != 0xB4: raise RuntimeError("Could not find VL6180X, is it connected and powered?") @@ -146,10 +145,7 @@ def ranges_from_history(self) -> Optional[List[int]]: if not self.range_history_enabled: return None - return [ - self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) - for age in range(16) - ] + return [self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) for age in range(16)] @property def range_history_enabled(self) -> bool: @@ -204,9 +200,7 @@ def offset(self) -> int: @offset.setter def offset(self, offset: int) -> None: - self._write_8( - _VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0] - ) + self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0]) self._offset = offset def _read_range_single(self) -> int: @@ -264,9 +258,7 @@ def read_lux(self, gain: int) -> float: # start ALS self._write_8(_VL6180X_REG_SYSALS_START, 0x1) # Poll until "New Sample Ready threshold event" is set - while ( - (self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) >> 3) & 0x7 - ) != 4: + while ((self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) >> 3) & 0x7) != 4: pass # read lux! lux = self._read_16(_VL6180X_REG_RESULT_ALS_VAL) diff --git a/docs/api.rst b/docs/api.rst index 0bf26c6..1aa8eff 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,8 @@ .. If you created a package, create one automodule per module in the package. +API Reference +############# + .. automodule:: adafruit_vl6180x :members: diff --git a/docs/conf.py b/docs/conf.py index 11c0b0f..e415180 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("..")) @@ -49,9 +47,7 @@ creation_year = "2017" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Tony DiCola" author = "Tony DiCola" diff --git a/examples/vl6180x_calibrationtest.py b/examples/vl6180x_calibrationtest.py index c3e5630..3e8d68d 100644 --- a/examples/vl6180x_calibrationtest.py +++ b/examples/vl6180x_calibrationtest.py @@ -11,7 +11,6 @@ import adafruit_vl6180x - # Create I2C bus. i2c = busio.I2C(board.SCL, board.SDA) diff --git a/examples/vl6180x_continuoustest.py b/examples/vl6180x_continuoustest.py index d638915..5960bb0 100644 --- a/examples/vl6180x_continuoustest.py +++ b/examples/vl6180x_continuoustest.py @@ -11,7 +11,6 @@ import adafruit_vl6180x - # Create I2C bus. i2c = busio.I2C(board.SCL, board.SDA) @@ -26,7 +25,7 @@ for _ in range(100): # Read the range in millimeters and print it. range_mm = sensor.range - print("Range: {0}mm".format(range_mm)) + print(f"Range: {range_mm}mm") # Delay for 10 ms time.sleep(0.01) diff --git a/examples/vl6180x_displayio_simpletest.py b/examples/vl6180x_displayio_simpletest.py index 6d88085..342d33e 100644 --- a/examples/vl6180x_displayio_simpletest.py +++ b/examples/vl6180x_displayio_simpletest.py @@ -4,10 +4,12 @@ # SPDX-License-Identifier: MIT import time + import board from adafruit_display_text.bitmap_label import Label -from terminalio import FONT from displayio import Group +from terminalio import FONT + import adafruit_vl6180x # Simple demo of the vl6180x distance sensor. @@ -43,8 +45,6 @@ while True: # Update the label.text property to change the text on the display range_output_label.text = f"Range:{sensor.range} mm" - light_lux_output_label.text = ( - f"Lux:{sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1)} lux" - ) + light_lux_output_label.text = f"Lux:{sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1)} lux" # wait for a bit time.sleep(1.0) diff --git a/examples/vl6180x_historytest.py b/examples/vl6180x_historytest.py index e2e1a46..2b1e430 100644 --- a/examples/vl6180x_historytest.py +++ b/examples/vl6180x_historytest.py @@ -11,7 +11,6 @@ import adafruit_vl6180x - # Create I2C bus. i2c = busio.I2C(board.SCL, board.SDA) diff --git a/examples/vl6180x_performancetest.py b/examples/vl6180x_performancetest.py index 1501817..770852b 100644 --- a/examples/vl6180x_performancetest.py +++ b/examples/vl6180x_performancetest.py @@ -11,7 +11,6 @@ import adafruit_vl6180x - # Create I2C bus. i2c = busio.I2C(board.SCL, board.SDA) @@ -27,11 +26,7 @@ start = time.time() for i in range(n_measurements): range_mm = sensor.range -print( - "Performed {} measurements in single-shot mode in {}s\n".format( - n_measurements, time.time() - start - ) -) +print(f"Performed {n_measurements} measurements in single-shot mode in {time.time() - start}s\n") # Sleep is required, otherwise the sensor might freeze when switching to # continuous mode too quickly after the last single shot @@ -43,11 +38,7 @@ start = time.time() for i in range(n_measurements): range_mm = sensor.range -print( - "Performed {} measurements in continuous mode in {}s\n".format( - n_measurements, time.time() - start - ) -) +print(f"Performed {n_measurements} measurements in continuous mode in {time.time() - start}s\n") # Continuous, reading data from history. # Note: This is fast, since you don't have to wait for the measurement to be @@ -57,9 +48,7 @@ for i in range(n_measurements): range_mm = sensor.range_from_history print( - "Performed {} measurements in continuous mode, reading form history, in {}s\n".format( - n_measurements, time.time() - start - ) + f"Performed {n_measurements} measurements in continuous mode, reading form history, in {time.time() - start}s\n" # noqa: E501 ) sensor.stop_range_continuous() diff --git a/examples/vl6180x_simpletest.py b/examples/vl6180x_simpletest.py index 2b06f4a..a66af8d 100644 --- a/examples/vl6180x_simpletest.py +++ b/examples/vl6180x_simpletest.py @@ -11,7 +11,6 @@ import adafruit_vl6180x - # Create I2C bus. i2c = busio.I2C(board.SCL, board.SDA) @@ -25,7 +24,7 @@ while True: # Read the range in millimeters and print it. range_mm = sensor.range - print("Range: {0}mm".format(range_mm)) + print(f"Range: {range_mm}mm") # Read the light, note this requires specifying a gain value: # - adafruit_vl6180x.ALS_GAIN_1 = 1x # - adafruit_vl6180x.ALS_GAIN_1_25 = 1.25x @@ -36,6 +35,6 @@ # - adafruit_vl6180x.ALS_GAIN_20 = 20x # - adafruit_vl6180x.ALS_GAIN_40 = 40x light_lux = sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1) - print("Light (1x gain): {0}lux".format(light_lux)) + print(f"Light (1x gain): {light_lux}lux") # Delay for a second. time.sleep(1.0) diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..1b887b1 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel +] + +[format] +line-ending = "lf" From 18086e601671906118f2514d2475ed418b152fd2 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 68/68] 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"