Skip to content

Commit 7b4fa8f

Browse files
committed
update readme
1 parent a2b983b commit 7b4fa8f

File tree

1 file changed

+13
-32
lines changed

1 file changed

+13
-32
lines changed

README.md

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
# f1tenth_system
22

3-
Drivers onboard f1tenth race cars. This branch is under development for migration to ROS2.
4-
5-
## Launching teleop
6-
```bash
7-
cd scripts
8-
./run_container.sh
9-
```
10-
This will bring up a container that contains foxy and the `f1tenth_stack`. Display is forwarded so `rviz` also works inside the container.
3+
Drivers onboard f1tenth race cars. This branch is under development for migration to ROS2. See the [documentation of F1TENTH](https://f1tenth.readthedocs.io/en/foxy_test/getting_started/firmware/index.html) on how to get started.
114

125
## Deadman's switch
13-
On Logitech F-710 joysticks, the LB button is the deadman's switch for teleop, and the RB button is the deadman's switch for navigation.
6+
On Logitech F-710 joysticks, the LB button is the deadman's switch for teleop, and the RB button is the deadman's switch for navigation. You can also remap buttons. See how on the readthedocs documentation.
147

158
## Topics
169

10+
### Topics that the driver stack subscribe to
1711
- `/drive`: Topic for autonomous navigation, uses `AckermannDriveStamped` messages.
12+
13+
### Sensor topics published by the driver stack
1814
- `/scan`: Topic for `LaserScan` messages.
19-
- `/vesc/odom`: Topic for `Odometry` messages.
15+
- `/odom`: Topic for `Odometry` messages.
16+
- `/sensors/imu/raw`: Topic for `Imu` messages.
17+
- `/sensors/core`: Topic for telemetry data from the VESC
2018

2119
## External Dependencies
2220

@@ -26,11 +24,11 @@ On Logitech F-710 joysticks, the LB button is the deadman's switch for teleop, a
2624
4. teleop_tools [https://index.ros.org/p/teleop_tools/#foxy](https://index.ros.org/p/teleop_tools/#foxy). This is the package for teleop with joysticks in ROS 2.
2725
5. vesc [GitHub - f1tenth/vesc at ros2](https://github.com/f1tenth/vesc/tree/ros2). This is the driver for VESCs in ROS 2.
2826
6. ackermann_mux [GitHub - f1tenth/ackermann_mux: Twist multiplexer](https://github.com/f1tenth/ackermann_mux). This is a package for multiplexing ackermann messages in ROS 2.
29-
7. rosbridge_suite [https://index.ros.org/p/rosbridge_suite/#foxy-overview](https://index.ros.org/p/rosbridge_suite/#foxy-overview) This is a package that allows for websocket connection in ROS 2.
27+
<!-- 7. rosbridge_suite [https://index.ros.org/p/rosbridge_suite/#foxy-overview](https://index.ros.org/p/rosbridge_suite/#foxy-overview) This is a package that allows for websocket connection in ROS 2. -->
3028

3129
## Package in this repo
3230

33-
1. f1tenth_stack: has the throttle interpolator and all bringup launch scripts and launch configs
31+
1. f1tenth_stack: maintains the bringup launch and all parameter files
3432

3533
## Nodes launched in bringup
3634

@@ -39,27 +37,10 @@ On Logitech F-710 joysticks, the LB button is the deadman's switch for teleop, a
3937
3. ackermann_to_vesc_node
4038
4. vesc_to_odom_node
4139
5. vesc_driver_node
42-
<!-- 6. throttle_interpolator.py -->
43-
7. urg_node
44-
8. ackermann_mux
45-
9. rosbridge_websocket.launch
46-
47-
## TODOs
48-
49-
- [x] port the bringup package to ROS2
50-
- [x] finish vesc imu implementation
51-
- [x] test urg_node on car
52-
- [ ] test urg_node on car with ethernet and wifi
53-
- [x] test joy on car
54-
- [x] test bringup launch on car
55-
- [ ] test foxglove studio integration over rosbridge
56-
57-
## Notes and Gotchas
58-
59-
- joy_teleop installed through rosdep/apt has a bug where the stamp is not using the correct format, clone from the teleop_tools repo on foxy-devel branch and put it in f1tenth_stack/ so it works correctly.
60-
- Testing results 09/24/21: mux is working but not correctly, when msgs published to /drive, the deadman switch doesn't work. Deadman switch for teleop works. Odom seems to be not published?
40+
6. urg_node
41+
7. ackermann_mux
6142

62-
## Extra doc to be put in other repos
43+
## Parameters and topics for dependencies
6344

6445
### vesc_driver
6546

0 commit comments

Comments
 (0)