You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+53-15Lines changed: 53 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,12 +61,11 @@ Please submit pull requests to the [devel branch](https://github.com/AutoRally/a
61
61
62
62
### 2. Clone or Fork Repositories
63
63
64
-
Get the autorally and imu_3dm_gx4 repositories in a [catkin workspace](http://wiki.ros.org/catkin/workspaces). The suggested location is `~/catkin_ws/src/`, but any valid catkin worskspace source folder will work. We suggest forking if you will be working with the code.
64
+
Get the autorally repository in a [catkin workspace](http://wiki.ros.org/catkin/workspaces). The suggested location is `~/catkin_ws/src/`, but any valid catkin worskspace source folder will work. We suggest forking first if you will be working with the code.
before using any AutoRally components. See the [wiki](https://github.com/AutoRally/autorally/wiki) for more information about how to set this system up for distributed launches on your vehicle platform.
86
85
87
86
_Note:_ If you are unfamiliar with catkin, please know that you must run `source <catkin_ws>/devel/setup.sh` before ROS will be able to locate the autorally packages. This line can be added to your ~/.bashrc file.
88
87
89
88
### 5. Generate Documentation
90
89
91
-
You can generate / update code documentation by running `doxygen` in `autorally/`.
90
+
You can generate or update code documentation by running `doxygen` in `autorally/`.
92
91
93
92
To view code documentation open `autorally/doc/html/index.html` in a web browser.
94
93
95
-
### 6. Test Setup in Simulation
94
+
### 6. Start the AutoRally Simulation to Test Configuration
96
95
97
-
To test that your setup process was successful, run the AutoRally simulator with the following command. You can use a USB gamepad to drive the simulated platform around. On startup, the `runstop` message published by the joystick node is false. Press any of the buttons by the right stick (normally labelled X, Y, A, B or square, triangle, X, circle) to toggle the published value.
98
-
99
-
If you do not have a gamepad and want to control the platform autonomously in simulation, comment out the joystick node launch line in the simulation launch file so that it doesn't publish a `runstop` message that is always false.
You can use a USB gamepad to drive the simulated platform around. On startup, the `runstop` message published by the `joystick` node is **false**. Press any of the buttons by the right stick (normally labelled X, Y, A, B or square, triangle, X, circle) to toggle the published value.
99
+
100
+
Verify runstop motion is enabled by looking at the `runstopMotionEnabled` paramter in the `/chassisState` topic.
101
+
102
+
If you aren't using a gamepad, you will have to configure another source of runstop information for the platform to move:
103
+
104
+
- Comment out line 93 of `autorally_gazebo/launch/autoRallyTrackGazeboSim.launch`
105
+
106
+
-```rosrun rqt_publisher rqt_publisher```
107
+
108
+
and configure rqt_publisher to publish a message to topic `/runstop` of type `autorally_msgs/runstop` at 1 Hz with `sender` set to `rqt_publisher` and `motionEnabled` set to **true**.
109
+
110
+
- Verify that `runstopMotionEnabled` is **true** in `/chassisState` topic.
111
+
112
+
### 7. Autonomous Driving in Simulation
113
+
114
+
At the end of this section the robot will be driving autonomously in simulation using controllers available in `autorally_control`.
115
+
116
+
Position the robot in the same spot as when the simulation starts and make sure runstop motion should is enabled (set to **true**).
117
+
118
+
#### Start state estimator:
119
+
120
+
In `autorally_core/launch/state_estimator.launch` change `InvertY` and `InvertZ` to **false**, then:
Configure a publisher on topic `constantSpeedController/speedCommand` of type `std_msgs/Float64` at rate 10 with value of 3 (you can adjust he value once everything is running). The value is the target velocity in m/s, and **as soon as you do this the platform should move if motion is enabled**.
135
+
136
+
If the robot turns and hits the barrier it's probably because the state estimator has not converged, so its orientation estimate is incorrect. Just select the track barriers and move them up to allow the robot to continue driving, and the estimator should converge and the vehicle will return to within the barriers.
137
+
103
138
## What's Next
104
139
105
-
Check out the [wiki](https://github.com/AutoRally/autorally/wiki) for:
106
-
* Instructions to configure a physical AutoRally platform
107
-
* Tutorials for released controllers (waypoint follower, constant speed controller)
108
-
* Tutorial to use your own controller with the AutoRally platform
109
-
* Information about how to run the included state estimator
140
+
More detailed explanations of the controllers and state estimator can be found on the [wiki](https://github.com/AutoRally/autorally/wiki):
[Controlling the AutoRally platform](https://github.com/AutoRally/autorally/wiki/Controlling%20the%20AutoRally%20Platform) is a tutorial for how your own controller can control the AutoRally platform (in simulation or on hardware).
146
+
147
+
If you are configuring a physical AutoRally platform, the next step is to configure the compute box, all of the peripherals, and the launch system. Those instructions are found in the [Platform Configuration Instructions](https://github.com/AutoRally/autorally/wiki/Platform%20Configuration%20Instructions).
0 commit comments