TI OPT3001 light sensor support (#4015)

* TI OPT3001 light sensor support

* Added register interrogation to deconflict with SHT sensors on same address

platformio.ini

@@ -136,4 +136,5 @@ lib_deps =
   mprograms/QMC5883LCompass@^1.2.0
   adafruit/Adafruit VEML7700 Library@^2.1.6
   adafruit/Adafruit SHT4x Library@^1.0.4
-  adafruit/Adafruit TSL2591 Library@^1.4.5
+  adafruit/Adafruit TSL2591 Library@^1.4.5
+  ClosedCube OPT3001@^1.1.2

src/configuration.h

@@ -132,6 +132,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define RCWL9620_ADDR 0x57
 #define VEML7700_ADDR 0x10
 #define TSL25911_ADDR 0x29
+#define OPT3001_ADDRESS 0x45
+#define OPT3001_ADDRESS_ALT 0x44
 
 // -----------------------------------------------------------------------------
 // ACCELEROMETER

src/detect/ScanI2C.h

@@ -46,6 +46,7 @@ class ScanI2C
         RCWL9620,
         NCP5623,
         TSL2591,
+        OPT3001,
         AHT10,
     } DeviceType;
 

src/detect/ScanI2CTwoWire.cpp

@@ -302,6 +302,9 @@ void ScanI2CTwoWire::scanPort(I2CPort port)
                 if (registerValue == 0x11a2) {
                     type = SHT4X;
                     LOG_INFO("SHT4X sensor found\n");
+                } else if (getRegisterValue(ScanI2CTwoWire::RegisterLocation(addr, 0x7E), 2) == 0x5449) {
+                    type = OPT3001;
+                    LOG_INFO("OPT3001 light sensor found\n");
                 } else {
                     type = SHT31;
                     LOG_INFO("SHT31 sensor found\n");
@@ -343,6 +346,7 @@ void ScanI2CTwoWire::scanPort(I2CPort port)
                 SCAN_SIMPLE_CASE(TCA9555_ADDR, TCA9555, "TCA9555 I2C expander found\n");
                 SCAN_SIMPLE_CASE(VEML7700_ADDR, VEML7700, "VEML7700 light sensor found\n");
                 SCAN_SIMPLE_CASE(TSL25911_ADDR, TSL2591, "TSL2591 light sensor found\n");
+                SCAN_SIMPLE_CASE(OPT3001_ADDRESS, OPT3001, "OPT3001 light sensor found\n");
 
             default:
                 LOG_INFO("Device found at address 0x%x was not able to be enumerated\n", addr.address);

src/main.cpp

@@ -534,6 +534,7 @@ void setup()
     SCANNER_TO_SENSORS_MAP(ScanI2C::DeviceType::RCWL9620, meshtastic_TelemetrySensorType_RCWL9620)
     SCANNER_TO_SENSORS_MAP(ScanI2C::DeviceType::VEML7700, meshtastic_TelemetrySensorType_VEML7700)
     SCANNER_TO_SENSORS_MAP(ScanI2C::DeviceType::TSL2591, meshtastic_TelemetrySensorType_TSL25911FN)
+    SCANNER_TO_SENSORS_MAP(ScanI2C::DeviceType::OPT3001, meshtastic_TelemetrySensorType_OPT3001)
     SCANNER_TO_SENSORS_MAP(ScanI2C::DeviceType::SHT4X, meshtastic_TelemetrySensorType_SHT4X)
     SCANNER_TO_SENSORS_MAP(ScanI2C::DeviceType::AHT10, meshtastic_TelemetrySensorType_AHT10)
 

src/modules/Telemetry/EnvironmentTelemetry.cpp

@@ -25,6 +25,7 @@
 #include "Sensor/BMP280Sensor.h"
 #include "Sensor/LPS22HBSensor.h"
 #include "Sensor/MCP9808Sensor.h"
+#include "Sensor/OPT3001Sensor.h"
 #include "Sensor/RCWL9620Sensor.h"
 #include "Sensor/SHT31Sensor.h"
 #include "Sensor/SHT4XSensor.h"
@@ -42,6 +43,7 @@ LPS22HBSensor lps22hbSensor;
 SHT31Sensor sht31Sensor;
 VEML7700Sensor veml7700Sensor;
 TSL2591Sensor tsl2591Sensor;
+OPT3001Sensor opt3001Sensor;
 SHT4XSensor sht4xSensor;
 RCWL9620Sensor rcwl9620Sensor;
 AHT10Sensor aht10Sensor;
@@ -109,6 +111,8 @@ int32_t EnvironmentTelemetryModule::runOnce()
                 result = veml7700Sensor.runOnce();
             if (tsl2591Sensor.hasSensor())
                 result = tsl2591Sensor.runOnce();
+            if (opt3001Sensor.hasSensor())
+                result = opt3001Sensor.runOnce();
             if (rcwl9620Sensor.hasSensor())
                 result = rcwl9620Sensor.runOnce();
             if (aht10Sensor.hasSensor())
@@ -299,6 +303,10 @@ bool EnvironmentTelemetryModule::sendTelemetry(NodeNum dest, bool phoneOnly)
         valid = valid && tsl2591Sensor.getMetrics(&m);
         hasSensor = true;
     }
+    if (opt3001Sensor.hasSensor()) {
+        valid = valid && opt3001Sensor.getMetrics(&m);
+        hasSensor = true;
+    }
     if (rcwl9620Sensor.hasSensor()) {
         valid = valid && rcwl9620Sensor.getMetrics(&m);
         hasSensor = true;

src/modules/Telemetry/Sensor/OPT3001Sensor.cpp

@@ -0,0 +1,44 @@
+#include "OPT3001Sensor.h"
+#include "../mesh/generated/meshtastic/telemetry.pb.h"
+#include "TelemetrySensor.h"
+#include "configuration.h"
+#include <ClosedCube_OPT3001.h>
+
+OPT3001Sensor::OPT3001Sensor() : TelemetrySensor(meshtastic_TelemetrySensorType_OPT3001, "OPT3001") {}
+
+int32_t OPT3001Sensor::runOnce()
+{
+    LOG_INFO("Init sensor: %s\n", sensorName);
+    if (!hasSensor()) {
+        return DEFAULT_SENSOR_MINIMUM_WAIT_TIME_BETWEEN_READS;
+    }
+    auto errorCode = opt3001.begin(nodeTelemetrySensorsMap[sensorType].first);
+    status = errorCode == NO_ERROR;
+
+    return initI2CSensor();
+}
+
+void OPT3001Sensor::setup()
+{
+    OPT3001_Config newConfig;
+
+    newConfig.RangeNumber = B1100;
+    newConfig.ConvertionTime = B0;
+    newConfig.Latch = B1;
+    newConfig.ModeOfConversionOperation = B11;
+
+    OPT3001_ErrorCode errorConfig = opt3001.writeConfig(newConfig);
+    if (errorConfig != NO_ERROR) {
+        LOG_ERROR("OPT3001 configuration error #%d", errorConfig);
+    }
+}
+
+bool OPT3001Sensor::getMetrics(meshtastic_Telemetry *measurement)
+{
+    OPT3001 result = opt3001.readResult();
+
+    measurement->variant.environment_metrics.lux = result.lux;
+    LOG_INFO("Lux: %f\n", measurement->variant.environment_metrics.lux);
+
+    return true;
+}

src/modules/Telemetry/Sensor/OPT3001Sensor.h

@@ -0,0 +1,17 @@
+#include "../mesh/generated/meshtastic/telemetry.pb.h"
+#include "TelemetrySensor.h"
+#include <ClosedCube_OPT3001.h>
+
+class OPT3001Sensor : public TelemetrySensor
+{
+  private:
+    ClosedCube_OPT3001 opt3001;
+
+  protected:
+    virtual void setup() override;
+
+  public:
+    OPT3001Sensor();
+    virtual int32_t runOnce() override;
+    virtual bool getMetrics(meshtastic_Telemetry *measurement) override;
+};