Merge pull request #483 from PlayerData/bootloader-info

feat: Add bootloader info

Author: ball-hayden

example/src/app/_layout.tsx

@@ -15,9 +15,10 @@ const RootLayout = () => {
   return (
     <SelectedDeviceProvider value={{ selectedDevice, setSelectedDevice }}>
       <Tabs>
+        <Tabs.Screen name="(home)" options={{ title: 'Home' }} />
         <Tabs.Screen
-          name="(home)"
-          options={{ title: 'Home' }}
+          name="bootloader_info"
+          options={{ title: 'Bootloader Info' }}
         />
         <Tabs.Screen name="update" options={{ title: 'Update' }} />
       </Tabs>

example/src/app/bootloader_info.tsx

@@ -0,0 +1,82 @@
+import {
+  BootloaderInfo,
+  bootloaderInfo as rnmcumgrBootloaderInfo,
+} from '@playerdata/react-native-mcu-manager';
+
+import React, { useCallback, useState } from 'react';
+import {
+  Button,
+  SafeAreaView,
+  ScrollView,
+  StyleSheet,
+  Text,
+  View,
+} from 'react-native';
+
+import { useSelectedDevice } from '../context/selectedDevice';
+
+const styles = StyleSheet.create({
+  root: {
+    padding: 16,
+  },
+
+  block: {
+    marginBottom: 16,
+  },
+});
+
+const BootloaderInfoView = () => {
+  const { selectedDevice } = useSelectedDevice();
+
+  const [fetchInProgress, setFetchInProgress] = useState(false);
+  const [error, setError] = useState<string | null>(null);
+  const [bootloaderInfo, setBootloaderInfo] = useState<BootloaderInfo | null>(
+    null
+  );
+
+  const fetchBootloaderInfo = useCallback(async () => {
+    setError(null);
+    setFetchInProgress(true);
+
+    try {
+      setBootloaderInfo(
+        await rnmcumgrBootloaderInfo(selectedDevice?.deviceId || '')
+      );
+    } catch (error: unknown) {
+      const errorMessage =
+        error instanceof Error ? error.message : 'Unknown error';
+
+      setError(errorMessage);
+    } finally {
+      setFetchInProgress(false);
+    }
+  }, [selectedDevice]);
+
+  return (
+    <SafeAreaView>
+      <ScrollView contentContainerStyle={styles.root}>
+        <View style={styles.block}>
+          <Button
+            disabled={fetchInProgress}
+            onPress={() => fetchBootloaderInfo()}
+            title="Fetch Bootloader Info"
+          />
+        </View>
+
+        {error && (
+          <View style={styles.block}>
+            <Text style={{ color: 'red' }}>{error}</Text>
+          </View>
+        )}
+
+        {bootloaderInfo && (
+          <View style={styles.block}>
+            <Text>{JSON.stringify(bootloaderInfo)}</Text>
+          </View>
+        )}
+      </ScrollView>
+    </SafeAreaView>
+  );
+};
+
+export default BootloaderInfoView;

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

@@ -1,6 +1,5 @@
 package uk.co.playerdata.reactnativemcumanager
 
-import android.bluetooth.BluetoothAdapter
 import android.bluetooth.BluetoothDevice
 import android.bluetooth.BluetoothManager
 import android.content.Context
@@ -14,7 +13,9 @@ import expo.modules.kotlin.modules.ModuleDefinition
 import expo.modules.kotlin.records.Field
 import expo.modules.kotlin.records.Record
 import io.runtime.mcumgr.McuMgrCallback
+import io.runtime.mcumgr.McuMgrErrorCode
 import io.runtime.mcumgr.ble.McuMgrBleTransport
+import io.runtime.mcumgr.exception.McuMgrErrorException
 import io.runtime.mcumgr.exception.McuMgrException
 import io.runtime.mcumgr.managers.DefaultManager
 import io.runtime.mcumgr.managers.ImageManager
@@ -29,7 +30,15 @@ class UpdateOptions : Record {
   @Field val upgradeMode: Int? = null
 }
 
+class BootloaderInfo : Record {
+  @Field var bootloader: String? = null
+  @Field var mode: Int? = null
+  @Field var noDowngrade: Boolean = false
+}
+
 class ReactNativeMcuManagerModule() : Module() {
+  private val MCUBOOT = "MCUboot"
+
   private val upgrades: MutableMap<String, DeviceUpgrade> = mutableMapOf()
   private val context
     get() = requireNotNull(appContext.reactContext) { "React Application Context is null" }
@@ -44,6 +53,41 @@ class ReactNativeMcuManagerModule() : Module() {
   override fun definition() = ModuleDefinition {
     Name(MODULE_NAME)
 
+    AsyncFunction("bootloaderInfo") { macAddress: String?, promise: Promise ->
+      val device: BluetoothDevice = getBluetoothDevice(macAddress)
+
+      val transport = McuMgrBleTransport(context, device)
+      transport.connect(device).timeout(60000).await()
+
+      val manager = DefaultManager(transport)
+      val info = BootloaderInfo()
+
+      try {
+        val nameResult = manager.bootloaderInfo(DefaultManager.BOOTLOADER_INFO_QUERY_BOOTLOADER)
+        info.bootloader = nameResult.bootloader
+      } catch(ex: McuMgrErrorException) {
+        transport.release()
+
+        // For consistency with iOS, if the error code is 8 (MGMT_ERR_ENOTSUP), return null
+        if (ex.code == McuMgrErrorCode.NOT_SUPPORTED) {
+          promise.resolve(info)
+          return@AsyncFunction
+        }
+
+        throw ex;
+      }
+
+      if (info.bootloader == MCUBOOT) {
+        val mcuMgrResult = manager.bootloaderInfo(DefaultManager.BOOTLOADER_INFO_MCUBOOT_QUERY_MODE)
+
+        info.mode = mcuMgrResult.mode
+        info.noDowngrade = mcuMgrResult.noDowngrade
+      }
+
+      transport.release()
+      promise.resolve(info)
+    }
+
     AsyncFunction("eraseImage") { macAddress: String?, promise: Promise ->
       try {
         val device: BluetoothDevice = getBluetoothDevice(macAddress)

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

@@ -0,0 +1,7 @@
+import ExpoModulesCore
+
+struct BootloaderInfo: Record {
+    @Field var bootloader: String?
+    @Field var mode: Int?
+    @Field var noDowngrade: Bool?
+}

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

@@ -12,6 +12,61 @@ public class ReactNativeMcuManagerModule: Module {
   public func definition() -> ModuleDefinition {
     Name(MODULE_NAME)
 
+    AsyncFunction("bootloaderInfo") { (bleId: String, promise: Promise) in
+      guard let bleUuid = UUID(uuidString: bleId) else {
+        promise.reject(Exception(name: "UUIDParseError", description: "Failed to parse UUID"))
+        return
+      }
+
+      let bleTransport = McuMgrBleTransport(bleUuid)
+      let manager = DefaultManager(transport: bleTransport)
+
+      manager.bootloaderInfo(query: DefaultManager.BootloaderInfoQuery.name) { (nameResponse: BootloaderInfoResponse?, err: Error?) in
+        if err != nil {
+          bleTransport.close()
+          promise.reject(Exception(name: "BootloaderInfoError", description: err!.localizedDescription))
+          return
+        }
+
+        guard let nameResponse = nameResponse else {
+          bleTransport.close()
+          promise.reject(Exception(name: "BootloaderInfoError", description: "Bootloader name response null, but no error occurred?"))
+          return
+        }
+
+        let info = BootloaderInfo()
+        info.bootloader = nameResponse.bootloader?.description
+
+        if nameResponse.bootloader != BootloaderInfoResponse.Bootloader.mcuboot {
+          info.mode = nameResponse.mode?.rawValue
+          info.noDowngrade = nameResponse.noDowngrade
+
+          bleTransport.close()
+          promise.resolve(info)
+          return
+        }
+
+        manager.bootloaderInfo(query: DefaultManager.BootloaderInfoQuery.mode) { (mcubootResponse: BootloaderInfoResponse?, err: Error?) in
+          bleTransport.close()
+
+          if err != nil {
+              promise.reject(Exception(name: "BootloaderInfoError", description: err!.localizedDescription))
+              return
+          }
+
+          guard let mcubootResponse = mcubootResponse else {
+              promise.reject(Exception(name: "BootloaderInfoError", description: "MCUboot response null, but no error occurred?"))
+              return
+          }
+
+          info.mode = mcubootResponse.mode?.rawValue
+          info.noDowngrade = mcubootResponse.noDowngrade
+
+          promise.resolve(info)
+        }
+      }
+    }
+
     AsyncFunction("eraseImage") { (bleId: String, promise: Promise) in
       guard let bleUuid = UUID(uuidString: bleId) else {
         promise.reject(Exception(name: "UUIDParseError", description: "Failed to parse UUID"))

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

@@ -13,6 +13,13 @@ export enum UpgradeFileType {
 }
 
 export enum UpgradeMode {
+  /**
+   * When this flag is set, the manager will immediately send the reset command after
+   * the upload is complete. The device will reboot and will run the new image on its next
+   * boot.
+   */
+  NONE = 0,
+
   /**
    * This mode is the default and recommended mode for performing upgrades due to it's ability to
    * recover from a bad firmware upgrade. The process for this mode is upload, test, reset, confirm.

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

@@ -0,0 +1,22 @@
+import McuManagerModule from './ReactNativeMcuManagerModule';
+
+export enum MCUBootMode {
+  MCUBOOT_MODE_SINGLE_SLOT = 0,
+  MCUBOOT_MODE_SWAP_USING_SCRATCH = 1,
+  MCUBOOT_MODE_UPGRADE_ONLY = 2,
+  MCUBOOT_MODE_SWAP_USING_MOVE = 3,
+  MCUBOOT_MODE_DIRECT_XIP = 4,
+  MCUBOOT_MODE_DIRECT_XIP_WITH_REVERT = 5,
+  MCUBOOT_MODE_RAM_LOAD = 6,
+  MCUBOOT_MODE_FIRMWARE_LOADER = 7,
+}
+
+export interface BootloaderInfo {
+  bootloader: string | null;
+  mode: MCUBootMode | null;
+  noDowngrade: boolean;
+}
+
+export const bootloaderInfo = McuManagerModule?.bootloaderInfo as (
+  bleId: string
+) => Promise<BootloaderInfo>;

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

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