docs: update changelog and header for version v1.4.12

Introducing enum for handling the NFC state to improve code readability

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [1.4.12] - 2025-03-30
+### Added
+- add touch sensor connection check and update logic
+
+### Changed
+- update platformio.ini for version v1.4.12
+- update README files to clarify PN532 DIP switch settings
+
+
+## [1.4.11] - 2025-03-30
+### Added
+- Renamed states of NFC state machine and introduced new state machine for spoolman API
+
+### Changed
+- update platformio.ini for version v1.4.11
+- Merge branch 'main' of github.com:ManuelW77/Filaman
+- Merge pull request #31 from janecker/nfc_rework
+- Introducing enum for handling the NFC state to improve code readability
+
+
 ## [1.4.10] - 2025-03-30
 ### Added
 - add manual tare functionality for scale

README.de.md

@@ -82,7 +82,7 @@ Discord Server: [https://discord.gg/my7Gvaxj2v](https://discord.gg/my7Gvaxj2v)
 | PN532 SCL         | 22        |
 | TTP223 I/O        | 25        |
 
-**!! Achte darauf, dass am PN532 die DIP-Schalter auf I2C gestellt sind**
+**!! Achte darauf, dass am PN532 die DIP-Schalter auf I2C gestellt sind**  
 **Nutze den 3V Pin vom ESP für den Touch Sensor**
 
 ![Wiring](./img/Schaltplan.png)

README.md

@@ -86,7 +86,7 @@ Discord Server: [https://discord.gg/my7Gvaxj2v](https://discord.gg/my7Gvaxj2v)
 | PN532 SCL         | 22        |
 | TTP223 I/O        | 25        |
 
-**!! Make sure that the DIP switches on the PN532 are set to I2C**
+**!! Make sure that the DIP switches on the PN532 are set to I2C**  
 **Use the 3V pin from the ESP for the touch sensor**
 
 ![Wiring](./img/Schaltplan.png)

platformio.ini

@@ -9,7 +9,7 @@
 ; https://docs.platformio.org/page/projectconf.html
 
 [common]
-version = "1.4.10"
+version = "1.4.12"
 to_old_version = "1.4.0"
 
 ##

src/api.cpp

@@ -3,7 +3,8 @@
 #include <ArduinoJson.h>
 #include "commonFS.h"
 
-bool spoolman_connected = false;
+volatile spoolmanApiStateType spoolmanApiState = API_INIT;
+//bool spoolman_connected = false;
 String spoolmanUrl = "";
 bool octoEnabled = false;
 String octoUrl = "";
@@ -85,6 +86,7 @@ JsonDocument fetchSingleSpoolInfo(int spoolId) {
 }
 
 void sendToApi(void *parameter) {
+    spoolmanApiState = API_TRANSMITTING;
     SendToApiParams* params = (SendToApiParams*)parameter;
 
     // Extrahiere die Werte
@@ -119,6 +121,7 @@ void sendToApi(void *parameter) {
     // Speicher freigeben
     delete params;
     vTaskDelete(NULL);
+    spoolmanApiState = API_IDLE;
 }
 
 bool updateSpoolTagId(String uidString, const char* payload) {
@@ -479,7 +482,8 @@ bool checkSpoolmanInstance(const String& url) {
                     return false;
                 }
 
-                spoolman_connected = true;
+                spoolmanApiState = API_IDLE;
+                oledShowTopRow();
                 return strcmp(status, "healthy") == 0;
             }
         }

src/api.h

@@ -6,7 +6,13 @@
 #include "website.h"
 #include "display.h"
 #include <ArduinoJson.h>
+typedef enum {
+    API_INIT,
+    API_IDLE,
+    API_TRANSMITTING
+} spoolmanApiStateType;
 
+extern volatile spoolmanApiStateType spoolmanApiState;
 extern bool spoolman_connected;
 extern String spoolmanUrl;
 extern bool octoEnabled;

src/display.cpp

@@ -177,7 +177,7 @@ void oledShowTopRow() {
         display.drawBitmap(50, 0, bitmap_off , 16, 16, WHITE);
     }
 
-    if (spoolman_connected == 1) {
+    if (spoolmanApiState != API_INIT) {
         display.drawBitmap(80, 0, bitmap_spoolman_on , 16, 16, WHITE);
     } else {
         display.drawBitmap(80, 0, bitmap_off , 16, 16, WHITE);

src/main.cpp

@@ -15,6 +15,7 @@
 
 bool mainTaskWasPaused = 0;
 uint8_t scaleTareCounter = 0;
+bool touchSensorConnected = false;
 
 // ##### SETUP #####
 void setup() {
@@ -59,6 +60,16 @@ void setup() {
 
   // Touch Sensor
   pinMode(TTP223_PIN, INPUT_PULLUP);
+  if (digitalRead(TTP223_PIN) == HIGH) 
+  {
+    Serial.println("Touch Sensor is not connected");
+    touchSensorConnected = false;
+  } 
+  else 
+  {
+    Serial.println("Touch Sensor is connected");
+    touchSensorConnected
+  }
 }
 
 
@@ -100,7 +111,7 @@ void loop() {
   unsigned long currentMillis = millis();
 
   // Überprüfe den Status des Touch Sensors
-  if (digitalRead(TTP223_PIN) == HIGH && currentMillis - lastButtonPress > debounceDelay) 
+  if (touchSensorConnected && digitalRead(TTP223_PIN) == HIGH && currentMillis - lastButtonPress > debounceDelay) 
   {
     lastButtonPress = currentMillis;
     scaleTareRequest = true;
@@ -122,7 +133,7 @@ void loop() {
 
     if (intervalElapsed(currentMillis, lastAutoSetBambuAmsTime, autoSetBambuAmsInterval)) 
     {
-      if (hasReadRfidTag == 0)
+      if (nfcReaderState == NFC_IDLE)
       {
         lastAutoSetBambuAmsTime = currentMillis;
         oledShowMessage("Auto Set         " + String(autoSetBambuAmsCounter - autoAmsCounter) + "s");
@@ -156,7 +167,7 @@ void loop() {
   // Ausgabe der Waage auf Display
   if(pauseMainTask == 0)
   {
-    if (mainTaskWasPaused || (weight != lastWeight && hasReadRfidTag == 0 && (!autoSendToBambu || autoSetToBambuSpoolId == 0)))
+    if (mainTaskWasPaused || (weight != lastWeight && nfcReaderState == NFC_IDLE && (!autoSendToBambu || autoSetToBambuSpoolId == 0)))
     {
       (weight < 2) ? ((weight < -2) ? oledShowMessage("!! -0") : oledShowWeight(0)) : oledShowWeight(weight);
     }
@@ -169,7 +180,7 @@ void loop() {
 
 
   // Wenn Timer abgelaufen und nicht gerade ein RFID-Tag geschrieben wird
-  if (currentMillis - lastWeightReadTime >= weightReadInterval && hasReadRfidTag < 3)
+  if (currentMillis - lastWeightReadTime >= weightReadInterval && nfcReaderState < NFC_WRITING)
   {
     lastWeightReadTime = currentMillis;
 
@@ -186,7 +197,8 @@ void loop() {
   }
 
   // reset weight counter after writing tag
-  if (currentMillis - lastWeightReadTime >= weightReadInterval && hasReadRfidTag > 1)
+  // TBD: what exactly is the logic behind this?
+  if (currentMillis - lastWeightReadTime >= weightReadInterval && nfcReaderState != NFC_IDLE && nfcReaderState != NFC_READ_SUCCESS)
   {
     weigthCouterToApi = 0;
   }
@@ -194,7 +206,7 @@ void loop() {
   lastWeight = weight;
 
   // Wenn ein Tag mit SM id erkannte wurde und der Waage Counter anspricht an SM Senden
-  if (spoolId != "" && weigthCouterToApi > 3 && weightSend == 0 && hasReadRfidTag == 1) {
+  if (spoolId != "" && weigthCouterToApi > 3 && weightSend == 0 && nfcReaderState == NFC_READ_SUCCESS) {
     oledShowIcon("loading");
     if (updateSpoolWeight(spoolId, weight)) 
     {

src/nfc.cpp

@@ -18,7 +18,7 @@ String spoolId = "";
 String nfcJsonData = "";
 volatile bool pauseBambuMqttTask = false;
 
-volatile uint8_t hasReadRfidTag = 0;
+volatile nfcReaderStateType nfcReaderState = NFC_IDLE;
 // 0 = nicht gelesen
 // 1 = erfolgreich gelesen
 // 2 = fehler beim Lesen
@@ -242,7 +242,7 @@ void writeJsonToTag(void *parameter) {
   Serial.println("Erstelle NDEF-Message...");
   Serial.println(payload);
 
-  hasReadRfidTag = 3;
+  nfcReaderState = NFC_WRITING;
   vTaskSuspend(RfidReaderTask);
   vTaskDelay(50 / portTICK_PERIOD_MS);
 
@@ -288,7 +288,7 @@ void writeJsonToTag(void *parameter) {
         //oledShowMessage("NFC-Tag written");
         oledShowIcon("success");
         vTaskDelay(1000 / portTICK_PERIOD_MS);
-        hasReadRfidTag = 5;
+        nfcReaderState = NFC_WRITE_SUCCESS;
         // aktualisieren der Website wenn sich der Status ändert
         sendNfcData(nullptr);
         pauseBambuMqttTask = false;
@@ -310,7 +310,7 @@ void writeJsonToTag(void *parameter) {
         Serial.println("Fehler beim Schreiben der NDEF-Message auf den Tag");
         oledShowIcon("failed");
         vTaskDelay(2000 / portTICK_PERIOD_MS);
-        hasReadRfidTag = 4;
+        nfcReaderState = NFC_WRITE_ERROR;
     }
   }
   else
@@ -318,7 +318,7 @@ void writeJsonToTag(void *parameter) {
     Serial.println("Fehler: Kein Tag zu schreiben gefunden.");
     oledShowMessage("No NFC-Tag found");
     vTaskDelay(2000 / portTICK_PERIOD_MS);
-    hasReadRfidTag = 0;
+    nfcReaderState = NFC_IDLE;
   }
   
   sendWriteResult(nullptr, success);
@@ -334,7 +334,7 @@ void startWriteJsonToTag(const char* payload) {
   char* payloadCopy = strdup(payload);
   
   // Task nicht mehrfach starten
-  if (hasReadRfidTag != 3) {
+  if (nfcReaderState != NFC_WRITING) {
     // Erstelle die Task
     xTaskCreate(
         writeJsonToTag,        // Task-Funktion
@@ -351,7 +351,7 @@ void scanRfidTask(void * parameter) {
   Serial.println("RFID Task gestartet");
   for(;;) {
     // Wenn geschrieben wird Schleife aussetzen
-    if (hasReadRfidTag != 3)
+    if (nfcReaderState != NFC_WRITING)
     {
       yield();
 
@@ -363,12 +363,12 @@ void scanRfidTask(void * parameter) {
 
       foundNfcTag(nullptr, success);
       
-      if (success && hasReadRfidTag != 1)
+      if (success && nfcReaderState != NFC_READ_SUCCESS)
       {
         // Display some basic information about the card
         Serial.println("Found an ISO14443A card");
 
-        hasReadRfidTag = 6;
+        nfcReaderState = NFC_READING;
 
         oledShowIcon("transfer");
         vTaskDelay(500 / portTICK_PERIOD_MS);
@@ -406,11 +406,11 @@ void scanRfidTask(void * parameter) {
             {
               oledShowMessage("NFC-Tag unknown");
               vTaskDelay(2000 / portTICK_PERIOD_MS);
-              hasReadRfidTag = 2;
+              nfcReaderState = NFC_READ_ERROR;
             }
             else 
             {
-              hasReadRfidTag = 1;
+              nfcReaderState = NFC_READ_SUCCESS;
             }
 
             free(data);
@@ -418,7 +418,7 @@ void scanRfidTask(void * parameter) {
           else
           {
             oledShowMessage("NFC-Tag read error");
-            hasReadRfidTag = 2;
+            nfcReaderState = NFC_READ_ERROR;
           }
         }
         else
@@ -427,9 +427,9 @@ void scanRfidTask(void * parameter) {
         }
       }
 
-      if (!success && hasReadRfidTag > 0)
+      if (!success && nfcReaderState != NFC_IDLE)
       {
-        hasReadRfidTag = 0;
+        nfcReaderState = NFC_IDLE;
         //uidString = "";
         nfcJsonData = "";
         Serial.println("Tag entfernt");

src/nfc.h

@@ -3,6 +3,16 @@
 
 #include <Arduino.h>
 
+typedef enum{
+    NFC_IDLE,
+    NFC_READING,
+    NFC_READ_SUCCESS,
+    NFC_READ_ERROR,
+    NFC_WRITING,
+    NFC_WRITE_SUCCESS,
+    NFC_WRITE_ERROR
+} nfcReaderStateType;
+
 void startNfc();
 void scanRfidTask(void * parameter);
 void startWriteJsonToTag(const char* payload);
@@ -10,7 +20,9 @@ void startWriteJsonToTag(const char* payload);
 extern TaskHandle_t RfidReaderTask;
 extern String nfcJsonData;
 extern String spoolId;
-extern volatile uint8_t hasReadRfidTag;
+extern volatile nfcReaderStateType nfcReaderState;
 extern volatile bool pauseBambuMqttTask;
 
+
+
 #endif

src/website.cpp

@@ -22,7 +22,7 @@ AsyncWebServer server(webserverPort);
 AsyncWebSocket ws("/ws");
 
 uint8_t lastSuccess = 0;
-uint8_t lastHasReadRfidTag = 0;
+nfcReaderStateType lastnfcReaderState = NFC_IDLE;
 
 
 void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventType type, void *arg, uint8_t *data, size_t len) {
@@ -44,13 +44,15 @@ void onWsEvent(AsyncWebSocket *server, AsyncWebSocketClient *client, AwsEventTyp
         JsonDocument doc;
         deserializeJson(doc, message);
 
+        bool spoolmanConnected = (spoolmanApiState != API_INIT);
+
         if (doc["type"] == "heartbeat") {
             // Sende Heartbeat-Antwort
             ws.text(client->id(), "{"
                 "\"type\":\"heartbeat\","
                 "\"freeHeap\":" + String(ESP.getFreeHeap()/1024) + ","
                 "\"bambu_connected\":" + String(bambu_connected) + ","
-                "\"spoolman_connected\":" + String(spoolman_connected) + ""
+                "\"spoolman_connected\":" + String(spoolmanConnected) + ""
                 "}");
         }
 
@@ -139,34 +141,31 @@ void foundNfcTag(AsyncWebSocketClient *client, uint8_t success) {
 }
 
 void sendNfcData(AsyncWebSocketClient *client) {
-    if (lastHasReadRfidTag == hasReadRfidTag) return;
-    if (hasReadRfidTag == 0) {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":{}}");
+    if (lastnfcReaderState == nfcReaderState) return;
+    // TBD: Why is there no status for reading the tag?
+    switch(nfcReaderState){
+        case NFC_IDLE:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":{}}");
+            break;
+        case NFC_READ_SUCCESS:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":" + nfcJsonData + "}");
+            break;
+        case NFC_READ_ERROR:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"error\":\"Empty Tag or Data not readable\"}}");
+            break;
+        case NFC_WRITING:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"info\":\"Schreibe Tag...\"}}");
+            break;
+        case NFC_WRITE_SUCCESS:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"info\":\"Tag erfolgreich geschrieben\"}}");
+            break;
+        case NFC_WRITE_ERROR:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"error\":\"Error writing to Tag\"}}");
+            break;
+        case DEFAULT:
+            ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"error\":\"Something went wrong\"}}");
     }
-    else if (hasReadRfidTag == 1) {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":" + nfcJsonData + "}");
-    }
-    else if (hasReadRfidTag == 2)
-    {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"error\":\"Empty Tag or Data not readable\"}}");
-    }
-    else if (hasReadRfidTag == 3)
-    {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"info\":\"Schreibe Tag...\"}}");
-    }
-    else if (hasReadRfidTag == 4)
-    {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"error\":\"Error writing to Tag\"}}");
-    }
-    else if (hasReadRfidTag == 5)
-    {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"info\":\"Tag erfolgreich geschrieben\"}}");
-    }
-    else 
-    {
-        ws.textAll("{\"type\":\"nfcData\", \"payload\":{\"error\":\"Something went wrong\"}}");
-    }
-    lastHasReadRfidTag = hasReadRfidTag;
+    lastnfcReaderState = nfcReaderState;
 }
 
 void sendAmsData(AsyncWebSocketClient *client) {