From 7b8811012256947f1056d3da0c4dcca81e2fd018 Mon Sep 17 00:00:00 2001 From: Li Bo Date: Mon, 22 Nov 2021 19:46:31 +0800 Subject: [PATCH] docs(readme): fix minor issues --- README.md | 30 ++++---- README_cn.md | 15 ++-- docs/firmeware_update.md | 121 +------------------------------- docs/firmeware_update_cn.md | 129 +---------------------------------- docs/firmware_update.md | 120 ++++++++++++++++++++++++++++++++ docs/firmware_update_cn.md | 128 ++++++++++++++++++++++++++++++++++ docs/hardware_overview.md | 14 ++-- docs/hardware_overview_cn.md | 14 ++-- 8 files changed, 289 insertions(+), 282 deletions(-) create mode 100644 docs/firmware_update.md create mode 100644 docs/firmware_update_cn.md diff --git a/README.md b/README.md index a4e25fbf..9a5c75a2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -* [中文版本](README.md) +* [中文版本](README_cn.md) # ESP-BOX AIoT Development Framework -**Important Note: We recommend [updating the ESP32-S3-BOX firmware](./docs/firmeware_update.md) when you first receive the product to have the latest features and bugfix.** +**Important Note: We recommend [updating the ESP32-S3-BOX firmware](./docs/firmware_update.md) when you first receive the product to have the latest features and bugfix.** The ESP-BOX is a new generation AIoT development platform released by Espressif Systems. The ESP32-S3-BOX is an AIoT development board that is based on Espressif’s ESP32-S3 Wi-Fi + Bluetooth 5 (LE) SoC. The ESP32-S3-BOX provides a platform for developing the control of home appliances using Voice Assistance + touch screen controller, sensor, infrared controller, and intelligent Wi-Fi gateway. The ESP32-S3-BOX comes with pre-built firmware that supports offline voice interaction, with the SDKs and examples provided by Espressif, you will be able to develop a wide variety of AIoT applications based on the ESP32-S3-BOX such as online and offline voice assistants, voice-enabled devices, HMI touch-screen devices, control panels, multi-protocol gateways easily. @@ -16,7 +16,7 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif * Reconfigurable voice commands in Chinese and English languages * Flexible and reusable GUI framework * End-to-end IoT development framework ESP-RainMaker -* Pmod™ compatible headers supports expand peripheral modules +* Pmod™ compatible headers support expand peripheral modules **ESP-BOX Open-Source Content Include:** @@ -29,24 +29,24 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif ## User Guide -* For getting start of ESP32-S3-BOX, [Please to the Getting Started](./docs/getting_started.md) -* For voice control and customization，[Please refer to the Voice Assistance Control and Customization](./docs/getting_started.md#voice-assistance-control-and-customization) +* For getting start of ESP32-S3-BOX, [Please refer to the Getting Started](./docs/getting_started.md) +* For voice control and customization, [Please refer to the Voice Assistance Control and Customization](./docs/getting_started.md#voice-assistance-control-and-customization) * For control the device by graphical user interface, [Please refer to the GUI Guide](./docs/getting_started.md#esp32-s3-box-graphical-user-interface) -* For more detils of ESP32-S3-BOX hardware，[Please refer to ESP-BOX hardware overview](./docs/hardware_overview.md) -* For latest version firmware，[Please refer to the ESP32-S3-BOX firmware update](./docs/firmeware_update.md) +* For more detils of ESP32-S3-BOX hardware, [Please refer to ESP32-S3-BOX hardware overview](./docs/hardware_overview.md) +* For latest version firmware, [Please refer to the ESP32-S3-BOX firmware update](./docs/firmware_update.md) ## Developer Guide -* **Step 1**. ESP-IDF (Espressif IoT Development Framework) is required to build the application. If this is your first time using the ESP-IDF, please refer to [ESP-IDF development guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/index.html) to understand the open-source drive and components provided by Espressif. +* **Step 1**. ESP-IDF (Espressif IoT Development Framework) is required to build the application. If this is your first time using the ESP-IDF, please refer to [ESP-IDF development guide](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/index.html) to understand the open-source drivers and components provided by Espressif. * **Step 2**. Next, setting up development environment. Please refer to [ESP-IDF(release/v4.4) Installation Step by Step](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/get-started/index.html#installation-step-by-step). * **Step 3**. Additionally, apply the patch files on current ESP-IDF, please refer [Patch for ESP-IDF](./idf_patch) for details. -* **Step 4**. Take a small step，you can [build and flash a simple example](/examples/image_display). -* **Step 5**. Moving further，please read [ESP-BOX technical architecture](./docs/technical_architecture.md) to understand the technical details. -* **Step 6**. Going deeper，please read [ESP Speech Recognition Application Guide](https://github.com/espressif/esp-sr), [ESP RainMaker Programming Guide](https://docs.espressif.com/projects/esp-rainmaker/en/latest/), [LVGL GUI Quick overview](https://docs.lvgl.io/latest/en/html/get-started/quick-overview.html). -* **Step 7**. For extended function, please read [ESP-BOX Pmod™ compatible headers](./docs/hardware_overview.md) and [ESP-IDF API reference](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/index.html)，to develop drivers for more extended devices. +* **Step 4**. Take a small step, you can [build and flash a simple example](./examples/image_display). +* **Step 5**. Moving further, please read [ESP-BOX technical architecture](./docs/technical_architecture.md) to understand the technical details. +* **Step 6**. Going deeper, please read [ESP Speech Recognition Application Guide](https://github.com/espressif/esp-sr), [ESP RainMaker Programming Guide](https://docs.espressif.com/projects/esp-rainmaker/en/latest/), [LVGL GUI Quick overview](https://docs.lvgl.io/latest/en/html/get-started/quick-overview.html). +* **Step 7**. For extended function, please read [ESP32-S3-BOX Pmod™ compatible headers](./docs/hardware_overview.md) and [ESP-IDF API reference](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/index.html), to develop drivers for more extended devices. ## Contact Us -* Should you have any technical issues, please submit a issue ticket at [GitHub Issues](https://github.com/espressif/esp-box/issues) or forum esp32.com for help. -* If you are interested with ESP-BOX project，welcome to the [ESP-BOX forum](https://esp32.com/viewforum.php?f=44) to share with us your idea. -* We welcome any open-source software or hardware contribution. Please commit to the [Pull Requests](https://github.com/espressif/esp-box/pulls) to contrinute your code. \ No newline at end of file +* If you have any technical issues, please submit issue tickets at [GitHub Issues](https://github.com/espressif/esp-box/issues) or forum [esp32.com](https://esp32.com/) for help. +* If you are interested in ESP-BOX project, welcome to the [ESP-BOX forum](https://esp32.com/viewforum.php?f=44) to share with us your ideas. +* We welcome any open-source software or hardware contribution. Please commit to the [Pull Requests](https://github.com/espressif/esp-box/pulls) to contribute your code. \ No newline at end of file diff --git a/README_cn.md b/README_cn.md index e97293ed..8156ab90 100644 --- a/README_cn.md +++ b/README_cn.md @@ -1,9 +1,10 @@ * [English Version](./README.md) +* [Gitee 镜像仓库](https://gitee.com/EspressifSystems/esp-box) # ESP-BOX AIoT 开发框架 **重要提醒：** -**我们建议您在第一次收到产品时[更新 ESP32-S3-BOX 的固件](./docs/firmeware_update_cn.md)以获得最新功能和 bug 的修复。** +**我们建议您在第一次收到产品时[更新 ESP32-S3-BOX 的固件](./docs/firmware_update_cn.md)以获得最新功能和 bug 的修复。** ESP-BOX 是乐鑫信息科技发布的新一代 AIoT 应用开发平台。ESP32-S3-BOX 是对应的 AIoT 应用开发板，搭载支持 AI 加速的 ESP32-S3 Wi-Fi + Bluetooth 5 (LE) SoC。ESP32-S3-BOX 为用户提供了一个基于语音助手 + 触摸屏控制、传感器、红外控制器和智能 Wi-Fi 网关等功能，开发和控制智能家居设备的平台。ESP32-S3-BOX 出厂支持离线语音交互功能，通过乐鑫丰富的 SDK 和解决方案，能够轻松构建在线和离线语音助手、智能语音设备、HMI 触摸屏设备、控制面板、多协议网关等多样的应用。 @@ -30,24 +31,24 @@ ESP-BOX 是乐鑫信息科技发布的新一代 AIoT 应用开发平台。ESP32- ## 使用指引 -* 首次拿到 ESP-BOX，[您可以查看首次使用操作指引](./docs/getting_started_cn.md#给-esp32-s3-box-供电) +* 首次拿到 ESP32-S3-BOX，[您可以查看首次使用操作指引](./docs/getting_started_cn.md#给-esp32-s3-box-供电) * 想要设置独特的语音命令词，[您可以查看修改自定义命令词](./docs/getting_started_cn.md#语音控制命令词自定义) * 想要通过界面控制设备，[请查看图形界面操作指引](./docs/getting_started_cn.md#esp32-s3-box-图形界面) -* 想要了解 ESP-BOX 硬件和接口细节，[请查看ESP-BOX 硬件总览](./docs/hardware_overview_cn.md) -* 想要使用最新版本固件，[请查看固件更新说明](./docs/firmeware_update_cn.md) +* 想要了解 ESP32-S3-BOX 硬件和接口细节，[请查看 ESP32-S3-BOX 硬件总览](./docs/hardware_overview_cn.md) +* 想要使用最新版本固件，[请查看固件更新说明](./docs/firmware_update_cn.md) ## 开发指引 * **Step 1**. 如果您首次接触 ESP-IDF 开发，建议先浏览 [ESP-IDF 编程指南](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/index.html)，了解乐鑫已经提供的开源驱动和组件； * **Step 2**. 接下来您可以详细阅读 [ESP-IDF（release/v4.4） 环境搭建指引](https://docs.espressif.com/projects/esp-idf/en/release-v4.4/esp32s3/get-started/index.html#installation-step-by-step), 一步一步完成开发环境搭建； * **Step 3**. 此外, 请在当前 ESP-IDF 上打上补丁, 详情请参考 [Patch for ESP-IDF](./idf_patch). -* **Step 4**. 小试牛刀，您可以尝试 [构建并烧录一个新的示例程序](/examples/image_display)； +* **Step 4**. 小试牛刀，您可以尝试 [构建并烧录一个新的示例程序](./examples/image_display)； * **Step 5**. 更进一步，您可以阅读 [ESP-BOX 技术架构说明](./docs/technical_architecture_cn.md)，了解更多技术细节； * **Step 6**. 深入开发，您可以阅读 [ESP 语音识别应用开发指南](https://github.com/espressif/esp-sr), [ESP RainMaker 编程指南](https://docs.espressif.com/projects/esp-rainmaker/en/latest/), [LVGL UI 界面开发快速总览](https://docs.lvgl.io/latest/en/html/get-started/quick-overview.html)； -* **Step 7**. 扩展功能，您可以阅读 [ESP-BOX Pmod™ 兼容接口介绍](./docs/hardware_overview_cn.md) 和 [ESP-IDF API 参考手册](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/index.html)，为更多扩展设备开发驱动； +* **Step 7**. 扩展功能，您可以阅读 [ESP32-S3-BOX Pmod™ 兼容接口介绍](./docs/hardware_overview_cn.md) 和 [ESP-IDF API 参考手册](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/index.html)，为更多扩展设备开发驱动； ## 联系我们 -* 如果有任何开发和使用问题，您可添加 [GitHub Issues](https://github.com/espressif/esp-box/issues) 或到 esp32.com 论坛寻求帮助； +* 如果有任何开发和使用问题，您可添加 [GitHub Issues](https://github.com/espressif/esp-box/issues) 或到 [esp32.com](https://esp32.com/) 论坛寻求帮助； * 如果你对 ESP-BOX 项目感兴趣，欢迎到论坛 [ESP-BOX 版块](https://esp32.com/viewforum.php?f=43)交流想法； * 我们欢迎任何软件或硬件相关的开源贡献，您可直接提交 [Pull Requests](https://github.com/espressif/esp-box/pulls) 贡献代码。 diff --git a/docs/firmeware_update.md b/docs/firmeware_update.md index 989564f8..95eff55e 100644 --- a/docs/firmeware_update.md +++ b/docs/firmeware_update.md @@ -1,120 +1,3 @@ -* [中文版本](./firmeware_update_cn.md) +> This file is deprecated, please redirect to the following link: -## Update ESP32-S3-BOX Firmware - -ESP32-S3-BOX supports updating firmware through USB, you just need: - -1. USB Type-C cable -2. [Latest firmware bin file](https://github.com/espressif/esp-box/releases) - -### Download Latest Firmware - -For latest firmware, please refer to: https://github.com/espressif/esp-box/releases - -1. Choose latest release version -2. Click `Assets` to show more files -3. Choose a `xxxxxx.bin` to download - -
- -
- -### Firmware update 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) manully. - -1. [Download latest firmware](https://github.com/espressif/esp-box/releases) -2. Connect ESP32-S3-BOX to the computer through USB Type-C cable. - -
- -
- -3. Please make sure the computer is connected to the Internet firstly. When the driver is installed, you can find the devices in `Device Manager`. There will be two more new devices `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. - -
- -
- -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 ui: - -
- -
- -6. Configure the download tool follow the instruction below: - 1. Choose the path of firmwire `xxxx.bin` , and set the address to `0x0` - 2. Select the COM port, like `COM2` for this PC. - 3. Click `START` to start download. - -
- -
- -7. After downloading, `FINISH` will shown in the tool, then **please reboot to run the new firmware!** - -
- -
- - -### Firmware update for Linux - -1. [Download latest firmware](https://github.com/espressif/esp-box/releases) -2. Connect ESP32-S3-BOX 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 following commands in `Terminal` (`pip` can be specified as `pip3`) : - - ``` - pip install esptool - ``` - -
- -
- -4. Download firmware using following instruction (`pip` can be specified as `pip3`)： - - ``` - python -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin - ``` - - 1. `0x0` is the flash address - 2. `download_path/test_bin.bin` is the name and path the downloaded firmware. - -5. After updating, download tool will prompt `Hash of data verified`, then **please reboot to run the new firmware!** - -
- -
- -### Firmware update for macOS - -1. [Download latest firmware](https://github.com/espressif/esp-box/releases) - -2. Connect ESP32-S3-BOX 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 following codes in `Terminal` (`pip3` can be specified as `pip`) : - - ``` - pip3 install esptool - ``` - -
- -
- -4. Download firmware using following commands (`pip3` can be specified as `pip`): - - ``` - python3 -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin - ``` - - 1. `0x0` is the flash address - 2. `download_path/test_bin.bin` is the name and path for the downloaded firmware. - -5. After updating, download tool will prompt `Hash of data verified`, then **please reboot to run the new firmware!** - -
- -
\ No newline at end of file +* [firmeware update](./firmware_update.md) diff --git a/docs/firmeware_update_cn.md b/docs/firmeware_update_cn.md index 5b74a564..d8b93be8 100644 --- a/docs/firmeware_update_cn.md +++ b/docs/firmeware_update_cn.md @@ -1,128 +1,3 @@ -* [English Version](./firmeware_update.md) +> 该文件已废弃，请重定向到以下链接： -## 更新 ESP32-S3-BOX 固件 - -ESP32-S3-BOX 支持使用 USB 接口更新固件，你仅需要准备： - -1. 一根 USB Type-C 数据线 -2. 最新版本固件（bin 文件） - -### 下载最新版本固件 - -请下载最新版本固件，固件下载链接为：https://github.com/espressif/esp-box/releases - -1. 请先选择一个固件（建议使用最新 release） -2. 点击 `Assets` 展开下载链接 -3. 选择一个 `xxxxxx.bin` 进行下载 - -
- -
- -### 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. [下载最新版本固件](https://github.com/espressif/esp-box/releases) -2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑 - -
- -
- -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` 进入下载工具界面： - -
- -
- -6. 请按照下图指示配置下载工具: - 1. 首先选择 `xxxx.bin` 路径，将地址设置为 `0x0` - 2. 选择下载端口，此电脑为 `COM2` - 3. 点击 `START` 开始固件下载 - -
- -
- -7. 下载完成后，工具将提示 `FINISH`，之后**重新上电，即可进入新程序！** - -
- -
- - -### Linux 系统更新固件说明 - -1. [下载最新版本固件](https://github.com/espressif/esp-box/releases) -2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑，`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动 - -
- -
- -3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip` 也可指定为 `pip3`）： - - ``` - pip install esptool - ``` - -
- -
- -4. 请使用以下指令下载固件（`python` 也可指定为 `python3`）： - - ``` - python -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin - ``` - - 1. `0x0` 是即将写入的 flash 地址 - 2. `download_path/test_bin.bin` 为固件下载的路径和名称 - -5. 下载完成后，工具将提示 `Hash of data verified`，之后**重新上电，即可进入新程序！** - -
- -
- -### macOS 系统更新固件说明 - -1. [下载最新版本固件](https://github.com/espressif/esp-box/releases) -2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑，`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动 - -
- -
- -3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip3` 也可指定为 `pip`）： - - ``` - pip3 install esptool - ``` - -
- -
- -4. 请使用以下指令下载固件（`python3` 也可指定为 `python`）： - - ``` - python3 -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin - ``` - - 1. `0x0` 是即将写入的 flash 地址 - 2. `download_path/test_bin.bin` 为固件下载的路径和名称 - -5. 下载完成后，工具将提示 `Hash of data verified`，之后**重新上电，即可进入新程序！** - -
- -
\ No newline at end of file +* [固件更新](./firmware_update_cn.md) \ No newline at end of file diff --git a/docs/firmware_update.md b/docs/firmware_update.md new file mode 100644 index 00000000..e856bfcc --- /dev/null +++ b/docs/firmware_update.md @@ -0,0 +1,120 @@ +* [中文版本](./firmware_update_cn.md) + +## Update ESP32-S3-BOX Firmware + +ESP32-S3-BOX supports updating firmware through USB, you just need: + +1. USB Type-C cable +2. [Latest firmware bin file](https://github.com/espressif/esp-box/releases) + +### Download Latest Firmware + +For the latest firmware, please refer 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 + +
+ +
+ +### Firmware update 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. + +1. [Download latest firmware](https://github.com/espressif/esp-box/releases) +2. Connect ESP32-S3-BOX 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. + +
+ +
+ +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. + +
+ +
+ +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. + 3. Click `START` to start the downloading. + +
+ +
+ +7. After downloading, `FINISH` will appear on the tool. Next, **please reboot to run the new firmware!** + +
+ +
+ + +### Firmware update for Linux + +1. [Download latest firmware](https://github.com/espressif/esp-box/releases) +2. Connect ESP32-S3-BOX 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`) : + + ``` + pip install esptool + ``` + +
+ +
+ +4. Follow the 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 flash address + 2. `download_path/test_bin.bin` is the name and path the downloaded firmware. + +5. After updating, the download tool will prompt `Hash of data verified`. Next, **please reboot to run the new firmware!** + +
+ +
+ +### Firmware update for macOS + +1. [Download latest firmware](https://github.com/espressif/esp-box/releases) + +2. Connect ESP32-S3-BOX 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`) : + + ``` + pip3 install esptool + ``` + +
+ +
+ +4. Follow the 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 flash address + 2. `download_path/test_bin.bin` is the name and path for the downloaded firmware. + +5. After updating, the download tool will prompt `Hash of data verified`. Next, **please reboot 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 new file mode 100644 index 00000000..6764bf4d --- /dev/null +++ b/docs/firmware_update_cn.md @@ -0,0 +1,128 @@ +* [English Version](./firmware_update.md) + +## 更新 ESP32-S3-BOX 固件 + +ESP32-S3-BOX 支持使用 USB 接口更新固件，你仅需要准备： + +1. 一根 USB Type-C 数据线 +2. 最新版本固件（bin 文件） + +### 下载最新版本固件 + +请下载最新版本固件，固件下载链接为：https://github.com/espressif/esp-box/releases + +1. 请先选择一个固件（建议使用最新 release） +2. 点击 `Assets` 展开下载链接 +3. 选择一个 `xxxxxx.bin` 进行下载 + +
+ +
+ +### 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. [下载最新版本固件](https://github.com/espressif/esp-box/releases) +2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑 + +
+ +
+ +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` 进入下载工具界面： + +
+ +
+ +6. 请按照下图指示配置下载工具: + 1. 首先选择 `xxxx.bin` 路径，将地址设置为 `0x0` + 2. 选择下载端口，此电脑为 `COM2` + 3. 点击 `START` 开始固件下载 + +
+ +
+ +7. 下载完成后，工具将提示 `FINISH`，之后**重新上电，即可进入新程序！** + +
+ +
+ + +### Linux 系统更新固件说明 + +1. [下载最新版本固件](https://github.com/espressif/esp-box/releases) +2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑，`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动 + +
+ +
+ +3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip` 也可指定为 `pip3`）： + + ``` + pip install esptool + ``` + +
+ +
+ +4. 请使用以下指令下载固件（`python` 也可指定为 `python3`）： + + ``` + python -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin + ``` + + 1. `0x0` 是即将写入的 flash 地址 + 2. `download_path/test_bin.bin` 为固件下载的路径和名称 + +5. 下载完成后，工具将提示 `Hash of data verified`，之后**重新上电，即可进入新程序！** + +
+ +
+ +### macOS 系统更新固件说明 + +1. [下载最新版本固件](https://github.com/espressif/esp-box/releases) +2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑，`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动 + +
+ +
+ +3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip3` 也可指定为 `pip`）： + + ``` + pip3 install esptool + ``` + +
+ +
+ +4. 请使用以下指令下载固件（`python3` 也可指定为 `python`）： + + ``` + python3 -m esptool --chip esp32s3 write_flash 0x0 download_path/test_bin.bin + ``` + + 1. `0x0` 是即将写入的 flash 地址 + 2. `download_path/test_bin.bin` 为固件下载的路径和名称 + +5. 下载完成后，工具将提示 `Hash of data verified`，之后**重新上电，即可进入新程序！** + +
+ +
\ No newline at end of file diff --git a/docs/hardware_overview.md b/docs/hardware_overview.md index 61232b0b..29876d9b 100644 --- a/docs/hardware_overview.md +++ b/docs/hardware_overview.md @@ -4,13 +4,13 @@ ### Hardware Source Files -* [ESP-BOX Mainboard Schematic](../hardware/esp32_s3_box_v2.5/schematic) -* [ESP-BOX Mainboard PCB](../hardware/esp32_s3_box_v2.5/pcb) -* [ESP-BOX Mainboard Gerber](../hardware/esp32_s3_box_v2.5/gerber) -* [ESP-BOX Subboard Schematic](../hardware/esp32_s3_box_sub_v2.2/schematic) -* [ESP-BOX Subboard PCB](../hardware/esp32_s3_box_sub_v2.2/pcb) -* [ESP-BOX Subboard Gerber](../hardware/esp32_s3_box_sub_v2.2/gerber) -* [ESP-BOX Shell CAD STEP](../hardware/esp32_s3_box_shell_step) +* [ESP32-S3-BOX Mainboard Schematic](../hardware/esp32_s3_box_v2.5/schematic) +* [ESP32-S3-BOX Mainboard PCB](../hardware/esp32_s3_box_v2.5/pcb) +* [ESP32-S3-BOX Mainboard Gerber](../hardware/esp32_s3_box_v2.5/gerber) +* [ESP32-S3-BOX Subboard Schematic](../hardware/esp32_s3_box_sub_v2.2/schematic) +* [ESP32-S3-BOX Subboard PCB](../hardware/esp32_s3_box_sub_v2.2/pcb) +* [ESP32-S3-BOX Subboard Gerber](../hardware/esp32_s3_box_sub_v2.2/gerber) +* [ESP32-S3-BOX Shell CAD STEP](../hardware/esp32_s3_box_shell_step) ### Specifications: diff --git a/docs/hardware_overview_cn.md b/docs/hardware_overview_cn.md index d560e494..ef34b21c 100644 --- a/docs/hardware_overview_cn.md +++ b/docs/hardware_overview_cn.md @@ -4,13 +4,13 @@ ### 硬件开源资料 -* [ESP-BOX Mainboard Schematic](../hardware/esp32_s3_box_v2.5/schematic) -* [ESP-BOX Mainboard PCB](../hardware/esp32_s3_box_v2.5/pcb) -* [ESP-BOX Mainboard Gerber](../hardware/esp32_s3_box_v2.5/gerber) -* [ESP-BOX Subboard Schematic](../hardware/esp32_s3_box_sub_v2.2/schematic) -* [ESP-BOX Subboard PCB](../hardware/esp32_s3_box_sub_v2.2/pcb) -* [ESP-BOX Subboard Gerber](../hardware/esp32_s3_box_sub_v2.2/gerber) -* [ESP-BOX Shell CAD STEP](../hardware/esp32_s3_box_shell_step) +* [ESP32-S3-BOX Mainboard Schematic](../hardware/esp32_s3_box_v2.5/schematic) +* [ESP32-S3-BOX Mainboard PCB](../hardware/esp32_s3_box_v2.5/pcb) +* [ESP32-S3-BOX Mainboard Gerber](../hardware/esp32_s3_box_v2.5/gerber) +* [ESP32-S3-BOX Subboard Schematic](../hardware/esp32_s3_box_sub_v2.2/schematic) +* [ESP32-S3-BOX Subboard PCB](../hardware/esp32_s3_box_sub_v2.2/pcb) +* [ESP32-S3-BOX Subboard Gerber](../hardware/esp32_s3_box_sub_v2.2/gerber) +* [ESP32-S3-BOX Shell CAD STEP](../hardware/esp32_s3_box_shell_step) ### 规格参数