Skip to content

Commit 9600d56

Browse files
committed
README updates
1 parent b98c311 commit 9600d56

File tree

2 files changed

+74
-3
lines changed

2 files changed

+74
-3
lines changed

README.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,82 @@ ros2 launch uirover_bringup rover.launch.py
102102

103103
---
104104

105-
## Other Launch Files
105+
## Other Launch Files/Scripts
106106

107+
### URDF development
107108

109+
Preview the robot model in RViz. Useful when manually tweaking urdf files.
110+
111+
```bash
112+
ros2 launch uirover_description preview.launch.py
113+
```
114+
115+
### Mapproxy
116+
117+
[Mapproxy](https://mapproxy.org/) is a map tile provider which allows map data to be cached locally for offline use. To use it offline, the map cache must first be "seeded" with data from an online source.
118+
119+
To seed the map cache with data, run:
120+
121+
```bash
122+
ros2 launch uirover_basestation mapproxy_seed.launch.py
123+
```
124+
125+
this launch file starts the mapproxy server:
126+
127+
```bash
128+
ros2 launch uirover_basestation mapproxy.launch.py
129+
```
130+
131+
Map proxy UI can be found at [http://localhost:8080/demo/](http://localhost:8080/demo/) while the service is running.
132+
133+
Map tiles will be served at [http://localhost:8080/tiles/satellite/webmercator/{z}/{x}/{y}.png](http://localhost:8080/tiles/satellite/webmercator/1/1/1.png) where {x}, {y}, and {z} are the tile coordinates.
134+
135+
More info can be found in the [mapproxy docs](https://mapproxy.github.io/mapproxy/latest/index.html)
136+
137+
### MoveIt2
138+
139+
[MoveIt2](https://moveit.ros.org/) is a motion planning framework for ROS2. It will do inverse kinematics, path planning, and collision checking for the rover arm.
140+
141+
To view the demo for our arm, run:
142+
143+
```bash
144+
ros2 launch uirover_moveit demo.launch.py
145+
```
146+
147+
More info can be found in the [MoveIt2 docs](https://moveit.picknik.ai/main/index.html)
148+
149+
> [!WARNING]
150+
>
151+
> As of **October 2025**, MoveIt2's setup assistant has a fatal issue caused by a version incompatibility with Rviz2. The current workaround is to downgrade to an older version of Rviz2. The GitHub issue is found [here](https://github.com/moveit/moveit2/issues/3546). A script is provided to automate this process:
152+
>
153+
>```bash
154+
>./tools/misc/moveit_rviz_workaround.sh
155+
>```
156+
157+
### Perception
158+
159+
Camera streams (sources) and viewers (sinks) can be launched with the following commands:
160+
161+
```bash
162+
ros2 launch uirover_perception gstream_source.launch.py
163+
ros2 launch uirover_perception gstream_sink.launch.py
164+
```
165+
166+
The realsense D435i can be demoed with this file
167+
168+
169+
```bash
170+
ros2 launch uirover_perception realsense.launch.py
171+
```
172+
173+
A more complete SLAM demo using the realsense can be run with
174+
175+
```bash
176+
ros2 launch uirover_perception stereo_slam.launch.py
177+
```
178+
179+
> [!NOTE]
180+
> To make full use of the D435i make sure that you are using a USB 3.0 compatible port and cable.
108181
109182
---
110183

src/uirover_basestation/mapproxy/mapproxy.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
# MapProxy configuration.
33
# -------------------------------
44

5-
# http://localhost:8080/tiles/satellite/webmercator/{z}/{x}/{y}.png
6-
75
services:
86
demo:
97
tms:

0 commit comments

Comments
 (0)