diff --git a/README.md b/README.md index 9a5c75a..3905168 100644 --- a/README.md +++ b/README.md @@ -29,11 +29,12 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif ## User Guide -* 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 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) +* 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 [ESP32-S3-BOX GUI Guide](./docs/getting_started.md#esp32-s3-box-graphical-user-interface) +* For product exploded-view and disassembly tutorial, please refer to [ESP32-S3-BOX Disassembly Tutorial](docs/disassembly_tutorial.md) +* For more detils of ESP32-S3-BOX hardware, please refer to the [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 diff --git a/README_cn.md b/README_cn.md index 8156ab9..3709200 100644 --- a/README_cn.md +++ b/README_cn.md @@ -31,11 +31,12 @@ ESP-BOX 是乐鑫信息科技发布的新一代 AIoT 应用开发平台。ESP32- ## 使用指引 -* 首次拿到 ESP32-S3-BOX,[您可以查看首次使用操作指引](./docs/getting_started_cn.md#给-esp32-s3-box-供电) -* 想要设置独特的语音命令词,[您可以查看修改自定义命令词](./docs/getting_started_cn.md#语音控制命令词自定义) -* 想要通过界面控制设备,[请查看图形界面操作指引](./docs/getting_started_cn.md#esp32-s3-box-图形界面) -* 想要了解 ESP32-S3-BOX 硬件和接口细节,[请查看 ESP32-S3-BOX 硬件总览](./docs/hardware_overview_cn.md) -* 想要使用最新版本固件,[请查看固件更新说明](./docs/firmware_update_cn.md) +* 首次拿到 ESP32-S3-BOX,您可以查看[首次使用操作指引](./docs/getting_started_cn.md#给-esp32-s3-box-供电) +* 想要设置独特的语音命令词,您可以查看[修改自定义命令词](./docs/getting_started_cn.md#语音控制命令词自定义) +* 想要通过界面控制设备,请查看[图形界面操作指引](./docs/getting_started_cn.md#esp32-s3-box-图形界面) +* 想要了解产品爆炸图和拆机说明, 请查看 [ESP32-S3-BOX 拆机教程](docs/disassembly_tutorial.md) +* 想要了解 ESP32-S3-BOX 硬件和接口细节,请查看 [ESP32-S3-BOX 硬件总览](./docs/hardware_overview_cn.md) +* 想要使用最新版本固件,请查看[固件更新说明](./docs/firmware_update_cn.md) ## 开发指引 diff --git a/docs/_static/disassembly_pictures/exploded_view.png b/docs/_static/disassembly_pictures/exploded_view.png new file mode 100644 index 0000000..8d32fe8 Binary files /dev/null and b/docs/_static/disassembly_pictures/exploded_view.png differ diff --git a/docs/_static/disassembly_pictures/figure_1.jpg b/docs/_static/disassembly_pictures/figure_1.jpg new file mode 100644 index 0000000..449f0fe Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_1.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_2.jpg b/docs/_static/disassembly_pictures/figure_2.jpg new file mode 100644 index 0000000..611ab4b Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_2.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_3.jpg b/docs/_static/disassembly_pictures/figure_3.jpg new file mode 100644 index 0000000..f6332d0 Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_3.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_4.jpg b/docs/_static/disassembly_pictures/figure_4.jpg new file mode 100644 index 0000000..34bc8b7 Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_4.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_5.jpg b/docs/_static/disassembly_pictures/figure_5.jpg new file mode 100644 index 0000000..c9f2d83 Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_5.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_6.jpg b/docs/_static/disassembly_pictures/figure_6.jpg new file mode 100644 index 0000000..ba2d1d0 Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_6.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_7.jpg b/docs/_static/disassembly_pictures/figure_7.jpg new file mode 100644 index 0000000..6e86ad7 Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_7.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_8.jpg b/docs/_static/disassembly_pictures/figure_8.jpg new file mode 100644 index 0000000..b4d908d Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_8.jpg differ diff --git a/docs/_static/disassembly_pictures/figure_9.jpg b/docs/_static/disassembly_pictures/figure_9.jpg new file mode 100644 index 0000000..fa02c11 Binary files /dev/null and b/docs/_static/disassembly_pictures/figure_9.jpg differ diff --git a/docs/_static/linux-logo.png b/docs/_static/linux-logo.png new file mode 100644 index 0000000..1112db6 Binary files /dev/null and b/docs/_static/linux-logo.png differ diff --git a/docs/_static/macos-logo.jpg b/docs/_static/macos-logo.jpg new file mode 100644 index 0000000..d07d2f4 Binary files /dev/null and b/docs/_static/macos-logo.jpg differ diff --git a/docs/_static/macos-logo.png b/docs/_static/macos-logo.png new file mode 100644 index 0000000..289d1f6 Binary files /dev/null and b/docs/_static/macos-logo.png differ diff --git a/docs/_static/windows-logo.png b/docs/_static/windows-logo.png new file mode 100644 index 0000000..122f53a Binary files /dev/null and b/docs/_static/windows-logo.png differ diff --git a/docs/disassembly_tutorial.md b/docs/disassembly_tutorial.md new file mode 100644 index 0000000..422a404 --- /dev/null +++ b/docs/disassembly_tutorial.md @@ -0,0 +1,73 @@ +# ESP32-S3-BOX Disassembly Tutorial + +## Exploded View + +The figure below depicts an exploded view of the ESP32-S3-BOX, which shows the relationship or order of assembly of various parts and how they fit together. The projection of the ESP32-S3-BOX main unit has seven layers, beginning from the top layer and arranging in descending order as shown in the picture below. + +
+ +
+ +> **Warning**: Disassembling the ESP32-S3–BOX may damage the hardware structure. Espressif will not be responsible for any damages resulting from the disassembling. + +## Disassembly Tutorial + +### What Do You Need + +- A Hot Air Blower +- A Flat-Head Screwdriver +- A Phillips-Head Screwdriver + +### Components Overview + +The following tutorial will guide you to disassemble the development board step-by-step. Once you have dissembled the development board, there will be 7 main components as shown below. Please keep them well. + +
+ +
+ +### Step-by-step Guide + +- The first step is to remove the touch display that is glued to the frame. Next, please use a "Hot Air Blower" perpendicularly on the edge of the touch screen to loosen the adhesive materials. +- Use the "Flat-Head Screwdriver" to pry off the touch screen. Please be careful, as you may damage the FPC cable and the glass cover of the touch screen when removing the touch screen from the development board. + +
+ +
+ +- While tearing off the touch screen, you will observe the touch panel is connected to the mainboard by two FPC cables, 8 pin and 20 pin, respectively. Unlock the two FPC connectors and take down the whole touch screen. + +
+ +
+ +- Use the “Phillips-Head Screwdriver” to remove the three self-tapping screws. Use the "Flat-Head Screwdriver" to remove the middle frame from the edge. +. Use the "Flat-Head Screwdriver" to remove the middle frame from the edge. + +
+ +
+ +> **Note**: The middle frame is 3D printed, it might be tight while removing the middle frame from the case. Try to open the snap-fit from the edge. + +- You will see a microphone sub-board attached to the back of the middle frame. The mic sub-board is connected to the mainboard through a 6 pin FPC cable. Unscrew the two screws of the mic sub-board and unlock one side of the 6 pin FPC cable to remove the sub-board completely. + +
+ +
+ +- Now, only the mainboard is embedded in the case. Unscrew the last three screws on the mainboard and take out the board. You will see the 6 pin FPC cable on the other side, unlock the connector and take off the FPC cable. + +
+ +
+ +
+ +
+ +- The speaker is glued to the side of the bottom case, and its connector is soldered to the mainboard PCBA. You can remove it from PCBA using the soldering iron. + +
+ +
diff --git a/docs/firmware_update.md b/docs/firmware_update.md index e856bfc..9138922 100644 --- a/docs/firmware_update.md +++ b/docs/firmware_update.md @@ -1,13 +1,13 @@ * [中文版本](./firmware_update_cn.md) -## Update ESP32-S3-BOX Firmware +# 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 +## Latest Firmware Download For the latest firmware, please refer to: https://github.com/espressif/esp-box/releases @@ -19,7 +19,15 @@ For the latest firmware, please refer to: https://github.com/espressif/esp-box/r -### Firmware update for Windows +## Firmware update + +Please follow the link below correspond to your OS to update the ESP-S3-BOX firmware. + +| [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 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. @@ -59,7 +67,7 @@ We recommend using `Windows 10` and above system. Under `Windows 10` system, the -### Firmware update for Linux +#### 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. @@ -88,7 +96,7 @@ We recommend using `Windows 10` and above system. Under `Windows 10` system, the -### Firmware update for macOS +#### Firmware update for macOS 1. [Download latest firmware](https://github.com/espressif/esp-box/releases) diff --git a/docs/firmware_update_cn.md b/docs/firmware_update_cn.md index 6764bf4..c1e3c0d 100644 --- a/docs/firmware_update_cn.md +++ b/docs/firmware_update_cn.md @@ -1,13 +1,13 @@ * [English Version](./firmware_update.md) -## 更新 ESP32-S3-BOX 固件 +# 更新 ESP32-S3-BOX 固件 ESP32-S3-BOX 支持使用 USB 接口更新固件,你仅需要准备: 1. 一根 USB Type-C 数据线 2. 最新版本固件(bin 文件) -### 下载最新版本固件 +## 下载最新版本固件 请下载最新版本固件,固件下载链接为:https://github.com/espressif/esp-box/releases @@ -19,7 +19,15 @@ ESP32-S3-BOX 支持使用 USB 接口更新固件,你仅需要准备: -### Windows 系统更新固件说明 +## 固件更新 + +不同操作系统的固件更新方法,请参考以下连接: + +| [Windows](#windows-系统更新固件说明) | [Linux](#linux-系统更新固件说明) | [macOS](#macos-系统更新固件说明) | +|:----:|:----:|:----:| +| [](#windows-系统更新固件说明) | [](#linux-系统更新固件说明) | [](#macos-系统更新固件说明) | + +#### 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) 并安装。 @@ -59,7 +67,7 @@ ESP32-S3-BOX 支持使用 USB 接口更新固件,你仅需要准备: -### Linux 系统更新固件说明 +#### Linux 系统更新固件说明 1. [下载最新版本固件](https://github.com/espressif/esp-box/releases) 2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑,`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动 @@ -93,7 +101,7 @@ ESP32-S3-BOX 支持使用 USB 接口更新固件,你仅需要准备: -### macOS 系统更新固件说明 +#### macOS 系统更新固件说明 1. [下载最新版本固件](https://github.com/espressif/esp-box/releases) 2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑,`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动