diff --git a/docs/_static/linux_download.png b/docs/_static/linux_download.png index ec233d4..c967b9c 100644 Binary files a/docs/_static/linux_download.png and b/docs/_static/linux_download.png differ diff --git a/docs/_static/linux_install_esptool.png b/docs/_static/linux_install_esptool.png index f6157c9..7b6382a 100644 Binary files a/docs/_static/linux_install_esptool.png and b/docs/_static/linux_install_esptool.png differ diff --git a/docs/firmware_update.md b/docs/firmware_update.md index 82ea7f6..036d76a 100644 --- a/docs/firmware_update.md +++ b/docs/firmware_update.md @@ -1,126 +1,124 @@ * [中文版本](./firmware_update_cn.md) -# Update Firmware +# Updating Firmware -The BOX series development boards support updating firmware through USB, you just need: +The BOX series development boards support updating firmware through USB. To update firmware, you only need: -1. USB Type-C cable -2. Latest firmware bin file +1. A USB Type-C cable +2. Latest firmware (bin file) **Important Note:** -> If USB download fails, please hold down `Boot` button and then press `Reset` button to initiates Firmware Download mode. +> If the downloading through USB fails, please hold down the `Boot` button and then press the `Reset` button to initiate Firmware Download mode. -## Latest Firmware Download +## Downloading Latest Firmware -For the latest firmware, please refer to: https://github.com/espressif/esp-box/releases +For the latest firmware, please go to https://github.com/espressif/esp-box/releases. -1. Choose the latest release version -2. Click `Assets` to show more files -3. Choose an `xxxxxx.bin` to download +1. Choose the latest release version. +2. Click `Assets` to show more files. +3. Choose an `xxxxxx.bin` and download it.
- +
-## Firmware update +## Updating Firmware -Please follow the link below correspond to your OS to update the firmware. +Please follow the link below corresponding to your OS to update the firmware. -| [Windows](#firmware-update-for-windows) | [Linux](#firmware-update-for-linux) | [macOS](#firmware-update-for-macos) | +| [
Windows
](#firmware-update-for-windows) | [
Linux
](#firmware-update-for-linux) | [
macOS
](#firmware-update-for-macos) | |:----:|:----:|:----:| -| [](#firmware-update-for-windows) | [](#firmware-update-for-linux) | [](#firmware-update-for-macos) | +| [](#firmware-update-for-windows) | [](#firmware-update-for-linux) | [](#firmware-update-for-macos) | -#### Firmware update for Windows +### Updating Firmware for Windows -We recommend using `Windows 10` and above system. Under `Windows 10` system, the driver of `USB-Serial-Jtag` will be downloaded automatically. If you use the `Windows 7`, please download and install [USB-Serial-JTAG drive](https://dl.espressif.com/dl/idf-driver/idf-driver-esp32-usb-jtag-2021-07-15.zip) manually. +We recommend using `Windows 10` and above. Under `Windows 10` system, the driver of `USB-Serial-Jtag` will be downloaded automatically. If you use `Windows 7`, please download and install [USB-Serial-JTAG drive](https://dl.espressif.com/dl/idf-driver/idf-driver-esp32-usb-jtag-2021-07-15.zip) manually. -1. [Download latest firmware](#latest-firmware-download) -2. Connect your development board to the computer through USB Type-C cable. -3. Please make sure the computer is connected to the Internet first. When the driver is installed, you can find two new devices appear on `Device Manager` list, `COMX` (`COM2` for example) and `USB JTAG/serial debug unit`, the former is used to download firmware or output program logs, the latter is used for JTAG debugging. +1. [Download the latest firmware](#latest-firmware-download). +2. Connect your development board to the computer through a USB Type-C cable. +3. Please make sure the computer is connected to the Internet first. When the driver is installed, you can find two new devices appear on the `Device Manager` list, `COMX` (`COM2` for example) and `USB JTAG/serial debug unit`. The first one is used to download firmware or output program logs, and the second one is used for JTAG debugging.
- +
-4. Download [Windows download tool](https://www.espressif.com/sites/default/files/tools/flash_download_tool_3.9.2_0.zip) and unzip it to any folder, then run the executable file `flash_download_tool_x.x.x.exe` -5. Please choose `chipType`: `ESP32S3`, `workMode`: `develop`, `loadMode`: `usb`, then click `OK` to enter the download tool config interface. +4. Download [Windows download tool](https://www.espressif.com/sites/default/files/tools/flash_download_tool_3.9.2_0.zip) and unzip it to any folder. Then double-click to run the executable file `flash_download_tool_x.x.x.exe`. +5. Please set `chipType` to `ESP32S3`, `workMode` to `develop`, `loadMode` to `usb`. Then, click `OK` to enter the download tool configuration interface.
- +
-6. Follow the instruction below to configure the downloaded tool: - 1. Choose the path of firmware `xxxx.bin`, then set the download address to `0x0`. - 2. Select the COM port, like `COM2` for this PC. +6. Follow the instructions below to configure the downloaded tool: + 1. Choose the path of firmware `xxxx.bin`, and set the download address to `0x0`. + 2. Select the COMX port (`COM2` for example) for your PC. 3. Click `START` to start the downloading.
- +
-7. After downloading, `FINISH` will appear on the tool. Next, **please reboot to run the new firmware!** +7. After the firmware is downloaded, `FINISH` will appear on the tool. Next, **please press the `Reset` button to run the new firmware!**
- +
-#### Firmware update for Linux +### Updating Firmware for Linux -1. [Download latest firmware](#latest-firmware-download) -2. Connect your development board to the computer through USB Type-C cable, there is no need to install the driver of `USB-Serial-Jtag` under Linux system. -3. Install `esptool`, input the following commands in `Terminal` (`pip` can be specified as `pip3`) : +1. [Download the latest firmware](#latest-firmware-download). +2. Connect your development board to the computer through a USB Type-C cable. There is no need to install the driver of `USB-Serial-Jtag` under Linux system. +3. Install `esptool` by entering the following command in `Terminal` (`pip` can be specified as `pip3`): ``` pip install esptool ```
- +
-4. Follow the instruction to download the firmware (`pip` can be specified as `pip3`)： +4. Follow the below instruction to download the firmware (`pip` can be specified as `pip3`): ``` python -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin ``` - 1. `0x0` is the fixed flash address - 2. `download_path/test_bin.bin` need be replaced with your firmware path and name. + 1. `0x0` is the fixed flash address. + 2. `download_path/test_bin.bin` should be replaced with your firmware path and name. -5. After updating, the download tool will prompt `Hash of data verified`. Next, **please reboot to run the new firmware!** +5. After the firmware is updated, the download tool will prompt `Hash of data verified`. Next, **please press the `Reset` button to run the new firmware!**
- +
-#### Firmware update for macOS +### Updating Firmware for macOS -1. [Download latest firmware](#latest-firmware-download) - -2. Connect your development board to the computer through USB Type-C cable, there is no need to install the driver of `USB-Serial-Jtag` under macOS. - -3. Install `esptool`, input the following codes in `Terminal` (`pip3` can be specified as `pip`) : +1. [Download the latest firmware](#latest-firmware-download). +2. Connect your development board to the computer through a USB Type-C cable. There is no need to install the driver of `USB-Serial-Jtag` under macOS. +3. Install `esptool` by entering the following command in `Terminal` (`pip3` can be specified as `pip`): ``` pip3 install esptool ```
- +
-4. Follow the instruction to download the firmware (`pip3` can be specified as `pip`): +4. Follow the below instruction to download the firmware (`pip3` can be specified as `pip`): ``` python3 -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin ``` 1. `0x0` is the fixed flash address. - 2. `download_path/test_bin.bin` need be replaced with your firmware path and name. + 2. `download_path/test_bin.bin` should be replaced with your firmware path and name. -5. After updating, the download tool will prompt `Hash of data verified`. Next, **please reboot to run the new firmware!** +5. After the firmware is updated, the download tool will prompt `Hash of data verified`. Next, **please press the `Reset` button to run the new firmware!**
- +
\ No newline at end of file diff --git a/docs/firmware_update_cn.md b/docs/firmware_update_cn.md index 27339bf..8400028 100644 --- a/docs/firmware_update_cn.md +++ b/docs/firmware_update_cn.md @@ -2,73 +2,73 @@ # 更新固件 -BOX 系列开发板支持使用 USB 接口更新固件，你仅需要准备： +BOX 系列开发板支持使用 USB 接口更新固件，您仅需要准备： 1. 一根 USB Type-C 数据线 2. 最新版本固件（bin 文件） -**需要提醒:** +**需要提醒：** > 如遇 USB 下载失败，请按住 `Boot` 按键的同时按一下 `Reset` 按键进入“固件下载”模式。 ## 下载最新版本固件 -下载最新发布的固件，请访问：https://github.com/espressif/esp-box/releases +请访问 https://github.com/espressif/esp-box/releases 下载最新发布的固件。 -1. 请先选择一个固件（建议使用最新 release） -2. 点击 `Assets` 展开下载链接 -3. 选择一个 `xxxxxx.bin` 进行下载 +1. 请先选择一个固件（建议使用最新发布的固件）。 +2. 点击 `Assets` 展开下载链接。 +3. 选择一个 `xxxxxx.bin` 进行下载。
- +
## 固件更新 -不同操作系统的固件更新方法，请参考以下连接: +不同操作系统的固件更新方法，请参考以下链接： -| [Windows](#windows-系统更新固件说明) | [Linux](#linux-系统更新固件说明) | [macOS](#macos-系统更新固件说明) | +| [
Windows
](#windows-系统更新固件说明) | [
Linux
](#linux-系统更新固件说明) | [
macOS
](#macos-系统更新固件说明) | |:----:|:----:|:----:| -| [](#windows-系统更新固件说明) | [](#linux-系统更新固件说明) | [](#macos-系统更新固件说明) | +| [](#windows-系统更新固件说明) | [](#linux-系统更新固件说明) | [](#macos-系统更新固件说明) | -#### Windows 系统更新固件说明 +### Windows 系统更新固件说明 我们推荐使用 `Windows 10` 及以上版本，在该系统下 `USB-Serial-Jtag` 的驱动将联网自动下载。如果使用 `Windows 7` 系统，请手动下载 [USB-Serial-JTAG 驱动](https://dl.espressif.com/dl/idf-driver/idf-driver-esp32-usb-jtag-2021-07-15.zip) 并安装。 -1. [下载最新版本固件](#下载最新版本固件) -2. 使用 USB Type-C 数据线将开发板接入电脑 -3. 初次使用，请确保电脑已联网，驱动正常自动安装后，我们能在设备管理器看到以下设备。这里将多出两个新的设备 `COMX`(此电脑为 `COM2` ) 和 `USB JTAG/serial debug unit`，前者用于下载固件和输出程序日志，后者用于 JTAG 调试 +1. [下载最新版本固件](#下载最新版本固件)。 +2. 使用 USB Type-C 数据线将开发板接入电脑。 +3. 初次使用，请确保电脑已联网。驱动正常自动安装后，我们能在设备管理器看到以下设备。这里将多出两个新的设备 `COMX`（此电脑为 `COM2`）和 `USB JTAG/serial debug unit`，前者用于下载固件和输出程序日志，后者用于 JTAG 调试。
- +
-4. 下载 [Windows download tool](https://www.espressif.com/sites/default/files/tools/flash_download_tool_3.9.2_0.zip)，并解压到任意文件夹，然后请双击打开下载工具可执行文件 `flash_download_tool_x.x.x.exe` -5. 请选择 `chipType`: `ESP32S3`, `workMode`: `develop`, `loadMode`: `usb`，之后点击 `OK` 进入下载工具界面： +4. 下载 [Windows download tool](https://www.espressif.com/sites/default/files/tools/flash_download_tool_3.9.2_0.zip)，并解压到任意文件夹，然后请双击打开下载工具可执行文件 `flash_download_tool_x.x.x.exe`。 +5. 请选择 `chipType` 为 `ESP32S3`, `workMode` 为 `develop`, `loadMode` 为 `usb`，之后点击 `OK` 进入下载工具界面：
- +
-6. 请按照下图指示配置下载工具: - 1. 首先选择 `xxxx.bin` 路径，将地址设置为 `0x0` - 2. 选择下载端口，此电脑为 `COM2` - 3. 点击 `START` 开始固件下载 +6. 请按照下图指示配置下载工具： + 1. 首先选择 `xxxx.bin` 路径，将地址设置为 `0x0`。 + 2. 选择下载端口 COMX，此电脑为 `COM2`。 + 3. 点击 `START` 开始固件下载。
- +
-7. 下载完成后，工具将提示 `FINISH`，之后**重新上电，即可进入新程序！** +7. 下载完成后，工具将提示 `FINISH`，之后**按下 `Reset` 按键，即可进入新程序！**
- +
-#### Linux 系统更新固件说明 +### Linux 系统更新固件说明 -1. [下载最新版本固件](#下载最新版本固件) -2. 使用 USB Type-C 数据线将开发板接入电脑，`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动 +1. [下载最新版本固件](#下载最新版本固件)。 +2. 使用 USB Type-C 数据线将开发板接入电脑，`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动。 3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip` 也可指定为 `pip3`）： ``` @@ -76,7 +76,7 @@ BOX 系列开发板支持使用 USB 接口更新固件，你仅需要准备： ```
- +
4. 请使用以下指令下载固件（`python` 也可指定为 `python3`）： @@ -85,19 +85,19 @@ BOX 系列开发板支持使用 USB 接口更新固件，你仅需要准备： python -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin ``` - 1. `0x0` 是一个固定值，表示即将写入的 flash 地址 - 2. `download_path/test_bin.bin` 是一个变量，请替换为您的固件下载路径和名称 + 1. `0x0` 是一个固定值，表示即将写入的 flash 地址。 + 2. `download_path/test_bin.bin` 是一个变量，请替换为您的固件下载路径和名称。 -5. 下载完成后，工具将提示 `Hash of data verified`，之后**重新上电，即可进入新程序！** +5. 下载完成后，工具将提示 `Hash of data verified`，之后**按下 `Reset` 按键，即可进入新程序！**
- +
-#### macOS 系统更新固件说明 +### macOS 系统更新固件说明 -1. [下载最新版本固件](#下载最新版本固件) -2. 使用 USB Type-C 数据线将开发板接入电脑，`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动 +1. [下载最新版本固件](#下载最新版本固件)。 +2. 使用 USB Type-C 数据线将开发板接入电脑，`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动。 3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip3` 也可指定为 `pip`）： ``` @@ -105,7 +105,7 @@ BOX 系列开发板支持使用 USB 接口更新固件，你仅需要准备： ```
- +
4. 请使用以下指令下载固件（`python3` 也可指定为 `python`）： @@ -114,11 +114,11 @@ BOX 系列开发板支持使用 USB 接口更新固件，你仅需要准备： python3 -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin ``` - 1. `0x0` 是一个固定值，表示即将写入的 flash 地址 - 2. `download_path/test_bin.bin` 是一个变量，请替换为您的固件下载路径和名称 + 1. `0x0` 是一个固定值，表示即将写入的 flash 地址。 + 2. `download_path/test_bin.bin` 是一个变量，请替换为您的固件下载路径和名称。 -5. 下载完成后，工具将提示 `Hash of data verified`，之后**重新上电，即可进入新程序！** +5. 下载完成后，工具将提示 `Hash of data verified`，之后**按下 `Reset` 按键，即可进入新程序！**
- +
\ No newline at end of file