Development Guide
Development Guide
XiaoZhi AI Development Documentation
This documentation is intended for developers who want to compile or modify the XiaoZhi AI program themselves. It includes the complete development environment setup process, core communication protocols, and implementation methods for extended functionality.
Development Environment
Communication Protocol Documentation
WebSocket Communication Protocol
Detailed explanation of WebSocket communication implementation between devices and servers, including connection establishment, message formats, audio transmission, and other core functions.
Emoji Emotion Display
Introduction to how large language models use Emoji to express emotional states, as well as related data formats and usage instructions.
Project Source Code Structure
The XiaoZhi AI project consists of the following main components:
- Main Control Program: Runs on ESP32 series chips
- Server Side: Handles device connections and voice forwarding
- Frontend Interface: Network configuration and settings page
Detailed source code structure and function descriptions can be found in the GitHub repository.
Common Development Issues
- Compilation Error Resolution: Usually related to ESP-IDF version mismatch; please use the specific ESP-IDF version recommended in the documentation
- Connection Timeout: Check WebSocket server configuration and network connection
- Insufficient Memory: ESP32-S3 development boards offer higher performance and are recommended
Documentation Index
| Document Name | Description | Update Time |
|---|---|---|
| ESP-IDF Development Environment Setup | ESP-IDF development environment setup guide for Windows and XiaoZhi compilation instructions | 2025-03-06 |
| WebSocket Communication Protocol | WebSocket client and server communication protocol documentation | 2025-03-06 |
| Emoji Emotion Display | Communication protocol for large language models to express emotional states via Emoji | 2025-03-06 |