Merge pull request #560 from tyeth/main-addvl53l1x

Add Vl53l1x

Author: tyeth

library.properties

@@ -7,4 +7,4 @@ paragraph=Arduino application for Adafruit.io WipperSnapper
 category=Communication
 url=https://github.com/adafruit/Adafruit_Wippersnapper_Arduino
 architectures=*
-depends=Adafruit NeoPixel, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit INA219, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit DPS310, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Sensirion I2C SCD4x, Sensirion I2C SEN5X, arduino-sht, Adafruit Si7021 Library, Adafruit MQTT Library, Adafruit MS8607, Adafruit MCP9808 Library, Adafruit MCP9600 Library, Adafruit MPL115A2, Adafruit MPRLS Library, Adafruit TSL2591 Library, Adafruit_VL53L0X, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS35HW, Adafruit seesaw Library, Adafruit BME680 Library, Adafruit MAX1704X, Adafruit ADT7410 Library, Adafruit HTS221, Adafruit HTU21DF Library, Adafruit HTU31D Library, Adafruit PCT2075, hp_BH1750, ENS160 - Adafruit Fork
+depends=Adafruit NeoPixel, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit INA219, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit DPS310, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Sensirion I2C SCD4x, Sensirion I2C SEN5X, arduino-sht, Adafruit Si7021 Library, Adafruit MQTT Library, Adafruit MS8607, Adafruit MCP9808 Library, Adafruit MCP9600 Library, Adafruit MPL115A2, Adafruit MPRLS Library, Adafruit TSL2591 Library, Adafruit_VL53L0X, Adafruit VL53L1X, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS35HW, Adafruit seesaw Library, Adafruit BME680 Library, Adafruit MAX1704X, Adafruit ADT7410 Library, Adafruit HTS221, Adafruit HTU21DF Library, Adafruit HTU31D Library, Adafruit PCT2075, hp_BH1750, ENS160 - Adafruit Fork

platformio.ini

@@ -49,6 +49,7 @@ lib_deps =
     adafruit/Adafruit TMP117
     adafruit/Adafruit TSL2591 Library
     adafruit/Adafruit_VL53L0X
+    adafruit/Adafruit VL53L1X
     adafruit/Adafruit_VL6180X
     adafruit/Adafruit PM25 AQI Sensor
     adafruit/Adafruit VEML7700 Library

src/components/i2c/WipperSnapper_I2C.cpp

@@ -669,6 +669,17 @@ bool WipperSnapper_Component_I2C::initI2CDevice(
     _vl53l0x->configureDriver(msgDeviceInitReq);
     drivers.push_back(_vl53l0x);
     WS_DEBUG_PRINTLN("VL53L0X Initialized Successfully!");
+  } else if (strcmp("vl53l1x", msgDeviceInitReq->i2c_device_name) == 0) {
+    _vl53l1x = new WipperSnapper_I2C_Driver_VL53L1X(this->_i2c, i2cAddress);
+    if (!_vl53l1x->begin()) {
+      WS_DEBUG_PRINTLN("ERROR: Failed to initialize VL53L1X!");
+      _busStatusResponse =
+          wippersnapper_i2c_v1_BusResponse_BUS_RESPONSE_DEVICE_INIT_FAIL;
+      return false;
+    }
+    _vl53l1x->configureDriver(msgDeviceInitReq);
+    drivers.push_back(_vl53l1x);
+    WS_DEBUG_PRINTLN("VL53L1X Initialized Successfully!");
   } else if (strcmp("vl6180x", msgDeviceInitReq->i2c_device_name) == 0) {
     _vl6180x = new WipperSnapper_I2C_Driver_VL6180X(this->_i2c, i2cAddress);
     if (!_vl6180x->begin()) {

src/components/i2c/WipperSnapper_I2C.h

@@ -62,6 +62,7 @@
 #include "drivers/WipperSnapper_I2C_Driver_VCNL4040.h"
 #include "drivers/WipperSnapper_I2C_Driver_VEML7700.h"
 #include "drivers/WipperSnapper_I2C_Driver_VL53L0X.h"
+#include "drivers/WipperSnapper_I2C_Driver_VL53L1X.h"
 #include "drivers/WipperSnapper_I2C_Driver_VL6180X.h"
 
 #define I2C_TIMEOUT_MS 50 ///< Default I2C timeout, in milliseconds.
@@ -151,6 +152,7 @@ class WipperSnapper_Component_I2C {
   WipperSnapper_I2C_Driver_LPS3XHW *_lps3xhw = nullptr;
   WipperSnapper_I2C_Driver_STEMMA_Soil_Sensor *_ss = nullptr;
   WipperSnapper_I2C_Driver_VL53L0X *_vl53l0x = nullptr;
+  WipperSnapper_I2C_Driver_VL53L1X *_vl53l1x = nullptr;
   WipperSnapper_I2C_Driver_VL6180X *_vl6180x = nullptr;
   WipperSnapper_I2C_Driver_MAX17048 *_max17048 = nullptr;
   WipperSnapper_I2C_Driver_ADT7410 *_adt7410 = nullptr;

src/components/i2c/drivers/WipperSnapper_I2C_Driver_VL53L1X.h

@@ -0,0 +1,101 @@
+/*!
+ * @file WipperSnapper_I2C_Driver_VL53L1X.h
+ *
+ * Device driver for the VL53L1X ToF sensor.
+ *
+ * Adafruit invests time and resources providing this open source code,
+ * please support Adafruit and open-source hardware by purchasing
+ * products from Adafruit!
+ *
+ * Copyright (c) 2022 afp316 https://github.com/afp316
+ * Modified  Tyeth Gundry 2023 for Adafruit Industries.
+ *
+ * MIT license, all text here must be included in any redistribution.
+ *
+ */
+#ifndef WipperSnapper_I2C_Driver_VL53L1X_H
+#define WipperSnapper_I2C_Driver_VL53L1X_H
+
+#include "WipperSnapper_I2C_Driver.h"
+#include <Adafruit_VL53L1X.h>
+
+/**************************************************************************/
+/*!
+    @brief  Class that provides a driver interface for a VL53L1X sensor.
+*/
+/**************************************************************************/
+class WipperSnapper_I2C_Driver_VL53L1X : public WipperSnapper_I2C_Driver {
+public:
+  /*******************************************************************************/
+  /*!
+      @brief    Constructor for a VL53L1X sensor.
+      @param    i2c
+                The I2C interface.
+      @param    sensorAddress
+                7-bit device address.
+  */
+  /*******************************************************************************/
+  WipperSnapper_I2C_Driver_VL53L1X(TwoWire *i2c, uint16_t sensorAddress)
+      : WipperSnapper_I2C_Driver(i2c, sensorAddress) {
+    _i2c = i2c;
+    _sensorAddress = sensorAddress;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Destructor for an VL53L1X sensor.
+  */
+  /*******************************************************************************/
+  ~WipperSnapper_I2C_Driver_VL53L1X() {
+    // Called when a VL53L1X component is deleted.
+    delete _VL53L1X;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Initializes the VL53L1X sensor and begins I2C.
+      @returns  True if initialized successfully, False otherwise.
+  */
+  /*******************************************************************************/
+  bool begin() {
+    _VL53L1X = new Adafruit_VL53L1X();
+    if (_VL53L1X->begin((uint8_t)_sensorAddress, _i2c, false)) {
+      _VL53L1X->startRanging();
+      _VL53L1X->setTimingBudget(500); // distance mode is long(2) by default
+      return true;
+    }
+    return false;
+  }
+
+  /*******************************************************************************/
+  /*!
+      @brief    Gets the VL53L1X's current proximity.
+      @param    proximityEvent
+                Pointer to an Adafruit_Sensor event.
+      @returns  True if the proximity was obtained successfully, False
+                otherwise.
+  */
+  /*******************************************************************************/
+  bool getEventProximity(sensors_event_t *proximityEvent) {
+    if (!_VL53L1X->dataReady()) {
+      return false;
+    }
+    int16_t proximityMM = _VL53L1X->distance();
+    if (proximityMM == -1) {
+      WS_DEBUG_PRINT("VL53L1X: Invalid proximity value:");
+      WS_DEBUG_PRINTLN(proximityMM);
+      WS_DEBUG_PRINT("VL53L1X status: ");
+      WS_DEBUG_PRINTLN(_VL53L1X->vl_status);
+      proximityEvent->data[0] = NAN;
+    } else {
+      proximityEvent->data[0] = proximityMM;
+      _VL53L1X->clearInterrupt();
+    }
+    return true;
+  }
+
+protected:
+  Adafruit_VL53L1X *_VL53L1X; ///< Pointer to VL53L1X temperature sensor object
+};
+
+#endif // WipperSnapper_I2C_Driver_VL53L1X