RT-Thread Studio 用户手册

界面介绍

界面简介

RT-Thread Studio 基于 eclipse 平台开发,界面设计和风格继承自 eclipse,RT-Thread Studio 启动后主界面结构如下图所示:

studio-frame

透视图简介

透视图定义了当前界面呈现的菜单栏,工具栏,以及功能窗口集合及其布局。不同透视图提供了完成特定类型任务的功能集合。例如 C 透视图组合了项目开发,源文件编辑,项目构建等常用的开发功能窗口,菜单和功能按钮,调试透视图包含了调试项目程序常用的调试功能窗口,菜单和功能按钮。

RT-Thread Studio 已实现启动调试时自动切换到调试透视图,停止调试时自动恢复到 C 透视图,用户平时也可以根据需要从透视图切换栏手动进行透视图切换,切换到其它透视图进行相关工作。

功能窗口特性

可移动

RT-Thread Studio 在初次打开的时候功能窗口位置呈现的是默认布局,但所有功能窗口位置都不是固定的,可以在窗口标题处按住鼠标左键,随意拖动窗口的位置,如下图所示左键按住属性窗口,拖动到项目资源管理器窗口下方,会出现一个灰色方框指示属性窗口将要被放置的位置,此时松开鼠标按键即可将属性窗口放置在该位置:

shuxing

当窗口拖乱了,或者整体布局不满意想恢复回默认布局的样子时,可以通过复位透视图菜单功能恢复默认窗口布局,如下图所示:

reset-see

可关闭

每个功能窗口标题旁边都有一个X可以通过点击该处,关闭功能窗口,如下图所示:

can-close

若想再次打开已关闭的功能窗口,可通过菜单栏的窗口菜单的子菜单显示视图菜单中再次打开对应功能窗口,如果当前菜单中没显示想要打开的功能窗口,可以点击从其他菜单中查找。

open-set

最大化

每个功能窗口都有自己单独的工具栏,工具栏最右边是最小化和最大化功能按钮,如下图所示:

max-size

在功能窗口的标题上双击或者点击功能窗口栏上最大化按钮,即可将窗口最大化,占满整个功能窗口区域,其它窗口将会暂时最小化到侧栏内,如下图所示:

max-pic

再次双击项目资源管理器功能窗口即可恢复之前的功能窗口位置和状态。

最小化

点击功能窗口最小化按钮,功能窗口将会暂时缩小到侧栏位置放置,点击恢复按钮即可恢复原来状态,如下图所示:

restore

欢迎页

RT-Thread Studio 每次启动打开软件主界面后会展示一个最大化的欢迎页窗口,如下图所示:

welcome-page

欢迎页左侧有四个便利的功能入口:创建RT-Thread项目RT-Thread论坛视频教程帮助文档,直接点击相应的功能名称即可使用对应功能。欢迎页右侧展示了三类内容:最新动态视频教程最新PR,点击对应的标签即可查看或者浏览对应标签页的内容。

新建

新建资源功能包括新建各类资源,例如工程,文件,文件夹等,新建入口有菜单,工具栏按钮,和工程右键菜单如下图所示:

new-resource

RT-Thread 配置

打开 RT-Thread 配置界面

通过双击工程根目录下的RT-Thread Settings文件,可以打开 RT-Thread 配置界面,如下图所示:

pro-set

软件包中心

通过点击立即查看进入软件包中心,软件包中心首先展示了软件包的大分类,在软件包中心,可以先选择一个分类,也可以直接搜索软件包,点击搜索到的软件包进入软件包详情页面后,可以通过点击添加软件包到工程按钮将软件包添加到工程,如下图所示:

add-packages

当软件包成功添加到工程后,软件包中心会提示软件包添加成功,同时添加的软件包会显示在软件包层,该软件包依赖的组件也会被自动启用,例如添加pahomqtt软件包,DFS,SALPOSIXlibc组件会自动被启用,如下图所示:

pahomqtt

组件和服务层

在图标上双击可直接启用该组件。启用的组件是亮色图标,未启用组件为灰色图标。通过在组件和服务层的图标上右键弹出可操作的右键菜单,如果该组件已经启用,则该组件的右键菜单有停用查看依赖详情配置三个选项,如果该组件未启用,则该组件右键菜单只有启用选项,如下图所示:

component

查看依赖

在启用的组件上右键选择查看依赖,可以查看该组件被哪些组件依赖,例如查看libc组件的依赖,依赖关系图窗口显示POSIX组件依赖了libc组件,如下图所示:

see-depend

查看详细配置

在启用的组件上右键选择详细配置,可以打开该组件的详细配置树形界面,例如在DFS上右键选择详细配置,打开的属性配置界面如下图所示:

detail-set

详细配置

当打开 RT-Thread 配置界面的时候,详细配置默认是隐藏的,通过启用的组件的右键菜单详细配置或者 RT-Thread 配置界面侧栏按钮,可以将详细配置界面调出来,侧栏按钮位置如下图所示:

open-detail

详细配置界面即右侧的树形配置界面,树形配置界面分成了四大类配置: Kernel, Components, Packages, Hardware 。通过标签可以切换不同的配置类别,点击侧栏按钮可以隐藏该属性配置界面,如下图所示:

look-detail

搜素配置

当需要搜索某个配置的时候,需要在详细配置里选中任意配置树节点右键,会弹出搜索菜单,或者在详细配置里选中任意配置树节点后,按下快捷键Ctrl + F即可弹出配置搜索对话框,输入搜索关键词点击搜索即可搜索出所有匹配关键词的配置,在结果列表里选择不同结果查看时,配置树会自动跳转到对应配置位置,如下图所示:

search-set

保存配置

当配置修改后,RT-Thread Configuration标签会有脏标记,配置完后要记得点击保存按钮,将配置保存并应用到工程中。保存的时候会弹出进度提示框,提示保存进度,如下图所示:

save-set

代码编辑

编辑

通过编辑菜单或者直接在源码编辑器内右键菜单,可以选择对应的编辑系列功能,如下图所示:

code-edit

源码

通过源码菜单或者直接在源码编辑器内右键菜单,可以选择对应的源码系列功能,如下图所示:

source

重构

通过重构菜单或者直接在源 码编辑器内右键菜单,可以选择对应的重构系列功能,如下图所示:

rebuild

导航

通过导航菜单或者直接在源码编辑器内右键菜单,可以选择对应的导航系列功能,如下图所示:

start-menu

搜素

通过搜索菜单或者搜索按钮,选择对应的搜索功能,如下图所示:

search-menu

辅助键

通过帮助菜单的子菜单辅助键查看所有的快捷键,如下图所示:

help-bottom

构建配置

构建配置入口

构建项目之前如果需要对项目进行构建参数配置,点击工具栏上打开构建配置按钮对项目进行构建参数配置,如下图所示:

build-entry

配置头文件包含

若要增删改头文件路径,在工具设置配置页,点击GNU ARM Cross C Compiler下的Includes配置项即可打开头文件路径配置参数,点击Inlucde paths(-I)配置栏相应的按钮即可进行头文件的增删改操作,如下图所示:

path-include

配置宏定义

若要增删改宏定义,在工具设置配置页,点击GNU ARM Cross C Compiler下的Preprocessor配置项即可打开宏定义配置参数,点击Define symbols(-D) 配置栏相应的按钮即可进行宏定义的增删改操作,如下图所示:

setmicro

配置链接脚本

若要增删改链接脚本配置,在工具设置配置页,点击Cross ARM C Linker下的General配置项即可设置链接脚本文件,点击Script files(-T)配置栏相应的按钮即可进行链接脚本的增删改操作,在Script files(-T)下方有一些基本的链接参数可配置,如下图所示:

setlinkscripts

配置外部二进制库文件

若要增删改外部二进制库文件,在 工具设置 配置页,点击 Cross ARM C Linker 下的 Libraries 配置项即可设置外部二进制库文件,点击 Libraries(-l) 配置栏相应的按钮即可进行库文件的增删改操作,在 Library search path(-L) 配置栏配置库文件相应的路径。

如下图所示:

  • 项目本地新增 GCC 二进制库文件,命名为:libxxx.a(如图中示例 libwifi_1.0.0_gcc.a)。
  • Libraries(-l) 配置栏增加二进制库文件名称:xxx(如图中示例 wifi_1.0.0_gcc),注意需要去掉前缀 lib 与后缀 .a
  • Library search path(-L) 配置栏,添加该库文件所在的路径。

add binary library

add binary library cfg

配置其它

配置其它构建参数可直接在工具设置配置页面中选择相应类型配置树节点,并设置其提供的详细配置项,配置完成后,点击应用并关闭按钮配置即可生效。如下图所示:

setother

调试配置

调试配置入口

进行下载或启动调试之前如果需要对项目进行相关调试参数配置,通过点击工具栏上的调试配置按钮,可打开调试配置对话框界面,如下图所示:

debugentry

调试配置项

选中一个调试配置后,调试配置对话框将展示所有配置项,配置项通过配置项分类标签页进行了分类,通过点击不同标签页展示不同类别配置项,修改配置项后,点击确定按钮即可保存配置修改,如下图所示:

debugset

下载功能

切换调试器

目前 RT-Thread Studio 支持 JLink 和 ST-Link,新建工程的时候可以在新建工程向导里选择调试器,工程创建好之后,如果想切换调试器,可以通过工具栏下载程序按钮旁边的三角下拉按钮来切换调试器,如下图所示:

switchdebug

调试

调试常用操作

当调试启动成功后,程序会在 main 方法处挂起,这时可以通过工具栏上的调试相关操作按钮或者快捷键进行常用的调试操作,如下图所示:

debugopt

启用汇编单步调试模式

点击工具栏上的汇编单步模式按钮,会自动打开反汇编功能窗口,此时汇编单步模式按钮呈凹下去的状态,代表此时处于汇编单步模式,如下图所示:

asmstep

当进入汇编单步模式后,所有单步调试操作将变为以一条汇编指令为单位进行单步执行,此时指令跳转情况可以在反汇编窗口进行查看。

若要退出汇编单步模式,直接再次点击汇编单步模式按钮即可。

查看寄存器

通过窗口菜单的显示视图子菜单,选择打开寄存器窗口即可查看核心寄存器,如下图所示:

seereg

查看外设寄存器

点击Peripherals窗口,让Peripherals窗口显示在最前面,若RT-Thread Studio存在相应的svd文件,该窗口将会显示所有外设名称及其地址和描述。可在Peripherals窗口勾选要查看的外设,内存窗口将会显示该外设的所有寄存器的名称及其地址和当前值,如下图所示:

seeperial

若需要修改某个寄存器的当前值,可以直接点击进入寄存器Value那一列,输入想要修改的值后,敲击回车键即可执行修改。(注:只有可读可写的寄存器可以修改值,只读寄存器无法修改值。)

editreg

查看变量

点击变量窗口,让变量窗口显示在最前面,即可查看当前程序挂起时所有可见的变量,点击变量窗口最右边的三角下拉菜单,可以设置变量显示的数值格式,如下图所示:

seevalue

查看内存

点击内存窗口,让内存窗口显示在最前面。点击添加内存监视器按钮,在弹出的输入框内,输入要查看内存的起始地址,点击确定即可添加要查看的内存,如下图所示:

seememreg

添加内存监视器后,内存窗口会立即展示刚输入的内存起始地址的一段内存,如下图所示:

seemem

断点

在源码编辑窗口边栏,双击即可设置断点,再次双击即可删除断点,打开断点窗口即可查看和管理所有断点,通过断点窗口工具栏可以进行删除,取消等断点管理操作,如下图所示:

breakpoint

表达式

在源码内选中表达式后点击右键,选择添加监看表达式即可将表达式添加到表达式窗口,或者直接点击表达式窗口内的添加新的表达式通过直接输入的方式,添加想要查看的表达式的值。

addformat

终端

通过点击工具栏终端按钮即可打开终端选择界面如下图所示:

terminal

点击确定按钮后,即会自动打开对应的终端功能窗口,如下图所示:

seeterminal

SDK Manager

SDK Manager 简介

通过 SDK Manager 维护 RT-Thread Studio 内部的 RT-Thread SDK 资源包,包括安装,卸载,升级各类资源包。通过工具栏的SDK Manager按钮即可打开 SDK Manager 功能界面,如下图所示:

sdkmanager

SDK Manager 功能

安装资源包

勾选状态为Not installed的资源包,点击Install packages按钮即可启动资源包安装过程,如下图所示:

installsdk

卸载资源包

勾选状态为Installed的资源包,点击Delete packages按钮即可启动卸载过程,如下图所示:

deletesdk

升级资源包

点击资源包对应的升级按钮,可以将资源包同步更新到最新状态。如下图所示:

updatesdk

MarkDown 编辑

RT-Thread Studio 自带 MarkDown 编辑器,若工程里有 md 文件,只需要双击即可打开 md 文件进行编辑,如下图所示:

editmd

常用快捷键

代码阅读

  • Ctrl+H 全局 打开搜索对话框
  • Ctrl+Shift+T 全局 打开类型
  • Ctrl+Shift+R 全局 打开资源

代码编辑

  • Ctrl+D 删除当前行

  • Ctrl+/ 注释当前行,再按则取消注释

  • Ctrl+Shift+F 格式化

  • Alt+→ /← 全局 前进/后退历史记录

  • Ctrl+Q 定位到最后编辑的地方

  • Ctrl+K 参照选中的Word快速定位到下一个

  • Ctrl+L 定位在某行

  • Alt+→ /← 前一个/下一个编辑的页面

  • Shift+Enter 在当前行的下一行插入空行

首选项

首选项介绍

RT-Thread Studio 基于 eclipse 平台开发,eclipse 是一个高度可定制的平台,基于 eclipse 实现的功能都会提供大量的配置项,来定制功能的行为方式,来满足用户自身的使用习惯,这些配置项 eclipse 称为首选项。

通过点击窗口菜单的字菜单首选项即可进入首选项配置界面,如下图所示:

firstopt

由于首选项数量大,种类多,首选项对话框左侧以树形的形式展示所有的首选项,点击对应的首选项类别即可展开对应的首选项配置树,若要查找某个首选项,可直接在输入过滤文本框中,输入关键字,进行查找。

首选项右侧即为具体的可配置项页面,修改 后直接点击应用即可保存配置,若想恢复当前配置页默认值,点击恢复默认值按钮即可。

首选项配置还可以通过左下角导入导出功能,将配置进行保存或者在不同用户间传递或者共享配置,导出功能将把所有配置导出到.epf文件中,其它用户直接导入这个.epf文件,即可使用该文件记录的所有配置。

optmenu

设置主题

通过首选项外观配置项选择“DevStyle Theme”即可启用新的黑色主题,切换主题后需要重启Studio后才会生效

devstyle1

通过DevStyle ThemeColor Themes配置项选择“Editor theme”可以切换其他黑色主题,切换主题后需要重启Studio后才会生效

devstyle2

Question && Feedback