furyhawk/xiaozhi-esp32
1
0
Fork 0
mirror of https://github.com/78/xiaozhi-esp32.git synced 2026-07-21 02:05:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

add quandong support (#2010)

Browse Source 
Co-authored-by: shujun <shujun@beithing.com>
This commit is contained in:
hashcodeFF
2026-05-26 05:42:19 +08:00
committed by GitHub
co-authored by shujun
parent bcc9b599ca
commit 331d69b83b
6 changed files with 416 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
main/CMakeLists.txt
+5
View File
@@ -153,6 +153,11 @@ elseif(CONFIG_BOARD_TYPE_LICHUANG_DEV_S3)
set(BUILTIN_TEXT_FONT font_noto_basic_20_4)
set(BUILTIN_ICON_FONT font_awesome_20_4)
set(DEFAULT_EMOJI_COLLECTION noto-emoji_128)
elseif(CONFIG_BOARD_TYPE_QUANDONG_S3_DEV)
set(BOARD_TYPE "quandong-s3-dev")
set(BUILTIN_TEXT_FONT font_noto_basic_20_4)
set(BUILTIN_ICON_FONT font_awesome_20_4)
set(DEFAULT_EMOJI_COLLECTION noto-emoji_128)
elseif(CONFIG_BOARD_TYPE_LICHUANG_DEV_C3)
set(BOARD_TYPE "lichuang-c3-dev")
set(BUILTIN_TEXT_FONT font_puhui_basic_20_4)
main/Kconfig.projbuild
+3
View File
@@ -212,6 +212,9 @@ choice BOARD_TYPE
config BOARD_TYPE_LICHUANG_DEV_S3
bool "立创·实战派 ESP32-S3"
depends on IDF_TARGET_ESP32S3
config BOARD_TYPE_QUANDONG_S3_DEV
bool "全动 ESP32-S3 开发板"
depends on IDF_TARGET_ESP32S3
config BOARD_TYPE_LICHUANG_DEV_C3
bool "立创·实战派 ESP32-C3"
depends on IDF_TARGET_ESP32C3
main/boards/quandong-s3-dev/HARDWARE_DIFF.md
+163
View File
@@ -0,0 +1,163 @@
# quandong-s3-dev vs bread-compact-wifi 硬件差异
两块板都基于 **ESP32-S3 + WiFi**，软件层都继承 `WifiBoard`，启动 → 配网 → 接小智后端 → 语音对话 的主流程完全一致。差异集中在 **音频路径**、**显示**、**人机交互** 三块。
---
## 1. 概览
| 维度 | quandong-s3-dev | bread-compact-wifi |
|---|---|---|
| 芯片 | ESP32-S3 | ESP32-S3 |
| 基类 | `WifiBoard` | `WifiBoard` |
| 音频 codec | **ES8311 硬 codec**（I2C 控制 + I2S 全双工） | **无 codec**：MEMS I2S 麦克 + I2S 数字功放（`NoAudioCodec`） |
| 显示 | **ILI9341 240×320 SPI 彩屏** | **SSD1306 / SH1106 OLED 128×32 或 128×64**（I2C 单色） |
| 按键数 | 1（BOOT） | 4（BOOT、Touch、Vol+、Vol-） |
| 板载 LED | 无 | GPIO48 单色 |
| MCP 外设示例 | 无 | `LampController`（GPIO18） |
| 背光 | PWM on GPIO45 | OLED 无背光 |
| 字体 / emoji 资源 | `font_noto_basic_20_4` + `font_awesome_20_4` + `noto-emoji_128` | `font_puhui_basic_14_1` + `font_awesome_14_1`（无 emoji） |
---
## 2. 音频子系统
### quandong-s3-dev
| 项 | 值 |
|---|---|
| Codec 芯片 | **ES8311**（I2C 地址 `ES8311_CODEC_DEFAULT_ADDR`） |
| I2C 总线 | I2C0，SDA = **GPIO16**，SCL = **GPIO15** |
| I2S 模式 | **Duplex**（一套 I2S 复用） |
| I2S 引脚 | MCLK = **GPIO4**，BCLK = **GPIO5**，WS = **GPIO7**，DIN = **GPIO6**，DOUT = **GPIO8** |
| 采样率 | 输入 / 输出 = **24000 / 24000** |
| 功放控制 | **GPIO1 拉低使能**（由 `InitializeAudioPaEnable()` 处理） |
| 音量控制 | 通过 ES8311 寄存器（`Es8311AudioCodec::SetOutputVolume`） |
### bread-compact-wifi
| 项 | 值 |
|---|---|
| Codec 芯片 | **无**（用 `NoAudioCodecSimplex`） |
| I2S 模式 | **Simplex**（麦克和喇叭走两套 I2S） |
| 麦克 I2S | WS = GPIO4，SCK = GPIO5，DIN = GPIO6 |
| 喇叭 I2S | DOUT = GPIO7，BCLK = GPIO15，LRCK = GPIO16 |
| 采样率 | 输入 / 输出 = **16000 / 24000** |
| 音量控制 | I2S 数字增益（软件实现） |
### 关键差异
- **硬件 codec vs 纯 I2S**：ES8311 提供更稳定的 ADC/DAC、硬件音量、消除 PoP，bread-compact-wifi 依赖软件处理。
- **采样率**：quandong 麦克按 24kHz 采，bread-compact-wifi 是 16kHz。两者都被 audio pipeline 重采样到协议层需要的速率。
- **I2C 资源**：quandong 用 I2C0 控 ES8311；bread-compact-wifi 的 I2C0 用来挂 SSD1306。两块板的 I2C0 用途完全不同，引脚也完全不同。
---
## 3. 显示子系统
### quandong-s3-dev
| 项 | 值 |
|---|---|
| 屏型号 | **ILI9341** |
| 接口 | **SPI**（SPI2，40 MHz） |
| 分辨率 | **240 × 320**，配置为横屏使用（`SWAP_XY=true` → 实际 320×240） |
| 引脚 | MOSI = GPIO11，SCK = GPIO12，CS = GPIO10，DC = GPIO46 |
| 背光 | **PWM 控制**，GPIO45，非反相 |
| 显示类 | `SpiLcdDisplay`（LVGL 9，RGB565） |
| 初始化序列 | 板厂自定义 `ili9341_vendor_specific_init`（gamma / power 时序） |
### bread-compact-wifi
| 项 | 值 |
|---|---|
| 屏型号 | **SSD1306**（默认）或 **SH1106**（由 Kconfig `DISPLAY_OLED_TYPE` 选择） |
| 接口 | **I2C**（400 kHz），地址 `0x3C` |
| 分辨率 | **128 × 32** 或 **128 × 64**（Kconfig 选择） |
| 引脚 | SDA = GPIO41，SCL = GPIO42 |
| 背光 | 无（OLED 自发光） |
| 显示类 | `OledDisplay`（LVGL 9，1bit 单色） |
### 关键差异
- **彩屏 vs 单色**：quandong 能跑 emoji、AI logo、大字体；bread-compact-wifi 只能塞下 1~2 行文字 + 简易图标。
- **接口带宽**：SPI 40 MHz vs I2C 400 kHz，差两个数量级，影响画面刷新流畅度。
- **驱动栈**：quandong 用 `esp_lcd_ili9341` (component 1.2.0) + `lvgl_port`；bread-compact-wifi 用 `esp_lcd_panel_ssd1306` / `esp_lcd_panel_sh1106`。
---
## 4. 输入与状态指示
### 按键
| 按键 | quandong | bread-compact-wifi | 行为 |
|---|---|---|---|
| BOOT (GPIO0) | ✅ | ✅ | 启动期进配网；运行时 `ToggleChatState`（按一下开/关对话） |
| Touch (GPIO47) | ❌ | ✅ | **按住说话**：`OnPressDown→StartListening`, `OnPressUp→StopListening` |
| Vol+ (GPIO40) | ❌ | ✅ | 单击 +10 音量；长按拉满 100 |
| Vol- (GPIO39) | ❌ | ✅ | 单击 -10 音量；长按静音 |
→ quandong 只有 BOOT 一个键，**没有按住说话**，**没有物理音量键**。调音量需要走 MCP / 语音指令。
### LED
| 板子 | LED | 用途 |
|---|---|---|
| quandong | `BUILTIN_LED_GPIO = NC` | 无 |
| bread-compact-wifi | GPIO48，`SingleLed` | 状态指示（idle / listening / speaking） |
### MCP 工具
bread-compact-wifi 注册了一个 `LampController(GPIO18)` 作为 MCP 协议演示，可以远程通过小智指令"开灯/关灯"。quandong 没有这种外设示例。
---
## 5. 启动流程差异
主流程相同（详见 `application.cc:61` / `wifi_board.cc:52`），UI 也由 `Application::Initialize()` 统一拉起。差别只在 **board 构造里做的事**：
### quandong-s3-dev 构造序列
```
InitializeI2c() // I2C0 for ES8311
InitializeSpi() // SPI2 for ILI9341
InitializeAudioPaEnable() // GPIO1 拉低使能功放
InitializeIli9341Display() // 自定义 init cmds + 实例化 SpiLcdDisplay
InitializeButtons() // BOOT 单键
GetBacklight()->SetBrightness(100)
```
### bread-compact-wifi 构造序列
```
InitializeDisplayI2c() // I2C0 for SSD1306
InitializeSsd1306Display() // OledDisplay
InitializeButtons() // BOOT + Touch + Vol+ + Vol-
InitializeTools() // 注册 LampController（MCP 外设）
```
---
## 6. 资源与构建配置
`main/CMakeLists.txt` 中的字体与 emoji 配置差异：
| 板子 | text font | icon font | emoji collection |
|---|---|---|---|
| quandong-s3-dev | `font_noto_basic_20_4` | `font_awesome_20_4` | `noto-emoji_128` |
| bread-compact-wifi | `font_puhui_basic_14_1` | `font_awesome_14_1` | （无） |
→ quandong 走的是和 `lichuang-dev`、`esp-box-3` 等 240×320 LCD 板同档资源；OLED 板因为像素少，用 14 像素位图字体即可，emoji 也加载不动。
### 其它依赖
- quandong 需要 `espressif/esp_lcd_ili9341 ==1.2.0`（仓库 `main/idf_component.yml` 已有，无需补依赖）
- bread-compact-wifi 不需要额外组件，`esp_lcd_panel_ssd1306` 走 ESP-IDF 自带的 driver
---
## 7. 一句话总结
> **quandong-s3-dev** ≈ "彩屏 + 硬 codec + 单按键" 的工程开发板，UI 表现力强但交互简化。
> **bread-compact-wifi** ≈ "OLED + 纯 I2S 软 codec + 多按键 + 板载 lamp" 的面包板参考实现，便于上手 MCP 外设。
> 功能层（配网、语音通话、MCP、唤醒）由 `WifiBoard` 基类统一提供，两者表现一致。
main/boards/quandong-s3-dev/config.h
+57
View File
@@ -0,0 +1,57 @@
#ifndef _BOARD_CONFIG_H_
#define _BOARD_CONFIG_H_
#include <driver/gpio.h>
#define AUDIO_INPUT_SAMPLE_RATE 24000
#define AUDIO_OUTPUT_SAMPLE_RATE 24000
#define AUDIO_I2S_GPIO_MCLK GPIO_NUM_4
#define AUDIO_I2S_GPIO_WS GPIO_NUM_7
#define AUDIO_I2S_GPIO_BCLK GPIO_NUM_5
#define AUDIO_I2S_GPIO_DIN GPIO_NUM_6
#define AUDIO_I2S_GPIO_DOUT GPIO_NUM_8
#define AUDIO_CODEC_USE_PCA9557
#define AUDIO_CODEC_PA_PIN GPIO_NUM_NC
#define AUDIO_CODEC_I2C_SCL_PIN GPIO_NUM_15
#define AUDIO_CODEC_I2C_SDA_PIN GPIO_NUM_16
#define AUDIO_CODEC_ES8311_ADDR ES8311_CODEC_DEFAULT_ADDR
#define AUDIO_CODEC_ES7210_ADDR 0x82
// GPIO1 拉低用于使能板载音频功放
#define AUDIO_PA_ENABLE_PIN GPIO_NUM_1
#define BUILTIN_LED_GPIO GPIO_NUM_NC
#define BOOT_BUTTON_GPIO GPIO_NUM_0
#define VOLUME_UP_BUTTON_GPIO GPIO_NUM_NC
#define VOLUME_DOWN_BUTTON_GPIO GPIO_NUM_NC
#define DISPLAY_SPI_SCK_PIN GPIO_NUM_12
#define DISPLAY_SPI_MOSI_PIN GPIO_NUM_11
#define DISPLAY_DC_PIN GPIO_NUM_46
#define DISPLAY_SPI_CS_PIN GPIO_NUM_10
/******横屏显示******/
#define DISPLAY_WIDTH 320
#define DISPLAY_HEIGHT 240
#define DISPLAY_MIRROR_X false
#define DISPLAY_MIRROR_Y true
#define DISPLAY_SWAP_XY true
/******竖屏显示（可选）******/
/*
#define DISPLAY_WIDTH 240
#define DISPLAY_HEIGHT 320
#define DISPLAY_MIRROR_X false
#define DISPLAY_MIRROR_Y false
#define DISPLAY_SWAP_XY false
*/
#define DISPLAY_OFFSET_X 0
#define DISPLAY_OFFSET_Y 0
#define DISPLAY_BACKLIGHT_PIN GPIO_NUM_45
#define DISPLAY_BACKLIGHT_OUTPUT_INVERT false
#endif // _BOARD_CONFIG_H_
main/boards/quandong-s3-dev/config.json
+9
View File
@@ -0,0 +1,9 @@
{
"target": "esp32s3",
"builds": [
{
"name": "quandong-s3-dev",
"sdkconfig_append": []
}
]
}
main/boards/quandong-s3-dev/quandong_s3_dev_board.cc
+179
View File
@@ -0,0 +1,179 @@
#include "wifi_board.h"
#include "codecs/es8311_audio_codec.h"
#include "display/lcd_display.h"
#include "esp_lcd_ili9341.h"
#include "application.h"
#include "button.h"
#include "config.h"
#include <esp_log.h>
#include <esp_lcd_panel_vendor.h>
#include <driver/i2c_master.h>
#include <driver/spi_common.h>
#include <wifi_station.h>
#define TAG "QuandongS3DevBoard"
// ILI9341 厂家自定义初始化序列
static const ili9341_lcd_init_cmd_t vendor_specific_init[] = {
{0xCF, (uint8_t []){0x00, 0xC1, 0x30}, 3, 0},
{0xED, (uint8_t []){0x64, 0x03, 0x12, 0x81}, 4, 0},
{0xE8, (uint8_t []){0x85, 0x00, 0x78}, 3, 0},
{0xCB, (uint8_t []){0x39, 0x2C, 0x00, 0x34, 0x02}, 5, 0},
{0xF7, (uint8_t []){0x20}, 1, 0},
{0xEA, (uint8_t []){0x00, 0x00}, 2, 0},
{0xC0, (uint8_t []){0x13}, 1, 0},
{0xC1, (uint8_t []){0x13}, 1, 0},
{0xC5, (uint8_t []){0x22, 0x35}, 2, 0},
{0xC7, (uint8_t []){0xBD}, 1, 0},
{0, (uint8_t []){0}, 0x11, 0},
{0x36, (uint8_t []){0x08}, 1, 0},
{0xB6, (uint8_t []){0x0A, 0xA2}, 2, 0},
{0x3A, (uint8_t []){0x55}, 1, 0},
{0xF6, (uint8_t []){0x01, 0x30}, 2, 0},
{0xB1, (uint8_t []){0x00, 0x1B}, 2, 0},
{0xF2, (uint8_t []){0x00}, 1, 0},
{0x26, (uint8_t []){0x01}, 1, 0},
{0xE0, (uint8_t []){0x0F, 0x35, 0x31, 0x0B, 0x0E, 0x06, 0x49, 0xA7, 0x33, 0x07, 0x0F, 0x03, 0x0C, 0x0A, 0x00}, 15, 0},
{0xE1, (uint8_t []){0x00, 0x0A, 0x0F, 0x04, 0x11, 0x08, 0x36, 0x58, 0x4D, 0x07, 0x10, 0x0C, 0x32, 0x34, 0x0F}, 15, 0},
{0, (uint8_t []){0}, 0x11, 0},
{0, (uint8_t []){0}, 0x29, 0},
};
class QuandongS3DevBoard : public WifiBoard {
private:
i2c_master_bus_handle_t codec_i2c_bus_;
Button boot_button_;
LcdDisplay* display_ = nullptr;
void InitializeI2c() {
i2c_master_bus_config_t i2c_bus_cfg = {
.i2c_port = I2C_NUM_0,
.sda_io_num = AUDIO_CODEC_I2C_SDA_PIN,
.scl_io_num = AUDIO_CODEC_I2C_SCL_PIN,
.clk_source = I2C_CLK_SRC_DEFAULT,
.glitch_ignore_cnt = 7,
.intr_priority = 0,
.trans_queue_depth = 0,
.flags = {
.enable_internal_pullup = 1,
},
};
ESP_ERROR_CHECK(i2c_new_master_bus(&i2c_bus_cfg, &codec_i2c_bus_));
}
void InitializeSpi() {
spi_bus_config_t buscfg = {};
buscfg.mosi_io_num = DISPLAY_SPI_MOSI_PIN;
buscfg.miso_io_num = GPIO_NUM_NC;
buscfg.sclk_io_num = DISPLAY_SPI_SCK_PIN;
buscfg.quadwp_io_num = GPIO_NUM_NC;
buscfg.quadhd_io_num = GPIO_NUM_NC;
buscfg.max_transfer_sz = DISPLAY_WIDTH * DISPLAY_HEIGHT * sizeof(uint16_t);
ESP_ERROR_CHECK(spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO));
}
// 板上音频功放使能引脚，需置为低电平
void InitializeAudioPaEnable() {
gpio_config_t io_conf = {};
io_conf.pin_bit_mask = (1ULL << AUDIO_PA_ENABLE_PIN);
io_conf.mode = GPIO_MODE_OUTPUT;
io_conf.pull_up_en = GPIO_PULLUP_DISABLE;
io_conf.pull_down_en = GPIO_PULLDOWN_DISABLE;
io_conf.intr_type = GPIO_INTR_DISABLE;
gpio_config(&io_conf);
gpio_set_level(AUDIO_PA_ENABLE_PIN, 0);
}
void InitializeButtons() {
// 与 bread-compact-wifi 一致：启动期间按下 BOOT 进入配网，否则切换对话状态
boot_button_.OnClick([this]() {
auto& app = Application::GetInstance();
if (app.GetDeviceState() == kDeviceStateStarting) {
EnterWifiConfigMode();
return;
}
app.ToggleChatState();
});
}
void InitializeIli9341Display() {
esp_lcd_panel_io_handle_t panel_io = nullptr;
esp_lcd_panel_handle_t panel = nullptr;
ESP_LOGD(TAG, "Install panel IO");
esp_lcd_panel_io_spi_config_t io_config = {};
io_config.cs_gpio_num = DISPLAY_SPI_CS_PIN;
io_config.dc_gpio_num = DISPLAY_DC_PIN;
io_config.spi_mode = 0;
io_config.pclk_hz = 40 * 1000 * 1000;
io_config.trans_queue_depth = 10;
io_config.lcd_cmd_bits = 8;
io_config.lcd_param_bits = 8;
ESP_ERROR_CHECK(esp_lcd_new_panel_io_spi(SPI2_HOST, &io_config, &panel_io));
ESP_LOGD(TAG, "Install LCD driver");
const ili9341_vendor_config_t vendor_config = {
.init_cmds = &vendor_specific_init[0],
.init_cmds_size = sizeof(vendor_specific_init) / sizeof(ili9341_lcd_init_cmd_t),
};
esp_lcd_panel_dev_config_t panel_config = {};
panel_config.reset_gpio_num = GPIO_NUM_NC;
panel_config.flags.reset_active_high = 1;
panel_config.rgb_ele_order = LCD_RGB_ELEMENT_ORDER_RGB;
panel_config.bits_per_pixel = 16;
panel_config.vendor_config = (void *)&vendor_config;
ESP_ERROR_CHECK(esp_lcd_new_panel_ili9341(panel_io, &panel_config, &panel));
esp_lcd_panel_reset(panel);
esp_lcd_panel_init(panel);
esp_lcd_panel_invert_color(panel, true);
esp_lcd_panel_swap_xy(panel, DISPLAY_SWAP_XY);
esp_lcd_panel_mirror(panel, DISPLAY_MIRROR_X, DISPLAY_MIRROR_Y);
esp_lcd_panel_disp_on_off(panel, true);
display_ = new SpiLcdDisplay(panel_io, panel,
DISPLAY_WIDTH, DISPLAY_HEIGHT, DISPLAY_OFFSET_X, DISPLAY_OFFSET_Y,
DISPLAY_MIRROR_X, DISPLAY_MIRROR_Y, DISPLAY_SWAP_XY);
}
public:
QuandongS3DevBoard() : boot_button_(BOOT_BUTTON_GPIO) {
InitializeI2c();
InitializeSpi();
InitializeAudioPaEnable();
InitializeIli9341Display();
InitializeButtons();
GetBacklight()->SetBrightness(100);
}
virtual AudioCodec* GetAudioCodec() override {
static Es8311AudioCodec audio_codec(
codec_i2c_bus_,
I2C_NUM_0,
AUDIO_INPUT_SAMPLE_RATE,
AUDIO_OUTPUT_SAMPLE_RATE,
AUDIO_I2S_GPIO_MCLK,
AUDIO_I2S_GPIO_BCLK,
AUDIO_I2S_GPIO_WS,
AUDIO_I2S_GPIO_DOUT,
AUDIO_I2S_GPIO_DIN,
AUDIO_CODEC_PA_PIN,
AUDIO_CODEC_ES8311_ADDR,
true,
true);
return &audio_codec;
}
virtual Display* GetDisplay() override {
return display_;
}
virtual Backlight* GetBacklight() override {
static PwmBacklight backlight(DISPLAY_BACKLIGHT_PIN, DISPLAY_BACKLIGHT_OUTPUT_INVERT);
return &backlight;
}
};
DECLARE_BOARD(QuandongS3DevBoard);