巴诺扫地机api接口


扫地机地图主页

<h5>简要描述</h5> <ul> <li>匿名token</li> </ul> <h5>请求URL</h5> <ul> <li><code>http://localhost:10002/api/v1/bnclw-robot/sys/robotInfo/getRobotInfo</code></li> </ul> <h5>请求方式</h5> <ul> <li>POST</li> </ul> <h5>header头部参数</h5> <p>token: 545df4c4c45115aaf0ff5f1e2d5d01d5</p> <h5>参数</h5> <pre><code>{         &amp;quot;sno&amp;quot;: &amp;quot;8dd58f842d15c2b0&amp;quot;     }</code></pre> <h5>传入参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sno</td> <td style="text-align: left;">String</td> <td style="text-align: left;">Y</td> <td>设备号</td> </tr> </tbody> </table> <h5>返回示例</h5> <pre><code>{     &amp;quot;code&amp;quot;: 0,     &amp;quot;errMsg&amp;quot;: &amp;quot;success&amp;quot;,     &amp;quot;data&amp;quot;: {         &amp;quot;id&amp;quot;: 35,         &amp;quot;sno&amp;quot;: &amp;quot;5478fb2e1b88ecd3&amp;quot;,         &amp;quot;electricity&amp;quot;: null, &amp;quot;mapSwitch&amp;quot;: 0,         &amp;quot;washRag&amp;quot;: 10,         &amp;quot;mapId&amp;quot;: 1,         &amp;quot;name&amp;quot;: null,         &amp;quot;map&amp;quot;: {             &amp;quot;mapId&amp;quot;: 1,             &amp;quot;sno&amp;quot;: &amp;quot;5478fb2e1b88ecd3&amp;quot;,             &amp;quot;mapName&amp;quot;: null,             &amp;quot;isApply&amp;quot;: 0,             &amp;quot;type&amp;quot;: 1,             &amp;quot;map&amp;quot;: &amp;quot;protobuf的base64加密自字符串&amp;quot;,             &amp;quot;mapForbidZones&amp;quot;: [                 {                     &amp;quot;id&amp;quot;: 1,                     &amp;quot;mapId&amp;quot;: 1,                     &amp;quot;sno&amp;quot;: &amp;quot;5478fb2e1b88ecd3&amp;quot;,                     &amp;quot;name&amp;quot;: &amp;quot;test1&amp;quot;,                     &amp;quot;shape&amp;quot;: null,                     &amp;quot;points&amp;quot;: null                 }             ],             &amp;quot;mapModules&amp;quot;: [                 {                     &amp;quot;id&amp;quot;: 2,                     &amp;quot;mapId&amp;quot;: 1,                     &amp;quot;sno&amp;quot;: &amp;quot;5478fb2e1b88ecd3&amp;quot;,                     &amp;quot;name&amp;quot;: &amp;quot;test1&amp;quot;,                     &amp;quot;size&amp;quot;: null,                     &amp;quot;types&amp;quot;: null,                     &amp;quot;moduleType&amp;quot;: null,                     &amp;quot;points&amp;quot;: null                 }             ],             &amp;quot;mapRooms&amp;quot;: [                 {                     &amp;quot;id&amp;quot;: 3,                     &amp;quot;mapId&amp;quot;: 1,                     &amp;quot;sno&amp;quot;: &amp;quot;5478fb2e1b88ecd3&amp;quot;,                     &amp;quot;name&amp;quot;: &amp;quot;test&amp;quot;,                     &amp;quot;material&amp;quot;: 0,                     &amp;quot;contour&amp;quot;: null, &amp;quot;cleanAttr&amp;quot;:null                 }             ]         },         &amp;quot;plan&amp;quot;: {             &amp;quot;planId&amp;quot;: 1,             &amp;quot;sno&amp;quot;: &amp;quot;5478fb2e1b88ecd3&amp;quot;,             &amp;quot;mapId&amp;quot;: 1,             &amp;quot;isApply&amp;quot;: 1,             &amp;quot;time&amp;quot;: null,             &amp;quot;repeat&amp;quot;: &amp;quot;&amp;quot;,             &amp;quot;onOff&amp;quot;: null,             &amp;quot;name&amp;quot;: &amp;quot;123&amp;quot;         }, &amp;quot;robotRunStatus&amp;quot;: { &amp;quot;robotStatus&amp;quot;: 2, &amp;quot;time&amp;quot;: 1745477956, &amp;quot;cleanArea&amp;quot;: 7, &amp;quot;battery&amp;quot;: 85, &amp;quot;mapId&amp;quot;: 1, &amp;quot;cleanTime&amp;quot;: 8, &amp;quot;cleanPath&amp;quot;: [ 0,0,0, 0,0,1, 0,0,2, 0.325,0.009,3, 0.685,0.029,4 ], &amp;quot;robotPosition&amp;quot;: [ -0.895, 6.084, -2.445 ], &amp;quot;baseStation&amp;quot;: [ 0, 0 ], &amp;quot;action&amp;quot;: 1, &amp;quot;modelInfo&amp;quot;: { &amp;quot;action&amp;quot;: 1, &amp;quot;mapId&amp;quot;: 1, &amp;quot;type&amp;quot;: 0 } },         &amp;quot;function&amp;quot;: {             &amp;quot;id&amp;quot;: 212,             &amp;quot;sno&amp;quot;: &amp;quot;1af2f77d8281bd69&amp;quot;,             &amp;quot;timezone&amp;quot;: &amp;quot;8.0&amp;quot;,             &amp;quot;language&amp;quot;: 1,             &amp;quot;aiEvolution&amp;quot;: 0,             &amp;quot;volume&amp;quot;: 100,             &amp;quot;areaUnit&amp;quot;: &amp;quot;0&amp;quot;,             &amp;quot;createTime&amp;quot;: 1746582481000,             &amp;quot;updateTime&amp;quot;: 1747272502000,             &amp;quot;tzString&amp;quot;: &amp;quot;Asia/Shanghai&amp;quot;,             &amp;quot;realPhotosSwitch&amp;quot;: 1         } } }</code></pre> <h5>返回参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">code</td> <td style="text-align: left;">int</td> <td>Y</td> <td>状态码</td> </tr> <tr> <td style="text-align: left;">errMsg</td> <td style="text-align: left;">String</td> <td>Y</td> <td>返回信息</td> </tr> <tr> <td style="text-align: left;">data</td> <td style="text-align: left;">object</td> <td>N</td> <td>实体对象</td> </tr> </tbody> </table> <h5>data参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">sno</td> <td style="text-align: left;">String</td> <td>设备号</td> </tr> <tr> <td style="text-align: left;">operatStatus</td> <td style="text-align: left;">Int</td> <td>运行状态 1:运行清扫中;2:待机中;3:充电中,4:离线</td> </tr> <tr> <td style="text-align: left;">electricity</td> <td style="text-align: left;">Int</td> <td>电量</td> </tr> <tr> <td style="text-align: left;">mapSwitch</td> <td style="text-align: left;">Int</td> <td>多层地图开关 0关, 1开</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td>设备名</td> </tr> <tr> <td style="text-align: left;">map</td> <td style="text-align: left;">Object</td> <td>地图</td> </tr> <tr> <td style="text-align: left;">plan</td> <td style="text-align: left;">Object</td> <td>清扫方案(存在表示有默认方案)</td> </tr> <tr> <td style="text-align: left;">robotRunStatus</td> <td style="text-align: left;">Object</td> <td>设备运行状态数据</td> </tr> <tr> <td style="text-align: left;">function</td> <td style="text-align: left;">Object</td> <td>设置信息</td> </tr> </tbody> </table> <h5>robotRunStatus 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">robotStatus</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>0:离线 1:待机中  2:清洁中 3:回充中 4:充电中  5:建图中</td> </tr> <tr> </tr> <tr> <td style="text-align: left;">cleanArea</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>清扫面积 单位:㎡</td> </tr> <tr> <td style="text-align: left;">battery</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>电池电量百分比</td> </tr> <tr> <td style="text-align: left;">cleanTime</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>清扫时间 默认区间为0min—9999分钟(没有小数点,整数表示)</td> </tr> <tr> <td style="text-align: left;">cleanPath</td> <td style="text-align: left;">float[]</td> <td style="text-align: left;">N</td> <td>[x1,y1,x2,y2], //清扫路线float数组</td> </tr> <tr> <td style="text-align: left;">robotPosition</td> <td style="text-align: left;">float[]</td> <td style="text-align: left;">N</td> <td> [x,y,raw], //扫地机世界坐标x,y和方向</td> </tr> <tr> <td style="text-align: left;">baseStation</td> <td style="text-align: left;">float[]</td> <td style="text-align: left;">N</td> <td>[x,y], 基站世界坐标</td> </tr> <tr> <td style="text-align: left;">modelInfo</td> <td style="text-align: left;">Object</td> <td style="text-align: left;">N</td> <td>清扫模式信息,对应 cmd:112 开始清扫</td> </tr> </tbody> </table> <h5>map 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">mapId</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>地图ID</td> </tr> <tr> <td style="text-align: left;">mapName</td> <td style="text-align: left;">String</td> <td style="text-align: left;">Y</td> <td>地图名</td> </tr> <tr> <td style="text-align: left;">map</td> <td style="text-align: left;">float[]</td> <td style="text-align: left;">Y</td> <td>地图数据</td> </tr> <tr> <td style="text-align: left;">mapForbidZones</td> <td style="text-align: left;">List</td> <td style="text-align: left;">Y</td> <td>禁区</td> </tr> <tr> <td style="text-align: left;">mapModules</td> <td style="text-align: left;">List</td> <td style="text-align: left;">Y</td> <td>地图组件</td> </tr> <tr> <td style="text-align: left;">mapRooms</td> <td style="text-align: left;">List</td> <td style="text-align: left;">Y</td> <td>房间</td> </tr> </tbody> </table> <h5>mapForbidZones 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>ID</td> </tr> <tr> <td style="text-align: left;">mapId</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>地图ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">N</td> <td>禁区名</td> </tr> <tr> <td style="text-align: left;">shape</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>0:线型 1:矩形</td> </tr> <tr> <td style="text-align: left;">points</td> <td style="text-align: left;">float[]</td> <td style="text-align: left;">Y</td> <td>轮廓点世界坐标</td> </tr> </tbody> </table> <h5>mapModules 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>ID</td> </tr> <tr> <td style="text-align: left;">mapId</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>地图ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">N</td> <td>禁区名</td> </tr> <tr> <td style="text-align: left;">points</td> <td style="text-align: left;">String</td> <td style="text-align: left;">Y</td> <td>float[]矩形地毯4个顶点世界坐标一组,支持多组</td> </tr> <tr> <td style="text-align: left;">types</td> <td style="text-align: left;">String</td> <td style="text-align: left;">Y</td> <td>属性数组</td> </tr> <tr> <td style="text-align: left;">moduleType</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>1:门槛条,2:地毯</td> </tr> </tbody> </table> <h5>mapRooms 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">id</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>ID</td> </tr> <tr> <td style="text-align: left;">mapId</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>地图ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">N</td> <td>名字</td> </tr> <tr> <td style="text-align: left;">contour</td> <td style="text-align: left;">float[]</td> <td style="text-align: left;">Y</td> <td>轮廓点世界坐标</td> </tr> <tr> <td style="text-align: left;">material</td> <td style="text-align: left;">Int</td> <td style="text-align: left;">Y</td> <td>0:瓷砖 1:大理石 2:木地板 3:地毯</td> </tr> <tr> <td style="text-align: left;">cleanAttr</td> <td style="text-align: left;">String</td> <td style="text-align: left;">N</td> <td>指定房间清扫参数(对应cmd:112 room节点数据格式)</td> </tr> </tbody> </table> <h5>plan 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th style="text-align: left;">是否必须</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">planId</td> <td style="text-align: left;">Long</td> <td style="text-align: left;">Y</td> <td>方案ID</td> </tr> <tr> <td style="text-align: left;">name</td> <td style="text-align: left;">String</td> <td style="text-align: left;">N</td> <td>名字</td> </tr> </tbody> </table> <h5>function 参数说明</h5> <table> <thead> <tr> <th style="text-align: left;">参数名</th> <th style="text-align: left;">类型</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td style="text-align: left;">areaUnit</td> <td style="text-align: left;">int</td> <td>面积显示单位</td> </tr> </tbody> </table> <h5>备注</h5> <ul> <li>code码请看目录 项目描述——全局报文说明 更多返回错误代码请看首页的错误代码描述</li> </ul>

页面列表

ITEM_HTML