Web端操作说明手册.md 21.1 KB

Web端操作说明手册

1. 文档说明

本文档基于当前 Web 端代码结构整理,用于说明系统主要功能模块、典型操作流程和使用注意事项,适合作为项目交付后的基础操作手册。

适用对象:

  • 系统管理员
  • 实施与运维人员
  • 调度与监控人员
  • 现场测试人员

系统定位:

  • 本系统是面向 AGV/AMR 机器人业务的后台管理平台,核心能力包括地图管理、机器人管理、动作与任务模板配置、任务调度、储位管理、充电桩管理、监控调度、疲劳测试和日志下载。

2. 系统功能总览

根据当前菜单与路由,Web 端主要包含以下业务模块:

2.1 数据监控

  • 数据监控:地图实时监控、机器人状态查看、任务下发、库位释放、机器人控制

2.2 模型搭建

  • 地图管理
  • 机器人管理
  • 动作配置
  • 请求配置
  • 任务模板
  • 储位类型
  • 储位管理
  • 充电桩管理

2.3 任务调度

  • 任务管理
  • 任务历史

2.4 系统工具

  • 疲劳测试
  • 日志下载

2.5 其他页面

  • 登录页
  • 移动端任务创建页
  • 设置 / 偏好等辅助页面

3. 推荐使用顺序

如果是首次上线或新项目初始化,建议按以下顺序完成基础数据建设:

  1. 配置请求配置
  2. 配置动作配置
  3. 配置储位类型
  4. 配置地图基础信息
  5. 进入地图画布维护节点、连线、资源和背景图
  6. 配置机器人基础资料
  7. 配置充电桩
  8. 配置任务模板
  9. 在监控页或任务管理页创建任务并联调

说明:

  • 任务模板依赖动作配置与请求配置。
  • 地图监控、任务调度依赖地图、机器人、储位等基础数据已配置完成。
  • 疲劳测试依赖地图、机器人和库位均已可用。

4. 登录与进入系统

4.1 登录

操作步骤:

  1. 打开系统登录页。
  2. 输入用户名和密码。
  3. 点击“登录”进入系统。

说明:

  • 系统提供“保持登录”选项。
  • 若使用移动设备访问,系统会自动跳转到移动端任务创建界面。

5. 数据监控

数据监控页是调度员和运维人员最常使用的页面,支持实时查看地图、机器人状态和执行现场操作。

5.1 页面主要功能

  • 选择监控地图
  • 查看节点数、连线数
  • 实时显示机器人位置与状态
  • 选择起点、终点或终点区域后直接下发任务
  • 对机器人执行复位、暂停/恢复、取消任务、重定位
  • 对库位执行释放操作
  • 开启或关闭异常语音播报

5.2 切换地图

操作步骤:

  1. 进入“数据监控”页面。
  2. 在页面顶部选择地图。
  3. 系统加载当前地图、机器人和库位状态。

说明:

  • 未选择地图时,页面只显示提示信息,不显示监控画布。
  • 切换地图后,系统会重新连接当前地图对应的实时数据订阅。

5.3 在监控页创建任务

操作步骤:

  1. 先在地图上选择起点节点。
  2. 再选择终点节点,或选择终点区域。
  3. 点击“执行任务”。

说明:

  • 若未选择起点,系统会提示先选择起点。
  • 若未选择终点节点或终点区域,系统会提示补全目标。
  • 任务创建成功后,页面会清除当前任务选中状态。

5.4 查看并控制机器人

操作步骤:

  1. 点击地图中的机器人,或点击右侧机器人状态卡片。
  2. 页面会弹出机器人操作面板。
  3. 可执行以下操作:
    • 复位
    • 暂停
    • 恢复
    • 取消任务
    • 重定位

说明:

  • 机器人离线时,这些控制按钮会被禁用。
  • 暂停与恢复为同一组切换操作,按钮名称会随状态变化。

5.5 机器人重定位

操作步骤:

  1. 在机器人操作面板点击“重定位”。
  2. 在地图上点击目标位置,或点击资源区域中心点。
  3. 在重定位面板设置方向角度。
  4. 点击“确认重定位”。

说明:

  • 重定位模式下,画布会进入十字定位状态。
  • 系统支持快捷角度按钮,便于快速设定常用朝向。

5.6 库位释放

操作步骤:

  1. 在监控地图中点击带库位的节点。
  2. 打开库位选择器。
  3. 选中某个库位后,可点击“释放库位”按钮执行释放。

说明:

  • 只有非空闲且非禁用的库位才允许释放。
  • 单个节点下若存在多个库位,系统会按层号排序显示。

5.7 异常语音播报

页面支持机器人异常语音播报功能。

操作方式:

  1. 在监控页右侧或顶部找到语音播报开关。
  2. 打开后,系统在检测到新的异常机器人时会进行中文语音提醒。

说明:

  • 该功能依赖浏览器 speechSynthesis 能力。
  • 更适合监控大屏、调度席或值守环境使用。

6. 地图管理

地图管理分为两部分:

  • 地图列表页:维护地图基础信息
  • 地图画布页:维护节点、连线、资源和背景图

6.1 地图列表管理

可执行操作:

  • 新增地图
  • 编辑地图
  • 删除地图
  • 批量删除
  • 复制地图
  • 进入画布
  • 刷新列表
  • 重置筛选

6.2 新增或编辑地图

主要字段:

  • 地图名称
  • 地图编码
  • 版本
  • 地图类型
  • 描述
  • 地图资源 URL
  • 是否定时获取资源
  • 地图点位 URL
  • 是否定时获取点位
  • 同步间隔
  • 是否启用

说明:

  • 地图类型包括“拓扑地图”和“雷达地图”。
  • 若已存在地图 ID,资源 URL 和点位 URL 旁支持单独“同步”按钮。
  • 可分别开启资源自动同步与点位自动同步。

6.3 复制地图

适用场景:

  • 新产线与既有地图结构类似
  • 需要快速复制一套地图进行二次改造

操作步骤:

  1. 在地图列表点击“复制”。
  2. 确认后生成一份新地图记录。
  3. 再进入画布页做差异化修改。

6.4 进入地图画布

在地图列表点击“画布”进入地图编辑器。

地图编辑器主要功能包括:

  • 选择 / 框选节点
  • 框选线段
  • 平移画布
  • 新增加点
  • 连线
  • 创建圆弧
  • 批量生成切线圆弧
  • 双向连线
  • X 方向连线
  • Y 方向连线
  • 批量修改节点
  • 批量编辑连线
  • 复制并平移
  • 平移选中元素
  • 导入背景图
  • 设置背景图比例、透明度、旋转、偏移
  • 清除背景图
  • 撤销
  • 放大 / 缩小 / 重置视图
  • 获取机器人坐标生成或更新节点
  • 导出节点 CSV
  • 导入节点 CSV
  • 下载节点导入模板
  • 保存地图

6.5 地图编辑器常见操作

6.5.1 新增节点

  1. 进入画布页。
  2. 切换到“加点”模式。
  3. 在画布上点击目标位置。
  4. 在右侧配置节点属性并保存。

可维护属性示例:

  • 节点编码
  • 节点类型
  • 储位类型
  • 坐标 X / Y
  • 朝向
  • 是否允许旋转
  • 是否允许倒车进入
  • 最大坐标偏移
  • 最大角度偏差
  • 最大速度

6.5.2 节点与连线编辑

  1. 切换到“选择”或框选模式。
  2. 选中单个节点或连线。
  3. 在右侧属性面板修改参数。
  4. 点击“保存”。

6.5.3 批量编辑

适用场景:

  • 批量修改节点类型
  • 批量修改储位类型
  • 批量调整速度、朝向、旋转允许策略

操作步骤:

  1. 先框选多个节点或线段。
  2. 打开“批量修改”或“批量编辑连线”面板。
  3. 录入要统一应用的参数。
  4. 点击“应用”。

6.5.4 复制和平移

适用场景:

  • 规则地图区域快速复用
  • 成组节点和连线整体偏移

操作方式:

  1. 选中目标节点或一组节点。
  2. 打开“复制”或“平移”面板。
  3. 输入 X / Y 偏移量。
  4. 确认执行。

说明:

  • 偏移量不能同时为 0。
  • 复制操作会生成新的节点与相关连线数据。

6.5.5 导入 / 导出节点 CSV

支持能力:

  • 下载节点导入模板
  • 导出当前地图节点
  • 批量导入节点

适用场景:

  • 现场测绘数据批量导入
  • 节点属性离线整理后再导回系统

6.5.6 获取机器人坐标

用途:

  • 根据现场机器人当前位置快速创建高速点
  • 用机器人当前坐标更新已有节点位置

操作方式:

  1. 选中一个节点,或不选中节点。
  2. 点击“获取机器人坐标”。
  3. 选择机器人。
  4. 系统自动创建节点或更新节点坐标。

6.6 地图编辑注意事项

  • 离开画布前必须先保存,否则未保存修改会丢失。
  • 背景图仅用于辅助对齐,不等同于地图业务数据。
  • 批量编辑、批量圆弧和 CSV 导入属于高影响操作,建议先在测试地图验证。

7. 机器人管理

机器人管理用于维护机器人主数据、运行参数和缓存储位配置。

7.1 列表支持功能

  • 新增
  • 编辑
  • 删除
  • 批量删除
  • 刷新
  • 重置筛选

7.2 机器人基础字段

主要包含以下分组:

  • 出厂信息
  • 基础参数
  • 能力规格
  • 设备姿态
  • 运动状态
  • 缓存储位

7.3 新增或编辑机器人

主要字段示例:

  • 机器人编码
  • 机器人名称
  • 机器人类型
  • 制造商
  • 序列号
  • 版本
  • 型号
  • 协议名称
  • 协议版本
  • 协议类型
  • IP 地址
  • 端口
  • MAC 地址
  • 坐标换算系数
  • 转弯半径
  • 安全距离
  • 运动中心到货位边缘间距
  • 运动类型
  • 最大载重
  • 最大 / 最小速度
  • 最大加速度 / 最大减速度
  • 宽度、长度、最小高度、最大高度
  • 当前地图
  • 当前节点 / 坐标 / 角度
  • 状态、在线状态、操作模式、电量
  • 是否行驶中、是否暂停、是否充电中

说明:

  • 机器人类型当前包括“潜伏 AGV”和“叉车 AGV”。
  • 协议类型包括“VDA5050”和“自定义”。
  • 错误信息支持一键复制到剪贴板,便于排障。

7.4 缓存储位维护

机器人支持配置缓存储位明细,字段包括:

  • 储位编码
  • 容器 ID
  • 物料编码
  • 物料名称
  • 数量
  • 重量
  • 备注

适用场景:

  • 维护机器人车体缓存位
  • 跟踪机器人当前装载情况

8. 动作配置

动作配置用于定义机器人可执行的业务动作,是任务模板的重要前置配置。

8.1 支持功能

  • 新增
  • 编辑
  • 删除
  • 批量删除
  • 刷新
  • 重置筛选
  • 查看详情

8.2 动作配置主要字段

  • 动作类别
  • 制造商
  • 机器人类型
  • 动作名称
  • 动作类别名称
  • 描述
  • 执行范围
  • 阻塞类型
  • 是否启用
  • 排序
  • 备注

动作类别示例:

  • 取货
  • 放货
  • 充电
  • 货叉高度调整
  • 托盘探测
  • 其他自定义动作

阻塞类型说明:

  • NONE:允许运行时执行,也允许与其他动作同时进行
  • SOFT:不允许运行时执行,但允许与其他动作同时进行
  • HARD:不允许运行时执行,也不允许与其他动作同时执行

8.3 动作参数配置

每个动作可维护参数列表,字段包括:

  • 参数名称
  • 值类型
  • 来源类型
  • 来源路径
  • 默认值
  • 值约束
  • 是否必填
  • 排序
  • 描述
  • 备注

参数来源类型包括:

  • 常量值
  • 从任务对象获取
  • 从机器人对象获取
  • 从路径对象获取
  • 从节点对象获取
  • 从边对象获取
  • 从自定义上下文获取

使用建议:

  • 参数设计尽量标准化,避免同类动作因命名不一致导致模板复用困难。

9. 请求配置

请求配置用于维护外部接口调用模板,常用于动作执行过程中的前置请求、后置请求或状态确认。

9.1 支持功能

  • 新增
  • 编辑
  • 删除
  • 批量删除
  • 刷新
  • 重置筛选

9.2 主要字段

  • 动作名称
  • 请求方式
  • 请求地址
  • 请求参数
  • 重复次数
  • 间隔时间(ms)
  • 等待响应类型
  • 响应验证规则
  • 描述
  • 扩展属性
  • 是否启用

适用场景:

  • 取货申请
  • 放货完成回传
  • 外部设备状态确认
  • 业务系统联动通知

使用建议:

  • 请求参数建议统一为 JSON 格式。
  • 若配置重复次数和等待响应,需确认目标接口具备幂等性。

10. 任务模板

任务模板用于定义任务执行流程,支持把移动步骤、节点动作、路线动作、请求动作组织为完整模板。

10.1 支持功能

  • 新增
  • 编辑
  • 删除
  • 批量删除
  • 复制模板
  • 刷新
  • 重置筛选

10.2 模板基础字段

  • 模板编码
  • 模板名称
  • 机器人类型
  • 制造商
  • 描述
  • 是否启用
  • 是否默认模板

10.3 任务流程画布说明

任务模板编辑器采用流程画布方式配置。

核心机制:

  • 左侧拖拽“移动”步骤到画布,创建任务主流程
  • 再将动作拖拽到步骤中的“节点前置点”“路线”“节点”等位置
  • 在右侧属性面板维护步骤属性、动作属性和请求逻辑

10.4 常见操作流程

10.4.1 新建模板

  1. 点击“添加”。
  2. 先填写模板基本信息。
  3. 进入流程画布。
  4. 先拖入一个或多个“移动”步骤。
  5. 根据需要拖入节点动作、路线动作。
  6. 在右侧属性区域补全步骤名、描述、阻塞类型、前后置请求等信息。
  7. 保存模板。

10.4.2 配置移动步骤

移动步骤可包含:

  • 节点前置点
  • 路线
  • 节点

可配置属性示例:

  • 步骤名称
  • 节点值
  • 动作结束后策略
  • 前置请求
  • 后置请求
  • 描述

10.4.3 配置动作

动作可配置内容包括:

  • 动作名称
  • 阻塞类型
  • 描述
  • 请求地址与请求参数
  • 重复次数
  • 间隔时间
  • 返回值验证规则

10.5 使用注意事项

  • 系统要求先创建移动步骤,再挂载动作。
  • 某些动作只允许挂载在节点,不允许挂载在线路上。
  • 模板复制后建议重新检查默认参数和请求地址,避免直接复用到错误业务场景。

11. 储位类型

储位类型用于定义货架 / 储位的标准模型,为地图节点和具体储位提供类型基础。

11.1 支持功能

  • 新增
  • 编辑
  • 删除
  • 批量删除
  • 刷新
  • 重置筛选

11.2 主要字段

  • 类型编码
  • 类型名称
  • 机器人型号
  • 货架类型
  • 层数
  • 层编号起始值
  • 基础层高
  • 层高
  • 货架宽度
  • 货架深度
  • 单层最大承重
  • 是否需要顶升
  • 顶升高度
  • 取货申请请求配置
  • 取货完成请求配置
  • 放货申请请求配置
  • 放货完成请求配置
  • 是否启用
  • 是否默认
  • 是否混线货架任务互斥

适用场景:

  • 对不同货架规格进行标准化建模
  • 将请求配置与储位作业流程关联

12. 储位管理

储位管理页面当前以列表查询为主,用于查看储位基础信息和状态。

12.1 支持功能

  • 刷新
  • 重置筛选

12.2 主要字段

  • 储位编码
  • 储位名称
  • 区域编码 / 区域名称
  • 储位类型编码 / 名称
  • 地图节点编码
  • 层号
  • 朝向
  • 状态
  • 是否启用
  • 宽度 / 深度 / 高度
  • 最大承重
  • 创建时间

状态说明:

  • 空闲
  • 占用
  • 预留
  • 禁用

说明:

  • 页面主要用于查询和监控。
  • 释放库位操作目前主要在“数据监控”页完成。

13. 充电桩管理

充电桩管理用于维护充电设备和自动回充策略。

13.1 支持功能

  • 新增
  • 编辑
  • 删除
  • 批量删除
  • 刷新
  • 重置筛选

13.2 主要字段

  • 充电桩编码
  • 充电桩名称
  • IP 地址
  • 端口
  • 最短充电时长
  • 充满阈值
  • 支持机器人型号
  • 绑定机器人
  • 绑定充电点
  • 是否允许任务中断
  • 自动开始阈值
  • 恢复阈值
  • 最大充电时长
  • 排队超时
  • 优先级
  • 是否启用

使用建议:

  • 自动开始阈值、恢复阈值、最大充电时长需与现场策略统一。
  • 端口必须大于 0。

14. 任务管理

任务管理用于人工创建任务、查看任务状态,并处理失败或异常任务。

14.1 支持功能

  • 新增任务
  • 删除任务
  • 刷新
  • 重置筛选
  • 查看子任务
  • 编辑任务
  • 重试任务
  • 手动完成任务
  • 执行子任务

14.2 新建任务

操作步骤:

  1. 进入“任务管理”。
  2. 点击“添加任务”。
  3. 录入任务名称。
  4. 选择任务模板。
  5. 选择起点。
  6. 选择终点类型:
    • 终点节点
    • 终点区域
  7. 设置优先级。
  8. 如有需要填写货架编码。
  9. 提交保存。

说明:

  • 任务模板、机器人、库位、库区等下拉项由基础数据动态加载。
  • 当终点类型为区域时,不需要填写终点节点。

14.3 列表查看内容

页面可查看以下信息:

  • 任务编码
  • 任务名称
  • 起点 / 终点
  • 机器人编码
  • 任务模板
  • 是否暂停
  • 状态
  • 错误信息
  • 优先级
  • 货架编码
  • 来源
  • 关联单号
  • 创建时间

14.4 子任务查看

当列表中只选中一条主任务时,页面会展示该任务对应的子任务列表,通常包括:

  • 序号
  • 起点
  • 终点
  • 状态
  • 创建时间

适用场景:

  • 排查任务拆分逻辑
  • 分析任务执行卡在哪个环节

14.5 异常任务处理

当前页面支持以下处理动作:

  • 删除任务
  • 重试任务
  • 手动完成任务
  • 执行子任务

使用建议:

  • 在执行“手动完成”前,应确认现场任务确已人工闭环。
  • 若任务错误信息非空,建议优先结合机器人状态、请求配置和日志下载一起排查。

15. 任务历史

任务历史页面用于查看已归档任务或历史任务记录。

适用场景:

  • 追溯历史执行情况
  • 核对归档时间
  • 辅助问题复盘

建议关注字段:

  • 任务编码
  • 状态
  • 来源
  • 归档时间
  • 关联单号

16. 疲劳测试

疲劳测试用于反复生成任务,验证地图、机器人和储位配置在长时间连续运行下的稳定性。

16.1 支持功能

  • 保存配置
  • 启动测试
  • 停止测试
  • 删除配置

16.2 配置项

  • 选择地图
  • 选择机器人
  • 选择库位
  • 任务间隔

当前任务间隔支持多种预设毫秒值,例如:

  • 100ms
  • 500ms
  • 1000ms

16.3 使用步骤

  1. 进入“疲劳测试”页面。
  2. 选择地图。
  3. 选择一个或多个机器人。
  4. 选择至少两个库位。
  5. 设置任务间隔。
  6. 点击“保存配置”。
  7. 保存成功后再点击“启动测试”。

说明:

  • 未保存配置前不能直接启动。
  • 若配置不完整,系统会提示补全。
  • 启动后可通过状态标识查看是否处于运行中。

16.4 注意事项

  • 疲劳测试会持续生成任务,建议仅在测试环境或受控时段使用。
  • 启动前确认地图、机器人、库位均为可用状态,避免产生大量失败任务。

17. 日志下载

日志下载用于按时间范围查询并打包下载日志文件。

17.1 页面功能

  • 选择开始时间
  • 选择结束时间
  • 查询日志列表
  • 全选
  • 清除选择
  • 下载选中日志

17.2 使用步骤

  1. 进入“日志下载”页面。
  2. 选择开始时间和结束时间。
  3. 点击“查询”。
  4. 在列表中勾选需要下载的日志文件。
  5. 点击“下载选中”。

17.3 规则说明

  • 开始时间和结束时间均为必填。
  • 开始时间不能大于结束时间。
  • 若当前时间范围内没有日志文件,系统会提示无文件可下载。

适用场景:

  • 问题追溯
  • 接口异常排查
  • 机器人执行失败分析
  • 联调过程留档

18. 移动端任务创建

系统为移动设备提供独立的简化任务页面。

18.1 入口说明

  • 当系统检测到移动设备访问时,会自动跳转到移动端任务页面。
  • 路由入口为 /mobile/task-create

18.2 当前可用功能

  • 搬运任务创建
  • 库位释放
  • 中英文切换

说明:

  • 充电功能当前仍处于开发中,页面已有入口但暂未形成完整业务闭环。

18.3 搬运任务创建步骤

  1. 选择“搬运”。
  2. 选择起点库位。
  3. 选择终点类型:
    • 终点库位
    • 终点区域
  4. 选择终点。
  5. 如有需要填写优先级、货架编码。
  6. 提交任务。

18.4 移动端库位释放

  1. 进入“释放库位”功能。
  2. 输入或选择库位。
  3. 提交释放操作。

适用场景:

  • 现场操作员快速发起搬运
  • 使用手机处理库位释放这类轻量操作

19. 常见操作建议

19.1 初始化建议

  • 先做基础配置,再做联调,避免页面下拉项为空。
  • 地图、机器人、储位、动作、模板尽量使用统一编码规范。

19.2 调试建议

  • 任务无法执行时,优先检查任务模板、动作配置和请求配置。
  • 机器人控制失败时,优先检查机器人在线状态和协议通信状态。
  • 地图显示异常时,优先检查当前地图是否启用、背景图是否错位、节点和连线是否已保存。

19.3 变更建议

  • 高风险操作包括批量删除、批量编辑、地图 CSV 导入、模板复制后二次修改。
  • 正式环境修改前,建议先在测试环境验证。

20. 手册结论

当前 Web 端已经形成较完整的机器人业务后台能力,整体可以概括为:

  • 用“请求配置 + 动作配置 + 任务模板”定义执行逻辑
  • 用“地图管理 + 储位类型 + 储位管理 + 机器人管理 + 充电桩管理”维护基础对象
  • 用“数据监控 + 任务管理 + 疲劳测试 + 日志下载”支撑现场调度、测试和运维

如果后续需要对外正式交付,建议在本文档基础上继续补充以下内容:

  • 系统截图
  • 角色权限说明
  • 接口联调说明
  • 常见报错处理办法
  • 版本更新记录