## 项目部署说明

#### 此文件用于说明如何部署本项目

#### 部署步骤

- 安装对应平台的esp idf环境
- 简单修改一个或者多个项目的配置文件以适配自己的平台

#### 演示平台
- CPU: AMD R5 3600
- 系统: Kubuntu 24.04
- 终端: zsh 5.9 (x86_64-ubuntu-linux-gnu)
- IDE: Clion2025.2
- IDF: v5.3.2
#### 主要参考教程
- [esp-idf官方教程](https://docs.espressif.com/projects/esp-idf/zh_CN/release-v5.3/esp32s3/get-started/linux-macos-setup.html)


#### 部署步骤
前置: 安装Clion 2025.2, 此IDE非商业免费

参考官方教程中给出的步骤(主要是从源码编译idf)，因此对于不同的平台，有不同的安装方式
对于windows来说，只需要下载对应版本`v5.3.2`的已经编译好的idf可执行文件即可，可以参考我bilibili录制的教程
[【Misaki】ESP-32 IDF Clion开发环境搭建](https://www.bilibili.com/video/BV1Q7epebEbb)

而开发环境使用的系统为Kubuntu 24.04，为Linux环境，在此给出Linux环境下的项目部署步骤
1. 编译 ESP-IDF 需要以下软件包。请根据使用的 Linux 发行版本，下面给出的是Ubuntu 和 Debian的安装命令。
    ```bash
   sudo apt-get install git wget flex bison gperf python3 python3-pip python3-venv cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
   ```
   
2. 获取 ESP-IDF，获取 ESP-IDF 的本地副本，在终端中执行下面的命令，注意选择合适的安装目录
    ```bash
    mkdir -p ~/esp
    cd ~/esp
    git clone -b tag/v5.3.2 --recursive https://github.com/espressif/esp-idf.git
    ```
   
3. 为idf的环境创建一个快速启动，因为idf框架下包含了非常多的组件，需要添加一些环境变量，为了不污染系统环境变量，我们可以执行以下操作

    1. 复制并粘贴以下命令到 shell 配置文件中（.profile、.bashrc、.zprofile 等），我使用的是zsh, 因此将此命令复制到.zshrc文件中
    
    ```bash
   # 注意这里的esp-idf的路径，请根据你的安装路径进行修改
   alias get_idf='. $HOME/esp/esp-idf/export.sh'
   ```
    
    ``
    这样当你打开一个新窗口就可以使用get_idf命令来快速启动idf环境了
    ``

4. 设置工具
    1. 除了 ESP-IDF 本身，还需要为支持 ESP32-S3 的项目安装 ESP-IDF 使用的各种工具，比如编译器、调试器、Python 包等。
    ```bash
   cd ~/esp/esp-idf
   ./install.sh all
   ```

   2. 注意，如果你处在国内网络，那么可以先执行以下命令，再执行上面的步骤，以加速下载
      ```bash
       export IDF_GITHUB_ASSETS="dl.espressif.cn/github_assets"
       ```


5. 创建并编译一个项目以完整下载idf框架下的所有组件

    1. 首先基于上一步的操作，打开一个新终端，输入get_idf以启动idf环境，接着输入下面的命令
    ```bash
   idf.py create-project Demo # 创建一个名为Demo的项目
   cd Demo

   idf.py build # 编译项目，此时会自动去下载idf框架下的所有组件(如果是第一次使用)
   ```
    2. 注意，如果你处在国内网络，而且你的github无法clone仓库，那么可以先添加以下命添加代理(需要你拥有一个代理服务器，如Clash)
   ```bash
    git config --global http.proxy http://127.0.0.1:7890  # 设置代理，7890为代理端口，替换为你的代理服务器的端口
    git config --global https.proxy http://127.0.0.1:7890
   
   # 如果需要取消代理，请执行以下命令
    git config --global --unset http.proxy
    git config --global --unset https.proxy
    ```
   3. 到此所有需要下载的组件已经下载完毕，可以开始开发或者编译项目了

6. 针对Clion的一些配置
   1. 将本项目使用Clion打开，接着在设置 -> 编译、执行、部署 -> 工具链 中新增一个工具链esp32
   2. 点击添加环境，环境文件中放export.sh文件的路径， 例如：`/home/misaki/Apps/esp/esp-idf/export.sh`
   3. 接着在设置 -> 编译、执行、部署 -> CMake 中切换工具链为esp32，最后点击确定，此时项目会自动加载，CMake加载无报错即成功
   4. 连接板子，选择flash_monitor_gui这个CMake应用，点击编译按钮即可一件启动编译、烧录、监视操作