@@ -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
0 commit comments