|
1 | | -# rmf_schedule_visualizer |
| 1 | +# Open-RMF Visualization |
2 | 2 |
|
3 | 3 |  |
| 4 | + |
4 | 5 | [](https://codecov.io/gh/open-rmf/rmf_visualization) |
5 | 6 |
|
6 | | -This repository contains several packages that aid with visualizing various entities within RMF via RViz. |
7 | | -* **rmf_visualization_building_systems**: to visualize the locations and states of lifts and doors in the facility. |
8 | | -* **rmf_visualization_fleet_states**: to visualize the location of robots from various fleets. |
9 | | -* **rmf_visualization_schedule**: to visualize the trajectories of participants in the RMF schedule database. This package also contains a websocket server that provides information on trajectories when queried. |
10 | | -* **rmf_visualization_rviz2_plugins**: Rviz plugins for customizing the view of the participant schedules and interacting with building systems. |
11 | | -* **rmf_visualization**: launch file to bring up the above systems |
| 7 | + |
12 | 8 |
|
13 | | - |
| 9 | + |
| 10 | +This repository contains several packages that aid with visualizing various entities within RMF via RViz. |
| 11 | +* [rmf_visualization](#rmfvisualization) |
| 12 | +* [rmf_visualization_building_systems](#rmfvisualizationbuildingsystems) |
| 13 | +* [rmf_visualization_fleet_states](#rmfvisualizationfleetstates) |
| 14 | +* [rmf_visualization_floorplans](#rmfvisualizationfloorplans) |
| 15 | +* [rmf_visualization_navgraphs](#rmfvisualizationnavgraphs) |
| 16 | +* [rmf_visualization_obstacles](#rmfvisualizationobstacles) |
| 17 | +* [rmf_visualization_rviz2_plugins](#rmfvisualizationrviz2plugins) |
| 18 | +* [rmf_visualization_schedule](#rmfvisualizationschedule) |
14 | 19 |
|
15 | 20 | ## Installation |
16 | 21 | It is recommended to follow the instructions [here](https://github.com/open-rmf/rmf#rmf) to setup an RMF workspace with the packages in this repository along with other dependencies. |
17 | 22 |
|
18 | | -## Run |
| 23 | + |
| 24 | +## rmf_visualization |
| 25 | +A package that contains the main [launch file](rmf_visualization/launch/visualization.launch.xml) to bringup all the visualizers. Descriptions of various configurable parameters is provided within the launch file. |
19 | 26 |
|
20 | 27 | To launch the visualizer |
21 | 28 | ``` |
22 | 29 | ros2 launch rmf_visualization visualization.launch.xml |
23 | 30 | ``` |
24 | 31 |
|
25 | | -An active `rmf_traffic_schedule` node is prerequisite for the visualizer to initialize. If a schedule node is not running, it can be started with the command |
26 | | -``` |
27 | | -ros2 run rmf_traffic_ros2 rmf_traffic_schedule |
28 | | -``` |
29 | | ->Note: Only one instance of `rmf_traffic_schedule` must be active at any moment. |
| 32 | +## rmf_visualization_building_systems |
| 33 | +A visualizer for lifts and doors in the facility. The ROS 2 node subscribes to `DoorState` and `LiftState` ROS 2 messages published over `/door_states` and `/lift_states` topics. It then publishes RViz markers depicting the location and status of these systems over `/building_systems_markers` with `Transient Local` durability. |
| 34 | + |
| 35 | +## rmf_visualization_fleet_states |
| 36 | +A visualizer for the current positions of various robot as reported by their fleet managers. The ROS 2 node subscribes to `FleetState` ROS 2 messages published over `/fleet_states`. It then publishes RViz markers depicting the location of the robots over `/fleet_markers`. |
| 37 | + |
| 38 | +## rmf_visualization_floorplans |
| 39 | +A visualizer for the floorplan images for each building level. The ROS 2 node subscribes to `BuildingMap` ROS 2 messages published over `/map`. It then converts the image to an `OccupancyGrid` and publishes it over `/floorplan`. |
| 40 | + |
| 41 | +## rmf_visualization_navgraphs |
| 42 | +https://user-images.githubusercontent.com/13482049/176585472-115ef57b-7792-4f02-93d3-c50a3ad70c95.mp4 |
30 | 43 |
|
31 | | -The various packages publish MarkerArray messages over these topics: |
32 | | -* `/map_markers` visualizes the nav graphs, waypoints and waypoint labels. Topic durability is `Transient Local`. |
33 | | -* `/schedule_markers` visualizes planned trajectory of the robots in the rmf_schedule along with the robot vicinities. |
34 | | -* `/fleet_markers` renders the current pose of robots as purple spheres |
35 | | -* `/building_systems_markers` visualize the current states of doors and lifts in the facility. Topic durability is `Transient Local`. |
| 44 | +A visualizer for the navigation graphs used by each fleet of robots. Lanes that are closed are shared grey while speed limited ones have relatively narrower widths. The ROS 2 node subscribes to `Graph` ROS 2 messages published over `/nav_graphs`. It then publishes RViz markers depicting color coded lanes for each fleet over `/map_markers` with `Transient Local` durability. |
36 | 45 |
|
| 46 | +## rmf_visualization_obstacles |
| 47 | + |
| 48 | + |
| 49 | +A visualizer for obstacles detected. The ROS 2 node subscribes to `Obstacles` ROS 2 messages published over `/rmf_obstacles`. It then publishes RViz markers depicting the obstacles over `/fleet_markers` with `Transient Local` durability. |
| 50 | + |
| 51 | +## rmf_visualization_rviz2_plugins |
37 | 52 |  |
| 53 | +This package provides several RViz panels to update the view and submit requests to Open-RMF. |
38 | 54 |
|
| 55 | +### RMFSchedulePanel |
39 | 56 | For a given `map_name`, the `rmf_visualization_schedule_data_node` queries for trajectories in the RMF schedule database over a duration that is specified by `start_duration` and `query_duration` parameters. |
40 | 57 | The expected location and vicinity of a participant are visualized with concentric yellow and blue circles respectively. |
41 | 58 | The expected trajectory for a participant is a green polyline when conflict-free and is red otherwise. |
42 | 59 | The `SchedulePanel` in RViz allows users to modify the parameters used to query trajectories in the schedule database. |
| 60 | +### Door and Lift panels |
43 | 61 | `Door` and `Lift` panels allow users to interact with these systems respectively. |
44 | 62 | The `rmf.rviz` file is used to save the configuration of RViz along with default values of parameters used in the different panels. |
45 | 63 |
|
| 64 | +## rmf_visualization_schedule |
| 65 | + |
| 66 | + |
| 67 | +A visualizer of the predicted schedule of robots as submitted by fleet adapters to the RMF Schedule Database. The ROS 2 node spawns a `Mirror` of the RMF Schedule Database which is queries before publishing markers depicting the trajectory of robots as green line strips to `/schedule_markers`. The `footprint` and `vicinity` of each robot is represented by yellow and cyan cylindrical markers respectively. |
| 68 | + |
| 69 | +An active `rmf_traffic_schedule` node is prerequisite for the visualizer to initialize. If a schedule node is not running, it can be started with the command |
| 70 | +``` |
| 71 | +ros2 run rmf_traffic_ros2 rmf_traffic_schedule |
| 72 | +``` |
| 73 | +>Note: Only one instance of `rmf_traffic_schedule` must be active at any moment. |
| 74 | +
|
| 75 | + |
46 | 76 | ## Websocket Server for Custom UIs |
47 | 77 | For developers looking to create custom UIs outside of the ROS2 environment, this repository provides a websocket server to exchange information contained in an active rmf schedule database. This may primarily be used to query for robot trajectories in the schedule along with conflict information if any. The format for various requests and corresponding responses are described below. |
48 | 78 |
|
|
0 commit comments