伽利略导航系统HTTP协议说明

程序实例

C# 版本

Python 版本

Java 版本

API的格式为API版本号加上对应的URL，以获取系统状态API为例，实际请求地址为/api/v1/system/status。API返回值都是json格式的数据。下面的文档将省略API前缀。API服务程序默认端口为3546。 机器人在启动后会向局域网发送UDP广播，端口为22002。通过此广播我们能够获取到局域网中的机器人基本信息。下面是一个具体的广播数据例子

{"id": "F072E1BA8162245572D2FAEEB2526C5DD916F5A0D6D0F8A14B67FA43DC501079461280B15BA5", "port": 3546, "mac": "00:e0:4c:68:6f:0f", "version": "5.0.0"}

广播数据包含了机器人ID，机器人Http服务端口号，机器人mac和机器人当前的http服务版本号。

对于Http调用的参数，GET和DELETE方法的参数放在URL query string里面。POST和PUT方法的参数放在body里面。

对于HTTP协议不熟悉的用户可以先参考这个文档

跨局域网调用API

通过伽利略网络代理我们可以实现远程跨局域网的机器人API调用

机器人远程代理设置网址

机器人远程调用说明

HTTP 服务的参数配置

http服务参数配置文件位于 /home/xiaoqiang/Documents/ros/src/galileo_api/config.json

其默认内容如下

{
    "username": "admin",
    "password": "admin",
    "allow_update": true,
    "no_token_check": true,
    "auto_charge": false,
}

token API

为了系统的安全性，在调用机器人api的时候可以加上token验证的功能。此功能默认关闭，可以通过配置http api参数打开此功能。

URL: /token

请求方式: GET

请求参数:

返回值

获取token后在调用api时可以在url参数中加入token=xxx,xxx为你的token数据。 对于POST或PUT请求，token参数可以加在url中也可以在body的json数据里面。

下面是一个调用的例子

http://192.168.0.132:3546/api/v1/system/info?token=28b1c500400611ebb805493c9303c705

其中192.168.0.132为机器人IP，28b1c500400611ebb805493c9303c705为机器人token。

系统状态API

获取系统当前状态

URL: /system/status

请求方式: GET

请求参数: 无

返回参数:

说明：系统可能处在互斥的几种状态中。通过不同的操作API系统在不同的状态间切换。只有在特定的状态下系统才能执行特定的API。

获取系统基本信息

URL: /system/info

请求方式: GET

请求参数: 无

返回参数:

说明: charge状态和galileo_status中的状态并不一样。charge状态是整个充电任务的状态而galileo status中的充电状态为局部充电任务状态。

示例返回

{
    "battery": 100,
    "camera_rgb": 19,
    "camera_depth": 29,
    "odom": 26,
    "imu": 49,
    "camera_processed": 30,
    "driver_port": false,
    "info": {
        "version": "6.1.5",
        "code_name": "chitu-noetic",
        "id": "AE13B83EE2846276882EE47A99391C89CD2EF6B6878D5D309F80755F8E3B7D15CB0CB9BEF55D",
        "mac": "00:15:00:b9:90:a6",
        "port": 3546
    },
    "charge": false,
    "loop": false,
    "slam_type": "camera"
}

注意第一次调用时，由于需要对数据统计，可能对应的数据返回为0.之后调用返回数据将为正常

获取Galileo Status

URL: /system/galileo_status

请求方式: GET

请求参数: 无

返回参数：当前的galileo status数据, galileo status是对系统整体状态的一个汇报参数。具体定义如下

例子

{
  "header": {
    "seq": 542928,
    "stamp": {
      "secs": 1624970817,
      "nsecs": 524690511
    },
    "frame_id": "map"
  },
  "navStatus": 0, // 导航服务状态，0表示没开启closed，1表示开启opened。
  "visualStatus": -1, // 视觉系统状态，-1标系视觉系统处于关闭状态，0表示没初始化uninit，1表示正在追踪tracking,2表示丢失lost,1和2都表示视觉系统已经初始化完成。
  "mapStatus": 0, // 建图服务状态，0表示未开始建图，1表示正在建图
  "gcStatus": 0, // 内存回收标志，0表示未进行内存回收，1表示正在进行内存回收
  "gbaStatus": 0, // 闭环优化标志，0表示未进行闭环优化，1表示正在进行闭环优化
  "chargeStatus": 0, // 充电状态，0 free 未充电状态, 1 charging 充电中, 2 charged 已充满，但仍在小电流充电, 3 finding 寻找充电桩, 4 docking 停靠充电桩, 5 error 错误
  "loopStatus": 0, // 是否处于自动巡检状态，1为处于，0为不处于。
  "power": 37.05362319946289, // 电源电压v。
  "targetNumID": -1, // 当前目标点编号,默认值为-1表示无效值，当正在执行无ID的任务是值为-2，比如通过Http API 创建的导航任务。
  "targetStatus": 0, // 当前目标点状态，0表示已经到达或者取消free，1表示正在前往目标点过程中working,2表示当前目标点的移动任务被暂停paused,3表示目标点出现错误error,默认值为-1表示无效值。
  "targetDistance": -1, // 机器人距离当前目标点的距离，单位为米，-1表示无效值，该值的绝对值小于0.01时表示已经到达。
  "angleGoalStatus": 1, // 目标角度达到情况，0表示未完成，1表示完成，2表示error,默认值为-1表示无效值。
  "controlSpeedX": 0, // 导航系统计算给出的前进速度控制分量,单位为m/s。
  "controlSpeedTheta": 0, // 导航系统计算给出的角速度控制分量,单位为rad/s。
  "currentSpeedX": -0.0000010095536708831787, // 当前机器人实际前进速度分量,单位为m/s。
  "currentSpeedTheta": 0.0002659947786014527,// 当前机器人实际角速度分量,单位为rad/s。
  "currentPosX": -1, // 当前机器人在map坐标系下的X坐标,此坐标可以直接用于设置动态插入点坐标
  "currentPosY": -1, // 当前机器人在map坐标系下的Y坐标
  "currentAngle": -1, // 当前机器人在map坐标系下的z轴转角(yaw)
  "busyStatus": 0 //当busy为true时系统将仍然后接收新指令，但是不会立即处理。当系统退出busy状态后再处理消息
}

获取系统日志

URL: /system/log

请求方式: GET

请求参数: 无

返回参数:

获取机器人速度

URL: /system/speed

请求方式: GET

请求参数: 无

返回参数:

说明:

机器人本体坐标系方向为，机器人正前方为x方向，机器人左方为y方向，机器人上方为z方向。y方向的速度是全向轮如麦克纳姆轮才有的。对于一般差速底盘y方向速度一直为0

遥控机器人

URL: /system/speed

请求方式: PUT

请求参数:

返回参数:

说明: 调用此API后机器人会以指定的速度移动。移动的时间是不确定的，这个由驱动器决定，一般是几秒的时间。实际开发遥控功能时可以以5Hz左右的频率调用此API。 对于6.2.1之后版本的机器人，遥控也可以通过websocket实现，这样可以极大的提高响应速度，尤其对于使用跨网访问接口。通过websocket向/cmd_vel话题发送Twist消息即可。

关闭机器人

URL: /system/shutdown

请求方式: GET

请求参数: 无

返回参数:

校正机器人陀螺仪

URL: /system/calibrate_imu

请求方式: GET

请求参数: 无

返回参数:

开始校正摄像头角度位置参数

URL: /system/calibrate_camera/start

请求方式: GET

请求参数:

说明：执行启动校准方法后需要遥控机器人在环境中运动，使其路径形成一个闭环完成闭环优化。闭环优化完成后，继续移动一段距离，然后调用提交参数方法完成参数校准。

请求参数: 无

返回参数:

取消摄像头角度位置校正参数

URL: /system/calibrate_camera/cancel

请求方式: GET

请求参数: 无

返回参数:

获取摄像头角度位置校正状态

URL: /system/calibrate_camera/status

请求方式: GET

请求参数: 无

返回参数:

提交摄像头角度位置校正参数

URL: /system/calibrate_camera/complete

请求方式: GET

说明： 只有在处于CALIBRATED状态下才能够提交标定参数

请求参数: 无

返回参数:

开始标定雷达参数

URL: /system/calibrate_laser/start

请求方式: GET

说明: 雷达校准需要在摄像头校准之后完成。开启后遥控机器人在具有明显边界的环境中移动。等待标定参数生成

返回参数:

提交雷达校正参数

URL: /system/calibrate_laser/complete

请求方式: GET

说明: 在雷达标定状态变为 CALIBRATED 之后，调用此API将生成的标定参数提交到系统内。

返回参数:

取消校准雷达参数

URL: /system/calibrate_laser/cancel

请求方式: GET

返回参数:

获取雷达校准状态

URL: /system/calibrate_laser/status

请求方式: GET

返回参数:

检查系统更新状态

URL: /system/update/check

请求方式: GET

请求参数: 无

返回参数:

开始自动更新程序

URL: /system/update/start

请求方式: GET

请求参数: 无

返回参数:

取消自动更新程序

URL: /system/update/cancel

请求方式: GET

请求参数: 无

返回参数:

获取软件更新日志

URL: /system/update/log

请求方式: GET

请求参数: 无

返回参数:

获取当前调度服务器

URL: /system/schedule_manager

请求方式: GET

请求参数: 无

返回参数: 所有schedule manager数据，其中第一个是当前的schedule manager

返回数据示例

[
  {
    "ip": "192.168.0.23",
    "update_time": 1576115449217,
    "version": "1.0.0",
    "id": "9188d590-8508-47bd-a704-d34ddb803265",
    "port": 24958
  }
]

系统自检

URL: /system/self_test

请求方式: GET

返回参数:

获取当前io电平情况

注意io仍为电平输出，获取的是输出电平的状态，并不是输入信号

URL: /system/io

请求方式: GET

请求参数: 无

返回参数:

控制当前io电平情况

URL: /system/io

请求方式: POST

请求参数:

返回参数:

获取IO扩展板电平

说明: IO扩展板有16路IO，其中8路输入8路输出

URL: /system/bw_io

请求方式: GET

请求参数: 无

返回参数:

返回数据示例

{
    "in": {
        "0": 0,
        "1": 0,
        "2": 0,
        "3": 0,
        "4": 0,
        "5": 0,
        "6": 0,
        "7": 0,
    },
    "out": {
        "0": 0,
        "1": 0,
        "2": 0,
        "3": 0,
        "4": 0,
        "5": 0,
        "6": 0,
        "7": 0,
    }
}

控制IO扩展板电平

URL: /system/bw_io

请求方式: PUT

请求参数:

返回参数:

获取机器人当前配置参数

URL: /system/config

请求方式: GET

请求参数: 无

返回参数:

5.0 以前版本返回

5.0 以后版本返回

6.6.8 增加参数

修改机器人配置

URL: /system/config

请求方式: POST

请求参数:

5.0 版本之前参数

5.0版本之后参数

返回参数:

修改后的机器人参数

5.0 以前版本返回

5.0 以后版本返回

恢复机器人默认参数

URL: /system/config

请求方式: DELETE

请求参数

返回参数:

让机器人播放语音

URL: /system/tts

请求方式: GET

请求参数:

返回参数:

说明: 机器人语音文件在第一次播放时需要联网下载，所以机器人未联网情况下无法播放新语音。成功播放后语音文件会自动缓存在机器人中，之后播放不再需要网络连接。

机器人当前是否正在播放语音

URL: /system/tts/playing

请求方式: GET

返回参数:

停止正在播放的语音

URL: /system/tts/stop

请求方式: GET

返回参数:

机器人的语音播放记录

URL: /system/tts/records

请求方式: GET

请求参数:

返回参数:

当没有package_name参数时返回的数据结构如下

示例数据:

{
    "packages": [
        "\u6653\u6653",
        "zh-cn",
        "Jenny",
        "SunHi",
        "\u5c0f\u8587",
        "xx"
    ],
    "records": [
        {
            "text": "\u6b22\u8fce\u5149\u4e34",
            "md5sum": "d5bd516c5a6827d585b1a4b08e352241",
            "tags": [
                "\u8fce\u5bbe\u6a21\u5f0f"
            ],
            "codenames": [
                "all"
            ],
            "i18n": {
                "en": "Welcome",
                "ko": "\uc548\ub155\ud558\uc138\uc694",
                "zh-cn": "\u6b22\u8fce\u5149\u4e34"
            },
            "mode": [
                "all"
            ],
            "last_active": 1663219852937,
            "active_count": 81
        },
        {
            "text": "\u5f00\u59cb\u5145\u7535",
            "md5sum": "1572fba0bf9d48b8c086b5c83f10e319",
            "tags": [
                "\u5145\u7535"
            ],
            "codenames": [
                "all"
            ],
            "i18n": {
                "en": "Start charging",
                "ko": "\ucda9\uc804 \uc2dc\uc791",
                "zh-cn": "\u5f00\u59cb\u5145\u7535"
            },
            "mode": [
                "all"
            ],
            "last_active": 1663482021699,
            "active_count": 421
        },
        ...
    ],
    "current_package": "\u6653\u6653"
}

上传语音包(语音音频文件方式)

URL: /system/tts/records

请求方式: POST

请求参数:

说明: 注意整个请求不是以json格式调用。由于需要上传语音文件，数据要通过Form的形式上传。 语音包文件要添加到Form里面。成功上传后机器人会自动切换到当前的语音包。

返回参数:

创建或替换语音包（语音压缩包方式）

URL: /system/tts/records

说明: 把之前导出的语音包文件导入机器人。注意由于需要上传文件此请求不是json格式。需要用Form方式上传。上传成功后机器人会自动切换到此语音包

请求参数:

返回参数:

替换语音文件

URL: /system/tts/records

说明: 替换机器人中特定文字对应的语音。由于需要上传语音文件所以此请求的方式不是json.数据需要通过添加到Form里面进行上传。

请求参数:

返回参数:

删除语音包

URL: /system/tts/records

请求参数:

返回参数:

重置默认语音

URL: /system/tts/records

说明：把替换的语音重置为系统默认的语音。注意重置过程机器人需要联网下载语音。所以要保证机器人联网。

请求参数:

返回参数:

获取语音修改文本

URL: /system/tts/alias

请求方式: GET

说明: 系统默认的语音可以替换成其他文字进行显示。注意替换并不会影响record记录。只是增加了一个alias记录。语音文本显示时可以判断是否有对应的alias记录，如果有则显示alias记录。

请求参数: 无

返回参数:

返回参数是一个dict，其中key是原文本，value是替换的文本

示例

{"\u4f60\u597d": "\u4f60\u597d\u554a"}

创建alias记录

URL: /system/tts/alias

请求方式: POST

说明: 这里上传的数据是所有的alias记录。上传后新数据会直接覆盖掉所有的老数据。

请求参数:

请求参数为一个dict，其中key是原文本，value是替换的文本

示例数据

{"\u4f60\u597d": "\u4f60\u597d\u554a"}

返回参数:

替换文本内容和语音

URL: /system/tts/alias

请求方式: PUT

说明: 不同于上面全覆盖的方式，这个API只会修改发生变化的文本内容。同时生成新内容对应的语音文件，自动替换旧语音文件。

请求参数:

请求参数为一个dict，其中key是原文本，value是替换的文本

返回参数:

返回参数是一个dict，其中key是原文本，value是替换的文本

迎宾模式开关

URL: /system/greeting

请求方式: PUT

说明: 迎宾模式开启后，当有人走过机器人后机器人会说欢迎光临。你也可以通过语音相关的api替换成其他语句。

请求参数:

返回参数:

获取对应话题数据

URL: /system/topic

请求方式: GET

说明: 获取对应话题的数据，自动转换成json格式进行返回。由于订阅话题需要一个时间，第一个调用可能会返回空数据。

请求参数:

返回参数:

话题对应的json数据。

获取语音模块IO电平

URL: /system/asr/io

请求方式: GET

说明: 语音模块共8个IO其中1-4是输出端口，5-8是输入端口。获取电平为获取输入端口电平。实际硬件端口序号从1开始，在程序中序号从0开始

请求参数: 无

返回参数:

设置语音模块输出端口电平

URL: /system/asr/io

请求方式: PUT

说明: 语音模块共8个IO其中1-4是输出端口，5-8是输入端口。设置电平为设置输出端口电平。实际端口序号从1开始，在程序中序号从0开始。注意设置io有频率限制，过高的设置频率会导致部分设置被丢弃失效。最高设置频率100HZ

请求参数:

请求参数是一个dict，其中key是端口号，value是电平数据。

示例数据

{
  "0": true,
  "1": true,
  "2": true,
  "3": true,
}

返回数据:

{
  "status": "ok"
}

设置语音模块输出端口PWM

URL: /system/asr/pwm

请求方式: GET

请求参数:

返回参数:

{
  "status": "ok"
}

设置语音模块输出舵机信号

URL: /system/asr/servo

请求方式: GET

请求参数:

返回参数:

{
  "status": "ok"
}

检查机器人证书

URL: /system/check_cert

请求方式: GET

请求参数: 无

返回值

{
  "status": "ok"
}

让机器人连接wifi

URL: /system/wifi

请求方式: GET

请求参数:

返回参数:

注意: wifi最后是否连接成功是以机器人能否访问互联网判断的。如果你所要连接的wifi不能连接互联网则即使机器人成功连接了wifi，此时机器人仍然会返回连接错误。

是否使用预览版程序

URL: /system/use_dev

请求方式: GET

请求参数: 无

返回参数：

设置使用预览版

URL: /system/use_dev

请求方式: PUT

请求参数:

返回参数:

是否开启跟随功能

URL: /system/tracking_mode

请求方式: GET

请求参数: 无

返回参数:

开启关闭跟随功能

URL: /system/tracking_mode

请求方式: PUT

请求参数:

获取系统音量设置

URL: /system/volume

请求方式: GET

请求参数: 无

返回参数:

设置系统音量

URL: /system/volume

请求方式: PUT

请求参数:

返回参数:

获取当前机器人是否连上互联网

URL: /system/is_online

请求方式: GET

请求参数:

无

返回参数

获取已经保存的照片文件

URL: /system/saved_images/

说明: 获取已经保存的拍照图片文件。file_timestamp为文件的时间戳，拍照完成时会返回此参数。如果想要获取所有的图片列表可以不加file_timestamp访问此接口。

请求方式：GET

请求参数: 无

返回参数:

返回图片文件。

拍照

URL: /system/saved_images

说明: 拍照并保存图片文件。图片默认保存在/home/xiaoqiang/Pictures目录下，文件名为<时间戳>.png

请求方式：POST

请求参数:

返回参数:

删除拍照文件

URL: /system/saved_images/

请求方式: DELETE

请求参数: 无

返回参数:

获取已经保存的录像文件

URL: /system/saved_videos/

说明: 获取已经保存的录像文件。file_timestamp为文件的时间戳，录像完成时会返回此参数。录像文件默认保存在/home/xiaoqiang/Videos目录下，文件名为<时间戳>.mkv。如果想要获取所有的录像列表可以不加file_timestamp访问此接口。

请求方式：GET

请求参数: 无

返回参数:

返回录像文件。

开始录像

URL: /system/saved_videos

说明: 开始录像并保存视频文件。

请求方式：POST

请求参数:

返回参数:

此API会自动创建一个包含录像动作的任务。返回参数为任务对象。

当通过任务控制API停止此任务时，录像会停止并保存文件。

删除录像文件

URL: /system/saved_videos/

请求方式: DELETE

请求参数: 无

返回参数:

滑台控制相关API

获取滑台当前位置

URL: /system/slide_pose

请求方式: GET

请求参数: 无

返回参数:

移动滑台

URL: /system/slide_move_to

请求方式: GET

请求参数:

返回参数:

返回数据示例:

{
    "id": "bff2bfb0-b2eb-42b8-9324-d86920faed83",
    "name": "slide_task",
    "loop_flag": false,
    "current_task": {
        "id": "9fe85f29-52f6-4783-b313-e812149f53aa",
        "type": "slide_action",
        "mode": 3,
        "pose": 0.5,
        "speed": 0,
        "time": 0,
        "progress": 0
    },
    "state": "WORKING",
    "sub_tasks": [
        {
            "id": "9fe85f29-52f6-4783-b313-e812149f53aa",
            "type": "slide_action",
            "mode": 3,
            "pose": 0.5,
            "speed": 0,
            "time": 0,
            "progress": 0
        }
    ],
    "progress": 0.0,
    "loop_count": 0
}

顶升机构控制API

获取当前顶升位置

URL: /system/jacking_pose

请求方式: GET

请求参数: 无

返回参数:

设置顶升位置

URL: /system/jacking_move_to

请求方式: GET

请求参数:

返回参数:

返回数据示例:

{
    "id": "bff2bfb0-b2eb-42b8-9324-d86920faed83",
    "name": "jacking_task",
    "loop_flag": false,
    "current_task": {
        "id": "9fe85f29-52f6-4783-b313-e812149f53aa",
        "type": "jacking_action",
        "mode": 3,
        "pose": 0.5,
        "speed": 0,
        "time": 0,
        "progress": 0
    },
    "state": "WORKING",
    "sub_tasks": [
        {
            "id": "9fe85f29-52f6-4783-b313-e812149f53aa",
            "type": "jacking_action",
            "mode": 3,
            "pose": 0.5,
            "speed": 0,
            "time": 0,
            "progress": 0
        }
    ],
    "progress": 0.0,
    "loop_count": 0
}

获取顶升角度

URL: /system/jacking_angle

请求方式: GET

请求参数:

返回参数:

设置顶升角度

URL: /system/jacking_angle_move_to

请求方式: GET

请求参数:

返回参数:

获取UWB跟随状态

URL: /system/uwb_track

请求方式: GET

请求参数: 无

返回参数:

启用UWB跟随功能

URL: /system/uwb_track

请求方式: PUT

请求参数:

返回参数:

获取ROS参数服务器参数

URL: /system/ros_params

请求方式: GET

请求参数:

返回参数:

设置ROS参数服务器参数

URL: /system/ros_params

请求方式: PUT

请求参数:

返回参数:

重启路由器

URL: /system/restart_router

请求方式: GET

请求参数:

返回参数:

重启机器人

URL: /system/restart_robot

请求方式: GET

请求参数: 无

返回参数:

重启novnc服务

URL: /system/restart_novnc

请求方式: GET

请求参数: 无

返回参数:

onvif 监控摄像头相关API

获取局域网内所有摄像头信息

URL: /system/onvif_cameras

请求方式: GET

请求参数: 无

返回参数:

返回数据例子

[
  {
    "ip": "192.168.0.13",
    "port": 9999
  }
]

获取特定摄像头参数

URL: /system/onvif_cameras

请求方式: GET

请求参数:

返回参数:

示例返回数据:

[{
    'Name': 'Stream_101',
    'VideoSourceConfiguration': {
        'Name': 'VideoSourceConfig_1',
        'UseCount': 2,
        'SourceToken': 'VideoSource_1',
        'Bounds': {
            'x': 0,
            'y': 0,
            'width': 2688,
            'height': 1520
        },
        '_value_1': None,
        'Extension': None,
        'token': 'VideoSourceToken_1',
        '_attr_1': {
    }
    },
    'AudioSourceConfiguration': {
        'Name': 'AudioSourceConfig_1',
        'UseCount': 4,
        'SourceToken': 'AudioSourceChannel_1',
        '_value_1': None,
        'token': 'AudioSourceConfigToken_1',
        '_attr_1': {
    }
    },
    'VideoEncoderConfiguration': {
        'Name': 'VideoEncoder_101',
        'UseCount': 1,
        'Encoding': 'H264',
        'Resolution': {
            'Width': 2688,
            'Height': 1520
        },
        'Quality': 3.0,
        'RateControl': {
            'FrameRateLimit': 25,
            'EncodingInterval': 1,
            'BitrateLimit': 6144
        },
        'MPEG4': None,
        'H264': {
            'GovLength': 50,
            'H264Profile': 'High'
        },
        'Multicast': {
            'Address': {
                'Type': 'IPv4',
                'IPv4Address': '239.0.0.1',
                'IPv6Address': None
            },
            'Port': 8860,
            'TTL': 128,
            'AutoStart': False,
            '_value_1': None,
            '_attr_1': None
        },
        'SessionTimeout': datetime.timedelta(seconds=5),
        '_value_1': None,
        'token': 'VideoEncoderToken_101',
        '_attr_1': {
    }
    },
    'AudioEncoderConfiguration': {
        'Name': 'AudioEncoderConfig_1',
        'UseCount': 4,
        'Encoding': 'G711',
        'Bitrate': 64,
        'SampleRate': 8,
        'Multicast': {
            'Address': {
                'Type': 'IPv4',
                'IPv4Address': '239.0.0.1',
                'IPv6Address': None
            },
            'Port': 8862,
            'TTL': 128,
            'AutoStart': False,
            '_value_1': None,
            '_attr_1': None
        },
        'SessionTimeout': datetime.timedelta(seconds=5),
        '_value_1': None,
        'token': 'MainAudioEncoderToken_1',
        '_attr_1': {
    }
......

获取特定摄像头视频流

URL: /system/onvif_camera/stream

请求方式: GET

请求参数:

返回参数:

返回数据示例:

{
    "stream": "rtsp://admin:SctecCam01@192.168.0.247:554/Streaming/Channels/101?transportmode=unicast&profile=Profile_101"
}

绝对位置移动监控摄像头

URL: /system/onvif_camera/move

请求方式: GET

请求参数:

返回参数:

监控摄像头移动到预置点

URL: /system/onvif_camera/goto_preset

请求方式: GET

请求参数:

返回参数:

速度模式移动监控摄像头

URL: /system/onvif_camera/move_speed

请求方式: GET

请求参数:

返回参数:

监控摄像头拍照

URL: /system/onvif_camera/snapshot

请求方式: GET

请求参数:

返回参数:

获取监控摄像头温度

说明: 需摄像头支持红外测温并且支持海康的ISAPI协议。如果没有插入用户测温点则此API返回所有返回内的温度信息。如果添加了用户测温点则返回用户测温点的温度信息。

URL: /system/onvif_camera/temperature

请求方式: GET

请求参数:

返回参数:

返回参数示例:

{
    "temperature": {
        "ThermometryRulesTemperatureInfoList": {
            "ThermometryRulesTemperatureInfo": [
                {
                    "id": 1,
                    "maxTemperature": 24.9,
                    "minTemperature": 24.0,
                    "averageTemperature": 24.5,
                    "MaxTemperaturePoint": {
                        "positionX": 0.308,
                        "positionY": 0.889
                    },
                    "MinTemperaturePoint": {
                        "positionX": 0.154,
                        "positionY": 0.93
                    },
                    "isFreezedata": false
                },
                {
                    "id": 2,
                    "maxTemperature": 24.0,
                    "minTemperature": 24.0,
                    "averageTemperature": 24.0,
                    "MaxTemperaturePoint": {
                        "positionX": 0.851,
                        "positionY": 0.321
                    },
                    "MinTemperaturePoint": {
                        "positionX": 0.851,
                        "positionY": 0.321
                    },
                    "isFreezedata": false
                }
            ]
        }
    }
}

获取监控摄像头当前位姿

URL: /system/onvif_camera/pose

请求方式: GET

请求参数:

返回参数:

文件系统操作API

注意为了系统安全，目前只开放了四个可操作的文件夹，分别是：

• /home/xiaoqiang/saved-slamdb
• /home/xiaoqiang/Videos
• /home/xiaoqiang/Pictures
• /home/xiaoqiang/slamdb

获取文件

URL: /fs/file_api

请求方式: GET

请求参数:

返回参数:

文件内容

创建文件

URL: /fs/file_api

请求方式: POST

说明: 注意path的参数放在GET里面，文件通过Form表单上传。文件参数名为file.

请求参数:

返回参数:

文件或文件夹重命名

URL: /fs/file_api

请求方式: PUT

请求参数:

返回参数:

删除文件

URL: /fs/file_api

请求方式: DELETE

请求参数:

返回参数:

获取文件夹内容

URL: /fs/dir_api

请求方式: GET

请求参数:

返回参数:

创建文件夹

URL: /fs/dir_api

请求方式: POST

请求参数:

返回参数:

删除文件夹

URL: /fs/dir_api

请求方式: DELETE

请求参数:

返回参数:

获取文件或文件夹详细信息

URL: /fs/get_file_info

请求方式: GET

请求参数:

返回参数:

复制文件或文件夹

URL: /fs/copy

请求方式: POST

请求参数:

返回参数:

批量删除文件或文件夹

URL: /fs/delete

请求方式: POST

请求参数:

返回参数:

剪切文件或文件夹

URL: /fs/cut

请求方式: POST

请求参数:

返回参数:

创建地图API

启动创建地图

URL: /map/start

请求方式: GET

说明: 接受到启动命令后系统会处于Busy状态，线程启动成功后系统进入Mapping状态。

请求参数:

返回参数:

结束创建地图线程

URL: /map/stop

请求方式: GET

说明: 接收到结束命令进入Busy状态。后先自动保存地图，然后开始关闭建图线程，线程关闭后系统进入Free状态。

请求参数: 无

返回参数

更新地图

URL: /map/update

请求方式: GET

请求参数：

返回参数:

当前机器人位置

URL: /map/pose

请求方式: GET

请求参数: 无

返回参数:

获取当前正在创建的地图信息

URL: /map/current_map_image

请求方式: GET

请求参数: 无

返回参数:

返回数据示例:

{
    "status": "OK",
    "map_params": {
        "origin": [
            -7.621091365814209,
            -9.969059944152832,
            0.0
        ],
        "width": 306,
        "resolution": 0.05000000074505806,
        "height": 324
    },
    "map_image": "/api/v1/map/current_map_png"
}

说明：机器人图片像素坐标和实际坐标的转换关系为标准的ROS地图关系。像素坐标的原点为图片左上角，x正方向向右，y正方向向下。地图坐标原点为左下角，x正方向向右，y正方向向上。转换关系如下

x_map = x_origin + x_pixel * res
y_map = y_origin + h_map * res - y_pixel * res

其中 x_map, y_map为像素点对应的地图坐标

x_origin, y_origial 为左下角原点坐标

x_pixel, y_pixel 为像素坐标

h_map为地图像素高度

保存当前创建的地图

URL: /map/current_map_image

请求方式: POST

请求参数:

返回参数:

获取当前创建地图的png图片

URL: /map/current_map_png

请求方式: GET

请求参数: 无

返回参数: 当前正在创建的地图的png图片

获取创建地图时机器人的运动轨迹

URL: /map/track

请求方式: GET

请求参数: 无

返回参数:

返回数据示例:

{
  "trajectory": [
    {
      "y": 0.3912552,
      "x": 0.3480716,
      "z": -0.0384934
    },
    {
      "y": 0.3972594,
      "x": 0.4466029,
      "z": -0.038688
    },
    {
      "y": 0.403202,
      "x": 0.5998781,
      "z": -0.0389315
    },
    ...
  ]
}

获取机器人轨迹

URL: /map/track

请求方式: GET

说明: 获取机器人轨迹只能在地图保存之后才行。

请求参数: 无

返回参数:

示例数据

{
    "trajectory": [
        {
            "x": -0.000295,
            "y": 0.0008704,
            "z": 1e-07
        },
        {
            "x": 0.000326,
            "y": 0.000888,
            "z": -9.69e-05
        },
    ]
}

导航部分

启动导航状态

URL: /navigation/start

请求方式: GET

说明： 接收到启动命令后系统会处于Busy状态，线程启动成功后系统进入Navigating状态。启动命令参数中包含导航地图文件名字。

请求参数:

返回参数

导航时开启或关闭更新地图

URL: /navigation/update_map

请求方式: PUT

说明: 在导航状态下开启或关闭更新地图。在这种情况下可以在导航移动的过程中更新地图

请求参数:

返回参数:

获取是否在导航时更新地图

URL: /navigation/update_map

请求方式: GET

说明: 获取是否在导航时更新地图

请求参数: 无

返回参数:

启动调度导航

URL: /navigation/start_schedule_mode

请求方式: GET

说明: 接收到启动命令后系统会处于Busy状态，线程启动成功后系统进入Navigating状态。此导航状态不同于普通导航状态。伽利略导航功能将不能使用，机器人将由拉格朗日调度系统控制。

请求参数: 无

返回参数:

停止导航

URL: /navigation/stop

请求方式: GET

请求参数: 无

返回参数:

停止调度导航

URL: /navigation/stop_schedule_mode

请求方式: GET

请求参数: 无

返回参数:

机器人当前位置信息

URL: /navigation/pose

请求方式: GET

请求参数: 无

返回参数:

获取当前导航正在使用的地图和路径名称

URL: /navigation/current_path

请求方式: GET

请求参数: 无

返回参数:

获取当前位置到目标点的距离

URL: /navigation/target_distance

请求方式: GET

请求参数: 无

返回参数:

获取已经保存的详细地图信息

URL: /navigation/saved_maps

请求参数: GET

请求参数:

返回参数:

获取保存的地图中的机器人运动轨迹

URL: /navigation/robot_tracks

请求方式: GET

请求参数:

返回参数:

当请求参数有map_name时

当请求参数有map_name时

返回所有地图的轨迹点列表，包含地图名称和轨迹点数据

返回数据示例:

当没有map_name参数时

[
  {
    "map_name": "map1",
    "track": [
      {
        "y": 0.0000016,
        "x": -0.0010667,
        "z": -0.0000129
      },
      {
        "y": 0.0084065,
        "x": 0.0657083,
        "z": -0.0001012
      },
      {
        "y": -0.0036619,
        "x": 0.1893717,
        "z": -0.0003028
      },
      ...
    ]
  }
]

获取目标地图的PGM图片信息

URL: /navigation/map_pgm

请求方式: GET

请求参数:

返回目标地图的pgm图片数据

获取目标地图的png图片信息

URL: /navigation/map_png

请求方式: GET

返回目标地图的png图片数据

获取当前正在使用的地图

URL: /navigation/current_map

请求方式: GET

请求参数: 无

返回参数:

上传当前机器人地图数据至调度服务器

URL: /navigation/upload_map

请求方式: GET

说明: 此方法是异步方法，调用后会在系统中创建一个上传地图数据的线程。上传进度可以通过task相关api获取。使用前一定要保证调度服务器和机器人可以正常通信，且机器人处于被激活状态。

请求参数:

返回参数:

地图上传任务数据

示例返回数据:

{
    "name": "upload_map",
    "loop_flag": false,
    "id": "8bc1e6dd-df1f-4a78-a17b-c60911ce5a06",
    "state": "WORKING",
    "sub_tasks": [
        {
            "server_id": "9188d590-8508-47bd-a704-d34ddb803265",
            "state": "WORKING",
            "result": "",
            "progress": 0,
            "type": "upload_map_action",
            "id": "e21c743d-c692-4ed2-b2be-1470da60ba1e"
        }
    ],
    "progress": 0.0,
    "current_task": {
        "server_id": "9188d590-8508-47bd-a704-d34ddb803265",
        "state": "WORKING",
        "result": "",
        "progress": 0,
        "type": "upload_map_action",
        "id": "e21c743d-c692-4ed2-b2be-1470da60ba1e"
    }
}

从调度服务器下载地图

URL: /navigation/download_map

请求方式: GET

请求参数:

返回参数:

地图下载任务数据

返回数据示例:

{
    "name": "download_map",
    "loop_flag": false,
    "id": "fb7669d2-5f03-4461-a992-95422f66d49d",
    "state": "WORKING",
    "sub_tasks": [
        {
            "server_id": "9188d590-8508-47bd-a704-d34ddb803265",
            "map_id": "04f777b8-ff9d-4303-87ac-334dab2e0ffe",
            "state": "WORKING",
            "result": "",
            "progress": 0,
            "type": "download_map_action",
            "id": "2fb7eebc-8048-47d8-b62a-60365c772f87"
        }
    ],
    "progress": 0.0,
    "current_task": {
        "server_id": "9188d590-8508-47bd-a704-d34ddb803265",
        "map_id": "04f777b8-ff9d-4303-87ac-334dab2e0ffe",
        "state": "WORKING",
        "result": "",
        "progress": 0,
        "type": "download_map_action",
        "id": "2fb7eebc-8048-47d8-b62a-60365c772f87"
    }
}

下载机器人地图

URL: /navigation/download_map_from_robot

请求方式: GET

请求参数:

返回数据: 地图文件压缩包

上传地图至机器人

URL: /navigation/upload_map_to_robot

请求方式: POST

请求参数:

注意: 此方法的上传数据不是json格式，是MultipartFormData格式

返回

开启导航任务

URL: /navigation/start_nav_task

请求方式: POST

请求参数:

说明:

当没有map和path参数时，机器人在当前地图中移动至对应坐标。如果包含map和path参数，机器人将自动寻找地图的连接点，并在移动过程中自动切换地图，最终到达目标地图中的目标点。此功能可以用来跨地图导航，比如，在不同的楼层间，不同的区域中进行导航。

返回参数:

导航任务数据

示例返回数据:

{
  "name": "navigation task",
  "loop_flag": false,
  "id": "a6858132-5e84-4d37-b968-19808dd8fd96",
  "state": "WORKING",
  "sub_tasks": [
    {
      "state": "WAITTING",
      "result": "",
      "progress": 0,
      "theta": 1.0936689376831055,
      "y": -0.1287004053592682,
      "x": -0.28466343879699707,
      "current_location": {
        "y": -1,
        "x": -1,
        "theta": -1
      },
      "type": "nav_action",
      "id": "99bfb264-8f8f-4950-940b-6f6b883e7358"
    }
  ],
  "progress": 0,
  "current_task": {
    "state": "WAITTING",
    "result": "",
    "progress": 0,
    "theta": 1.0936689376831055,
    "y": -0.1287004053592682,
    "x": -0.28466343879699707,
    "current_location": {
      "y": -1,
      "x": -1,
      "theta": -1
    },
    "type": "nav_action",
    "id": "99bfb264-8f8f-4950-940b-6f6b883e7358"
  }
}

开始自动充电

URL: /navigation/go_charge

请求方式: GET

请求参数: 无

返回参数:

返回充电任务对象

停止自动充电

URL: /navigation/stop_charge

请求方式: GET

请求参数: 无

返回参数:

移动到对应目标点

URL: /navigation/move_to_index

请求方式: GET

请求参数:

说明： 当没有map和path参数时，机器人会在当前地图上移动到目标位置。如果包含map和path参数，机器人将自动寻找地图的连接点，并在移动过程中自动切换地图，最终到达目标地图中的目标点。此功能可以用来跨地图导航，比如，在不同的楼层间，不同的区域中进行导航。

返回参数:

返回导航任务对象

取消当前导航任务

URL: /navigation/stop_nav_task

请求方式: GET

请求参数: 无

返回参数:

返回当前导航任务对象

获取导航循环任务信息

导航循环任务为沿着插入的导航点依次移动的导航任务，其效果和点击客户端上的循环选项一样。

URL: /navigation/loop_task

请求方式: GET

请求参数: 无

返回参数:

返回循环导航任务状态

开始导航循环任务

URL: /navigation/loop_task

请求方式: POST

请求参数

返回参数:

返回新创建的导航循环任务，如果已有导航循环任务则会返回错误

停止导航循环任务

URL: /navigation/loop_task

请求方式: DELETE

请求参数: 无

返回参数:

返回当前的导航循环任务

获取充电桩位置

URL: /navigation/charge_pose

请求方式: GET

请求参数: 无

返回参数:

保存充电桩位置

URL: /navigation/charge_pose

请求方式: POST

请求参数: 无

返回参数:

动态切换地图

URL: /navigation/reload

method: GET

请求参数:

说明：

此方法为动态切换地图，导航程序不会重启。所以切换速度会很快。推荐在机器人需要切换场景时使用，比如上下电梯后不同楼层地图的切换。

返回参数:

{
  "status": "ok",
  "map": "",
  "path": ""
}

获取导航路径点

URL: /navigation/path

请求方式: GET

请求参数

说明：

当同时有map_name和path_name参数的时候，返回数据为对应路径文件的内容。如下

{
  "map_name": "map1",
  "path_name": "path1",
  "path_data": "0.575 -0.356 0\n6.98246 17.95874 0\n9.969936 15.64437 0\n-2.099531 2.193034 0\n-2.099531 2.193034 0\n-2.099531 2.193034 0\n-2.099531 2.193034 0\n-3.247468 4.031781 0\n-2.099531 2.193034 0\n6.98246 17.95874 0\n6.98246 17.95874 0\n0.575 -0.356 0\n9.969936 15.64437 0\n-2.099531 2.193034 0\n-2.099531 2.193034 0\n-2.099531 2.193034 0\n-2.099531 2.193034 0\n-3.247468 4.031781 0\n-2.099531 2.193034 0\n-1.278543 -2.399499 0\n-3.247468 4.031781 0\n-2.099531 2.193034 0\n12.3693 12.11829 0\n9.969936 15.64437 0\n-1.928585 1.842135 0\n-1.278543 -2.399499 0\n-3.247468 4.031781 0\n-2.099531 2.193034 0\n12.3693 12.11829 0\n9.969936 15.64437 0\n-1.928585 1.842135 0\n-1.278543 -2.399499 0\n-6.600385 -5.06042 0\n-6.555664 -5.038059 0\n-6.510942 -5.015699 0\n-6.466221 -4.993338 0\n-6.4215 -4.970977 0\n-6.376779 -4.948617 0\n-6.332057 -4.926256 0\n-6.287336 -4.903895 0\n-6.242614 -4.881535 0\n-6.197893 -4.859174 0\n-6.153172 -4.836813 0\n-6.10845 -4.814453 0\n"
}

当只有map_name参数时，返回的数据是对应地图的所有路径名称，如下

[
    "pathY01",
    "path4"
]

当没有map_name和path_name参数时，返回的数据为所有地图和其对应的路径名称

{
    "14": [
        "pathY01",
        "path\u673a\u573a\u5230\u8fbe\u53e31\u6b63",
        "path\u673a\u573a3",
        "path\u673a\u573a\u5230\u8fbe\u53e31\u53cd",
        "path\u673a\u573a2"
    ],
    "\u58f9\u667a\u4e91\u516c\u53f8": [
        "01"
    ],
    "12": [
        "pathY01",
        "path\u673a\u573a\u5230\u8fbe\u53e31\u6b63",
        "path\u673a\u573a3",
        "path\u673a\u573a\u5230\u8fbe\u53e31\u53cd",
        "path\u673a\u573a2"
    ],
    "13": [
        "pathY01",
        "path\u673a\u573a\u5230\u8fbe\u53e31\u6b63",
        "path\u673a\u573a3",
        "path\u673a\u573a\u5230\u8fbe\u53e31\u53cd",
        "path\u673a\u573a2"
    ],
    "map5": [
        "pathY01",
        "path4"
    ]
}

上传导航路径点

URL: /navigation/path

请求方式: POST, PUT

请求参数:

说明：

路径文件内容格式为每个路径点的坐标 x y z，z一般为0，然后换行。可以参照上面API的返回值。如果对应路径已经存在则覆盖之前的路径。

返回参数:

和请求参数一致

删除导航路径点

URL: /navigation/path

请求方式: DELETE

请求参数:

说明:

注意删除路径的时候会自动删除此路径对应的导航点

返回值:

{
  "status": "ok"
}

获取导航目标点

URL: /navigation/nav_points

请求方式: GET

请求参数:

说明：

返回的path_data是导航点文件内容，其格式为 x y z theta errorX errorY direction name。其中x y z为导航点坐标，一般z为0。theta为导航点角度。errorX errorY为导航点所允许的误差。direction为循环方向，name为点的名称，可以为空。和客户端中的设置一致。

当没有传入map_name和path_name参数时，系统会自动选取上次导航的地图和路径，并返回上次导航的导航点数据。

返回参数

{
    "map_name": "map5",
    "path_name": "path4",
    "path_data": "0.575 -0.356 0 -1.117307 0.1 0.1 0\n6.98246 17.95874 0 -2.563412 0.1 0.1 0\n9.969936 15.64437 0 2.045675 0.1 0.1 0\n-2.099531 2.193034 0 -1.078226 0.1 0.1 0\n-2.099531 2.193034 0 -1.078226 0.1 0.1 0\n-2.099531 2.193034 0 -1.078226 0.1 0.1 0\n-2.099531 2.193034 0 -1.078226 0.1 0.1 0\n-3.247468 4.031781 0 -0.9649882 0.1 0.1 0\n-2.099531 2.193034 0 -1.078226 0.1 0.1 0\n6.98246 17.95874 0 -2.563412 0.1 0.1 0\n6.98246 17.95874 0 -2.563412 0.1 0.1 0\n"
}

上传导航目标点

URL: /navigation/nav_points

请求方式: POST, PUT

参数说明

说明：当map_name或path_name没有传入时，将采用当前正常使用的地图和路径最为修改对象。

返回参数:

和请求参数一致

删除导航目标点

URL: /navigation/nav_points

请求方式: DELETE

参数说明

说明：

删除导航点的时候并不会自动删除路径文件

返回值

{
  "status": "ok"
}

获取地图连接点

URL: /navigation/point_connections

请求方式: GET

请求参数: 无

返回参数:

示例数据

{
    "points": [
        {
            "x": 1.624922, // 导航点 x 坐标
            "y": -0.372011, // 导航点 y 坐标
            "theta": 0.0, // 导航点角度
            "name": "", // 导航点名称
            "map": "office", // 导航点所在地图名称
            "path": "path2", // 导航点所在地图路径
            "index": 0, // 导航点序号
            "type": "floor", // 导航点所属地图类型
            "levels": [ // 导航点所属楼层，可以为多层。和地图楼层一致
                1
            ]
        },
        {
            "x": 0.8710775,
            "y": -0.09214968,
            "theta": -0.2962013,
            "name": "",
            "map": "office",
            "path": "path2",
            "index": 1,
            "type": "floor",
            "levels": [
                1
            ]
        },
        {
            "x": -0.967,
            "y": -2.864,
            "theta": 1.570796,
            "name": "",
            "map": "out",
            "path": "path1",
            "index": 0,
            "type": "floor",
            "levels": [
                1
            ]
        },
        {
            "x": 5.470039,
            "y": -0.08699174,
            "theta": 0.0,
            "name": "",
            "map": "out",
            "path": "path1",
            "index": 1,
            "type": "floor",
            "levels": [
                1
            ]
        },
    ],
    "connections": [
        {
            "_id": {
                "$oid": "60ff74d3d78f798bc92b91d5"
            },
            // points为此连接所连接的目标点，表示可以通过一定方式在这两个点间切换
            "points": [
                {
                    "map": "office",
                    "path": "path2",
                    "index": 1,
                    "type": "floor",
                    "levels": [
                        1
                    ]
                },
                {
                    "map": "out",
                    "path": "path1",
                    "index": 0,
                    "type": "floor",
                    "levels": [
                        1
                    ]
                }
            ],
            "type": "direct",// 连接的方式，direct为直接连接, 如不同地图中的同一个位置
            // elevator为电梯连接，用于跨楼层
            "is_available": true, // 此连接是否可用，当为false时，此连接将被排除于路径规划
            "id": "a05ee41f-86d3-4588-be99-4feb776848d6"
        }
    ]
}

添加导航点连接信息

URL: /navigation/point_connections

请求方式: POST

请求参数: |参数|类型|说明| |--|--|--| |points|list|目标点信息| |type|string|连接类型，direct直接连接，表示此点为不同地图中的同一个位置。elevator电梯连接|

请求例子

{
    "points": [
        {
             "map": "office", // 目标点所在的地图
             "path": "path2", // 目标点所在的路径
             "index": 1 // 目标点的序号
         },
        {
             "map": "out",
             "path": "path1",
             "index": 0
         }
    ],
    "type": "direct" // 连接方式
}

返回参数:

和请求参数一致

返回示例

{
  "points": [
    {
      "map": "office",
      "path": "path2",
      "index": 1
    },
    {
      "map": "out",
      "path": "path1",
      "index": 0
    }
  ],
  "type": "direct",
  "is_available": true,
  "id": "a05ee41f-86d3-4588-be99-4feb776848d6",
  "_id": {
    "$oid": "60ff74d3d78f798bc92b91d5"
  }
}

删除导航点之间的连接

URL: /navigation/point_connections

请求方式: DELETE

请求参数

返回参数:

切换当前地图

注意：此切换地图API只是切换当前使用的地图文件。并不是在导航过程中切换地图。导航中切换地图可以使用/navigation/reload API

URL: /navigation/switch_map

请求方式: GET

请求参数：

返回参数

{
  "status": "ok"
}

获取忽略区域信息

URL: /navigation/skip_area

请求方式: GET

请求参数:

返回参数:

示例数据:

{
    "map_name": "\u529e\u516c\u5ba4",
    "path_name": "1",
    "skip_area": "9.89896392822266 19.9832229614258 12.0267267227173 20.9590129852295\n"
}

修改忽略信息

URL: /navigation/skip_area

请求方式: POST

请求参数:

示例数据:

{
    "map_name": "\u529e\u516c\u5ba4",
    "path_name": "1",
    "skip_area": "9.89896392822266 19.9832229614258 12.0267267227173 20.9590129852295\n"
}

返回数据:

返回数据和请求数据一致

删除忽略区域信息

URL: /navigation/skip_area

请求方式: DELETE

请求参数:

返回参数:

获取虚拟墙信息

URL: /navigation/virtual_wall

请求方式: GET

请求参数:

返回参数:

示例数据:

{
    "map_name": "\u529e\u516c\u5ba4",
    "path_name": "1",
    "virtual_wall": "5.209754 18.43822\n5.2582 18.45059\n5.306646 18.46296\n5.355093 18.47532\n5.403539 18.48769\n5.451986 18.50006\n5.500432 18.51242\n5.548879 18.52479\n5.597325 18.53716\n5.645772 18.54952\n"
}

修改虚拟墙数据

URL: /navigation/virtual_wall

请求方式: POST

请求参数:

示例数据:

{
    "map_name": "\u529e\u516c\u5ba4",
    "path_name": "1",
    "virtual_wall": "5.209754 18.43822\n5.2582 18.45059\n5.306646 18.46296\n5.355093 18.47532\n5.403539 18.48769\n5.451986 18.50006\n5.500432 18.51242\n5.548879 18.52479\n5.597325 18.53716\n5.645772 18.54952\n"
}

返回数据:

返回数据和请求数据一致

删除虚拟墙数据

URL: /navigation/virtual_wall

请求方式: DELETE

请求参数:

返回参数:

设置导航初始位置

URL: /navigation/init_pose

请求方式: POST

请求参数:

返回参数:

生成多地图导航任务（不执行）

URL: /navigation/multi_map_task

请求参数:

示例数据

{
  "from": {
    "map": "map1",
    "path": "path1",
    "index": 2,
  },
  "to": {
    "map": "map2",
    "path": "path2",
    "index": 1,
  }
}

返回参数:

返回为多地图导航任务对象

执行局部运动任务

说明: 此API会根据对应参数自动创建一个包含LocalMoveAction的任务，然后自动执行

URL: /navigation/start_local_move

请求方式: GET

请求参数:

返回参数:

返回此任务信息

执行导航和局部运动

说明: 机器人先导航至指定目标点然后执行局部运动，如导航至1号点然后倒退。机器人会自动创建包含一个导航动作和一个局部运动动作的任务。

URL: /navigation/start_nav_and_local_move

请求方式: GET

请求参数:

返回参数:

返回此任务信息

执行导航任务，局部任务，io任务

说明: 机器人先导航至指定目标点然后执行局部运动动作，然后再设置io电平。如导航到1号点然后倒退，再设置1号端口高电平。机器人会自动创建包含一个导航动作，一个局部运动动作和一个控制io动作的任务。

URL: /navigation/start_nav_local_move_io

请求方式: GET

请求参数:

返回参数:

返回此任务信息

局部移动到指定位置

说明: 调用局部移动Action,局部移动到指定位置

URL: /navigation/start_local_move_target

请求方式: GET

请求参数:

返回参数:

返回此任务信息

导航到指定目标点

说明: 调用局部移动Action,局部移动到指定目标点位置.可用于精准对接

请求方式: GET

URL: /navigation/start_local_move_index

请求参数:

返回参数:

返回此任务信息

风向传感器信息

说明: 获取风向传感器信息

请求方式: GET

URL: /navigation/wind_info

请求参数:

无

返回参数:

获取地图二维码信息

请求方式: GET

URL: /navigation/landmarks

请求参数:

返回参数:

生成覆盖路径

说明: 有些情况下需要机器人路径覆盖特定区域，比如清扫机器人。此API可以生成覆盖路径。

请求方式: POST

URL: /navigation/coverage_path

请求参数:

返回参数:

示例

请求参数
{
    "swath_angle": -3,
    "op_width": 0.5,
    "turn_radius": 0.5,
    "headland_width": 0.5,
    "border": [
        [0, 0, 0],
        [10, 0, 0],
        [10, 10, 0],
        [0, 10, 0],
        [0, 0, 0]
    ],
    "holes": [
        [
            [2, 2, 0],
            [2, 3, 0],
            [3, 3, 0],
            [3, 2, 0],
            [2, 2, 0]
        ]
    ]
}


返回参数

{
    "status": "ok",
    "path": [
        [0, 0, 0],
        [0, 0.5, 0],
        [0, 1, 0],
        [0, 1.5, 0],
        [0, 2, 0],
        [0, 2.5, 0],
        [0, 3, 0],
        [0, 3.5, 0],
        [0, 4, 0],
        [0, 4.5, 0],
        [0, 5, 0],
        [0, 5.5, 0],
        [0, 6, 0],
        [0, 6.5, 0],
        [0, 7, 0],
        ...
    ]
}

任务相关API

机器人的一个动作被定义为Action。比如移动到[1,1]点。又如播放一段声音。一系列的Action组合在一起构成一个任务即Task。通过对Action和Task进行操作，我们可以轻松的控制机器人实现一系列动作。

Task 和 Action 有以下的一些状态

WAITTING 等待执行 WORKING 正在执行 PAUSED 暂停中 CANCELLED 被取消 ERROR 错误 COMPLETE 完成

获取任务信息

URL: /task

请求方式: GET

请求参数:

返回参数:

task 数据信息

创建任务

URL: /task

请求方式: POST

请求参数:

例子:

{
    "name": "task",
    "sub_tasks": [
      {
        "type": "nav_action",
        "x": 0,
        "y": 0,
        "theta": 0
      },
      {
        "type": "nav_action",
        "x": 1,
        "y": 1,
        "theta": 1
      },
      {
        "type": "nav_action",
        "x": 2,
        "y": 2,
        "theta": 2
      },
    ],
    "loop_flag": false,
}

返回参数:

成功创建的task数据

示例返回数据

{
  "name": "test task",
  "loop_flag": false,
  "id": "47a97e4e-9327-4214-a780-fd5a2ae39ee3",
  "state": "WAITTING",
  "sub_tasks": [],
  "progress": 0,
  "current_task": null
}