ESP-IDF FastMCP Server

# ESP-IDF自动安装脚本设计文档 ## 概述 ESP-IDF自动安装脚本(`install_esp_idf.py`)旨在简化ESP-IDF开发环境的配置过程。该脚本能够自动检测操作系统类型，并根据不同的系统使用相应的包管理器安装必要的依赖软件包，然后下载并安装指定版本的ESP-IDF。此外，脚本还支持安装QEMU模拟器，以便在没有真实硬件的情况下进行开发和测试。 ## 脚本特性 1. **跨平台支持**：自动检测操作系统，支持Ubuntu/Debian/CentOS/Arch Linux/macOS等主流系统。 2. **灵活的交互方式**：同时支持交互式命令行界面和命令行参数配置。 3. **版本管理**：支持根据远端git tag选择并安装特定版本的ESP-IDF。 4. **远端版本列表**：能够从GitHub获取并显示最新的ESP-IDF版本列表供用户选择，支持分页浏览。 5. **依赖管理**：自动安装ESP-IDF所需的系统级依赖软件包。 6. **QEMU支持**：可选择安装QEMU模拟器及其依赖项，用于在模拟环境中运行和调试ESP-IDF应用程序。 7. **环境配置**：自动设置必要的环境变量和执行安装脚本。 ## 脚本使用说明 ### 基本用法 ```bash # 交互式运行 python install_esp_idf.py # 命令行参数运行 python install_esp_idf.py --version v5.1.2 # 列出可用版本 python install_esp_idf.py --list-versions # 安装ESP-IDF并安装QEMU python install_esp_idf.py --version v5.1.2 --install-qemu ``` ### 命令行参数 - `--version <tag>`: 指定要安装的ESP-IDF版本（git tag） - `--list-versions`: 列出可用的ESP-IDF版本 - `--version-count <number>`: 指定列出的版本数量（默认：10） - `--install-qemu`: 在安装ESP-IDF后安装QEMU模拟器 - `--help`: 显示帮助信息 ## 脚本实现细节 ### 操作系统检测 脚本通过Python的`platform`模块检测当前操作系统类型，并根据检测结果选择相应的包管理器和依赖包列表。 对于Linux系统，还会进一步检测具体的发行版： - Debian/Ubuntu: 检测`/etc/debian_version`文件 - CentOS/RHEL: 检测`/etc/centos-release`文件 - Arch Linux: 检测`/etc/arch-release`文件 ### 依赖安装 根据不同操作系统，脚本会调用相应的包管理器来安装系统依赖： #### Debian/Ubuntu系 使用`apt`包管理器： ```bash sudo apt update sudo apt install -y git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 ``` #### CentOS/RHEL系 使用`yum`包管理器： ```bash sudo yum install -y git wget flex bison gperf python3 python3-setuptools cmake ninja-build ccache dfu-util libusbx ``` #### Arch Linux系 使用`pacman`包管理器： ```bash sudo pacman -Syu --noconfirm gcc git make flex bison gperf python cmake ninja ccache dfu-util libusb python-pip ``` #### macOS (Homebrew) 使用`brew`包管理器（需要用户预先安装Homebrew）： ```bash brew install cmake ninja dfu-util ccache ``` ### ESP-IDF获取 1. 从GitHub获取最新的git tags列表供用户选择或验证用户指定的版本。 2. 在`~/esp/{版本号}`目录下克隆指定版本的ESP-IDF仓库。 3. 设置必要的环境变量（`IDF_GITHUB_ASSETS`, `IDF_TOOLS_PATH`）。 4. 执行ESP-IDF提供的`install.sh`脚本完成工具链和其他依赖的安装。 ### 远端版本列表功能 1. 使用`git ls-remote --tags`命令从ESP-IDF的GitHub仓库获取所有可用的版本标签。 2. 对获取的标签进行解析和排序，显示最新的稳定版本供用户选择。 3. 在交互模式下，将格式化的版本列表呈现给用户进行选择，支持分页浏览。 4. 在命令行参数模式下，验证用户指定的版本是否存在于远端标签列表中。 ### QEMU 安装功能 1. 在安装完ESP-IDF后，可选择安装QEMU模拟器。 2. 自动检测操作系统并安装QEMU所需的系统依赖包： - Ubuntu/Debian: `libgcrypt20 libglib2.0-0 libpixman-1-0 libsdl2-2.0-0 libslirp0` - CentOS/RHEL: `libgcrypt glib2 pixman SDL2 libslirp` - Arch Linux: `libgcrypt glib2 pixman sdl2 libslirp` - macOS: `libgcrypt glib pixman sdl2 libslirp` 3. 使用ESP-IDF的`idf_tools.py`脚本安装预构建的QEMU二进制文件： - `qemu-xtensa`: 用于ESP32/ESP32-S系列 - `qemu-riscv32`: 用于ESP32-C系列 ### 交互式界面 交互式界面提供以下功能： 1. 自动检测操作系统类型 2. 询问用户是否需要安装系统依赖包 3. 分页显示远端版本列表供用户选择 4. 确认用户的安装选择 分页浏览功能： - 每页显示10个版本 - 用户可以输入数字选择版本或跳转到指定页面 - 支持[N]ext和[P]revious命令进行翻页 ## 配置选项说明 ### 环境变量 - `IDF_GITHUB_ASSETS`: 用于指定ESP-IDF工具下载的镜像地址，解决国内网络访问问题。 - `IDF_TOOLS_PATH`: 指定ESP-IDF工具链的安装路径。 ### 安装路径 ESP-IDF将被安装在`~/esp/{版本号}`目录下，其中`{版本号}`为用户选择的ESP-IDF版本标签。 具体路径结构： ``` ~/esp/ └── {版本号}/ ├── esp-idf/ # ESP-IDF源码 └── espressif/ # 工具链和工具 ``` ### 自定义配置 用户可以通过修改脚本中的常量来自定义安装行为，如： - `DEFAULT_VERSION`: 默认安装的ESP-IDF版本 - `ESP_IDF_REPO`: ESP-IDF仓库地址 - `DEFAULT_VERSION_COUNT`: 默认显示的版本数量 ## 系统依赖包 ### Debian/Ubuntu系 ``` git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0 ``` QEMU额外依赖： ``` libgcrypt20 libglib2.0-0 libpixman-1-0 libsdl2-2.0-0 libslirp0 ``` ### CentOS/RHEL系 ``` git wget flex bison gperf python3 python3-setuptools cmake ninja-build ccache dfu-util libusbx ``` QEMU额外依赖： ``` libgcrypt glib2 pixman SDL2 libslirp ``` ### Arch Linux系 ``` gcc git make flex bison gperf python cmake ninja ccache dfu-util libusb python-pip ``` QEMU额外依赖： ``` libgcrypt glib2 pixman sdl2 libslirp ``` ### macOS (Homebrew) ``` cmake ninja dfu-util ccache ``` QEMU额外依赖： ``` libgcrypt glib pixman sdl2 libslirp ``` ## ESP-IDF安装详情 ### Git仓库 ``` https://github.com/espressif/esp-idf.git ``` ### 克隆路径 ``` ~/esp/{版本号}/esp-idf ``` ### 安装方式 在仓库路径下执行以下命令： ```bash export IDF_GITHUB_ASSETS="dl.espressif.com/github_assets" export IDF_TOOLS_PATH="$HOME/esp/{版本号}/espressif" ./install.sh ```