update box3 component and doc
Xu Xin
|
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 17 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 13 KiB |
|
After Width: | Height: | Size: 446 KiB |
|
After Width: | Height: | Size: 304 KiB |
|
After Width: | Height: | Size: 1.3 MiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 250 KiB |
@@ -19,7 +19,7 @@ This guide provides a comprehensive overview of the built-in firmware's capabili
|
||||
The target group for this product includes individuals and organizations engaged in making, prototyping, and development activities. It is designed to cater to a wide range of users, such as hobbyists, makers, engineers, educators, and professionals seeking versatile and expandable solutions for their projects.
|
||||
|
||||
# Target Application
|
||||
* How to call these things, use one trem: Smart Home
|
||||
* Smart Home
|
||||
* Smart Agriculture
|
||||
* Smart City
|
||||
* Energy Management
|
||||
@@ -38,7 +38,7 @@ The target group for this product includes individuals and organizations engaged
|
||||
<img src="./_static/_get_started_static/ESP32_S3_BOX_3_KitFigure.png" width="700px">
|
||||
</div>
|
||||
|
||||
- ESP32-S3-BOX-3, a main unit that can work on its own
|
||||
- ESP32-S3-BOX-3, a main unit that can work on its own
|
||||
- ESP32-S3-BOX-3-DOCK, a functional accessory serving as a stand for the main box
|
||||
- ESP32-S3-BOX-3-SENSOR, a functional accessory showcasing sensor applications
|
||||
- ESP32-S3-BOX-3-BRACKET, an adapter accessory for mounting the main box to other devices
|
||||
@@ -53,7 +53,7 @@ The target group for this product includes individuals and organizations engaged
|
||||
<img src="./_static/_get_started_static/usb_power_box.png" width="800px">
|
||||
</div>
|
||||
|
||||
2. Once the device is powered on, the screen will play the Espressif logo boot animation.
|
||||
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="500px">
|
||||
@@ -154,7 +154,7 @@ Firstly, connect the RGB LED module to your device. Refer to the pin definitions
|
||||
<img src="./_static/_get_started_static/LED_pin_defination.png">
|
||||
</div>
|
||||
|
||||
1. You may say `"Hi E. S. P." (pronounce in alphabet)` 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 isn't displayed, give it another try. The screen below indicates your device is listening.
|
||||
1. You may say `"Hi E. S. P." (pronounce in alphabet)` 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 isn't displayed, give it another try. The screen below indicates your device is listening.
|
||||
|
||||
<div align="center">
|
||||
<img src="./_static/_get_started_static/17.png">
|
||||
@@ -167,9 +167,9 @@ Firstly, connect the RGB LED module to your device. Refer to the pin definitions
|
||||
</div>
|
||||
|
||||
3. You can use voice commands to enjoy music. First, wake up the device, then say `"Sing a song"`. This will launch the music player and start playing built-in music. You can also use voice commands to pause or skip songs. There are two built-in songs.
|
||||
|
||||
|
||||
>**Tips:**
|
||||
|
||||
|
||||
>* If the LED light fails to turn on, check whether the module pins are inserted into the right ports.
|
||||
>* If the BOX doesn't recognize any command within the designated timeframe, a `Timeout` message will appear, and the screen will exit in approximately 1 second.
|
||||
|
||||
@@ -180,7 +180,7 @@ Firstly, connect the RGB LED module to your device. Refer to the pin definitions
|
||||
|
||||
4. The default commands are: **turn on the light**, **turn off the light**, **turn red**, **turn green**, **turn blue**, **sing a song**, **next song**, **pause playing**.
|
||||
|
||||
## Continuous Speech Recognition
|
||||
## Continuous Speech Recognition
|
||||
|
||||
More interestingly, the device supports continuous speech recognition after waking up. This feature adds a natural and seamless quality to voice interaction, enhancing the interactive experience with a human touch.
|
||||
|
||||
@@ -211,7 +211,7 @@ The ESP32-S3-BOX-3 is also equipped with Espressif proprietary AI Speech Recogni
|
||||
<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. 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.
|
||||
@@ -237,11 +237,11 @@ The ESP32-S3-BOX-3 is also equipped with Espressif proprietary AI Speech Recogni
|
||||
</div>
|
||||
|
||||
>**Tips:**
|
||||
|
||||
|
||||
>* Please do not exit the QR code page during the network provisioning.
|
||||
>* 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>
|
||||
|
||||
@@ -98,7 +98,7 @@ ESP32-S3-BOX-3 出厂固件支持中文和英文离线语音唤醒和命令词
|
||||
</div>
|
||||
|
||||
5. 轻触屏幕下方的红色圆圈以返回上一页。红圈是一块可自定义的触摸区域，允许用户根据自己的喜好配置额外的触摸功能。
|
||||
|
||||
|
||||
<div align="center">
|
||||
<img src="./_static/_get_started_static/hardware_home.png" width="250px">
|
||||
</div>
|
||||
@@ -130,7 +130,7 @@ ESP32-S3-BOX-3 出厂固件支持中文和英文离线语音唤醒和命令词
|
||||
</tr>
|
||||
<tr>
|
||||
<td><img src="./_static/_get_started_static/29.png"></td>
|
||||
<td><img src="./_static/_get_started_static/30.png"></td>
|
||||
<td><img src="./_static/_get_started_static/26.png"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -164,12 +164,12 @@ ESP32-S3-BOX-3 出厂固件支持中文和英文离线语音唤醒和命令词
|
||||
</div>
|
||||
|
||||
3. 您还可以使用语音命令词欣赏音乐。请先唤醒设备，然后说出命令词`“播放音乐”`，设备将打开音乐播放器并开始播放内置音乐。您也可以用语音命令词切换歌曲或者暂停播放。出厂固件默认自带两首歌曲。
|
||||
|
||||
|
||||
>**注意：**
|
||||
>
|
||||
>* 如果模块上的 LED 灯没有亮起，请检查模块管脚是否插错。
|
||||
>* 若在规定时间内未识别到命令词，则会显示 `超时`，约 1 秒后界面关闭。
|
||||
|
||||
|
||||
<div align="center">
|
||||
<img src="_static/_get_started_static/18.png">
|
||||
</div>
|
||||
@@ -195,18 +195,18 @@ ESP32-S3-BOX-3 出厂固件支持中文和英文离线语音唤醒和命令词
|
||||
|
||||
**中文模型额外支持的命令词**
|
||||
|
||||
| command ID | 命令词 |
|
||||
| :--------: | :----------:|
|
||||
| 0 | 打开空调 |
|
||||
| 1 | 关闭空调 |
|
||||
| 2 | 舒适模式 |
|
||||
| 3 | 制冷模式 |
|
||||
| 4 | 制热模式 |
|
||||
| 5 | 加热模式 |
|
||||
| 6 | 除湿模式 |
|
||||
| 7 | 送风模式 |
|
||||
| 8 | 升高温度 |
|
||||
| 9 | 降低温度 |
|
||||
| command ID | 命令词 |
|
||||
| :--------: | :----------:|
|
||||
| 0 | 打开空调 |
|
||||
| 1 | 关闭空调 |
|
||||
| 2 | 舒适模式 |
|
||||
| 3 | 制冷模式 |
|
||||
| 4 | 制热模式 |
|
||||
| 5 | 加热模式 |
|
||||
| 6 | 除湿模式 |
|
||||
| 7 | 送风模式 |
|
||||
| 8 | 升高温度 |
|
||||
| 9 | 降低温度 |
|
||||
|
||||
>**注意：**
|
||||
>
|
||||
@@ -220,14 +220,14 @@ ESP32-S3-BOX-3 还配备了乐鑫专有的 AI 语音识别系统，通过我们
|
||||
|
||||
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. 登录您的 ESP BOX 账号并打开手机蓝牙。点按界面下方 `+`，扫描设备上的二维码配置网络。
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
# Great projects using ESP-BOX serials
|
||||
|
||||
## Willow - A Practical, Open Source, Privacy-focused Platform for Voice Assistants and Other Applications
|
||||
|
||||
<td><img src="./_static/great_projects_picture/willow1.png" width="400"/></td>
|
||||
|
||||
### Project Source
|
||||
|
||||
[GitHub link](https://github.com/toverainc/willow)
|
||||
|
||||
[GitHub URL](https://heywillow.io)
|
||||
|
||||
### Project description
|
||||
|
||||
Willow is a powerful and privacy-focused voice assistant platform designed for the ESP32-BOX hardware family, offering a cost-effective, open-source, and highly customizable solution for voice interaction and home automation.
|
||||
|
||||
<td><img src="./_static/great_projects_picture/willow2.jpg" width="200"/></td>
|
||||
|
||||
Willow is an ESP IDF-based project primarily designed for the ESP32-BOX hardware family from Espressif. The project's main objectives are to deliver performance, accuracy, cost-effectiveness, and functionality comparable to Amazon Echo and Google Home when used with Home Assistant, openHAB, and other platforms.
|
||||
|
||||
It is 100% open source and self-hosted, providing fast response times (500ms or less), high wake word accuracy, and low false activation rates. Willow offers flexibility with the option to use the Willow Inference Server or perform command recognition solely on the device. The project is known for its reliability, having been tested extensively with a failure rate of less than 1%.
|
||||
|
||||
Willow is not only fast and accurate but also prioritizes privacy. Users can inspect the source code, build and flash it themselves, proxy through another server for traffic inspection, use it on their own server, or operate it without internet access. It is a practical and aesthetically pleasing solution, ready to be deployed without drawing attention. The hardware cost is approximately $50, making it a cost-effective choice.
|
||||
|
||||
Willow supports features such as wake word detection, voice activity detection, integration with Home Assistant, openHAB, and generic REST APIs, far-field voice recognition, excellent audio quality, and reliable performance in challenging Wi-Fi environments.
|
||||
|
||||
The project's future plans include running the Willow Inference Server without CUDA, improving the LCD and touchscreen features, adding support for buttons and custom wake words, and configuring GPIO for user customization.
|
||||
|
||||
|
||||
|
||||
## ESP-BOX-EMU - A Retro Game Emulation System
|
||||
|
||||
<td><img src="./_static/great_projects_picture/esp-box-emu1.png" width="200"/></td>
|
||||
|
||||
### Project Source
|
||||
|
||||
[GitHub link](https://github.com/esp-cpp/esp-box-emu)
|
||||
|
||||
### Project description
|
||||
|
||||
ESP-BOX-EMU is a comprehensive project that allows users to enjoy retro game emulation on the ESP32-BOX hardware, with a user-friendly interface and various features for an enhanced gaming experience.
|
||||
|
||||
<td><img src="./_static/great_projects_picture/esp-box-emu2.jpg" width="400"/></td>
|
||||
|
||||
This project, "esp-box-emu," is an emulation system running on the ESP32-BOX hardware. It is designed to emulate retro games and is built using various components and software libraries, including ESPP, LVGL, Squareline Studio for LVGL design, Nofrendo for NES emulation, and GNUBoy for Game Boy/Game Boy Color emulation.
|
||||
|
||||
The project offers videos showcasing its capabilities, including emulation for Game Boy Color, NES games (e.g: Super Mario Bros. and Zelda), and Game Boy games (e.g: Pokemon and Link's Awakening). The videos demonstrate features like audio and video settings, ROM scaling options, and audio control.
|
||||
|
||||
The project supports both internal storage using LittleFS and external storage via a uSD card with a FAT filesystem. ROM images and metadata are organized in a specific format for ease of use.
|
||||
|
||||
|
||||
|
||||
## **ESP32-S3-BOX-3-JoyStick** - A JoyStick Combines Gaming Controller And Aircraft Remote
|
||||
|
||||
<td><img src="./_static/great_projects_picture/joystick.png" width="200"/></td>
|
||||
|
||||
### Project Source
|
||||
|
||||
[OSHWHub link](https://oshwhub.com/esp-college/esp_box_3_joystick)
|
||||
|
||||
### Project description
|
||||
|
||||
The ESP32-S3-BOX-3-JoyStick hardware system comprises the ESP32-S3-BOX-3 development board, JoyStick controller, and ESP32-S3-USB-Bridge receiver. The ESP32-S3-BOX-3 serves as the main controller, connecting to the JoyStick controller and ESP32-S3-USB-Bridge receiver through a PCI-E interface. The system operates in "Game Mode" and "RC Remote Control Mode." In Game Mode, it supports USB-HID and BLE-HID protocols for computer gaming control, as well as an NES emulator mode. In RC Remote Control Mode, it utilizes the ESP-NOW wireless communication protocol to pair with ESP32-S3-USB-Bridge and other Espressif development boards, enabling wireless control of RC vehicles and ESP-Drone quadcopters.
|
||||
@@ -92,5 +92,5 @@ ESP32-S3-BOX-3-BREAD is an adapter that enables easy connection of the ESP32-S3-
|
||||
## Hardware Source Files
|
||||
* [ESP32-S3-BOX-3 Kit PCB](../../../hardware/PCB_ESP32-S3-BOX-3_V1.0)
|
||||
* [ESP32-S3-BOX-3 Kit Schematic](../../../hardware/SCH_ESP32-S3-BOX-3_V1.0)
|
||||
* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell_stl)
|
||||
* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell)
|
||||
* [ESP32-S3-BOX-3 Bracket Mounting Template](../../../hardware/ESP32-S3-BOX-3-BRACKET_template.PDF)
|
||||
@@ -97,5 +97,5 @@ ESP32-S3-BOX-3-BREAD 是一个转接板，方便用户轻松连接 ESP32-S3-BOX-
|
||||
|
||||
* [ESP32-S3-BOX-3 Kit PCB](../../../hardware/PCB_ESP32-S3-BOX-3_V1.0)
|
||||
* [ESP32-S3-BOX-3 Kit Schematic](../../../hardware/SCH_ESP32-S3-BOX-3_V1.0)
|
||||
* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell_stl)
|
||||
* [ESP32-S3-BOX-3 3D Shell CAD](../../../hardware/esp32_s3_box_3_shell)
|
||||
* [ESP32-S3-BOX-3 Bracket Mounting Template](../../../hardware/ESP32-S3-BOX-3-BRACKET_template.PDF)
|
||||
|
||||