# ESP32-Project-Template

**Repository Path**: qiaozyqzy/esp32-project-template

## Basic Information

- **Project Name**: ESP32-Project-Template
- **Description**: No description available
- **Primary Language**: C
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-11
- **Last Updated**: 2022-02-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ESP32-Project-v4

## 介绍
这是一个使用esp-idf v4开发的工程，包含自编的一些组件。

## 安装教程

### 1. 安装esp-idf

参看[ESP32 开发环境搭建]()（待写）

### 2. 修改VSCode C项目属性文件

转到`.vscode\c_cpp_properties.json`文件，修改以下项目中的路径为你的实际路径。

```json
"includePath": [
    "${workspaceFolder}/**",
    "${workspaceFolder}/main",
    "D:/XXX/esp-idf/components/driver/include"
],
"browse": {
    "limitSymbolsToIncludedHeaders": true,
    "databaseFilename": "",
    "path": [
        "${workspaceRoot}",
        "D:/XXX/esp-idf/components",
        "D:/XXX/.espressif/Tools"
    ]
}
```
### 3. 修改快捷命令脚本 

修改`script\idf\idf.ps1`文件中的export脚本路径和与设备通信使用的串口号。

```powershell
$exportPath = "D:\XXX\esp-idf\export.ps1" # export.ps1脚本的全路径 
$portName = "COM9"                        # 设备串口号 
```

## 使用说明

### 1. 项目结构

```sh
├───components 		# ├─存放项目内的自编组件
├───document		# ├─存放一些说明、备忘类文档
├───main			# ├─用户代码文件夹，在此文件夹下的代码不需要在makefile文件中对头文件、包含组件等进行指明
└───script			# ├─脚本文件存放位置
    └───idf			#   └─存放用于快捷操作idf的脚本
```

### 2. 快捷操作IDF

默认脚本环境为 **Windows Terminal** 中的 **PowerShell**，需要安装 **Windows Terminal** 并将VSCode中的默认终端设置为 **PowerShell**。

在VSCode中依次按下`alt + t`、`alt + r` 键，在弹出的运行任务选择窗口中输入任务对应的数字编号，按下确定键开始执行该任务。

当需要执行 *3. 配置*  任务时，在VSCode内置终端中执行时会出现无法使用方向键的问题，因此，在执行该任务后，会打开 **Windows Terminal**，并跳转到项目目录，之后脚本会将后续命令添加到剪切板，当终端启动后，按下 `ctrl + V` 粘贴到终端内执行即可。

## 参与贡献

1.  Fork 本仓库
2.  新建 Feat_XXX 分支
3.  提交代码
4.  新建 Pull Request