frugal-iot-client 2.0.4 → 2.0.6

package/core.js

@@ -208,6 +208,13 @@ function mqtt_deliver(topic, msg, retained) {
     }
   }
 }
+// Drop one subscription, made with mqtt_subscribe, that was only wanted for a while.
+function mqtt_unsubscribe(topic) {
+  mqtt_subscriptions = mqtt_subscriptions.filter((s) => s.topic !== topic);
+  if (mqtt_client && mqtt_client.connected) {
+    mqtt_client.unsubscribe(topic, (err) => { if (err) console.error(err); });
+  }
+}
 // Drop every subscription belonging to an organization - all its topics start with the organization id.
 // Called when switching organization, both to tell the broker (if still connected) and so that the
 // connection made for the new organization does not resubscribe to the old organization's topics.
@@ -423,7 +430,7 @@ EN:
   close: close
   Collapse: Collapse
   Color:  Color
-  "Compiled into a node's firmware, this is what lets it ask this server for its own broker credential. It grants nothing else - no reading and no publishing. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "Compiled into a node's firmware, this is what lets it ask this server for its own broker credential. It grants nothing else - no reading and no publishing. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one."
+  "Compiled into firmware and used to request broker credential. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "Compiled into firmware and used to request broker credential. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one."
   Connect board: Connect board
   connected: connected
   connecting: connecting
@@ -446,7 +453,6 @@ EN:
   Done: Done
   ds18b20: ds18b20
   e.g. LiteFarm: e.g. LiteFarm
-  Each node has its own broker credential, which it collects from this server the first time it connects. Forget one to have it issued a new credential - needed if its filesystem has been erased, because it can then no longer prove which node it is.: Each node has its own broker credential, which it collects from this server the first time it connects. Forget one to have it issued a new credential - needed if its filesystem has been erased, because it can then no longer prove which node it is.
   eCO2: eCO2
   Email: Email
   Enrol URL: Enrol URL
@@ -533,7 +539,7 @@ EN:
   No farms registered for this organization yet.: No farms registered for this organization yet.
   No nodes found for this farm's project(s).: No nodes found for this farm's project(s).
   No nodes found for this organization: No nodes found for this organization
-  No nodes have enrolled yet. A node enrols itself the first time it connects.: No nodes have enrolled yet. A node enrols itself the first time it connects.
+  No nodes have enrolled yet, and none have asked and been rejected.: No nodes have enrolled yet, and none have asked and been rejected.
   No organization: No organization
   No organization selected: No organization selected
   No OTA files uploaded yet.: No OTA files uploaded yet.
@@ -550,6 +556,7 @@ EN:
   Nodes: Nodes
   Nodes in Farm: Nodes in Farm
   Nodes in Organization: Nodes in Organization
+  Nodes that have obtained broker credentials on first connection. Forget reissues a new credential at next connection and is needed if memory has been erased. Refused nodes are listed - click Approve to allow (on next retry, typically 30 minutes).: Nodes that have obtained broker credentials on first connection. Forget reissues a new credential at next connection and is needed if memory has been erased. Refused nodes are listed - click Approve to allow (on next retry, typically 30 minutes).
   Not in the schema: Not in the schema
   Not selected: Not selected
   Note this is your organization - not the organizations whose devices you want to access.: Note this is your organization - not the organizations whose devices you want to access.
@@ -581,6 +588,8 @@ EN:
   Pressure: Pressure
   Project: Project
   Project changed to: Project changed to
+  Asked %s to move: Asked %s to move
+  Waiting for %s to report: Waiting for %s to report
   Project ID: Project ID
   Project ID *: Project ID *
   Project Name: Project Name
@@ -733,7 +742,7 @@ FR:
   close: fermer
   Collapse: Réduire
   Color: Couleur  
-  "Compiled into a node's firmware, this is what lets it ask this server for its own broker credential. It grants nothing else - no reading and no publishing. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "Compilé dans le micrologiciel d'un nœud, c'est ce qui lui permet de demander à ce serveur son propre identifiant de broker. Il n'accorde rien d'autre - ni lecture ni publication. Ajoutez-en un second pour le changer : les deux sont acceptés, donc les nœuds déjà flashés continuent de fonctionner jusqu'à ce que vous retiriez l'ancien."
+  "Compiled into firmware and used to request broker credential. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "Compilé dans le micrologiciel et utilisé pour demander l'identifiant de broker. Ajoutez-en un second pour le changer : les deux sont acceptés, donc les nœuds déjà flashés continuent de fonctionner jusqu'à ce que vous retiriez l'ancien."
   Connect board: Connecter la carte
   connected: connecté
   connecting: connexion
@@ -756,7 +765,6 @@ FR:
   Done: Fait
   ds18b20: ds18b20
   e.g. LiteFarm: par ex. LiteFarm
-  Each node has its own broker credential, which it collects from this server the first time it connects. Forget one to have it issued a new credential - needed if its filesystem has been erased, because it can then no longer prove which node it is.: Chaque nœud a son propre identifiant de broker, qu'il récupère sur ce serveur lors de sa première connexion. Oubliez-en un pour qu'un nouvel identifiant lui soit délivré - nécessaire si son système de fichiers a été effacé, car il ne peut alors plus prouver quel nœud il est.
   eCO2: eCO2
   Email: Email
   Enrol URL: URL d'enrôlement
@@ -843,7 +851,7 @@ FR:
   No farms registered for this organization yet.: Aucune ferme enregistrée pour cette organisation pour l'instant.
   No nodes found for this farm's project(s).: Aucun nœud trouvé pour le(s) projet(s) de cette ferme.
   No nodes found for this organization: Aucun nœud trouvé pour cette organisation
-  No nodes have enrolled yet. A node enrols itself the first time it connects.: Aucun nœud ne s'est encore enrôlé. Un nœud s'enrôle lui-même lors de sa première connexion.
+  No nodes have enrolled yet, and none have asked and been rejected.: Aucun nœud ne s'est encore enrôlé, et aucun n'a été refusé.
   No organization: Aucune organisation
   No organization selected: Aucune organisation sélectionnée
   No OTA files uploaded yet.: Aucun fichier OTA téléversé pour l'instant.
@@ -860,6 +868,7 @@ FR:
   Nodes: Nœuds
   Nodes in Farm: Nœuds dans la ferme
   Nodes in Organization: Nœuds dans l'organisation
+  Nodes that have obtained broker credentials on first connection. Forget reissues a new credential at next connection and is needed if memory has been erased. Refused nodes are listed - click Approve to allow (on next retry, typically 30 minutes).: Nœuds ayant obtenu leur identifiant de broker à la première connexion. Oublier en délivre un nouveau à la prochaine connexion, nécessaire si la mémoire a été effacée. Les nœuds refusés sont listés - cliquez sur Approuver pour autoriser (à la prochaine tentative, généralement 30 minutes).
   Not in the schema: Absent du schéma
   Not selected: Non sélectionné
   Note this is your organization - not the organizations whose devices you want to access.: Ceci est votre organisation - pas les organisations dont vous voulez accéder aux appareils.
@@ -891,6 +900,8 @@ FR:
   Pressure: Pression
   Project: Projet
   Project changed to: Projet changé en
+  Asked %s to move: Déplacement demandé à %s
+  Waiting for %s to report: En attente du rapport de %s
   Project ID: ID du projet
   Project ID *: ID du projet *
   Project Name: Nom du projet
@@ -1043,7 +1054,7 @@ HI:
   close: बंद करें
   Collapse: छोटा करें
   Color: रंग  
-  "Compiled into a node's firmware, this is what lets it ask this server for its own broker credential. It grants nothing else - no reading and no publishing. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "नोड के फ़र्मवेयर में संकलित, यही उसे इस सर्वर से अपना ब्रोकर क्रेडेंशियल माँगने देता है। यह और कुछ नहीं देता - न पढ़ना, न प्रकाशित करना। इसे बदलने के लिए दूसरा जोड़ें: दोनों स्वीकार किए जाते हैं, इसलिए पहले फ़्लैश किए गए नोड तब तक काम करते रहते हैं जब तक आप पुराना वापस नहीं लेते।"
+  "Compiled into firmware and used to request broker credential. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "फ़र्मवेयर में संकलित और ब्रोकर क्रेडेंशियल माँगने के लिए उपयोग किया जाता है। इसे बदलने के लिए दूसरा जोड़ें: दोनों स्वीकार किए जाते हैं, इसलिए पहले फ़्लैश किए गए नोड तब तक काम करते रहते हैं जब तक आप पुराना वापस नहीं लेते।"
   Connect board: बोर्ड कनेक्ट करें
   connected: जुड़े हुए
   connecting: कनेक्ट हो रहा है
@@ -1066,7 +1077,6 @@ HI:
   Done: पूर्ण
   ds18b20: ds18b20
   e.g. LiteFarm: उदाहरण के लिए LiteFarm
-  Each node has its own broker credential, which it collects from this server the first time it connects. Forget one to have it issued a new credential - needed if its filesystem has been erased, because it can then no longer prove which node it is.: हर नोड का अपना ब्रोकर क्रेडेंशियल होता है, जो वह पहली बार जुड़ते समय इस सर्वर से लेता है। किसी को भुला दें ताकि उसे नया क्रेडेंशियल मिले - यह ज़रूरी है यदि उसका फ़ाइल-सिस्टम मिटा दिया गया हो, क्योंकि तब वह यह सिद्ध नहीं कर सकता कि वह कौन सा नोड है।
   eCO2: ईसीओ2
   Email: ईमेल
   Enrol URL: पंजीकरण URL
@@ -1153,7 +1163,7 @@ HI:
   No farms registered for this organization yet.: इस संगठन के लिए अभी तक कोई फार्म पंजीकृत नहीं है।
   No nodes found for this farm's project(s).: इस फार्म के प्रोजेक्ट (प्रोजेक्ट्स) के लिए कोई नोड नहीं मिला।
   No nodes found for this organization: इस संगठन के लिए कोई नोड नहीं मिला
-  No nodes have enrolled yet. A node enrols itself the first time it connects.: अभी तक कोई नोड पंजीकृत नहीं हुआ है। नोड पहली बार जुड़ते समय स्वयं पंजीकृत हो जाता है।
+  No nodes have enrolled yet, and none have asked and been rejected.: अभी तक कोई नोड पंजीकृत नहीं हुआ है, और किसी को अस्वीकार नहीं किया गया है।
   No organization: कोई संगठन नहीं
   No organization selected: कोई संगठन चयनित नहीं
   No OTA files uploaded yet.: अभी तक कोई OTA फ़ाइल अपलोड नहीं की गई है।
@@ -1170,6 +1180,7 @@ HI:
   Nodes: नोड्स
   Nodes in Farm: फार्म में नोड्स
   Nodes in Organization: संगठन में नोड्स
+  Nodes that have obtained broker credentials on first connection. Forget reissues a new credential at next connection and is needed if memory has been erased. Refused nodes are listed - click Approve to allow (on next retry, typically 30 minutes).: वे नोड जिन्होंने पहली बार जुड़ने पर ब्रोकर क्रेडेंशियल प्राप्त किए हैं। भुलाएँ अगली बार जुड़ने पर नया क्रेडेंशियल जारी करता है, और यह ज़रूरी है यदि मेमोरी मिटा दी गई हो। अस्वीकृत नोड भी सूचीबद्ध हैं - अनुमति देने के लिए स्वीकृत करें पर क्लिक करें (अगले प्रयास पर, आमतौर पर 30 मिनट)।
   Not in the schema: स्कीमा में नहीं
   Not selected: चयनित नहीं
   Note this is your organization - not the organizations whose devices you want to access.: ध्यान दें यह आपका संगठन है - वे संगठन नहीं जिनके उपकरणों तक आप पहुंचना चाहते हैं।
@@ -1201,6 +1212,8 @@ HI:
   Pressure: दाब
   Project: परियोजना
   Project changed to: प्रोजेक्ट बदलकर किया गया
+  Asked %s to move: "%s को स्थानांतरित करने को कहा"
+  Waiting for %s to report: "%s की रिपोर्ट की प्रतीक्षा"
   Project ID: प्रोजेक्ट आईडी
   Project ID *: प्रोजेक्ट आईडी *
   Project Name: प्रोजेक्ट का नाम
@@ -1353,7 +1366,7 @@ ID:
   close: tutup
   Collapse: Ciutkan
   Color: Warna  
-  "Compiled into a node's firmware, this is what lets it ask this server for its own broker credential. It grants nothing else - no reading and no publishing. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "Dikompilasi ke dalam firmware sebuah node, inilah yang memungkinkannya meminta kredensial broker miliknya sendiri dari server ini. Ia tidak memberi apa pun selain itu - tidak membaca dan tidak menerbitkan. Tambahkan yang kedua untuk menggantinya: keduanya diterima, sehingga node yang sudah di-flash tetap bekerja sampai Anda mencabut yang lama."
+  "Compiled into firmware and used to request broker credential. Add a second one to change it: both are accepted, so nodes already flashed keep working until you withdraw the old one.": "Dikompilasi ke dalam firmware dan digunakan untuk meminta kredensial broker. Tambahkan yang kedua untuk menggantinya: keduanya diterima, sehingga node yang sudah di-flash tetap bekerja sampai Anda mencabut yang lama."
   Connect board: Hubungkan papan
   connected: terhubung
   connecting: menghubungkan
@@ -1376,7 +1389,6 @@ ID:
   Done: Selesai
   ds18b20: ds18b20
   e.g. LiteFarm: misalnya LiteFarm
-  Each node has its own broker credential, which it collects from this server the first time it connects. Forget one to have it issued a new credential - needed if its filesystem has been erased, because it can then no longer prove which node it is.: Setiap node memiliki kredensial broker sendiri, yang diambilnya dari server ini saat pertama kali tersambung. Lupakan salah satu agar diberi kredensial baru - diperlukan jika sistem berkasnya telah dihapus, karena node itu tidak lagi dapat membuktikan node yang mana dirinya.
   eCO2: eCO2  
   Email: Email
   Enrol URL: URL pendaftaran
@@ -1463,7 +1475,7 @@ ID:
   No farms registered for this organization yet.: Belum ada farm yang terdaftar untuk organisasi ini.
   No nodes found for this farm's project(s).: Tidak ada node ditemukan untuk proyek farm ini.
   No nodes found for this organization: Tidak ada node ditemukan untuk organisasi ini
-  No nodes have enrolled yet. A node enrols itself the first time it connects.: Belum ada node yang mendaftar. Sebuah node mendaftarkan dirinya sendiri saat pertama kali tersambung.
+  No nodes have enrolled yet, and none have asked and been rejected.: Belum ada node yang terdaftar, dan tidak ada yang ditolak.
   No organization: Tidak ada organisasi
   No organization selected: Tidak ada organisasi yang dipilih
   No OTA files uploaded yet.: Belum ada berkas OTA yang diunggah.
@@ -1480,6 +1492,7 @@ ID:
   Nodes: Node
   Nodes in Farm: Node dalam Farm
   Nodes in Organization: Node dalam Organisasi
+  Nodes that have obtained broker credentials on first connection. Forget reissues a new credential at next connection and is needed if memory has been erased. Refused nodes are listed - click Approve to allow (on next retry, typically 30 minutes).: Node yang telah memperoleh kredensial broker saat pertama kali tersambung. Lupakan menerbitkan kredensial baru pada sambungan berikutnya, dan diperlukan jika memori telah dihapus. Node yang ditolak juga dicantumkan - klik Setujui untuk mengizinkan (pada percobaan berikutnya, biasanya 30 menit).
   Not in the schema: Tidak ada di skema
   Not selected: Tidak dipilih
   Note this is your organization - not the organizations whose devices you want to access.: Ini adalah organisasi Anda - bukan organisasi yang perangkatnya ingin Anda akses.
@@ -1511,6 +1524,8 @@ ID:
   Pressure: Tekanan
   Project: Proyek
   Project changed to: Proyek diubah menjadi
+  Asked %s to move: Meminta %s pindah
+  Waiting for %s to report: Menunggu laporan %s
   Project ID: ID Proyek
   Project ID *: ID Proyek *
   Project Name: Nama Proyek
@@ -1818,8 +1833,13 @@ class MqttTopic {
   // Creation & initialization =========
   constructor() {
     this.data = []; // Tracks previous values of this topic - used for graphing
-    this.qos = 0; // Default to send and not care if received
-    this.retain = false; // Default to not retain
+    /* For what this publishes - "set/..." commands to a node. QoS 1 so the broker holds them for a
+     * node that is asleep, until it reconnects to its persistent session; QoS 0 is dropped for anyone
+     * not connected at that moment. Not retained: the node writes a set value to its own flash, and
+     * a retained command would be replayed at every fresh subscribe, e.g. each reboot.
+     */
+    this.qos = 1;
+    this.retain = false;
     this.state = {}; // Dynamic state: value, groupMt roll-up fields (now_wired, out_wired, on, etc.)
   }
 
@@ -2021,8 +2041,6 @@ class MqttTopic {
         case 'toggle':
           //noinspection JSUnresolvedVariable
           elx = el('mqtt-toggle', {color: this.color, graphable: this.graphable });
-          this.retain = true;
-          this.qos = 1;
           break;
         case 'bar':
           // noinspection JSUnresolvedReference
@@ -2305,7 +2323,7 @@ class MqttTopic {
   }
   publishWired(val) {
     console.log("Publishing ", this.topicWiredPath, val, this.retain ? "retain" : "", this.qos ? `qos=${this.qos}` : "");
-    mqtt_client.publish(this.topicWiredPath, val, {retain: true, qos: 1});
+    mqtt_client.publish(this.topicWiredPath, val, {retain: this.retain, qos: this.qos});
   }
   // Adds historical data to the chart - typically chart updates data for each line, then updates the chart.
   addDataFrom(filename, first, cb) {
@@ -3329,6 +3347,7 @@ export {
   mqttTempConnect,
   mqtt_deliver,
   mqtt_subscribe,
+  mqtt_unsubscribe,
   mqtt_unsubscribe_organization,
   nextUniqueId,
   nowMs,

package/docs/FLASH_PLAN.md

@@ -55,7 +55,7 @@ So an ESP32 board needs three extra regions that are **independent of your sketc
 | Piece | Depends on | Per-app? |
 |---|---|---|
 | `bootloader.bin` | chip + flash mode/freq | No |
-| `partitions.bin` | partition scheme (`min_spiffs`, `frugal_8mb`, …) | No |
+| `partitions.bin` | partition scheme (`min_spiffs`, `default_8MB`, …) | No |
 | `boot_app0.bin` | nothing — fixed 8192-byte blob | No |
 | `firmware.bin` | your app | Yes — this is what the OTA tab already stores |
 
@@ -194,18 +194,25 @@ This can be decided with high confidence by reading the flash back before writin
 exposes `readFlash()`, and with the stub loaded, reading ~7 KB is fast.
 
 1. Read 3 KB at `0x8000`. Absent partition-table magic (`AA 50`) → no valid layout → **provision**.
-2. Parse the on-device table and check the **app slot only** — `app0` at `0x10000`, size `0x1E0000`.
-   Differs → the board is laid out for something else → **provision**.
+2. Parse the on-device table and check the **app slot's position only** — `app0` at `0x10000`.
+   Elsewhere → the board is laid out for something else → **provision**. Its size is not compared
+   here; it becomes the limit the image is checked against once one is chosen (see the refusals).
 3. Read 4 bytes at `chip.BOOTLOADER_FLASH_OFFSET`. Not `0xE9` → **provision**.
 4. Read the first 4 KB of the on-device FS partition (offset from *its* table, not ours) and look for
    the littlefs superblock magic — the ASCII string `littlefs`. Present → a filesystem exists worth
    preserving → **app-only**.
 
-Comparing only the app slot rather than the whole table is deliberate, and it's what the fixed app
-geometry buys: a board whose FS partition is a different size than our scheme would produce is still
-perfectly safe to update app-only. That correctly covers a board provisioned by an earlier version of
-this tool, or flashed by hand from PlatformIO with stock `min_spiffs`, instead of needlessly wiping
-its config.
+Comparing only where the app slot starts, rather than the whole table, is deliberate. An app image
+runs from any slot it fits in, so a board laid out differently from our scheme — a bigger app slot,
+a filesystem elsewhere — is still perfectly safe to update app-only. That correctly covers a board
+provisioned by an earlier version of this tool, or flashed by hand from PlatformIO with any stock
+scheme (`min_spiffs`, `default`, `default_8MB`), instead of needlessly wiping its config.
+
+**App-only also resets otadata.** A board that has taken a wireless OTA update may be booting from
+`app1`, and would then ignore the app just written to `app0`. So the app-only path writes
+`boot_app0.bin` at the otadata offset from the *board's own* table — exactly what a PlatformIO
+upload does — which selects `app0` without touching the filesystem. If the table could not be read,
+otadata is left alone and the log says the old firmware may keep booting.
 
 That resolves the "is it virgin?" question definitively. The one residue is step 4's blind spot: a
 matching partition table plus a valid LittleFS **belonging to a different project**. Flash contents
@@ -272,42 +279,40 @@ base/
   partitions/
     min_spiffs.bin               3 KB   — chip-independent (Arduino stock, 4 MB)
     min_spiffs.csv                      — provenance for the above
-    frugal_8mb.bin                      — custom, see below
-    frugal_8mb.csv
-    frugal_16mb.bin
-    frugal_16mb.csv
+    default_8MB.bin                     — Arduino stock, see below
+    default_8MB.csv
+    default_16MB.bin
+    default_16MB.csv
 ```
 
 Target chip set: **ESP8266** (no base needed at all), **ESP32-C3**, **ESP32-S2**, **ESP32-S3**.
 `min_spiffs` for the smaller chips, per Frugal IoT convention.
 
-### Partition schemes: fixed app size, all spare space to LittleFS
-
-Bigger boards get the *same* app partitions as a 4 MB board, with the surplus going to the
-filesystem. Arduino's stock large-flash schemes do the opposite (`default_8MB` gives 3.1 MB app
-slots and only 1.5 MB of FS), so these are custom tables.
-
-Starting from stock `min_spiffs` (4 MB), which is unchanged:
+### Partition schemes: the stock tables PlatformIO uses
 
-| Partition | Type/Subtype | Offset | `min_spiffs` (4 MB) | `frugal_8mb` | `frugal_16mb` |
-|---|---|---|---|---|---|
-| `nvs` | data/nvs | `0x9000` | `0x5000` | `0x5000` | `0x5000` |
-| `otadata` | data/ota | `0xe000` | `0x2000` | `0x2000` | `0x2000` |
-| `app0` | app/ota_0 | `0x10000` | `0x1E0000` | `0x1E0000` | `0x1E0000` |
-| `app1` | app/ota_1 | `0x1F0000` | `0x1E0000` | `0x1E0000` | `0x1E0000` |
-| `spiffs` | data/spiffs | `0x3D0000` | `0x20000` (128 KB) | `0x420000` (4.125 MB) | `0xC20000` (12.125 MB) |
-| `coredump` | data/coredump | *varies* | `0x3F0000` | `0x7F0000` | `0xFF0000` |
+Every scheme is Arduino's own, unmodified, so a board provisioned here has exactly the table a
+PlatformIO upload of the matching env writes. That is the point: a USB upload from PlatformIO onto a
+board provisioned here — or the reverse — rewrites the table with an identical one, and the
+filesystem (with the board's WiFi and MQTT config) stays where it is.
 
-App partitions stay 64 KB-aligned and the FS partition stays 4 KB-aligned in all three, and each
-table sums exactly to its flash size.
+| Partition | Type/Subtype | `min_spiffs` (4 MB) | `default_8MB` | `default_16MB` |
+|---|---|---|---|---|
+| `nvs` | data/nvs | `0x9000` `0x5000` | `0x9000` `0x5000` | `0x9000` `0x5000` |
+| `otadata` | data/ota | `0xe000` `0x2000` | `0xe000` `0x2000` | `0xe000` `0x2000` |
+| `app0` | app/ota_0 | `0x10000` `0x1E0000` | `0x10000` `0x330000` | `0x10000` `0x640000` |
+| `app1` | app/ota_1 | `0x1F0000` `0x1E0000` | `0x340000` `0x330000` | `0x650000` `0x640000` |
+| `spiffs` | data/spiffs | `0x3D0000` `0x20000` | `0x670000` `0x180000` | `0xC90000` `0x360000` |
+| `coredump` | data/coredump | `0x3F0000` `0x10000` | `0x7F0000` `0x10000` | `0xFF0000` `0x10000` |
 
-**Two consequences worth relying on:**
+**What is relied on:** `app0` is at `0x10000` in every scheme, so the app-only path always writes
+there. Its size varies, and an image fits any slot it is no bigger than — so the same
+`firmware.bin` from a 4 MB build flashes to an 8 or 16 MB board, and a wireless OTA moves it between
+`app0` and `app1` regardless. The image is checked against the slot actually on the board.
 
-1. **The app image is flash-size-independent.** `app0` has the same offset *and* size in every
-   scheme, so one `firmware.bin` flashes to a 4, 8 or 16 MB board. The OTA files in the tab need no
-   per-size variants, and the app-only path always writes at `0x10000`.
-2. **A 1.875 MB app slot is generous** and unchanged from what 4 MB boards already run, so nothing
-   about existing builds needs revisiting.
+An earlier version of this plan used custom `frugal_8mb`/`frugal_16mb` tables (`min_spiffs` app
+slots, all surplus to LittleFS). They were dropped because the firmware's PlatformIO envs build for
+the board default, and a PlatformIO upload onto a board provisioned with a different table moves the
+filesystem and loses its config.
 
 **Keep the label `spiffs`, even though the content is LittleFS.** Arduino's LittleFS mounts by
 partition label, defaulting to `"spiffs"`
@@ -315,10 +320,9 @@ partition label, defaulting to `"spiffs"`
 Renaming the partition to `littlefs` would stop the firmware mounting it unless `begin()` is also
 changed. Not worth the coupling.
 
-These CSVs are Frugal IoT's own, so they belong in the **firmware** repo (so builds can reference them
-via `board_build.partitions`), with the generated `.bin` plus a copy of the `.csv` committed here for
-the flasher. Generate with the core's `tools/gen_esp32part.py`, or just harvest
-`.pio/build/<env>/partitions.bin` from a build configured with that CSV.
+The `.csv` files are copied from the core's `tools/partitions/`, and the `.bin` generated from them
+with the core's `tools/gen_esp32part.py` — or harvested from `.pio/build/<env>/partitions.bin` of a
+build using that scheme.
 
 `boards.json` maps a detected `<chip>-<flashsize>` to the parts to use, so lookup after detection is
 a single key:
@@ -329,8 +333,8 @@ a single key:
     "ESP32-C3-4MB": "min_spiffs",
     "ESP32-S2-4MB": "min_spiffs",
     "ESP32-S3-4MB": "min_spiffs",
-    "ESP32-S3-8MB": "frugal_8mb",
-    "ESP32-S3-16MB": "frugal_16mb"
+    "ESP32-S3-8MB": "default_8MB",
+    "ESP32-S3-16MB": "default_16MB"
   },
   "bootloaderByChip": {
     "ESP32-C3": "bootloader/esp32c3.bin",
@@ -380,8 +384,8 @@ support without touching the client code:
 
 1. Build the firmware for the board.
 2. If the **chip** is new, copy `bootloader.bin` to `base/bootloader/<chip>.bin`.
-3. If the **flash size** is new, write a CSV following the table above — same app partitions, all
-   surplus to `spiffs` — and commit both it and the generated `.bin` to `base/partitions/`.
+3. If the **flash size** is new, copy the core's stock CSV for it — the one the board's PlatformIO
+   env uses — and commit both it and the generated `.bin` to `base/partitions/`.
 4. Add one `"<CHIP>-<SIZE>": "<scheme>"` line to `schemeByChipAndSize`.
 
 `boot_app0.bin` never needs touching, and the app binary never needs rebuilding for a different flash
@@ -397,8 +401,10 @@ All four are **refusals, not warnings** — a bad combination here means a board
 2. App image: byte 0 == `0xE9`, and for ESP32-family images `chip_id` (u16 LE at offset 12) ==
    `esploader.chip.IMAGE_CHIP_ID` (0=ESP32, 2=S2, 5=C3, 9=S3, 12=C2, 13=C6, 16=H2 — the ROM classes
    expose it). This catches the classic "C3 build onto a D1 Mini".
-3. App byte length ≤ app-slot size from the parsed partition table. Catches a `min_spiffs` app
-   dropped onto a `default`-scheme board.
+3. App byte length ≤ app-slot size — the board's own slot for an app-only write, the base scheme's
+   when provisioning. Catches a `default_8MB` build too big for a `min_spiffs` board. A too-big image
+   is refused rather than provisioned automatically, since provisioning erases the board's config;
+   the message says when "Provision instead" would make it fit.
 4. `detectFlashSize()` must produce a `<chip>-<flashsize>` key present in `schemeByChipAndSize` — and
    if the size came from the `"4MB"` fallback, require confirmation (and on an S3, warn about octal
    flash).
@@ -847,9 +853,8 @@ Nothing structural — the flow works but is a little unintuitive. Known rough e
   fact rather than a guess.
 - Confirm `writeFlash` tolerates an omitted `calculateMD5Hash` (see Client change 7).
 - **Ship 4 MB only at first.** Larger boards are still more expensive and not seen in practice, so
-  `min_spiffs` is the only scheme that needs to work on day one. The `frugal_8mb` / `frugal_16mb`
-  tables above are specified so they *can* be added without redesign, but they should be generated and
-  tested by someone holding the hardware rather than committed untested — an unlisted
+  `min_spiffs` is the only scheme that needs to work on day one. `default_8MB` / `default_16MB` are
+  the stock tables, but provisioning with them is untested on real hardware — an unlisted
   `<chip>-<flashsize>` already fails cleanly as "unsupported board".
 - Whether an ESP32-S2 `bootloader.bin` is worth harvesting up front, given `ARDUINO_LOLIN_S2_MINI`
   appears in the firmware but may not be in active use.

package/flash.js

@@ -13,9 +13,11 @@ const PartitionTableOffset = 0x8000;
 const PartitionTableMagic = 0x50aa; // AA 50 on the wire
 const PartitionType = {app: 0x00, data: 0x01};
 const PartitionSubtype = {factory: 0x00, ota0: 0x10, otadata: 0x00, spiffs: 0x82, littlefs: 0x83};
-// Every Frugal IoT scheme keeps app0 here, so one firmware.bin suits any flash size - see FLASH_PLAN.md
+// Every Arduino scheme keeps app0 here; only its size varies, and an image fits any slot it is no
+// bigger than - see FLASH_PLAN.md
 const AppPartitionOffset = 0x10000;
-const AppPartitionSize = 0x1e0000;
+// The smallest app0 we provision (min_spiffs) - the limit when the board's own table is unreadable
+const AppPartitionSizeMin = 0x1e0000;
 const ImageMagic = 0xe9;
 const LittleFsMagic = [0x6c, 0x69, 0x74, 0x74, 0x6c, 0x65, 0x66, 0x73]; // "littlefs" in the superblock
 const FlashBaudRates = [921600, 460800, 230400, 115200];
@@ -238,7 +240,6 @@ class MqttFlash extends HTMLElementExtended {
       dev.wholeImage = true;                 // ESP8266 firmware.bin is a complete image at 0x0
       dev.provision = false;                 // and does not overlap the filesystem
       dev.appAddress = 0x0;
-      dev.appLimit = null;
       return;
     }
     const scheme = boards.schemeByChipAndSize[`${dev.chipName}-${dev.flashSize}`];
@@ -255,11 +256,14 @@ class MqttFlash extends HTMLElementExtended {
       partitions: {url: partUrl(boards.partitionsByScheme[scheme]), address: boards.partitionTableOffset},
       otadata: {url: partUrl(boards.otadata), address: null}, // from the partition table below
     };
+    // Fetched now rather than at flash time, so the size check knows the base's app slot
+    const baseApp = partitionApp(partitionsParse(await fetchBytes(dev.base.partitions.url)));
+    dev.base.appSize = baseApp ? baseApp.size : AppPartitionSizeMin;
     // The filesystem partition is deliberately left erased - the firmware's LittleFS.begin(true)
     // formats it on first boot. See FLASH_PLAN.md: it only appeared unable to when we were writing a
     // bootloader from the wrong framework.
     dev.appAddress = AppPartitionOffset;
-    dev.appLimit = AppPartitionSize;
+    dev.onDeviceAppSize = AppPartitionSizeMin;
     await this.deviceInspect();
   }
   // Returns null rather than stalling, so a board that will not answer the stub's read command does
@@ -287,6 +291,7 @@ class MqttFlash extends HTMLElementExtended {
       dev.inspected = false;
       dev.provision = false;
       this.logLine("Could not inspect the board - assuming it is already provisioned. Use \"Provision instead\" if this is a new board.");
+      this.logLine("Without its partition table otadata cannot be reset, so a board that has taken an OTA update may keep booting the old firmware.");
       return;
     }
     dev.inspected = true;
@@ -295,8 +300,13 @@ class MqttFlash extends HTMLElementExtended {
     const app = partitionApp(onDeviceParts);
     if (!onDeviceParts.length) reasons.push("no partition table");
     else if (!app) reasons.push("no app partition");
-    // Only the app slot has to match - a differently sized filesystem is still safe to keep
-    else if (app.offset !== AppPartitionOffset || app.size !== AppPartitionSize) reasons.push("app partition differs");
+    // Only the app slot's position has to match - its size is checked against the image at flash
+    // time, and a differently laid out filesystem is still safe to keep
+    else if (app.offset !== AppPartitionOffset) reasons.push("app partition not at 0x10000");
+    if (app) dev.onDeviceAppSize = app.size;
+    // Only an ota_0 slot is selected through otadata - a factory app boots without it
+    const otadata = partitionOtadata(onDeviceParts);
+    if (app && app.subtype === PartitionSubtype.ota0 && otadata) dev.onDeviceOtadataOffset = otadata.offset;
     // Worth always logging - a layout that disagrees with the base explains most boot failures
     if (onDeviceParts.length) {
       this.logLine("On-device partition table:");
@@ -359,8 +369,15 @@ class MqttFlash extends HTMLElementExtended {
       if (chipId !== this.state.esploader.chip.IMAGE_CHIP_ID) {
         throw new Error(`${this.state.app.name} was built for chip id ${chipId}, but this board is ${dev.chipName} (chip id ${this.state.esploader.chip.IMAGE_CHIP_ID})`);
       }
-      if (dev.appLimit && bytes.length > dev.appLimit) {
-        throw new Error(`${this.state.app.name} is ${bytesToSizeString(bytes.length)}, larger than the ${bytesToSizeString(dev.appLimit)} app partition`);
+      // Not provisioned automatically: that erases the board's configuration, so it is the user's call
+      if (dev.provision && bytes.length > dev.base.appSize) {
+        throw new Error(`${this.state.app.name} is ${bytesToSizeString(bytes.length)}, larger than the ${bytesToSizeString(dev.base.appSize)} app partition of ${dev.scheme}`);
+      }
+      if (!dev.provision && bytes.length > dev.onDeviceAppSize) {
+        const fix = bytes.length <= dev.base.appSize
+          ? ` - "Provision instead" would lay it out as ${dev.scheme}, but erases its configuration`
+          : "";
+        throw new Error(`${this.state.app.name} is ${bytesToSizeString(bytes.length)}, larger than the ${bytesToSizeString(dev.onDeviceAppSize)} app partition on this board${fix}`);
       }
     }
     if (dev.flashSizeGuessed && !this.state.confirmed) {
@@ -381,6 +398,9 @@ class MqttFlash extends HTMLElementExtended {
       files.push({data: partitions, address: dev.base.partitions.address});
       files.push({data: otadata, address: otadataPart.offset});
       dev.verifyAddress = dev.base.partitions.address; // read back below to confirm the write landed
+    } else if (!dev.wholeImage && dev.onDeviceOtadataOffset != null) {
+      // After an OTA update the board boots app1, so the app written to app0 would never run
+      files.push({data: await fetchBytes(dev.base.otadata.url), address: dev.onDeviceOtadataOffset});
     }
     files.push({data: this.state.app.bytes, address: dev.appAddress});
     return files;

package/frugaliot.css

@@ -193,6 +193,8 @@ div.mqtt-text {
     }
 
 
+@keyframes fi-spin { to { transform: rotate(360deg); } }
+
 /* Related to authentication */
     .mqtt-admin {
         .pseudolink {
@@ -201,7 +203,9 @@ div.mqtt-text {
             cursor: pointer;
         }
         /* The \27f3 beside a heading: still a link, but underlining a glyph reads as a typo. */
-        .refresh { text-decoration: none; }
+        .refresh { text-decoration: none; display: inline-block; margin-left: 0.3em; }
+        /* Spins until the fetch it started replies - on a slow link a still glyph got clicked again and again. */
+        .refresh.busy { animation: fi-spin 1s linear infinite; cursor: progress; }
         /* An OTA row's glyphs: the padding is the whole hit area, so a mis-tap cannot reach delete. */
         .otaicon { text-decoration: none; padding: 0 0.3em; }
         .message {margin: 0.5em; font-weight: bold; font-size: x-large; }

package/graph.js

@@ -503,7 +503,7 @@ customElements.define('mqtt-graphdataset', MqttGraphDataset);
 // This event is used by custom dashboards to send
 document.addEventListener('frugaliot:publish', ({detail}) => {
   if (mqtt_client && detail.topic && detail.value !== undefined)
-    mqtt_client.publish(detail.topic, String(detail.value), detail.options || {retain: true, qos: 1});
+    mqtt_client.publish(detail.topic, String(detail.value), detail.options || {retain: false, qos: 1}); // As for MqttTopic - see its constructor
 });
 
 // Public API for custom dashboards and pages that import this module.

package/package.json

@@ -41,5 +41,5 @@
     "unlink:hee": "rm -f node_modules/html-element-extended && npm install html-element-extended"
   },
   "type": "module",
-  "version": "2.0.4"
+  "version": "2.0.6"
 }

package/test/cardui.test.js

@@ -237,6 +237,16 @@ describe('back mode', () => {
     card.remove();
   });
 
+  test('a control that is not a hysteresis still shows its topics to wire', () => {
+    const { card } = cardFor('display-control', 'esp32-48ed20', { mode: 'back', at: T0 });
+    const titles = [...card.querySelectorAll('.fi-section__title')].map((h) => h.textContent);
+    assert.ok(titles.includes('LCD SHT'), `no LCD section in ${titles}`);
+    for (const leaf of ['temperature', 'humidity', 'message']) {
+      assert.ok(card.querySelector(`[topic$="control_lcd_ht/${leaf}"]`), `no widget for ${leaf}`);
+    }
+    card.remove();
+  });
+
   test('nothing but Advanced is collapsed', () => {
     const { card } = cardFor('control-wired', 'esp8266-fb94bb', { mode: 'back', at: T0 });
     assert.equal(card.querySelectorAll('details').length, 1);