XiaoZhi AI Chatbot Documentation Center | XiaoZhi.Dev
XiaoZhi AI Chatbot Documentation Center | XiaoZhi.Dev
📖 XiaoZhi AI Documentation Center
XiaoZhi AI is an open-source intelligent voice robot built on the ESP32 family (S3, C3, C5, C6, P4 and more), integrating wake word detection, AI conversation, device control, and multi-protocol communication capabilities. This documentation center provides complete technical guides from hardware assembly to AI integration.
Project Features:
- 🎙️ Wake Word Detection: Supports 26 wake words including “Hello XiaoZhi”, <200ms response
- 🧠 Conversation: LLMs are integrated on the server side; the device talks to the server over WebSocket or MQTT + UDP
- 🏠 IoT Control: Integrates MQTT, MCP protocols for smart home control
- 🔧 Open Source Hardware: Covers ESP32, C3, C5, C6, S3 and P4 platforms, complete open-source solution
🚀 Quick Start
Beginner’s Guide
ESP32-S3 board assembly, wiring solutions and component lists
Pre-compiled firmware download, flashing tools and configuration guide
Wi-Fi setup, device connection and network troubleshooting
Voice interaction, AI conversation and device control features
📚 Documentation Navigation
🛠️ User Guide
Complete tutorials for users
- Hardware Setup Guide - ESP32-S3 hardware assembly and wiring solutions
- Firmware Download & Flashing - Pre-compiled firmware acquisition and installation
- Network Configuration - Wi-Fi setup and network troubleshooting
- Self-Hosted Server - connect a device to your own server
- Feature Usage Tutorial - Voice interaction and smart control features
- ESP32 Budget Version - Low-cost ESP32 hardware solution
- Frequently Asked Questions - Common issues and solutions during usage
💻 Development Documentation
In-depth technical guides for developers
- ESP-IDF Environment Setup - Development environment configuration and compilation guide
- WebSocket Communication Protocol - Device-server communication protocol
- MCP Protocol Development - Model Context Protocol IoT control
- MQTT+UDP Hybrid Protocol - Control and audio hybrid communication
- Emoji Emotion Display - LLM emotion state expression protocol
- Custom Board Guide - add a board and build with scripts/build.py
- Ecosystem Projects - community servers, clients and ports
- Dynamic Text Glyph Push Extension - the server pushes glyphs missing from the device font
- Asynchronous Voice Notifications - notify message and Ogg Opus streaming playback
🔧 ESP32 Development Guide
Complete ESP32-S3 platform development tutorial
- Chip Support and Storage Specs - Supported chips, audio engines and partition tables
- Firmware Code Tour - Directory layout, state machine and development rules
- Advanced Extension Points - Network types, wake words, MCP and asset customization
- Troubleshooting - Build, flashing, audio and assets issues
🤖 AI Feature Capabilities
AI technology integration and capability overview
- 🎯 Voice Processing: Local wake word + cloud recognition hybrid solution
- 🧠 LLM Integration: Connected on the server side; the device is not tied to a specific model
- ⚡ On-device Wake Word: Espressif WakeNet / MultiNet, available depending on chip and PSRAM
- 🎵 Voice Synthesis: Synthesized on the server and delivered as Opus audio
🛠️ Technical Features
Hardware Platform
- Main Controller: ESP32-S3 dual-core 240MHz, 16MB Flash + 8MB PSRAM
- Audio Processing: INMP441 digital microphone + MAX98357A digital amplifier
- Display Output: SSD1306 OLED display + RGB status lights
- Network Communication: Wi-Fi (supported chips can pick the 5 GHz band automatically) + 4G Cat.1 communication (optional)
Software Architecture
- Development Framework: ESP-IDF v6.0.1+
- AI Engine: Espressif Wake Word Engine + cloud LLMs
- Communication Protocols: WebSocket + MQTT + MCP Protocol
- Audio Encoding: 16kHz PCM + Opus compression transmission
📊 Performance Metrics
| Feature Module | Performance Metrics | Notes |
|---|---|---|
| Wake Word Detection | <200ms latency, >99% accuracy | Local offline processing |
| Speech Recognition | <1s latency, >95% accuracy | Chinese recognition accuracy |
| AI Conversation | <3s response, supports 5+ LLMs | DeepSeek recommended |
| Device Control | <100ms command response | Local + cloud hybrid |
| Power Management | 5mA standby, 150mA active | Smart power optimization |
🗂️ Documentation Index
| Documentation Category | Document Name | Main Content | Update Time |
|---|---|---|---|
| User Guide | Hardware Setup Guide | ESP32-S3 assembly, wiring diagrams, component lists | 2025-03-19 |
| User Guide | Firmware Download | Pre-compiled firmware, flashing tools, configuration guide | 2025-03-18 |
| User Guide | Network Configuration | Wi-Fi setup, troubleshooting, advanced settings | 2025-03-18 |
| User Guide | Feature Tutorial | Voice interaction, device control, personalization settings | 2025-03-18 |
| User Guide | ESP32 Budget Version | Low-cost ESP32 development board construction solution | 2025-03-18 |
| User Guide | FAQ | Usage issues, troubleshooting, technical support | 2025-03-18 |
| User Guide | Self-Hosted Server | OTA URL, community servers, security warning | 2026-10-23 |
| Development Guide | Ecosystem Projects | Community servers, clients and ports | 2026-10-23 |
| Development Documentation | ESP-IDF Environment Setup | Development environment configuration, compilation toolchain installation | 2025-03-06 |
| Development Documentation | WebSocket Protocol | Communication protocol specifications, message format definitions | 2025-03-06 |
| Development Documentation | MCP Protocol Specification | Model Context Protocol interaction flow | 2025-03-20 |
| Development Documentation | MCP Usage Guide | Specific applications of IoT device control | 2025-03-20 |
| Development Documentation | MQTT+UDP Protocol | Control channel and audio channel hybrid communication | 2025-03-20 |
| Development Documentation | Emoji Emotion Display | LLM emotion state expression protocol | 2025-03-06 |
| ESP32 Development | Chip and Storage Specs | Supported chips, audio engines, partition tables | 2026-10-23 |
| ESP32 Development | Firmware Code Tour | Directory layout, state machine, development rules | 2026-10-23 |
| ESP32 Development | Advanced Extension Points | Network types, wake words, MCP, asset customization | 2026-10-23 |
| ESP32 Development | Troubleshooting | Build, flashing, audio and assets issues | 2026-10-23 |
| AI Features | AI Capabilities | Device and server roles, wake words, camera, languages | 2026-10-23 |
🔗 Related Resources
Community Resources
- 📖 Online Documentation: https://xiaozhi.dev/docs
- 💬 Technical Blog: https://xiaozhi.dev/blog
- 🚀 Project Updates: Follow GitHub repository updates
Technical Support:
- 📧 Contact Email: [email protected]
- 📖 Online Documentation: https://xiaozhi.dev/docs