Skip to content

Commit a2a1034

Browse files
update gazebo doc
1 parent 0208757 commit a2a1034

1 file changed

Lines changed: 19 additions & 18 deletions

File tree

docs/Gazebo Simulation Documentation.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,37 +65,38 @@ In one terminal, run the Gazebo simulator (using the instructions provided in th
6565

6666
### 2. Launch the GEM Stack
6767

68-
Open a second terminal and launch GEMStack with your configured launch file.
68+
Open a second terminal and launch GEMStack with your configured launch file. Make sure to set the variant to `gazebo`.
6969

70-
```bash
71-
python3 main.py --variant=gazebo --settings={your_file}.yaml launch/{your_file}.yaml
70+
#### For GEM e2 Vehicle:
7271

72+
```bash
73+
python3 main.py --variant=gazebo --settings=GEMstack/knowledge/defaults/e2.yaml launch/fixed_route.yaml
7374
```
74-
- Make sure to set the variant to `gazebo`.
75-
- You can specify the settings file to GEMstack/knowledge/defaults/e4_gazebo.yaml or e2_gazebo.yaml till we work on closing the sim to real gap.
7675

77-
Example command launching the fixed route with e4 vehicle:
76+
#### For GEM e4 Vehicle:
7877

7978
```bash
80-
python3 main.py --variant=gazebo --settings=GEMstack/knowledge/defaults/e2.yaml launch/fixed_route.yaml
81-
or
8279
python3 main.py --variant=gazebo --settings=GEMstack/knowledge/defaults/current.yaml launch/fixed_route.yaml
8380
```
84-
**Variants:**
85-
- sim
86-
- gazebo
8781

88-
**Vehicle types:**
89-
- e2
90-
- e4
82+
You can replace `fixed_route.yaml` with your specific launch file.
83+
84+
**Note:** By default, the system uses `GEMstack/knowledge/defaults/current.yaml` which contains GEM e4 vehicle configuration settings.
9185

92-
**Setting:**
86+
## Available Variants and Vehicle Types
87+
88+
**Variants:**
89+
- `sim` - Simple simulation mode
90+
- `gazebo` - 3D Gazebo simulation mode
9391

94-
By default it takes GEMstack/knowledge/defaults/current.yaml which is GEM E4 Vehicle configuration settings.
92+
**Vehicle Types:**
93+
- `e2` - GEM e2 vehicle (uses Novatel GNSS)
94+
- `e4` - GEM e4 vehicle (uses Septentrio GNSS)
9595

96-
Other available configuration files:
96+
## Available Configuration Files
9797

9898
GEMstack/knowledge/defaults/
99-
- e2.yaml
99+
- `current.yaml` - Default configuration (GEM e4)
100+
- `e2.yaml` - GEM e2 configuration
100101

101102
---

0 commit comments

Comments
 (0)