ESP-Skainet [中文]
ESP-Skainet is Espressif's intelligent voice assistant, which currently supports the Wake Word Engine and Speech Commands Recognition.
ESP-Skainet supports the development of wake word detection and speech commands recognition applications based around Espressif Systems' ESP32 chip in the most convenient way. With ESP-Skainet, you can easily build up wake word detection and speech command recognition applications.
In general, the ESP-Skainet features will be supported, as shown below:
The input audio stream can come from any way of providing voice, such as MIC, wav/pcm files in flash/SD Card.
Espressif wake word engine WakeNet is specially designed to provide a high performance and low memory footprint wake word detection algorithm for users, which enables devices always wait for wake words, such as "Alexa", “天猫精灵” (Tian Mao Jing Ling), and “小爱同学” (Xiao Ai Tong Xue).
Currently, Espressif has not only provided an official wake word "Hi, Lexin" to the public for free but also allows customized wake words. For details on how to customize your own wake words, please see Espressif Speech Wake Words Customization Process.
Espressif's speech command recognition model MultiNet is specially designed to provide a flexible offline speech command recognition model. With this model, you can easily add your own speech commands, eliminating the need to train model again.
Currently, Espressif MultiNet supports up to 200 Chinese or English speech commands, such as “打开空调” (Turn on the air conditioner) and “打开卧室灯” (Turn on the bedroom light).
Espressif Audio Front-End AFE integrates AEC (Acoustic Echo Cancellation), VAD (Voice Activity Detection),BSS (Blind Source Separation) and NS (Noise Suppression).
Our two-mic Audio Front-End (AFE) have been qualified as a “Software Audio Front-End Solution” for Amazon Alexa Built-in devices.
To run ESP-Skainet, you need to have an ESP32 or ESP32-S3 development board which integrates an audio input module . Development board Support:
| Example Name | Latest Models | Supported Board |
|---|---|---|
| cn_speech_commands_recognition | Multinet4_5 | ESP32-Korvo, ESP32-S3-Korvo-1, ESP-BOX, ESP-S3-Korvo-2, ESP32-S3-EYE |
| en_speech_commands_recognition | Multinet5 | ESP32-S3-Korvo-1, ESP-BOX, ESP-S3-Korvo-2, ESP32-S3-EYE |
| wake_word_detection | Wakenet8 | ESP32-Korvo, ESP32-S3-Korvo-1, ESP-BOX, ESP-S3-Korvo-2, ESP32-S3-EYE |
| chinese_tts | esp-tts-v1 | ESP32-Korvo, ESP32-S3-Korvo-1, ESP-BOX, ESP-S3-Korvo-2 |
On how to configure your applications, please refer to the README.md of each example.
Make sure you have cloned this project with the --recursive option, shown as follows:
git clone --recursive https://github.com/espressif/esp-skainet.git
If you have cloned this project without the --recursive option, please go to the esp-skainet directory and run the git submodule update --init command before anything else.
In this case, we take ESP-IDF v4.4 as the test version. If you had already configured ESP-IDF before, and do not want to change your existing one, you can configure the IDF_PATH environment variable to the path to ESP-IDF.
For details on how to set up the ESP-IDF, please refer to Getting Started Guide for the stable ESP-IDF version
The folder of examples contains sample applications demonstrating the API features of ESP-Skainet.
Please start with the wake_word_detection example.
- Navigate to one example folder `esp-skainet/examples/wake_word_detection).
cd esp-skainet/examples/wake_word_detection
- Compile and flash the project.
idf.py flash monitor
- Advanced users can add or modify speech commands by using the
idf.py menuconfigcommand.
For details, please read the README file in each example.
-
View the Issues section on GitHub if you find a bug or have a feature request, please check existing Issues before opening a new one.
-
If you are interested in contributing to ESP-Skainet, please check the Contributions Guide.