diff --git a/development-tools/rtthread-studio/um/figures/BSP_Features.png b/development-tools/rtthread-studio/um/figures/BSP_Features.png new file mode 100644 index 0000000000000000000000000000000000000000..7c31d97786f4c18c30a145d3b4d9f90c1745e921 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/BSP_Features.png differ diff --git a/development-tools/rtthread-studio/um/figures/BSP_Info.png b/development-tools/rtthread-studio/um/figures/BSP_Info.png new file mode 100644 index 0000000000000000000000000000000000000000..5308c5920a7d0cf058f285c411ca67ecf34dc76d Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/BSP_Info.png differ diff --git a/development-tools/rtthread-studio/um/figures/BSP_Info2.png b/development-tools/rtthread-studio/um/figures/BSP_Info2.png new file mode 100644 index 0000000000000000000000000000000000000000..e9eb8b696530a0836cfbb9e68c79cb5d6054300a Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/BSP_Info2.png differ diff --git a/development-tools/rtthread-studio/um/figures/Create_BSP.png b/development-tools/rtthread-studio/um/figures/Create_BSP.png new file mode 100644 index 0000000000000000000000000000000000000000..a0eeed215733e896939d6a3fda04d43591cfc8fd Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/Create_BSP.png differ diff --git a/development-tools/rtthread-studio/um/figures/Project_Info.png b/development-tools/rtthread-studio/um/figures/Project_Info.png new file mode 100644 index 0000000000000000000000000000000000000000..d0a4e261f29d62c235605ac33b735c6df2f88547 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/Project_Info.png differ diff --git a/development-tools/rtthread-studio/um/figures/Project_Info2.png b/development-tools/rtthread-studio/um/figures/Project_Info2.png new file mode 100644 index 0000000000000000000000000000000000000000..1bcb72acbb6c6d087a5683b7a940100123254caf Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/Project_Info2.png differ diff --git a/development-tools/rtthread-studio/um/figures/cubemx_0.png b/development-tools/rtthread-studio/um/figures/cubemx_0.png new file mode 100644 index 0000000000000000000000000000000000000000..5237e2369b9d84d0fab1666591918fb07795657e Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/cubemx_0.png differ diff --git a/development-tools/rtthread-studio/um/figures/cubemx_1.png b/development-tools/rtthread-studio/um/figures/cubemx_1.png new file mode 100644 index 0000000000000000000000000000000000000000..8b6e4ae7c96d69422c26f30e8b5ae5260c6a0f4b Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/cubemx_1.png differ diff --git a/development-tools/rtthread-studio/um/figures/cubemx_2.png b/development-tools/rtthread-studio/um/figures/cubemx_2.png new file mode 100644 index 0000000000000000000000000000000000000000..31a72c16294af516c79761c297626b3604137185 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/cubemx_2.png differ diff --git a/development-tools/rtthread-studio/um/figures/cubemx_3.png b/development-tools/rtthread-studio/um/figures/cubemx_3.png new file mode 100644 index 0000000000000000000000000000000000000000..518f917c824f6d70d3070add9b2ee5ec4d7fda2e Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/cubemx_3.png differ diff --git a/development-tools/rtthread-studio/um/figures/iar2.png b/development-tools/rtthread-studio/um/figures/iar2.png new file mode 100644 index 0000000000000000000000000000000000000000..7066956e8fc6067b8d47b9ec8679f4f009c3006e Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/iar2.png differ diff --git a/development-tools/rtthread-studio/um/figures/iar_1.png b/development-tools/rtthread-studio/um/figures/iar_1.png new file mode 100644 index 0000000000000000000000000000000000000000..bc79150934d3e98454a62e020b9dcc7d81a8f4a4 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/iar_1.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk4.png b/development-tools/rtthread-studio/um/figures/mdk4.png new file mode 100644 index 0000000000000000000000000000000000000000..ff32825f5c0b39a1e0e6c18024397cd7c3e3d67d Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk4.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_0.png b/development-tools/rtthread-studio/um/figures/mdk_0.png new file mode 100644 index 0000000000000000000000000000000000000000..193247d1cdeba78ec10b777fe0c2039467cfbf57 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_0.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_1.png b/development-tools/rtthread-studio/um/figures/mdk_1.png new file mode 100644 index 0000000000000000000000000000000000000000..0e20e5eebd2deae9d0ce9d8a08ea81add09d1871 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_1.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_10.png b/development-tools/rtthread-studio/um/figures/mdk_10.png new file mode 100644 index 0000000000000000000000000000000000000000..d5026be8ef0eb04f6b5b47e7dbb6ceac863ca56b Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_10.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_2.png b/development-tools/rtthread-studio/um/figures/mdk_2.png new file mode 100644 index 0000000000000000000000000000000000000000..878bfd98695d2e7c7d7a11fa9859d18ee69b5040 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_2.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_3.png b/development-tools/rtthread-studio/um/figures/mdk_3.png new file mode 100644 index 0000000000000000000000000000000000000000..68773d1238ea66cf7a9b8d01db82daf6c25ad492 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_3.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_5.png b/development-tools/rtthread-studio/um/figures/mdk_5.png new file mode 100644 index 0000000000000000000000000000000000000000..7765d6c108687b767e0c808a2112d2b0ad032609 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_5.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_6.png b/development-tools/rtthread-studio/um/figures/mdk_6.png new file mode 100644 index 0000000000000000000000000000000000000000..b6a5150cb9132f1a36327b963d7e1723ec89f256 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_6.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_7.png b/development-tools/rtthread-studio/um/figures/mdk_7.png new file mode 100644 index 0000000000000000000000000000000000000000..4fbc646a11066cb4c2329091772042e37e427022 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_7.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_8.png b/development-tools/rtthread-studio/um/figures/mdk_8.png new file mode 100644 index 0000000000000000000000000000000000000000..d2c36086ca2641e6dd48f68fad9a02b86fa72ff9 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_8.png differ diff --git a/development-tools/rtthread-studio/um/figures/mdk_9.png b/development-tools/rtthread-studio/um/figures/mdk_9.png new file mode 100644 index 0000000000000000000000000000000000000000..258a69f11746caf6c3323d627f8122c516a2d68a Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/mdk_9.png differ diff --git a/development-tools/rtthread-studio/um/figures/release.png b/development-tools/rtthread-studio/um/figures/release.png new file mode 100644 index 0000000000000000000000000000000000000000..e1254164a6ceb2984f10ae2f5d2dcdaa754cce82 Binary files /dev/null and b/development-tools/rtthread-studio/um/figures/release.png differ diff --git a/development-tools/rtthread-studio/um/studio-user-manual.md b/development-tools/rtthread-studio/um/studio-user-manual.md index 09dce1f75cad118b75ba57bc44ab7d124d6e0376..892d096d08e2e9f5ad23a7e76847816bf7f52a1c 100644 --- a/development-tools/rtthread-studio/um/studio-user-manual.md +++ b/development-tools/rtthread-studio/um/studio-user-manual.md @@ -657,6 +657,110 @@ RT-Thread Studio 自 V2.0.0 版本开始支持 PlatformIO 工程的创建、编 ![updatesdk](figures/updatesdk.png) +## 开发板资源包制作 + +本文主要介绍如何从一个BSP转化为Studio工程，然后再以Studio工程为基础，借助开发板资源包制作工具制作一个开发板资源包。最后可以将开发板资源包贡献到SDK上。（BSP的获取可以从 [新手推荐开发板列表及其BSP](https://www.rt-thread.org/document/site/tutorial/quick-start/more/#stm32-bsp)这篇文章中获取，或者按照教程制作自己的BSP，这里不再赘述） + +### 1.Studio工程制作 + +**前提条件**：在 RT-Thread 主线分支 2021-01-18 之后的版本中，添加了对 --dist-ide 的增强支持，能够通过 scons --dist-ide 将一个bsp 转换为studio 工程，使用方法如下 + ++ git pull 同步最新的 rt-thread 代码 ++ 进入到bsp文件夹的目录中，打开 env工具输入` scons --dist-ide --project-path=dist_studio（存储的文件夹名字） --project-name=project_name_xxx（生成的工程名）`即可生成studio工程。 + +### 2.开发板资源包制作 + +这里需要借助开发板资源包制作工具来制作。下面介绍开发板资源制作工具的使用方法。 + +#### 准备工作 + +1. RT-Thread Studio V2.1.0及以上版本 +2. Studio工程 +3. 开发板的基本信息，如开发板名称、厂商、调试器、调试接口等 +4. 开发板所用芯片的基本信息，如芯片厂商，芯片名等 +5. 开发板的大、小图片各一张，小图片尺寸为200x300 +6. 开发板的文档 + +#### 使用方法 + +打开Studio,点击工具栏`新建`按钮旁的下拉三角，选择`开发板支持包` + +![](figures/Create_BSP.png) + +下图即为开发板制作包工具，共有五栏信息需要填写，左上角打*号的表示该项为必填项。 + +![](figures/BSP_Info.png) + +下面对一些所填项进行解释说明，方便大家填写。 + +![](figures/BSP_Info2.png) + +![](figures/BSP_Features.png) + +![](figures/Project_Info.png) + +到此所有信息都填写完成了，可以点击右上角`预览`按钮，检查开发板信息是否填写无误。检查没有问题后可点击`生成`按钮即可生成开发板资源包 + +![](figures/Project_Info2.png) + +### 3.部署开发板支持包到Studio SDK Manager + +1. 在github.com 新建一个仓库，存储制作好的开发板支持包，需要满足以下格式 + + + 仓库名字以 “sdk-bsp-” 为首，例如 sdk-bsp-stm32h750-realthread-artpi + + 开发板支持包描述文件 (yaml) 需要位于仓库的根目录下 + + 参考仓库：https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi + +2. 将开发板支持包 push 到建好的 github 仓库中，并发布一个 release，需满足以下条件 + + + release 版本号 tag version 与 yaml 里的 pkg version 保持一致，格式需为三位数字 [0-9].[0-9].[0-9] ，例如 1.0.0 + + 记录 Source code 的下载链接，在后续步骤使用 + + ![](figures/release.png) + +3. Fork 一份RT-Thread Studio 的 SDK 索引仓库 https://github.com/RT-Thread-Studio/sdk-index 到个人 github 账号下 + +4. 在本地sdk-index 仓库的 sdk-index/Board_Support_Packages 下添加一个新的开发板信息 + + + 检查 Board_Support_Packages 是否有新添加的开发板支持包的芯片文件夹，如果没有则参考目前已有的芯片添加一个新的芯片厂商文件夹 + + 在芯片厂商文件夹中，检查是否有需要添加的开发板，如果没有则参考其他开发板添加一个 + + 在开发板的文件夹中，添加新的开发板支持包release 信息，url 为 release 时的Source code的下载链接 + + ```json + { + "name": "STM32H750-RT-ART-Pi", + "vendor": "RealThread", + "description": "STM32H750-RT-ART-Pi Board Support Packages", + "license": "", + "repository": "https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi.git", + "releases": [ + { + "version": "1.1.0", + "date": "2020-12-01", + "description": "released v1.1.0", + "size": "152 MB", + "url": "https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi/archive/1.1.0.zip" + }, + { + "version": "1.0.1", + "date": "2020-10-23", + "description": "released v1.0.1", + "size": "136 MB", + "url": "https://github.com/RT-Thread-Studio/sdk-bsp-stm32h750-realthread-artpi/archive/1.0.1.zip" + } + ] + } + ``` + + + 注意事项： + + 索引仓库中不要出现非ascii 字符 + + 开发板支持包名称 name字段 保持大写字母和中划线组合 + +5. 将改好的 sdk-index 仓库 push 到 github，并向官方 sdk-index 提出 PR + +6. PR 合并后，开发板支持包将会更新在Studio 的SDK Manager 界面里 + ## MarkDown 编辑 RT-Thread Studio 自带 MarkDown 编辑器，若工程里有 md 文件，只需要双击即可打开 md 文件进行编辑，如下图所示：