Development Documentation

Development Documentation

Development Environment

  • Cursor or VSCode
  • Install ESP-IDF plugin, select SDK version 5.3 or above
  • Linux is better than Windows, with faster compilation and no driver issues
  • Follow Google C++ Style Guide, ensure code compliance before submission

ESP-IDF Environment Setup 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 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 functionalities.

Emoji Emotion Display

Introduces how large language models use Emoji to express emotional states, along with related data formats and usage instructions.

Document Index

Document NameDescriptionLast Updated
ESP-IDF Environment SetupESP-IDF Environment Setup and Xiaozhi Compilation Guide for Windows2025-03-06
WebSocket Communication ProtocolWebSocket Client-Server Communication Protocol Documentation2025-03-06
Emoji Emotion DisplayCommunication Protocol for LLM Emotional Expression via Emoji2025-03-06