ghcr.io/open-rmf/rmf-web/api-server:testing-jazzy-nightly

RMF Web

Open-RMF Web 是一组软件包，为用户提供基于 Web 的界面，用于可视化和控制 Open-RMF 部署的各个方面。

• 快速开始（使用 Docker）
• 从源代码开始
• API 服务器
• API 客户端
• RMF 仪表板框架
• 配置
• 贡献指南
• 路线图

Quick start with docker

这些 Docker 镜像在试用 rmf_demos 时非常有用。

rmf_demos使用主机网络访问启动演示仪表板，并相应配置 RMF_SERVER_URL 和 TRAJECTORY_SERVER_URL。演示仪表板默认将在 localhost:3000 上可访问。

docker run \
--network host -it --rm \
-e RMF_SERVER_URL=http://localhost:8000 \
-e TRAJECTORY_SERVER_URL=ws://localhost:8006 \
ghcr.io/open-rmf/rmf-web/demo-dashboard:jazzy-nightly

[!NOTE] 演示仪表板假设 API 服务器在本地默认端口上托管。

使用主机网络访问启动 API 服务器，并设置正确的 ROS_DOMAIN_ID 和 ROS 2 RMW 实现（当前镜像已安装并支持 rmw_fastrtps_cpp 和 rmw_cyclonedds_cpp），这些将在 Open-RMF 系统的其他部分中使用。API 服务器将使用默认端口 localhost:8000。

docker run \
--network host -it --rm \
-e ROS_DOMAIN_ID= \
-e RMW_IMPLEMENTATION= \
ghcr.io/open-rmf/rmf-web/api-server:jazzy-nightly

# Use the appropriate tag for different ROS 2 distributions

[!NOTE] 用户也可以通过挂载配置文件并设置环境变量 RMF_API_SERVER_CONFIG 来配置 API 服务器。在默认情况下，API 服务器将使用内部非持久化数据库。

RMF_API_SERVER_CONFIG

• 如果地图楼层的平面图未加载，请检查并确认已使用 traffic-editor 或 rmf_site 在 .building.yaml 中为楼层添加了墙壁。仪表板使用包含所有墙壁顶点的边界框创建渲染场景边界，因此如果没有墙壁顶点，场景边界将无效，导致楼层无法渲染。

检查该问题是否已被报告或修复。

• 有关一般贡献指南，请参见 CONTRIBUTING。
• 遵循 https://basarat.gitbook.io/typescript/styleguide。
• 在 rmf-dashboard-framework 中引入新功能时，请尽可能编写测试以及 e2e 测试。
• 在通过 api-server 引入 API 变更时，
  • 如果新变更要在外部使用（例如在 Web 包之外，与其他 Open-RMF 包一起使用），请先修改 https://github.com/open-rmf/rmf_api_msgs，然后使用修改后的提交哈希通过 此脚本 生成所需模型。
  • 不要忘记按照 这些说明 使用新添加的变更更新 API 客户端。
• 查看最新的 API 定义请访问 https://open-rmf.github.io/rmf-web/，或访问运行服务器 URL 的相对路径 /docs，例如 http://localhost:8000/docs。
• 使用 storybook 开发前端，无需启动任何 Open-RMF 组件。
• 有关与新设备/基础设施的集成，请查看 Robot Interaction Objects (RIO)。
• 在开发过程中同步更新文档，并在必要时更新 https://osrf.github.io/ros2multirobotbook。

配置

• 有关 API 服务器运行时配置，请参见 api-server 文档。
• rmf-dashboard-framework 允许您轻松构建仪表板。

故障排除

• 如果某个功能缺失或无法正常工作，它可能仅在 Open-RMF 源码构建中可用，而不在二进制文件中。尝试从源码构建 Open-RMF，并在启动 API 服务器之前设置新工作区的环境变量。rmf-web 可能使用 Open-RMF 的开发中功能。

• 在运行模拟的 Open-RMF 部署时，从 Web 仪表板创建任务需要任务开始时间与模拟时间匹配，模拟时间从 unix 毫秒 0 开始。尝试创建开始日期在 1970 年之前的相同任务。

• 如果地图层级的平面图未加载，请检查并确认已使用 traffic-editor 或 rmf_site 在 .building.yaml 中为层级添加了墙壁。仪表板使用包含所有墙壁顶点的边界框来创建渲染的场景边界，因此如果没有墙壁顶点，场景边界将无效，导致楼层无法渲染。

• 检查该问题是否已 https://github.com/open-rmf/rmf-web/issues。