Merge pull request #435 from PlayerData/explicit-zip

feat: Explicitly set either bin or zip upgrade file

Author: ball-hayden

example/package.json

@@ -16,7 +16,7 @@
     "expo-document-picker": "13.0.1",
     "expo-splash-screen": "0.29.18",
     "lodash": "4.17.21",
-    "react": "19.0.0",
+    "react": "18.3.1",
     "react-native": "0.76.3",
     "react-native-ble-plx": "3.2.1",
     "react-native-toast-message": "2.2.1"

example/src/App.tsx

@@ -1,4 +1,7 @@
-import { UpgradeMode } from '@playerdata/react-native-mcu-manager';
+import {
+  UpgradeFileType,
+  UpgradeMode,
+} from '@playerdata/react-native-mcu-manager';
 
 import React, { useState } from 'react';
 import {
@@ -36,6 +39,9 @@ export default function App() {
   const [selectedDeviceName, setSelectedDeviceName] = useState<string | null>(
     null
   );
+  const [fileType, setFileType] = useState<UpgradeFileType>(
+    UpgradeFileType.BIN
+  );
   const [upgradeMode, setUpgradeMode] = useState<UpgradeMode | undefined>(
     undefined
   );
@@ -45,6 +51,7 @@ export default function App() {
   const { cancelUpdate, runUpdate, progress, state } = useFirmwareUpdate(
     selectedDeviceId,
     selectedFile?.uri || null,
+    fileType,
     upgradeMode
   );
 
@@ -98,6 +105,21 @@ export default function App() {
           <Button onPress={() => pickFile()} title="Pick File" />
         </View>
 
+        <Text style={styles.block}>Step 2a - Select Update File Type</Text>
+
+        <View style={styles.block}>
+          <Button
+            disabled={fileType === UpgradeFileType.BIN}
+            title="BIN"
+            onPress={() => setFileType(UpgradeFileType.BIN)}
+          />
+          <Button
+            disabled={fileType === UpgradeFileType.ZIP}
+            title="ZIP"
+            onPress={() => setFileType(UpgradeFileType.ZIP)}
+          />
+        </View>
+
         <Text style={styles.block}>Step 3 - Upgrade Mode</Text>
 
         <View style={styles.block}>

example/src/useFirmwareUpdate.ts

@@ -1,9 +1,14 @@
-import { Upgrade, UpgradeMode } from '@playerdata/react-native-mcu-manager';
+import {
+  Upgrade,
+  UpgradeMode,
+  UpgradeFileType,
+} from '@playerdata/react-native-mcu-manager';
 import { useState, useEffect, useRef } from 'react';
 
 const useFirmwareUpdate = (
   bleId: string | null,
   updateFileUri: string | null,
+  upgradeFileType: UpgradeFileType,
   upgradeMode?: UpgradeMode
 ) => {
   const [progress, setProgress] = useState(0);
@@ -21,6 +26,7 @@ const useFirmwareUpdate = (
       {
         estimatedSwapTime: 60,
         upgradeMode,
+        upgradeFileType,
       },
       setProgress,
       setState
@@ -32,7 +38,7 @@ const useFirmwareUpdate = (
       upgrade.cancel();
       upgrade.destroy();
     };
-  }, [bleId, updateFileUri, upgradeMode]);
+  }, [bleId, upgradeFileType, updateFileUri, upgradeMode]);
 
   const runUpdate = async (): Promise<void> => {
     try {
@@ -41,7 +47,7 @@ const useFirmwareUpdate = (
       }
 
       await upgradeRef.current.runUpgrade();
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
     } catch (ex: any) {
       setState(ex.message);
     }

pnpm-lock.yaml

@@ -15,7 +15,6 @@ import io.runtime.mcumgr.dfu.mcuboot.model.ImageSet
 import io.runtime.mcumgr.exception.McuMgrException
 import io.runtime.mcumgr.image.McuMgrImage
 import java.io.IOException
-import android.webkit.MimeTypeMap
 
 val UpgradeModes =
         mapOf(
@@ -24,8 +23,17 @@ val UpgradeModes =
                 3 to FirmwareUpgradeManager.Mode.TEST_ONLY
         )
 
+enum class UpgradeFileType {
+    BIN,
+    ZIP,
+}
+
+val UpgradeFileTypes = mapOf(
+    0 to UpgradeFileType.BIN,
+    1 to UpgradeFileType.ZIP,
+)
+
 class DeviceUpgrade(
-        private val id: String,
         device: BluetoothDevice,
         private val context: Context,
         private val updateFileUri: Uri,
@@ -72,15 +80,12 @@ class DeviceUpgrade(
         return inputStream.use { it.readBytes() }
     }
 
-    private fun extractImagesFrom(updateBundleUri: Uri): ImageSet {
-        val fileExtension = MimeTypeMap.getFileExtensionFromUrl(updateBundleUri.toString())
-        val mimeType = MimeTypeMap.getSingleton().getMimeTypeFromExtension(fileExtension)
+    private fun extractImagesFrom(updateBundleUri: Uri, upgradeFileType: UpgradeFileType): ImageSet {
         val binData = uriToByteArray(updateBundleUri) ?: throw IOException("Failed to read update file")
 
-        if (mimeType == "application/zip") {
-            return extractImagesFromZipFile(binData)
-        } else {
-            return extractImagesFromBinFile(binData)
+        return when (upgradeFileType) {
+            UpgradeFileType.BIN -> extractImagesFromBinFile(binData)
+            UpgradeFileType.ZIP -> extractImagesFromZipFile(binData)
         }
     }
 
@@ -95,18 +100,19 @@ class DeviceUpgrade(
     }
 
     private fun extractImagesFromZipFile(zipData: ByteArray): ImageSet {
-        return ZipPackage(zipData).getBinaries();
+        return ZipPackage(zipData).getBinaries()
     }
 
     private fun doUpdate(updateBundleUri: Uri) {
         val estimatedSwapTime = updateOptions.estimatedSwapTime * 1000
         val modeInt = updateOptions.upgradeMode ?: 1
+        val upgradeFileType = UpgradeFileTypes[updateOptions.upgradeFileType] ?: UpgradeFileType.BIN
         val upgradeMode = UpgradeModes[modeInt] ?: FirmwareUpgradeManager.Mode.TEST_AND_CONFIRM
 
         val settings = Settings.Builder().setEstimatedSwapTime(estimatedSwapTime).build()
 
         try {
-            val images = extractImagesFrom(updateBundleUri)
+            val images = extractImagesFrom(updateBundleUri, upgradeFileType)
 
             dfuManager.setMode(upgradeMode)
             dfuManager.start(images, settings)

react-native-mcu-manager/android/src/main/java/uk/co/playerdata/reactnativemcumanager/DeviceUpgrade.kt

@@ -20,6 +20,7 @@ private val TAG = "McuManagerModule"
 
 class UpdateOptions : Record {
   @Field val estimatedSwapTime: Int = 0
+  @Field val upgradeFileType: Int = 0
   @Field val upgradeMode: Int? = null
 }
 
@@ -71,7 +72,6 @@ class ReactNativeMcuManagerModule : Module() {
       val updateFileUri = Uri.parse(updateFileUriString)
 
       val upgrade = DeviceUpgrade(
-          id,
           device,
           context,
           updateFileUri,

react-native-mcu-manager/android/src/main/java/uk/co/playerdata/reactnativemcumanager/ReactNativeMcuManagerModule.kt

@@ -7,6 +7,11 @@ enum JSUpgradeMode: Int {
   case TEST_ONLY = 3
 }
 
+enum UpgradeFileType: Int {
+  case BIN = 0
+  case ZIP = 1
+}
+
 class DeviceUpgrade {
   private let id: String
 
@@ -39,14 +44,12 @@ class DeviceUpgrade {
     self.logDelegate = UpdateLogDelegate()
   }
 
-  func extractImageFrom(from url: URL) throws -> [ImageManager.Image] {
-    switch url.pathExtension.lowercased() {
-    case "bin":
+  func extractImageFrom(from url: URL, upgradeFileType: UpgradeFileType) throws -> [ImageManager.Image] {
+    switch upgradeFileType {
+    case UpgradeFileType.BIN:
       return try extractImageFromBinFile(from: url)
-    case "zip":
+    case UpgradeFileType.ZIP:
       return try extractImageFromZipFile(from: url)
-    default:
-      throw Exception(name: "UnsupportedFileType", description: "File must be .bin or .zip")
     }
   }
 
@@ -102,7 +105,9 @@ class DeviceUpgrade {
     }
 
     do {
-      let images = try extractImageFrom(from: fileUrl)
+      let images = try extractImageFrom(
+        from: fileUrl, upgradeFileType: UpgradeFileType(rawValue: self.options.upgradeFileType)!
+      )
 
       self.bleTransport = McuMgrBleTransport(bleUuid)
       self.dfuManager = FirmwareUpgradeManager(transport: self.bleTransport!, delegate: self)

react-native-mcu-manager/ios/DeviceUpgrade.swift

@@ -1,6 +1,7 @@
 import ExpoModulesCore
 
 struct UpdateOptions: Record {
-  @Field var estimatedSwapTime: TimeInterval = 0
-  @Field var upgradeMode: Int?
+    @Field var estimatedSwapTime: TimeInterval = 0
+    @Field var upgradeFileType: Int = 0
+    @Field var upgradeMode: Int?
 }

react-native-mcu-manager/ios/UpdateOptions.swift

@@ -1,5 +1,17 @@
 import ReactNativeMcuManager from './ReactNativeMcuManagerModule';
 
+export enum UpgradeFileType {
+  /**
+   * A single binary update image.
+   */
+  BIN = 0,
+
+  /**
+   * A zip file containing a manifest.json file that describes the contents of the zip file.
+   */
+  ZIP = 1,
+}
+
 export enum UpgradeMode {
   /**
    * This mode is the default and recommended mode for performing upgrades due to it's ability to
@@ -26,6 +38,11 @@ export interface UpgradeOptions {
    */
   estimatedSwapTime: number;
 
+  /**
+   * The type of firmware update file.
+   */
+  upgradeFileType: UpgradeFileType;
+
   /**
    * McuManager firmware upgrades can actually be performed in few different ways.
    * These different upgrade modes determine the commands sent after the upload step.

react-native-mcu-manager/src/Upgrade.ts

@@ -1,10 +1,10 @@
 import McuManagerModule from './ReactNativeMcuManagerModule';
 import type { FirmwareUpgradeState, UpgradeOptions } from './Upgrade';
-import Upgrade, { UpgradeMode } from './Upgrade';
+import Upgrade, { UpgradeMode, UpgradeFileType } from './Upgrade';
 
 export const eraseImage = McuManagerModule?.eraseImage as (
   bleId: string
 ) => Promise<void>;
 
-export { Upgrade, UpgradeMode };
+export { Upgrade, UpgradeMode, UpgradeFileType };
 export type { FirmwareUpgradeState, UpgradeOptions };