介紹

esp_remote_flash_tool 是一款基于 esptool.py 的遠(yuǎn)程自動(dòng)燒錄工具，支持 ESP32 和 ESP8266。

使用場景

• 基于 ESP-IDF 、ESP8266 NONO SDK、ESP8266 RTOS SDK 進(jìn)行開發(fā)的項(xiàng)目
• 項(xiàng)目代碼存儲(chǔ)在 Linux 編譯機(jī)上，Windows 通過 SSH 連接到 Linux 進(jìn)行開發(fā)，且開發(fā)板連接在 Windows 開發(fā)機(jī)上

為什么選擇這樣的開發(fā)模式？

• Windows 下編譯的效率太低，完整編譯一個(gè)程序大概需要 5-6 分鐘，而同樣的項(xiàng)目 Linux 僅需要 1 分鐘，所以在 Linux 下進(jìn)行編譯開發(fā)可以大大提高效率。

• 但是，直接在 Linux 下開發(fā)可能遇到一些問題，比如：

  1. Linux 開發(fā)機(jī)是服務(wù)器，主機(jī)在服務(wù)器機(jī)房中，無法通過串口連接開發(fā)板進(jìn)行燒錄和調(diào)試
  2. Linux下缺少好用的串口調(diào)試工具，而且如果遇到串口輸出中文的情況，還可能出現(xiàn)亂碼的問題
  3. Linux缺少一些常用的軟件，例如公司要求使用的辦公軟件

• 權(quán)衡之后，最佳開發(fā)方式將項(xiàng)目代碼存儲(chǔ)在 Linux 編譯機(jī)上，Windows 通過 SSH 連接到 Linux 進(jìn)行開發(fā)，且開發(fā)板連接在 Windows 開發(fā)機(jī)上，負(fù)責(zé)燒錄和調(diào)試。

問題與解決

因?yàn)殚_發(fā)板連接在 Windows 開發(fā)機(jī)上，每次修改完代碼想要驗(yàn)證程序時(shí)，都需要經(jīng)過一系列步驟：

1. 編譯程序
2. 將編譯后的程序復(fù)制到開發(fā)機(jī)
3. 利用燒錄軟件將程序燒錄到開發(fā)板
4. 打開串口調(diào)試軟件進(jìn)行調(diào)試

esp_remote_flash_tool 將這些步驟進(jìn)行簡化，只需要執(zhí)行一行命令，就可以完成上述操作，提高了開發(fā)時(shí)驗(yàn)證代碼的效率。

開始使用

項(xiàng)目地址
Github：https://github.com/CloudSir/esp_remote_flash_tool/
Gitee：https://gitee.com/Cloud-Sir/esp_remote_flash_tool

下載項(xiàng)目

# 使用Github
git clone https://github.com/CloudSir/esp_remote_flash_tool# 使用Gitee
git clone https://gitee.com/Cloud-Sir/esp_remote_flash_tool

開啟服務(wù)端

1. 復(fù)制服務(wù)端程序：將 esp_remote_flash_tool 文件夾下的 server 復(fù)制到 Windows 開發(fā)機(jī)上

2. 下載依賴：進(jìn)入 Windows 開發(fā)機(jī)的 server 目錄，執(zhí)行

pip install -r requirements.txt

3. 運(yùn)行服務(wù)端程序：在 Windows 開發(fā)機(jī)的 server 目錄下執(zhí)行

python main.py

復(fù)制 running on 后面的服務(wù)器地址。

開始遠(yuǎn)程燒錄

1. 復(fù)制遠(yuǎn)程燒錄客戶端程序：將 esp_remote_flash_tool 文件夾下的 client 復(fù)制到 Linux 編譯機(jī)上（與你的ESP項(xiàng)目文件夾同級(jí)文件夾下）

2. 下載依賴：進(jìn)入 Linux 編譯機(jī)的 client 目錄，執(zhí)行

pip install -r requirements.txt

2. 根據(jù)自己的項(xiàng)目的配置修改 client 目錄下的 config.yaml

   • server_url: 剛才復(fù)制的服務(wù)器的文件地址

   • com_port：Windows 開發(fā)機(jī)下連接 ESP8266/ESP32 的串口號(hào)，如果 Winsows下只連接了一個(gè)串口，可以設(shè)置為 auto，此時(shí)會(huì)自動(dòng)選擇該串口

   • basic_options：esptool.py 的基本選項(xiàng)，與 esptool.py 的選項(xiàng)相同，具體請(qǐng)參考 esptool.py 的文檔

   • flash_options：esptool.py 的 flash 選項(xiàng)，與 esptool.py 的選項(xiàng)相同，具體請(qǐng)參考 esptool.py 的文檔

   • firmware_list：要燒錄的固件列表，是一個(gè)鍵值對(duì)類型，鍵為固件燒錄地址，值為固件文件的絕對(duì)路徑地址，例如：

     firmware_list:0x0000: 'firmware/bootloader.bin'0x1000: 'firmware/app.bin'
     

3. 你的項(xiàng)目編譯成功后，可以在 Linux 編譯機(jī)下調(diào)用 esp_remote_flash_tool 進(jìn)行遠(yuǎn)程燒錄(確保 Windows 開發(fā)機(jī)的服務(wù)器端程序已運(yùn)行，且 Windows 開發(fā)機(jī)和 Linux 編譯機(jī)在同一局域網(wǎng)下)

# 確保 client 文件夾和項(xiàng)目文件夾在同一目錄下，且當(dāng)前目錄是你的項(xiàng)目根目錄# 僅燒錄
python ../client/main.py# 編譯并燒錄（使用 make 構(gòu)建時(shí)）
make && python../client/main.py# 編譯并燒錄（使用 ninja 構(gòu)建時(shí)）
ninja && python../client/main.py# 編譯并燒錄（使用 idf.py 時(shí)）
idf.py build && python../client/main.py

---

后記

esp_remote_flash_tool 還處于開發(fā)階段，可能還有很多不足之處，起初只是為了方便自己開發(fā) ESP8266 時(shí)燒錄程序，如果你對(duì)這個(gè)項(xiàng)目感興趣，歡迎提 pull request 或 issue，大家一起完善這個(gè)工具。