zy上云api


服务

<p>[TOC]</p> <h4>无人机</h4> <h5>起飞 (takeoff)</h5> <ol> <li>服务描述 takeoff 服务用于控制无人机起飞。该服务是同步调用(sync),调用后会立即返回结果。</li> <li>请求格式 请求消息中需要包含服务标识符 takeoff,并携带必要的消息头信息。由于 takeoff 服务没有输入参数,因此请求体可以为空。</li> </ol> <table> <thead> <tr> <th>参数</th> <th>类型</th> <th>描述</th> <th>是否必传</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>height</td> <td>float</td> <td>-起飞高度</td> <td>是</td> <td>大于0 m)</td> </tr> </tbody> </table> <p>示例请求</p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;takeoff&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;height&amp;quot;: 100 }, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <ol> <li> <p>响应格式 响应消息中包含服务调用的结果,包括返回码和错误信息(如果有的话)。 示例响应</p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <h5>降落 (autoland)</h5> </li> <li>服务描述 autoland 服务用于控制无人机自动降落。该服务是同步调用(sync),调用后会立即返回结果。</li> <li>请求格式 请求消息中需要包含服务标识符 autoland,并携带必要的消息头信息。由于 autoland 服务没有输入参数,因此请求体可以为空。 示例请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;autoland&amp;quot;, // 自动降落服务的标识符 &amp;quot;data&amp;quot;: {}, // 无输入参数 &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> <li>响应格式 响应消息中包含服务调用的结果,包括返回码和错误信息(如果有的话)。 示例响应 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <h5>无人机移动 (moveUav)</h5></li> <li>服务描述 moveUav 是一个用于通过摇杆值控制无人机移动的服务。该服务支持异步调用,调用后不会返回任何结果。移动指令通过 x, y, z, yaw 四个参数指定,分别表示无人机在三维空间中的移动方向和旋转角度。</li> <li>请求格式 请求消息中需要包含服务标识符 moveUav,并携带必要的移动参数。</li> </ol> <table> <thead> <tr> <th>参数</th> <th>类型</th> <th>描述</th> <th>是否必传</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>x</td> <td>float</td> <td>-</td> <td>是</td> <td>空传0</td> </tr> <tr> <td>y</td> <td>float</td> <td>-</td> <td>是</td> <td>空传0</td> </tr> <tr> <td>z</td> <td>float</td> <td>-</td> <td>是</td> <td>空传0</td> </tr> <tr> <td>yaw</td> <td>float</td> <td>-</td> <td>是</td> <td>空传0</td> </tr> </tbody> </table> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;moveUav&amp;quot;, // 无人机移动服务的标识符 &amp;quot;data&amp;quot;: { &amp;quot;x&amp;quot;: 5.0, &amp;quot;y&amp;quot;: 3.0, &amp;quot;z&amp;quot;: 2.0, &amp;quot;yaw&amp;quot;: 10.0, }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre> <h5>返航 (gohome)</h5> <ol> <li>服务描述 gohome 服务用于控制无人机返回预设的返航点。该服务是同步调用(sync),调用后会立即返回结果。</li> <li>请求格式 请求消息中需要包含服务标识符 gohome,并携带必要的消息头信息。由于 gohome 服务没有输入参数,因此请求体可以为空。 示例请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;gohome&amp;quot;, // 返航服务的标识符 &amp;quot;data&amp;quot;: {}, // 无输入参数 &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> <li>响应格式 响应消息中包含服务调用的结果,包括返回码和错误信息(如果有的话)。 示例响应 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>航线任务 (waylinesFlightTask)</h5> <ol> <li>服务描述 waylinesFlightTask 服务用于控制无人机执行航线任务。该服务是同步调用(sync),调用后会立即返回结果。</li> <li>请求格式 请求消息中需要包含服务标识符 waylinesFlightTask,并携带必要的消息头信息。由于 waylinesFlightTask 服务没有输入参数,因此请求体可以为空。 示例请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;waylinesFlightTask&amp;quot;, // 返航服务的标识符 &amp;quot;data&amp;quot;: {}, // 无输入参数 &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> <li>响应格式 响应消息中包含服务调用的结果,包括返回码和错误信息(如果有的话)。 示例响应 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>指点飞行(gotoPosition)</h5> <ol> <li>服务概述 gotoPosition 是一个用于控制无人机飞往指定位置的服务。通过指定目标位置的经度(longitude)、纬度(latitude)、高度(height) ,可以实现精确的定点飞行。该服务为同步调用,调用后会立即返回操作结果。</li> <li>请求格式 </li> </ol> <table> <thead> <tr> <th>参数</th> <th>类型</th> <th>描述</th> <th>是否必传</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>longitude</td> <td>double</td> <td>经度</td> <td>是</td> <td></td> </tr> <tr> <td>latitude</td> <td>double</td> <td>纬度</td> <td>是</td> <td></td> </tr> <tr> <td>height</td> <td>float</td> <td>高度</td> <td>是</td> <td>m</td> </tr> </tbody> </table> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;gotoPosition&amp;quot;, // 服务标识符 &amp;quot;data&amp;quot;: { &amp;quot;longitude&amp;quot;: 116.3974, // 目标位置的经度 &amp;quot;latitude&amp;quot;: 39.9092, // 目标位置的纬度 &amp;quot;height&amp;quot;: 100.5 // 目标位置的高度(米) }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳 }</code></pre> <p>3.2 示例响应</p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <h5>紧急停止(stopAll)</h5> <ol> <li>服务描述 stopAll 服务用于触发无人机的紧急停止操作。该服务支持指定紧急停止后的动作。服务调用后会立即返回结果,调用方式为同步(sync)。</li> <li> <p>请求格式 请求消息中需要包含服务标识符 stopAll,并携带必要的消息头信息。用于指定紧急停止后的动作。</p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;stopAll&amp;quot;, // 紧急停止服务的标识符 &amp;quot;data&amp;quot;: { }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre> </li> <li>响应格式 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <h5>前向避障</h5> <ol> <li>服务描述 打开避障开关后,具体状态 在飞机属性字段front_avoid_switch 体验出来是否打开。 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;forwardObstacle&amp;quot;, // &amp;quot;data&amp;quot;: { &amp;quot;switch&amp;quot;:false// true 打开, false 关闭 } }</code></pre> <h1>云台</h1></li> </ol></li> </ol> <h5>实况拉流(live)</h5> <ol> <li>服务描述 live 服务用于控制无人机的实况视频流操作,支持“拉流”和“停流”两种操作。该服务是同步调用(sync),调用后会立即返回结果。</li> <li>请求格式 请求消息中需要包含服务标识符 live,并携带必要的操作参数(action 和 videoId)。 请求和响应示例</li> <li>RTMP拉流请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;live&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;action&amp;quot;: &amp;quot;START&amp;quot;, &amp;quot;protocol&amp;quot;: &amp;quot;RTMP&amp;quot;, &amp;quot;videoId&amp;quot;: &amp;quot;video_001&amp;quot;, &amp;quot;streamUrl&amp;quot;: &amp;quot;rtmp://example.com/live/stream1&amp;quot; }, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> <li>GB28181拉流请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;live&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;action&amp;quot;: &amp;quot;START&amp;quot;, &amp;quot;protocol&amp;quot;: &amp;quot;GB28181&amp;quot;, &amp;quot;videoId&amp;quot;: &amp;quot;video_002&amp;quot;, &amp;quot;channelId&amp;quot;: &amp;quot;channel_001&amp;quot; }, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> <li>RTSP拉流请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;live&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;action&amp;quot;: &amp;quot;START&amp;quot;, &amp;quot;protocol&amp;quot;: &amp;quot;RTSP&amp;quot;, &amp;quot;videoId&amp;quot;: &amp;quot;video_003&amp;quot;, &amp;quot;streamUrl&amp;quot;: &amp;quot;rtsp://example.com/streaming/channels/1&amp;quot; }, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> <li>停流请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;live&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;action&amp;quot;: &amp;quot;STOP&amp;quot;, &amp;quot;protocol&amp;quot;: &amp;quot;RTMP&amp;quot;, &amp;quot;videoId&amp;quot;: &amp;quot;video_001&amp;quot; }, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> <li>响应示例 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>云台移动(moveGimbal)</h5> <ol> <li>服务概述 moveGimbal 是一个用于控制无人机云台移动的服务。通过指定云台的俯仰角(pitch)、翻滚角(roll)、偏航角(yaw) ,可以精确控制云台的运动。该服务为异步调用,且不返回任何结果。 2 示例请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;moveGimbal&amp;quot;, // 服务标识符 &amp;quot;data&amp;quot;: { &amp;quot;pitch&amp;quot;: 10.5, // 云台俯仰角 &amp;quot;roll&amp;quot;: 5.0, // 云台翻滚角 &amp;quot;yaw&amp;quot;: 20.0, // 云台偏航角 }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳 }</code></pre> <h5>实况视频源切换(liveSourcesChange)</h5></li> <li>服务概述 liveSourcesChange 是一个用于切换无人机实况视频源的服务。通过指定镜头(index)和视频源类型(sourceType),可以切换到不同的视频源(如FPV或云台)。该服务为同步调用,调用后会立即返回操作结果。</li> <li>请求格式 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;liveSourcesChange&amp;quot;, // 服务标识符 &amp;quot;data&amp;quot;: { &amp;quot;index&amp;quot;: 1, // 目前没用到 &amp;quot;sourceType&amp;quot;: &amp;quot;gimbal&amp;quot; // 视频源类型:云台 gimbal /fpv }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳 }</code></pre></li> <li>响应格式 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>变焦倍数切换 (liveZoomChange)</h5> <ol> <li>服务描述 liveZoomChange 服务用于控制视频流的变焦倍数切换。该服务允许用户指定视频 ID 和目标变焦倍数,从而调整视频流的变焦状态。该服务是同步调用(sync),调用后会立即返回结果。 2.请求格式 请求消息中需要包含服务标识符 liveZoomChange,并携带必要的消息头信息。请求体中包含两个可选参数:videoId 和 zoomFactor 示例请求 : <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;liveZoomChange&amp;quot;, // 变焦切换服务的标识符 &amp;quot;data&amp;quot;: { &amp;quot;zoomFactor&amp;quot;: 10 // 变焦倍数 }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre> <p>3.示例响应 :</p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>云台回中 (resetGimbal)</h5> <ol> <li>服务描述 resetGimbal 服务用于将无人机的云台回中。该服务是同步调用(sync),调用后会立即返回结果。由于该服务不需要输入参数,因此请求体可以为空。</li> <li>请求格式 请求消息中需要包含服务标识符 resetGimbal,并携带必要的消息头信息。由于该服务没有输入参数,请求体为空。 示例请求 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;resetGimbal&amp;quot;, // 云台回中服务的标识符 &amp;quot;data&amp;quot;: {}, // 无输入参数 &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> <li>响应格式 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>云台向下 (resetGimbalToDown)</h5> <ol> <li>服务描述 resetGimbalToDown 服务用于将无人机的云台调整到向下位置。该服务是同步调用(sync),调用后会立即返回结果。虽然接口定义中包含输入和输出字段,但这些字段似乎并未明确指定具体用途,可能表示该服务不需要额外的输入参数,且返回信息较为简单。</li> <li>请求格式 请求消息中需要包含服务标识符 resetGimbalToDown,并携带必要的消息头信息。根据接口定义,输入参数字段存在但未明确其用途,因此可以认为请求体可以为空或包含一个简单的占位符字段。 示例请求 :无参数 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;resetGimbalToDown&amp;quot;, // 云台向下服务的标识符 &amp;quot;data&amp;quot;: { &amp;quot;placeholder&amp;quot;: &amp;quot;1&amp;quot; // 占位符字段,可选 }, &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> <li>响应格式 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>开始录像 (startRecordVideo)</h5> <ol> <li>服务描述 startRecordVideo 服务用于控制设备开始录像。该服务是同步调用(sync),调用后会立即返回结果。根据接口定义,输入和输出字段似乎未明确指定具体用途,可能表示该服务不需要额外的输入参数,且返回信息较为简单。</li> <li>请求格式 请求消息中需要包含服务标识符 startRecordVideo,并携带必要的消息头信息 示例请求:无参数 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;startRecordVideo&amp;quot;, // 开始录像服务的标识符 &amp;quot;data&amp;quot;: {}, // 请求体为空 &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> <li>响应格式 <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre></li> </ol> <h5>停止录像 (stopRecordVideo)</h5> <ol> <li>服务描述 stopRecordVideo 服务用于控制设备停止录像。该服务是同步调用(sync),调用后会立即返回结果。由于该服务没有输入参数,请求体可以为空。</li> <li>请求格式 请求消息中需要包含服务标识符 stopRecordVideo,并携带必要的消息头信息。由于该服务没有输入参数,请求体为空。 示例请求 <pre><code class="language-json"> { &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, // 请求的唯一标识符 &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, // 监听响应的标识符 &amp;quot;method&amp;quot;: &amp;quot;stopRecordVideo&amp;quot;, // 停止录像服务的标识符 &amp;quot;data&amp;quot;: {}, // 请求体为空 &amp;quot;timestamp&amp;quot;: 1700000000000 // 请求发送的时间戳(毫秒) }</code></pre></li> </ol> <pre><code>3. 响应格式 ```json { &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, // 结果返回码:0 表示成功,非 0 表示失败 &amp;quot;message&amp;quot;: &amp;quot;成功&amp;quot; // 错误信息(如果失败则返回具体原因) &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <h1>传感器</h1> <h5>开始磁罗盘校准 (startMagCalibration)</h5> <ol> <li>服务描述</li> </ol> <p>启动磁罗盘校准的校准流程。该服务为同步调用,调用后立即返回校准进度。校准完成后,进度值percentage将返回100</p> <ol> <li> <p>请求格式 </p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;startMagCalibration&amp;quot;, &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> </li> <li>响应格式 持续发送 percentage 100 为校准完成</li> </ol> <pre><code class="language-json">{ &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { &amp;quot;percentage&amp;quot;: 9, &amp;quot;total&amp;quot;: 100 }, &amp;quot;message&amp;quot;: &amp;quot;success&amp;quot;, &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;timestamp&amp;quot;: 1749716131647 }</code></pre> <h5>取消磁罗盘校准 (cancelMagCalibration)</h5> <ol> <li>服务描述</li> </ol> <p>取消正在进行的IMU传感器校准流程。该服务为同步调用,调用后立即返回结果。</p> <ol> <li>请求格式</li> </ol> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;cancelMagCalibration&amp;quot;, &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <ol> <li>响应格式 <pre><code class="language-json">{ &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;: { }, &amp;quot;message&amp;quot;: &amp;quot;success&amp;quot;, &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;timestamp&amp;quot;: 1749716131647 }</code></pre></li> </ol> <h5>开始校准加速度传感器 (startAccelCalibration)</h5> <ol> <li>服务描述</li> </ol> <p>启动加速度传感器的校准流程。该服务为同步调用,调用后立即返回结果。</p> <ol> <li>请求格式</li> </ol> <p>示例请求</p> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;startAccelCalibration&amp;quot;, &amp;quot;data&amp;quot;: {}, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <ol> <li> <p>响应格式 </p> <pre><code class="language-json">{ &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;:{}, &amp;quot;message&amp;quot;: &amp;quot;success&amp;quot;, &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;timestamp&amp;quot;: 1749716131647 }</code></pre> <h5>设置加速度传感器 (stepAccelCalibration)</h5> </li> <li> <p>服务描述</p> <p>设置加速度传感器校准的具体步骤。该服务为同步调用,调用后立即返回结果。step参数范围为1-7</p> </li> <li>请求格式 </li> </ol> <pre><code class="language-json">{ &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;method&amp;quot;: &amp;quot;stepAccelCalibration&amp;quot;, &amp;quot;data&amp;quot;: { &amp;quot;step&amp;quot;: 1 }, &amp;quot;timestamp&amp;quot;: 1700000000000 }</code></pre> <ol> <li>响应格式 <pre><code class="language-json">{ &amp;quot;bid&amp;quot;: &amp;quot;9876543210&amp;quot;, &amp;quot;code&amp;quot;: 0, &amp;quot;data&amp;quot;:{}, &amp;quot;message&amp;quot;: &amp;quot;success&amp;quot;, &amp;quot;tid&amp;quot;: &amp;quot;1234567890&amp;quot;, &amp;quot;timestamp&amp;quot;: 1749716131647 }</code></pre></li> </ol>

页面列表

ITEM_HTML