Skip to content

Commit a15f58d

Browse files
YunxianHuayujingz
andauthored
feat: add teleop panel, service panel, publish panel docs (#220)
* I must enjoy torturing myself * some stuff working haha * I'm sorry. * Refactor and improve documentation for Publish, Service, and Teleop panels - Enhanced clarity and readability of panel documentation - Updated configuration and usage instructions - Improved technical descriptions and formatting - Added more precise explanations of panel functionalities - Synchronized Chinese and English documentation --------- Co-authored-by: Yujing Zheng <[email protected]>
1 parent ac4c7ef commit a15f58d

File tree

12 files changed

+176
-0
lines changed

12 files changed

+176
-0
lines changed
+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
sidebar_position: 12
3+
---
4+
5+
# 发布面板
6+
7+
![viz-12-1.png](../img/viz-12-1.png)
8+
9+
发布面板(Publish Panel)是一个用于向「指定主题(Topic)」发布消息的工具,它通过 [coBridge](https://github.com/coscene-io/coBridge) 将信息传递给您的机器人系统。
10+
11+
## 设置选项
12+
13+
- 编辑模式(Editing Mode):开启时可编辑消息内容,关闭时仅显示发布按钮
14+
- 按钮标题(Button Title):自定义发布按钮的显示文本
15+
- 按钮提示(Button Tooltip):设置鼠标悬停时显示的提示信息
16+
- 按钮颜色(Button Color):自定义按钮的显示颜色
17+
18+
## 使用步骤
19+
20+
1. 输入主题:在主题栏中输入目标主题名称,系统会自动识别对应的消息架构并生成 JSON 模板
21+
2. 选择架构:点击架构选择框可查看常用 ROS 架构列表,选择后将自动生成对应的 JSON 模板
22+
3. 编辑消息:根据需求修改 JSON 模板内容
23+
4. 发送消息:点击发布按钮将消息发送至指定主题
24+
25+
## 使用须知
26+
27+
- Web 端必须连接至支持发布功能的机器端,否则发布按钮将处于禁用状态
28+
- 机器端的 coBridge 配置需要启用 clientPublish 功能,才能支持从 Web 端发布主题消息
29+
30+
发布面板为您提供了一个直观的界面,让您能够方便地与机器人系统进行消息交互,提升操作效率。
+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
sidebar_position: 13
3+
---
4+
5+
# 服务调用面板
6+
7+
![viz-13-1.png](../img/viz-13-1.png)
8+
9+
服务调用面板(Service Call Panel)允许您通过 [coBridge](https://github.com/coscene-io/coBridge) 调用机器端服务(Service)并查看其响应。
10+
11+
## 配置选项
12+
13+
### 基础配置
14+
15+
- **服务名称** (Service name):需要调用的服务名称
16+
- **布局方式** (Layout):配置请求和响应区域的排列方式
17+
- 垂直布局 (Vertical):上下排列
18+
- 水平布局 (Horizontal):左右排列
19+
20+
### 按钮配置
21+
22+
- **按钮文本** (Title):显示在按钮上的文字
23+
- **提示信息** (Tooltip):鼠标悬停时显示的提示文本
24+
- **按钮颜色** (Color):自定义按钮的显示颜色
25+
26+
## 使用说明
27+
28+
1. 首先需要确保已连接到支持的数据源,否则"调用服务"按钮将保持禁用状态
29+
2. 在请求输入区域中,使用标准 JSON 格式编写服务请求内容
30+
3. 点击"调用服务"按钮发送请求
31+
4. 服务的响应结果将自动显示在响应区域中
32+
33+
服务调用面板为您提供了一个直观的界面,方便您与机器人系统进行服务(Service)级别的交互。通过这个面板,您可以轻松地测试各种服务调用,实时查看响应结果,有效地进行系统调试和功能验证。
+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sidebar_position: 14
3+
---
4+
5+
# 远程操控面板
6+
7+
![viz-14-1.png](../img/viz-14-1.png)
8+
9+
远程操控面板使您能够通过发布 `geometry_msgs/Twist``geometry_msgs/msg/Twist` 消息到指定主题(Topic)来控制机器人。要使用此面板远程操控机器人,您需要先通过 [coBridge](https://github.com/coscene-io/cobridge) 建立与机器人的通信连接。
10+
11+
## 配置参数
12+
13+
- 发布频率 (Publish rate):控制 Twist 消息的发送频率
14+
- 主题名称 (Topic):指定发布 Twist 消息的目标主题
15+
- 方向控制按钮:配置上/下/左/右按钮对应的运动参数
16+
- 可分别设置线性速度(x、y、z)和角速度的对应数值
17+
18+
## 支持的消息类型
19+
20+
- ROS 1: `geometry_msgs/Twist`
21+
- ROS 2: `geometry_msgs/msg/Twist`
22+
23+
## 技术实现
24+
25+
远程操控面板是一个专用的发布器面板,其核心功能是通过 coBridge 向机器人发送控制指令。要实现远程操控功能,机器人端需要配置相应的组件来处理接收到的控制消息。

docs/4-recipes/img/viz-12-1.png

27.4 KB
Loading

docs/4-recipes/img/viz-13-1.png

31.1 KB
Loading

docs/4-recipes/img/viz-14-1.png

42.3 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
sidebar_position: 12
3+
---
4+
5+
# Publish Panel
6+
7+
![viz-12-1.png](../img/viz-12-1.png)
8+
9+
The Publish Panel allows the users to publish messages to specified topics via [coBridge](https://github.com/coscene-io/coBridge).
10+
11+
## Settings Options
12+
13+
- Editing Mode: When enabled, you can edit the message content; when disabled, only the publish button is displayed
14+
- Button Title: Customize the display text of the publish button
15+
- Button Tooltip: Set the tooltip information displayed on mouse hover
16+
- Button Color: Customize the button's display color
17+
18+
## Usage Steps
19+
20+
1. Specify Topic: Enter the target topic name in the topic field, and the system will automatically recognize the corresponding message schema and generate a JSON template
21+
2. Select Schema: Click the schema selection box to view a list of common ROS schemas, selecting one will automatically generate the corresponding JSON template
22+
3. Edit Message: Modify the JSON template content according to your needs
23+
4. Send Message: Click the publish button to send the message to the specified topic
24+
25+
## Notes
26+
27+
- The web client must be connected to a machine that supports the publishing feature, otherwise the publish button will be disabled
28+
- The coBridge configuration on the machine must enable the clientPublish feature to support publishing topic messages from the web client
29+
30+
The Publish Panel provides you with an intuitive interface to conveniently interact with your robot system, improving operational efficiency.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
sidebar_position: 13
3+
---
4+
5+
# Service Call Panel
6+
7+
![viz-13-1.png](../img/viz-13-1.png)
8+
9+
The Service Call Panel allows the users to call ROS services via [coBridge](https://github.com/coscene-io/coBridge) and view the responses.
10+
11+
## Configuration Options
12+
13+
### Basic Settings
14+
15+
- **Service Name**: The name of the target service to be called
16+
- **Layout**: Configure the arrangement of request and response areas
17+
- Vertical: Arranged top and bottom
18+
- Horizontal: Arranged left and right
19+
20+
### Button Settings
21+
22+
- **Title**: The text displayed on the button
23+
- **Tooltip**: The hint text shown on mouse hover
24+
- **Color**: Customize the button's display color
25+
26+
## Usage Instructions
27+
28+
1. Make sure you are connected to a supported data source, otherwise the "Call Service" button will remain disabled
29+
2. In the request input area, write the service request content using standard JSON format
30+
3. Click the "Call Service" button to send the request
31+
4. The service response will automatically display in the response area
32+
33+
The Service Call Panel provides you with an intuitive interface for service-level interaction with the robot system. Through this panel, you can easily test various service calls, view response results in real-time, and effectively perform system debugging and functionality verification.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
sidebar_position: 14
3+
---
4+
5+
# Teleop Panel
6+
7+
![viz-14-1.png](../img/viz-14-1.png)
8+
9+
The Teleop Panel allows you to remotely control your robot by publishing `geometry_msgs/Twist` or `geometry_msgs/msg/Twist` messages on a specified topic. To remotely operate a connected robot using this panel, you need to establish communication with the robot via [coBridge](https://github.com/coscene-io/cobridge).
10+
11+
## Configuration Parameters
12+
13+
- Publish Rate: Control the frequency of publishing Twist messages
14+
- Topic: Specify the topic for publishing Twist messages
15+
- Direction Control Buttons: Configure the movement parameters for Up/Down/Left/Right buttons
16+
- You can set corresponding values for linear velocity (x, y, z) and angular velocity
17+
18+
## Supported Message Types
19+
20+
- ROS 1: `geometry_msgs/Twist`
21+
- ROS 2: `geometry_msgs/msg/Twist`
22+
23+
## Technical Implementation
24+
25+
The Teleop Panel is a specialized publish panel, with its core functionality being sending control commands to the robot via coBridge. To achieve remote control functionality, the robot side needs to have corresponding components configured to process the received control messages.
Loading
Loading
Loading

0 commit comments

Comments
 (0)