diff --git a/.github/workflows/deploy-to-gh-pages.yml b/.github/workflows/deploy-to-gh-pages.yml index 91b767e54..bf2d2d234 100644 --- a/.github/workflows/deploy-to-gh-pages.yml +++ b/.github/workflows/deploy-to-gh-pages.yml @@ -35,11 +35,9 @@ jobs: - name: Build website with English locale run: | # Temporarily modify the default locale to English - sed -i 's/defaultLocale: '\''zh'\''/defaultLocale: '\''en'\''/' docusaurus.config.js - - # Uncomment and update Algolia search path for GitHub Pages deployment sed -i '/{ type: '\''localeDropdown'\'', position: '\''right'\'' }/d' docusaurus.config.js - 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 + 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 + 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' {} + 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' {} + diff --git a/docs/use-case/5-heterogeneous-robot-data-factory.md b/docs/use-case/5-heterogeneous-robot-data-factory.md index 88e0c4b5a..c097a64c1 100644 --- a/docs/use-case/5-heterogeneous-robot-data-factory.md +++ b/docs/use-case/5-heterogeneous-robot-data-factory.md @@ -50,7 +50,82 @@ sidebar_position: 5 ## 准备与启动 ROS node - 机器人本体上需要有可以提供 **service** 的**数据录制节点**,并且提供 **开始录制** (如/start_record), **取消录制** (如/cancel_record), **结束录制** (如/stop_record)之类的服务供刻行时空调用。 - -- **注意:**: 目前只支持**service** 类型的消息。 + -- **注意:** +1. /start_record service + + e.g.: + ```C++ + # request + string record_opt + --- + # response + bool success + string message + ``` + start_record request 无任何要求,可以在此处添加一些例如 `saving directory` 等字段, 供`数据录制节点`使用。 + + start_record response 必须需包含 `success` 和 `message` 字段, 用于通知 web 端是否已经成功开启了录制功能。 + +2. /cancel_record service + + e.g.: + ```C++ + # request + bool auto_remove # remove bags that are recorded + --- + # response + bool success + string message + ``` + cancel_record request 无任何要求,可以在此处添加一些例如 `auto_remove` 等字段, 供`数据录制节点`使用。 + + cancel_record response 必须需包含 `success` 和 `message` 字段, 用于通知 web 端是否已经成功取消了录制功能。 + +3. /stop_record service + + e.g.: + ```C++ + # request + --- + # response + bool success + string type + string message + string record_name + string[] tags + string[] files + ``` + stop_record request 无任何要求,可以在此处添加一些字段, 供`数据录制节点`使用。 + + stop_record response 必须需包含示例中的所有字段。 + + | 字段 | 含义 | 备注 | + |-------------|--------------------------------------|--------------------------------------------------------------------------------------------------| + | success | 停止录制是否成功 | 不可为空 | + | type | 是否需要上传录制的包 | 不可为空,type 的值为以下之一:
"NORMAL": 需要把生成的bag上传
"SKIP_CAPTURE":采集出现问题(e.g.: 未能通过bag质量检测),不需要上传 | + | message | success 为 false时, 用于返回 error message | 可以为空 | + | record_name | 指定平台记录的名称 | 如果record_name=="", 则使用默认 record 名称 "deviceSN-startTime" | + | tags | 对 record 添加的 tag | 可以为空 | + | files | 需要上传的文件列表 | 不可为空 | + +**response示例:** +```json +{ + "success": true, + "type": "NORMAL", + "message": "采集成功", + "record_name": "", + "tags": ["01", "02"], + "files": [ + "/home/cos/bags/1.bag", + "/home/cos/bags/2.bag", + "/home/cos/bags/3.bag" + ] +} +``` + + + - 启动 coBridge 前需 source **数据录制节点** 的 workspace 环境变量。 - 示例启动脚本(请根据实际情况修改): ```bash diff --git a/docusaurus.config.js b/docusaurus.config.js index 06e23c4da..731c84d87 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -96,7 +96,7 @@ const config = { { href: 'https://www.coscene.cn', label: '官方网站', position: 'right' }, { href: 'https://github.com/coscene-io', label: 'GitHub', position: 'right' }, { - href: 'https://petstore.swagger.io/?url=https://coscene-download.s3.us-east-1.amazonaws.com/openapi/openapi.yaml', + href: 'https://petstore.swagger.io/?url=https://download.coscene.cn/openapi/openapi.yaml', label: 'OpenAPI', position: 'right', },