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

Merge branch 'docs/update_getting_started' into 'master'

Browse Source 
docs: update getting_started.md

See merge request ae_group/esp-box!41
This commit is contained in:
Wu Jian Gang
2022-08-09 18:16:05 +08:00
parent b3dae46172 3ce4318326
commit ced426421d
2 changed files with 119 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting_started.md
+62 -67
View File
@@ -1,11 +1,10 @@
* [中文版本](./getting_started_cn.md)
The guide is suitable for the development boards that flashed the latest firmware, now it supports ESP32-S3-BOX Kit and ESP32-S3-BOX-Lite Kit, hereafter this text will be collectively referred to as BOX series products.
The guide is applicable to ESP32-S3-BOX Kits and ESP32-S3-BOX-Lite Kits with the latest version of firmware flashed. They are collectively referred to as BOX series of development boards in this guide.
# Getting Started
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 series of development boards integrated with ESP32-S3 SoCs provide a platform for users to develop the control system of smart home appliances, using the voice assistance + touch screen controller, sensor, infrared remote controller, and intelligent Wi-Fi gateway. The BOX series of development boards come with the pre-built firmware that supports voice wake-up and offline speech recognition both in Chinese and English. The ESP-BOX SDK features reconfigurable AI voice interaction, allowing you to customize commands to control home appliances. This guide briefly introduces what you can do with the latest version of firmware to help you get started. After you read through the guide, you may start developing an application by yourself. Now, let’s begin!
**The BOX Kit contains:**
@@ -13,27 +12,27 @@ The ESP-BOX SDK includes a reconfigurable AI voice interaction that allows you t
| :-----: | :---------------------: |
| A main unit that can work on its own | A main unit that can work on its own|
| 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|
| Dock, an accessory that serves as a stand for the main unit | N/A|
**Required Hardware:**
What do you need: An USB-C Cable (not included in the kit).
Please find yourself a USB-C cable.
## Connect the RGB LED Module to your Device
## Connect the RGB LED Module to Your Device
Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB LED Module has four male pins: R, G, B, GND, which should connect to the G39, G40, G41, GND female port of the PMOD 1.
Please refer to the pin definition below, and connect the RGB LED module to the BOX using DuPont wires. The module has four male pins, R, G, B, and GND. Please connect them to the female ports G39, G40, G41, and GND on PMOD 1.
<div align="center">
<img src="./_static/_get_started_static/hardware_pmod.png">
</div>
## Power on your Device
1. Power on your device via an USB-C cable.
## Power on Your Device
1. Power on your device using the USB-C cable.
<div align="center">
<img src="./_static/_get_started_static/usb_power.png" width="800px">
</div>
2. Once power on, the interactive Espressif logo will display on the screen.
2. Once the device is powered on, the screen will play the Espressif logo boot animation.
<div align="center">
<img src="./_static/_get_started_static/boot_animation.png" width="700px">
@@ -41,7 +40,7 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
## 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.
1. The first two pages of the quick guide introduce what the buttons do on your BOX series of development boards. Tap `Next` to go to the next page.
<table border="0" align="center">
<tr>
@@ -58,7 +57,7 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
</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.
2. The last two pages of the quick guide introduces how to use AI voice control. Tap `OK Let’s Go` to enter the menu.
<table border="0" align="center">
<tr>
@@ -67,7 +66,7 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
</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.
3. There are five options in the menu: `Device Control`, `Network`, `Media Player`, `Help`, and `About Us`. You can navigate to different options by swiping left and right. For example, enter `Device Control` screen, tap `Light` to turn on or off the LED light on the module. Then you may go back to the menu, and enter `Media Player` screen to play music or adjust the volume.
<table border="0" align="center">
<tr>
@@ -80,77 +79,69 @@ Refer to the pin definition below, insert the RGB LED Module to the BOX. The RGB
</tr>
</table>
**The following features are only supported by ESP32-S3-BOX**
**Only ESP32-S3-BOX supports the following features:**
4. Press the Mute button on the top of the ESP32-S3-BOX to disable the voice wake-up and speech recognition function. Press again to restore the function.
4. Press the mute button on the top of the device to disable voice wake-up and speech recognition. Press again to enable them.
<div align="center">
<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. Tap the red circle below the screen to 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
## Offline Voice Assistant
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. You may say "hi E. S. P." at any screen to wake up your device. When it wakes up, the screen will display the wake word you just used. If the wake word is not displayed, give it another shot. The screen below indicates 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 within 6 seconds after the beep, such as "turn on the light". You will see the command shown on the screen and the LED light on the module turned on, and hear "OK". Around 6 seconds later you will exit the voice control screen if there is no more command.
<div align="center">
<img src="./_static/_get_started_static/21.png">
</div>
3. You can use voice commands to enjoy music. Please wake up the device first, then say the command phrase "Sing a song". The music player opens and start playing built-in music. You can also use voice commands to switch to the next song or pause playing (There are two build-in songs).
3. You can use voice commands to enjoy music. Please wake up the device first, then say "play music". The music player will open and start playing built-in music. You can also use voice commands to skip songs or pause music. There are two build-in songs.
>**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 LED light fails to turn on, check whether the module pins are inserted into the right ports.
>* If the BOX recognizes no command within the specified time, you will see `Timeout` and exit the screen in about 1 second.
<div align="center">
<img src="_static/_get_started_static/19.png">
</div>
4. The default command words are:
4. The default commands are: **turn on the light**, **turn off the light**, **turn red**, **turn green**, **turn blue**, **play music**, **next song**, **pause playing**.
"**Turn on the light**", "**Switch off the light**", "**Turn Red**", "**Turn Green**", "**Turn Blue**", "**Sing a song**", "**Next Song**", "**Pause Playing**".
## Continuous Speech Recognition
## Continuous Recognition
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. The continuous recognition makes the voice interaction more natural and smooth, and brings a more humanized interactive experience.
More interestingly, the device supports continuous speech recognition after waking up. This feature makes voice interaction natural and smooth, and brings a human touch to interactive experience.
**How to use**
- Say "Hi, E. S. P" to wake up the device, a prompt beep will be played.
- Say a command phrase after the prompt beep. If the device recognizes the command word, it will play the corresponding prompt tone "OK", and then it can continue to recognize.
- If nothing is recognized, the device will continue to wait. If there is no new command word within 6S, the device will automatically exit and you need to wake it up again.
- Say "hi, E. S. P" to wake up the device, and you will hear a beep.
- Say your command. If the device recognizes the command, you will hear "OK", and then it will continue to recognize other commands.
- If no command is recognized, the device will wait. If there is not any command in 6 seconds, the device will automatically exit the voice control screen and you need to wake it up again.
**Attention**
- If it fails to recognize normally for many times, please wait for timeout and wake up the device again to enter the recognition mode.
- After the wake-up word is spoken, the command word shall be sent out at the same position. The device does not support recognition during movement.
- The length of the best English offline command word we recommend is 3-5 English characters.
- The current version does not support continuous recognition when the speaker plays a prompt tone.
- If the device fails to recognize your command for many times, please wait for timeout and wake it up again to use the feature.
- After you say the wake-up word, please do not move the device. Otherwise, the device will fail to recognize your command.
- We recommend voice commands of 3-5 words.
- Currently, the device cannot recognize commands when it plays prompts.
## 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.
(For the details of how the algorithm works, please refer to the technical architecture on the Developer Guide for an inside peek.)
The BOX series of development boards are equipped with Espressif proprietary AI Speech Recognition System, which allows you to customize commands through our ESP BOX app. We will take the LED light on the module as an example, to show how to create your own voice commands. For algorithm details, please refer to [Technical Architecture](https://github.com/espressif/esp-box/blob/master/docs/technical_architecture.md).
**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.
<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.1. Enter `Network`, and tap `To install APP` at the upper right corner. Scan the QR Code or search "ESP BOX" in App Store or Google Play to install the app.
<div align="center">
<img src="_static/_get_started_static/8.png">
@@ -158,10 +149,10 @@ The BOX series development boards are equipped with the Espressif’s proprietar
<div align="center">
<img src="_static/_get_started_static/Picture1.png" width="100 px">
</div>
1.2. If you are new to this app, please register an account first.
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.3. Sign in with your ESP BOX account and turn on the Bluetooth on your phone. Tap `+` at the bottom of the screen, and scan the QR code on your device to set up the network.
<table border="0" align="center">
<tr>
@@ -171,7 +162,7 @@ The BOX series development boards are equipped with the Espressif’s proprietar
</tr>
</table>
1.5 Please follow the instructions to add your device. After adding the device, you will see the following interfaces:
1.4 After adding the device, you will see the following prompts:
<table border="0" align="center">
<tr>
@@ -180,18 +171,22 @@ The BOX series development boards are equipped with the Espressif’s proprietar
</tr>
</table>
<div align="center">
<img src="_static/_get_started_static/7.png">
</div>
>**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.
>* 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.
>* Make sure you connect the device to 2.4 GHz Wi-Fi instead of 5 GHz, and enter the correct Wi-Fi password. If the Wi-Fi password is incorrect, the prompt "Wi-Fi Authentication failed" will pop up.
>* Long press the `Boot` button (i.e. `Funtion` button) for 5 seconds to clear the network information and restore the device to factory settings. After the device is reset, if the QR code or Bluetooth is not working, please restart your device by pressing the `Reset` button.
<div align="center">
<img src="_static/_get_started_static/7.jpeg"width="300" />
</div>
**2. Customize Voice Command**
**2. Customize Voice Commands**
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.)
2.1. Tap the ESP-BOX device icon and enter the below screen. You can turn on or off the light easily by toggling the button as shown in the picture. You may develop the Fan and Switch features by yourself.
<table border="0" align="center">
<tr>
@@ -200,7 +195,7 @@ The BOX series development boards are equipped with the Espressif’s proprietar
</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.
2.2 Tap `Light`, and the `Configure` tab shows the default pin information and commands. The pins for Red, Green, and Blue can be changed as needed.
<table border="0" align="center">
<tr>
@@ -209,31 +204,31 @@ The BOX series development boards are equipped with the Espressif’s proprietar
</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.
<div align="center">
<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.3 In the `Configure` tab, you may also customize commands to turn on or off the light and change its color. For example, you can set "good morning" as the command to turn on the light. Click `Save` to return to the previous screen. Then click `Save` again as shown below.
<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>
</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.4 In the `Control` tab, you may adjust the color, brightness, and saturation of the light.
<div align="center">
<img src="_static/_get_started_static/12.jpeg"width="300" />
</div>
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" within 6 seconds to turn on the light. The new command will show on the screen with the module light turned on.
<div align="center">
<img src="_static/_get_started_static/15.png">
</div>
>**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:**
>**To ensure the commands work well, please note:**
>
>* 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.
>* Length of commands: A command should consists of 2-8 words. When creating a series of commands, please try to keep them at similar lengths.
>* Avoid repeating: Please do not include shorter commands in longer commands, or shorter commands will not be recognized. For example, if you create both "turn on" and "turn on the light" commands, "turn on" will not be 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!
The guide only gives you a brief idea of how to use the latest firmware on your BOX series of development boards. Now, you may start writing programs, and embark on your IoT journey!
docs/getting_started_cn.md
+57 -66
View File
@@ -1,10 +1,10 @@
* [English Version](./getting_started.md)
本用户指南适用于烧录了最新固件的 ESP32-S3-BOX、ESP32-S3-BOX-Lite 产品，下文将他们统称为 BOX 系列开发板。
本指南适用于已烧录最新固件的 ESP32-S3-BOX、ESP32-S3-BOX-Lite 产品，下文将其统称为 BOX 系列开发板。
# 开始使用
基于 ESP32-S3 的 BOX 系列开发板为用户提供了一个基于语音助手 + 屏幕控制、传感器、红外控制器和智能 Wi-Fi 网关等功能，开发和控制智能家居设备的平台。BOX 系列开发板出厂支持语音唤醒和离线中英文命令词识别。 其 SDK 包含可重构的 AI 语音交互功能，支持用户通过自定义命令词控制智能设备。本文的内容仅为您简要介绍最新固件能实现的参考功能，让您了解如何开始使用开发板。一旦您完成阅读下面的指南，您可以尝试自己开发应用。让我们开始旅程吧！
搭载 ESP32-S3 芯片的 BOX 系列开发板借助语音助手 + 屏幕控制、传感器、红外控制器和智能 Wi-Fi 网关等功能，为用户提供了一个开发智能家居设备控制系统的平台。BOX 系列开发板出厂支持语音唤醒和离线中英文命令词识别，其 SDK 具备可重构 AI 语音交互功能，用户可以通过自定义命令词控制家居设备。本文仅简要介绍最新固件能够实现的参考功能，供您了解如何开始使用开发板。阅读完该指南，您可以尝试自己开发应用。让我们开始吧！
**BOX 套件包含：**
@@ -12,22 +12,22 @@
| :-----: | :---------------------: |
| 主机，可独立使用 | 主机，可独立使用 |
| 供测试的 RGB LED 模块和杜邦线 | 供测试的 RGB LED 模块和杜邦线 |
| Dock 配件，辅助主机站在桌上 | N/A|
| Dock 配件，辅助主机立于桌面 | N/A|
**所需硬件：**
您需要准备一根 USB-C 数据线 （不包含在套件内）。
请您自行准备一根 USB-C 数据线。
## 插入 RGB LED 模块
参考下面的引脚定义，将 RGB LED 模块插入 BOX 设备。RGB LED 模块有四根公头针脚：R、G、B、GND，将它们插入 PMOD 1 对应的 G39、G40、G41、GND 母头端口。
## 连接 RGB LED 模块
参考下面的管脚定义，用杜邦线连接 RGB LED 模块和设备。RGB LED 模块有 R、G、B、GND 四根公头针脚，请将其与 PMOD 1 的 G39、G40、G41、GND 母头端口连接。
<div align="center">
<img src="./_static/_get_started_static/hardware_pmod.png">
</div>
## 给设备供电
1. 使用一根 USB-C 数据线（不包含在套件中）给 BOX 设备供电。
1. 使用 USB-C 数据线给设备供电。
<div align="center">
<img src="./_static/_get_started_static/usb_power.png" width="800px">
@@ -41,7 +41,7 @@
## 开始体验
1. 首先您会看几页“按键引导页”，介绍 BOX 系列开发板的按键功能，完成阅读后点击 “Next” 并进入下一页。
1. 请阅读按键引导页，了解 BOX 系列开发板的按键功能，随后点按 `Next` 进入下一页。
<table border="0" align="center">
<tr>
@@ -58,7 +58,7 @@
</tr>
</table>
2. 接下来是“语音助手使用说明”引导页 ，请仔细阅读，它会提示您如何使用 AI 语音功能。完成阅读后点击 “OK Let's Go” 进入菜单页。
2. 请阅读语音助手使用说明引导页，了解 AI 语音功能，随后点按 `OK Let's Go` 进入菜单页。
<table border="0" align="center">
<tr>
@@ -67,7 +67,7 @@
</tr>
</table>
3. 菜单页有五大功能，分别是“设备控制”、“音乐播放器”、“网络”、“帮助”以及“关于”，左右切换可进入不同的功能。比如，进入“设备控制”用户界面，选中 “Light” 图标，点按确认可打开或关闭 LED 灯。然后回到菜单页，找到“音乐播放器”界面并进入，进行歌曲的播放或调节音量。
3. 菜单页有五大功能，分别是 `Device Control`、`Network`、`Media Player`、`Help` 以及 `About Us`，左右滑动可选择功能。比如，进入 `Device Control` 界面，点按 `Light` 可打开或关闭模块上的 LED 灯。回到菜单页，再进入 `Media Player` 界面播放歌曲或调节音量。
<table border="0" align="center">
<tr>
@@ -80,66 +80,61 @@
</tr>
</table>
**以下功能仅 ESP32-S3-BOX 支持**
**仅 ESP32-S3-BOX 支持以下功能：**
4. 按下 ESP32-S3-BOX 顶部的静音按钮，按下后设备语音唤醒和识别功能被禁用，再次按下恢复语音功能。
4. 按下 ESP32-S3-BOX 顶部的静音按钮之后，语音唤醒和识别功能将被禁用，再次按下则会恢复语音功能。
<div align="center">
<img src="_static/_get_started_static/hardware_mute_button.jpg" width="350px">
</div>
5. 也可以轻触触摸屏下方的 “小红圈” 返回上一页。
5. 轻触屏幕下方的“小红圈”可返回上一页。
<div align="center">
<img src="./_static/_get_started_static/hardware_home.png" width="350px">
</div>
## 体验离线语音识别
1. 在任意界面，您可以使用唤醒词去唤醒设备，中文唤醒词是“Hi 乐鑫”，英文唤醒词是 “Hi E. S. P.”（用字母发音）。设备唤醒成功后，唤醒词将显示在如下屏幕上并伴有提示音 “我在”，如果唤醒词未出现，请再次尝试。如下展示的动画界面提示您的设备正在倾听。
## 离线语音识别
1. 您可以在任意界面使用唤醒词来唤醒设备，唤醒词为“hi 乐鑫”。设备唤醒后，唤醒词将显示在屏幕上并伴有提示音“我在”。如果唤醒词未出现，请再次尝试。出现如下界面表示您的设备正在倾听。
<div align="center">
<img src="./_static/_get_started_static/16.png">
</div>
2. 请在提示音响起后的 6 秒左右时间内对设备说命令词，比如“打开电灯”，命令词将显示在屏幕上并且 LED 模块打开，同时会有语音反馈 “好的”，随后语音控制界面退出。
2. 请在提示音响起后的 6 秒内对设备说出命令词，比如“打开电灯”。您将看到命令词显示在屏幕上，模块的 LED 灯亮起，同时听到语音反馈“好的”。若无其他命令词，设备将在 6 秒左右退出语音控制界面。
<div align="center">
<img src="./_static/_get_started_static/20.png">
</div>
3. 您也可以使用语音命令欣赏音乐，请先唤醒设备然后对设备说命令词“播放音乐”，设备会打开音乐播放器并开始播放内置音乐，您也可以用语音命令词切换下一首歌或者暂停播放。（最新固件默认自带两首歌）
3. 您还可以使用语音命令词欣赏音乐。请先唤醒设备，然后说出命令词“播放音乐”，设备将打开音乐播放器并开始播放内置音乐。您也可以用语音命令词切换歌曲或者暂停播放。最新固件默认自带两歌曲。
>**注意：**
>* 如果 LED 灯没有被打开，请检查 RGB 模块的 pin 脚是否插错。
>* 若在规定时间内未识别到命令词，则显示超时，约 1 秒后界面关闭。
>**注意：**
>
>* 如果模块上的 LED 灯没有亮起，请检查模块管脚是否插错。
>* 若在规定时间内未识别到命令词，则会显示 `超时`，约 1 秒后界面关闭。
<div align="center">
<img src="_static/_get_started_static/19.png">
</div>
4. 默认命令词为：“**打开电灯**”，“**关闭电灯**”，“**调成红色**”，“**调成绿色**”，“**调成蓝色**”，“**播放音乐**”，“**切歌**”，“**暂停播放**”；
4. 默认命令词包括：**打开电灯**，**关闭电灯**，**调成红色**，**调成绿色**，**调成蓝色**，**播放音乐**，**切歌**，**暂停播放**。
## 连续语音识别
更有意思的是，设备支持唤醒后连续识别多个命令词。连续识别，即用户可以在唤醒一次设备后，与其连续对话，连续对话让语音交互更自然流畅，带来更人性化的对话体验。
更有趣的是，设备支持唤醒后连续识别多个命令词，即用户可以在唤醒设备后与其连续对话。连续语音识别使语音交互自然流畅，带来人性化的对话体验。
**使用方式**
- 使用“Hi，乐鑫”唤醒设备，唤醒后播放提示音 `我在`
- 唤醒后进行识别，设备识别到命令词，则会播放对应的提示音 `好的`，然后可以继续识别
- 未识别到则继续等待，6s 内未有新指令则自动退出，需要再次唤醒
- 使用“hi，乐鑫”唤醒设备，唤醒后设备播放提示音“我在”。
- 说出命令词。如设备识别出命令词，则会播放提示音“好的”，然后将继续识别其他命令词。
- 如设备未识别命令词则会继续等待，6 秒内没有新命令将自动退出语音控制界面，使用语音识别功能需要再次唤醒设备。
**注意**
- 如多次未正常识别请再次唤醒进入识别
- 发出唤醒词后应在同样位置发出命令词，不支持在移动中识别
- 我们推荐的最佳中文离线命令词长度为 3-5 个汉字
- 目前版本不支持在喇叭播放提示音时继续识别
- 当唤醒后没有识别到用户的语音指令时，会等待 6s ，然后自动退出
- 如设备多次未能识别命令词，请再次唤醒重新识别
- 说出唤醒词后请勿移动设备，设备不支持在移动中识别命令词
- 我们推荐使用长度为 3-5 个汉字的命令词
- 暂不支持播放提示音时识别命令词
**额外支持的命令词**
@@ -170,31 +165,26 @@
| 22 | 二十四度 | 46 | 音量小点 | | |
| 23 | 二十五度 | 47 | 音量调到最大 | | |
> 上述表格的命令仅供演示，没有实际动作产生。
> 上述命令词仅供演示，由于没有接入相关智能设备，所以无法实现命令词功能。
## 语音命令词自定义
BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过 “ESP BOX” APP 自定义用于指令的任意命令词，我们将以 LED 灯作为示例介绍如何自定义语音命令词。（有关算法工作原理的详细信息，请参阅开发指引里的技术架构说明。）
BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过 ESP BOX 应用程序自定义任意命令词。我们将以模块上的 LED 灯为例，介绍如何自定义语音命令词。如需了解算法详细信息，请参阅[技术架构](https://github.com/espressif/esp-box/blob/master/docs/technical_architecture_cn.md)。
**1. 连接 ESP BOX 手机 APP**
**1. 连接 ESP BOX 手机应用程序**
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.1. 进入 `Network` 界面，点按右上角 `To install APP`。扫描二维码下载并安装 ESP BOX 应用程序，或者直接在 App Store 或 Google Play 中搜索 "ESP BOX" 下载应用程序。
<div align="center">
<img src="_static/_get_started_static/8.png">
</div>
<div align="center">
<img src="_static/_get_started_static/Picture1.png" width="100 px">
</div>
1.2. 如您第一次使用此应用程序，请先注册账户。
1.3. 如您第一次下载使用，请点击 “User”，“Register”，注册一个新账户。
1.4. 登录您的 ESP BOX 账号并打开手机蓝牙。然后找到界面下方的“+” ，点击扫码图标扫描设备上的配网二维码。
1.3. 登录您的 ESP BOX 账号并打开手机蓝牙。点按界面下方 `+`，扫描设备上的二维码配置网络。
<table border="0" align="center">
<tr>
@@ -204,7 +194,7 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
</tr>
</table>
1.5 请按 APP 内指引添加您的设备，设备添加完成后，您将看到如下界面：
1.4. 设备添加成功后，您将看到如下提示：
<table border="0" align="center">
<tr>
@@ -220,9 +210,8 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
>**注意：**
>
>* 确保设备连接的网络是 2.4GHz Wi-Fi 而不是 5GHz，并且输入正确的 Wi-Fi 密码，如果 Wi-Fi 密码错误，会显示 “Wi-Fi Authentication failed”。
>* 长按 Boot 按键 5 秒可清除配网信息恢复出厂设置。
>* 设备重置后，如遇二维码扫码失败或蓝牙扫不到，请按 reset 按键重启一下设备。
>* 请确保设备接入 2.4 GHz Wi-Fi 而非 5 GHz，且 Wi-Fi 密码输入正确。如果 Wi-Fi 密码错误，设备将会提示 "Wi-Fi Authentication failed"。
>* 长按 `Boot` 键（即 `Function` 键）5 秒可清除网络配置信息，恢复出厂设置。设备重置后，如遇二维码扫码失败或蓝牙搜索不到设备，请按 `Reset` 键重启设备。
<div align="center">
<img src="_static/_get_started_static/7.jpeg"width="300" />
@@ -230,7 +219,7 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
**2. 自定义语音命令词：**
2.1. 点击你的 ESP-BOX 设备，进入如下页面，您可以简单地在这个用户界面开灯或者关灯。（我们预留了“开关”和“风扇”功能给您自行去配置和开发。）
2.1. 点按您的 ESP-BOX 设备图标，进入如下界面。在此界面，您可轻松控制开灯或者关灯。此外，我们预留了 `Switch` 和 `Fan` 功能供您自行开发。
<table border="0" align="center">
<tr>
@@ -239,7 +228,7 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
</tr>
</table>
2.2. 点按 “Light”，进入 “Configure” 页面查看当前默认的 pin 脚信息和命令词。您也可以根据需要修改 LED 模块的 “RED”、“GREEN” 和 “BLUE” pin 脚。
2.2. 点按 `Light`，`Configure` 标签页会显示当前默认的管脚信息和命令词。您可以根据需要修改 RGB LED 模块的 Red、Green 和 Blue 管脚。
<table border="0" align="center">
<tr>
@@ -248,13 +237,7 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
</tr>
</table>
2.3. “Control” 页面允许您对灯光进行颜色、亮度和饱和度的更改。
<div align="center">
<img src="_static/_get_started_static/12.jpeg"width="300" />
</div>
2.4. “Configure” 页面允许您针对设备的“开”、“关”、“颜色”定义您喜欢的命令词来控制设备。比如，您可以自定义“开”的命令词为“早上好”（如下图标注“1”步骤），点击保存，界面返回上一级（如下图标注“2”步骤），然后再点击保存（如下图标注“3”步骤）。
2.3. 您也可以在 `Configure` 标签页自定义控制设备“开”、“关”和“颜色”的命令词。比如，您可以将“开”的命令词自定义为“早上好”，点按 `Save` 后返回上一级界面，然后如图所示再次点按 `Save`。
<table border="0" align="center">
<tr>
@@ -263,16 +246,24 @@ BOX 系列开发板配备乐鑫专有的 AI 语音识别系统，您可以通过
</tr>
</table>
2.5. 现在，您可以体验您的新命令词了！请先使用 “Hi 乐鑫” 去唤醒设备，然后在六秒内说出打开电灯的新命令词“早上好”，新命令词会显示在屏幕上并且 LED 模块打开。
2.4. 在 `Control` 标签页更改灯光颜色、亮度和饱和度。
<div align="center">
<img src="_static/_get_started_static/12.jpeg"width="300" />
</div>
2.5. 现在，您可以体验新命令词了！请先使用“hi 乐鑫”唤醒设备，然后在 6 秒内说出打开电灯的新命令词“早上好”，新命令词将显示在屏幕上，同时模块上的 LED 灯会亮起。
<div align="center">
<img src="_static/_get_started_static/14.png"width="300" />
</div>
>**如何添加合适的命令词：AI 模型支持自定义命令词，为了获得最优的识别体验，APP 上命令词定义时需要注意以下事项：**
>* 命令词的长度：命令词中单词数需要大于等于 2 个，小于等于 8 个。在定义一系列命令词时，最好可以保持不同命令词的长度相似。
>* 避免前缀：多个命令词，相互之间不要是对方的前缀，短的词会被屏蔽，比如 “打开”和“打开灯”，“打开”会被屏蔽。
>**为了获得最优识别体验，自定义时需要注意以下事项：**
>
>* 命令词长度：命令词长度需要在 2-8 个汉字之间。在定义一系列命令词时，最好可以保持不同命令词的长度相似。
>* 避免重复：请勿在长命令词中包含短命令词，否则短命令词将无法识别。比如“打开”和“打开灯”，设备将无法识别“打开”。
以上指南目的是让您简要了解如何在 BOX 系列开发板上使用最新的固件，其他三个功能图标 (Switch/Fan/Air) 仅用于展示，暂未开发。您可以开始尝试编写令人兴奋的应用程序，开启您的物联网之旅！
此指南仅供您简要了解如何在 BOX 系列开发板上使用最新的固件。现在，请开始编写自己的应用程序，开启物联网之旅吧！