Merge pull request #116 from cjkas/feat/usb-only-firmware

feat: say when the firmware is flashed over USB

data-src/index.js

@@ -4169,9 +4169,14 @@ class Firmware {
         div.style.display = '';
     }
     updateFirmware() {
+        let chip = document.getElementById('divContainer').getAttribute('data-chipmodel') || '';
+        // Firmware from before the field leaves it out: undefined, not false.
+        if (proto.model.header.hasOtaSlot === false) {
+            ui.infoMessage(`This device has no OTA slot, so its firmware is flashed over USB with SomfyController.onboard.esp32${chip}.bin, from the release's SomfyController.onboard.esp32${chip}.bin.zip. That image holds the web UI and an empty configuration too, so take a backup first and restore it afterwards.`);
+            return;
+        }
         let div = this.createFileUploader('/updateFirmware');
         let inst = div.querySelector('div[id=divInstText]');
-        let chip = document.getElementById('divContainer').getAttribute('data-chipmodel') || '';
         let html = `<div style="font-size:14px;margin-bottom:20px;">Select a binary file [SomfyController.ino.esp32${chip}.bin] containing the device firmware then press the Upload File button.</div>`;
         if (this.isMobile()) {
             html += `<div style="width:100%;color:red;text-align:center;font-weight:bold;"><span style="margin-top:7px;width:100%;background:yellow;padding:3px;display:inline-block;border-radius:5px;background:white;">WARNING<span></div>`;
@@ -4302,18 +4307,15 @@ class Firmware {
                 security.tokenRefused();
                 return;
             }
-            if (service !== '/restore' && (xhr.status < 200 || xhr.status >= 300)) {
-                ui.errorMessage(el, `The upload failed (${xhr.status}).`);
+            if (xhr.status < 200 || xhr.status >= 300) {
+                // The device's reason, when it sent one.
+                let desc = `The upload failed (${xhr.status}).`;
+                try { desc = JSON.parse(xhr.responseText).desc || desc; } catch (e) { }
+                ui.errorMessage(el, desc);
                 return;
             }
             switch (service) {
                 case '/restore':
-                    if (xhr.status < 200 || xhr.status >= 300) {
-                        let desc = 'The restore failed.';
-                        try { desc = JSON.parse(xhr.responseText).desc || desc; } catch (e) { }
-                        ui.errorMessage(el, desc);
-                        break;
-                    }
                     (async () => {
                         await somfy.init();
                         if (document.getElementById('divUploadFile')) document.getElementById('divUploadFile').remove();

data-src/js/model.js

@@ -140,7 +140,7 @@ ProtoModel.ITEMS = [
 // have it.
 ProtoModel.FIELDS = {
     header: ['maxRooms', 'maxShades', 'maxGroups', 'maxGroupedShades', 'maxLinkedRemotes', 'startingAddress', 'bitLength',
-        'proto', 'serverId', 'hostname', 'model', 'chipModel', 'fw', 'connType'],
+        'proto', 'serverId', 'hostname', 'model', 'chipModel', 'hasOtaSlot', 'fw', 'connType'],
     room: ['roomId', 'name', 'sortOrder'],
     shadeState: ['shadeId', 'position', 'target', 'direction', 'myPos', 'tiltPosition', 'tiltTarget', 'tiltDirection',
         'myTiltPos', 'flags', 'lastRollingCode'],

docs/PROTOCOL.md

@@ -53,7 +53,7 @@ A number is never reused. A retired type stays reserved.
    - `F`: fields, as `[key, name, kind, default]`, kind being `b` bool, `i` integer, `n` number, `s` string, `l` list, `o` object
    - `E`: error codes, as `[number, name]`
    - `Q`: feeds, as `[number, name]`
-3. Then the device: `header` (limits, starting address, what a new shade gets, server id, hostname, model, chip, firmware, connection type), `rooms`, `shades`, `groups`, `repeaters` and `status` (memory, and WiFi or Ethernet). A frame is at most 4 KB, an item is never split across frames, and several sections can share one.
+3. Then the device: `header` (limits, starting address, what a new shade gets, server id, hostname, model, chip, whether it has an OTA slot, firmware, connection type), `rooms`, `shades`, `groups`, `repeaters` and `status` (memory, and WiFi or Ethernet). A frame is at most 4 KB, an item is never split across frames, and several sections can share one.
 4. The client sends `next` after each `sync` frame, and the device answers with the following one. With no `next` for 30 s the device closes the socket.
 5. `syncEnd` follows the last `sync` frame.
 

src/ConfigSettings.cpp

@@ -7,6 +7,7 @@
 #include "Utils.h"
 #include "Secrets.h"
 #include "esp_chip_info.h"
+#include "esp_ota_ops.h"
 #include "esp_log.h"
 
 static const char *TAG = "Config";
@@ -144,6 +145,7 @@ bool ConfigSettings::begin() {
       break;
   }
   ESP_LOGD(TAG, "Chip Model ESP32-%s", this->chipModel);
+  this->hasOtaSlot = esp_ota_get_next_update_partition(nullptr) != nullptr;
   this->fwVersion.parse(FW_VERSION);
   uint64_t mac = ESP.getEfuseMac();
   for(int i=0; i<17; i=i+8) {

src/ConfigSettings.h

@@ -163,6 +163,9 @@ class ConfigSettings: BaseSettings {
     char serverId[10] = "";
     char hostname[32] = "ESPSomfyRTS";
     char chipModel[10] = "ESP32";
+    // Whether the partition table has a second app slot for /updateFirmware
+    // to write.  Builds with one 3 MB slot (C6, debug) are flashed over USB.
+    bool hasOtaSlot = true;
     conn_types_t connType = conn_types_t::unset;
     appver_t fwVersion;
     appver_t appVersion;

src/ProtoSchema.h

@@ -169,6 +169,7 @@
   FIELD(hostname, "hn", 's', 0) \
   FIELD(model, "md", 's', 0) \
   FIELD(chipModel, "cp", 's', 0) \
+  FIELD(hasOtaSlot, "os", 'b', 1) \
   FIELD(connType, "ct", 's', 0) \
   /* memory, wifi and ethernet */ \
   FIELD(freeHeap, "fr", 'i', 0) \

src/entryPoints/HttpRoutes.cpp

@@ -164,15 +164,21 @@ void registerHttpRoutes(AsyncWebServer &server) {
   // updateFirmware - file upload
   server.on(AsyncURIMatcher::exact("/updateFirmware"), HTTP_POST,
     [](AsyncWebServerRequest *request) {
+      // Nothing was written or stopped, so there is nothing to reboot for.
+      if(!settings.hasOtaSlot) {
+        request->send(400, _encoding_json, F("{\"status\":\"ERROR\",\"desc\":\"This device has no OTA slot, so its firmware is flashed over USB.\"}"));
+        return;
+      }
+      // errorString() is one of the updater's fixed messages, none with a quote.
       if(Update.hasError())
-        request->send(500, _encoding_json, "{\"status\":\"ERROR\",\"desc\":\"Error updating firmware: \"}");
+        request->send(500, _encoding_json, String("{\"status\":\"ERROR\",\"desc\":\"Error updating firmware: ") + Update.errorString() + "\"}");
       else
         request->send(200, _encoding_json, "{\"status\":\"SUCCESS\",\"desc\":\"Successfully updated firmware\"}");
       rebootDelay.reboot = true;
       rebootDelay.rebootTime = millis() + 500;
     },
     [](AsyncWebServerRequest *request, String filename, size_t index, uint8_t *data, size_t len, bool final) {
-      if(!uploadAllowed(request, index)) return;
+      if(!uploadAllowed(request, index) || !settings.hasOtaSlot) return;
       if(index == 0) {
         webServer.uploadSuccess = false;
         ESP_LOGI(TAG, "Update: %s", filename.c_str());
@@ -207,7 +213,7 @@ void registerHttpRoutes(AsyncWebServer &server) {
   server.on(AsyncURIMatcher::exact("/updateApplication"), HTTP_POST,
     [](AsyncWebServerRequest *request) {
       if(Update.hasError())
-        request->send(500, _encoding_json, "{\"status\":\"ERROR\",\"desc\":\"Error updating application: \"}");
+        request->send(500, _encoding_json, String("{\"status\":\"ERROR\",\"desc\":\"Error updating application: ") + Update.errorString() + "\"}");
       else
         request->send(200, _encoding_json, "{\"status\":\"SUCCESS\",\"desc\":\"Successfully updated application\"}");
       rebootDelay.reboot = true;

src/outputs/ProtoSocket.cpp

@@ -77,6 +77,7 @@ static void writeHeader(ProtoWriter &w) {
   w.add(proto_field_t::hostname, settings.hostname);
   w.add(proto_field_t::model, "ESPSomfyRTS");
   w.add(proto_field_t::chipModel, settings.chipModel);
+  w.add(proto_field_t::hasOtaSlot, settings.hasOtaSlot);
   w.add(proto_field_t::fw, settings.fwVersion.name);
   w.add(proto_field_t::connType, net.connTypeName());
 }

test/e2e/README.md

@@ -16,7 +16,7 @@ Runs against a real device on your network, by hand, never in CI. It checks sock
 | `--lockout` | on a Secured device, also fail `/login` until this PC is refused, then wait out the 30 s lockout |
 | `--record` | save hello, the sync and the schema to `test/fixtures/proto2/`, for the web UI and Home Assistant tests |
 
-A plain run sends nothing on air, changes no setting (it saves only values the device already has) and doesn't reboot the device. The command tests send ops that are refused before they reach the radio, and one `setPositions` that sets a shade to the position the sync gave: that drops the fraction of a percent the shade's believed position may have had. The edit tests send edits that are refused, and one shade sort order set to the order it has, which saves the shades again unchanged. The settings tests send saves that are refused, and one that saves the NTP server and time zone the device already has. The restore test sends options that aren't JSON with a file that isn't a backup, so nothing is restored. The frequency scan test pauses the radio's sending for a second or two, as a scan does. It does fill every socket slot for a few seconds, and replays a page load.
+A plain run sends nothing on air, changes no setting (it saves only values the device already has) and doesn't reboot the device. The command tests send ops that are refused before they reach the radio, and one `setPositions` that sets a shade to the position the sync gave: that drops the fraction of a percent the shade's believed position may have had. The edit tests send edits that are refused, and one shade sort order set to the order it has, which saves the shades again unchanged. The settings tests send saves that are refused, and one that saves the NTP server and time zone the device already has. The restore test sends options that aren't JSON with a file that isn't a backup, so nothing is restored. A firmware upload goes only to a device without an OTA slot, which refuses it. The frequency scan test pauses the radio's sending for a second or two, as a scan does. It does fill every socket slot for a few seconds, and replays a page load.
 
 The web UI holds one of the device's 5 socket slots for each open tab, and Home Assistant holds one. The tests that fill every slot fill the ones left, so close the UI's tabs for the full load.
 

test/e2e/test_routes.py

@@ -11,7 +11,8 @@ import urllib.request
 
 import pytest
 
-from proto_client import ProtoClient
+from proto_client import ProtoClient, run_sync
+from test_settings import header, uptime
 
 # Every route that needs the token under Secured, sent without a body or
 # parameters, so a route that let one through would still change nothing.
@@ -169,3 +170,20 @@ def test_a_socket_from_the_page_the_device_served_is_accepted(host, token):
     c.close()
     # The device frees the slot when it sees the disconnect.
     time.sleep(0.5)
+
+
+def test_a_firmware_upload_without_an_ota_slot_is_refused(host, token, connect, schema):
+    """Builds with one app slot (C6, debug) say so in the header, and refuse
+    the upload without stopping the radio or rebooting."""
+    _, frames, _ = run_sync(connect(schema=schema.hash))
+    # Left out at its default, true, as is a field older firmware doesn't have.
+    if header(schema, frames).get("hasOtaSlot", True):
+        pytest.skip("the device has an OTA slot: an upload would start an update")
+    uptime_before = uptime(schema, frames)
+    status, _, body = upload(host, "/updateFirmware", auth(token))
+    assert status == 400, body
+    assert "no OTA slot" in json.loads(body)["desc"]
+    # The old reply rebooted half a second later.
+    time.sleep(2)
+    _, frames, _ = run_sync(connect(schema=schema.hash))
+    assert uptime(schema, frames) > uptime_before, "the device restarted"

test/e2e/test_settings.py

@@ -86,9 +86,8 @@ def test_a_save_tells_the_other_clients(connect, schema):
 def test_a_wifi_scan_lists_the_networks(connect, schema):
     c = connect(schema=schema.hash)
     _, frames, _ = run_sync(c)
-    header = next(schema.expand(f["d"][schema.keys["header"]]) for f in frames if schema.keys["header"] in f["d"])
     # The connection in use: Ethernet with WiFi as the fallback may be on either.
-    if header.get("connType") != "Wifi":
+    if header(schema, frames).get("connType") != "Wifi":
         pytest.skip("the device isn't on WiFi")
     assert is_ok(schema, op(c, schema, "scanWifi", {}))
     found = c.recv_until(lambda f: f["t"] == schema.type_numbers["wifiNetworks"], timeout=20)[-1]
@@ -152,6 +151,12 @@ def wait_for_restart(host, token, schema, uptime_before):
         time.sleep(2)
 
 
+def header(schema, frames):
+    """The header a sync starts with."""
+    key = schema.keys["header"]
+    return next(schema.expand(f["d"][key]) for f in frames if key in f["d"])
+
+
 def uptime(schema, frames):
     """The uptime, in ms, from the status a sync ends with."""
     key = schema.keys["status"]

test/js/model.test.js

@@ -37,6 +37,19 @@ test('a field the sync left out is its default', () => {
     for (const g of m.groupList()) assert.ok(Array.isArray(g.linkedShades));
 });
 
+test('the device has an OTA slot unless it says it has none', () => {
+    // The recording is from firmware before the field.
+    assert.equal(synced().header.hasOtaSlot, undefined);
+    const schema = recordedSchema();
+    schema.add({ F: [['os', 'hasOtaSlot', 'b', 1]] });
+    const header = deviceSections(schema).find((d) => d.header).header;
+    const m = new ProtoModel(schema);
+    m.applySync({ header: header });
+    assert.equal(m.header.hasOtaSlot, true);
+    m.applySync({ header: schema.expand(Object.assign({ os: 0 }, schema.pack(header))) });
+    assert.equal(m.header.hasOtaSlot, false);
+});
+
 test('the lists come in their sort order', () => {
     const m = synced();
     const orders = m.shadeList().map((s) => s.sortOrder);

test/test_proto/test_proto.cpp

@@ -119,15 +119,17 @@ static void test_values_at_their_default_are_left_out() {
     w.add(proto_field_t::myPos, (int8_t)-1);
     w.add(proto_field_t::repeats, (uint8_t)1);
     w.add(proto_field_t::paired, false);
+    w.add(proto_field_t::hasOtaSlot, true);  // a bool whose default is true
     w.add(proto_field_t::name, "");
     w.add(proto_field_t::name, (const char *)nullptr);
   }).c_str());
 }
 static void test_values_off_their_default_are_written_by_key() {
-  TEST_ASSERT_EQUAL_STRING("{\"p\":50,\"m\":0,\"i\":1,\"n\":\"Office\",\"a\":4294967295,\"q\":-5}", writeObject([](ProtoWriter &w) {
+  TEST_ASSERT_EQUAL_STRING("{\"p\":50,\"m\":0,\"i\":1,\"os\":0,\"n\":\"Office\",\"a\":4294967295,\"q\":-5}", writeObject([](ProtoWriter &w) {
     w.add(proto_field_t::position, (int8_t)50);
     w.add(proto_field_t::myPos, (int8_t)0);
     w.add(proto_field_t::paired, true);
+    w.add(proto_field_t::hasOtaSlot, false);
     w.add(proto_field_t::name, "Office");
     w.add(proto_field_t::remoteAddress, (uint32_t)0xFFFFFFFF);
     w.add(proto_field_t::tiltPosition, (int8_t)-5);