Skip to content

Commit 856a965

Browse files
heqiWoodii1998yujingzFredzengfafa曾擎禹
authored
release v25.37.0 (#337)
* feat: update catalogue (#286) * Add Translations for Custom Panels and some broken links fix (#288) * feat: add dev script to package.json and update links in documentation - Added a new "dev" script to package.json for easier local development. - Updated links in the device collector and data diagnosis documentation for better navigation. - Ensured consistent formatting in the device collector documentation. * Fix absolute links in cn changelog * create project broken link * add translations * translate message converters * translate topic aliases * translate other docs * fix a couple files that did not translate to english * Add more translations * Fix/broken links (#289) * before fixing the markdown references * fix broken links * New user-case: online-simulation-test (#291) * New user-case: online-simulation-test * new quick-start * resolve the conversation comments * resolve the comments * fix format problem * fix picture * fix problem of picture format * fix a couple formatting and remove some unnecessary words * formatting --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Data Record Solution (#293) Co-authored-by: 曾擎禹 <[email protected]> * renaming for beterr linuix support * Update embodied intelligence data collection solution documentation and enhance home catalogue with new links * Heterogeneous Robot Data Factory Docs 1.0 (#296) * offical-version1.0 of data collection * Add files via upload * Add files via upload * Add files via upload * Update 5-embodied-intelligence-data-collection-solution.md * fix links --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Better Links (#297) * safely upgrade deps * improve device admission htmr anchor * Add temporary en translations * update links * ci * Faster Builds (#298) * update changelog * fix changelog # Conflicts: # src/pages/changelog.md * updated changelog,device,rules (#299) * updated changelog,device,rules * fix link * fix changelog * fix link --------- Co-authored-by: Qi He <[email protected]> * enable device and homepage catalogue (#301) * enable device * update catalogue * 新增设备采集器文档中的模板语法使用部分,详细介绍了模板语法的概述、基本语法、支持的变量及时间格式化选项,提升了文档的可读性和实用性。 (#303) * Add simulation translation (#305) * Doc: update device config info (#308) * Release 25.26.0 (#306) * feat: update catalogue (#286) * Add Translations for Custom Panels and some broken links fix (#288) * feat: add dev script to package.json and update links in documentation - Added a new "dev" script to package.json for easier local development. - Updated links in the device collector and data diagnosis documentation for better navigation. - Ensured consistent formatting in the device collector documentation. * Fix absolute links in cn changelog * create project broken link * add translations * translate message converters * translate topic aliases * translate other docs * fix a couple files that did not translate to english * Add more translations * Fix/broken links (#289) * before fixing the markdown references * fix broken links * New user-case: online-simulation-test (#291) * New user-case: online-simulation-test * new quick-start * resolve the conversation comments * resolve the comments * fix format problem * fix picture * fix problem of picture format * fix a couple formatting and remove some unnecessary words * formatting --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Data Record Solution (#293) Co-authored-by: 曾擎禹 <[email protected]> * renaming for beterr linuix support * Update embodied intelligence data collection solution documentation and enhance home catalogue with new links * Heterogeneous Robot Data Factory Docs 1.0 (#296) * offical-version1.0 of data collection * Add files via upload * Add files via upload * Add files via upload * Update 5-embodied-intelligence-data-collection-solution.md * fix links --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> * Better Links (#297) * safely upgrade deps * improve device admission htmr anchor * Add temporary en translations * update links * ci * Faster Builds (#298) * update changelog * fix changelog # Conflicts: # src/pages/changelog.md * updated changelog,device,rules (#299) * updated changelog,device,rules * fix link * fix changelog * fix link --------- Co-authored-by: Qi He <[email protected]> * enable device and homepage catalogue (#301) * enable device * update catalogue * 新增设备采集器文档中的模板语法使用部分,详细介绍了模板语法的概述、基本语法、支持的变量及时间格式化选项,提升了文档的可读性和实用性。 (#303) * Add simulation translation (#305) --------- Co-authored-by: Woodii <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: Qi He <[email protected]> * doc: update device config info --------- Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: Woodii <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: Qi He <[email protected]> Co-authored-by: Qi He <[email protected]> * Feat/project resource (#307) * Feat/add token runtime info (#313) * add titles to terms of services * add info about costoken * remove dup * add view client information hashtag (#315) * colistener collect (#312) * coListener collect * Update 5-device-collect.md * Update 5-device-collect.md * fix link --------- Co-authored-by: xiranyu <[email protected]> * Changelog (#316) * Update changelog.md * Update changelog.md * fix anchor * update docs link --------- Co-authored-by: Yujing Zheng <[email protected]> * Update coCLI latest changes (#319) * cocli is now out of beta * finish the cocli install page refresh * add basic docs for record ops * view and describe records * finish labels docs * add files operations * emphise the help * cleanup * Add moments related operations * update english version as well * remove unnecessary category json * Remove aseets we dont need anymore * Create records by convention in Action (#321) * complete action runtime docs info * update english version as well * feat: add cocli category * updated devcie & collect & some pages (#323) * update catalogue; uninstall device command (#324) * update uninstall device command * update catalogue * 25.31 changelog (#325) * 25.31 changelog * 25.31 changelog 2 * fix link --------- Co-authored-by: Qi He <[email protected]> * Update: Open API link in docusaurus.config.js to fix to new S3 storage address. (#328) * Feat/data collection (#331) * Add files via upload * Update 5-device-collect.md * Add files via upload * Update 5-device-collect.md * Update 3-add-rule.md * Update 3-add-rule.md * Add files via upload * Update 1-quick-start.md * Add files via upload * Update 1-quick-start.md * Update 3-add-rule.md * Update 3-add-rule.md * fix add rule variable * Update 3-add-rule.md * Update 3-add-rule.md --------- Co-authored-by: Qi He <[email protected]> * Feat/changelog (#332) * Update changelog.md * Update changelog.md * add information of service definition. (#318) * add information of service definition. * nit --------- Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: fei.gao <[email protected]> * fix: openapi url (#336) --------- Co-authored-by: Woodii <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: Fredzengfafa <[email protected]> Co-authored-by: 曾擎禹 <[email protected]> Co-authored-by: Yujing Zheng <[email protected]> Co-authored-by: xiranyu <[email protected]> Co-authored-by: angryPopcorn <[email protected]> Co-authored-by: fei.gao <[email protected]>
1 parent 8e97bb2 commit 856a965

File tree

3 files changed

+79
-6
lines changed

3 files changed

+79
-6
lines changed

.github/workflows/deploy-to-gh-pages.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,9 @@ jobs:
3535
- name: Build website with English locale
3636
run: |
3737
# Temporarily modify the default locale to English
38-
sed -i 's/defaultLocale: '\''zh'\''/defaultLocale: '\''en'\''/' docusaurus.config.js
39-
40-
# Uncomment and update Algolia search path for GitHub Pages deployment
4138
sed -i '/{ type: '\''localeDropdown'\'', position: '\''right'\'' }/d' docusaurus.config.js
42-
sed -i -e "s/defaultLocale: 'zh'/defaultLocale: 'en'/" -e "s/locales: \['zh', 'en'\]/locales: \['en'\]/" -e 's|coscene.cn|coscene.io|g' docusaurus.config.js
39+
sed -i -e "s/defaultLocale: 'zh'/defaultLocale: 'en'/" -e "s/locales: \['zh', 'en'\]/locales: \['en'\]/" -e 's|download.coscene.cn|coscene-download.s3.us-east-1.amazonaws.com|g' -e 's|coscene.cn|coscene.io|g' docusaurus.config.js
40+
4341
find docs blog src i18n -type f \( -name "*.md" -o -name "*.mdx" -o -name "*.js" -o -name "*.ts" -name "*.tsx" -o -name "*.json" \) -exec sed -i -e 's|https://coscene.cn|https://portal.coscene.io|g' {} +
4442
find docs blog src i18n -type f \( -name "*.md" -o -name "*.mdx" -o -name "*.js" -o -name "*.ts" -name "*.tsx" -o -name "*.json" \) -exec sed -i -e 's|coscene.cn|coscene.io|g' {} +
4543

docs/use-case/5-heterogeneous-robot-data-factory.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,82 @@ sidebar_position: 5
5050
## 准备与启动 ROS node
5151

5252
- 机器人本体上需要有可以提供 **service****数据录制节点**,并且提供 **开始录制** (如/start_record), **取消录制** (如/cancel_record), **结束录制** (如/stop_record)之类的服务供刻行时空调用。
53-
-- **注意:**: 目前只支持**service** 类型的消息。
53+
-- **注意:**
54+
1. /start_record service
55+
56+
e.g.:
57+
```C++
58+
# request
59+
string record_opt
60+
---
61+
# response
62+
bool success
63+
string message
64+
```
65+
start_record request 无任何要求,可以在此处添加一些例如 `saving directory` 等字段, 供`数据录制节点`使用。
66+
67+
start_record response 必须需包含 `success``message` 字段, 用于通知 web 端是否已经成功开启了录制功能。
68+
69+
2. /cancel_record service
70+
71+
e.g.:
72+
```C++
73+
# request
74+
bool auto_remove # remove bags that are recorded
75+
---
76+
# response
77+
bool success
78+
string message
79+
```
80+
cancel_record request 无任何要求,可以在此处添加一些例如 `auto_remove` 等字段, 供`数据录制节点`使用。
81+
82+
cancel_record response 必须需包含 `success``message` 字段, 用于通知 web 端是否已经成功取消了录制功能。
83+
84+
3. /stop_record service
85+
86+
e.g.:
87+
```C++
88+
# request
89+
---
90+
# response
91+
bool success
92+
string type
93+
string message
94+
string record_name
95+
string[] tags
96+
string[] files
97+
```
98+
stop_record request 无任何要求,可以在此处添加一些字段, 供`数据录制节点`使用。
99+
100+
stop_record response 必须需包含示例中的所有字段。
101+
102+
| 字段 | 含义 | 备注 |
103+
|-------------|--------------------------------------|--------------------------------------------------------------------------------------------------|
104+
| success | 停止录制是否成功 | 不可为空 |
105+
| type | 是否需要上传录制的包 | 不可为空,type 的值为以下之一:<br/> "NORMAL": 需要把生成的bag上传<br/>"SKIP_CAPTURE":采集出现问题(e.g.: 未能通过bag质量检测),不需要上传 |
106+
| message | success 为 false时, 用于返回 error message | 可以为空 |
107+
| record_name | 指定平台记录的名称 | 如果record_name=="", 则使用默认 record 名称 "deviceSN-startTime" |
108+
| tags | 对 record 添加的 tag | 可以为空 |
109+
| files | 需要上传的文件列表 | 不可为空 |
110+
111+
**response示例:**
112+
```json
113+
{
114+
"success": true,
115+
"type": "NORMAL",
116+
"message": "采集成功",
117+
"record_name": "",
118+
"tags": ["01", "02"],
119+
"files": [
120+
"/home/cos/bags/1.bag",
121+
"/home/cos/bags/2.bag",
122+
"/home/cos/bags/3.bag"
123+
]
124+
}
125+
```
126+
127+
128+
54129
- 启动 coBridge 前需 source **数据录制节点** 的 workspace 环境变量。
55130
- 示例启动脚本(请根据实际情况修改):
56131
```bash

docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ const config = {
9696
{ href: 'https://www.coscene.cn', label: '官方网站', position: 'right' },
9797
{ href: 'https://github.com/coscene-io', label: 'GitHub', position: 'right' },
9898
{
99-
href: 'https://petstore.swagger.io/?url=https://coscene-download.s3.us-east-1.amazonaws.com/openapi/openapi.yaml',
99+
href: 'https://petstore.swagger.io/?url=https://download.coscene.cn/openapi/openapi.yaml',
100100
label: 'OpenAPI',
101101
position: 'right',
102102
},

0 commit comments

Comments
 (0)