Skip to content

Commit 5f6c389

Browse files
committed
Updated README for home world
Signed-off-by: KamalanathanN <[email protected]> Signed-off-by: KamalanathanN <[email protected]>
1 parent 3cb2ae3 commit 5f6c389

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ By specifying `server_uri`, the fleetadapter will update `rmf-web` `api-server`
4949

5050
* [Hotel World](#Hotel-World)
5151
* [Office World](#Office-World)
52+
* [Home World](#Home-World)
5253
* [Airport Terminal World](#Airport-Terminal-World)
5354
* [Clinic World](#Clinic-World)
5455

@@ -157,7 +158,32 @@ To run a scenario with multiple task requests, load [office_tasks.json](https://
157158
The office demo can be run in secure mode using ROS 2 DDS-Security integration. Click [here](docs/secure_office_world.md) to learn more.
158159

159160
---
161+
### Home World
162+
This demo world shows robot inside a home environment where the robot is configured to serve beverages to multiple drop points and also perform looping tasks.
160163

164+
165+
```bash
166+
source ~/rmf_demos_ws/install/setup.bash
167+
ros2 launch rmf_demos_gz home_world.launch.xml
168+
```
169+
2 types of Tasks are defined: **Delivery** and **Loop**
170+
171+
To send task requests, open rmf_demos web panel: https://open-rmf.github.io/rmf-panel-js/
172+
173+
![](../media/home_world.gif?raw=true)
174+
175+
To submit a delivery task, select ```Delivery``` from the ```Select a request type``` dropdown list. Next, select ```your desired coke delivery location``` from the ```Select delivery task``` list. Choose a desired start time for task and click submit.
176+
177+
Or, submit a task via CLI:
178+
179+
```bash
180+
ros2 run rmf_demos_tasks dispatch_patrol -p kitchen dining_table -n 2 --use_sim_time
181+
ros2 run rmf_demos_tasks dispatch_delivery -p kitchen -ph coke_dispenser -d bedroom_1 -dh coke_ingestor_bedroom_1 --use_sim_time
182+
```
183+
184+
To submit a **loop task**, select ```Loop``` from the ```Select a request type``` dropdown list. Choose desired start and end locations and click submit.
185+
186+
---
161187
### Airport Terminal World
162188

163189
This demo world shows robot interaction on a much larger map, with a lot more lanes, destinations, robots and possible interactions between robots from different fleets, robots and infrastructure, as well as robots and users. In the illustrations below, from top to bottom we have how the world looks like in `traffic_editor`, the schedule visualizer in `rviz`, and the full simulation in `gazebo`,

0 commit comments

Comments
 (0)