Skip to content

Commit ceb8c77

Browse files
ToniRVGitHub Enterprise
authored andcommitted
Merge pull request #37 from SPARK/feature/improve_readme
Improve Readme
2 parents 9c461bc + 2f08da2 commit ceb8c77

File tree

3 files changed

+19
-2
lines changed

3 files changed

+19
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,29 @@ source ~/.bashrc
6060
Download a [Euroc](https://projects.asl.ethz.ch/datasets/doku.php?id=kmavvisualinertialdatasets) rosbag: for example [V1_01_easy](http://robotics.ethz.ch/~asl-datasets/ijrr_euroc_mav_dataset/vicon_room1/V1_01_easy/V1_01_easy.bag).
6161

6262
## Online
63-
- In one terminal, launch the SparkVIO ROS wrapper:
63+
1. As a general good practice, open a new terminal and run: `roscore`
64+
65+
2. In another terminal, launch SparkVIO ROS wrapper:
6466
```bash
6567
roslaunch spark_vio_ros spark_vio_ros_euroc.launch
6668
```
67-
- In another terminal, launch the downloaded Euroc rosbag:
69+
70+
3. In another terminal, launch rviz for visualization:
71+
```bash
72+
rviz -d $(rospack find spark_vio_ros)/rviz/spark_vio_euroc.rviz
73+
```
74+
75+
4. Finally, in another terminal, launch the downloaded Euroc rosbag:
6876
```bash
6977
rosbag play --clock /PATH/TO/EUROC_ROSBAG
7078
```
7179

80+
> Note that you will need to both source ROS and your `catkin_ws` for each new terminal unless you added the following lines to your `~/.bashrc` file:
81+
> ```bash
82+
> source /opt/ros/melodic/setup.bash # Change `melodic` for your ROS distribution.
83+
> source ~/catkin_ws/devel/setup.bash # Change `bash` to the shell you use.
84+
> ```
85+
7286
## Offline
7387
In this mode, the provided rosbag will be first parsed and then sent to the VIO for processing.
7488
This is particularly useful when debugging to avoid potential ROS networking issues.
@@ -87,6 +101,9 @@ roslaunch spark_vio_ros spark_vio_ros_kitti.launch
87101
rosbag play --clock /PATH/TO/KITTI_ROSBAG
88102
```
89103
- In rviz, you can use the provided config file provided at spark_vio_ros/rviz/sparkvio_kitti.rviz
104+
```bash
105+
rviz -d $(rospack find spark_vio_ros)/rviz/spark_vio_kitti.rviz
106+
```
90107
91108
# Hardware use
92109
## RealSense D435i (Infrared)

0 commit comments

Comments
 (0)