Flutter北欧芯片固件更新插件flutter_nordic_dfu的使用

Flutter北欧芯片固件更新插件flutter_nordic_dfu的使用

简介

flutter-nordic-dfu 是一个用于通过Flutter应用程序对Nordic Semiconductor的nRF51或nRF52芯片进行设备固件更新（DFU）的库。它支持Android和iOS平台，可以方便地集成到你的Flutter项目中。

示例项目

要运行示例项目，请按照以下步骤操作：

1. 添加DFU文件：将你的DFU ZIP文件添加到 example/assets/file.zip。
2. 运行示例项目：在终端中运行 flutter run 启动示例项目。
3. 扫描设备：应用程序会自动扫描附近的蓝牙设备。
4. 开始DFU：选择一个设备并点击“Start Dfu”按钮开始固件更新。

使用方法

startDFU

startDFU 方法用于启动固件更新过程。你可以传递绝对文件路径或资产文件路径给 FlutterNordicDfu。

使用绝对文件路径

/// 你可以定义自己的ProgressListener
await FlutterNordicDfu.startDfu(
  'EB:75:AD:E3:CA:CF', '/file/to/zip/path/file.zip',
  progressListener: ProgressListenerListener(),
);

class ProgressListenerListener extends DfuProgressListenerAdapter {
  [@override](/user/override)
  void onProgressChanged(String deviceAddress, int percent, double speed, double avgSpeed, int currentPart, int partsTotal) {
    super.onProgressChanged(deviceAddress, percent, speed, avgSpeed, currentPart, partsTotal);
    print('deviceAddress: $deviceAddress, percent: $percent');
  }
}

/// 或者你可以使用DefaultDfuProgressListenerAdapter
await FlutterNordicDfu.startDfu(
  'EB:75:AD:E3:CA:CF',
  'assets/file.zip',
  fileInAsset: true,
  progressListener: DefaultDfuProgressListenerAdapter(onProgressChangedHandle: (
    deviceAddress,
    percent,
    speed,
    avgSpeed,
    currentPart,
    partsTotal,
  ) {
    print('deviceAddress: $deviceAddress, percent: $percent');
  }),
);

使用资产文件路径

/// 只需设置 [fileInAsset] 为 true
await FlutterNordicDfu.startDfu(
  'EB:75:AD:E3:CA:CF', 'assets/file.zip',
  progressListener: ProgressListenerListener(),
  fileInAsset: true,
);

class ProgressListenerListener extends DfuProgressListenerAdapter {
  [@override](/user/override)
  void onProgressChanged(String deviceAddress, int percent, double speed, double avgSpeed, int currentPart, int partsTotal) {
    super.onProgressChanged(deviceAddress, percent, speed, avgSpeed, currentPart, partsTotal);
    print('deviceAddress: $deviceAddress, percent: $percent');
  }
}

完整示例Demo

以下是一个完整的示例项目代码，展示了如何使用 flutter_nordic_dfu 插件进行固件更新。

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:flutter_nordic_dfu/flutter_nordic_dfu.dart';
import 'package:flutter_blue/flutter_blue.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final FlutterBlue flutterBlue = FlutterBlue.instance;
  StreamSubscription<ScanResult> scanSubscription;
  List<ScanResult> scanResults = <ScanResult>[];
  bool dfuRunning = false;
  int dfuRunningInx;

  [@override](/user/override)
  void initState() {
    super.initState();
  }

  Future<void> doDfu(String deviceId) async {
    stopScan();
    dfuRunning = true;
    try {
      var s = await FlutterNordicDfu.startDfu(
        deviceId,
        'assets/file.zip',
        fileInAsset: true,
        progressListener: DefaultDfuProgressListenerAdapter(onProgressChangedHandle: (
          deviceAddress,
          percent,
          speed,
          avgSpeed,
          currentPart,
          partsTotal,
        ) {
          print('deviceAddress: $deviceAddress, percent: $percent');
        }),
      );
      print(s);
      dfuRunning = false;
    } catch (e) {
      dfuRunning = false;
      print(e.toString());
    }
  }

  void startScan() async {
    scanSubscription?.cancel();
    await flutterBlue.stopScan();
    setState(() {
      scanResults.clear();
      scanSubscription = flutterBlue.scan().listen(
        (scanResult) {
          if (scanResults.firstWhere(
                  (ele) => ele.device.id == scanResult.device.id,
                  orElse: () => null) !=
              null) {
            return;
          }
          setState(() {
            /// add result to results if not added
            scanResults.add(scanResult);
          });
        },
      );
    });
  }

  void stopScan() {
    scanSubscription?.cancel();
    scanSubscription = null;
    setState(() => scanSubscription = null);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    final isScanning = scanSubscription != null;
    final hasDevice = scanResults.length > 0;

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
          actions: <Widget>[
            isScanning
                ? IconButton(
                    icon: Icon(Icons.pause_circle_filled),
                    onPressed: dfuRunning ? null : stopScan,
                  )
                : IconButton(
                    icon: Icon(Icons.play_arrow),
                    onPressed: dfuRunning ? null : startScan,
                  )
          ],
        ),
        body: !hasDevice
            ? const Center(
                child: const Text('No device'),
              )
            : ListView.separated(
                padding: const EdgeInsets.all(8),
                itemBuilder: _deviceItemBuilder,
                separatorBuilder: (context, index) => const SizedBox(height: 5),
                itemCount: scanResults.length,
              ),
      ),
    );
  }

  Widget _deviceItemBuilder(BuildContext context, int index) {
    var result = scanResults[index];
    return DeviceItem(
      isRunningItem: (dfuRunningInx == null ? false : dfuRunningInx == index),
      scanResult: result,
      onPress: dfuRunning
          ? () async {
              await FlutterNordicDfu.abortDfu();
              setState(() {
                dfuRunningInx = null;
              });
            }
          : () async {
              setState(() {
                dfuRunningInx = index;
              });
              await this.doDfu(result.device.id.id);
              setState(() {
                dfuRunningInx = null;
              });
            },
    );
  }
}

class ProgressListenerListener extends DfuProgressListenerAdapter {
  [@override](/user/override)
  void onProgressChanged(String deviceAddress, int percent, double speed, double avgSpeed, int currentPart, int partsTotal) {
    super.onProgressChanged(deviceAddress, percent, speed, avgSpeed, currentPart, partsTotal);
    print('deviceAddress: $deviceAddress, percent: $percent');
  }
}

class DeviceItem extends StatelessWidget {
  final ScanResult scanResult;
  final VoidCallback onPress;
  final bool isRunningItem;

  DeviceItem({this.scanResult, this.onPress, this.isRunningItem});

  [@override](/user/override)
  Widget build(BuildContext context) {
    var name = "Unknow";
    if (scanResult.device.name != null && scanResult.device.name.length > 0) {
      name = scanResult.device.name;
    }
    return Card(
      child: Padding(
        padding: const EdgeInsets.all(8.0),
        child: Row(
          children: <Widget>[
            Icon(Icons.bluetooth),
            Expanded(
              child: Column(
                crossAxisAlignment: CrossAxisAlignment.start,
                children: <Widget>[
                  Text(name),
                  Text(scanResult.device.id.id),
                  Text("RSSI: ${scanResult.rssi}"),
                ],
              ),
            ),
            TextButton(
                onPressed: onPress,
                child: isRunningItem ? Text("Abort Dfu") : Text("Start Dfu"))
          ],
        ),
      ),
    );
  }
}