adafruit-mirror/Adafruit_Wippersnapper_Arduino
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

add(driver): Add MLX90632 driver w/ debug info

Browse source
This commit is contained in:
tyeth 2025-08-20 12:33:33 +01:00
parent e06ebab53a
commit e873237b5e
6 changed files with 345 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
library.properties
View file

@ -1,5 +1,5 @@
name=Adafruit WipperSnapper
version=1.0.0-beta.110
version=1.0.0-beta.111
author=Adafruit
maintainer=Adafruit <adafruitio@adafruit.com>
sentence=Arduino application for Adafruit.io WipperSnapper
@ -7,4 +7,4 @@ paragraph=Arduino application for Adafruit.io WipperSnapper
category=Communication
url=https://github.com/adafruit/Adafruit_Wippersnapper_Arduino
architectures=*
depends=OmronD6T - Community Fork, SdFat - Adafruit Fork, Adafruit NeoPixel, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit HDC302x, Adafruit INA219, Adafruit INA260 Library, Adafruit INA237 and INA238 Library, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit MCP3421, Adafruit NAU7802 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit DPS310, Adafruit DS248x, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Sensirion I2C SCD4x, Sensirion I2C SEN5X, Sensirion I2C SEN66, 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, STM32duino VL53L4CD, STM32duino VL53L4CX, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VCNL4200 Library, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS28, 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, Adafruit BusIO, Adafruit Unified Sensor, Sensirion Core, Adafruit GFX Library, Adafruit LED Backpack Library, Adafruit LiquidCrystal, Adafruit SH110X, Adafruit SSD1306
depends=OmronD6T - Community Fork, SdFat - Adafruit Fork, Adafruit NeoPixel, Adafruit SPIFlash, ArduinoJson, Adafruit DotStar, Adafruit HDC302x, Adafruit INA219, Adafruit INA260 Library, Adafruit INA237 and INA238 Library, Adafruit LTR329 and LTR303, Adafruit LTR390 Library, Adafruit MCP3421, Adafruit MLX90632 Library, Adafruit NAU7802 Library, Adafruit SleepyDog Library, Adafruit TMP117, Adafruit TinyUSB Library, Adafruit AHTX0, Adafruit BME280 Library, Adafruit BMP280 Library, Adafruit BMP3XX Library, Adafruit DPS310, Adafruit DS248x, Adafruit SCD30, Adafruit SGP30 Sensor, Adafruit SGP40 Sensor, Sensirion I2C SCD4x, Sensirion I2C SEN5X, Sensirion I2C SEN66, 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, STM32duino VL53L4CD, STM32duino VL53L4CX, Adafruit_VL6180X, Adafruit PM25 AQI Sensor, Adafruit VCNL4020 Library, Adafruit VCNL4040, Adafruit VCNL4200 Library, Adafruit VEML7700 Library, Adafruit LC709203F, Adafruit LPS2X, Adafruit LPS28, 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, Adafruit BusIO, Adafruit Unified Sensor, Sensirion Core, Adafruit GFX Library, Adafruit LED Backpack Library, Adafruit LiquidCrystal, Adafruit SH110X, Adafruit SSD1306

1
platformio.ini
View file

@ -57,6 +57,7 @@ lib_deps =
adafruit/Adafruit MCP3421
adafruit/Adafruit MCP9808 Library
adafruit/Adafruit MCP9600 Library
adafruit/Adafruit MLX90632 Library
adafruit/Adafruit MPL115A2
adafruit/Adafruit MPRLS Library
adafruit/Adafruit MS8607

2
src/Wippersnapper.h
View file

@ -142,7 +142,7 @@
#endif
#define WS_VERSION \
"1.0.0-beta.110" ///< WipperSnapper app. version (semver-formatted)
"1.0.0-beta.111" ///< WipperSnapper app. version (semver-formatted)
// Reserved Adafruit IO MQTT topics
#define TOPIC_IO_THROTTLE "/throttle" ///< Adafruit IO Throttle MQTT Topic

11
src/components/i2c/WipperSnapper_I2C.cpp
View file

@ -537,6 +537,17 @@ bool WipperSnapper_Component_I2C::initI2CDevice(
_mcp9808->configureDriver(msgDeviceInitReq);
drivers.push_back(_mcp9808);
WS_DEBUG_PRINTLN("MCP9808 Initialized Successfully!");
} else if (strcmp("mlx90632", msgDeviceInitReq->i2c_device_name) == 0) {
_mlx90632 = new WipperSnapper_I2C_Driver_MLX90632(this->_i2c, i2cAddress);
if (!_mlx90632->begin()) {
WS_DEBUG_PRINTLN("ERROR: Failed to initialize MLX90632!");
_busStatusResponse =
wippersnapper_i2c_v1_BusResponse_BUS_RESPONSE_DEVICE_INIT_FAIL;
return false;
}
_mlx90632->configureDriver(msgDeviceInitReq);
drivers.push_back(_mlx90632);
WS_DEBUG_PRINTLN("MLX90632 Initialized Successfully!");
} else if (strcmp("mpl115a2", msgDeviceInitReq->i2c_device_name) == 0) {
_mpl115a2 = new WipperSnapper_I2C_Driver_MPL115A2(this->_i2c, i2cAddress);
if (!_mpl115a2->begin()) {

2
src/components/i2c/WipperSnapper_I2C.h
View file

@ -50,6 +50,7 @@
#include "drivers/WipperSnapper_I2C_Driver_MAX17048.h"
#include "drivers/WipperSnapper_I2C_Driver_MCP3421.h"
#include "drivers/WipperSnapper_I2C_Driver_MCP9808.h"
#include "drivers/WipperSnapper_I2C_Driver_MLX90632.h"
#include "drivers/WipperSnapper_I2C_Driver_MPL115A2.h"
#include "drivers/WipperSnapper_I2C_Driver_MPRLS.h"
#include "drivers/WipperSnapper_I2C_Driver_MS8607.h"
@ -180,6 +181,7 @@ private:
WipperSnapper_I2C_Driver_LTR390 *_ltr390 = nullptr;
WipperSnapper_I2C_Driver_MCP3421 *_mcp3421 = nullptr;
WipperSnapper_I2C_Driver_MCP9808 *_mcp9808 = nullptr;
WipperSnapper_I2C_Driver_MLX90632 *_mlx90632 = nullptr;
WipperSnapper_I2C_Driver_MPL115A2 *_mpl115a2 = nullptr;
WipperSnapper_I2C_Driver_MPRLS *_mprls = nullptr;
WipperSnapper_I2C_Driver_MS8607 *_ms8607 = nullptr;

328
src/components/i2c/drivers/WipperSnapper_I2C_Driver_MLX90632.h Normal file
View file

@ -0,0 +1,328 @@
/*!
* @file WipperSnapper_I2C_Driver_MLX90632.h
*
* Device driver for a Melexis MLX90632 thermal FIR 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) Tyeth Gundry 2025 for Adafruit Industries.
*
* MIT license, all text here must be included in any redistribution.
*
*/
#ifndef WipperSnapper_I2C_Driver_MLX90632_H
#define WipperSnapper_I2C_Driver_MLX90632_H
#include <Adafruit_MLX90632.h>
#include "WipperSnapper_I2C_Driver.h"
/**************************************************************************/
/*!
@brief Sensor driver for the Melexis MLX90632 temperature sensor.
*/
/**************************************************************************/
class WipperSnapper_I2C_Driver_MLX90632 : public WipperSnapper_I2C_Driver {
public:
/*******************************************************************************/
/*!
@brief Constructor for an MLX90632 sensor.
@param i2c
The I2C interface.
@param sensorAddress
7-bit device address.
*/
/*******************************************************************************/
WipperSnapper_I2C_Driver_MLX90632(TwoWire *i2c, uint16_t sensorAddress)
: WipperSnapper_I2C_Driver(i2c, sensorAddress) {
_i2c = i2c;
_sensorAddress = sensorAddress;
_deviceTemp = NAN;
_objectTemp = NAN;
_lastRead = 0;
}
/*******************************************************************************/
/*!
@brief Destructor for an MLX90632 sensor.
*/
/*******************************************************************************/
~WipperSnapper_I2C_Driver_MLX90632() { delete _mlx90632; }
/*******************************************************************************/
/*!
@brief Initializes the MLX90632 sensor and begins I2C.
@returns True if initialized successfully, False otherwise.
*/
/*******************************************************************************/
bool begin() {
_mlx90632 = new Adafruit_MLX90632();
// attempt to initialize MLX90632
if (!_mlx90632->begin(_sensorAddress, _i2c))
return false;
return ConfigureAndPrintSensorInfo();
}
/*******************************************************************************/
/*!
@brief Configures the MLX90632 sensor and prints its information.
@returns True if configuration fetching and setting were successful.
*/
/*******************************************************************************/
bool ConfigureAndPrintSensorInfo() {
// Reset the device
if (!_mlx90632->reset()) {
WS_PRINTER.println(F("Device reset failed"));
while (1) { delay(10); }
}
WS_PRINTER.println(F("Device reset: SUCCESS"));
uint64_t productID = _mlx90632->getProductID();
WS_PRINTER.print(F("Product ID: 0x"));
WS_PRINTER.print((uint32_t)(productID >> 32), HEX);
WS_PRINTER.println((uint32_t)(productID & 0xFFFFFFFF), HEX);
uint16_t productCode = _mlx90632->getProductCode();
WS_PRINTER.print(F("Product Code: 0x"));
WS_PRINTER.println(productCode, HEX);
uint16_t eepromVersion = _mlx90632->getEEPROMVersion();
WS_PRINTER.print(F("EEPROM Version: 0x"));
WS_PRINTER.println(eepromVersion, HEX);
// Decode product code bits
uint8_t fov = (productCode >> 8) & 0x3;
uint8_t package = (productCode >> 5) & 0x7;
uint8_t accuracy = productCode & 0x1F;
WS_PRINTER.print(F("FOV: "));
WS_PRINTER.println(fov == 0 ? F("50°") : F("Unknown"));
WS_PRINTER.print(F("Package: "));
WS_PRINTER.println(package == 1 ? F("SFN 3x3") : F("Unknown"));
WS_PRINTER.print(F("Accuracy: "));
if (accuracy == 1) {
WS_PRINTER.println(F("Medical"));
} else if (accuracy == 2) {
WS_PRINTER.println(F("Standard"));
} else {
WS_PRINTER.println(F("Unknown"));
}
// Set and get mode - choose one:
WS_PRINTER.println(F("\n--- Mode Settings ---"));
if (!_mlx90632->setMode(MLX90632_MODE_CONTINUOUS)) {
// if (!_mlx90632->setMode(MLX90632_MODE_STEP)) { // Uncomment for step mode testing
// if (!_mlx90632->setMode(MLX90632_MODE_SLEEPING_STEP)) { // Uncomment for sleeping step mode testing
WS_PRINTER.println(F("Failed to set mode"));
while (1) { delay(10); }
}
//TODO: use Step mode?
mlx90632_mode_t currentMode = _mlx90632->getMode();
WS_PRINTER.print(F("Current mode: "));
switch (currentMode) {
case MLX90632_MODE_HALT:
WS_PRINTER.println(F("Halt"));
break;
case MLX90632_MODE_SLEEPING_STEP:
WS_PRINTER.println(F("Sleeping Step"));
break;
case MLX90632_MODE_STEP:
WS_PRINTER.println(F("Step"));
break;
case MLX90632_MODE_CONTINUOUS:
WS_PRINTER.println(F("Continuous"));
break;
default:
WS_PRINTER.println(F("Unknown"));
}
// set accuracy mode based on medical if detected
if (accuracy == 1) {
// Set and get measurement select (medical)
WS_PRINTER.println(F("\n--- Measurement Select Settings ---"));
if (!_mlx90632->setMeasurementSelect(MLX90632_MEAS_MEDICAL)) {
WS_PRINTER.println(F("Failed to set measurement select to Medical"));
while (1) { delay(10); }
}
mlx90632_meas_select_t currentMeasSelect = _mlx90632->getMeasurementSelect();
WS_PRINTER.print(F("Current measurement select: "));
switch (currentMeasSelect) {
case MLX90632_MEAS_MEDICAL:
WS_PRINTER.println(F("Medical"));
break;
case MLX90632_MEAS_EXTENDED_RANGE:
WS_PRINTER.println(F("Extended Range"));
break;
default:
WS_PRINTER.println(F("Unknown"));
}
}
// Set and get refresh rate (default to 2Hz)
WS_PRINTER.println(F("\n--- Refresh Rate Settings ---"));
if (!_mlx90632->setRefreshRate(MLX90632_REFRESH_2HZ)) {
WS_PRINTER.println(F("Failed to set refresh rate to 2Hz"));
while (1) { delay(10); }
}
mlx90632_refresh_rate_t currentRefreshRate = _mlx90632->getRefreshRate();
WS_PRINTER.print(F("Current refresh rate: "));
switch (currentRefreshRate) {
case MLX90632_REFRESH_0_5HZ:
WS_PRINTER.println(F("0.5 Hz"));
break;
case MLX90632_REFRESH_1HZ:
WS_PRINTER.println(F("1 Hz"));
break;
case MLX90632_REFRESH_2HZ:
WS_PRINTER.println(F("2 Hz"));
break;
case MLX90632_REFRESH_4HZ:
WS_PRINTER.println(F("4 Hz"));
break;
case MLX90632_REFRESH_8HZ:
WS_PRINTER.println(F("8 Hz"));
break;
case MLX90632_REFRESH_16HZ:
WS_PRINTER.println(F("16 Hz"));
break;
case MLX90632_REFRESH_32HZ:
WS_PRINTER.println(F("32 Hz"));
break;
case MLX90632_REFRESH_64HZ:
WS_PRINTER.println(F("64 Hz"));
break;
default:
WS_PRINTER.println(F("Unknown"));
}
// Clear new data flag before starting continuous measurements
WS_PRINTER.println(F("\\n--- Starting Continuous Measurements ---"));
if (!_mlx90632->resetNewData()) {
WS_PRINTER.println(F("Failed to reset new data flag"));
while (1) { delay(10); }
}
return true;
}
/*******************************************************************************/
/*!
@brief Checks if sensor was read within last 1s, or is the first read.
@returns True if the sensor was recently read, False otherwise.
*/
/*******************************************************************************/
bool HasBeenReadInLast200ms() {
return _lastRead != 0 && millis() - _lastRead < 200;
}
/*******************************************************************************/
/*!
@brief Reads the sensor.
@returns True if the sensor was read successfully, False otherwise.
*/
/*******************************************************************************/
bool ReadSensorData() {
bool result=false;
// Only check new data flag - much more efficient for continuous mode
if (_mlx90632->isNewData()) {
WS_PRINTER.print(F("New Data Available - Cycle Position: "));
WS_PRINTER.println(_mlx90632->readCyclePosition());
// Read ambient temperature
_deviceTemp = _mlx90632->getAmbientTemperature();
WS_PRINTER.print(F("Ambient Temperature: "));
WS_PRINTER.print(_deviceTemp, 4);
WS_PRINTER.println(F(" °C"));
// Read object temperature
_objectTemp = _mlx90632->getObjectTemperature();
WS_PRINTER.print(F("Object Temperature: "));
if (isnan(_objectTemp)) {
WS_PRINTER.println(F("NaN (invalid cycle position)"));
} else {
WS_PRINTER.print(_objectTemp, 4);
WS_PRINTER.println(F(" °C"));
}
result=true;
// Reset new data flag after reading
if (!_mlx90632->resetNewData()) {
WS_PRINTER.println(F("Failed to reset new data flag"));
}
WS_PRINTER.println(); // Add blank line between readings
} else {
WS_PRINTER.println(F("No new data available, skipping read"));
}
// Check if we need to trigger a new measurement for step modes
mlx90632_mode_t currentMode = _mlx90632->getMode();
if (currentMode == MLX90632_MODE_STEP || currentMode == MLX90632_MODE_SLEEPING_STEP) {
// Trigger single measurement (SOC bit) for step modes
if (!_mlx90632->startSingleMeasurement()) {
WS_PRINTER.println(F("Failed to start single measurement"));
}
}
_lastRead = millis();
return result;
}
/*******************************************************************************/
/*!
@brief Gets the MLX90632's current temperature.
@param tempEvent
Pointer to an Adafruit_Sensor event.
@returns True if the temperature was obtained successfully, False
otherwise.
*/
/*******************************************************************************/
bool getEventAmbientTemp(sensors_event_t *tempEvent) {
if (ReadSensorData() && _deviceTemp != NAN) {
//TODO: check max/min or error values in datasheet
// if (_deviceTemp < -40 || _deviceTemp > 125) {
// WS_PRINTER.println(F("Invalid ambient temperature"));
// return false;
// }
// if the sensor was read recently, return the cached temperature
tempEvent->temperature = _deviceTemp;
return true;
}
return false; // sensor not read recently, return false
}
/*******************************************************************************/
/*!
@brief Gets the MLX90632's object temperature.
@param tempEvent
Pointer to an Adafruit_Sensor event.
@returns True if the temperature was obtained successfully, False
otherwise.
*/
/*******************************************************************************/
bool getEventObjectTemp(sensors_event_t *tempEvent) {
if (ReadSensorData() && _objectTemp != NAN) {
// if the sensor was read recently, return the cached temperature
tempEvent->temperature = _objectTemp;
return true;
}
return false; // sensor not read recently, return false
}
protected:
double _deviceTemp; ///< Device temperature in Celsius
double _objectTemp; ///< Object temperature in Celsius
uint32_t _lastRead; ///< Last time the sensor was read in milliseconds
Adafruit_MLX90632 *_mlx90632 = nullptr; ///< MLX90632 object
};
#endif // WipperSnapper_I2C_Driver_MLX90632