frugal-iot-client 2.0.4 → 2.0.6

package/test/fixtures/config.json

@@ -206,6 +206,141 @@
      }
     ]
    },
+   "control_lcd_ht": {
+    "summary": false,
+    "name": "LCD SHT",
+    "topics": [
+     {
+      "leaf": "temperature",
+      "leaf_from": "controlfloat",
+      "name": "Temperature",
+      "min": -40,
+      "max": 85,
+      "color": "#ff0000"
+     },
+     {
+      "leaf": "humidity",
+      "leaf_from": "controlfloat",
+      "name": "Humidity",
+      "color": "#0000ff"
+     },
+     {
+      "leaf": "message",
+      "leaf_from": "controltext",
+      "name": "Message",
+      "rw": "r"
+     }
+    ]
+   },
+   "control_oled_gps": {
+    "summary": false,
+    "name": "OLED GPS",
+    "topics": [
+     {
+      "leaf": "latitude",
+      "leaf_from": "controlfloat",
+      "name": "Latitude",
+      "min": -90,
+      "max": 90,
+      "width": 10,
+      "color": "#0000ff"
+     },
+     {
+      "leaf": "longitude",
+      "leaf_from": "controlfloat",
+      "name": "Longitude",
+      "min": -180,
+      "max": 180,
+      "width": 11,
+      "color": "#0000ff"
+     },
+     {
+      "leaf": "altitude",
+      "leaf_from": "controlfloat",
+      "name": "Altitude",
+      "min": -500,
+      "max": 9000,
+      "width": 6,
+      "color": "#008000"
+     },
+     {
+      "leaf": "speed",
+      "leaf_from": "controlfloat",
+      "name": "Speed",
+      "max": 999,
+      "color": "#ffa500"
+     },
+     {
+      "leaf": "course",
+      "leaf_from": "controlfloat",
+      "name": "Course",
+      "max": 360
+     },
+     {
+      "leaf": "satellites",
+      "leaf_from": "controlfloat",
+      "name": "Satellites",
+      "max": 32
+     },
+     {
+      "leaf": "hdop",
+      "leaf_from": "controlfloat",
+      "name": "HDOP",
+      "max": 50
+     }
+    ]
+   },
+   "control_oled_ht": {
+    "summary": false,
+    "name": "OLED HT",
+    "topics": [
+     {
+      "leaf": "temperature",
+      "leaf_from": "controlfloat",
+      "name": "Temperature",
+      "max": 50,
+      "color": "#ff0000"
+     },
+     {
+      "leaf": "humidity",
+      "leaf_from": "controlfloat",
+      "name": "Humidity",
+      "color": "#0000ff"
+     },
+     {
+      "leaf": "battery",
+      "leaf_from": "controlfloat",
+      "name": "Battery",
+      "max": 5000,
+      "color": "#00ff00"
+     }
+    ]
+   },
+   "control_oled_loramesher": {
+    "summary": false,
+    "name": "OLED LoRaMesher",
+    "topics": [
+     {
+      "leaf": "battery",
+      "leaf_from": "controlfloat",
+      "name": "Battery",
+      "max": 5000,
+      "color": "#00ff00"
+     }
+    ]
+   },
+   "control_oled_single": {
+    "summary": false,
+    "name": "OLED",
+    "topics": [
+     {
+      "leaf": "value",
+      "leaf_from": "controlfloat",
+      "name": "Value",
+      "max": 10000
+     }
+    ]
+   },
    "controlblinken": {
     "name": "Control Blinken",
     "topics": [
@@ -415,6 +550,24 @@
      }
     ]
    },
+   "hcsr04": {
+    "name": "HC-SR04 Distance",
+    "topics": [
+     {
+      "leaf": "hcsr04",
+      "leaf_from": "ultrasonic",
+      "max": 4000
+     },
+     {
+      "leaf": "temperature",
+      "leaf_from": "controlfloat",
+      "name": "Air Temperature",
+      "min": -20,
+      "max": 50,
+      "color": "#ff0000"
+     }
+    ]
+   },
    "health": {
     "name": "System",
     "insidefrugaliot": true,
@@ -838,14 +991,16 @@
       "leaf_from": "controlfloat",
       "name": "Battery",
       "min": 0,
-      "max": 16000
+      "max": 16000,
+      "log": true
      },
      {
       "leaf": "panel",
       "leaf_from": "controlfloat",
       "name": "Panel",
       "min": 0,
-      "max": 30000
+      "max": 30000,
+      "log": true
      },
      {
       "leaf": "profile",
@@ -889,6 +1044,18 @@
      }
     ]
    },
+   "time": {
+    "name": "Time",
+    "insidefrugaliot": true,
+    "topics": [
+     {
+      "leaf": "epoch"
+     },
+     {
+      "leaf": "offset"
+     }
+    ]
+   },
    "ultrasonic": {
     "name": "Ultrasonic Distance",
     "topics": [
@@ -1178,6 +1345,16 @@
     "rw": "r",
     "graphable": true
    },
+   "epoch": {
+    "leaf": "epoch",
+    "name": "Epoch",
+    "type": "int",
+    "log": false,
+    "display": "text",
+    "color": "#000000",
+    "rw": "r",
+    "units": "s"
+   },
    "gas": {
     "leaf": "gas",
     "name": "Gas Resistance",
@@ -1412,6 +1589,16 @@
     "rw": "w",
     "retain": true
    },
+   "offset": {
+    "leaf": "offset",
+    "name": "UTC Offset",
+    "type": "int",
+    "log": false,
+    "display": "text",
+    "color": "#000000",
+    "rw": "r",
+    "units": "min"
+   },
    "on": {
     "leaf": "on",
     "name": "On",

package/test/flash.test.js

@@ -1,8 +1,9 @@
 // The flasher's hold on the serial port. WebSerial refuses a second open of the same port, so the
 // element is the only thing that can close it - and a connect that fails is exactly when it must.
 import './setup.js';
-import { test, describe, before, beforeEach, afterEach } from 'node:test';
+import { test, describe, before, after, beforeEach, afterEach } from 'node:test';
 import assert from 'node:assert/strict';
+import { readFileSync } from 'node:fs';
 
 let ports; // what a fake Transport did, in order
 
@@ -218,3 +219,87 @@ describe('the serial monitor', () => {
     flash.remove();
   });
 });
+
+/*
+ * Provision vs app-only, against real partition tables from base/. A board is only re-laid out when
+ * its app slot is somewhere else - a different size is checked against the image instead, since
+ * provisioning erases the board's configuration.
+ */
+describe('flashing over a board that is already laid out', () => {
+  const readBase = (p) => new Uint8Array(readFileSync(new URL(`../base/${p}`, import.meta.url)));
+  const boards = JSON.parse(readFileSync(new URL('../base/boards.json', import.meta.url), 'utf8'));
+  let writes;
+  // An 8MB S3 whose flash holds `table` at 0x8000, a bootloader, and an erased filesystem
+  function fakeS3(table) {
+    return async () => ({
+      Transport: class { async disconnect() {} },
+      ESPLoader: class {
+        constructor() { this.chip = {CHIP_NAME: 'ESP32-S3', BOOTLOADER_FLASH_OFFSET: 0, IMAGE_CHIP_ID: 9}; }
+        async main() { return 'ESP32-S3'; }
+        async readFlashId() { return 0x17 << 16; }
+        async readFlash(offset, length) {
+          const block = new Uint8Array(length).fill(0xff);
+          if (offset === 0) block[0] = 0xe9;
+          if (offset === 0x8000) block.set(table.subarray(0, length));
+          return block;
+        }
+        async writeFlash({fileArray}) { writes.push(...fileArray.map((f) => f.address)); }
+        async after() {}
+      },
+    });
+  }
+  async function connected(table) {
+    const flash = document.createElement('mqtt-flash');
+    document.body.append(flash);
+    flash.esptoolImport = fakeS3(table);
+    flash.state.boards = boards;
+    flash.monitorStart = () => {};
+    await flash.connectAndInspect({});
+    return flash;
+  }
+  const image = (size) => { const b = new Uint8Array(size); b[0] = 0xe9; b[12] = 9; return b; };
+  let realFetch;
+  before(() => {
+    realFetch = globalThis.fetch;
+    globalThis.fetch = async (url) => {
+      const bytes = readBase(String(url).replace(/^\.\/base\//, '').replace(/\?.*$/, ''));
+      return {ok: true, arrayBuffer: async () => bytes.buffer.slice(bytes.byteOffset, bytes.byteOffset + bytes.byteLength)};
+    };
+  });
+  after(() => { globalThis.fetch = realFetch; });
+  beforeEach(() => { writes = []; });
+
+  test('a board on a bigger app slot than our scheme is updated app-only, keeping its config', async () => {
+    const flash = await connected(readBase('partitions/default_8MB.bin'));
+    assert.equal(flash.state.device.provision, false, flash.state.log.join('\n'));
+    flash.state.app = {name: 'firmware.bin', bytes: image(0x200000)}; // too big for min_spiffs, fits here
+    await flash.flash();
+    assert.deepEqual(writes, [0xe000, 0x10000], 'otadata reset, then the app - nothing else');
+    flash.remove();
+  });
+
+  test('an app-only write resets otadata where the board says, so it boots app0 and not an older app1', async () => {
+    const flash = await connected(readBase('partitions/min_spiffs.bin'));
+    flash.state.app = {name: 'firmware.bin', bytes: image(0x1000)};
+    await flash.flash();
+    assert.ok(writes.includes(0xe000), 'otadata should have been written');
+    flash.remove();
+  });
+
+  test('an image too big for the board is refused, not provisioned behind the user’s back', async () => {
+    const flash = await connected(readBase('partitions/min_spiffs.bin'));
+    flash.state.app = {name: 'firmware.bin', bytes: image(0x200000)};
+    await assert.rejects(flash.flash(), /larger than the 1\.88MB app partition on this board - "Provision instead"/);
+    assert.deepEqual(writes, []);
+    flash.remove();
+  });
+
+  test('a board whose app slot is somewhere else is provisioned', async () => {
+    const table = readBase('partitions/min_spiffs.bin').slice();
+    new DataView(table.buffer).setUint32(2 * 32 + 4, 0x20000, true); // app0 is the third record
+    const flash = await connected(table);
+    assert.equal(flash.state.device.provision, true);
+    assert.deepEqual(flash.state.device.provisionReasons, ['app partition not at 0x10000']);
+    flash.remove();
+  });
+});

package/test/mock.js

@@ -132,6 +132,19 @@ export const scenarios = {
     }),
   },
 
+  'display-control': {
+    // A control that is not hysteresis-shaped: two inputs wired to another node, one output to the LCD
+    title: 'An LCD display control wired to another node',
+    messages: [
+      ...device('esp32-48ed20', 'LCD', { 'control_lcd_ht/temperature': '21.5', 'control_lcd_ht/humidity': '60' },
+        { ota: 'lcd_ht_supermini' }),
+      ...wiring('esp32-48ed20', 'control_lcd_ht', {
+        temperature: `${ORG}/${PROJECT}/esp32-784702/sht/temperature`,
+        humidity: `${ORG}/${PROJECT}/esp32-784702/sht/humidity`,
+      }),
+    ],
+  },
+
   'unknown-module': {
     // Nothing in modules.yaml declares 'quantumflux' - it must still reach the back of the card,
     // because that is what someone adding a module needs to see

package/test/page.test.js

@@ -483,3 +483,33 @@ describe('the page', () => {
     page.remove();
   });
 });
+
+describe('moving a node to another project', () => {
+  test('shows pending until the node is heard live at its new address', () => {
+    const config = structuredClone(base);
+    config.organizations.dev.projects = {
+      lotus: { name: 'Lotus Ponds', nodes: { n1: { 'frugal_iot/name': 'Pond' } } },
+      developers: { name: 'Developers', nodes: {} },
+    };
+    mock.loadConfig({ ...config, user: { id: 2, name: 'test', permissions: [{ org: 'dev', capability: 'ADMIN' }] } });
+    const admin = document.createElement('mqtt-admin');
+    admin.setAttribute('section', 'admin');
+    document.body.append(admin);
+    let redrawn = 0;
+    admin.watchNodeMove('dev', 'n1', 'lotus', 'developers', () => redrawn++);
+    const cell = () => admin.renderProjectIdCell({ nodeId: 'n1', projectId: 'lotus' }, () => {}).textContent;
+    assert.match(cell(), /lotus → developers/);
+
+    // Left over from an earlier stay in that project - not this node arriving
+    core.mqtt_deliver('dev/developers/n1/frugal_iot/name', 'Pond', true);
+    assert.equal(redrawn, 0);
+    assert.ok(admin.projectsOf('dev').lotus.nodes.n1);
+
+    core.mqtt_deliver('dev/developers/n1/frugal_iot/name', 'Pond', false);
+    assert.equal(redrawn, 1);
+    assert.equal(admin.projectsOf('dev').lotus.nodes.n1, undefined);
+    assert.equal(admin.projectsOf('dev').developers.nodes.n1['frugal_iot/name'], 'Pond');
+    assert.equal(cell(), 'lotus');   // no longer pending - and the row itself is now in developers
+    admin.remove();
+  });
+});

package/base/partitions/frugal_16mb.csv

@@ -1,8 +0,0 @@
-# Frugal IoT 16MB: app partitions identical to min_spiffs, all surplus to LittleFS (label must stay "spiffs")
-# Name,   Type, SubType, Offset,  Size, Flags
-nvs,      data, nvs,     0x9000,  0x5000,
-otadata,  data, ota,     0xe000,  0x2000,
-app0,     app,  ota_0,   0x10000, 0x1E0000,
-app1,     app,  ota_1,   0x1F0000,0x1E0000,
-spiffs,   data, spiffs,  0x3D0000,0xC20000,
-coredump, data, coredump,0xFF0000,0x10000,

package/base/partitions/frugal_8mb.csv

@@ -1,8 +0,0 @@
-# Frugal IoT 8MB: app partitions identical to min_spiffs, all surplus to LittleFS (label must stay "spiffs")
-# Name,   Type, SubType, Offset,  Size, Flags
-nvs,      data, nvs,     0x9000,  0x5000,
-otadata,  data, ota,     0xe000,  0x2000,
-app0,     app,  ota_0,   0x10000, 0x1E0000,
-app1,     app,  ota_1,   0x1F0000,0x1E0000,
-spiffs,   data, spiffs,  0x3D0000,0x420000,
-coredump, data, coredump,0x7F0000,0x10000,