Flutter NRF 工具插件nrfutil的使用

nrfutil

一个用于创建nRF DFU包并为nRF51和nRF52设备进行DFU更新的Flutter插件。该插件还可以生成用于签名DFU包的密钥，并在设备上用于验证的C代码。

请注意 在继续或发布新问题之前：

• 该插件不是由Nordic Semiconductor赞助或维护的。作者是希望使nrf设备的dfu包更容易创建的开发者。

开始使用

要在你的pubspec.yaml文件中添加nrfutil包以开始使用，请执行以下步骤：

dependencies:
  nrfutil: ^x.x.x

使用方法

nRF设备具有不同的软设备，请确保从softDeviceReqType枚举列表中选择正确的软设备。如果没有提供密钥文件，则会使用默认密钥。请勿在最终包中使用此密钥。

DFU包可以包含单独的固件选项（例如应用、软设备或引导加载程序）或组合选项（例如应用+软设备+引导加载程序、应用+软设备或软设备+引导加载程序）。它不能制作应用+引导加载程序。

生成一个nRF DFU包

生成一个归档包作为Uint8List。

在YAML文件中生成

在你的pubspec.yaml或nrfutil.yaml中添加以下内容：

nrfutil:
  debug: true
  comment: "test comment"
  softdevice_type: "s132NRF52d611"
  export_path: "assets"
  hardware_version: 0xFFFFFFFF
  keyfile:
    generate: false
    private_key: "assets/key.pem"
    public_key: "assets/pbkey.pem"
  bootloader:
    version: 0xFFFFFFFF
    path: "assets/firmwares/foo.hex"
  application:
    version: 0xFFFFFFFF
    path: "assets/firmwares/bar.hex"
  softdevice:
    version: 0xFFFFFFFF
    path: "assets/firmwares/s132_nrf52_mini.hex"

然后运行以下命令：

dart run nrfutil --verbose

在终端中生成

仅在终端中运行以下命令：

dart run nrfutil --verbose --application assets/firmwares/bar.hex --app_version 0xFFFFFFFF --debug

在你的Flutter包中生成

生成一个归档包作为Uint8List。

Uint8List package =  await NRFUTIL(
    applicationFirmware: applicationFirmware,
    softDeviceFirmware: softDeviceFirmware,
    hardwareVersion: hwVersion,
    applicationVersion: appVersion,
    keyFile: keyFile,
    sofDeviceReqType: sdReq
).generate();

生成私钥和公钥

生成一个归档包作为Uint8List。

密钥生成能够提供一个PEM格式的私钥，但公钥可以是PEM或C代码形式。

Uint8List package =  await Signing.generateKey();

示例

你可以在这里找到这个API的示例：示例代码

import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:nrfutil/nrfutil.dart';
import 'package:nrfutil_example/src/saveFile/saveFile.dart';

class DropDownItems{
  DropDownItems({
    required this.value,
    required this.text
  });
  SoftDeviceTypes value;
  String text;
}

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const NRFUtilWidget(),
    );
  }
}

enum NRFCall{cancel,submit}

class NRFUtilWidget extends StatefulWidget {
  const NRFUtilWidget({
    Key? key,
  }) : super(key: key);
  [@override](/user/override)
  _NRFUtilWidgetState createState() => _NRFUtilWidgetState();
}

class _NRFUtilWidgetState extends State<NRFUtilWidget> {
  TextEditingController appCont = TextEditingController();
  TextEditingController sdCont = TextEditingController();
  TextEditingController bootCont = TextEditingController();
  TextEditingController keyCont = TextEditingController();

  String? applicationFirmware;
  String? bootloaderFirmware;
  String? softDeviceFirmware;
  String? key;

  SoftDeviceTypes sdReq = SoftDeviceTypes.s132NRF52d611;
  String error = '';
  late List<DropdownMenuItem<SoftDeviceTypes>> sdDropDown;
  late double deviceWidth;

  bool loading = false;

  [@override](/user/override)
  void initState(){
    getFirmware();
    List<DropDownItems> keys = [];
    for (int i = 0; i < SoftDeviceTypes.values.length; i++) {
      keys.add(DropDownItems(value: SoftDeviceTypes.values[i], text: SoftDeviceTypes.values[i].toString()));
    }
    sdDropDown = setDropDownItems(keys);
    super.initState();
  }

  void getFirmware() async{
    String bfs = await rootBundle.loadString('assets/firmwares/bar.hex');
    String afs = await rootBundle.loadString('assets/firmwares/bar.hex');
    String sfs = await rootBundle.loadString('assets/firmwares/foo.hex');
    String ks = await rootBundle.loadString('assets/key.pem');
    applicationFirmware = afs;
    bootloaderFirmware = bfs;
    softDeviceFirmware = sfs;
    key = ks;
  }

  static Widget squareButton({
    Key? key,
    bool iconFront = false,
    Widget? icon,
    Color buttonColor = Colors.transparent,
    Color textColor = Colors.blueGrey,
    required String text,
    Function()? onTap,
    String fontFamily = 'Klavika Bold',
    double fontSize = 18.0,
    MainAxisAlignment mainAxisAlignment = MainAxisAlignment.center,
    double height = 75,
    double width = 100,
    double radius = 5,
    Alignment? alignment,
    EdgeInsets? margin,
    EdgeInsets? padding,
    List<BoxShadow>? boxShadow,
    Color? borderColor
  }){
    Widget totalIcon = (icon != null)?icon:Container();
    return InkWell(
      onTap: onTap,
      child: Container(
        alignment: alignment,
        height: height,
        width: width,
        margin: margin,
        padding: padding,
        decoration: BoxDecoration(
          color: buttonColor,
          border: Border.all(
            color: (borderColor == null)?buttonColor:borderColor,
            width: 2
          ),
          borderRadius: BorderRadius.all(Radius.circular(radius)),
          boxShadow: boxShadow
        ),
        child: Row(
          key: key,
          mainAxisAlignment: mainAxisAlignment,
          children: [
            (iconFront)?totalIcon:Container(),
            Text(
              text.toUpperCase(),
              textAlign: TextAlign.start,
              style: TextStyle(
                color: textColor,
                fontSize: fontSize,
                fontFamily: fontFamily,
                decoration: TextDecoration.none
              )
            ),
            (!iconFront)?totalIcon:Container(),
          ]
        )
      )
    );
  }

  static List<DropdownMenuItem<SoftDeviceTypes>> setDropDownItems(List<DropDownItems> info){
    List<DropdownMenuItem<SoftDeviceTypes>> items = [];
    for (int i =0; i < info.length;i++) {
      items.add(DropdownMenuItem(
        value: info[i].value,
        child: Text(
          info[i].text, 
          overflow: TextOverflow.ellipsis,
        )
      ));
    }
    return items;
  }

  double responsive({double? width, double smallest = 650, int total = 1}){
    width = width ?? deviceWidth;
    if(width < smallest){
      return width/total-20;
    }
    else if(width < smallest+350){
      return width/(2+(total-1))-20;
    }
    else{
      return width/(3+(total-1))-20;
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    deviceWidth = MediaQuery.of(context).size.width;
    return Scaffold(
      body: Align(
        alignment: Alignment.center,
        child: SizedBox(
          width: responsive(),
          height: 360,
          child: Container(
            padding: const EdgeInsets.all(20),
            height: 360,
            width: responsive(),
            alignment: Alignment.center,
            decoration: BoxDecoration(
              color: Theme.of(context).cardColor,
              borderRadius: const BorderRadius.all(Radius.circular(10)),
              boxShadow: [
                BoxShadow(
                  color: Theme.of(context).shadowColor,
                  blurRadius: 5,
                  offset: const Offset(2, 2),
                ),
              ]
            ),
            child: Column(
              mainAxisAlignment: MainAxisAlignment.spaceBetween,
              children: [
                squareButton(
                  text: 'generate key',
                  onTap: () {
                    SaveFile.saveBytes(printName: 'nrfutil_keys', fileType: 'zip', bytes: Signing.generateKey().zipFile);
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                ),
                squareButton(
                  text: 'Create Application',
                  onTap: () {
                    NRFUTIL(
                      applicationFirmware: applicationFirmware,
                      hardwareVersion: 52,
                      applicationVersion: 1,
                      keyFile: key,
                      softDeviceReqType: sdReq,
                      verbose: true
                    ).generate().then((value){
                      SaveFile.saveBytes(printName: 'nrfutil_test', fileType: 'zip', bytes: value);
                    });
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                ),
                squareButton(
                  text: 'Create Bootloader',
                  onTap: () {
                    NRFUTIL(
                      bootloaderFirmware: bootloaderFirmware,
                      hardwareVersion: 52,
                      bootloaderVersion: 1,
                      keyFile: key,
                      softDeviceReqType: sdReq,
                      verbose: true
                    ).generate().then((value){
                      SaveFile.saveBytes(printName: 'nrfutil_test', fileType: 'zip', bytes: value);
                    });
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                ),
                squareButton(
                  text: 'Create softdevice',
                  onTap: () {
                    NRFUTIL(
                      softDeviceFirmware: softDeviceFirmware,
                      hardwareVersion: 52,
                      keyFile: key,
                      softDeviceReqType: sdReq,
                      verbose: true
                    ).generate().then((value){
                      SaveFile.saveBytes(printName: 'nrfutil_test', fileType: 'zip', bytes: value);
                    });
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                ),
                squareButton(
                  text: 'Create Application and Softdevice',
                  onTap: () {
                    NRFUTIL(
                      applicationFirmware: applicationFirmware,
                      softDeviceFirmware: softDeviceFirmware,
                      hardwareVersion: 52,
                      applicationVersion: 1,
                      keyFile: key,
                      softDeviceReqType: sdReq,
                      verbose: true
                    ).generate().then((value){
                      SaveFile.saveBytes(printName: 'nrfutil_test', fileType: 'zip', bytes: value);
                    });
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                ),
                squareButton(
                  text: 'Create bootloader and Softdevice',
                  onTap: () {
                    NRFUTIL(
                      softDeviceFirmware: softDeviceFirmware,
                      bootloaderFirmware: bootloaderFirmware,
                      bootloaderVersion: 1,
                      keyFile: key,
                      softDeviceReqType: sdReq
                    ).generate().then((value){
                      SaveFile.saveBytes(printName: 'nrfutil_test', fileType: 'zip', bytes: value);
                    });
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                ),
                squareButton(
                  text: 'Create application, bootloader and Softdevice',
                  onTap: () {
                    NRFUTIL(
                      applicationFirmware: applicationFirmware,
                      bootloaderFirmware: bootloaderFirmware,
                      softDeviceFirmware: softDeviceFirmware,
                      applicationVersion: 1,
                      hardwareVersion: 52,
                      keyFile: key,
                      softDeviceReqType: sdReq,
                      verbose: true
                    ).generate().then((value){
                      SaveFile.saveBytes(printName: 'nrfutil_test', fileType: 'zip', bytes: value);
                    });
                  },
                  borderColor: Colors.blueGrey,
                  height: 45,
                  radius: 10,
                  width: (responsive()-45),
                )
              ]
            )
          )
        )
      )
    );
  }
}