electron-rare/esp-box
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update get started and firmware download

Browse Source
This commit is contained in:
caoyan
2022-03-09 18:34:14 +08:00
committed by zhouli
parent 84bd75e6c9
commit 553e9d21dc
11 changed files with 235 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -16
View File
@@ -35,22 +35,14 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif
## Features
* Supports far-field voice interaction with 2 mics
* Offline voice wake-up with high wake-up rate
* Offline speech commands recognition in Chinese and English languages with high recognition rate
* Reconfigurable 200+ speech commands in Chinese and English languages
* Continuous Identification and Wakeup Interrupt
* Flexible and reusable GUI framework
* End-to-end AIoT dvelopment framwork ESP-RainMaker
* Pmod™ compatible headers support expand peripheral modules
## Open-Source Content
* [Schematic and PCB Source File](./hardware)
@@ -62,13 +54,13 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif
## User Guide
* For getting start of BOX serial development boards, please refer to the [Getting Started](./docs/getting_started.md)
* For experiencing voice assistant, please refer to the [Voice Assistance Control and Customization](./docs/getting_started.md#offline-voice-assistant-with-your-device)
* For experiencing a more humanized interactive experience, please refer to the [Continuous Speech Recognition](./docs/getting_started.md#continuous-recognition)
* For defining the speech commands by mobile APP, please refer to the [ESP-BOX APP User Guide](./docs/getting_started.md#voice-command-customization)
* For product exploded-view and disassembly tutorial, please refer to [Disassembly Tutorial](docs/disassembly_tutorial.md)
* For getting start of BOX serial development boards, please refer to the [Getting Started](./docs/getting_started.md).
* For experiencing voice assistant, please refer to the [Voice Assistance Control and Customization](./docs/getting_started.md#offline-voice-assistant-with-your-device).
* For experiencing a more humanized interactive experience, please refer to the [Continuous Speech Recognition](./docs/getting_started.md#continuous-recognition).
* For defining the speech commands by mobile APP, please refer to the [ESP-BOX APP User Guide](./docs/getting_started.md#voice-command-customization).
* For product exploded-view and disassembly tutorial, please refer to [Disassembly Tutorial](docs/disassembly_tutorial.md).
* For more detils of hardware information, please refer to the [Hardware Overview](./docs/hardware_overview).
* For latest version firmware, please refer to the [Firmware Update](./docs/firmware_update.md)
* For latest version firmware, please refer to the [Firmware Update](./docs/firmware_update.md).
## Developer Guide
@@ -83,10 +75,8 @@ The ESP-BOX is a new generation AIoT development platform released by Espressif
## Contact Us
* 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.
## Contributing Examples
We welcome any open-source software or hardware contribution. If you have any examples you want to share with us, please click the [Contributions Guide](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/contribute/index.html) and commit to the [Pull Requests](https://github.com/espressif/esp-box/pulls) to contribute your code.
README_cn.md
+10 -11
View File
@@ -54,29 +54,28 @@ ESP-BOX 是乐鑫信息科技发布的新一代 AIoT 应用开发平台。ESP32-
## 使用指引
* 首次拿到 BOX 系列开发板，您可以查看 [首次使用操作指引](./docs/getting_started_cn.md#给设备供电)
* 想要体验离线语音助手功能，您可以查看 [离线语音识别](./docs/getting_started_cn.md#体验离线语音识别)
* 体验更人性化的语音交互，可查看 [连续语音识别](./docs/getting_started_cn.md#连续语音识别)
* 想要通过手机 APP 设置独特的语音命令词，请查看 [ESP-BOX APP 操作指引](./docs/getting_started_cn.md#语音命令词自定义)
* 想要了解产品爆炸图和拆机说明，请查看 [拆机教程](docs/disassembly_tutorial.md)
* 想要了解开发板硬件和接口细节，请查看 [硬件总览](./docs/hardware_overview)
* 想要使用最新版本固件，请查看 [固件更新说明](./docs/firmware_update_cn.md)
* 首次拿到 BOX 系列开发板，您可以查看 [首次使用操作指引](./docs/getting_started_cn.md#给设备供电)；
* 想要体验离线语音助手功能，您可以查看 [离线语音识别](./docs/getting_started_cn.md#体验离线语音识别)；
* 体验更人性化的语音交互，可查看 [连续语音识别](./docs/getting_started_cn.md#连续语音识别)；
* 想要通过手机 APP 设置独特的语音命令词，请查看 [ESP-BOX APP 操作指引](./docs/getting_started_cn.md#语音命令词自定义)；
* 想要了解产品爆炸图和拆机说明，请查看 [拆机教程](docs/disassembly_tutorial.md)；
* 想要了解开发板硬件和接口细节，请查看 [硬件总览](./docs/hardware_overview)；
* 想要使用最新版本固件，请查看 [固件更新说明](./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 3**. 此外，请在当前 ESP-IDF 上打上补丁，详情请参考 [Patch for ESP-IDF](./idf_patch)；
* **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/8.1/get-started/index.html)；
* **Step 7**. 扩展功能，您可以阅读 [开发板 Pmod™ 兼容接口介绍](./docs/hardware_overview) 和 [ESP-IDF API 参考手册](https://docs.espressif.com/projects/esp-idf/en/v4.4/esp32s3/api-reference/index.html)，为更多扩展设备开发驱动；
* **Step 7**. 扩展功能，您可以阅读 [开发板 Pmod™ 兼容接口介绍](./docs/hardware_overview) 和 [ESP-IDF API 参考手册](https://docs.espressif.com/projects/esp-idf/en/v4.4/esp32s3/api-reference/index.html)，为更多扩展设备开发驱动。
## 联系我们
* 如果有任何开发和使用问题，您可添加 [GitHub Issues](https://github.com/espressif/esp-box/issues) 或到 [esp32.com](https://esp32.com/) 论坛寻求帮助；
* 如果你对 ESP-BOX 项目感兴趣，欢迎到论坛 [ESP-BOX 版块](https://www.esp32.com/viewforum.php?f=43) 交流想法；
* 如果你对 ESP-BOX 项目感兴趣，欢迎到论坛 [ESP-BOX 版块](https://www.esp32.com/viewforum.php?f=43) 交流想法。
## 贡献示例
docs/_static/Action.jpg
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 115 KiB

docs/_static/_get_started_static/13.1 CN.jpeg
Vendored
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 265 KiB

After

Width:  |  Height:  |  Size: 286 KiB

docs/_static/_get_started_static/6.png
Vendored
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 9.9 KiB

After

Width:  |  Height:  |  Size: 11 KiB

docs/_static/_get_started_static/7.png
Vendored
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 10 KiB

After

Width:  |  Height:  |  Size: 11 KiB

docs/_static/plug_power.png
Vendored
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 22 KiB

docs/firmware_update.md
+29 -15
View File
@@ -1,14 +1,33 @@
* [中文版本](./firmware_update_cn.md)
# Update ESP32-S3-BOX Firmware
# Update Firmware
ESP32-S3-BOX supports updating firmware through USB, you just need:
The BOX series development boards support updating firmware through USB, you just need:
1. USB Type-C cable
2. [Latest firmware bin file](https://github.com/espressif/esp-box/releases)
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.
## 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
@@ -21,7 +40,7 @@ For the latest firmware, please refer to: https://github.com/espressif/esp-box/r
## Firmware update
Please follow the link below correspond to your OS to update the ESP-S3-BOX firmware.
Please follow the link below correspond to your OS to update the firmware.
| [Windows](#firmware-update-for-windows) | [Linux](#firmware-update-for-linux) | [macOS](#firmware-update-for-macos) |
|:----:|:----:|:----:|
@@ -31,13 +50,8 @@ Please follow the link below correspond to your OS to update the ESP-S3-BOX firm
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.
<div align="center">
<img src="_static/plug_power.png">
</div>
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.
<div align="center">
@@ -69,8 +83,8 @@ We recommend using `Windows 10` and above system. Under `Windows 10` system, the
#### 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.
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`) :
```
@@ -98,9 +112,9 @@ We recommend using `Windows 10` and above system. Under `Windows 10` system, the
#### Firmware update for macOS
1. [Download latest firmware](https://github.com/espressif/esp-box/releases)
1. [Download latest firmware](#latest-firmware-download)
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.
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`) :
docs/firmware_update_cn.md
+28 -24
View File
@@ -1,15 +1,34 @@
* [English Version](./firmware_update.md)
# 更新 ESP32-S3-BOX 固件
# 更新固件
ESP32-S3-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/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
1. 请先选择一个固件（建议使用最新 release）
2. 点击 `Assets` 展开下载链接
@@ -31,13 +50,8 @@ ESP32-S3-BOX 支持使用 USB 接口更新固件，你仅需要准备：
我们推荐使用 `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 接入电脑
<div align="center">
<img src="_static/plug_power.png">
</div>
1. [下载最新版本固件](#下载最新版本固件)
2. 使用 USB Type-C 数据线将开发板接入电脑
3. 初次使用，请确保电脑已联网，驱动正常自动安装后，我们能在设备管理器看到以下设备。这里将多出两个新的设备 `COMX`(此电脑为 `COM2` ) 和 `USB JTAG/serial debug unit`，前者用于下载固件和输出程序日志，后者用于 JTAG 调试
<div align="center">
@@ -69,13 +83,8 @@ ESP32-S3-BOX 支持使用 USB 接口更新固件，你仅需要准备：
#### Linux 系统更新固件说明
1. [下载最新版本固件](https://github.com/espressif/esp-box/releases)
2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑，`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动
<div align="center">
<img src="_static/plug_power.png">
</div>
1. [下载最新版本固件](#下载最新版本固件)
2. 使用 USB Type-C 数据线将开发板接入电脑，`USB-Serial-Jtag` 在 Linux 系统下无需安装驱动
3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip` 也可指定为 `pip3`）：
```
@@ -103,13 +112,8 @@ ESP32-S3-BOX 支持使用 USB 接口更新固件，你仅需要准备：
#### macOS 系统更新固件说明
1. [下载最新版本固件](https://github.com/espressif/esp-box/releases)
2. 使用 USB Type-C 数据线将 ESP32-S3-BOX 接入电脑，`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动
<div align="center">
<img src="_static/plug_power.png">
</div>
1. [下载最新版本固件](#下载最新版本固件)
2. 使用 USB Type-C 数据线将开发板接入电脑，`USB-Serial-Jtag` 在 macOS 系统下无需安装驱动
3. 安装下载工具 `esptool`，请打开 `终端` ，并输入以下指令（`pip3` 也可指定为 `pip`）：
```
docs/getting_started.md
+83 -80
View File
@@ -7,7 +7,6 @@ The guide is suitable for the development boards that flashed the latest firmwar
The BOX series development boards based on ESP32-S3 SoC provides a platform for developing the control of home appliances using Voice Assistance + display with buttons controller, sensor, infrared controller, and intelligent Wi-Fi gateway. The BOX series development boards comes with pre-built firmware that allows you to experience voice wake-up and offline speech commands recognition in Chinese and English languages.
The ESP-BOX SDK includes a reconfigurable AI voice interaction that allows you to customize commands to control your smart home appliances. The content of this material is to give you a brief concept of how the latest firmware works, a basic idea for you to know where to begin. Once you go through the guide below, you may start developing the application yourself. So, let’s begin the journey!
**The BOX Kit contains:**
| ESP32-S3-BOX | ESP32-S3-BOX-Lite |
@@ -16,8 +15,6 @@ The ESP-BOX SDK includes a reconfigurable AI voice interaction that allows you t
| An RGB LED module and Dupont wires for testing | An RGB LED module and Dupont wires for testing|
| Dock, an accessory that serves as a stand for the device. | N/A|
**Required Hardware:**
What do you need: An USB-C Cable (not included in the kit).
@@ -39,40 +36,49 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
2. Once power on, the interactive Espressif logo will display on the screen.
<div align="center">
<img src="./_static/_get_started_static/boot_animation.png" width="800px">
<img src="./_static/_get_started_static/boot_animation.png" width="700px">
</div>
## Let's Play Around!
1. Initially, the two Guide Pages introduces the functions of buttons of your BOX series development boards. Press Next to enter next page after reading them.
| ESP32-S3-BOX | ESP32-S3-BOX-Lite|
| :-----: | :---------------------: |
| <img src="./_static/_get_started_static/0.png" width="300px"/> | <img src="./_static/_get_started_static/1.png" width="300px"/> |
| <img src="./_static/_get_started_static/2.png" width="280px"/> | <img src="./_static/_get_started_static/2.png" width="280px"/> |
<table border="0" align="center">
<tr>
<td><b>ESP32-S3-BOX </b></td>
<td><b>ESP32-S3-BOX-Lite </b></td>
</tr>
<tr>
<td><img src="./_static/_get_started_static/0.png" width="300px"/></td>
<td><img src="./_static/_get_started_static/1.png" width="300px"/></td>
</tr>
<tr>
<td><img src="./_static/_get_started_static/2.png" width="280px"/></td>
<td><img src="./_static/_get_started_static/2.png" width="280px"/></td>
</tr>
</table>
2. Next, the Steps for Voice Assistant window gives you a hint of how to use the AI voice control. Press “OK Let’s Go” to enter the Menu screen.
<div align="center">
<img src="./_static/_get_started_static/3_EN.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/3.1_EN.png">
</div>
2. Next, the Steps for Voice Assistant window gives you a hint of how to use the AI voice control. Press "OK Let’s Go" to enter the Menu screen.
<table border="0" align="center">
<tr>
<td><img src="./_static/_get_started_static/3_EN.png"></td>
<td><img src="./_static/_get_started_static/3.1_EN.png"></td>
</tr>
</table>
3. The Menu screen has five functions, they are Device Control, Media Player, Network, Help and About Us. You can navigate to different sections by switching the pages. For example, enter the Device Control user interface, tap the Light icon to turn on or turn off the LED light. Moreover, go back to the Menu page and go forward to the Media Player section, you can operate buttons to control the music playback or adjust the volume.
<div align="center">
<img src="./_static/_get_started_static/4.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/4.1.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/5.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/5.1.png">
</div>
<table border="0" align="center">
<tr>
<td><img src="./_static/_get_started_static/4.png"></td>
<td><img src="./_static/_get_started_static/4.1.png"></td>
</tr>
<tr>
<td><img src="./_static/_get_started_static/5.png"></td>
<td><img src="./_static/_get_started_static/5.1.png"></td>
</tr>
</table>
**The following features are only supported by ESP32-S3-BOX**
@@ -81,20 +87,20 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
<img src="_static/_get_started_static/hardware_mute_button.jpg" width="350px">
</div>
5. You can press the “Red Circle” on the device and return to the last page.
5. You can press the "Red Circle" on the device and return to the last page.
<div align="center">
<img src="./_static/_get_started_static/hardware_home.png" width="350px">
</div>
## Offline Voice Assistant with your Device
1. In any interface, you can say the Chinese wake word “Hi Le Xin”, or English wake word “Hi E. S. P.” (Pronounce in alphabet) to activate your BOX series development boards. If the board wakes up, its screen will display the wake word you just speak. If the wake word is not displayed, try the wake word more times. The animation interface below gives you a hint that your device is listening.
1. In any interface, you can say the Chinese wake word "Hi Le Xin", or English wake word "Hi E. S. P." (Pronounce in alphabet) to activate your BOX series development boards. If the board wakes up, its screen will display the wake word you just speak. If the wake word is not displayed, try the wake word more times. The animation interface below gives you a hint that your device is listening.
<div align="center">
<img src="./_static/_get_started_static/17.png">
</div>
2. Utter a command phrase within 6 seconds after the beep, for example “turn on the light”. The command phrase will display on the screen and the RGB light of the LED Module will turn on, and there will be a voice feedback "OK". Around 6 seconds the voice user interface exits if no more commands.
2. Utter a command phrase within 6 seconds after the beep, for example "turn on the light". The command phrase will display on the screen and the RGB light of the LED Module will turn on, and there will be a voice feedback "OK". Around 6 seconds the voice user interface exits if no more commands.
<div align="center">
<img src="./_static/_get_started_static/21.png">
@@ -105,7 +111,7 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
>**Tips:**
>* If the LED light fails to turn on, check whether the pins of the RGB Module are inserted into the right port of the BOX.
>* If the BOX receives no command within the specified time, the voice user interface will show “Timeout” and jumps back to last page in about 1 second.
>* If the BOX receives no command within the specified time, the voice user interface will show "Timeout" and jumps back to last page in about 1 second.
<div align="center">
<img src="_static/_get_started_static/19.png">
@@ -134,55 +140,51 @@ More interestingly, the device supports continuous recognition of multiple comma
## Voice Command Customization
The BOX series development boards are equipped with the Espressif’s proprietary AI Speech Recognition system which allows you to customize command phrases through our ESP-BOX APP. We will take the LED module as an example to show how to customize the voice commands.
The BOX series development boards are equipped with the Espressif’s proprietary AI Speech Recognition system which allows you to customize command phrases through our ESP BOX APP. We will take the LED module as an example to show how to customize the voice commands.
(For the details of how the algorithm works, please refer to the technical architecture on the Developer Guide for an inside peek.)
**1. Connect to the ESP-BOX mobile APP**
**1. Connect to the ESP BOX mobile APP**
1.1. First, please navigate to the Network section, press confirm button, and enter device provisioning interface. You will see a QR Code as below. Before network provisioning, ESP-BOX APP need to be installed. Tap on the “To install APP” icon that appears at the upper right corner and navigate to APP download interface.
1.1. First, please navigate to the Network section, press confirm button, and enter device provisioning interface. You will see a QR Code as below. Before network provisioning, ESP BOX APP need to be installed. Tap on the "To install APP" icon that appears at the upper right corner and navigate to APP download interface.
<div align="center">
<img src="_static/_get_started_static/6.png" >
</div>
1.2. Scan the QR Code below to visit the APP download page, follow the instructions to install the ESP-BOX APP. You can also search the “ESP-BOX” either in Apple Store or Google Play to install the APP.
1.2. Scan the QR Code below to visit the APP download page, follow the instructions to install the ESP BOX APP. You can also search the "ESP BOX" either in Apple Store or Google Play to install the APP.
<div align="center">
<img src="_static/_get_started_static/8.png">
</div>
<div align="center">
<img src="_static/_get_started_static/Picture1.png">
<img src="_static/_get_started_static/Picture1.png" width="100 px">
</div>
1.3. If you first download the APP, please click "User", "Register" to register a new account.
1.4. Sign in with your ESP-BOX account and turn on the Bluetooth of your phone. Then tap + on the bottom of the interface, find the code scanning icon and scan the network provisioning QR code on your device.
1.4. Sign in with your ESP BOX account and turn on the Bluetooth of your phone. Then tap + on the bottom of the interface, find the code scanning icon and scan the network provisioning QR code on your device.
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/1.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/2.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/3.jpeg"width="300"/></td>
</tr>
</table>
<div align="center">
<img src="_static/_get_started_static/1.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/2.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/3.jpeg"width="300" />
</div>
1.5 Please follow the instructions to add your device. After adding the device, you will see the following interfaces:
<div align="center">
<img src="_static/_get_started_static/4.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/5.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/7.png">
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/4.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/5.jpeg"width="300"/></td>
</tr>
</table>
>**Tips:**
>
>* Make sure the device is connected to 2.4GHz Wi-Fi channel not 5GHz, if the Wi-Fi password is incorrect, it will lead to Wi-Fi Authentication failed as the figure below shows.
>* Please stay on the device provisioning page during network provision.
* Long press the Boot button for 5 seconds to clean the network information and restore to factory settings.
>* Long press the Boot button for 5 seconds to clean the network information and restore to factory settings.
* After the device is restored, if the QR code scan fails or the Bluetooth scan fails, please restart your device by pressing the reset button.
<div align="center">
<img src="_static/_get_started_static/7.jpeg"width="300" />
</div>
@@ -191,20 +193,21 @@ The BOX series development boards are equipped with the Espressif’s proprietar
2.1. Tap the ESP-BOX device and enter to the below interface. You can simply turn on or turn off the light by toggling the button on the user interface, as the figure below shows. (We left the Fan and Switch parts for you to configure and develop by yourself.)
<div align="center">
<img src="_static/_get_started_static/8.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/9.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/8.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/9.jpeg"width="300"/></td>
</tr>
</table>
2.2 Press on Light and navigate to the Configure page to check the current default pin information and command phrases. The pin number for RED, GREEN and BLUE can be modified as needed.
<div align="center">
<img src="_static/_get_started_static/10 EN.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/11.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/10 EN.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/11.jpeg"width="300"/></td>
</tr>
</table>
2.3 The Control page allows you to adjust the color and brightness of the light, as well as the saturation of the color.
@@ -212,16 +215,16 @@ The BOX series development boards are equipped with the Espressif’s proprietar
<img src="_static/_get_started_static/12.jpeg"width="300" />
</div>
2.4 The Configure page allows you to define the preferred command phrase to control the on/off status and color of the light. For example, you can customize “Good morning” for action ON (as marked with “1” in the figure below). Click Save to return to the previous interface (as marked with “2” in the figure below). Then click Save again (as marked with “3” in the figure below).
2.4 The Configure page allows you to define the preferred command phrase to control the on/off status and color of the light. For example, you can customize "Good morning" for action ON (as marked with "1" in the figure below). Click Save to return to the previous interface (as marked with "2" in the figure below). Then click Save again (as marked with "3" in the figure below).
<div align="center">
<img src="_static/_get_started_static/13 EN.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/13.1 EN.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/13 EN.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/13.1 EN.jpeg"width="300"/></td>
</tr>
</table>
2.5 Now, you can try out your new command! First, say “Hi E. S. P.” to wake up your device. Then say “Good morning” to turn on your light within 6 seconds. The new command phrase will display on the screen and the LED module will turn on.
2.5 Now, you can try out your new command! First, say "Hi E. S. P." to wake up your device. Then say "Good morning" to turn on your light within 6 seconds. The new command phrase will display on the screen and the LED module will turn on.
<div align="center">
<img src="_static/_get_started_static/15.png">
@@ -230,7 +233,7 @@ The BOX series development boards are equipped with the Espressif’s proprietar
>**How to Add Appropriate Command Phrases: Now AI model supports users to define command phrases. In order to obtain the best recognition experience, you need to pay attention to the following matters when defining command phrase in the APP:**
>
>* Length of command word: The number of words in the command phrase must be greater than or equal to 2 and less than or equal to 8. When defining a series of command phrases, it is best to keep the length of different command phrases similar.
>* Avoid prefixes: Multiple command phrase should not be prefixed with each other. Short words will be not recognized, such as “Turn on” and “Turn on the light", “Turn on" will be not recognized.
>* Avoid prefixes: Multiple command phrase should not be prefixed with each other. Short words will be not recognized, such as "Turn on" and "Turn on the light", "Turn on" will be not recognized.
The built-in function above gives you a brief idea of how to use the latest firmware on your BOX series products. The other three icons (Switch, Fan, Air) are added for illustration purposes, and you may start writing your exciting application program! Begin your IoT journey!
docs/getting_started_cn.md
+79 -70
View File
@@ -12,10 +12,10 @@
| :-----: | :---------------------: |
| 主机，可独立使用 | 主机，可独立使用 |
| 供测试的 RGB LED 模块和杜邦线 | 供测试的 RGB LED 模块和杜邦线 |
| Dock 配件, 辅助主机站在桌上 | N/A|
| Dock 配件，辅助主机站在桌上 | N/A|
**所需硬件:**
**所需硬件：**
您需要准备一根 USB-C 数据线 （不包含在套件内）。
@@ -36,41 +36,49 @@
2. 设备启动后，屏幕上将显示 Espressif logo 的开机动画。
<div align="center">
<img src="./_static/_get_started_static/boot_animation.png" width="800px">
<img src="./_static/_get_started_static/boot_animation.png" width="700px">
</div>
## 开始体验
1. 首先您会看几页“按键引导页”，介绍 BOX 系列开发板的按键功能，完成阅读后点击 “Next” 并进入下一页。
| ESP32-S3-BOX 按键引导页| ESP32-S3-BOX-Lite 按键引导页|
| :-----: | :---------------------: |
| <img src="./_static/_get_started_static/0.png" width="300px"/> | <img src="./_static/_get_started_static/1.png" width="300px"/> |
| <img src="./_static/_get_started_static/2.png" width="280px"/> | <img src="./_static/_get_started_static/2.png" width="280px"/> |
<table border="0" align="center">
<tr>
<td><b>ESP32-S3-BOX 按键引导页</b></td>
<td><b>ESP32-S3-BOX-Lite 按键引导页</b></td>
</tr>
<tr>
<td><img src="./_static/_get_started_static/0.png" width="300px"/></td>
<td><img src="./_static/_get_started_static/1.png" width="300px"/></td>
</tr>
<tr>
<td><img src="./_static/_get_started_static/2.png" width="280px"/></td>
<td><img src="./_static/_get_started_static/2.png" width="280px"/></td>
</tr>
</table>
2. 接下来是“语音助手使用说明”引导页 ，请仔细阅读，它会提示您如何使用 AI 语音功能。完成阅读后点击 “OK Let's Go” 进入菜单页。
<div align="center">
<img src="./_static/_get_started_static/3_CN.png" >
</div>
<div align="center">
<img src="./_static/_get_started_static/3.1_CN.png">
</div>
<table border="0" align="center">
<tr>
<td><img src="./_static/_get_started_static/3_CN.png"></td>
<td><img src="./_static/_get_started_static/3.1_CN.png"></td>
</tr>
</table>
3. 菜单页有五大功能，分别是“设备控制”、“音乐播放器”、“网络”、“帮助”以及“关于”，左右切换可进入不同的功能。比如，进入“设备控制”用户界面，选中 “Light” 图标，点按确认可打开或关闭 LED 灯。然后回到菜单页，找到“音乐播放器”界面并进入，进行歌曲的播放或调节音量。
<div align="center">
<img src="./_static/_get_started_static/4.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/4.1.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/5.png">
</div>
<div align="center">
<img src="./_static/_get_started_static/5.1.png">
</div>
<table border="0" align="center">
<tr>
<td><img src="./_static/_get_started_static/4.png"></td>
<td><img src="./_static/_get_started_static/4.1.png"></td>
</tr>
<tr>
<td><img src="./_static/_get_started_static/5.png"></td>
<td><img src="./_static/_get_started_static/5.1.png"></td>
</tr>
</table>
**以下功能仅 ESP32-S3-BOX 支持**
@@ -109,7 +117,7 @@
<img src="_static/_get_started_static/19.png">
</div>
4. 默认命令词为："**打开电灯**", "**关闭电灯**", "**调成红色**", "**调成绿色**", "**调成蓝色**", "**播放音乐**", "**切歌**", "**暂停播放**"；
4. 默认命令词为：“**打开电灯**”，“**关闭电灯**”，“**调成红色**”，“**调成绿色**”，“**调成蓝色**”，“**播放音乐**”，“**切歌**”，“**暂停播放**”；
## 连续语音识别
@@ -165,55 +173,56 @@
> 上述表格的命令仅供演示，没有实际动作产生。
## 语音命令词自定义
BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过 “ESP-BOX” APP 自定义用于指令的任意命令词，我们将以 LED 灯作为示例介绍如何自定义语音命令词。（有关算法工作原理的详细信息，请参阅开发指引里的技术架构说明。）
BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过 “ESP BOX” APP 自定义用于指令的任意命令词，我们将以 LED 灯作为示例介绍如何自定义语音命令词。（有关算法工作原理的详细信息，请参阅开发指引里的技术架构说明。）
**1. 连接 ESP-BOX 手机 APP**
**1. 连接 ESP BOX 手机 APP**
1.1. 首先找到“网络”部分，点击确认后进入如下设备配网界面，在此之前，您需要安装 ESP-BOX APP。点击右上角 “To install APP” 部分下载并安装 ESP-BOX APP。
1.1. 首先找到“网络”部分，点击确认后进入如下设备配网界面，在此之前，您需要安装 ESP BOX APP。点击右上角 “To install APP” 部分下载并安装 ESP BOX APP。
<div align="center">
<img src="_static/_get_started_static/6.png">
</div>
1.2. 扫描如下二维码下载并安装 ESP-BOX APP，您也可以直接在 Apple Store 和 Google Play 搜索 “ESP-BOX” 下载 APP。
1.2. 扫描如下二维码下载并安装 ESP BOX APP，您也可以直接在 Apple Store 和 Google Play 搜索 “ESP BOX” 下载 APP。
<div align="center">
<img src="_static/_get_started_static/8.png">
</div>
<div align="center">
<img src="_static/_get_started_static/Picture1.png">
<img src="_static/_get_started_static/Picture1.png" width="100 px">
</div>
1.3. 如您第一次下载使用，请点击 “User”，“Register”，注册一个新账户。
1.4. 登录您的 ESP-BOX 账号并打开手机蓝牙。然后找到界面下方的“+” ，点击扫码图标扫描设备上的配网二维码。
1.4. 登录您的 ESP BOX 账号并打开手机蓝牙。然后找到界面下方的“+” ，点击扫码图标扫描设备上的配网二维码。
<div align="center">
<img src="_static/_get_started_static/1.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/2.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/3.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/1.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/2.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/3.jpeg"width="300"/></td>
</tr>
</table>
1.5 请按 APP 内指引添加您的设备，设备添加完成后，您将看到如下界面:
1.5 请按 APP 内指引添加您的设备，设备添加完成后，您将看到如下界面：
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/4.jpeg" width="300"/></td>
<td><img src="_static/_get_started_static/5.jpeg" width="300"/></td>
</tr>
</table>
<div align="center">
<img src="_static/_get_started_static/7.png">
</div>
<div align="center">
<img src="_static/_get_started_static/4.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/5.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/7.png">
</div>
>**注意：**
>
>* 确保设备连接的网络是 2.4GHz Wi-Fi 而不是 5GHz，并且输入正确的 Wi-Fi 密码，如果 Wi-Fi 密码错误，会显示 “Wi-Fi Authentication failed”。
>* 在配网过程中不要退出设备配网界面。
>* 长按 Boot 按键 5 秒可清除配网信息恢复出厂设置。
>* 设备重置后，如遇二维码扫码失败或蓝牙扫不到，请按 reset 按键重启一下设备。
<div align="center">
<img src="_static/_get_started_static/7.jpeg"width="300" />
@@ -223,21 +232,21 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
2.1. 点击你的 ESP-BOX 设备，进入如下页面，您可以简单地在这个用户界面开灯或者关灯。（我们预留了“开关”和“风扇”功能给您自行去配置和开发。）
<div align="center">
<img src="_static/_get_started_static/8.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/9.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/8.jpeg" width="300"/></td>
<td><img src="_static/_get_started_static/9.jpeg" width="300"/></td>
</tr>
</table>
2.2. 点按 “Light”，进入 “Configure” 页面查看当前默认的 pin 脚信息和命令词。您也可以根据需要修改 LED 模块的 “RED”、“GREEN” 和 “BLUE” pin 脚。
<div align="center">
<img src="_static/_get_started_static/10 CN.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/11.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/10 CN.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/11.jpeg" width="300"/></td>
</tr>
</table>
2.3. “Control” 页面允许您对灯光进行颜色、亮度和饱和度的更改。
@@ -247,12 +256,12 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
2.4. “Configure” 页面允许您针对设备的“开”、“关”、“颜色”定义您喜欢的命令词来控制设备。比如，您可以自定义“开”的命令词为“早上好”（如下图标注“1”步骤），点击保存，界面返回上一级（如下图标注“2”步骤），然后再点击保存（如下图标注“3”步骤）。
<div align="center">
<img src="_static/_get_started_static/13 CN.jpeg"width="300" />
</div>
<div align="center">
<img src="_static/_get_started_static/13.1 CN.jpeg"width="300" />
</div>
<table border="0" align="center">
<tr>
<td><img src="_static/_get_started_static/13 CN.jpeg"width="300"/></td>
<td><img src="_static/_get_started_static/13.1 CN.jpeg"width="300"/></td>
</tr>
</table>
2.5. 现在，您可以体验您的新命令词了！请先使用 “Hi 乐鑫” 去唤醒设备，然后在六秒内说出打开电灯的新命令词“早上好”，新命令词会显示在屏幕上并且 LED 模块打开。