fix!: Rework OTA

lib/extension/otaUpdate.ts

@@ -1,12 +1,13 @@
+import type {Ota} from 'zigbee-herdsman-converters';
+
 import assert from 'assert';
 import path from 'path';
 
 import bind from 'bind-decorator';
 import stringify from 'json-stable-stringify-without-jsonify';
-import * as URI from 'uri-js';
 
 import {Zcl} from 'zigbee-herdsman';
-import * as zhc from 'zigbee-herdsman-converters';
+import {ota} from 'zigbee-herdsman-converters';
 
 import Device from '../model/device';
 import dataDir from '../util/data';
@@ -15,17 +16,6 @@
 import utils from '../util/utils';
 import Extension from './extension';
 
-function isValidUrl(url: string): boolean {
-    let parsed;
-    try {
-        parsed = URI.parse(url);
-    } catch {
-        // istanbul ignore next
-        return false;
-    }
-    return parsed.scheme === 'http' || parsed.scheme === 'https';
-}
-
 type UpdateState = 'updating' | 'idle' | 'available';
 interface UpdatePayload {
     update: {
@@ -37,7 +27,7 @@
     };
 }
 
-const topicRegex = new RegExp(`^${settings.get().mqtt.base_topic}/bridge/request/device/ota_update/(update|check)`, 'i');
+const topicRegex = new RegExp(`^${settings.get().mqtt.base_topic}/bridge/request/device/ota_update/(update|check)/?(downgrade)?`, 'i');
 
 export default class OTAUpdate extends Extension {
     private inProgress = new Set();
@@ -46,23 +36,24 @@
     override async start(): Promise<void> {
         this.eventBus.onMQTTMessage(this, this.onMQTTMessage);
         this.eventBus.onDeviceMessage(this, this.onZigbeeEvent);
-        if (settings.get().ota.ikea_ota_use_test_url) {
-            zhc.ota.tradfri.useTestURL();
-        }
 
-        // Let zigbeeOTA module know if the override index file is provided
-        let overrideOTAIndex = settings.get().ota.zigbee_ota_override_index_location;
-        if (overrideOTAIndex) {
-            // If the file name is not a full path, then treat it as a relative to the data directory
-            if (!isValidUrl(overrideOTAIndex) && !path.isAbsolute(overrideOTAIndex)) {
-                overrideOTAIndex = dataDir.joinPath(overrideOTAIndex);
-            }
+        const otaSettings = settings.get().ota;
+        // Let OTA module know if the override index file is provided
+        let overrideIndexLocation = otaSettings.zigbee_ota_override_index_location;
 
-            zhc.ota.zigbeeOTA.useIndexOverride(overrideOTAIndex);
+        // If the file name is not a full path, then treat it as a relative to the data directory
+        if (overrideIndexLocation && !ota.isValidUrl(overrideIndexLocation) && !path.isAbsolute(overrideIndexLocation)) {
+            overrideIndexLocation = dataDir.joinPath(overrideIndexLocation);
         }
 
         // In order to support local firmware files we need to let zigbeeOTA know where the data directory is
-        zhc.ota.setDataDir(dataDir.getPath());
+        ota.setConfiguration({
+            dataDir: dataDir.getPath(),
+            overrideIndexLocation,
+            // TODO: implement me
+            imageBlockResponseDelay: otaSettings.image_block_response_delay,
+            defaultMaximumDataSize: otaSettings.default_maximum_data_size,
+        });
 
         // In case Zigbee2MQTT is restared during an update, progress and remaining values are still in state, remove them.
         for (const device of this.zigbee.devicesIterator(utils.deviceNotCoordinator)) {
@@ -102,10 +93,11 @@
             if (!check) return;
 
             this.lastChecked[data.device.ieeeAddr] = Date.now();
-            let availableResult: zhc.OtaUpdateAvailableResult | undefined;
+            let availableResult: Ota.UpdateAvailableResult | undefined;
 
             try {
-                availableResult = await data.device.definition.ota.isUpdateAvailable(data.device.zh, data.data as zhc.ota.ImageInfo);
+                // never use 'previous' when responding to device request
+                availableResult = await ota.isUpdateAvailable(data.device.zh, data.device.otaExtraMetas, data.data as Ota.ImageInfo, false);
             } catch (error) {
                 logger.debug(`Failed to check if update available for '${data.device.name}' (${error})`);
             }
@@ -146,14 +138,14 @@
 
     private getEntityPublishPayload(
         device: Device,
-        state: zhc.OtaUpdateAvailableResult | UpdateState,
+        state: Ota.UpdateAvailableResult | UpdateState,
         progress?: number,
         remaining?: number,
     ): UpdatePayload {
         const deviceUpdateState = this.state.get(device).update;
         const payload: UpdatePayload = {
             update: {
                 state: typeof state === 'string' ? state : state.available ? 'available' : 'idle',
                 installed_version: typeof state === 'string' ? deviceUpdateState?.installed_version : state.currentFileVersion,
                 latest_version: typeof state === 'string' ? deviceUpdateState?.latest_version : state.otaFileVersion,
             },
@@ -171,14 +163,17 @@
     }
 
     @bind async onMQTTMessage(data: eventdata.MQTTMessage): Promise<void> {
-        if (!data.topic.match(topicRegex)) {
+        const topicMatch = data.topic.match(topicRegex);
+
+        if (!topicMatch) {
             return;
         }
 
         const message = utils.parseJSON(data.message, data.message);
         const ID = (typeof message === 'object' && message['id'] !== undefined ? message.id : message) as string;
         const device = this.zigbee.resolveEntity(ID);
-        const type = data.topic.substring(data.topic.lastIndexOf('/') + 1);
+        const type = topicMatch[1];
+        const downgrade = Boolean(topicMatch[2]);
         const responseData: {id: string; update_available?: boolean; from?: KeyValue | null; to?: KeyValue | null} = {id: ID};
         let error: string | undefined;
         let errorStack: string | undefined;
@@ -197,7 +192,7 @@
                 logger.info(msg);
 
                 try {
-                    const availableResult = await device.definition.ota.isUpdateAvailable(device.zh, undefined);
+                    const availableResult = await ota.isUpdateAvailable(device.zh, device.otaExtraMetas, undefined, downgrade);
                     const msg = `${availableResult.available ? 'Update' : 'No update'} available for '${device.name}'`;
                     logger.info(msg);
 
@@ -210,11 +205,12 @@
                 }
             } else {
                 // type === 'update'
-                const msg = `Updating '${device.name}' to latest firmware`;
+                const msg = `Updating '${device.name}' to ${downgrade ? 'previous' : 'latest'} firmware`;
                 logger.info(msg);
 
                 try {
-                    const onProgress = async (progress: number, remaining: number | null): Promise<void> => {
+                    const from_ = await this.readSoftwareBuildIDAndDateCode(device, 'immediate');
+                    const fileVersion = await ota.update(device.zh, device.otaExtraMetas, downgrade, async (progress, remaining) => {
                         let msg = `Update of '${device.name}' at ${progress.toFixed(2)}%`;
                         if (remaining) {
                             msg += `, ≈ ${Math.round(remaining / 60)} minutes remaining`;
@@ -223,10 +219,7 @@
                         logger.info(msg);
 
                         await this.publishEntityState(device, this.getEntityPublishPayload(device, 'updating', progress, remaining ?? undefined));
-                    };
-
-                    const from_ = await this.readSoftwareBuildIDAndDateCode(device, 'immediate');
-                    const fileVersion = await device.definition.ota.updateToLatest(device.zh, onProgress);
+                    });
                     logger.info(`Finished update of '${device.name}'`);
                     this.removeProgressAndRemainingFromState(device);
                     await this.publishEntityState(

lib/model/device.ts

@@ -29,6 +29,9 @@
     get customClusters(): CustomClusters {
         return this.zh.customClusters;
     }
+    get otaExtraMetas(): zhc.Ota.ExtraMetas {
+        return typeof this.definition?.ota === 'object' ? this.definition.ota : {};
+    }
 
     constructor(device: zh.Device) {
         this.zh = device;

lib/types/types.d.ts

@@ -173,7 +173,8 @@ declare global {
             update_check_interval: number;
             disable_automatic_update_check: boolean;
             zigbee_ota_override_index_location?: string;
-            ikea_ota_use_test_url?: boolean;
+            image_block_response_delay?: number;
+            default_maximum_data_size?: number;
         };
         frontend?: {
             auth_token?: string;

lib/util/settings.schema.json

@@ -337,19 +337,29 @@
                     "description": "Zigbee devices may request a firmware update, and do so frequently, causing Zigbee2MQTT to reach out to third party servers. If you disable these device initiated checks, you can still initiate a firmware update check manually.",
                     "default": false
                 },
-                "ikea_ota_use_test_url": {
-                    "type": "boolean",
-                    "title": "IKEA TRADFRI OTA use test url",
-                    "requiresRestart": true,
-                    "description": "Use IKEA TRADFRI OTA test server, see OTA updates documentation",
-                    "default": false
-                },
                 "zigbee_ota_override_index_location": {
                     "type": ["string", "null"],
                     "title": "OTA index override file name",
                     "requiresRestart": true,
                     "description": "Location of override OTA index file",
                     "examples": ["index.json"]
+                },
+                "image_block_response_delay": {
+                    "type": "number",
+                    "title": "Image block response delay",
+                    "description": "Limits the rate of requests during OTA updates to reduce network congestion. You can increase this value if your network appears unstable during OTA.",
+                    "default": 250,
+                    "minimum": 50,
+                    "requiresRestart": true
+                },
+                "default_maximum_data_size": {
+                    "type": "number",
+                    "title": "Default maximum data size",
+                    "description": "The size of file chunks sent during an update. Note: This value may get ignored for manufacturers that require specific values.",
+                    "default": 50,
+                    "minimum": 10,
+                    "maximum": 100,
+                    "requiresRestart": true
                 }
             }
         },
@@ -757,13 +767,6 @@
                     "title": "RTS / CTS (deprecated)",
                     "requiresRestart": true,
                     "description": "RTS / CTS Hardware Flow Control for serial port"
-                },
-                "ikea_ota_use_test_url": {
-                    "type": "boolean",
-                    "title": "IKEA TRADFRI OTA use test url (deprecated)",
-                    "requiresRestart": true,
-                    "description": "Use IKEA TRADFRI OTA test server, see OTA updates documentation",
-                    "default": false
                 }
             }
         },

lib/util/settings.ts

@@ -21,7 +21,6 @@ objectAssignDeep(schema, schemaJson);
     delete schema.properties.advanced.properties.homeassistant_status_topic;
     delete schema.properties.advanced.properties.baudrate;
     delete schema.properties.advanced.properties.rtscts;
-    delete schema.properties.advanced.properties.ikea_ota_use_test_url;
     delete schema.properties.experimental;
     delete (schemaJson as KeyValue).properties.whitelist;
     delete (schemaJson as KeyValue).properties.ban;
@@ -77,6 +76,8 @@ const defaults: RecursivePartial<Settings> = {
     ota: {
         update_check_interval: 24 * 60,
         disable_automatic_update_check: false,
+        image_block_response_delay: 250,
+        default_maximum_data_size: 50,
     },
     device_options: {},
     advanced: {
@@ -184,12 +185,6 @@ function loadSettingsWithDefaults(): void {
         _settingsWithDefaults.serial.rtscts = _settings.advanced.rtscts;
     }
 
-    // @ts-expect-error ignore typing
-    if (_settings.advanced?.ikea_ota_use_test_url !== undefined && _settings.ota?.ikea_ota_use_test_url == null) {
-        // @ts-expect-error ignore typing
-        _settingsWithDefaults.ota.ikea_ota_use_test_url = _settings.advanced.ikea_ota_use_test_url;
-    }
-
     // @ts-expect-error ignore typing
     if (_settings.experimental?.transmit_power !== undefined && _settings.advanced?.transmit_power == null) {
         // @ts-expect-error ignore typing

test/extensions/bridge.test.ts

@@ -203,7 +203,12 @@ describe('Extension: Bridge', () => {
                         },
                     },
                     mqtt: {base_topic: 'zigbee2mqtt', force_disable_retain: false, include_device_information: false, server: 'mqtt://localhost'},
-                    ota: {disable_automatic_update_check: false, update_check_interval: 1440},
+                    ota: {
+                        disable_automatic_update_check: false,
+                        update_check_interval: 1440,
+                        image_block_response_delay: 250,
+                        default_maximum_data_size: 50,
+                    },
                     passlist: [],
                     serial: {disable_led: false, port: '/dev/dummy'},
                 },