docs: update changelog and header for version v1.4.0

Improves NFC Tag handling

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## [1.4.0] - 2025-03-01
+### Added
+- add support for Spoolman Octoprint Plugin in README files
+- add OctoPrint integration with configurable fields and update functionality
+- add version comparison function and check for outdated versions before updates
+- remove unused version and protocol fields from JSON output; add error message for insufficient memory
+
+### Changed
+- update NFC tag references to include NTAG213 and clarify storage capacity
+- bump version to 1.4.0
+- remove unused version and protocol fields from NFC data packet
+- sort vendors alphabetically in the dropdown list
+- Merge pull request #10 from janecker/nfc-improvements
+- Improves NFC Tag handling
+
+
 ## [1.3.99] - 2025-02-28
 ### Changed
 - update platformio.ini for version v1.3.99

README.de.md

@@ -18,7 +18,7 @@ Deutsches Erklärvideo: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaO
 - **OLED-Display:** Zeigt aktuelles Gewicht, Verbindungsstatus (WiFi, Bambu Lab, Spoolman).
 - **WLAN-Konnektivität:** WiFiManager für einfache Netzwerkkonfiguration.
 - **MQTT-Integration:** Verbindet sich mit Bambu Lab Drucker für AMS-Steuerung.
-- **NFC-Tag NTAG215:** Verwendung von NTAG215 wegen ausreichendem Speicherplatz auf dem Tag
+- **NFC-Tag NTAG213 NTAG215:** Verwendung von NTAG213, besser NTAG215 wegen ausreichendem Speicherplatz auf dem Tag
 
 ### Weboberflächen-Funktionen
 - **Echtzeit-Updates:** WebSocket-Verbindung für Live-Daten-Updates.
@@ -35,6 +35,7 @@ Deutsches Erklärvideo: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaO
   - Filtern und Auswählen von Filamenten.
   - Automatische Aktualisierung der Spulengewichte.
   - Verfolgung von NFC-Tag-Zuweisungen.
+  - Unterstützt das Spoolman Octoprint Plugin
 
 ### Wenn Sie meine Arbeit unterstützen möchten, freue ich mich über einen Kaffee
 <a href="https://www.buymeacoffee.com/manuelw" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 30px !important;width: 108px !important;" ></a>
@@ -61,7 +62,7 @@ Deutsches Erklärvideo: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62zaO
 [Amazon Link](https://amzn.eu/d/0AuBp2c)
 - **PN532 NFC NXP RFID-Modul V3:** Für NFC-Tag-Operationen.
 [Amazon Link](https://amzn.eu/d/jfIuQXb)
-- **NFC Tags Ntag215:** RFID Tag
+- **NFC Tags NTAG213 NTA215:** RFID Tag
 [Amazon Link](https://amzn.eu/d/9Z6mXc1)
 
 ### Pin-Konfiguration

README.md

@@ -21,7 +21,7 @@ german explanatory video: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62z
 - **OLED Display:** Shows current weight, connection status (WiFi, Bambu Lab, Spoolman).
 - **WiFi Connectivity:** WiFiManager for easy network configuration.
 - **MQTT Integration:** Connects to Bambu Lab printer for AMS control.
-- **NFC-Tag NTAG215:** Use NTAG215 because of enaught space on the Tag
+- **NFC-Tag NTAG213 NTAG215:** Use NTAG213, better NTAG215 because of enaught space on the Tag
 
 ### Web Interface Features
 - **Real-time Updates:** WebSocket connection for live data updates.
@@ -38,6 +38,7 @@ german explanatory video: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62z
   - Filter and select filaments.
   - Update spool weights automatically.
   - Track NFC tag assignments.
+  - Supports Spoolman Octoprint Plugin
 
 ### If you want to support my work, i would be happy to get a coffe
 <a href="https://www.buymeacoffee.com/manuelw" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 30px !important;width: 108px !important;" ></a>
@@ -64,7 +65,7 @@ german explanatory video: [Youtube](https://youtu.be/uNDe2wh9SS8?si=b-jYx4I1w62z
 [Amazon Link](https://amzn.eu/d/0AuBp2c)
 - **PN532 NFC NXP RFID-Modul V3:** For NFC tag operations.
 [Amazon Link](https://amzn.eu/d/jfIuQXb)
-- **NFC Tags Ntag215:** RFID Tag
+- **NFC Tags NTAG213 NTAG215:** RFID Tag
 [Amazon Link](https://amzn.eu/d/9Z6mXc1)
 
 

html/rfid.js

@@ -640,8 +640,6 @@ function writeNfcTag() {
 
     // Erstelle das NFC-Datenpaket mit korrekten Datentypen
     const nfcData = {
-        version: "2.0",
-        protocol: "openspool",
         color_hex: selectedSpool.filament.color_hex || "FFFFFF",
         type: selectedSpool.filament.material,
         min_temp: minTemp,

html/spoolman.html

@@ -52,11 +52,18 @@
             if (spoolmanUrl && spoolmanUrl.trim() !== "") {
                 document.getElementById('spoolmanUrl').value = spoolmanUrl;
             }
+            
+            // Initialize OctoPrint fields visibility
+            toggleOctoFields();
         };
 
         function checkSpoolmanInstance() {
             const url = document.getElementById('spoolmanUrl').value;
-            fetch(`/api/checkSpoolman?url=${encodeURIComponent(url)}`)
+            const spoolmanOctoEnabled = document.getElementById('spoolmanOctoEnabled').checked;
+            const spoolmanOctoUrl = document.getElementById('spoolmanOctoUrl').value;
+            const spoolmanOctoToken = document.getElementById('spoolmanOctoToken').value;
+            
+            fetch(`/api/checkSpoolman?url=${encodeURIComponent(url)}&octoEnabled=${spoolmanOctoEnabled}&octoUrl=${spoolmanOctoUrl}&octoToken=${spoolmanOctoToken}`)
                 .then(response => response.json())
                 .then(data => {
                     if (data.healthy) {
@@ -90,6 +97,15 @@
                     document.getElementById('bambuStatusMessage').innerText = 'Error while saving: ' + error.message;
                 });
         }
+
+        /**
+         * Controls visibility of OctoPrint configuration fields based on checkbox state
+         * Called on page load and when checkbox changes
+         */
+        function toggleOctoFields() {
+            const octoEnabled = document.getElementById('spoolmanOctoEnabled').checked;
+            document.getElementById('octoFields').style.display = octoEnabled ? 'block' : 'none';
+        }
     </script>
     <script>
         var spoolmanUrl = "{{spoolmanUrl}}";
@@ -102,6 +118,17 @@
             <div class="card-body">
                 <h5 class="card-title">Set URL/IP to your Spoolman-Instanz</h5>
                 <input type="text" id="spoolmanUrl" placeholder="http://ip-or-url-of-your-spoolman-instanz:port">
+                <h5 class="card-title">If you want to enable sending Spool to Spoolman Octoprint Plugin:</h5>
+                <p>
+                    <input type="checkbox" id="spoolmanOctoEnabled" {{spoolmanOctoEnabled}} onchange="toggleOctoFields()"> Send to Octo-Plugin
+                </p>
+                <div id="octoFields" style="display: none;">
+                    <p>
+                        <input type="text" id="spoolmanOctoUrl" placeholder="http://ip-or-url-of-your-octoprint-instanz:port" value="{{spoolmanOctoUrl}}">
+                        <input type="text" id="spoolmanOctoToken" placeholder="Your Octoprint Token" value="{{spoolmanOctoToken}}">
+                    </p>
+                </div>
+                
                 <button onclick="checkSpoolmanInstance()">Save Spoolman URL</button>
                 <p id="statusMessage"></p>
             </div>

html/spoolman.js

@@ -97,13 +97,15 @@ function populateVendorDropdown(data, selectedSmId = null) {
         ? (weightInKg / 1000).toFixed(2) + " t" 
         : weightInKg.toFixed(2) + " kg";
 
-    // Dropdown mit gefilterten Herstellern befüllen
+    // Dropdown mit gefilterten Herstellern befüllen - alphabetisch sortiert
-    Object.entries(filteredVendors).forEach(([id, name]) => {
+    Object.entries(filteredVendors)
-        const option = document.createElement("option");
+        .sort(([, nameA], [, nameB]) => nameA.localeCompare(nameB)) // Sort vendors alphabetically by name
-        option.value = id;
+        .forEach(([id, name]) => {
-        option.textContent = name;
+            const option = document.createElement("option");
-        vendorSelect.appendChild(option);
+            option.value = id;
-    });
+            option.textContent = name;
+            vendorSelect.appendChild(option);
+        });
 
     document.getElementById("totalSpools").textContent = totalSpools;
     document.getElementById("spoolsWithoutTag").textContent = spoolsWithoutTag;

platformio.ini

@@ -9,7 +9,9 @@
 ; https://docs.platformio.org/page/projectconf.html
 
 [common]
-version = "1.3.99"
+version = "1.4.0"
+to_old_version = "1.4.0"
+
 ##
 [env:esp32dev]
 platform = espressif32
@@ -48,6 +50,7 @@ build_flags =
     #-DNDEBUG
     -mtext-section-literals
     -DVERSION=\"${common.version}\"
+    -DTOOLDVERSION=\"${common.to_old_version}\"
     -DASYNCWEBSERVER_REGEX
     #-DCORE_DEBUG_LEVEL=3
     -DCONFIG_ARDUHAL_LOG_COLORS=1

src/api.cpp

@@ -5,11 +5,15 @@
 
 bool spoolman_connected = false;
 String spoolmanUrl = "";
+bool octoEnabled = false;
+String octoUrl = "";
+String octoToken = "";
 
 struct SendToApiParams {
     String httpType;
     String spoolsUrl;
     String updatePayload;
+    String octoToken;
 };
 
 JsonDocument fetchSingleSpoolInfo(int spoolId) {
@@ -87,14 +91,16 @@ void sendToApi(void *parameter) {
     String httpType = params->httpType;
     String spoolsUrl = params->spoolsUrl;
     String updatePayload = params->updatePayload;
-    
+    String octoToken = params->octoToken;    
 
     HTTPClient http;
     http.begin(spoolsUrl);
     http.addHeader("Content-Type", "application/json");
+    if (octoEnabled && octoToken != "") http.addHeader("X-Api-Key", octoToken);
 
     int httpCode = http.PUT(updatePayload);
     if (httpType == "PATCH") httpCode = http.PATCH(updatePayload);
+    if (httpType == "POST") httpCode = http.POST(updatePayload);
 
     if (httpCode == HTTP_CODE_OK) {
         Serial.println("Spoolman erfolgreich aktualisiert");
@@ -198,6 +204,43 @@ uint8_t updateSpoolWeight(String spoolId, uint16_t weight) {
     return 1;
 }
 
+bool updateSpoolOcto(int spoolId) {
+    String spoolsUrl = octoUrl + "/plugin/Spoolman/selectSpool";
+    Serial.print("Update Spule in Octoprint mit URL: ");
+    Serial.println(spoolsUrl);
+
+    JsonDocument updateDoc;
+    updateDoc["spool_id"] = spoolId;
+    updateDoc["tool"] = "tool0";
+
+    String updatePayload;
+    serializeJson(updateDoc, updatePayload);
+    Serial.print("Update Payload: ");
+    Serial.println(updatePayload);
+
+    SendToApiParams* params = new SendToApiParams();
+    if (params == nullptr) {
+        Serial.println("Fehler: Kann Speicher für Task-Parameter nicht allokieren.");
+        return false;
+    }
+    params->httpType = "POST";
+    params->spoolsUrl = spoolsUrl;
+    params->updatePayload = updatePayload;
+    params->octoToken = octoToken;
+
+    // Erstelle die Task
+    BaseType_t result = xTaskCreate(
+        sendToApi,                // Task-Funktion
+        "SendToApiTask",          // Task-Name
+        4096,                     // Stackgröße in Bytes
+        (void*)params,            // Parameter
+        0,                        // Priorität
+        NULL                      // Task-Handle (nicht benötigt)
+    );
+
+    return true;
+}
+
 bool updateSpoolBambuData(String payload) {
     JsonDocument doc;
     DeserializationError error = deserializeJson(doc, payload);
@@ -435,17 +478,24 @@ bool checkSpoolmanInstance(const String& url) {
     return false;
 }
 
-bool saveSpoolmanUrl(const String& url) {
+bool saveSpoolmanUrl(const String& url, bool octoOn, const String& octoWh, const String& octoTk) {
     if (!checkSpoolmanInstance(url)) return false;
 
     JsonDocument doc;
     doc["url"] = url;
-    Serial.print("Speichere URL in Datei: ");
+    doc["octoEnabled"] = octoOn;
-    Serial.println(url);
+    doc["octoUrl"] = octoWh;
+    doc["octoToken"] = octoTk;
+    Serial.print("Speichere Spoolman Data in Datei: ");
+    Serial.println(doc.as<String>());
     if (!saveJsonValue("/spoolman_url.json", doc)) {
         Serial.println("Fehler beim Speichern der Spoolman-URL.");
+        return false;
     }
     spoolmanUrl = url;
+    octoEnabled = octoOn;
+    octoUrl = octoWh;
+    octoToken = octoTk;
 
     return true;
 }
@@ -453,6 +503,13 @@ bool saveSpoolmanUrl(const String& url) {
 String loadSpoolmanUrl() {
     JsonDocument doc;
     if (loadJsonValue("/spoolman_url.json", doc) && doc["url"].is<String>()) {
+        octoEnabled = (doc["octoEnabled"].is<bool>()) ? doc["octoEnabled"].as<bool>() : false;
+        if (octoEnabled && doc["octoToken"].is<String>() && doc["octoUrl"].is<String>())
+        {
+            octoUrl = doc["octoUrl"].as<String>();
+            octoToken = doc["octoToken"].as<String>();
+        }
+
         return doc["url"].as<String>();
     }
     Serial.println("Keine gültige Spoolman-URL gefunden.");

src/api.h

@@ -9,9 +9,12 @@
 
 extern bool spoolman_connected;
 extern String spoolmanUrl;
+extern bool octoEnabled;
+extern String octoUrl;
+extern String octoToken;
 
 bool checkSpoolmanInstance(const String& url);
-bool saveSpoolmanUrl(const String& url);
+bool saveSpoolmanUrl(const String& url, bool octoOn, const String& octoWh, const String& octoTk);
 String loadSpoolmanUrl(); // Neue Funktion zum Laden der URL
 bool checkSpoolmanExtraFields(); // Neue Funktion zum Überprüfen der Extrafelder
 JsonDocument fetchSingleSpoolInfo(int spoolId); // API-Funktion für die Webseite
@@ -19,5 +22,6 @@ bool updateSpoolTagId(String uidString, const char* payload); // Neue Funktion z
 uint8_t updateSpoolWeight(String spoolId, uint16_t weight); // Neue Funktion zum Aktualisieren des Gewichts
 bool initSpoolman(); // Neue Funktion zum Initialisieren von Spoolman
 bool updateSpoolBambuData(String payload); // Neue Funktion zum Aktualisieren der Bambu-Daten
+bool updateSpoolOcto(int spoolId); // Neue Funktion zum Aktualisieren der Octo-Daten
 
 #endif

src/main.cpp

@@ -197,6 +197,11 @@ void loop() {
       vTaskDelay(2000 / portTICK_PERIOD_MS);
       weightSend = 1;
       autoSetToBambuSpoolId = spoolId.toInt();
+
+      if (octoEnabled) 
+      {
+        updateSpoolOcto(autoSetToBambuSpoolId);
+      }
     }
     else
     {

src/nfc.cpp

@@ -44,8 +44,6 @@ void payloadToJson(uint8_t *data) {
       DeserializationError error = deserializeJson(doc, jsonString);
   
       if (!error) {
-        const char* version = doc["version"];
-        const char* protocol = doc["protocol"];
         const char* color_hex = doc["color_hex"];
         const char* type = doc["type"];
         int min_temp = doc["min_temp"];
@@ -55,8 +53,6 @@ void payloadToJson(uint8_t *data) {
         Serial.println();
         Serial.println("-----------------");
         Serial.println("JSON-Parsed Data:");
-        Serial.println(version);
-        Serial.println(protocol);
         Serial.println(color_hex);
         Serial.println(type);
         Serial.println(min_temp);
@@ -93,8 +89,16 @@ bool formatNdefTag() {
     return success;
   }
 
+uint16_t readTagSize()
+{
+  uint8_t buffer[4];
+  memset(buffer, 0, 4);
+  nfc.ntag2xx_ReadPage(3, buffer);
+  return buffer[2]*8;
+}
+
 uint8_t ntag2xx_WriteNDEF(const char *payload) {
-  uint8_t tagSize = 240; // 144 bytes is maximum for NTAG213
+  uint16_t tagSize = readTagSize();
   Serial.print("Tag Size: ");Serial.println(tagSize);
 
   uint8_t pageBuffer[4] = {0, 0, 0, 0};
@@ -136,6 +140,8 @@ uint8_t ntag2xx_WriteNDEF(const char *payload) {
   if (combinedData == NULL) 
   {
     Serial.println("Fehler: Nicht genug Speicher vorhanden.");
+    oledShowMessage("Tag too small");
+    vTaskDelay(2000 / portTICK_PERIOD_MS);
     return 0;
   }
 
@@ -369,46 +375,51 @@ void scanRfidTask(void * parameter) {
 
         if (uidLength == 7)
         {
-          uint8_t data[256];
+          uint16_t tagSize = readTagSize();
-
+          if(tagSize > 0)
-          // We probably have an NTAG2xx card (though it could be Ultralight as well)
-          Serial.println("Seems to be an NTAG2xx tag (7 byte UID)");
-          
-          for (uint8_t i = 0; i < 45; i++) {
-            /*
-            if (i < uidLength) {
-              uidString += String(uid[i], HEX);
-              if (i < uidLength - 1) {
-                  uidString += ":"; // Optional: Trennzeichen hinzufügen
-              }
-            }
-            */
-            if (!nfc.mifareclassic_ReadDataBlock(i, data + (i - 4) * 4)) 
-            {
-              break; // Stop if reading fails
-            }
-            // Check for NDEF message end
-            if (data[(i - 4) * 4] == 0xFE) 
-            {
-              break; // End of NDEF message
-            }
-
-            yield();
-            esp_task_wdt_reset();
-            vTaskDelay(pdMS_TO_TICKS(1));
-          }
-
-          if (!decodeNdefAndReturnJson(data)) 
           {
-            oledShowMessage("NFC-Tag unknown");
+            // Create a buffer depending on the size of the tag
-            vTaskDelay(2000 / portTICK_PERIOD_MS);
+            uint8_t* data = (uint8_t*)malloc(tagSize);
-            hasReadRfidTag = 2;
+            memset(data, 0, tagSize);
+
+            // We probably have an NTAG2xx card (though it could be Ultralight as well)
+            Serial.println("Seems to be an NTAG2xx tag (7 byte UID)");
+            
+            uint8_t numPages = readTagSize()/4;
+            for (uint8_t i = 4; i < 4+numPages; i++) {
+              if (!nfc.ntag2xx_ReadPage(i, data+(i-4) * 4))
+              {
+                break; // Stop if reading fails
+              }
+              // Check for NDEF message end
+              if (data[(i - 4) * 4] == 0xFE) 
+              {
+                break; // End of NDEF message
+              }
+
+              yield();
+              esp_task_wdt_reset();
+              vTaskDelay(pdMS_TO_TICKS(1));
+            }
+
+            if (!decodeNdefAndReturnJson(data)) 
+            {
+              oledShowMessage("NFC-Tag unknown");
+              vTaskDelay(2000 / portTICK_PERIOD_MS);
+              hasReadRfidTag = 2;
+            }
+            else 
+            {
+              hasReadRfidTag = 1;
+            }
+
+            free(data);
           }
           else
           {
-            hasReadRfidTag = 1;
+            oledShowMessage("NFC-Tag read error");
+            hasReadRfidTag = 2;
           }
-         
         }
         else
         {

src/ota.cpp

@@ -14,6 +14,34 @@ static size_t updateTotalSize = 0;
 static size_t updateWritten = 0;
 static bool isSpiffsUpdate = false;
 
+/**
+ * Compares two version strings and determines if version1 is less than version2
+ * 
+ * @param version1 First version string (format: x.y.z)
+ * @param version2 Second version string (format: x.y.z)
+ * @return true if version1 is less than version2
+ */
+bool isVersionLessThan(const String& version1, const String& version2) {
+    int major1 = 0, minor1 = 0, patch1 = 0;
+    int major2 = 0, minor2 = 0, patch2 = 0;
+    
+    // Parse version1
+    sscanf(version1.c_str(), "%d.%d.%d", &major1, &minor1, &patch1);
+    
+    // Parse version2
+    sscanf(version2.c_str(), "%d.%d.%d", &major2, &minor2, &patch2);
+    
+    // Compare major version
+    if (major1 < major2) return true;
+    if (major1 > major2) return false;
+    
+    // Major versions equal, compare minor
+    if (minor1 < minor2) return true;
+    if (minor1 > minor2) return false;
+    
+    // Minor versions equal, compare patch
+    return patch1 < patch2;
+}
 
 void backupJsonConfigs() {
     // Bambu Credentials backup
@@ -111,6 +139,16 @@ void handleUpdate(AsyncWebServer &server) {
     updateHandler->setUri("/update");
     updateHandler->setMethod(HTTP_POST);
     
+    // Check if current version is less than defined TOOLVERSION before proceeding with update
+    if (isVersionLessThan(VERSION, TOOLDVERSION)) {
+        updateHandler->onRequest([](AsyncWebServerRequest *request) {
+            request->send(400, "application/json", 
+                "{\"success\":false,\"message\":\"Your current version is too old. Please perform a full upgrade.\"}");
+        });
+        server.addHandler(updateHandler);
+        return;
+    }
+
     updateHandler->onUpload([](AsyncWebServerRequest *request, String filename,
                              size_t index, uint8_t *data, size_t len, bool final) {
         if (!index) {

src/website.cpp

@@ -239,7 +239,10 @@ void setupWebserver(AsyncWebServer &server) {
     server.on("/spoolman", HTTP_GET, [](AsyncWebServerRequest *request){
         Serial.println("Anfrage für /spoolman erhalten");
         String html = loadHtmlWithHeader("/spoolman.html");
-        html.replace("{{spoolmanUrl}}", spoolmanUrl);
+        html.replace("{{spoolmanUrl}}", (spoolmanUrl != "") ? spoolmanUrl : "");
+        html.replace("{{spoolmanOctoEnabled}}", octoEnabled ? "checked" : "");
+        html.replace("{{spoolmanOctoUrl}}", (octoUrl != "") ? octoUrl : "");
+        html.replace("{{spoolmanOctoToken}}", (octoToken != "") ? octoToken : "");
 
         JsonDocument doc;
         if (loadJsonValue("/bambu_credentials.json", doc) && doc["bambu_ip"].is<String>()) 
@@ -277,10 +280,21 @@ void setupWebserver(AsyncWebServer &server) {
             return;
         }
 
-        String url = request->getParam("url")->value();
+        if (request->getParam("octoEnabled")->value() == "true" && (!request->hasParam("octoUrl") || !request->hasParam("octoToken"))) {
-        url.trim();
+            request->send(400, "application/json", "{\"success\": false, \"error\": \"Missing OctoPrint URL or Token parameter\"}");
+            return;
+        }
 
-        bool healthy = saveSpoolmanUrl(url);
+        String url = request->getParam("url")->value();
+        bool octoEnabled = (request->getParam("octoEnabled")->value() == "true") ? true : false;
+        String octoUrl = request->getParam("octoUrl")->value();
+        String octoToken = (request->getParam("octoToken")->value() != "") ? request->getParam("octoToken")->value() : "";
+
+        url.trim();
+        octoUrl.trim();
+        octoToken.trim();
+        
+        bool healthy = saveSpoolmanUrl(url, octoEnabled, octoUrl, octoToken);
         String jsonResponse = "{\"healthy\": " + String(healthy ? "true" : "false") + "}";
 
         request->send(200, "application/json", jsonResponse);