00-简介
::: hljs-center
# 朴为科技移动机器人接口简介
:::
### 1. HTTP(S)接口
http(s)接口主要包括设备发现接口、注册登录接口、建图导航接口、地图相关操作、系统参数等接口：
设备发现：实现局域网内设备ip地址发现
注册登录：授权登录后台系统
建图导航：启动/停止建图、导航程序、导航系统状态获取
地图接口：地图保存、删除、列出、上传、下载
导航参数：导航系统最大速度、位置误差、角度误差、充电阈值获取与设置
### 2. WebSocket(ws/wss)接口
websocket接口主要用于建图导航过程中客户端和服务端数据交互过程，主要包括客户端---->服务端、服务端---->客户端的数据传输：
客户端---->服务端：包括机器初始位姿、目标点、暂停/恢复、直接控制车速度、充电/取消充电、取消、蜂鸣等消息
服务端---->客户端：包括地图数据、规划路径、系统状态、目标点列表、事件输出等消息
### 3. 使用流程
> **局域网**使用`http + ws `协议， 端口`8080`
>**广域网**使用`https + wss` 协议， 端口`443` (机器联网情况下使用我们提供的云服务)
建图流程：
1. 设备发现(已知IP可省略)
2. 登录系统
3. 启动建图
4. 建立websocket长链接
5. 移动机器人完成建图
6. 保存地图
7. 停止
导航流程：
1. 设备发现(已知IP可省略)
2. 登录系统
3. 获取地图列表
4. 选择地图
5. 启动导航
6. 建立websocket长链接
7. 设置机器初始位姿
8. 设置目标点并发送
9. 监听运行事件并处理(按照不同业务逻辑自行处理)