3e78cd73bd
* Migrate board builds to ESP-IDF 6.0.1 * Document upstream IDF 6 CI blockers * Use IDF 6 patched registry components * Fix board-specific ESP-IDF 6 build errors * Fix remaining ESP-IDF 6 board builds * Document final ESP-IDF 6 matrix results [skip ci] * update IDF 6 component releases * rebase IDF 6 migration and use upstream SSCMA * Enhance audio input management in AudioService - Introduced AS_EVENT_AUDIO_INPUT_STOP_REQUEST to manage audio input stopping more effectively. - Updated AudioService::Start() to clear the new stop request event. - Modified AudioService::AudioInputTask() to handle the stop request and ensure proper input disabling. - Adjusted AdcPdmAudioCodec::Start() to reflect lazy input opening, ensuring start/stop operations run in the same task. * Refactor audio codec management and configuration - Added output_device_opened_ flag to track the state of the output device in Es8388 and Es8389 codecs. - Updated EnableOutput method to prevent unnecessary device reopening and added mute functionality to manage audio output more effectively. - Enhanced error handling in Es8311AudioCodec by ensuring proper closure and deletion of the codec device. - Adjusted sample rates in board configurations for atk-dnesp32s3-box2 to 24000 Hz and introduced AUDIO_CODEC_USE_MCLK for improved clock management. * Update build configurations and documentation for ESP-IDF 6 compatibility - Added container specification for the build workflow using espressif/idf:v6.0.1. - Updated the version of the espressif/esp_video component to ^2.3.0. - Enhanced documentation to clarify the support status of ESP32-P4 variants, specifying that legacy Rev < 3 variants are excluded from the IDF 6 matrix. - Adjusted board configurations to include IDF version constraints and necessary SDK configurations for legacy support. - Improved handling of YUV formats in EspVideo to maintain compatibility with previous versions. * Implement playback drained event handling in Application - Added MAIN_EVENT_PLAYBACK_DRAINED to manage playback state transitions. - Introduced callbacks for playback drained events in AudioService to trigger listening state changes. - Refactored Application::Run() to handle deferred listening start based on playback queue status. - Enhanced audio processing logic to prevent audio truncation during state changes. - Updated related methods to ensure proper wake word detection configuration during listening mode. * Fix variant selection shell in CI * Update project version to 2.4.0 and adjust component dependencies - Bump project version in CMakeLists.txt to 2.4.0. - Change espressif/esp_video component version to ^2.0.1 in idf_component.yml. - Modify AUDIO_INPUT_REFERENCE setting in config.h to false for m5stack-core-s3. - Remove unnecessary infinite loops in xmini_c3_board.cc during initialization. --------- Co-authored-by: Xiaoxia <terrence.huang@tenclass.com>
An MCP-based Chatbot
Introduction
👉 Handcraft your AI girlfriend, beginner's guide【bilibili】
As a voice interaction entry, the XiaoZhi AI chatbot leverages the AI capabilities of large models like Qwen / DeepSeek, and achieves multi-terminal control via the MCP protocol.
Version Notes
The current v2 version is incompatible with the v1 partition table, so it is not possible to upgrade from v1 to v2 via OTA. For partition table details, see partitions/v2/README.md.
All hardware running v1 can be upgraded to v2 by manually flashing the firmware.
The stable version of v1 is 1.9.2. You can switch to v1 by running git checkout v1. The v1 branch will be maintained until February 2026.
Features Implemented
- Wi-Fi / ML307 Cat.1 4G
- Offline voice wake-up ESP-SR
- Supports two communication protocols (Websocket or MQTT+UDP)
- Uses OPUS audio codec
- Voice interaction based on streaming ASR + LLM + TTS architecture
- Speaker recognition, identifies the current speaker 3D Speaker
- OLED / LCD display, supports emoji display
- Battery display and power management
- Multi-language support (Chinese, English, Japanese)
- Supports ESP32-C3, ESP32-S3, ESP32-P4 chip platforms
- Device-side MCP for device control (Speaker, LED, Servo, GPIO, etc.)
- Cloud-side MCP to extend large model capabilities (smart home control, PC desktop operation, knowledge search, email, etc.)
- Customizable wake words, fonts, emojis, and chat backgrounds with online web-based editing (Custom Assets Generator)
Hardware
Breadboard DIY Practice
See the Feishu document tutorial:
👉 "XiaoZhi AI Chatbot Encyclopedia"
Breadboard demo:
Supports 70+ Open Source Hardware (Partial List)
- LiChuang ESP32-S3 Development Board
- Espressif ESP32-S3-BOX3
- M5Stack CoreS3
- M5Stack AtomS3R + Echo Base
- Magic Button 2.4
- Waveshare ESP32-S3-Touch-AMOLED-1.8
- LILYGO T-Circle-S3
- XiaGe Mini C3
- CuiCan AI Pendant
- WMnologo-Xingzhi-1.54TFT
- SenseCAP Watcher
- ESP-HI Low Cost Robot Dog
Software
Firmware Flashing
For beginners, it is recommended to use the firmware that can be flashed without setting up a development environment.
The firmware connects to the official xiaozhi.me server by default. Personal users can register an account to use the Qwen real-time model for free.
👉 Beginner's Firmware Flashing Guide
Development Environment
- Cursor or VSCode
- Install ESP-IDF plugin, select SDK version 5.4 or above
- Linux is better than Windows for faster compilation and fewer driver issues
- This project uses Google C++ code style, please ensure compliance when submitting code
Developer Documentation
- Custom Board Guide - Learn how to create custom boards for XiaoZhi AI
- MCP Protocol IoT Control Usage - Learn how to control IoT devices via MCP protocol
- MCP Protocol Interaction Flow - Device-side MCP protocol implementation
- MQTT + UDP Hybrid Communication Protocol Document
- A detailed WebSocket communication protocol document
Large Model Configuration
If you already have a XiaoZhi AI chatbot device and have connected to the official server, you can log in to the xiaozhi.me console for configuration.
👉 Backend Operation Video Tutorial (Old Interface)
Related Open Source Projects
For server deployment on personal computers, refer to the following open-source projects:
- xinnan-tech/xiaozhi-esp32-server Python server
- joey-zhou/xiaozhi-esp32-server-java Java server
- AnimeAIChat/xiaozhi-server-go Golang server
- hackers365/xiaozhi-esp32-server-golang Golang server
Other client projects using the XiaoZhi communication protocol:
- huangjunsen0406/py-xiaozhi Python client
- TOM88812/xiaozhi-android-client Android client
- 100askTeam/xiaozhi-linux Linux client by 100ask
- 78/xiaozhi-sf32 Bluetooth chip firmware by Sichuan
- QuecPython/solution-xiaozhiAI QuecPython firmware by Quectel
Custom Assets Tools:
- 78/xiaozhi-assets-generator Custom Assets Generator (Wake words, fonts, emojis, backgrounds)
About the Project
This is an open-source ESP32 project, released under the MIT license, allowing anyone to use it for free, including for commercial purposes.
We hope this project helps everyone understand AI hardware development and apply rapidly evolving large language models to real hardware devices.
If you have any ideas or suggestions, please feel free to raise Issues or join our Discord or QQ group: 1095994019