这个存储库包含.NET nanoFramework固件刷写工具。
这是一个.NET Core 工具，它能够将固件映像 (nanoBooter和nanoCLR) 刷写进一个.NET nanoFramework 支持的设备，部署应用程序（运行.NET应用程序所需的所有程序集）并恢复先前保存的部署映像。
它是.NET nanoFramework工具集的一部分，与其他用于.NET nanoFramework开发、使用或仓库管理的各种工具一起使用。
它使用了几个第三方工具:
- 乐鑫 esptool 您可以在存储库中找到esptool和许可信息 链接.
- STM32 Cube Programmer 您可以找到源代码、许可信息和文档 链接.
- Texas Instruments Uniflash 您可以找到Uniflash工具和许可信息 链接.
我们还将此工具作为 .NET 库分发，以便它可以集成到第三方应用程序中。请查看“Samples”文件夹中的 README 以获取更多详细信息以及示例应用程序。
使用以下.NET Core CLI命令一键安装.NET nanoFramework 固件刷写工具:
dotnet tool install -g nanoff成功安装后，将显示一条消息，显示将用于调用工具和所安装的版本的命令。 类似于下面的例子:
You can invoke the tool using the following command: nanoff
Tool 'nanoff' (version '9.9.9') was successfully installed.Caution
已知在安装路径中包含变音符号（例如：法语中的重音符号（acute accent）用于表示元音应该发/ay/的音）时，使用nanoff为STM32设备运行命令会出现问题。这是由于STM32 Cube Programmer中的一个已知错误引起的。如果您的路径中存在这种情况，您必须将其安装在没有这些字符的位置。为了实现这一点，可以使用以下.NET Core CLI命令，在其中指定工具将安装的路径：
dotnet tool install nanoff --tool-path c:\a-plain-simple-path-to-install-the-tool请注意，如果您没有在STM32设备中使用'nanoff'，则此限制不适用。
您需要将nanoff添加到您的路径中。安装完成后，运行以下命令：
export PATH=$PATH:~/.dotnet/tools要更新.NET nanoFramework 固件刷写工具，请使用.NET Core CLI命令:
dotnet tool update -g nanoff如果工具安装在特定的路径下，请使用以下.NET Core CLI命令:
dotnet tool update nanoff --tool-path c:\path-where-the-tool-was-installed一旦安装了该工具，你就可以通过命令“nanoff”来调用它，这是该程序名称的简称，以方便输入。
nanoff [command] [args]该工具包括所有可用命令的帮助，您可以通过输入以下命令来查看:
nanoff --help各平台的使用示例和常用选项列表：
请注意，如果平台支持这些操作，可以组合多个选项，例如在同一次执行中更新 CLR 并部署托管应用程序。
有多种可用的 ESP32 映像，有些是专门为特定目标构建的。请查看列表。您还需要知道设备使用的 COM 端口。请查看如何在 Windows 上找到设备的 COM 端口。或者，您也可以列出可用的 COM 端口。如果先在没有设备的情况下列出端口，然后插入设备，显示的新增端口就是要刷写的设备的端口。此方法适用于所有操作系统：
nanoff --listportsESP32_PSRAM_REV0 映像适用于任何变体的 ESP32 系列，无论是否带有 PSRAM，并且适用于所有硅片版本。 您可以在这里阅读有关各种映像之间差异的更多信息。
FEATHER_S2 映像适用于几乎所有暴露嵌入式 USB CDC 引脚的 ESP32-S2 系列变体。 您可以在这里阅读有关各种映像之间差异的更多信息。
使用 nanoff 时，您可以添加 --target MY_TARGET_NAME_HERE 以使用特定映像。或者，您只需指定平台 --platform esp32，nanoff 将根据连接设备的功能选择最合适的映像。输出将类似于以下内容，以告知即将使用的映像：
未提供目标名称！根据设备特性使用 'ESP32_REV0'。注意：请注意，对于 ESP32-S2 目标，无法安全地确定最佳映像。因此，必须提供适当的目标名称
--target MY_TARGET_NAME_HERE。
一些 ESP32 开发板在进入引导加载程序模式时有问题。通常可以通过按住开发板上的 BOOT/FLASH 按钮来解决此问题。
如果 nanoff 检测到这种情况，将显示以下警告：
*** 按住 ESP32 开发板上的 BOOT/FLASH 按钮 ***警告： 要更新 FeatherS2、TinyS2 和一些 S3 模块，开发板需要通过按住 [BOOT]、点击 [RESET] 然后释放 [BOOT] 进入下载模式。
更新连接到COM31的ESP32设备器的固件到最新可用的开发版本。
nanoff --update --target ESP32_PSRAM_REV0 --serialport COM31使用本地CLR文件(例如来自一个构建文件)更新连接到COM31的ESP32-S2 KALUGA 1设备的固件。
这个文件必须是一个二进制文件，且必须是有效且经过构建的CLR。 对文件内容不执行其他检查或验证。
nanoff --update --target KALUGA_1 --serialport COM31 --clrfile "C:\nf-interpreter\build\nanoCLR.bin" 您可以调整要使用的核心固件的名称。 请参阅前一节以获得完整的列表。
查看与COM31相连的ESP32设备的详细信息。
nanoff --platform esp32 --serialport COM31 --devicedetails 可选地，可以传递额外的参数 --checkpsram，它会强制检测PSRAM的可用性。
将托管应用程序部署到连接到COM31的ESP32_PSRAM_REV0设备上。
Note: 在成功构建之后，可以在Visual Studio项目的Release或Debug文件夹中找到包含部署映像的二进制文件。 此文件包含将托管应用程序部署到设备所需的所有内容(即应用程序可执行文件和所有引用的库和程序集)。
nanoff --target ESP32_PSRAM_REV0 --serialport COM12 --deploy --image "E:\GitHub\nf-Samples\samples\Blinky\Blinky\bin\Debug\Blinky.bin"要在连接到COM31的ESP32设备机上部署应用程序，您必须指定托管应用程序的路径。 您也可以提供一个地址，该地址将覆盖默认的部署地址。
本示例使用的是在构建应用程序时可以找到的二进制格式文件。 注意，因为只有应用程序可以运行，所以在构建库时，不会自动创建bin文件，这只针对应用程序。
nanoff --target ESP32_PSRAM_REV0 --update --serialport COM31 --deploy --image "c:\eps32-backups\my_awesome_app.bin" --address 0x1B000在更新连接到 COM31 的 ESP32 目标的固件时跳过备份配置分区。
nanoff --update --target ESP32_PSRAM_REV0 --serialport COM31 --nobackupconfig使用JTAG连接将ST_STM32F769I_DISCOVERY设备的固件更新到最新可用的稳定版本。
nanoff --update --target ST_STM32F769I_DISCOVERY --jtag将托管应用程序部署到ST_STM32F769I_DISCOVERY设备，该设备的部署区域位于0x08080000 Flash地址，并在刷写后复位MCU。
Note: 在成功构建之后，可以在Visual Studio项目的Release或Debug文件夹中找到包含部署映像的二进制文件。 此文件包含将托管应用程序部署到设备所需的所有内容(即应用程序可执行文件和所有引用的库和程序集)。
nanoff --target ST_STM32F769I_DISCOVERY --deploy --image "E:\GitHub\nf-Samples\samples\Blinky\Blinky\bin\Debug\Blinky.bin" --address 0x08040000 --reset使用JTAG连接和托管应用程序，将ST_STM32F769I_DISCOVERY设备的固件更新到最新可用的预览版本。
您必须指定托管应用程序的路径。
本例使用了Visual Studio在构建任何nanoFramework c#应用程序时生成的二进制格式文件。 因为它是一个二进制文件，所以您还必须指定部署区域的flash地址(这里是0x08000000，注意十六进制格式)。
nanoff --update --target ST_STM32F769I_DISCOVERY --jtag --binfile "c:\dev\my awesome app\bin\debug\my_awesome_app.bin" --address 0x08000000这将列出通过JTAG连接的所有STM32设备。
nanoff --listjtag这将列出所有通过DFU连接的STM32设备。
nanoff --listdfu为STM32 JTAG连接的设备安装驱动程序。
nanoff --installjtagdrivers为STM32 DFU连接的设备安装驱动程序。
nanoff --installdfudrivers将TI_CC1352R1_LAUNCHXL设备的固件更新到最新的预览版本。
nanoff --update --target TI_CC1352R1_LAUNCHXL --preview安装XDS110 USB驱动。
nanoff --installxdsdrivers将 SL_STK3701A 目标的固件更新到最新版本。
nanoff --update --target SL_STK3701A使用本地固件文件（例如从构建中生成的文件）更新 Silabs 目标的固件。 该文件必须是包含有效 Booter 和 CLR 的二进制文件。不会对文件内容进行任何检查或验证。
nanoff --update --platform efm32 --binfile "C:\nf-interpreter\build\nanobooter-nanoclr.bin" --address 0x0向 SL_STK3701A 目标部署托管应用程序，该目标的部署区域位于 0x000EE000 闪存地址，并在刷写后重置 MCU。
注意：部署映像的二进制文件可以在 Visual Studio 项目成功构建后的 Release 或 Debug 文件夹中找到。该文件包含部署托管应用程序到目标所需的一切（即应用程序可执行文件和所有引用的库和程序集）。
nanoff --target SL_STK3701A --deploy --image "E:\GitHub\nf-Samples\samples\Blinky\Blinky\bin\Debug\Blinky.bin" --address 0x000EE000使用 J-Link 连接将 SL_STK3701A 目标的固件更新到最新可用版本，并部署托管应用程序。 您必须指定托管应用程序的路径。 此示例使用 Visual Studio 构建任何 nanoFramework C# 应用程序时生成的二进制格式文件。由于它是二进制文件，您还必须指定部署区域的闪存地址（此处为 0x000EE000，请注意十六进制格式）。
nanoff --update --target SL_STK3701A --binfile "c:\dev\my awesome app\bin\debug\my_awesome_app.bin" --address 0x000EE000这对于列出所有通过 J-Link 连接的 Silabs 设备非常有用。
nanoff --listjlink可以使用与 Visual Studio 连接相同的连接来更新 nano 设备，这意味着不需要专门的连接（如 JTAG 或 JLink）。这仅在设备之前已刷写了工作 nanoFramework 固件的情况下才可能。
将连接到串行端口的 nano 设备的 CLR 更新到最新可用版本。 这将找到连接设备的最新可用固件并更新 CLR。
nanoff --nanodevice --update --serialport COM9要部署（或更新）托管应用程序，必须提供托管应用程序的路径。 此示例使用 Visual Studio 构建任何 nanoFramework C# 应用程序时生成的二进制格式文件。由于可以从连接的设备中检索所有必需的详细信息，因此不需要其他配置。
nanoff --nanodevice --deploy --serialport COM9 --image "c:\dev\my awesome app\bin\debug\my_awesome_app.bin"使用本地固件文件（例如从构建中生成的文件）更新 nano 设备的固件。 该文件必须是包含有效 nanoCLR 的二进制文件。不会对文件内容进行任何检查或验证。
nanoff --nanodevice --update --serialport COM9 --clrfile "C:\nf-interpreter\build\nanoclr.bin"获取连接到串行端口的 nano 设备的详细信息。
nanoff --nanodevice --devicedetails --serialport COM9该工具会尽最大努力检查所请求的设备是否符合已连接的设备。
有时这是不可能的，因为设备名称的差异和变化，或者缺乏所连接设备提供的详细信息，甚至(像DFU所连接的设备)，因为根本不可能确切地确定所连接的设备。
这并不一定意味着固件不能工作，所以这只是一个建议。
要禁用此验证，请在命令行中添加'——nofitcheck'选项。
可以通过' v|verbosity '选项设置工具输出详细。
例如，如果在一个自动化流程中使用该工具，该流程需要最小的输出以简化对执行返回结果的处理，那么这是很方便的。 它可以设置为:
- q[uiet]
- m[inimal]
- n[ormal]
- d[etailed]
- diag[nostic]
nanoff -v q翻译结果
您可以列出支持的设备及其版本，用于稳定版本或预览。 --platform 允许您过滤平台。
在预览版本中列出可用于ESP32设备的软件包。
nanoff --listboards --platform esp32列出可用于STM32设备的包(稳定版本)。
nanoff --listboards --platform stm32如果你只使用'——listtargets'开关，你会得到所有设备的所有稳定包的列表。
一些设备如 ESP32、Orgpal 和其他一些设备有可用的存储空间。文件可以部署到这个存储空间中。你需要使用 filedeployment 参数指向一个 JSON 文件，在刷写设备时部署文件：
nanoff --target XIAO_ESP32C3 --update --masserase --serialport COM21 --filedeployment C:\path\deploy.jsonJSON 文件中可以包含一个可选的 SerialPort，以防上传文件的端口与刷写设备的端口不同或未在主命令行中指定，并且必须包含一个 Files 条目的列表。每个条目必须包含 DestinationFilePath，即目标完整路径文件名，以及 SourceFilePath，即要部署的内容的源文件路径；否则，要删除文件时，必须包含要部署的源文件的完整路径和文件名：
{
"serialport":"COM42",
"files": [
{
"DestinationFilePath": "I:\\TestFile.txt",
"SourceFilePath": "C:\\tmp\\NFApp3\\NFApp3\\TestFile.txt"
},
{
"DestinationFilePath": "I:\\NoneFile.txt"
},
{
"DestinationFilePath": "I:\\wilnotexist.txt",
"SourceFilePath": "C:\\WRONGPATH\\TestFile.txt"
}
]
}如果你只想部署文件而不进行其他操作，你可以只指定：
nanoff --filedeployment C:\path\deploy.json在这种情况下，SerialPort 必须在 JSON 文件中存在。
注意： 如果存储中已经存在文件，它将被新文件替换。
如果文件不存在且请求删除，则不会发生任何事情，会显示警告。
如果由于某种问题无法上传文件，其他文件的部署将继续，并会显示错误。
如果需要，可以清除存储在本地缓存中的固件包。
另外，缓存位置是用户文件夹中的目录 -nanoFramework\fw_cache。
当命令中包含此选项时，不会处理其他选项。
nanoff --clearcache默认情况下，nanoff 使用在线仓库来查找固件包。也可以使用本地目录作为固件的来源。可以通过 --updatearchive 选项来填充固件存档：
nanoff --updatearchive --target ESP32_S3_ALL --archivepath c:\...\firmware
nanoff --updatearchive --platform esp32 --archivepath c:\...\firmware查看已存档的固件列表：
nanoff --listtargets --fromarchive --archivepath c:\...\firmware要在设备上安装固件，使用与平常相同的命令行参数，但添加 --fromarchive 和 --archivepath：
nanoff --nanodevice --update --serialport COM9 --fromarchive --archivepath c:\...\firmware默认情况下，nanoff 会检查是否发布了新版本的工具。如果不需要，可以添加选项 --suppressnanoffversioncheck 来跳过检查。
可以查看签入代码 这个源文件.
如欲提供反馈、报告问题及了解如何作出贡献，请参阅 主储库.
加入我们的Discord社区 这里.
此项目的贡献者列表可在以下网站找到 贡献者.
nanoFramework firmware flash工具使用 MIT许可证.
这个项目采用了贡献者契约所定义的行为准则，以澄清我们社区的预期行为。
知识产权.NET Foundation Code of Conduct.
这个项目由.NET Foundation提供支持.