VS Code 使用指南

概述

Ameba 扩展插件是基于 Cline 开发的 VS Code 扩展插件，保留了原生 Cline 的所有功能，并针对 Realtek Ameba 系列芯片增加了开发环境检查和自动安装，SDK 配置、代码编译、固件烧录、串口监控等专用功能。这些功能通过直观的按钮界面提供，简化了 Ameba 系列芯片的开发流程。

Cline 相关资料

使用流程

  1. 插件的安装

    • 在 VS Code 的扩展应用商店中搜索 Ameba，点击安装即可

  2. 仅使用 Ameba 功能

    • 首次使用的欢迎页面中可以登录 cline 账号或者使用自定义的 API Key

    • 当您没有 Cline 账户或 API key 时，可以点击 USE Ameba Only 按钮仅使用 Ameba 相关功能

../../_images/vsix_welcome.gif

  1. Ameba 相关功能区

    • 下图中的红框展示了 Ameba 相关的功能区域

../../_images/vsix_ameba_area.png

  1. 开发环境检查和自动安装

    • 插件会自动检查如下配置:

      • 打开的文件夹和子文件夹内是否包含 Ameba SDK, SDK 的下载请参考 FreeRTOS SDK 下载 。

      • 开发环境的软件合集包是否已正确安装，如果没有安装，将会在右下角提供 Install from GitHub 和 Install from Aliyun 两种安装选项（中国大陆地区用户建议使用 Aliyun），点击即可自动下载安装。

      • SDK 的 python 虚拟环境是否正确创建，如果没有，将会在右下角提示自动创建。

    • 通过上述所有检查后，插件才会激活 Ameba 相关功能按钮

../../_images/vsix_check.gif

  1. 芯片选择

    • 通过下拉选择框选择要开发的 Ameba 系列芯片型号

../../_images/vsix_ic_select.gif

  1. 串口选择

    • 自动扫描并更新系统中所有可用串口，通过下拉选择框选择开发板对应的串口名

../../_images/vsix_port_select.gif

  1. 示例选择

    • 通过下拉选择框选择对应的应用示例

    • 选择示例后将打开对应示例的 README.md 的预览

    • 默认情况下或者选择示例中的 None 将会编译基础项目配置

../../_images/vsix_example_select.gif

主要功能

SDK 配置

  1. 点击 Ameba Menuconfig 按钮打开图形化 SDK 配置界面

  2. SDK 配置相关信息请参考 配置 SDK（menuconfig）

../../_images/vsix_config.gif

项目编译

  1. 点击 Ameba Build 按钮进行编译工程

  2. 编译过程中将实时显示详细进度和日志信息

../../_images/vsix_build.gif

固件烧录

  1. 点击 Ameba Flash 按钮启动固件烧录流程

  2. 烧录时会自动根据 SDK 配置以及 Flash 布局信息 选择对应的固件和烧录地址进行烧录

  3. 提供烧录进度实时反馈和详细日志

../../_images/vsix_flash.gif

串口监控

  1. 点击 Ameba Monitor 按钮打开集成的串口监视器，自动选择波特率并连接串口

  2. 实时显示和接收串口数据

../../_images/vsix_monitor.gif

在线文档

  1. 点击 Ameba Doc 按钮将打开默认浏览器跳转到 Realtek Ameba 的官方在线网页

../../_images/vsix_doc.gif

高级功能

  1. 远程串口烧录和监控

    • 如果您本机电脑是 Windows 系统，开发板也连接到本机电脑，但是选择将 SDK 下载到 linux 服务器，通过 VS Code 的 Remote-SSH 的扩展进行 SDK 的开发，那么可以使用如下步骤进行

      • 在本机电脑 下载 AmebaSerialServer 软件并启动，启动后默认不配置密码，有安全需要可以右击软件图标配置密码

      • 在 VS Code 中按下键盘 F1 按键，输入 ameba: Remote Servers ，点击对应的选项

      • 点击 Add New Remote Server 选项

        • Server 名称：输入想要自定义的服务器名称

        • Server 地址：输入 windows 本机电脑的 IP 地址

        • Server 密码：如果 windows 的服务器软件有配置密码，需要输入对应的密码，如服务器未设置，则直接回车跳过

      • 配置成功后，如果 VS Code 通过 Remote-SSH 连接打开了 Ameba SDK，串口列表会更新出远程串口信息，选择后可以进行远程串口的烧录和监控

      • 再次在 VS Code 中按下键盘 F1 按键，输入 ameba: Remote Servers ，点击对应的选项可以查看已有 Server 信息，点击对应已有 Server 可以将其删除

../../_images/vsix_remote_server.gif