diff --git a/data-src/index.js b/data-src/index.js
index 4f00273..cecd83c 100644
--- a/data-src/index.js
+++ b/data-src/index.js
@@ -4170,9 +4170,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 = `Select a binary file [SomfyController.ino.esp32${chip}.bin] containing the device firmware then press the Upload File button.
`;
if (this.isMobile()) {
html += `WARNING
`;
@@ -4303,18 +4308,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();
diff --git a/data-src/js/model.js b/data-src/js/model.js
index 2411996..b23c370 100644
--- a/data-src/js/model.js
+++ b/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'],
diff --git a/docs/PROTOCOL.md b/docs/PROTOCOL.md
index 1937f23..0f27463 100644
--- a/docs/PROTOCOL.md
+++ b/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.
diff --git a/src/ConfigFile.cpp b/src/ConfigFile.cpp
index 2d606e4..e7854ca 100644
--- a/src/ConfigFile.cpp
+++ b/src/ConfigFile.cpp
@@ -608,7 +608,9 @@ bool ShadeConfigFile::restoreFile(SomfyShadeController *s, const char *filename,
else {
this->file.seek(this->file.position() + this->header.netRecordSize, SeekSet);
}
- if(opts.shades) s->commit();
+ // The repeaters are saved in shades.cfg too. Left to somfy.loop(), they
+ // race the reboot.
+ if(opts.shades || opts.repeaters) s->commit();
if(opts.transceiver)
{
// Read into a copy so the radio task never transmits on a half restored config.
diff --git a/src/ConfigSettings.cpp b/src/ConfigSettings.cpp
index 3d0cf97..47d2d7e 100644
--- a/src/ConfigSettings.cpp
+++ b/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";
@@ -149,6 +150,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) {
diff --git a/src/ConfigSettings.h b/src/ConfigSettings.h
index 043ebe4..81c5838 100644
--- a/src/ConfigSettings.h
+++ b/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;
diff --git a/src/ProtoSchema.h b/src/ProtoSchema.h
index dc5a853..85ae094 100644
--- a/src/ProtoSchema.h
+++ b/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) \
diff --git a/src/entryPoints/HttpRoutes.cpp b/src/entryPoints/HttpRoutes.cpp
index 440bc6e..2e2e21d 100644
--- a/src/entryPoints/HttpRoutes.cpp
+++ b/src/entryPoints/HttpRoutes.cpp
@@ -93,7 +93,11 @@ void registerHttpRoutes(AsyncWebServer &server) {
server.on(AsyncURIMatcher::exact("/restore"), HTTP_POST,
[](AsyncWebServerRequest *request) {
- if(webServer.uploadSuccess) {
+ // An upload is restored once: a later /restore without a file must not
+ // find this one.
+ const bool uploaded = webServer.uploadSuccess;
+ webServer.uploadSuccess = false;
+ if(uploaded) {
restore_options_t opts;
if(asyncHasParam(request, "data")) {
String dataStr = asyncParam(request, "data");
@@ -101,6 +105,7 @@ void registerHttpRoutes(AsyncWebServer &server) {
JsonDocument doc;
DeserializationError err = deserializeJson(doc, dataStr);
if(err) {
+ LittleFS.remove("/shades.tmp");
request->send(500, _encoding_json, "{\"status\":\"ERROR\",\"desc\":\"JSON parse error\"}");
return;
}
@@ -113,6 +118,13 @@ void registerHttpRoutes(AsyncWebServer &server) {
ESP_LOGD(TAG, "No restore options sent. Using defaults...");
opts.shades = true;
}
+ // Otherwise the device would reboot having restored nothing.
+ const uint8_t parts = restoreParts(opts);
+ if(parts == 0) {
+ LittleFS.remove("/shades.tmp");
+ request->send(400, _encoding_json, F("{\"status\":\"ERROR\",\"desc\":\"No part of the backup was chosen, so nothing was restored.\"}"));
+ return;
+ }
// Checked here so the client hears about a bad file. It only reads
// the file; the shades are still changed on loop() alone.
if(!ShadeConfigFile::validateFile("/shades.tmp")) {
@@ -124,7 +136,7 @@ void registerHttpRoutes(AsyncWebServer &server) {
// codes, and then reboots.
loop_item_t item;
item.type = loop_item_type_t::restore_shades;
- item.restoreParts = restoreParts(opts);
+ item.restoreParts = parts;
if(!queueLoopItem(request, item)) return;
request->send(200, _encoding_json, "{\"status\":\"Success\",\"desc\":\"Restoring Shade settings\"}");
}
@@ -152,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());
@@ -195,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;
diff --git a/src/entryPoints/Web.cpp b/src/entryPoints/Web.cpp
index 37db532..69c556c 100644
--- a/src/entryPoints/Web.cpp
+++ b/src/entryPoints/Web.cpp
@@ -143,13 +143,18 @@ bool Web::createAPIToken(const IPAddress ipAddress, char *token) {
// =====================================================
// Async API Handlers
// =====================================================
-// Helper: get a query param as String, or empty if missing
+// The library keeps query parameters and form fields apart, and looks up only
+// the first unless asked. /restore's options come as a form field.
+static const AsyncWebParameter *queryOrFormParam(AsyncWebServerRequest *request, const char *name) {
+ const AsyncWebParameter *p = request->getParam(name);
+ return p ? p : request->getParam(name, true);
+}
String asyncParam(AsyncWebServerRequest *request, const char *name) {
- if(request->hasParam(name)) return request->getParam(name)->value();
- return String();
+ const AsyncWebParameter *p = queryOrFormParam(request, name);
+ return p ? p->value() : String();
}
bool asyncHasParam(AsyncWebServerRequest *request, const char *name) {
- return request->hasParam(name);
+ return queryOrFormParam(request, name) != nullptr;
}
// -- Serialization helpers --
diff --git a/src/entryPoints/WebRoutes.h b/src/entryPoints/WebRoutes.h
index a6af497..7e2c815 100644
--- a/src/entryPoints/WebRoutes.h
+++ b/src/entryPoints/WebRoutes.h
@@ -18,7 +18,7 @@ extern const char _encoding_json[];
// Hands an item to loop(), which owns the shades. When it can't be the
// request is answered with the reason and false is returned.
bool queueLoopItem(AsyncWebServerRequest *request, const loop_item_t &item);
-// A query parameter, or an empty string when it is missing.
+// A query parameter or form field, or an empty string when it is missing.
String asyncParam(AsyncWebServerRequest *request, const char *name);
bool asyncHasParam(AsyncWebServerRequest *request, const char *name);
#endif
diff --git a/src/outputs/ProtoSocket.cpp b/src/outputs/ProtoSocket.cpp
index 81c5533..8a979cd 100644
--- a/src/outputs/ProtoSocket.cpp
+++ b/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());
}
diff --git a/test/e2e/README.md b/test/e2e/README.md
index 6e9ed68..1467e54 100644
--- a/test/e2e/README.md
+++ b/test/e2e/README.md
@@ -12,11 +12,11 @@ Runs against a real device on your network, by hand, never in CI. It checks sock
| `--password`, `--username` / `--pin` | the credentials of a Secured device |
| `--radio --shade ` | also send real commands: that shade moves a little and back |
| `--edit` | also add a room and delete it again |
-| `--reboot` | also reboot the device and wait for it to come back |
+| `--reboot` | also reboot the device and wait for it to come back, and restore the settings from a backup taken a moment before (it changes the NTP server, which the restore puts back) |
| `--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 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.
diff --git a/test/e2e/conftest.py b/test/e2e/conftest.py
index 23e564b..1b47f1e 100644
--- a/test/e2e/conftest.py
+++ b/test/e2e/conftest.py
@@ -18,7 +18,7 @@ def pytest_addoption(parser):
parser.addoption("--radio", action="store_true", help="also run the tests that send commands on air")
parser.addoption("--shade", type=int, default=None, help="with --radio: the id of the shade the commands may move")
parser.addoption("--edit", action="store_true", help="also run the edits that change the shade model, then undo them")
- parser.addoption("--reboot", action="store_true", help="also run the test that reboots the device")
+ parser.addoption("--reboot", action="store_true", help="also run the tests that reboot the device")
parser.addoption("--lockout", action="store_true", help="also run the test that locks this PC out of /login for 30 s")
diff --git a/test/e2e/test_restore.py b/test/e2e/test_restore.py
new file mode 100644
index 0000000..96593b7
--- /dev/null
+++ b/test/e2e/test_restore.py
@@ -0,0 +1,72 @@
+"""/restore and the options the web UI sends with the backup file.
+
+The round trip restores a backup and reboots the device: pass --reboot.
+"""
+import json
+
+import pytest
+
+from proto_client import run_sync
+from test_commands import is_ok, op, synced_model
+from test_routes import auth, http, restore_without_a_file, upload
+from test_settings import desc, settings, uptime, wait_for_restart
+
+# Saved for the round trip and put back by the restore. .invalid never resolves.
+CHANGED_NTP_SERVER = "restore.e2e.invalid"
+
+
+def test_restore_reads_the_options_sent_as_a_form_field(host, token):
+ """The options come as the form field "data", next to the file.
+
+ They are read before the file is checked, so options that aren't JSON
+ are refused, and this file, which isn't a backup, restores nothing
+ either way. /restore once looked up only query parameters, missed the
+ field and restored the shades alone, whatever was ticked.
+ """
+ status, _, body = upload(host, "/restore", auth(token), fields={"data": "{"})
+ assert status == 500, body
+ assert json.loads(body)["desc"] == "JSON parse error"
+
+
+def test_a_restore_with_no_part_chosen_is_refused(host, token):
+ """Checked before the file, so this file, which isn't a backup, restores nothing either way."""
+ options = json.dumps({"shades": False})
+ status, _, body = upload(host, "/restore", auth(token), fields={"data": options})
+ assert status == 400, body
+ assert json.loads(body)["desc"] == "No part of the backup was chosen, so nothing was restored."
+
+
+def test_a_refused_restore_leaves_no_upload_behind(host, token):
+ """A later /restore without a file must not find the refused one's upload."""
+ status, _, _ = upload(host, "/restore", auth(token), fields={"data": "{"})
+ assert status == 500
+ status, reason = restore_without_a_file(host, token)
+ assert status == 400
+ assert "didn't complete" in reason, reason
+
+
+def test_a_restore_brings_back_the_parts_that_were_ticked(request, host, token, connect, schema):
+ if not request.config.getoption("--reboot"):
+ pytest.skip("restores a backup and reboots the device: pass --reboot")
+ c = connect(schema=schema.hash)
+ _, frames, _ = run_sync(c)
+ uptime_before = uptime(schema, frames)
+ general = settings(c, schema, "general")
+ ntp = {name: general.get(name, schema.default(name)) for name in ("ntpServer", "posixZone")}
+ assert ntp["ntpServer"] != CHANGED_NTP_SERVER
+ status, _, backup = http(host, "/backup", headers=auth(token))
+ assert status == 200
+
+ reply = op(c, schema, "saveSettings", dict(ntp, ntpServer=CHANGED_NTP_SERVER, section="general"))
+ assert is_ok(schema, reply), desc(schema, reply)
+ try:
+ options = json.dumps({"shades": False, "settings": True})
+ status, _, body = upload(host, "/restore", auth(token), file=backup, fields={"data": options})
+ assert status == 200, body
+ wait_for_restart(host, token, schema, uptime_before)
+ finally:
+ c, _, _ = synced_model(connect, schema)
+ restored = settings(c, schema, "general").get("ntpServer", schema.default("ntpServer"))
+ if restored != ntp["ntpServer"]:
+ op(c, schema, "saveSettings", dict(ntp, section="general"))
+ assert restored == ntp["ntpServer"]
diff --git a/test/e2e/test_routes.py b/test/e2e/test_routes.py
index 9072568..a992284 100644
--- a/test/e2e/test_routes.py
+++ b/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.
@@ -38,16 +39,26 @@ def http(host, path, method="GET", body=None, headers=None):
return e.code, e.headers, e.read()
-def upload(host, path, headers=None, with_file=True):
- """Posts a small file that isn't a backup or an image, or a form without a file."""
+def auth(token):
+ """The header that carries the token, if there is one."""
+ return {"apikey": token} if token else {}
+
+
+def upload(host, path, headers=None, file=b"\0" * 256, fields=None):
+ """Posts a form as the web UI does: the file, then the fields.
+
+ The file is by default a small one that isn't a backup or an image, and
+ file=None leaves it out.
+ """
boundary = "e2e-upload"
- if with_file:
- part = (
+ parts = []
+ if file is not None:
+ parts.append(
f"--{boundary}\r\nContent-Disposition: form-data; name=\"file\"; filename=\"e2e.bin\"\r\n"
- "Content-Type: application/octet-stream\r\n\r\n").encode() + b"\0" * 256
- else:
- part = f"--{boundary}\r\nContent-Disposition: form-data; name=\"e2e\"\r\n\r\n1".encode()
- body = part + f"\r\n--{boundary}--\r\n".encode()
+ "Content-Type: application/octet-stream\r\n\r\n".encode() + file)
+ for name, value in (fields or {}).items():
+ parts.append(f"--{boundary}\r\nContent-Disposition: form-data; name=\"{name}\"\r\n\r\n{value}".encode())
+ body = b"\r\n".join(parts) + f"\r\n--{boundary}--\r\n".encode()
return http(host, path, "POST", body, {"Content-Type": f"multipart/form-data; boundary={boundary}", **(headers or {})})
@@ -90,7 +101,7 @@ def test_secured_refuses_a_web_asset_name_below_a_route(host, secured, method, p
def test_secured_accepts_the_token_on_a_route(host, secured, token):
if not secured:
pytest.skip("the device's security is None")
- status, _, _ = http(host, "/backup", headers={"apikey": token})
+ status, _, _ = http(host, "/backup", headers=auth(token))
assert status == 200
@@ -104,7 +115,7 @@ def test_secured_refuses_an_upload_without_a_token(host, secured, path):
def restore_without_a_file(host, token):
- status, _, body = upload(host, "/restore", {"apikey": token}, with_file=False)
+ status, _, body = upload(host, "/restore", auth(token), file=None, fields={"e2e": "1"})
return status, json.loads(body or b"{}").get("desc", "")
@@ -159,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"
diff --git a/test/e2e/test_settings.py b/test/e2e/test_settings.py
index 414cdeb..7f06154 100644
--- a/test/e2e/test_settings.py
+++ b/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]
@@ -123,6 +122,11 @@ def test_reboot(request, host, token, connect, schema):
uptime_before = uptime(schema, frames)
assert is_ok(schema, op(c, schema, "reboot", {}))
assert c.closed.wait(15), "the socket stayed open"
+ wait_for_restart(host, token, schema, uptime_before)
+
+
+def wait_for_restart(host, token, schema, uptime_before):
+ """Waits until the device is back, and checks it restarted."""
# The device closes its sockets just before it restarts, and may still
# take a connection in between: that one never gets its hello.
time.sleep(3)
@@ -147,6 +151,12 @@ def test_reboot(request, host, token, connect, schema):
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"]
diff --git a/test/js/model.test.js b/test/js/model.test.js
index 3d8cd4e..cf58bad 100644
--- a/test/js/model.test.js
+++ b/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);
diff --git a/test/test_proto/test_proto.cpp b/test/test_proto/test_proto.cpp
index 17f2259..f548966 100644
--- a/test/test_proto/test_proto.cpp
+++ b/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);