diff --git a/README.md b/README.md index b2e2bc3..41c274e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,22 @@ # 说明文档 +- [说明文档](#说明文档) + - [一.目录说明](#一目录说明) + - [二.依赖库版本](#二依赖库版本) + - [三.编译说明](#三编译说明) + - [3.1.参考下面文档配置编译环境](#31参考下面文档配置编译环境) + - [3.2用vscode打开工程](#32用vscode打开工程) + - [3.3打开终端](#33打开终端) + - [3.4输入指令导出环境变量](#34输入指令导出环境变量) + - [3.5输入指令编译](#35输入指令编译) + - [四.版本说明](#四版本说明) + - [五.需求说明](#五需求说明) + ## 一.目录说明 ```bash - main/ 应用代码 + main/ 应用代码 + envsetup.ps1 配置环境变量 ``` ## 二.依赖库版本 @@ -23,19 +36,45 @@ ftp://zftpuser:zftpzwsd@192.168.1.2/zwsd/manufacturer_espressif/sdk_release/espr ### 3.3打开终端 -### 3.4输入指令编译 +注意打开的终端需要是powershell + +![image-20220720111842228](markdown.assets/README.assets/image-20220720111842228.png) + +### 3.4输入指令导出环境变量 + +![image-20220720112005246](markdown.assets/README.assets/image-20220720112005246.png) ``` +Tip: + 此过程中还会自动创建一个软连接到 C:\Espressif\frameworks\esp-idf-v4.4 目录,方便搜索代码。 ``` +### 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 打印所有可用端口 +``` +## 四.版本说明 +``` +``` +## 五.需求说明 ``` -Set-ExecutionPolicy Unrestricted + ``` diff --git a/setup.ps1 b/envsetupsetup.ps1 similarity index 100% rename from setup.ps1 rename to envsetupsetup.ps1 diff --git a/link-esp-idf-v4.4.ps1 b/link-esp-idf-v4.4.ps1 deleted file mode 100644 index 372b84f..0000000 --- a/link-esp-idf-v4.4.ps1 +++ /dev/null @@ -1,5 +0,0 @@ -if(-NOT(Test-Path ".\esp-idf-v4.4")) -{ - $command ="cmd /c mklink /J esp-idf-v4.4 C:\Espressif\frameworks\esp-idf-v4.4" - invoke-expression "$command" -} diff --git a/lscom.ps1 b/lscom.ps1 new file mode 100644 index 0000000..9fa4122 --- /dev/null +++ b/lscom.ps1 @@ -0,0 +1 @@ +[System.IO.Ports.SerialPort]::getportnames() \ No newline at end of file diff --git a/markdown.assets/README.assets/image-20220720111842228.png b/markdown.assets/README.assets/image-20220720111842228.png new file mode 100644 index 0000000..1ec3a79 Binary files /dev/null and b/markdown.assets/README.assets/image-20220720111842228.png differ diff --git a/markdown.assets/README.assets/image-20220720112005246.png b/markdown.assets/README.assets/image-20220720112005246.png new file mode 100644 index 0000000..6db02c1 Binary files /dev/null and b/markdown.assets/README.assets/image-20220720112005246.png differ