Skip to content

Commit 423b0f2

Browse files
yujingzzhexuanyheqixiranyu01yu xiran
authored
Relase 25.12 (#258)
* init dev deploy action * update dev bucket trigger update deployment target url Add development environment indicator to Docusaurus config * Restructure docs toc * fix building * remove number prefix from folder's name in docs * reorg docs structures * rm unused img files * undo changes in i18n * undo changes in i18n * continue to reorg structure * continue reorg the structure of docs * finish record * cleanup temp img files * finish task and comment * finish client apps * finish concepts * finish coscene command line * finish openapi * finish docs * finish device * finish image * finish data diagnosis * tmp saving * i18n building pass * Configure docs as landing page and remove unused pages * Update deployment notification message in GitHub Actions workflow * Localize deployment notification text to Chinese * Add emoji for better visual clarity * Improve readability of deployment information * add cursor rules for some repo knowledge * Hide navbar title in both light and dark themes * Update Changelog * Update i18n translations for Docusaurus theme and sidebar categories - Add new translations for search-related UI elements in code.json - Update sidebar category translations in current.json - Modify footer and navbar translations - Specify English locale for write-translations script in package.json * feat: doc url fragment * Backport Panel Updates to Dev (#230) * Add documentation for Publish, Service Call, and Teleop Panels - Create new markdown files for three visualization panels in Chinese and English - Add corresponding panel screenshots in both language directories - Document panel features, configuration options, and usage instructions - Cover panels for publishing messages, calling services, and remote robot control * Update image paths and alt text for Publish, Service Call, and Teleop Panel docs * Sync Upstream Changes (#231) * Update Rules Docs * adding rules file to master * finish i18n * fix anchors error * Update Changelog 0208 (#224) * update: changelog for version 25.6.0 * update: changelog for version 25.6.0 * slight tweak --------- Co-authored-by: yu xiran <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Remove empty data diagnosis rule documentation file * Update Adding Rules (#226) * update: changelog for version 25.6.0 * update: changelog for version 25.6.0 * docs: update rule content structure * remove the extra packagejson lock --------- Co-authored-by: yu xiran <[email protected]> * 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]> * docs: update rule content structure & coBridge (#227) * docs: update rule content structure & coBridge * chore(deps): bump dependencies in package.json and pnpm-lock.yaml - Update postcss from 8.5.1 to 8.5.2 - Update prettier from 3.4.2 to 3.5.0 - Update various Algolia and Babel-related dependencies - Minor version bumps for other development dependencies * update add rule * fix: resolve merge conflicts in data diagnosis rule documentation * Update 2-get-started.md * Update 3-add-rule.md * Update 2-get-started.md --------- Co-authored-by: yu xiran <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * docs: update data diagnosis documentation images and configuration * refactoring names --------- Co-authored-by: Zhexuan Yang <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: yu xiran <[email protected]> Co-authored-by: fei.gao <[email protected]> * feat: add home page (#235) * add home page * docs * move CATALOGUE * add link * update CATALOGUE * update category * update link * update code.json * action i18n * sidebar i18n * update width * panel folder * panel i18n * build fix * overview * feat: home page header (#237) * add header image * i18n * update font size * image url * Remove unused assets (#238) * remove unused zhcn images * remove a few en dup images * remove unused en images * update changelog (#241) * feat: update logo svg (#240) * feat: update record doc (#242) * update record * hide image * update link * fix image --------- Co-authored-by: xiran.yu <[email protected]> * add teambition integration (#243) * add teambition integration * delete npm * feat: batch remote command doc (#245) * feat: batch remote command doc * update doc sidebar position * rename md * update doc title * add tag * update image * remote command * en markdown * i18n * clean up * device en * translate * remote cmd * fix link * update doc * feat: add legel and data security docs (#244) * feat: add legel and data security docs * fix: announcementBar site_url (#246) * fix: development announcement bar (#247) * test process.env.environment * output env * add DEPLOY_ENV * update content * fix content * feat: use html link to download json file (#250) * feat: use html link to download json file * Feat/record viz (#252) * feat: update record&viz * docs:updated record & viz * fix doc catalogue * update doc name --------- Co-authored-by: Qi He <[email protected]> * Feat:add `coStudio` usage docs (#254) * feat: add coStudio realtime viz docs * Update: device docs (#255) * Add rules (#222) * Feat/update terms (#257) * fix: 更新隐私政策页面的最后更新日期 (#249) * feat: update terms * I'm just going to blame Copilot for that one. --------- Co-authored-by: Zhexuan Yang <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: yu xiran <[email protected]> Co-authored-by: fei.gao <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: xiran.yu <[email protected]> Co-authored-by: Woodii <[email protected]> Co-authored-by: Zhexuan Yang <[email protected]>
1 parent c3fad9d commit 423b0f2

File tree

416 files changed

+12110
-10038
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

416 files changed

+12110
-10038
lines changed

.github/workflows/shared-oss-deploy.yml

+2
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ jobs:
4242
run: pnpm install --frozen-lockfile
4343

4444
- name: Build Project
45+
env:
46+
DEPLOY_ENV: ${{ inputs.environment }}
4547
run: |
4648
export NODE_OPTIONS=--max_old_space_size=5632
4749
pnpm build
+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# 通过 coBridge 连接机器
6+
7+
[coBridge](https://github.com/coscene-io/coBridge) 是刻行时空提供的一款开源机端软件,目前支持 **ros1** `noetic`**ros2** `foxy``humble` 版本。cobridge 会以 ros node 的方式运行在机器人端,并通过 websocket 方式与云端进行交互。cobridge 与云端建立链接后,根据云端指令可以实现订阅 ros topic,调用 ros service,实现实时监控机器人状态、远程下发指令等功能。
8+
9+
## 安装 coBridge
10+
在机器端,打开 terminal,依照以下流程安装 coBridge。
11+
1. 导入公钥。
12+
```bash
13+
wget https://coscene-download.oss-cn-hangzhou.aliyuncs.com/cobridge/coscene.gpg && sudo gpg --dearmor -o /etc/apt/trusted.gpg.d/coscene.gpg coscene.gpg
14+
```
15+
16+
2. 添加源。
17+
```bash
18+
echo "deb [signed-by=/etc/apt/trusted.gpg.d/coscene.gpg] https://coscene-download.oss-cn-hangzhou.aliyuncs.com/cobridge $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/cobridge.list
19+
```
20+
21+
3. 更新apt并安装。
22+
```bash
23+
sudo apt update
24+
# 注意: 如果 ROS_DISTRO 没有在你的环境变量里面,${ROS_DISTRO} 需要被 'noetic', 'foxy' or 'humble' 替换
25+
sudo apt install ros-${ROS_DISTRO}-cobridge -y
26+
```
27+
28+
4. 运行 coBridge。
29+
```bash
30+
source /opt/ros/${ROS_DISTRO}/setup.bash
31+
32+
# for ros 1 distribution
33+
roslaunch cobridge cobridge.launch
34+
35+
# for ros 2 distribution
36+
ros2 launch cobridge cobridge_launch.xml
37+
```
38+
39+
## 使用 coStudio 对机器进行实时可视化
40+
1. 下载 [coStudio](https://www.coscene.cn/download)
41+
2. 开启 coStudio 后,选择 “打开连接” 功能。
42+
![打开连接](./img/1-1-open-connection-cn.png)
43+
3. 选择 coScene Websocket 选项,在 WebSocket URL 中输入连接地址。`ws://localhost:21274` **( 21274 为 coBridge 的默认端口号 )**
44+
![选择连接](./img/1-2-select-connection-cn.png)
45+
4. 打开后即可使用不同面板对机器数据进行实时可视化。
46+
![实时可视化](./img/1-3-realtime-viz-cn.png)
47+
48+
## 可视化相关参考链接
49+
* 面板相关设置:[面板设置](https://docs.coscene.cn/docs/category/panel)
50+
* 布局相关设置:[布局](https://docs.coscene.cn/docs/viz/layout)
51+

docs/coStudio/_category_.json

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"label": "客户端",
3+
"position": 12,
4+
"collapsible": true,
5+
"link": {
6+
"type": "generated-index",
7+
"slug": "/category/costudio"
8+
}
9+
}
10+
77.8 KB
Loading
62.8 KB
Loading
309 KB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
6+
# Teambition 集成
7+
8+
## 简介
9+
配置 Teambition 集成后,可将项目的通用任务同步至 Teambition,实现企业工单平台对任务的统一管理。以下是典型的使用场景:
10+
1. 设备发生问题时,自动上传数据并在 Teambition 中创建任务
11+
2. 可视化分析数据时,在关键时间点创建任务并同步至 Teambition
12+
13+
## 前提条件
14+
请确保你的 Teambition 企业已发布「企业内部应用」,步骤如下:
15+
16+
1. 进入[Teambition 开放平台](https://open.teambition.com/app),创建新应用-企业内部应用,详见[Teambition 发布应用文档](https://open.teambition.com/docs/documents/5d89d63f8acc9d00143ac733)
17+
2. 进入应用开发 - 权限管理页面,开通以下权限
18+
19+
| 开通项 | 图示 |
20+
|------|------|
21+
| 任务-任务查看权限 | ![teambition1](./img/teambition_1.png) |
22+
| 任务-任务创建权限 | ![teambition2](./img/teambition_2.png) |
23+
| 项目-项目查看权限 | ![teambition3](./img/teambition_3.png) |
24+
| 项目-获取缺陷分类列表 | ![teambition4](./img/teambition_4.png) |
25+
| 工作流节点-搜索企业工作流 | ![teambition5](./img/teambition_5.png) |
26+
27+
3. 在应用发布页面发布应用,并联系企业管理员进行审核
28+
4. 在应用凭证与基本信息页面,复制应用的 App ID 与 App Secret,用于后续项目集成
29+
30+
## 操作流程
31+
### 配置集成
32+
> 仅项目管理员与组织管理员有编辑权限,其余角色不可见
33+
34+
1. 进入需要配置集成的项目,在项目设置 - 服务集成 - Teambition 中,点击【添加配置】按钮。
35+
36+
![teambition_6](./img/teambition_6.png)
37+
38+
2. 填写集成配置并保存,字段说明如下
39+
40+
```yaml
41+
enabled: true # 启用配置
42+
endpoint: https://teambition.com # Teambition 应用的网页地址
43+
apiEndpoint: https://open.teambition.com/api/ # Teambition API 地址
44+
appCredential:
45+
appId: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 应用的唯一标识符(App ID)
46+
appSecret: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 应用的安全密钥(App Secret)
47+
userId: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 任务创建者的 UID
48+
orgId: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 的组织 ID
49+
projectId: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 的项目 ID
50+
51+
issueTitleTemplate: '{{task.title}}' # Teambition 的标题为任务名称
52+
issueDescriptionTemplate: |
53+
【任务名称】:{{task.title}}
54+
【记录名称】:{{record.title}}
55+
【记录描述】:{{record.description}}
56+
【记录标签】:{{record.labels}}
57+
【设备 ID】:{{device.id}}
58+
【记录链接】:{{record.link}}
59+
assignee: '{{moment.customFields.assignee}}' # Teambition 任务执行者的 UID,取自一刻属性值中 assignee 对应的值
60+
deadline: '{{moment.triggerTime}}' # Teambition 任务的截止时间,取自一刻的触发时间
61+
sprintId: '{{device.customFields.sprint}}' # Teambition 的迭代 ID,取自设备自定义字段 sprint 的值
62+
scenarioFieldConfigId: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 任务类型(需求/缺陷/任务)的 ID
63+
customFields:
64+
- id: xxxxxxxxxxxxxxxxxxxxxxxx # Teambition 自定义字段的 ID
65+
type: commongroup # Teambition 自定义字段的类型
66+
values:
67+
- title: '{{moment.customFields.bug}}' # Teambition 自定义字段的值,取自一刻属性值中 bug 对应的值
68+
69+
```
70+
71+
- **enabled**
72+
73+
是否启用配置,默认为`true`
74+
75+
- **endpoint**
76+
77+
Teambition 应用的网页地址,默认为`https://teambition.com`
78+
79+
- **apiEndpoint**
80+
81+
Teambition API 地址,默认为`https://open.teambition.com/api/`
82+
83+
- **appId**
84+
85+
Teambition 应用的唯一标识符(App ID),可在[Teambition 开放平台](https://open.teambition.com/app)的「应用凭证与基础信息」页获取。
86+
87+
- **appSecret**
88+
89+
Teambition 应用的安全密钥(App Secret),可在[Teambition 开放平台](https://open.teambition.com/app)的「应用凭证与基础信息」页获取。
90+
91+
![teambition_7](./img/teambition_7.png)
92+
93+
- **userId**
94+
95+
Teambition 任务创建者的 UID,可在账号设置-个人账号中心获取。
96+
97+
| ![teambition_8](./img/teambition_8.png) | ![teambition_9](./img/teambition_9.png) |
98+
|:---:|:---:|
99+
100+
- **orgId**
101+
102+
Teambition 的组织 ID,可在浏览器的 URL 中获取。
103+
104+
![teambition_10](./img/teambition_10.png)
105+
106+
- **projectId**
107+
108+
Teambition 的项目 ID,可进入项目后,在浏览器的 URL 中获取。
109+
110+
![teambition_11](./img/teambition_11.png)
111+
112+
- **issueTitleTemplate**
113+
114+
Teambition 任务标题,可自定义,默认使用通用任务标题,即`'{{task.title}}'`
115+
116+
- **issueDescriptionTemplate**
117+
118+
Teambition 任务备注,可自定义或使用变量
119+
120+
- **assignee**
121+
122+
Teambition 任务执行者的 UID,可在账号设置-个人账号中心获取(同userId)。
123+
124+
- **deadline**
125+
126+
Teambition 任务的截止时间,默认为一刻的触发时间,即`'{{moment.triggerTime}}'`
127+
128+
- **sprintId**
129+
130+
Teambition 任务的迭代 ID,可进入项目的迭代,在浏览器的 URL 处获取。![teambition_12](./img/teambition_12.png)
131+
132+
- **scenarioFieldConfigId**
133+
134+
Teambition 任务类型(需求/缺陷/任务),在项目中打开浏览器开发者模式,可获取对应的 id。
135+
136+
![teambition_13](./img/teambition_13.png)
137+
138+
- **customFields**
139+
140+
Teambition 任务的自定义字段,一个自定义字段的配置信息如下:
141+
142+
```yaml
143+
- id: 67b****e93d23d # 自定义字段的 ID
144+
values:
145+
- title: **** # 自定义字段的值
146+
```
147+
148+
- 自定义字段的 ID 可在浏览器开发者模式中获取
149+
150+
![teambition_14](./img/teambition_14.png)
151+
152+
- 自定义字段的值可自定义或使用变量
153+
154+
- 其中,「缺陷分类」字段需增加字段类型`type: commongroup`
155+
156+
```yaml
157+
customFields:
158+
- id: 67b2c****015 # 字段的 ID
159+
type: commongroup # 字段类型,若为其他自定义字段,无需填写此行
160+
values:
161+
- title: **** # 字段的值
162+
```
163+
164+
### 变量
165+
集成中的任务信息支持使用变量,详见下表:
166+
167+
| 变量名 | 含义 |
168+
|--------|------|
169+
| `{{task.title}}` | 任务名称 |
170+
| `{{record.title}}` | 记录名称 |
171+
| `{{record.description}}` | 记录描述 |
172+
| `{{record.labels}}` | 记录标签 |
173+
| `{{record.link}}` | 记录链接 |
174+
| `{{device.id}}` | 设备 ID |
175+
| `{{device.title}}` | 设备名称 |
176+
| `{{device.customFields.sprint}}` | 设备自定义字段`sprint`的值 |
177+
| `{{moment.customFields.name}}` | 一刻属性值中`name`字段的值 |
178+
| `{{moment.triggerTime}}` | 一刻的触发时间 |
179+
180+
### 同步任务到 Teambition
181+
1. 前往已配置的数采&诊断规则中,将「诊断数据」模块中的「创建通用任务」与「同步通用任务至 Teambition 中」设置为「是」
182+
183+
![teambition_15](./img/teambition_15.png)
184+
185+
2. 当监听到设备触发规则时,将自动上传数据并在 Teambition 中创建任务
186+
- 根据规则采集的数据
187+
188+
![teambition_16](./img/teambition_16.png)
189+
190+
- 自动诊断数据,并创建出一刻
191+
192+
![teambition_17](./img/teambition_17.png)
193+
194+
- 根据创建出来的一刻,系统自动创建「通用任务」并同步到 Teambition 平台中
195+
196+
![teambition_18](./img/teambition_18.png)
197+
198+
- 在 Teambition 中可查看到一条任务
199+
200+
![teambition_19](./img/teambition_19.png)
201+
202+
## 常见问题解答
203+
**问:Teambition 中的 userId 出现了文本溢出,无法直接在界面上复制,怎么办?**
204+
答:使用浏览器的开发者模式查看 userID,在 Network - me - id ,复制双引号中间的部分即可,详细操作如下图所示。
205+
206+
![teambition_20](./img/teambition_20.png)
207+
208+
**问:保存 Teambition 集成时,提示「请检查 yaml 文件格式」?**
209+
答:检查 yaml 内容中使用变量的部分,是否已使用英文输入法的单引号 ' ' 括起,如下图所示的`'{{moment.triggerTime}}'`就少了右边部分的单引号。
210+
211+
![teambition_21](./img/teambition_21.png)
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/collaboration/record/1-create-record.md

-46
This file was deleted.

0 commit comments

Comments
 (0)