# 说明文档

- [说明文档](#说明文档)
	- [一.目录说明](#一目录说明)
	- [二.依赖库版本](#二依赖库版本)
	- [三.编译说明](#三编译说明)
		- [3.1.参考下面文档配置编译环境](#31参考下面文档配置编译环境)
		- [3.2用vscode打开工程](#32用vscode打开工程)
		- [3.3打开终端](#33打开终端)
		- [3.4输入指令导出环境变量](#34输入指令导出环境变量)
		- [3.5输入指令编译](#35输入指令编译)
	- [四.版本说明](#四版本说明)
	- [五.需求说明](#五需求说明)

## 一.目录说明

```bash
 main/                 应用代码  
 envsetup.ps1		  配置环境变量
```

## 二.依赖库版本

```bash
# espressif-ide-2.5.0-with-esp-idf-4.4.exe
ftp://zftpuser:zftpzwsd@192.168.1.2/zwsd/manufacturer_espressif/sdk_release/espressif-ide-setup-espressif-ide-2.5.0-with-esp-idf-4.4.exe
```

## 三.编译说明

### 3.1.参考下面文档配置编译环境

[manufacturer_espressif/doc - windows开发环境搭建.md](http://192.168.1.3:3000/manufacturer_espressif/doc/src/branch/master/windows开发环境搭建.md)

### 3.2用vscode打开工程

### 3.3打开终端

注意打开的终端需要是powershell

![image-20220720111842228](markdown.assets/README.assets/image-20220720111842228.png)

### 3.4输入指令导出环境变量

![image-20220720121034807](markdown.assets/README.assets/image-20220720121034807.png)

```
Tip:
	1.此过程中还会自动创建一个软连接到 C:\Espressif\frameworks\esp-idf-v4.4 目录，方便搜索代码。
	2.powershell默认不支持执行自定义脚本，执行下面指令释放权限
		set-ExecutionPolicy RemoteSigned
```

### 3.5输入指令编译

```bash
idf.py.exe build			        #编译
idf.py.exe -p COM79  flash monitor   #编译并下载同时监控日志
idf.py.exe -p COM79  monitor		#监控日志
```

```
Tip:
	1.通过win+R后输入devmgmt.msc打开设备管理器确定串口端口
	
	2.通过在终端输入 [System.IO.Ports.SerialPort]::getportnames() 打印所有可用端口
	
	3.终端输入 .\lscom.ps1 打印所有可用端口
```

## 四.版本说明

```
```

## 五.需求说明

```

```