Release v0.2.0

Author: Bryon Gloden, CISSP®

Doxyfile

@@ -628,7 +628,7 @@ INPUT_ENCODING         = UTF-8
 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
 # *.f90 *.f *.for *.vhd *.vhdl
 
-FILE_PATTERNS          = *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py *.f90 *.f *.for *.vhd *.vhdl *.pde *.ino
+FILE_PATTERNS          = *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py *.f90 *.f *.for *.vhd *.vhdl *.pde *.ino *.msg *.srv
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 # should be searched for input files as well. Possible values are YES and NO.

README.md

@@ -4,9 +4,20 @@
 
 Software for the AutoRally research platform.
 
-AutoRally Platform Website: http://autorally.github.io
+[AutoRally Platform Website](http://autorally.github.io)
 
-AutoRally Research Website: http://rehg.org/autorally
+[AutoRally Youtube Channel](https://www.youtube.com/channel/UCSt0P1uqi4zU5RX2DZC_Qvg)
+
+Research Pages AutoRally is associated with:
+  * http://rehg.org/autorally
+  * http://dcsl.gatech.edu/research-muri-nascar.html
+  * http://acds-lab.gatech.edu/Research.html
+
+## Contributing
+
+We welcome bug fixes, ehancements, new features, and [feedback](https://github.com/AutoRally/autorally/issues)!
+
+Please submit pull requests to the [devel branch](https://github.com/AutoRally/autorally/pull/new/devel) that conform to the [ROS C++ Style Guide](http://wiki.ros.org/CppStyleGuide). We use Gitflow, so master branch is reserved for releases.
 
 ## Setup Instructions
 
@@ -21,26 +32,19 @@ AutoRally Research Website: http://rehg.org/autorally
 1. __Install [Ubuntu 14.04 64-bit](http://www.ubuntu.com)__
 2. __Install required packages__
 
-   ```sudo apt-get install git doxygen openssh-server libusb-dev```
+   ```sudo apt-get install git doxygen openssh-server libusb-dev texinfo```
 
    _Recommended Tools_
 
    The following tools are useful, but not necessary for this project.
    * feh
    * cutecom
    * cmake-curses-gui
-   * texinfo
    * coriander
    * synaptic
    * arduino
    * python-termcolor
 
-   _Compute Box Dependencies_
-   
-   When installing software on an AutoRally compute box, include these dependencies as well:
-   
-   ```sudo apt-get install lm-sensors acpi gpsd-clients```
-   
 3. __[Install](http://www.ros.org/install/) ros-indigo-desktop-full__
 4. __Install gtsam__
 
@@ -54,13 +58,14 @@ AutoRally Research Website: http://rehg.org/autorally
 
    ```sudo ldconfig```
 
-### 2. Clone Repositories
+### 2. Clone or Fork Repositories
 
-Clone the autorally and imu_3dm_gx4 repositories into 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.
+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.
 
-```git clone https://github.com/AutoRally/imu_3dm_gx4.git```
+To clone:
 
-```git clone https://github.com/AutoRally/autorally.git```
+    git clone https://github.com/AutoRally/autorally.git
+    git clone https://github.com/AutoRally/imu_3dm_gx4.git
 
 ### 3. Install AutoRally ROS Dependencies
 
@@ -72,7 +77,11 @@ Within the catkin workspace folder, run this command to install the packages thi
 
 To compile and install run `catkin_make` from the catkin workspace folder.
 
-Due to the additional requirement of ROS's distributed launch system, you must run `source autorally/autorally_util/setupEnvLocal.sh` before using any autorally components. For more information about how to set this system up for distributed launches on your vehicle platform, see the wiki.
+Due to the additional requirement of ROS's distributed launch system, you must run
+
+`source autorally/autorally_util/setupEnvLocal.sh`
+
+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.
 
 _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.
 
@@ -84,6 +93,16 @@ To view code documentation open `autorally/doc/html/index.html` in a web browser
 
 ### 5. Test Setup in Simulation
 
-To test that your setup process was successful, run the AutoRally simulator with the following command. If you have a USB gamepad, plug it in to your computer before launching this simulator. You will be able to drive the virtual platform around using this gamepad.
+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.
 
+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.
+ 
 ```roslaunch autorally_gazebo autoRallyTrackGazeboSim.launch```
+
+## What's Next
+
+Check out the [wiki](https://github.com/AutoRally/autorally/wiki) for:
+* Instructions to configure a physical AutoRally platform
+* Tutorials for released controllers (waypoint follower, constant speed controller)
+* Tutorial to use your own controller with the AutoRally platform
+* Information about how to run the included state estimator

autorally_control/CMakeLists.txt

@@ -16,7 +16,7 @@ find_package(catkin REQUIRED COMPONENTS
 )
 
 find_package(Boost 1.49.0 REQUIRED)
-find_package(Eigen REQUIRED)
+find_package(Eigen3 REQUIRED)
 
 set(BUILD_FLAGS "-std=c++11 -Wuninitialized")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${BUILD_FLAGS}")
@@ -29,7 +29,7 @@ catkin_package(
   INCLUDE_DIRS include
 )
 
-include_directories(include ${catkin_INCLUDE_DIRS} ${Boost_INCLUDE_DIR} ${Eigen_INCLUDE_DIRS})
+include_directories(include ${catkin_INCLUDE_DIRS} ${Boost_INCLUDE_DIR} ${Eigen3_INCLUDE_DIRS})
 
 add_subdirectory(src/ConstantSpeedController)
 add_subdirectory(src/joystick)

autorally_control/launch/constantSpeedController.launch

@@ -1,7 +1,7 @@
 <launch>
   <include file="$(find autorally_core)/launch/hardware.machine" />
 
-  <node pkg="nodelet" type="nodelet" name="ConstantSpeedControllerB" args="load control/ConstantSpeedController autorally_core_manager" output="screen">
+  <node pkg="nodelet" type="nodelet" name="ConstantSpeedController" args="load autorally_control/ConstantSpeedController autorally_core_manager" output="screen"  machine="autorally-master">
 
     <rosparam param="throttleCalibration" command="load" file="$(env AR_CONFIG_PATH)/throttlePositionCalibration.yaml" />
     <param name="speedCommander" value="OCS" />
@@ -12,7 +12,6 @@
     <param name="accelerationRate" value="0.0" />
     <param name="KI" value="0.001" />
     <param name="IMax" value="0.2" />
-    <remap from="/safeSpeed" to="/targetSpeed" />
 
   </node>
 

autorally_control/launch/gpsWaypoint.launch

@@ -1,28 +1,26 @@
 <launch>
   <include file="$(find autorally_core)/launch/hardware.machine" />
 
-  <node name="joy_node" pkg="joy" type="joy_node" output="screen" machine="muri-ocs">
+  <node name="joy_node" pkg="joy" type="joy_node" output="screen" machine="autorally-ocs">
     <param name="dev" value="/dev/input/js0" />
-    <param name="deadzone" value="0.02" />
+    <param name="deadzone" value="0.01" />
     <param name="autorepeat_rate" value="10" />
     <param name="coalesce_interval" value="0.01" />
   </node>
 
-  <node name="joystickController" pkg="autorally_control" type="joystickController" output="screen" machine="muri-ocs">
+  <node name="joystickController" pkg="autorally_control" type="joystickController" output="screen" machine="autorally-ocs">
     <param name="throttleDamping" value="1.0" />
     <param name="steeringDamping" value="1.0" />
     <param name="throttleAxis" value="1" />
     <param name="steeringAxis" value="3" />
+    <rosparam param="runstopToggleButtons">[0, 1, 2, 3]</rosparam>
     <param name="safeSpeedIncButton" value="0" />
     <param name="safeSpeedDecButton" value="3" />
     <param name="safeSpeedZeroButton1" value="1" />
     <param name="safeSpeedZeroButton2" value="2" />
     <param name="throttleEnableButton" value="4" />
     <param name="steeringEnableButton" value="5" />
 
-    <param name="throttleBrakePaired" value="True" />
-    <param name="frontBrake" value="True" />
-    
     <param name="brakeAxis" value="2" />
     <remap from="/safeSpeed" to="/targetSpeed" />
   </node>

autorally_control/launch/joystickController.launch

@@ -1,9 +1,9 @@
 <launch>
   <include file="$(find autorally_core)/launch/hardware.machine" />
 
-  <node pkg="autorally_control" type="GenerateWaypoints" name="WaypointGen" output="screen">
+  <node pkg="autorally_control" type="GenerateWaypoints" name="WaypointGen" output="screen" machine="autorally-master">
     <param name="WaypointDistance" value="0.5" />
-    <param name="WaypointFile" value="$(find autorally_core)/waypoints" />
+    <param name="WaypointFile" value="$(find autorally_control)/launch/waypoints" />
     <remap from="/WaypointGen/gps" to="/pose_estimate"/>
   </node>
 

autorally_control/launch/recordWpts.launch

@@ -0,0 +1,14 @@
+<launch>
+  <include file="$(find autorally_core)/launch/hardware.machine" />
+
+  <node name="waypointFollower" pkg="autorally_control" type="gpsWaypoint" output="screen" machine="autorally-master">
+    <param name="WaypointFile" value="$(find autorally_control)/launch/waypoints"/>
+    <param name="WaypointRadius" value="1.0"/>
+    <param name="HeadingP" value="2.5"/>
+    <remap from="/waypointFollower/Speeds" to="/wheelSpeeds"/>
+    <remap from="/waypointFollower/Odom" to="/pose_estimate"/>
+    <remap from="/waypointFollower/Pose" to="/imu_data"/>
+    <remap from="/waypointFollower/imageMask" to="/imageMask"/>
+    <remap from="/waypointFollower/servoCommand" to="/waypointFollower/servoCommand"/>
+  </node>
+</launch>

autorally_control/launch/waypointFollower.launch

@@ -0,0 +1,111 @@
+-4.28133096191,4.52923845036
+-4.67314206709,4.88899952285
+-5.04550394009,5.23344260074
+-5.41338026704,5.57693292516
+-5.78223082111,5.92435076606
+-6.15059269523,6.27181471353
+-6.51610753564,6.6164449385
+-6.88391193938,6.96485976029
+-7.25040958617,7.31252525947
+-7.61469527066,7.66133200806
+-7.97840332773,8.00882954401
+-8.34106085485,8.35559453533
+-8.70580710165,8.70378943482
+-9.06959863299,9.05155532565
+-9.44611743816,9.3888781596
+-9.86381209567,9.66530789472
+-10.2946900411,9.92663290285
+-10.7547055615,10.127237672
+-11.2516092591,10.219833547
+-11.7558820128,10.2163790175
+-12.2554570195,10.1843254937
+-12.7550773777,10.1415403987
+-13.2581356247,10.0916878196
+-13.7544658239,10.0092031063
+-14.2494533074,9.90714747715
+-14.740126115,9.78467551985
+-15.2200565189,9.63718967623
+-15.6836017361,9.44944188479
+-16.1793352819,9.13554032264
+-16.5471591679,8.78895747548
+-16.9016822633,8.430392615
+-17.2510495502,8.06782518165
+-17.5920890013,7.7011267033
+-17.908716359,7.30425749344
+-18.1794520099,6.87504828121
+-18.3425423842,6.39758681985
+-18.4597130043,5.90510285854
+-18.5753086937,5.41239493868
+-18.6762771322,4.91782785549
+-18.7489295127,4.42085785426
+-18.7295386408,3.91585596868
+-18.6286145226,3.42609038896
+-18.4889451594,2.94442313626
+-18.3402510665,2.45914858743
+-18.1651833064,1.98173053624
+-17.917689814,1.53909444871
+-17.6103012576,1.14390040771
+-17.2746824236,0.759957962994
+-16.9397679965,0.379879540612
+-16.6030792642,-0.003432319876
+-16.265386381,-0.385045219685
+-15.9333060816,-0.765977673427
+-15.5935133251,-1.14582953357
+-15.2535696899,-1.53204274211
+-14.9162828613,-1.90505228474
+-14.5841520484,-2.27919748192
+-14.2426853609,-2.65161652809
+-13.9058030585,-3.02447784377
+-13.5592285516,-3.39716801304
+-13.2061298629,-3.7726998306
+-12.8551641181,-4.14945676596
+-12.5095789364,-4.51741637164
+-12.1674001803,-4.88609500664
+-11.8185885992,-5.25294766609
+-11.4665025658,-5.62697515452
+-11.1094239069,-6.00738244578
+-10.7652621831,-6.37127197707
+-10.4227204733,-6.73744260389
+-10.0761026779,-7.10883028228
+-9.73479994191,-7.4745851353
+-9.39070776466,-7.84432867941
+-9.04218597345,-8.21795166945
+-8.69976337539,-8.58577654114
+-8.35697387967,-8.95048233411
+-7.93867952829,-9.2295296082
+-7.50932472726,-9.49082110913
+-7.0442698254,-9.69808616556
+-6.59147342626,-9.91800041666
+-6.12305987495,-10.0994844911
+-5.64460300737,-10.2530422005
+-5.14807728273,-10.3545272474
+-4.64190114868,-10.3872021436
+-4.14736426841,-10.2993687011
+-3.6829770276,-10.107375025
+-3.22241391556,-9.88335422092
+-2.77209139035,-9.65256322087
+-2.32361889666,-9.4223400199
+-1.87712249063,-9.18450984964
+-1.43310296979,-8.94064576017
+-1.00535316731,-8.6708922936
+-0.619503443152,-8.34540500593
+-0.248876468681,-7.99287130764
+0.0925035645565,-7.6192559671
+0.404324749525,-7.22192488241
+0.653979974184,-6.7859917148
+0.859967649443,-6.32875982521
+1.01697198076,-5.84970727505
+1.12420055909,-5.34282448437
+1.17197752058,-4.83953116234
+1.17258321287,-4.33681151259
+1.12572844672,-3.8347976101
+1.05987314844,-3.32982384925
+0.985133797519,-2.83289289116
+0.885343076751,-2.33950926164
+0.752171811076,-1.8539721239
+0.582025140965,-1.382970678
+0.362465112003,-0.932170047864
+0.0759059899515,-0.516396477314
+-0.228722647928,-0.11543105313
+-0.538094153901,0.281595569448
+-0.851707050601,0.671762395801

autorally_control/launch/waypoints

@@ -22,10 +22,3 @@
   </class>
 </library>
 
-<library path="lib/libConstantSpeedControllerB">
-  <class name="autorally_control/ConstantSpeedControllerB" type="autorally_control::ConstantSpeedControllerB" base_class_type="nodelet::Nodelet">
-    <description>
-    Drive robot at a constant speed using wheel speed data
-    </description>
-  </class>
-</library>