From 861f60752eb6f585ac49d1dc4fa709cb7d1690ac Mon Sep 17 00:00:00 2001 From: shangjinlong Date: Tue, 20 Oct 2026 14:56:02 +0800 Subject: [PATCH] docs(boards): add descriptions for all supported boards --- .gitattributes | 13 ++ CHANGELOG.md | 2 + README.md | 3 + README.zh-CN.md | 2 + THIRD_PARTY_NOTICES.md | 8 ++ VENDORED_SOURCES.md | 30 +++- components/mybot_platform/boards/README.md | 31 ++++ .../boards/atom-echos3r/README.md | 45 ++++++ .../boards/bread-compact-wifi-lcd/README.md | 31 ++++ .../mybot_platform/boards/esp-vocat/README.md | 85 +++++++++++ .../esp32-s3-touch-amoled-1.75/README.md | 15 ++ .../esp32-s3-touch-amoled-1.75c/README.md | 15 ++ .../esp32-s3-touch-amoled-2.16/README.md | 15 ++ .../boards/m5stack-core-s3/README.md | 22 +++ .../boards/m5stack-stick-s3/README.md | 133 ++++++++++++++++++ .../README.md | 34 +++++ .../boards/sensecap-watcher/README.md | 52 +++++++ .../boards/sensecap-watcher/README_en.md | 53 +++++++ .../xingzhi-cube-1.54tft-wifi/README.md | 32 +++++ .../boards/zhengchen-1.54tft-ml307/README.md | 45 ++++++ .../boards/zhengchen-1.54tft-wifi/README.md | 45 ++++++ 21 files changed, 710 insertions(+), 1 deletion(-) create mode 100644 components/mybot_platform/boards/README.md create mode 100644 components/mybot_platform/boards/atom-echos3r/README.md create mode 100644 components/mybot_platform/boards/bread-compact-wifi-lcd/README.md create mode 100644 components/mybot_platform/boards/esp-vocat/README.md create mode 100644 components/mybot_platform/boards/esp32-s3-touch-amoled-1.75/README.md create mode 100644 components/mybot_platform/boards/esp32-s3-touch-amoled-1.75c/README.md create mode 100644 components/mybot_platform/boards/esp32-s3-touch-amoled-2.16/README.md create mode 100644 components/mybot_platform/boards/m5stack-core-s3/README.md create mode 100644 components/mybot_platform/boards/m5stack-stick-s3/README.md create mode 100644 components/mybot_platform/boards/respeaker-flex-xvf3800-circular4-xiao/README.md create mode 100644 components/mybot_platform/boards/sensecap-watcher/README.md create mode 100644 components/mybot_platform/boards/sensecap-watcher/README_en.md create mode 100644 components/mybot_platform/boards/xingzhi-cube-1.54tft-wifi/README.md create mode 100644 components/mybot_platform/boards/zhengchen-1.54tft-ml307/README.md create mode 100644 components/mybot_platform/boards/zhengchen-1.54tft-wifi/README.md diff --git a/.gitattributes b/.gitattributes index f7fef4e..75214d8 100644 --- a/.gitattributes +++ b/.gitattributes @@ -11,6 +11,19 @@ components/lvgl/** -whitespace components/esp-wifi-connect/** -whitespace third_party/** -whitespace +# Preserve board reference documents verbatim, including upstream whitespace and line endings. +components/mybot_platform/boards/atom-echos3r/README.md -text -whitespace +components/mybot_platform/boards/esp-vocat/README.md -text -whitespace +components/mybot_platform/boards/esp32-s3-touch-amoled-1.75/README.md -text -whitespace +components/mybot_platform/boards/esp32-s3-touch-amoled-1.75c/README.md -text -whitespace +components/mybot_platform/boards/esp32-s3-touch-amoled-2.16/README.md -text -whitespace +components/mybot_platform/boards/m5stack-core-s3/README.md -text -whitespace +components/mybot_platform/boards/m5stack-stick-s3/README.md -text -whitespace +components/mybot_platform/boards/sensecap-watcher/README.md -text -whitespace +components/mybot_platform/boards/sensecap-watcher/README_en.md -text -whitespace +components/mybot_platform/boards/zhengchen-1.54tft-ml307/README.md -text -whitespace +components/mybot_platform/boards/zhengchen-1.54tft-wifi/README.md -text -whitespace + *.a binary *.bin binary *.jpg binary diff --git a/CHANGELOG.md b/CHANGELOG.md index a308e76..0be1a58 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ Versioning and Conventional Commits. ### Added +- Per-board README files for all thirteen profiles, including eleven verbatim reference documents + covering ten profiles, three local descriptions, and a linked board documentation index. - CoreS3-only process-gray pixel-glasses UI, with 23 expressions, four 9 px terminal rows, a 10 px signature and fixed 32 px six-digit pairing codes on its 320x240 display. Automatic faces follow READY/conversation phases; four MCP emotions use bounded holds, diff --git a/README.md b/README.md index 5b6c33d..a988a20 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,9 @@ Circular-4 with XIAO ESP32S3, and SenseCAP Watcher. ## Supported Boards +Per-board descriptions and original reference documents are listed in the +[board documentation index](components/mybot_platform/boards/README.md). + | Board profile | Audio | Display and input | Storage | | --- | --- | --- | --- | | `zhengchen-1.54tft-ml307` | I2S microphone and speaker | ST7789, Boot and volume buttons | 16 MB QIO Flash, 8 MB Octal PSRAM | diff --git a/README.zh-CN.md b/README.zh-CN.md index c810489..449e560 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -35,6 +35,8 @@ StickS3、M5Stack AtomEchoS3R、搭配 XIAO ESP32S3 的 ReSpeaker Flex XVF3800 C ## 支持的板卡 +各板型目录中的说明和参考原文见[板卡说明索引](components/mybot_platform/boards/README.md)。 + | Board profile | 音频 | 显示与输入 | 存储 | | --- | --- | --- | --- | | `zhengchen-1.54tft-ml307` | I2S 麦克风和扬声器 | ST7789、Boot 与音量按键 | 16 MB QIO Flash、8 MB Octal PSRAM | diff --git a/THIRD_PARTY_NOTICES.md b/THIRD_PARTY_NOTICES.md index 865aad7..7b5b9e3 100644 --- a/THIRD_PARTY_NOTICES.md +++ b/THIRD_PARTY_NOTICES.md @@ -37,6 +37,7 @@ It does not replace third-party terms. This file is informational and is not leg | CoreS3 pixel-glasses renderer, geometry/mask generators (`dc4c854` BK reference) | MIT; expression helpers/policy retain their file-level Apache-2.0 notices | `components/mybot_platform/src/drivers/display/renderers/lvgl/pixel_glasses_view.cc`, pixel geometry/masks/generators and private expression support | | MyBot Terminal bitmap subsets derived from DejaVu Sans Mono Bold | Bitstream Vera font terms, with public-domain DejaVu changes | `components/mybot_platform/src/drivers/display/renderers/lvgl/pixel_fonts.c`, `TERMINAL_FONT_LICENSE.txt` | | Project-maintained shared LVGL panel adapters | Apache-2.0 unless file SPDX says otherwise | `components/mybot_platform/src/drivers/display/adapters/lvgl/st7789_lvgl_adapter.cc`, `components/mybot_platform/src/drivers/display/adapters/lvgl/shared_lvgl_adapter.cc` | +| Verbatim board README documents (`1d5eeb2` reference) | MIT | The eleven files listed under Board reference documents in `VENDORED_SOURCES.md` | | M5Stack CoreS3-derived implementation | MIT | Paths listed under MIT Attributions | | ReSpeaker Flex XVF3800-derived implementation (`b060243`) | MIT | Paths listed under MIT Attributions | | SenseCAP Watcher-derived implementation (`2b9b4e3`) | MIT | Paths listed under MIT Attributions | @@ -74,6 +75,13 @@ supply an authorized package locally. ## MIT Attributions +The eleven board reference README files listed in `VENDORED_SOURCES.md` are copied verbatim from +`github.com/junlon2006/xiaozhi-esp32` at commit `1d5eeb2dd51cb315f98ef3c7d3f2b96bd2bbcf1d`. +The upstream MIT copyright and full permission notice are retained in +`components/mybot_platform/assets/LICENSE.xiaozhi-esp32`. External product images remain linked +to their original sites; no additional image files are vendored. The separate Bread Compact +Wi-Fi LCD, Xingzhi Cube and ReSpeaker Flex profile descriptions are project-maintained documents. + The pinned esp-wifi-connect manifest declares MIT but its 3.2.2 archive omitted the license file. `components/esp-wifi-connect/LICENSE` is the byte-identical MIT text later published by that upstream project in commit `347682fa013b52f863052ad4b1a793ca3cabff17`. diff --git a/VENDORED_SOURCES.md b/VENDORED_SOURCES.md index dcc7859..cdd5d28 100644 --- a/VENDORED_SOURCES.md +++ b/VENDORED_SOURCES.md @@ -1,6 +1,6 @@ # Vendored Dependency Baselines -This file records only the revisions needed to reproduce the firmware build. License and +This file records the revisions of firmware inputs and copied board documents. License and redistribution terms are documented separately in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md). | Path | Source | Pinned revision | @@ -34,6 +34,34 @@ redistribution terms are documented separately in [THIRD_PARTY_NOTICES.md](THIRD | `components/mybot_platform/src/drivers/display/renderers/lvgl/lvgl_fonts.c`, `components/mybot_platform/src/drivers/display/assets/licenses/LVGL_VIEW_FONT_LICENSE.txt` | `github.com/lvgl/lvgl`, `scripts/built_in_font/SourceHanSansSC-Normal.otf` | LVGL 9.5.0 source font SHA-256 `1ee89e1669362dee13851129c0a8a791a87521eb4148e5efbf5d26596738e25b`; generated 20 px, 4 bpp static UI subset | | `components/mybot_platform/assets/ui/noto_emoji`, `components/mybot_platform/src/drivers/display/renderers/lvgl/lvgl_assets.c` | Noto Color Emoji font glyphs rasterized by `github.com/78/noto-fonts`, `png/noto-color-emoji_64` | 2.0.0, commit `d45dbc64052d57048f20ab1770074172ce9eb53b`; per-image SHA-256 values and glyph provenance in `assets/ui/noto_emoji/SOURCES.json` | +## Board reference documents + +The following files are copied verbatim from `github.com/junlon2006/xiaozhi-esp32` at commit +`1d5eeb2dd51cb315f98ef3c7d3f2b96bd2bbcf1d`. Paths in the source column are relative to +`main/boards/`; destination paths are relative to `components/mybot_platform/boards/`. +The copies retain upstream text, whitespace and line endings under the upstream MIT license. + +| Destination | Source | +| --- | --- | +| `atom-echos3r/README.md` | `atom-echos3r/README.md` | +| `esp-vocat/README.md` | `esp-vocat/README.md` | +| `esp32-s3-touch-amoled-1.75/README.md` | `waveshare/esp32-s3-touch-amoled-1.75/README.md` | +| `esp32-s3-touch-amoled-1.75c/README.md` | `waveshare/esp32-s3-touch-amoled-1.75/README.md` | +| `esp32-s3-touch-amoled-2.16/README.md` | `waveshare/esp32-s3-touch-amoled-2.16/README.md` | +| `m5stack-core-s3/README.md` | `m5stack-core-s3/README.md` | +| `m5stack-stick-s3/README.md` | `m5stack-stick-s3/README.md` | +| `sensecap-watcher/README.md` | `sensecap-watcher/README.md` | +| `sensecap-watcher/README_en.md` | `sensecap-watcher/README_en.md` | +| `zhengchen-1.54tft-ml307/README.md` | `zhengchen-1.54tft-ml307/README.md` | +| `zhengchen-1.54tft-wifi/README.md` | `zhengchen-1.54tft-wifi/README.md` | + +Upstream selects the same 1.75 directory for the 1.75C variant, so both profiles share its README. +The Bread Compact Wi-Fi LCD, Xingzhi Cube and ReSpeaker Flex profile READMEs are project-maintained +descriptions based on the checked-in profiles; no corresponding upstream README was available. +These documentation additions do not change firmware behavior or validation status. + +## Implementation references + External implementation references and hardware-mapping verification baselines used for project-maintained board ports are pinned separately; their application layer and dependency set are not vendored into this repository. diff --git a/components/mybot_platform/boards/README.md b/components/mybot_platform/boards/README.md new file mode 100644 index 0000000..c314d44 --- /dev/null +++ b/components/mybot_platform/boards/README.md @@ -0,0 +1,31 @@ +# Board documentation / 板卡说明 + +All 13 supported board profiles have a README in their own directory. Reference documents are +copied verbatim, including their original build instructions and feature descriptions. For this +firmware, use the [English build guide](../../../README.md#build) or +[中文构建说明](../../../README.zh-CN.md#构建); the active profile is defined by each `board.cmake` +and `board_config.h`. + +已有的板卡说明原样复制自参考工程，保留原文内容、行尾和格式，其中的菜单、脚本、固件名称 +及功能描述属于原工程。本工程使用 `MYBOT_BOARD` 和 `scripts/build_all.py` 构建，实际引脚与 +支持能力以各目录的 `board_config.h`、`board.cmake` 及本工程文档为准。 + +| Board profile | 说明 | 来源 | +| --- | --- | --- | +| `atom-echos3r` | [README](atom-echos3r/README.md) | 参考原文 | +| `bread-compact-wifi-lcd` | [README](bread-compact-wifi-lcd/README.md) | 参考工程无对应 README，按当前 profile 补充 | +| `esp-vocat` | [README](esp-vocat/README.md) | 参考原文 | +| `esp32-s3-touch-amoled-1.75` | [README](esp32-s3-touch-amoled-1.75/README.md) | 参考原文 | +| `esp32-s3-touch-amoled-1.75c` | [README](esp32-s3-touch-amoled-1.75c/README.md) | 与 1.75 共用参考原文，与上游板型映射一致 | +| `esp32-s3-touch-amoled-2.16` | [README](esp32-s3-touch-amoled-2.16/README.md) | 参考原文 | +| `m5stack-core-s3` | [README](m5stack-core-s3/README.md) | 参考原文 | +| `m5stack-stick-s3` | [README](m5stack-stick-s3/README.md) | 参考原文 | +| `respeaker-flex-xvf3800-circular4-xiao` | [README](respeaker-flex-xvf3800-circular4-xiao/README.md) | 参考工程无对应 README，按当前 profile 补充 | +| `sensecap-watcher` | [中文](sensecap-watcher/README.md) / [English](sensecap-watcher/README_en.md) | 参考原文 | +| `xingzhi-cube-1.54tft-wifi` | [README](xingzhi-cube-1.54tft-wifi/README.md) | 参考工程无对应 README，按当前 profile 补充 | +| `zhengchen-1.54tft-ml307` | [README](zhengchen-1.54tft-ml307/README.md) | 参考原文 | +| `zhengchen-1.54tft-wifi` | [README](zhengchen-1.54tft-wifi/README.md) | 参考原文 | + +Source mappings and the pinned revision are recorded in +[VENDORED_SOURCES.md](../../../VENDORED_SOURCES.md#board-reference-documents), with license terms in +[THIRD_PARTY_NOTICES.md](../../../THIRD_PARTY_NOTICES.md). diff --git a/components/mybot_platform/boards/atom-echos3r/README.md b/components/mybot_platform/boards/atom-echos3r/README.md new file mode 100644 index 0000000..ccb452f --- /dev/null +++ b/components/mybot_platform/boards/atom-echos3r/README.md @@ -0,0 +1,45 @@ +# AtomEchoS3R +## 简介 + +AtomEchoS3R 是 M5Stack 推出的基于 ESP32-S3-PICO-1-N8R8 的物联网可编程控制器，采用了 ES8311 单声道音频解码器、MEMS 麦克风和 NS4150B 功率放大器的集成方案。 + +开发版**不带屏幕、不带额外按键**，需要使用语音唤醒。必要时，需要使用 `idf.py monitor` 查看 log 以确定运行状态。 + +## 配置、编译命令 + +**配置编译目标为 ESP32S3** + +```bash +idf.py set-target esp32s3 +``` + +**打开 menuconfig 并配置** + +```bash +idf.py menuconfig +``` + +分别配置如下选项： + +- `Xiaozhi Assistant` → `Board Type` → 选择 `AtomEchoS3R` +- `Partition Table` → `Custom partition CSV file` → 删除原有内容，输入 `partitions/v2/8m.csv` +- `Serial flasher config` → `Flash size` → 选择 `8 MB` +- `Component config` → `ESP PSRAM` → `Support for external, SPI-connected RAM` → `SPI RAM config` → 选择 `Octal Mode PSRAM` + +按 `S` 保存，按 `Q` 退出。 + +**编译** + +```bash +idf.py build +``` + +**烧录** + +将 AtomEchoS3R 连接到电脑，按住侧面 RESET 按键，直到 RESET 按键下方绿灯闪烁。 + +```bash +idf.py flash +``` + +烧录完毕后，按一下 RESET 按钮重启设备。 diff --git a/components/mybot_platform/boards/bread-compact-wifi-lcd/README.md b/components/mybot_platform/boards/bread-compact-wifi-lcd/README.md new file mode 100644 index 0000000..de4f473 --- /dev/null +++ b/components/mybot_platform/boards/bread-compact-wifi-lcd/README.md @@ -0,0 +1,31 @@ +# Bread Compact Wi-Fi LCD + +本说明根据本工程的 [board.cmake](board.cmake)、[board_config.h](board_config.h) 和 +[sdkconfig.defaults](sdkconfig.defaults) 整理；参考工程没有该板型的独立 README。 + +## 硬件配置 + +| 项目 | 当前 profile | +| --- | --- | +| MCU | ESP32-S3，N16R8 配置 | +| Flash | 16 MB，QIO | +| PSRAM | 8 MB，Octal，80 MHz | +| 显示 | ST7789，240×320，SPI；GPIO42 PWM 背光 | +| 音频 | 麦克风与扬声器使用独立 I2S，16 kHz 单声道 | +| 输入 | GPIO0 Boot 按键，无独立音量键、无触摸 | +| 网络 | Wi-Fi | +| 分区 | `partitions/v2/16m.csv` | + +麦克风 WS/BCLK/DIN 分别为 GPIO4/5/6，扬声器 DOUT/BCLK/WS 分别为 GPIO7/15/16。 +显示引脚及方向配置见 `board_config.h`。当前 profile 没有摄像头支持。 + +## 构建 + +在工程根目录激活 ESP-IDF v5.5.2 后执行： + +```sh +python3 scripts/build_all.py --board bread-compact-wifi-lcd --language both +``` + +构建与烧录的完整说明见[项目文档](../../../../README.zh-CN.md#构建)。当前板型的 +实机验证状态见[平台移植文档](../../../../docs/BOARD_PORTING.zh-CN.md)。 diff --git a/components/mybot_platform/boards/esp-vocat/README.md b/components/mybot_platform/boards/esp-vocat/README.md new file mode 100644 index 0000000..614faf2 --- /dev/null +++ b/components/mybot_platform/boards/esp-vocat/README.md @@ -0,0 +1,85 @@ +# ESP-VoCat 喵伴 + +## 简介 + +
+ 立创开源平台 +
+ +ESP-VoCat 喵伴是一款智能 AI 开发套件，搭载 ESP32-S3-WROOM-1 模组，1.85 寸 QSPI 圆形触摸屏，双麦阵列，支持离线语音唤醒与声源定位算法。硬件详情等可查看[立创开源项目](https://oshwhub.com/esp-college/echoear)。 + +## 配置、编译命令 + +**配置编译目标为 ESP32S3** + +```bash +idf.py set-target esp32s3 +``` + +**打开 menuconfig 并配置** + +```bash +idf.py menuconfig +``` + +分别配置如下选项： + +### 基本配置 +- `Xiaozhi Assistant` → `Board Type` → 选择 `Espressif ESP-VoCat` + +### UI风格选择 + +ESP-VoCat 支持多种不同的 UI 显示风格，通过 menuconfig 配置选择： + +- `Xiaozhi Assistant` → `Select display style` → 选择显示风格 + +#### 可选风格 + +##### 表情动画风格 (Emote animation style) - 推荐 +- **配置选项**: `USE_EMOTE_MESSAGE_STYLE` +- **特点**: 使用自定义的 `EmoteDisplay` 表情显示系统 +- **功能**: 支持丰富的表情动画、眼睛动画、状态图标显示 +- **适用**: 智能助手场景，提供更生动的人机交互体验 +- **类**: `emote::EmoteDisplay` + +**⚠️ 重要**: 选择此风格需要额外配置自定义资源文件： +1. `Xiaozhi Assistant` → `Flash Assets` → 选择 `Flash Custom Assets` +2. `Xiaozhi Assistant` → `Custom Assets File` → 填入资源文件地址： + ``` + https://dl.espressif.com/AE/wn9_nihaoxiaozhi_tts-font_puhui_common_20_4-echoear.bin + ``` + + 这是保留表情动画和模型的历史资源包；新版固件会忽略其中没有 Noto 元数据的旧 Puhui + 字体，并使用内置 Noto basic 字体。待新的 Noto 资源包上传后可直接替换此 URL。 + +##### 默认消息风格 (Enable default message style) +- **配置选项**: `USE_DEFAULT_MESSAGE_STYLE` (默认) +- **特点**: 使用标准的消息显示界面 +- **功能**: 传统的文本和图标显示界面 +- **适用**: 标准的对话场景 +- **类**: `SpiLcdDisplay` + +##### 微信消息风格 (Enable WeChat Message Style) +- **配置选项**: `USE_WECHAT_MESSAGE_STYLE` +- **特点**: 仿微信聊天界面风格 +- **功能**: 类似微信的消息气泡显示 +- **适用**: 喜欢微信风格的用户 +- **类**: `SpiLcdDisplay` + +> **说明**: ESP-VoCat 喵伴使用16MB Flash，需要使用专门的分区表配置来合理分配存储空间给应用程序、OTA更新、资源文件等。 + +按 `S` 保存，按 `Q` 退出。 + +**编译** + +```bash +idf.py build +``` + +**烧录** + +将 ESP-VoCat 喵伴连接至电脑，**注意打开电源**，并运行： + +```bash +idf.py flash +``` diff --git a/components/mybot_platform/boards/esp32-s3-touch-amoled-1.75/README.md b/components/mybot_platform/boards/esp32-s3-touch-amoled-1.75/README.md new file mode 100644 index 0000000..5f99392 --- /dev/null +++ b/components/mybot_platform/boards/esp32-s3-touch-amoled-1.75/README.md @@ -0,0 +1,15 @@ +# Waveshare ESP32-S3-Touch-AMOLED-1.75 + + +[ESP32-S3-Touch-AMOLED-1.75](https://www.waveshare.com/esp32-s3-touch-amoled-1.75.htm) ESP32-S3-Touch-AMOLED-1.75 is a high performance, highly integrated microcontroller development board designed by Waveshare.\ +In the smaller form, the 1.75-inch capacitive HD AMOLED screen, highly integrated power management chip, six-axis sensor (three-axis accelerometer and three-axis gyroscope), RTC, low-power audio codec chip and echo cancellation circuit are mounted on the board, which is convenient for development and embedding into the product. + + +## images + +| [ESP32-S3-Touch-AMOLED-1.75](https://www.waveshare.com/esp32-s3-touch-amoled-1.75.htm) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | +| | +| | + diff --git a/components/mybot_platform/boards/esp32-s3-touch-amoled-1.75c/README.md b/components/mybot_platform/boards/esp32-s3-touch-amoled-1.75c/README.md new file mode 100644 index 0000000..5f99392 --- /dev/null +++ b/components/mybot_platform/boards/esp32-s3-touch-amoled-1.75c/README.md @@ -0,0 +1,15 @@ +# Waveshare ESP32-S3-Touch-AMOLED-1.75 + + +[ESP32-S3-Touch-AMOLED-1.75](https://www.waveshare.com/esp32-s3-touch-amoled-1.75.htm) ESP32-S3-Touch-AMOLED-1.75 is a high performance, highly integrated microcontroller development board designed by Waveshare.\ +In the smaller form, the 1.75-inch capacitive HD AMOLED screen, highly integrated power management chip, six-axis sensor (three-axis accelerometer and three-axis gyroscope), RTC, low-power audio codec chip and echo cancellation circuit are mounted on the board, which is convenient for development and embedding into the product. + + +## images + +| [ESP32-S3-Touch-AMOLED-1.75](https://www.waveshare.com/esp32-s3-touch-amoled-1.75.htm) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | +| | +| | + diff --git a/components/mybot_platform/boards/esp32-s3-touch-amoled-2.16/README.md b/components/mybot_platform/boards/esp32-s3-touch-amoled-2.16/README.md new file mode 100644 index 0000000..e8233a9 --- /dev/null +++ b/components/mybot_platform/boards/esp32-s3-touch-amoled-2.16/README.md @@ -0,0 +1,15 @@ +# Waveshare ESP32-S3-Touch-AMOLED-2.16 + + +[ESP32-S3-Touch-AMOLED-2.16](https://www.waveshare.com/esp32-s3-touch-amoled-2.16.htm) ESP32-S3-Touch-AMOLED-2.16 is a high performance, highly integrated microcontroller development board designed by Waveshare.\ +In the smaller form, the 2.16-inch capacitive HD AMOLED screen, highly integrated power management chip, six-axis sensor (three-axis accelerometer and three-axis gyroscope), RTC, low-power audio codec chip and echo cancellation circuit are mounted on the board, which is convenient for development and embedding into the product. + + +## images + +| [ESP32-S3-Touch-AMOLED-2.16](https://www.waveshare.com/esp32-s3-touch-amoled-2.16.htm) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | +| | +| | + diff --git a/components/mybot_platform/boards/m5stack-core-s3/README.md b/components/mybot_platform/boards/m5stack-core-s3/README.md new file mode 100644 index 0000000..d7aa9b8 --- /dev/null +++ b/components/mybot_platform/boards/m5stack-core-s3/README.md @@ -0,0 +1,22 @@ +# 使用说明 + + +**编译** + +```bash +python ./scripts/release.py m5stack-core-s3 +``` + +如需手动编译，请参考 `m5stack-core-s3/config.json` 修改 menuconfig 对应选项。 + +**烧录** + +```bash +idf.py flash +``` + +> [!NOTE] +> 进入下载模式：长按复位按键(约3秒)，直至内部指示灯亮绿色，松开按键。 + + + diff --git a/components/mybot_platform/boards/m5stack-stick-s3/README.md b/components/mybot_platform/boards/m5stack-stick-s3/README.md new file mode 100644 index 0000000..b8a5721 --- /dev/null +++ b/components/mybot_platform/boards/m5stack-stick-s3/README.md @@ -0,0 +1,133 @@ +# M5Stack Sticks3 + +* MCU: ESP32-S3 +* PSRAM: 8MB +* Flash: 8MB +* Display: 1.14Inch, 135x240 LCD. + +----------- +## Hardware + +* SYS_I2C/I2C0 + * SCL -- G48 + * SDA -- G47 +* PMIC: M5PM1 + * Interface: I2C0@0x6E +* LCD + * Power: M5PM1_G2 高电平使能 + * Resolution: 135x240 + * Driver: CO5300 + * Interface: SPI + * MOSI -- G39 + * SCLK -- G40 + * CS -- G41 + * RS -- G45 + * BL -- G38 +* Audio + * Power: M5PM1_G2 高电平使能 + * ES8311@0x18 + * Control Interface: SYS_I2C + * Data Interface: I2S0 + * MCLK -- G18 + * BCLK -- G17 + * ASDOUT -- G16 + * LRCK -- G15 + * DSDIN -- G14 + * PA -- PM1_G3 +* Key + * KEY1 -- G11 +* IMU + * BMI270@0x68 + * Interface: SYS_I2C +* IR + * TX -- G46 + * RX -- G42 + +## 快速构建 + +推荐使用 release 脚本生成完整固件包： + +```bash +python scripts/release.py m5stack-stick-s3 --name m5stack-stick-s3 +``` + +生成的固件压缩包位于： + +```text +releases/v2.2.6_m5stack-stick-s3.zip +``` + +`config.json` 中的关键构建配置： + +```text +CONFIG_ESPTOOLPY_FLASHSIZE_8MB=y +CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions/v2/8m.csv" +CONFIG_SPIRAM=y +``` + +## 手动配置 + +配置编译目标： + +```bash +idf.py set-target esp32s3 +``` + +打开配置菜单： + +```bash +idf.py menuconfig +``` + +选择板卡： + +```text +Xiaozhi Assistant -> Board Type -> M5Stack StickS3 +``` + +配置 Flash 大小： + +```text +Serial flasher config -> Flash size -> 8 MB +``` + +配置分区表： + +```text +Partition Table -> Custom partition CSV file -> partitions/v2/8m.csv +``` + +配置 PSRAM： + +```text +Component config -> ESP PSRAM -> Support for external, SPI-connected RAM -> Select +``` + +编译： + +```bash +idf.py build +``` + +## 合并固件 + +手动构建后，可使用以下命令合并烧录固件： + +```bash +esptool.py --chip esp32s3 merge_bin \ + --flash_mode dio \ + --flash_freq 80m \ + --flash_size 8MB \ + 0x0 build/bootloader/bootloader.bin \ + 0x8000 build/partition_table/partition-table.bin \ + 0xd000 build/ota_data_initial.bin \ + 0x20000 build/xiaozhi.bin \ + 0x600000 build/generated_assets.bin \ + -o M5Stack-StickS3-XiaoZhi-v2.2.6_0x00.bin +``` + +烧录合并后的固件： + +```bash +esptool.py -b 1500000 write_flash -z 0 M5Stack-StickS3-XiaoZhi-v2.2.6_0x00.bin +``` diff --git a/components/mybot_platform/boards/respeaker-flex-xvf3800-circular4-xiao/README.md b/components/mybot_platform/boards/respeaker-flex-xvf3800-circular4-xiao/README.md new file mode 100644 index 0000000..bd997b4 --- /dev/null +++ b/components/mybot_platform/boards/respeaker-flex-xvf3800-circular4-xiao/README.md @@ -0,0 +1,34 @@ +# ReSpeaker Flex XVF3800 Circular-4 with XIAO ESP32S3 + +本说明根据本工程的 [board.cmake](board.cmake)、[board_config.h](board_config.h) 和 +[sdkconfig.defaults](sdkconfig.defaults) 整理；参考工程没有该板型的独立 README。 +硬件介绍见 [Seeed Studio ReSpeaker Flex 文档](https://wiki.seeedstudio.com/cn/respeaker_flex_introduction/)。 + +## 硬件配置 + +| 项目 | 当前 profile | +| --- | --- | +| MCU | XIAO ESP32S3 | +| Flash | 8 MB，QIO | +| PSRAM | 8 MB，Octal，80 MHz | +| 音频 | XVF3800 麦克风前端与 AIC3104 输出，SDK 使用 16 kHz 单声道 PCM | +| I2S | BCLK GPIO8、WS GPIO7、DOUT GPIO44、DIN GPIO43 | +| I2C | SDA GPIO5、SCL GPIO6，400 kHz；AIC3104 `0x18`、XVF3800 `0x2c` | +| 输入 | XIAO Boot GPIO0 与 XVF3800 板载按键 | +| 显示 | 无屏幕，不编译 LVGL | +| 控制台 | USB Serial/JTAG；GPIO43/44 已用于 I2S | +| 网络 | Wi-Fi | +| 分区 | `partitions/v2/8m.csv` | + +XVF3800 提供硬件 AEC，当前 profile 关闭 Cloud AEC。当前 profile 没有摄像头支持。 + +## 构建 + +在工程根目录激活 ESP-IDF v5.5.2 后执行： + +```sh +python3 scripts/build_all.py --board respeaker-flex-xvf3800-circular4-xiao --language both +``` + +构建与烧录的完整说明见[项目文档](../../../../README.zh-CN.md#构建)。当前板型的 +实机验证状态见[平台移植文档](../../../../docs/BOARD_PORTING.zh-CN.md)。 diff --git a/components/mybot_platform/boards/sensecap-watcher/README.md b/components/mybot_platform/boards/sensecap-watcher/README.md new file mode 100644 index 0000000..aa91010 --- /dev/null +++ b/components/mybot_platform/boards/sensecap-watcher/README.md @@ -0,0 +1,52 @@ +# 编译命令 + +## 一键编译 + +```bash +python scripts/release.py sensecap-watcher +``` + +## 手动配置编译 + +```bash +idf.py set-target esp32s3 +``` + +**配置** + +```bash +idf.py menuconfig +``` + +选择板子 + +``` +Xiaozhi Assistant -> Board Type -> SenseCAP Watcher +``` + +watcher 中一些额外的配置项如下，需要在menuconfig 中选择. + +``` +CONFIG_BOARD_TYPE_SEEED_STUDIO_SENSECAP_WATCHER=y +CONFIG_ESPTOOLPY_FLASHSIZE_32MB=y +CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions/v2/32m.csv" +CONFIG_BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH=y +CONFIG_ESPTOOLPY_FLASH_MODE_AUTO_DETECT=n +CONFIG_IDF_EXPERIMENTAL_FEATURES=y +``` + +## 编译烧入 + +```bash +idf.py -DBOARD_NAME=sensecap-watcher build flash +``` + +注意: 如果当前设备出货之前是SenseCAP 固件(非小智版本),请特别小心处理闪存固件分区地址，以避免错误擦除 SenseCAP Watcher 的自身设备信息（EUI 等），否则设备即使恢复成SenseCAP固件也无法正确连接到 SenseCraft 服务器！所以在刷写固件之前，请务必记录设备的相关必要信息，以确保有恢复的方法！ + +您可以使用以下命令备份生产信息 + +```bash +# firstly backup the factory information partition which contains the credentials for connecting the SenseCraft server +esptool.py --chip esp32s3 --baud 2000000 --before default_reset --after hard_reset --no-stub read_flash 0x9000 204800 nvsfactory.bin + +``` \ No newline at end of file diff --git a/components/mybot_platform/boards/sensecap-watcher/README_en.md b/components/mybot_platform/boards/sensecap-watcher/README_en.md new file mode 100644 index 0000000..27338a8 --- /dev/null +++ b/components/mybot_platform/boards/sensecap-watcher/README_en.md @@ -0,0 +1,53 @@ +# Build Instructions + +## One-click Build + +```bash +python scripts/release.py sensecap-watcher -c config_en.json +``` + +## Manual Configuration and Build + +```bash +idf.py set-target esp32s3 +``` + +**Configuration** + +```bash +idf.py menuconfig +``` + +Select the board: + +``` +Xiaozhi Assistant -> Board Type -> SenseCAP Watcher +``` + +There are some additional configuration options for the watcher. Please select them in menuconfig: + +``` +CONFIG_BOARD_TYPE_SEEED_STUDIO_SENSECAP_WATCHER=y +CONFIG_ESPTOOLPY_FLASHSIZE_32MB=y +CONFIG_PARTITION_TABLE_CUSTOM_FILENAME="partitions/v2/32m.csv" +CONFIG_BOOTLOADER_CACHE_32BIT_ADDR_QUAD_FLASH=y +CONFIG_ESPTOOLPY_FLASH_MODE_AUTO_DETECT=n +CONFIG_IDF_EXPERIMENTAL_FEATURES=y +CONFIG_LANGUAGE_EN_US=y +CONFIG_SR_WN_WN9_JARVIS_TTS=y +``` + +## Build and Flash + +```bash +idf.py -DBOARD_NAME=sensecap-watcher-en build flash +``` + +Note: If your device was previously shipped with the SenseCAP firmware (not the Xiaozhi version), please be very careful with the flash partition addresses to avoid accidentally erasing the device information (such as EUI) of the SenseCAP Watcher. Otherwise, even if you restore the SenseCAP firmware, the device may not be able to connect to the SenseCraft server correctly! Therefore, before flashing the firmware, be sure to record the necessary device information to ensure you have a way to recover it! + +You can use the following command to back up the factory information: + +```bash +# Firstly backup the factory information partition which contains the credentials for connecting the SenseCraft server +esptool.py --chip esp32s3 --baud 2000000 --before default_reset --after hard_reset --no-stub read_flash 0x9000 204800 nvsfactory.bin +``` diff --git a/components/mybot_platform/boards/xingzhi-cube-1.54tft-wifi/README.md b/components/mybot_platform/boards/xingzhi-cube-1.54tft-wifi/README.md new file mode 100644 index 0000000..3817c19 --- /dev/null +++ b/components/mybot_platform/boards/xingzhi-cube-1.54tft-wifi/README.md @@ -0,0 +1,32 @@ +# 行者 Cube 1.54 TFT Wi-Fi + +本说明根据本工程的 [board.cmake](board.cmake)、[board_config.h](board_config.h) 和 +[sdkconfig.defaults](sdkconfig.defaults) 整理；参考工程没有该板型的独立 README。 + +## 硬件配置 + +| 项目 | 当前 profile | +| --- | --- | +| MCU | ESP32-S3 | +| Flash | 16 MB，QIO；实际容量待实机核对 | +| PSRAM | Octal，80 MHz；实际容量待实机核对 | +| 显示 | ST7789，240×240，SPI mode 3；GPIO13 PWM 背光 | +| 音频 | 麦克风与扬声器使用独立 I2S，16 kHz 单声道 | +| 输入 | Boot GPIO0、音量加 GPIO40、音量减 GPIO39 | +| 电源保持 | GPIO21 | +| 网络 | Wi-Fi | +| 分区 | `partitions/v2/16m.csv` | + +麦克风 WS/BCLK/DIN 分别为 GPIO4/5/6，扬声器 DOUT/BCLK/WS 分别为 GPIO7/15/16。 +显示引脚及方向配置见 `board_config.h`。当前 profile 没有摄像头支持。 + +## 构建 + +在工程根目录激活 ESP-IDF v5.5.2 后执行： + +```sh +python3 scripts/build_all.py --board xingzhi-cube-1.54tft-wifi --language both +``` + +构建与烧录的完整说明见[项目文档](../../../../README.zh-CN.md#构建)。当前板型的 +实机验证状态见[平台移植文档](../../../../docs/BOARD_PORTING.zh-CN.md)。 diff --git a/components/mybot_platform/boards/zhengchen-1.54tft-ml307/README.md b/components/mybot_platform/boards/zhengchen-1.54tft-ml307/README.md new file mode 100644 index 0000000..a7f289b --- /dev/null +++ b/components/mybot_platform/boards/zhengchen-1.54tft-ml307/README.md @@ -0,0 +1,45 @@ +# 产品相关介绍网址 + +```http +https://e.tb.cn/h.6Gl2LC7rsrswQZp?tk=qFuaV9hzh0k CZ356 +``` + +# 编译配置命令 + +**配置编译目标为 ESP32S3：** + +```bash +idf.py set-target esp32s3 +``` + +**打开 menuconfig：** + +```bash +idf.py menuconfig +``` + +**选择板子：** + +``` +Xiaozhi Assistant -> Board Type -> zhengchen-1.54tft-ml307 +``` + +``` + +**编译：** + +bash +idf.py build +``` + +**下载：** +idf.py build flash monitor + +进行下载和显示日志 + + +**固件生成：** + +```bash +idf.py merge-bin +``` diff --git a/components/mybot_platform/boards/zhengchen-1.54tft-wifi/README.md b/components/mybot_platform/boards/zhengchen-1.54tft-wifi/README.md new file mode 100644 index 0000000..20bd9a6 --- /dev/null +++ b/components/mybot_platform/boards/zhengchen-1.54tft-wifi/README.md @@ -0,0 +1,45 @@ +# 产品相关介绍网址 + +```http +https://e.tb.cn/h.6Gl2LC7rsrswQZp?tk=qFuaV9hzh0k CZ356 +``` + +# 编译配置命令 + +**配置编译目标为 ESP32S3：** + +```bash +idf.py set-target esp32s3 +``` + +**打开 menuconfig：** + +```bash +idf.py menuconfig +``` + +**选择板子：** + +``` +Xiaozhi Assistant -> Board Type -> zhengchen-1.54tft-wifi +``` + +``` + +**编译：** + +bash +idf.py build +``` + +**下载：** +idf.py build flash monitor + +进行下载和显示日志 + + +**固件生成：** + +```bash +idf.py merge-bin +```