pdf-icon

Arduino Quick Start

2. Devices & Examples

6. Applications

Hat Thermal Arduino Tutorial

1. Preparation

2. Notes

Pin compatibility
Because each host has different pin assignments, please check the product document's pin compatibility table before use and adjust the example code according to your actual wiring.

3. Example program

  • This tutorial uses StickS3 as the main controller together with the Hat Thermal module. The thermal imaging module communicates via I2C; modify the pin definitions in the example according to your wiring. When stacked onto the host, the corresponding I2C pins are G0 (SCL) and G8 (SDA).
cpp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
#include "M5Unified.h"
#include "Wire.h"
#include "Arduino.h"
#include "MLX90640_API.h"
#include "MLX90640_I2C_Driver.h"
#include "M5PM1.h"

M5PM1 pm1;

M5Canvas img(&M5.Lcd);// Sprite for thermal imaging display (main visual)
M5Canvas msg(&M5.Lcd);// Sprite for temperature info panel (side data)

#define TA_SHIFT         8             // Temperature compensation shift for ambient temperature (calibration parameter)
#define COLS             32            // MLX90640 native horizontal resolution (32 pixels)
#define ROWS             24            // MLX90640 native vertical resolution (24 pixels)
#define COLS_5           ((COLS - 1) * 5)    // 5x horizontal interpolation resolution (155 pixels)
#define ROWS_5           ((ROWS - 1) * 5 + 1)// 5x vertical interpolation resolution (120 pixels)
#define pixelsArraySize  (COLS * ROWS) // Total native pixels (32*24=768)

// Temperature pixel data arrays
float pixels[COLS * ROWS];        // Corrected & horizontally flipped temperature data (for display)
float reversePixels[COLS * ROWS]; // Raw temperature data from MLX90640 (unflipped)
float pixels_5[COLS_5 * ROWS_5];  // 5x interpolated temperature data (for high-res display)

#define get_pixels(x, y)   (pixels[y * COLS + x])         // Convert (x,y) 2D coordinates to 1D index for native resolution array
#define get_pixels_5(x, y) (pixels_5[(y)*5 * COLS_5 + x]) // Convert (x,y) 2D coordinates to 1D index for 5x interpolated array

byte speed_setting = 2;             // MLX90640 frame read loop count (affects refresh rate/FPS)
const byte MLX90640_address = 0x33; // MLX90640 default I2C slave address (7-bit)
paramsMLX90640 mlx90640;            // MLX90640 device parameter structure (calibration data from EEPROM)

// Temperature range configuration for display mapping
float mintemp = 24;                 // User-adjustable MIN display temperature (°C)
float maxtemp = 35;                 // User-adjustable MAX display temperature (°C)
float min_v   = 24;                 // Real-time detected MIN temperature from pixel data (°C)
float max_v   = 35;                 // Real-time detected MAX temperature from pixel data (°C)

// ======== 256-Color Thermal Palette (RGB565 Format) ========
const uint16_t camColors[] = {
    0x480F, 0x400F, 0x400F, 0x400F, 0x4010, 0x3810, 0x3810, 0x3810, 0x3810,
    0x3010, 0x3010, 0x3010, 0x2810, 0x2810, 0x2810, 0x2810, 0x2010, 0x2010,
    0x2010, 0x1810, 0x1810, 0x1811, 0x1811, 0x1011, 0x1011, 0x1011, 0x0811,
    0x0811, 0x0811, 0x0011, 0x0011, 0x0011, 0x0011, 0x0011, 0x0031, 0x0031,
    0x0051, 0x0072, 0x0072, 0x0092, 0x00B2, 0x00B2, 0x00D2, 0x00F2, 0x00F2,
    0x0112, 0x0132, 0x0152, 0x0152, 0x0172, 0x0192, 0x0192, 0x01B2, 0x01D2,
    0x01F3, 0x01F3, 0x0213, 0x0233, 0x0253, 0x0253, 0x0273, 0x0293, 0x02B3,
    0x02D3, 0x02D3, 0x02F3, 0x0313, 0x0333, 0x0333, 0x0353, 0x0373, 0x0394,
    0x03B4, 0x03D4, 0x03D4, 0x03F4, 0x0414, 0x0434, 0x0454, 0x0474, 0x0474,
    0x0494, 0x04B4, 0x04D4, 0x04F4, 0x0514, 0x0534, 0x0534, 0x0554, 0x0554,
    0x0574, 0x0574, 0x0573, 0x0573, 0x0573, 0x0572, 0x0572, 0x0572, 0x0571,
    0x0591, 0x0591, 0x0590, 0x0590, 0x058F, 0x058F, 0x058F, 0x058E, 0x05AE,
    0x05AE, 0x05AD, 0x05AD, 0x05AD, 0x05AC, 0x05AC, 0x05AB, 0x05CB, 0x05CB,
    0x05CA, 0x05CA, 0x05CA, 0x05C9, 0x05C9, 0x05C8, 0x05E8, 0x05E8, 0x05E7,
    0x05E7, 0x05E6, 0x05E6, 0x05E6, 0x05E5, 0x05E5, 0x0604, 0x0604, 0x0604,
    0x0603, 0x0603, 0x0602, 0x0602, 0x0601, 0x0621, 0x0621, 0x0620, 0x0620,
    0x0620, 0x0620, 0x0E20, 0x0E20, 0x0E40, 0x1640, 0x1640, 0x1E40, 0x1E40,
    0x2640, 0x2640, 0x2E40, 0x2E60, 0x3660, 0x3660, 0x3E60, 0x3E60, 0x3E60,
    0x4660, 0x4660, 0x4E60, 0x4E80, 0x5680, 0x5680, 0x5E80, 0x5E80, 0x6680,
    0x6680, 0x6E80, 0x6EA0, 0x76A0, 0x76A0, 0x7EA0, 0x7EA0, 0x86A0, 0x86A0,
    0x8EA0, 0x8EC0, 0x96C0, 0x96C0, 0x9EC0, 0x9EC0, 0xA6C0, 0xAEC0, 0xAEC0,
    0xB6E0, 0xB6E0, 0xBEE0, 0xBEE0, 0xC6E0, 0xC6E0, 0xCEE0, 0xCEE0, 0xD6E0,
    0xD700, 0xDF00, 0xDEE0, 0xDEC0, 0xDEA0, 0xDE80, 0xDE80, 0xE660, 0xE640,
    0xE620, 0xE600, 0xE5E0, 0xE5C0, 0xE5A0, 0xE580, 0xE560, 0xE540, 0xE520,
    0xE500, 0xE4E0, 0xE4C0, 0xE4A0, 0xE480, 0xE460, 0xEC40, 0xEC20, 0xEC00,
    0xEBE0, 0xEBC0, 0xEBA0, 0xEB80, 0xEB60, 0xEB40, 0xEB20, 0xEB00, 0xEAE0,
    0xEAC0, 0xEAA0, 0xEA80, 0xEA60, 0xEA40, 0xF220, 0xF200, 0xF1E0, 0xF1C0,
    0xF1A0, 0xF180, 0xF160, 0xF140, 0xF100, 0xF0E0, 0xF0C0, 0xF0A0, 0xF080,
    0xF060, 0xF040, 0xF020, 0xF800,
};

// Function prototype: Get temperature value from 1D pixel array with 2D coordinates
// Parameters: p = pixel array pointer, rows/cols = array resolution, x/y = target 2D coordinates
// Return: Temperature value at (x,y) (°C)
float get_point(float *p, uint8_t rows, uint8_t cols, int16_t x, int16_t y);

// Performance monitoring variables (for FPS calculation)
long loopTime, startTime, endTime, fps;

// ======== 5x Interpolation Function: 32x24 → 155x121 ========
// Scale native MLX90640 resolution (32x24) to 5x high resolution via linear interpolation
// Process: Horizontal interpolation first → Vertical interpolation second (smoother scaling)
void cover5() {
    uint8_t x, y;
    uint16_t pos      = 0;
    float x_step      = 0.0;
    float y_step      = 0.0;
    float pixel_value = 0.0;
    float max_step    = 0;

    for (y = 0; y < ROWS; y++) {
        for (x = 0; x < COLS - 1; x++) {
            pixel_value       = get_pixels(x, y);
            x_step            = (get_pixels(x + 1, y) - pixel_value) / 5.0;
            pos               = 5 * x + COLS_5 * (y * 5);
            pixels_5[pos]     = pixel_value + x_step;
            pixels_5[pos + 1] = pixels_5[pos] + x_step;
            pixels_5[pos + 2] = pixels_5[pos + 1] + x_step;
            pixels_5[pos + 3] = pixels_5[pos + 2] + x_step;
            pixels_5[pos + 4] = pixels_5[pos + 3] + x_step;
        }
    }

    for (y = 0; y < ROWS - 1; y++) {
        for (x = 0; x < COLS_5; x++) {
            pixel_value = get_pixels_5(x, y);
            y_step      = (get_pixels_5(x, y + 1) - pixel_value) / 5.0;
            pixels_5[(5 * y + 1) * COLS_5 + x] = pixel_value + y_step;
            pixels_5[(5 * y + 2) * COLS_5 + x] = pixel_value + 2 * y_step;
            pixels_5[(5 * y + 3) * COLS_5 + x] = pixel_value + 3 * y_step;
            pixels_5[(5 * y + 4) * COLS_5 + x] = pixel_value + 4 * y_step;
            pixels_5[(5 * y + 5) * COLS_5 + x] = pixel_value + 5 * y_step;
        }
    }
}

// ======== Thermal Image Drawing Function ========
void drawpixels(float *p, uint8_t rows, uint8_t cols) {
    int colorTemp;
    Serial.printf("%f, %f\r\n", mintemp, maxtemp);

    for (int y = 0; y < rows; y++) {
        for (int x = 0; x < cols; x++) {
            float val = get_point(p, rows, cols, x, y);

            if (val >= maxtemp) {
                colorTemp = maxtemp;
            } else if (val <= mintemp) {
                colorTemp = mintemp;
            } else {
                colorTemp = val;
            }

            uint8_t colorIndex = map(colorTemp, mintemp, maxtemp, 0, 255);
            colorIndex         = constrain(colorIndex, 0, 255);  // 0 ~ 255
            // draw the pixels!
            img.drawPixel(x, y, camColors[colorIndex]);
        }
    }

    img.drawCircle(COLS_5 / 2, ROWS_5 / 2, 5, TFT_WHITE);  // update center spot icon
    img.drawLine(COLS_5 / 2 - 8, ROWS_5 / 2, COLS_5 / 2 + 8, ROWS_5 / 2, TFT_WHITE);  // vertical line
    img.drawLine(COLS_5 / 2, ROWS_5 / 2 - 8, COLS_5 / 2, ROWS_5 / 2 + 8, TFT_WHITE);  // horizontal line
    img.setCursor(COLS_5 / 2 + 6, ROWS_5 / 2 - 12);
    img.setTextColor(TFT_WHITE);
    img.printf("%.2fC", get_point(p, rows, cols, cols / 2, rows / 2));
    img.pushSprite(0, 0);

    msg.fillScreen(TFT_BLACK);
    msg.setTextColor(TFT_YELLOW);
    msg.setCursor(10, 0);
    msg.print("min tmp");
    msg.setCursor(15, 15);
    msg.printf("%.2fC", min_v);
    msg.setCursor(10, 35);
    msg.print("max tmp");
    msg.setCursor(15, 50);
    msg.printf("%.2fC", max_v);

    msg.pushSprite(COLS_5+10, 10);
}

void setup() {
  M5.begin();

  // ---------- M5PM1(Wire1) ----------
  auto pm_sda = M5.getPin(m5::pin_name_t::in_i2c_sda);
  auto pm_scl = M5.getPin(m5::pin_name_t::in_i2c_scl);
  Wire1.begin(pm_sda, pm_scl, 100000);
  pm1.begin(&Wire1, M5PM1_DEFAULT_ADDR, pm_sda, pm_scl, M5PM1_I2C_FREQ_100K);
  pm1.setDcdcEnable(true);// Enable 3V3 for Hat Thermal

  // ---------- Hat Thermal(Wire) ----------
  Wire.begin(8, 0, 400000);   // SDA=8, SCL=0

  M5.Lcd.setRotation(1);
  img.createSprite(COLS_5, ROWS_5);
  msg.createSprite(240 - COLS_5, ROWS_5 - 10);

  // Get device parameters - We only have to do this once
    int status;
    uint16_t eeMLX90640[832];  // 32 * 24 = 768

    status = MLX90640_DumpEE(MLX90640_address, eeMLX90640);
    if (status != 0) Serial.println("Failed to load system parameters");

    status = MLX90640_ExtractParameters(eeMLX90640, &mlx90640);
    if (status != 0) Serial.println("Parameter extraction failed");

    // Setting MLX90640 device at slave address 0x33 to work with 16Hz refresh
    MLX90640_SetRefreshRate(0x33, 0x05);

    MLX90640_SetResolution(0x33, 0x03);

    // Display bottom side colorList and info
    M5.Lcd.fillScreen(TFT_BLACK);

    for (int icol = 0; icol <= 127; icol++) {
        M5.Lcd.drawRect(icol * 2, 127, 2, 12, camColors[icol * 2]);
    }
}

void loop() {
    loopTime  = millis();
    startTime = loopTime;

    M5.update();

    // Reset settings
    if (M5.BtnA.pressedFor(1000)) {
        mintemp = min_v - 1;
        maxtemp = max_v + 1;
    }

    // Set Min Value
    if (M5.BtnA.wasPressed()) {
        if (mintemp <= 0) {
            mintemp = maxtemp - 1;
        } else {
            mintemp--;
        }
    }
    // Set Max Value
    if (M5.BtnB.wasPressed()) {
        maxtemp = maxtemp + 1;
    }

    uint16_t mlx90640Frame[834];

    // those fun get tmp array, 32*24, 5fps
    for (byte x = 0; x < speed_setting; x++) {
        int status = MLX90640_GetFrameData(MLX90640_address, mlx90640Frame);
        if (status < 0) {
            Serial.print("GetFrame Error: ");
            Serial.println(status);
        }

        float vdd = MLX90640_GetVdd(mlx90640Frame, &mlx90640);
        float Ta  = MLX90640_GetTa(mlx90640Frame, &mlx90640);
        float tr  = Ta - TA_SHIFT;  // Reflected temperature based on the sensor
                                    // ambient temperature
        float emissivity = 0.95;
        MLX90640_CalculateTo(mlx90640Frame, &mlx90640, emissivity, tr, reversePixels);  // save pixels temp to array (pixels)
        int mode = MLX90640_GetCurMode(MLX90640_address);
        MLX90640_BadPixelsCorrection(mlx90640.brokenPixels, reversePixels, mode, &mlx90640);
    }

    // Reverse image (order of Integer array)
    for (int x = 0; x < pixelsArraySize; x++) {
        if (x % COLS == 0) {
            for (int j = 0 + x, k = (COLS - 1) + x; j < COLS + x; j++, k--) {
                pixels[j] = reversePixels[k];
            }
        }
    }

    max_v = mintemp;
    min_v = maxtemp;

    for (int itemp = 0; itemp < sizeof(pixels) / sizeof(pixels[0]); itemp++) {
        if (pixels[itemp] > max_v) {
            max_v = pixels[itemp];
        }
        if (pixels[itemp] < min_v) {
            min_v = pixels[itemp];
        }
    }

    // cover pixels to pixels_5
    cover5();

    // show tmp image
    drawpixels(pixels_5, ROWS_5, COLS_5);

    loopTime = millis();
    endTime  = loopTime;
    fps      = 1000 / (endTime - startTime);
}

4. Thermal imaging effect

  • After power-on, the screen displays the thermal image. The left area shows the thermal map and the right area displays the currently detected maximum and minimum temperatures. Use BtnA and BtnB to adjust the temperature mapping range; long-press BtnA to reset the range to min/max expanded by 1°C from the current detected values.
On This Page