VIC-14350 Reorder tutorials and cleanup (#188)

* Reorder tutorials to be in the order of beginner-to-advance progression and in order of interest, IMO
* Fix VIC-14499
* Make annotations tutorial more user friendly. Remove unnecessary import module comments since these modules are in requirements.txt
* Modify comment in 09_control_priority_level
* Float the sounds folder up higher to be more discoverable. We have a precedent with a similar folder: face_images
* Correct annotation.py comment
* Add internal README notes
* lint fix

Author: msintov

anki_vector/annotate.py

@@ -17,7 +17,9 @@
 .. image:: ../images/annotate.png
 
 This module defines an :class:`ImageAnnotator` class used by
-:class:`anki_vector.world.World` to add annotations to camera images received by the robot.
+:class:`anki_vector.camera.CameraImage` and
+:class:`anki_vector.camera.CameraComponent` to add annotations
+to camera images received by the robot.
 
 This can include the location of cubes and faces that the robot currently sees,
 along with user-defined custom annotations.

anki_vector/audio.py

@@ -66,7 +66,7 @@ class AudioComponent(util.Component):
         import anki_vector
 
         with anki_vector.Robot() as robot:
-            robot.audio.stream_wav_file('../examples/tutorials/sounds/vector_alert.wav')
+            robot.audio.stream_wav_file('../examples/sounds/vector_alert.wav')
     """
 
     # TODO restore audio feed code when ready
@@ -167,7 +167,7 @@ async def stream_wav_file(self, filename, volume=50):
             import anki_vector
 
             with anki_vector.Robot() as robot:
-                robot.audio.stream_wav_file('../examples/tutorials/sounds/vector_alert.wav')
+                robot.audio.stream_wav_file('../examples/sounds/vector_alert.wav')
 
         :param filename: the filename/path to the .wav audio file
         :param volume: the audio playback level (0-100)

anki_vector/util.py

@@ -1123,7 +1123,7 @@ def read_configuration(serial: str, name: str, logger: logging.Logger) -> dict:
             for key in config[keySerial]:
                 if config[keySerial][key] == name:
                     return config[keySerial]
-                elif config[keySerial][key].lower() == name.lower():
+                if config[keySerial][key].lower() == name.lower():
                     logger.warning("Using case-insensitive name match found in config. Set 'name' field to match 'Vector-A1B2' format.")
                     return config[keySerial]
 

examples/tutorials/sounds/vector_alert.wav renamed to examples/sounds/vector_alert.wav

@@ -23,8 +23,8 @@
 def main():
     args = anki_vector.util.parse_command_args()
     with anki_vector.Robot(args.serial) as robot:
-        robot.audio.stream_wav_file("sounds/vector_bell_whistle.wav", 75)
-        robot.audio.stream_wav_file("sounds/vector_alert.wav", 75)
+        robot.audio.stream_wav_file("../sounds/vector_bell_whistle.wav", 75)
+        robot.audio.stream_wav_file("../sounds/vector_alert.wav", 75)
 
 
 if __name__ == "__main__":

examples/tutorials/sounds/vector_bell_whistle.wav renamed to examples/sounds/vector_bell_whistle.wav

@@ -14,27 +14,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Use behavior control at the highest priority level
+"""Vector maintains SDK behavior control after being picked up
 
-This script demonstrates how to request behavior control at the highest level.  This allows Vector
-to perform actions under system conditions that normally take priority over the SDK, such as being
-at a cliff, stuck on an edge or obstacle, low battery, tilted or inclined, picked up, in
-darkness, etc.
+During normal operation, SDK programs cannot maintain control over Vector
+when he is at a cliff, stuck on an edge or obstacle, tilted or inclined,
+picked up, in darkness, etc.
 
-After requesting control, Vector will wait until it detects being picked up.  At
-this point the wheel motors will briefly activate.  These commands will not succeed at
-CONTROL_PRIORITY_LEVEL.DEFAULT.
+This script demonstrates how to use the highest level SDK behavior control
+ControlPriorityLevel.OVERRIDE_BEHAVIORS_PRIORITY to make Vector perform
+actions that normally take priority over the SDK. These commands will not
+succeed at ControlPriorityLevel.DEFAULT.
 """
 
 import sys
 import time
 import anki_vector
-from anki_vector.connection import CONTROL_PRIORITY_LEVEL as control_level
+from anki_vector.connection import ControlPriorityLevel
 
 
 def main():
     args = anki_vector.util.parse_command_args()
-    with anki_vector.Robot(args.serial, behavior_control_level=control_level.OVERRIDE_BEHAVIORS_PRIORITY) as robot:
+    with anki_vector.Robot(args.serial, behavior_control_level=ControlPriorityLevel.OVERRIDE_BEHAVIORS_PRIORITY) as robot:
         robot.behavior.say_text("Pick me up!")
         pickup_countdown = 20