More docs

LICENSE

@@ -0,0 +1,28 @@
+Copyright (c) 2015, Mani Monajjemi (AutonomyLab, Simon Fraser University)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of [project] nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

bebop_autonomy/README.md

@@ -0,0 +1,3 @@
+## bebop_autonomy
+
+ROS Driver for Parrot Bebop drone.

bebop_autonomy_msgs/README.md

@@ -0,0 +1,3 @@
+## bebop_autonomy_msgs
+
+Common message definitions for `bebop_autonomy`.

bebop_tools/README.md

@@ -0,0 +1,3 @@
+## bebop_tools
+
+Miscellaneous tools for `bebop_autonomy` package

docs/FAQ.rst

@@ -2,13 +2,19 @@
 Frequently Asked Questions
 **************************
 
-Is bebop_autonomy based on ardrone_autonomy
-===========================================
+Is *bebop_autonomy* based on *ardrone_autonomy*?
+================================================
 
-No. TBA
+No. `ardrone_autonomy <http://wiki.ros.org/ardrone_autonomy>`_ is based on Parrot's `legacy SDK <https://github.com/AutonomyLab/ardronelib>`_ for AR-Drone 1.0 and 2.0, while *bebop_autonomy* uses Parrot's new SDK for its third generation drones. Since these two SDKs and their underlying protocols are totally different and incompatible, we had to develop *bebop_autonomy* from scrath.
 
-Is bebop_autonomy compatible with ardrone_autonomy
-==================================================
+Is *bebop_autonomy* compatible with *ardrone_autonomy*?
+===================================================
 
-No. TBA
+Not completely.
+
+- Topic names, types and coordinate frame conventions for core piloting tasks are identical, however there is no explicit namespacing (i.e. ``takeoff`` instead of ``ardrone/takeoff``)
+- *bebop_autonomy* does not expose services for *Flight Animations* or *Flat Trim*; topics are used instead.
+- Front camera video stream is published on ``image_raw`` topic only.
+- Parameter names, types and effects are different.
+- AR-Drone *Navdata* is replaced by Bebop *States* (see :ref:`sec-states`)
 

docs/dev.rst

@@ -0,0 +1,30 @@
+**************
+Under The Hood
+**************
+
+This page contains information about the architecture of the driver and different techniques used for its development.
+
+Automatic Code Generation
+=========================
+
+TBA
+
+Threading Model
+===============
+
+TBA
+
+Publishing States
+=================
+
+TBA
+
+Configuring the Drone
+=====================
+
+TBA
+
+Tests
+=====
+
+TBA

docs/index.rst

@@ -7,7 +7,7 @@ bebop_autonomy
 [`Source Code <https://github.com/AutonomyLab/bebop_autonomy>`_]
 [`Support <http://answers.ros.org/questions/scope:all/sort:activity-desc/tags:bebop_autonomy/page:1/>`_]
 [`Bug Tracker <https://github.com/AutonomyLab/bebop_autonomy/issues>`_]
-[`Developer Mailing List <https://github.com/AutonomyLab/bebop_autonomy/issues>`_]
+[`Developer Forum <https://trello.com/b/C6rNl8Ux/parrot-drones-in-ros-development>`_]
 
 Features and Roadmap
 ====================
@@ -44,6 +44,7 @@ Table of Contents
   configuration
   contribute
   FAQ
+  dev
   license
 
 Indices and tables

docs/piloting.rst

@@ -4,6 +4,8 @@ Sending Commands to Bebop
 
 .. note:: ``bebop_tools`` package comes with a launch file for tele-operating Bebop with a joystick using ROS `joy_teleop <http://wiki.ros.org/joy_teleop>`_ package. The configuration file (key-action map) is written for `Logitech F710 controller <http://gaming.logitech.com/en-ca/product/f710-wireless-gamepad>`_ and located in ``/bebop_tools/config`` folder. Adapting the file to your own controller is straight-forward. To teleop Bebop while the driver is running execute ``roslaunch bebop_tools joy_teleop.launch``.
 
+.. _core-piloting:
+
 Takeoff
 =======
 

docs/reading.rst

@@ -9,6 +9,8 @@ The video stream from Bebop's front camera is published on ``image_raw`` topic a
 
 To set the location of camera calibration data, please check this page: :doc:`configuration`
 
+.. _sec-states:
+
 States (aka Navdata)
 ====================
 

docs/running.rst

@@ -26,15 +26,19 @@ The executable node is called ``bebop_driver_node``. It's recommended to run the
 Running the driver as a Nodelet
 ===================================
 
-To run the driver as a ROS Nodelet, you need to first run a Nodelet manager, then load the driver's Nodelet (``bebop_autonomy/BebopDriverNodelet``) in it, along with other Nodelets that need to communicate with the driver. `launch/bebop_nodelet.launch` is a sample launch file that demonstrates these steps by visualizing Bebop's video stream using an instance of `image_view/image <http://wiki.ros.org/image_view#image_view.2BAC8-diamondback.image_view.2BAC8-image>`_ Nodelet. Similar to `bebop_node.launch`, it also runs everything in a namespace and loads the default configuration.
+To run the driver as a ROS Nodelet, you need to first run a Nodelet manager, then load the driver's Nodelet (``bebop_autonomy/BebopDriverNodelet``) in it, along with other Nodelets that need to communicate with the driver. `bebop_tools/launch/bebop_nodelet_iv.launch` is a sample launch file that demonstrates these steps by visualizing Bebop's video stream using an instance of `image_view/image <http://wiki.ros.org/image_view#image_view.2BAC8-diamondback.image_view.2BAC8-image>`_ Nodelet. Similar to `bebop_node.launch`, it also runs everything in a namespace and loads the default configuration.
 
 .. code-block:: bash
 
-  $ roslaunch bebop_autonomy bebop_nodelet.launch
+  $ roslaunch bebop_tools bebop_nodelet_iv.launch
 
 
 .. literalinclude::
-  ../bebop_autonomy/launch/bebop_nodelet.launch
+  ../bebop_tools/launch/bebop_nodelet_iv.launch
   :language: XML
-  :caption: bebop_nodelet.launch
+  :caption: bebop_tools/launch/bebop_nodelet_iv.launch
 
+.. literalinclude::
+  ../bebop_autonomy/launch/bebop_nodelet.launch
+  :language: XML
+  :caption: bebop_autonomy/launch/bebop_nodelet.launch