xiaozhi-esp32 README

The project's README from github.com/78/xiaozhi-esp32. As one markdown file: README.md.

An MCP-based Chatbot

(English | 中文 | 日本語)

Introduction

👉 Human: Give AI a camera vs AI: Instantly finds out the owner hasn't washed hair for three days【bilibili】

👉 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.

Control everything via MCP

Recent Updates

Features Implemented

Hardware

Breadboard DIY Practice

See the Feishu document tutorial:

👉 "XiaoZhi AI Chatbot Encyclopedia"

Breadboard demo:

Breadboard Demo

Supports 138 Board Directories and 171 Release Variants (Partial List)

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

Developer Documentation

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)

For server deployment on personal computers, refer to the following open-source projects:

Other client projects using the XiaoZhi communication protocol:

Custom Assets Tools:

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

Star History

Star History Chart

xiaozhi-esp32 (78/xiaozhi-esp32)

c++
Searching Database…

What is this?XiaoZhi is an open-source firmware for ESP32 chips that turns a cheap microcontroller board into a voice-driven AI chatbot, using MCP to let the AI control devices and cloud services.
Is this an app I install on my phone, or firmware I flash onto a chip?It is C++ firmware that runs directly on ESP32-family chips; there is no phone app involved, though companion servers and clients exist as separate projects.
How do I get a device running with this?Beginners can flash a prebuilt firmware binary without setting up any dev environment; it connects to the official xiaozhi.me server by default and personal users get free access to the Qwen real-time model after registering an account.
Does compiling the firmware work the same on Windows and Linux?It works on both, but Linux is recommended since it compiles faster and has fewer driver issues than Windows.
Which ESP32 chips does it support?ESP32, ESP32-C3, ESP32-C5, ESP32-C6, ESP32-S3, and ESP32-P4, across 138 board directories and 171 release variants.
Does it need the internet, or can it run fully offline?Core wake-word detection is offline via ESP-SR, but the chat pipeline (ASR/LLM/TTS) relies on connecting to a server (official xiaozhi.me or a self-hosted alternative) over WebSocket or MQTT+UDP.
What can the device actually control through MCP?Device-side MCP lets the AI control local hardware like speakers, LEDs, servos and GPIO, while cloud-side MCP extends the model's reach to smart home control, PC desktop operation, knowledge search, and email.
Can I run my own server instead of the official xiaozhi.me?Yes, the community maintains alternative server implementations in Python, Java, and Go that speak the same XiaoZhi protocol, listed under Related Open Source Projects.
Does it support languages other than Chinese?Yes, the firmware ships with 39 interface languages with localized voice prompts where available and English fallback.
Creator
78
Size
11.4 MB
Stars
31.3K
Age
2y
Commits · 90 Days