Merge branch 'docs/prepare_tag_0.3.0' into 'master'

docs: add driver IC and update readme and firmware download part See merge request ae_group/esp-box!37
espressif · Jun 9, 2022 · a45ee1e · a45ee1e
2 parents cc7610d + a1e4586
commit a45ee1e
Show file tree

Hide file tree

Showing 12 changed files with 32 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -26,9 +26,10 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif
 
 ## Versions
 
-|      ESP-Box     | Dependent ESP-IDF |  Branch Note                                           | Support State  |
+|      ESP-BOX     | Dependent ESP-IDF |  Branch Note                                           | Support State  |
 | :--------------: | :---------------: | :----------------------------------------------------: | -------------- |
 |      master      | release/v4.4<br>commit id: 2bdea81b2a |  Latest developing firmware <br/>esp-sr version:  dev/v2.0<br>commit id: c873a35  | New feature develop, compatible with ESP32-S3-BOX and ESP32-S3-BOX-Lite |
+|      Tag 0.3.0     | release/v4.4<br>commit id: 2bdea81b2a | esp-sr version:  dev/v2.0<br>commit id: c873a35  | Compatible with ESP32-S3-BOX and ESP32-S3-BOX-Lite |
 | Tag 0.2.1 | release/v4.4 with [patch](https://github.com/espressif/esp-box/tree/v0.2.1/idf_patch) | esp-sr version: close v1.0<br/>commit id: 3ce34fe | Support ESP32-S3-BOX only |
 | Tag 0.1.1 | release/v4.4 with [patch](https://github.com/espressif/esp-box/tree/v0.1.1/idf_patch) | esp-sr version: v0.9.6<br/>commit id: 3ce34fe | Support ESP32-S3-BOX only |
 

diff --git a/README_cn.md b/README_cn.md
@@ -26,9 +26,10 @@ ESP-BOX 是乐鑫信息科技发布的新一代 AIoT 应用开发平台。ESP32-
 
 ## 版本信息
 
-|  ESP-Box  |                        依赖的 ESP-IDF                        |                           分支信息                           | 支持状态                                                |
+|  ESP-BOX  |                        依赖的 ESP-IDF                        |                           分支信息                           | 支持状态                                                |
 | :-------: | :----------------------------------------------------------: | :----------------------------------------------------------: | ------------------------------------------------------- |
-|  master   |            release/v4.4<br/>commit id: 2bdea81b2a            | Latest developing firmware <br/>esp-sr version:  dev/v2.0<br/>commit id: c873a35 | 新功能开发分支，兼容  ESP32-S3-BOX 和 ESP32-S3-BOX-Lite |
+|  master   |            release/v4.4<br/>commit id: 2bdea81b2a            | Latest developing firmware <br/>esp-sr version:  dev/v2.0<br/>commit id: c873a35 | 新功能开发分支，兼容  ESP32-S3-BOX 和 ESP32-S3-BOX-Lite |
+|  Tag 0.3.0   |            release/v4.4<br/>commit id: 2bdea81b2a            | esp-sr version: dev/v2.0<br/>commit id: c873a35 | 兼容  ESP32-S3-BOX 和 ESP32-S3-BOX-Lite |
 | Tag 0.2.1 | release/v4.4 with [patch](https://github.com/espressif/esp-box/tree/v0.2.1/idf_patch) |      esp-sr version: close v1.0<br/>commit id: 3ce34fe       | 仅支持 ESP32-S3-BOX                                     |
 | Tag 0.1.1 | Release/v4.4 with [patch](https://github.com/espressif/esp-box/tree/v0.1.1/idf_patch) |        esp-sr version: v0.9.6<br/>commit id: 3ce34fe         | 仅支持 ESP32-S3-BOX                                     |
 

diff --git a/docs/_static/_table/specs_for_box.md b/docs/_static/_table/specs_for_box.md
@@ -101,6 +101,12 @@
     <td class="tg-zr06">Touch Points:</td>
     <td class="tg-zr06">10</td>
   </tr>
+  <tr>
+    <td class="tg-ycr8">Driver IC</td>
+    <td class="tg-ycr8">ILI9342C</td>
+    <td class="tg-ycr8"></td>
+    <td class="tg-ycr8"></td>
+  </tr>
   <tr>
     <td class="tg-o2c7" colspan="4"><span style="font-weight:bold">Microphone</span></td>
   </tr>

diff --git a/docs/_static/_table/specs_for_box.png b/docs/_static/_table/specs_for_box.png
diff --git a/docs/_static/_table/specs_for_lite.md b/docs/_static/_table/specs_for_lite.md
@@ -94,6 +94,12 @@
     <td class="tg-zr06">SPI</td>
     <td class="tg-zr06">Interface Speed:</td>
     <td class="tg-zr06">40 MHz</td>
+  </tr>
+    <tr>
+    <td class="tg-ycr8">Driver IC:</td>
+    <td class="tg-ycr8">ST7789V</td>
+    <td class="tg-ycr8"></td>
+    <td class="tg-ycr8"></td>
   </tr>
     <tr>
     <td class="tg-o2c7" colspan="4"><span style="font-weight:bold">Microphone</span></td>

diff --git a/docs/_static/_table/specs_for_lite.png b/docs/_static/_table/specs_for_lite.png
diff --git a/docs/firmeware_update.md b/docs/firmeware_update.md
diff --git a/docs/firmeware_update_cn.md b/docs/firmeware_update_cn.md
diff --git a/docs/firmware_update.md b/docs/firmware_update.md
@@ -12,22 +12,6 @@ The BOX series development boards support updating firmware through USB, you jus
 
 ## Latest Firmware Download
 
-We have two kinds of firmware, the latest developing firmware and the latest release firmware. Flashing developing firmware, you can experiance the new features, flashing latest release firmware, which is more stable than the developing firmware but does not contain new features.
-
-### Latest developing firmware
-
-For the developing firmware, please refer to: https://github.com/espressif/esp-box/actions
-
-1. Click the `Action`
-2. Choose the latest the workflow
-3. Download the `factory-firmware`
-
-<div align="center">
-<img src="_static/Action.jpg" width="500px">
-</div>
-
-### Latest release firmware
-
 For the latest firmware, please refer to: https://github.com/espressif/esp-box/releases
 
 1. Choose the latest release version

diff --git a/docs/firmware_update_cn.md b/docs/firmware_update_cn.md
@@ -12,23 +12,7 @@ BOX 系列开发板支持使用 USB 接口更新固件，你仅需要准备：
 
 ## 下载最新版本固件
 
-我们有两种版本的最新固件，一个是开发中的固件，您可以下载后体验新功能，另外一个是正式发布的固件，相比于开发中的固件，正式发布的固件不包含最新功能但是会更稳定。
-
-### 开发中的固件
-
-下载最新开发中的固件，请访问：https://github.com/espressif/esp-box/actions
-
-1. 点击工具栏的 `Action`
-2. 选择最新的 workflow
-3. 下载 `factory-firmware`
-
-<div align="center">
-<img src="_static/Action.jpg" width="500px">
-</div>
-
-### 正式发布的固件
-
-下载最新发布固件，请访问：https://github.com/espressif/esp-box/releases
+下载最新发布的固件，请访问：https://github.com/espressif/esp-box/releases
 
 1. 请先选择一个固件（建议使用最新 release）
 2. 点击 `Assets` 展开下载链接

diff --git a/docs/technical_architecture.md b/docs/technical_architecture.md
@@ -32,7 +32,7 @@ ESP-SR is a speech recognition framework developed by Espressif for the field of
 
 ESP-HMI is a human-computer interaction solution designed by Espressif based on the open-source GUI framework LVGL. With the powerful computing and peripheral resources in ESP32-S3, it can achieve excellent data visualization, touch control, and other functions:
 
-1. Screen driver library: compatible with a variety of mainstream 8080, SPI, I2C interface color screens, monochrome screens, touch screens, and provide a uniform display driver interface. Developers can directly use the adapted screen controller or add their screens according to the display driver interface. And the UI interface can be deployed to a variety of screens.
+1. Screen driver library: compatible with a variety of mainstream RGB, 8080, SPI, I2C interface color screens, monochrome screens, touch screens, and provide a uniform display driver interface. Developers can directly use the adapted screen controller or add their screens according to the display driver interface. And the UI interface can be deployed to a variety of screens.
 2. Open source UI templates: Espressif has designed multiple open source UI templates suitable for IoT control panels, multimedia players, voice assistants, and other different IoT scenarios, which can help developers carry out more professional secondary development.
 3. Hardware design reference: Espressif provides hardware reference designs, circuit schematics, and development guides related to screen applications to help developers quickly complete hardware designs.
 
@@ -50,5 +50,11 @@ With the help of ESP32-S3 Xtensa® 32bit LX7 dual-core CPU and AI / DSP extended
 
 **Device Drivers**
 
+Device driver is the foundation base of the framework layer, which provides the interface for the framework layer to control peripheral devices. [ESP-IoT-Solution](https://github.com/espressif/esp-iot-solution) provides rich
+open source device drivers for the development of IoT system, which works as extra components of ESP-IDF and much easier to start. It contains device drivers for sensors, display, audio, input, USB, etc.
+
 ### Application Layer
 
+**Voice Assistance**
+
+The voice assistance allows the user to control the light on/off, change color, play/pause the music player and switch songs through voice commands. More interestingly, the device supports continuous recognition of multiple command words after wake-up. Continuous recognition means that the user can talk to the device continuously once it is woken up.
diff --git a/docs/technical_architecture_cn.md b/docs/technical_architecture_cn.md
@@ -30,7 +30,7 @@ ESP-SR 是乐鑫面向智能语音领域开发的语音识别框架，该框架
 **ESP-HMI**
 
 ESP-HMI 是乐鑫基于开源 GUI 框架 LVGL 设计的人机交互方案，借助 ESP32-S3 强大的计算能力和外设资源，可以实现出色的数据可视化、触摸控制等功能，它包括：
-1. 屏幕驱动库：兼容多款主流 8080、SPI、I2C 接口彩色屏幕、单色屏、触摸屏，提供统一的显示驱动接口。开发者可以直接使用已适配的屏幕控制器，也可根据显示驱动接口添加自己的屏幕，UI 界面开发完成可无缝部署到多种屏幕。
+1. 屏幕驱动库：兼容多款主流 RGB、8080、SPI、I2C 接口彩色屏幕、单色屏、触摸屏，提供统一的显示驱动接口。开发者可以直接使用已适配的屏幕控制器，也可根据显示驱动接口添加自己的屏幕，UI 界面开发完成可无缝部署到多种屏幕。
 2. 开源 UI 模板：乐鑫设计了适用于物联网控制面板、多媒体播放器、语音助手等不同物联网场景的多套开源 UI 模板，帮助开发者进行更专业的二次开发。
 3. 硬件参考设计：提供屏幕应用相关的硬件参考设计、电路原理图和开发指南，帮助开发者快速完成硬件设计。
 
@@ -45,7 +45,12 @@ ESP-HMI 是乐鑫基于开源 GUI 框架 LVGL 设计的人机交互方案，借
 
 借助 ESP32-S3 Xtensa® 32bit LX7 双核 CPU 和 AI / DSP 扩展指令集，ESP32-S3 可高效完成向量运算、复数运算、FFT 等运算，加速神经网络计算和数字信号处理计算能力。AI 开发者们可以基于乐鑫开源的基于 AI / DSP 扩展指令集的软件库，实现高性能的图像识别、语音唤醒与识别等应用。
 
-**设备驱动 Device Drivers**
+**设备驱动**
 
+设备驱动是框架层的底层基础，为框架层提供了控制外围设备的接口。[ESP-IoT-Solution](https://github.com/espressif/esp-iot-solution) 提供了丰富的常用外设驱动，包含传感器、显示屏、音频设备、输入设备、USB 设备等，可作为 ESP-IDF 的补充组件，方便用户实现更简单的开发。
 
 ### 应用层 Application Layer
+
+**语音助手**
+
+语音助手功能允许用户通过语音指令控制灯的开/关，颜色切换，打开/关闭音乐播放器，切换歌曲。更有连续语音识别，用户可以在唤醒一次设备后，与其连续对话。