added readme

README.md

@@ -0,0 +1,61 @@
+# thermi2C - a thermal camera app for the jolla 1 phone
+
+This is an app used to interface a cheap melexis MLX90640 thermal camera (~35€ for the sensor) with a Jolla 1 phone, using the phone's built-in I2C bus.
+
+Note that the app is closer to a tech demo than a full thermal camera driver app, it can't do temperature readings just yet, or pictures, all you get is a direct view of the thermal sensor at ~11fps (due to I2C bus speed limitations on this phone). But at least you get quite a few themes for color :\)
+
+## screenshots
+
+### regular mode
+
+Sometimes the checkerboard pattern that is created due to interlacing doesn't go away, this is me waving at the camera:   
+<img src="./images/therm.png" alt= “” width="300" height="value">
+
+### demo mode
+The app also has a demo mode for when the sensor fails/ isn't connected, it'll display perlin noise on the UI where the thermal view should be.
+theme hotiron            |  theme gray
+:-------------------------:|:-------------------------:
+![alt text](./images/demo.png "Title")  |  ![alt text](./images/demo_gray.png "Title")
+
+**note:** __leaving the noise generation on can cause issues with the normal mode of operation (flashing), so this line needs to be commented for the demo mode to be available:__
+
+```c++
+#include <stdint.h>
+
+#define IGNORE_I2C_DISCONNECTS  //comment out this line to enable noise generation / demo mode
+
+class MLX90640 : public QObject
+```
+Found in `mlx90640_API.h` line 92
+
+## credits
+
+This app uses code from these other repos:   
+https://github.com/kimmoli/i2ctool   
+(used for some of the I2C code, but largely reworked to maximize byte capacity and speed)   
+https://github.com/melexis/mlx90640-library   
+(used for most of the thermal sensor logic, also modified and objectified [C -> C++])
+
+## hardware
+You'll need a jolla 1 phone (2014)   
+The 5V and INT pins on the phone are unused, here's the wiring:   
+![alt text](./images/setup.jpg "hardware")
+   
+(N means unused here, i didn't bother to mark the 5V pin). I used some nickel strips to contact witht he pogo pins, this works quite well, a soldering iron can be used to melt the pins into their proper position.    
+Some parts of the case are open, if you don't like this you can edit the fusion 360 project i dropped in ./stl/ and make your own.   
+
+i usually get my sensors from there (MLX90640ESF-BAA):   
+https://fr.aliexpress.com/item/1005004645739586.html
+
+## Compiling the app
+
+As for the SDK setup, you'll need the sailfish SDK (latest), **and this is important**: ***with*** version 3.4.0 OS target, which is the latest one the jolla 1 phone supports (or you can use your phone's current version if you don't want to update to 3.4).
+
+ the sdk here: https://docs.sailfishos.org/Tools/Sailfish_SDK/
+
+ for debugging i highly recommend this, to at least check that the camera IS connected and responding:
+ https://github.com/kimmoli/i2ctool   
+ Probe with it, address 33 should light up green. If it doesn't either you wired it wrong or your camera's dead.   
+ this app can also be installed directly from the jolla store, easier to get working imo.   
+
+ Happy hacking!

src/colorattributer.h

@@ -14,8 +14,8 @@ protected:
     QString myName;
 public:
     float minValue, maxValue;
-    //ColorAttributer(QString name, const float& minValue = -3000000.0f, const float& maxValue = -1000000.0f) : minValue(minValue), maxValue(maxValue), myName(name) {}
-    ColorAttributer(QString name, const float& minValue = 0.0f, const float& maxValue = 1.0f) : minValue(minValue), maxValue(maxValue), myName(name) {}
+    ColorAttributer(QString name, const float& minValue = -3000000.0f, const float& maxValue = -1000000.0f) : minValue(minValue), maxValue(maxValue), myName(name) {}
+    //ColorAttributer(QString name, const float& minValue = 0.0f, const float& maxValue = 1.0f) : minValue(minValue), maxValue(maxValue), myName(name) {}
     Q_INVOKABLE inline QString getName() const {return myName;}
     Q_INVOKABLE void addColor(const float& value, const QColor& color);
     Q_INVOKABLE QColor encode(const float& value);

src/src/MLX90640_API.h

@@ -89,6 +89,8 @@
 
 #include <stdint.h>
 
+#define IGNORE_I2C_DISCONNECTS  //comment out this line to enable noise generation / demo mode
+
 class MLX90640 : public QObject
 {
     Q_OBJECT
@@ -186,23 +188,31 @@ public:
             fprintf(stderr, "dump EEprom...\n");
             status = mlx90640_DumpEE (slaveAddress, eeMLX90640);
             usleep(1000);
+#ifndef IGNORE_I2C_DISCONNECTS
             if(status != 0){
                 perlin.fillWithPerlinNoise(imageVect, 32, 24, 1234567);
                 emit initializedChanged();
                 emit dataReady(imageVect);
                 return;
             }
+#endif
             fprintf(stderr, "extract parameters...\n");
             status = mlx90640_ExtractParameters(eeMLX90640, &mlx90640);
             usleep(1000);
+            #ifndef IGNORE_I2C_DISCONNECTS
             if(status == 0)
                 getData();
             else{
                 perlin.fillWithPerlinNoise(imageVect, 32, 24, 1234567);
                 emit dataReady(imageVect);
             }
+            #else
+            getData();
+            #endif
         }catch(...){
+            #ifndef IGNORE_I2C_DISCONNECTS
             perlin.fillWithPerlinNoise(imageVect, 32, 24, 1234567);
+            #endif
         }
 
         emit initializedChanged();
@@ -226,7 +236,9 @@ public:
                 imageVect[i] = mlx90640Image[i];
             }
         } else {
+            #ifndef IGNORE_I2C_DISCONNECTS
             perlin.fillWithPerlinNoise(imageVect, 32, 24, 1234567);
+            #endif
         }
 
         emit dataReady(imageVect);

src/thermi2c.pro.user

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE QtCreatorProject>
-<!-- Written by QtCreator 4.15.2, 2023-06-12T18:21:29. -->
+<!-- Written by QtCreator 4.15.2, 2023-06-14T18:37:02. -->
 <qtcreator>
  <data>
   <variable>EnvironmentId</variable>