Update the docs (for SDK 3.10.x / upcoming release changes)

SDK 3.9.x to SDK 3.10.1 Changes:

- Removed Settings:
    - PilotingSettingsLandingModeValue (Landing Mode)
- New Settings (http://bebop-autonomy.readthedocs.io/en/latest/autogenerated/ardrone3_settings_param.html):
    - PictureSettingsVideoRecordingModeMode (Video recording mode)
    - PictureSettingsVideoFramerateFramerate (Video framerate)
    - PictureSettingsVideoResolutionsType (Video streaming and recording resolutions)
- New Topics:
    - states/ardrone3/MediaRecordState/VideoResolutionState
    - states/enable_mediastreamingstate_videostreammodechanged
    - states/enable_commonstate_deprecatedmassstoragecontentchanged
    - states/common/CommonState/MassStorageContent
    - states/common/CommonState/MassStorageContentForCurrentRun
    - states/common/FlightPlanState/LockStateChanged

Author: mani-monaj

docs/contribute.rst

@@ -31,13 +31,17 @@ List of Contributers
 - `Jacob Perron <https://github.com/jacobperron>`_
 
   - `#26 Bebop now follows right-hand rule <https://github.com/AutonomyLab/bebop_autonomy/pull/26>`_
+  - `#57 Add autonomous flight plan capabilities to driver <https://github.com/AutonomyLab/bebop_autonomy/pull/57>`_
 
 - `Jake Bruce <http://www.sfu.ca/~jakeb/>`_
 
 - `Charuvahan Adhivarahan <http://www.chartoin.com/>`_
 
   - `#30 Fixed breaking build due to legac macro usage <https://github.com/AutonomyLab/bebop_autonomy/pull/34>`_
 
+- `Thomas Bamford <https://github.com/thomas-bamford>`_
+
+  - `Added Xbox 360 config file <https://github.com/AutonomyLab/bebop_autonomy/pull/56>`_
 
 Acknowledgments
 ================

docs/dev.rst

@@ -55,9 +55,17 @@ Upgrading the Bebop SDK
 =======================
 
 1. Update the ``GIT_TAG`` of ``ARDroneSDK3`` in ``bebop_driver/CMakeLists.txt::add_custom_target::./repo init ... -b GIT_TAG`` to your desired commit hash, branch or tag (release). The official upstream repository is hosted `here <https://github.com/Parrot-Developers/arsdk_manifests>`_.
-2. Checkout (or browse) the upstream repository at the same hash used in step (1) and open ``release.xml`` file. From this file, extract the commit hash of ``libARCommands`` from the ``revision`` property of this XML tag: ``<project name="libARCommands" ... revision="" />``.
+2. Checkout (or browse) the upstream repository at the same hash used in step (1) and open ``release.xml`` file. From this file, extract the commit hash of ``arsdk-xml`` from the ``revision`` property of this XML tag: ``<project name="arsdk-xml" ... revision="" />``.
 3. Open ``bebop_driver/scripts/meta/generate.py`` and update ``LIBARCOMMANDS_GIT_HASH`` variable to the hash obtained in step (2).
 4. Change the working diretory to ``bebop_driver/scripts/meta``, then execute ``generate.py`` from the command line. This will regenerate all automatically generated message definitions, header files and documentations.
-5. Copy the generated files to their target locations by calling ``install.sh``.
-6. In ``bebop_driver/include/bebop_driver/autogenerated/ardrone3_setting_callbacks.h`` change ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_MAXDISTANCECHANGED_VALUE`` to ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_MAXDISTANCECHANGED_CURRENT``. This is due to a bug in upstream XML definitions.
+5. Copy the generated files to their target locations by calling ``./install.sh``.
+6. In ``bebop_driver/include/bebop_driver/autogenerated/ardrone3_setting_callbacks.h`` change the following varialbles:
+
+  - ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_MAXDISTANCECHANGED_VALUE`` to ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_MAXDISTANCECHANGED_CURRENT``.
+  - ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_BANKEDTURNCHANGED_VALUE`` to ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_BANKEDTURNCHANGED_STATE``
+  - ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_CIRCLINGRADIUSCHANGED_VALUE`` to ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_CIRCLINGRADIUSCHANGED_CURRENT``
+  - ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_CIRCLINGALTITUDECHANGED_VALUE`` to ``ARCONTROLLER_DICTIONARY_KEY_ARDRONE3_PILOTINGSETTINGSSTATE_CIRCLINGALTITUDECHANGED_CURRENT``
+
+These changes are required becasue the upstream XML file is inconsistent for a couple of variable names.
+
 7. Remove ``build`` and ``devel`` space of your ``catkin`` workspace, then re-build it.

docs/index.rst

@@ -2,7 +2,7 @@
 bebop_autonomy - ROS Driver for Parrot Bebop Drone (quadrocopter) 1.0 & 2.0
 ****************************************************************************
 
-*bebop_autonomy* is a :abbr:`ROS (Robot Operating System)` driver for `Parrot Bebop 1.0 <http://www.parrot.com/ca/products/bebop-drone/>`_ and 2.0 drones (quadrocopters), based on Parrot's official `ARDroneSDK3 <https://github.com/Parrot-Developers/arsdk_manifests>`_. This driver has been developed in `Autonomy Lab <http://autonomylab.org/>`_ of `Simon Fraser University <http://www.sfu.ca/>`_ by `Mani Monajjemi <http://mani.im>`_ and other contributers (:ref:`sec-contribs`).
+*bebop_autonomy* is a :abbr:`ROS (Robot Operating System)` driver for `Parrot Bebop 1.0 <http://www.parrot.com/ca/products/bebop-drone/>`_ and `2.0 <https://www.parrot.com/ca/drones/parrot-bebop-2>`_ drones (quadrocopters), based on Parrot's official `ARDroneSDK3 <http://developer.parrot.com/docs/SDK3/>`_. This driver has been developed in `Autonomy Lab <http://autonomylab.org/>`_ of `Simon Fraser University <http://www.sfu.ca/>`_ by `Mani Monajjemi <http://mani.im>`_ and other contributers (:ref:`sec-contribs`).
 
 [`Source Code <https://github.com/AutonomyLab/bebop_autonomy>`_] 
 [`ROS wiki page <http://wiki.ros.org/bebop_autonomy>`_] 
@@ -18,6 +18,10 @@ Features and Roadmap
 .. csv-table::
   :header: "Feature", "Status", "Notes"
 
+  SDK Version,"3.10.1", "Since v0.6"
+  Support for Parrot Bebop 1, Yes, "Tested up to Firmware 3.3"
+  Support for Parrot Bebop 2, Yes, "Tested up to Firmware 3.9"
+  Support for Parrot Disco FPV, No, "Not tested (help wanted)"
   Core piloting, Yes, ""
   H264 video decoding, Yes, "Enhancement: `#1 <https://github.com/AutonomyLab/bebop_autonomy/issues/1>`_"
   ROS Camera Interface, Yes, ""
@@ -26,11 +30,12 @@ Features and Roadmap
   Dynamically reconfigurable Bebop settings, Yes, ":ref:`sec-dev-dyn`"
   Inline build of ARDroneSDK3, Yes, "Enhancement: `#2 <https://github.com/AutonomyLab/bebop_autonomy/issues/2>`_"
   Bebop In The Loop tests, Yes, ":ref:`sec-dev-test`"
-  Joystick teleop demo, Yes, ""
+  Joystick teleop demo, Yes, ":ref:`sec-pilot-teleop`"
   TF Publisher, Yes, "Since v0.5 (:ref:`sec-tf`)"
   Odometry Publisher, Yes, "Since v0.5 (:ref:`sec-odom`)"
   Provide ROS API for on-board picture/video recording, Yes, "Since v0.4.1 (:ref:`sec-snapshot`)"
-  GPS Support, Yes, "Since v0.5 (:ref:`sec-gps`)"
+  GPS Support, Yes, "Since v0.6 (:ref:`sec-gps`)"
+  Support for 720p streaming, Yes, "Since v0.6"
   Mavlink Support, No, ""
   Binary Release, No, ""
   Support for Parrot Sky Controller, No, ""

docs/piloting.rst

@@ -1,6 +1,7 @@
 *************************
 Sending Commands to Bebop
 *************************
+.. _sec-snapshot: sec-pilot-teleop
 
 .. 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 is located in ``bebop_tools/config`` folder. Adapting the file to your own controller is straightforward. To teleop Bebop while the driver is running execute ``roslaunch bebop_tools joy_teleop.launch``.