Documentation
Documentation
Development Environment
- Cursor or VSCode
- Install ESP-IDF plugin, select SDK version 5.3 or above
- Linux is preferred over Windows for faster compilation and fewer driver issues
- Follow Google C++ Style Guide for code submissions
ESP-IDF Setup Guide and Xiaozhi Compilation
Detailed guide on setting up ESP-IDF 5.3.2 development environment on Windows and complete steps for compiling Xiaozhi firmware.
Communication Protocols
WebSocket Communication Protocol
Detailed explanation of WebSocket communication implementation between devices and servers, including connection establishment, message formats, audio transmission, and other core functionalities.
Emoji Emotion Display
Introduction to how large language models use Emoji to express emotional states, along with related data formats and usage instructions.
Document Index
| Document Name | Description | Last Updated |
|---|---|---|
| ESP-IDF Environment Setup | ESP-IDF Environment Setup and Compilation Guide for Windows | 2025-03-06 |
| WebSocket Protocol | WebSocket Client-Server Communication Protocol Documentation | 2025-03-06 |
| Emoji Emotion Display | Communication Protocol for LLM Emotional Expression via Emoji | 2025-03-06 |