Embedded IDE 技术文档

Embedded IDE 技术文档

eide An embedded development environment for mcs51/stm8/avr/cortex-m/riscv on VsCode. 项目地址: https://gitcode.com/gh_mirrors/ei/eide

---

安装指南

前提条件

确保您的系统为 Windows x64（≥Windows 10）、Linux x64 或 macOS（仅在'macOS 10.15 x64'上测试过）。

1. 安装Visual Studio Code: 首先，访问Visual Studio Code官网下载并安装适用于您操作系统的版本。

2. 安装Embedded IDE插件: 打开VSCode，进入扩展市场搜索Embedded IDE，由作者CL.eide提供的插件，点击安装。

3. 配置环境:

   • 对于不同MCU架构的开发，确保已安装对应的编译器（如armcc、gcc-arm-none-eabi、riscv-gcc等）。
   • 在插件的“Operations”栏中设置编译器的安装路径。

---

项目的使用说明

创建项目

1. 快速启动：从插件的“Operations”栏选择“New”，依据提示创建基于内部模板的新项目。
2. 导入项目：对于KEIL5、IAR或Eclipse项目，可使用“Import”功能导入现有项目的源码结构。

编译与构建

• 在项目视图中选择需要编译的项目，通过插件提供的命令进行Build或Rebuild。

程序烧录

• 连接开发板后，利用插件支持的JLink、STLink、OpenOCD等工具进行Flash操作。

调试与分析

• 插件自动配置与调试器插件（如cortex-debug）兼容的默认调试配置。
• 利用集成的工具查看项目资源、代码反汇编等。

---

项目API使用文档

本部分主要指插件提供给用户的交互接口而非传统意义上的API。具体功能操作通过VSCode的命令面板或插件提供的UI界面完成。例如，通过“Extensions: Operations”菜单进行：

• 芯片支持包安装（仅限Cortex-M项目）
• 项目模板选择
• 编译链配置
• 程序上传设置

对于高级定制需求，可以参考插件的源码和配置文件，但官方未直接提供详细的API文档用于二次开发。

---

项目安装方式

自行构建插件

如果您想贡献代码或自定义编译，按照以下步骤：

1. 安装Node.js 16: 确保系统中已安装指定版本的Node.js。
2. 克隆仓库：从GitHub克隆项目到本地。
3. 安装依赖：在项目根目录打开终端，运行npm install。
4. 构建插件:
   • 使用npm: webpack命令来构建插件，完成后可通过F5进行调试。
   • 若要生成可用于安装的.vsix文件，执行“build vsix”。

通过这种方式，您可以获取最新特性或者对插件进行定制修改。

---

本技术文档提供了详尽的指引，以帮助您高效地运用Embedded IDE在VSCode中进行嵌入式项目开发。无论是初学者还是经验丰富的开发者，都能快速上手，并充分利用该插件的强大功能。

eide An embedded development environment for mcs51/stm8/avr/cortex-m/riscv on VsCode. 项目地址: https://gitcode.com/gh_mirrors/ei/eide