Robson Cardoso dos Santos / Sophia

Sophia, an autonomous robot based on Tamiya kits

Files at this revision

API Documentation at this revision

Revision 1:575431135236, committed 2013-05-09

Comitter:
cylax
Date:
Thu May 09 15:15:31 2013 +0000
Parent:
0:db79273ace80
Commit message:
updated documentation

Changed in this revision

Sophia.h Show annotated file Show diff for this revision Revisions of this file 
--- a/Sophia.h	Thu May 09 02:45:44 2013 +0000
+++ b/Sophia.h	Thu May 09 15:15:31 2013 +0000
@@ -12,14 +12,26 @@
  */
 class Sophia {
 public:
-    /** Set the speed of the motor
+    /** Set the direction of Sophia and the speed of the motor
+     * 
+     * @param speed The speed of the motor as a normalised value between -1.0 and 1.0
+     * @param direction The desired direction to move the robot, FWD or REV
+     */
+    void move(float speed, int direction);
+
+    /** Sets the side to turn and the speed of the motor
      * 
      * @param speed The speed of the motor as a normalised value between -1.0 and 1.0
-     * @param direction The desired direction to move the robot, FWD, REV, LEFT and RIGHT.
+     * @param direction The desired direction to move the robot, LEFT or RIGHT.
      */
-    void move(float speed, int direction);  // direction = 0:left, 1:right
-    void turn(float speed, int direction);  // direction = 0:left, 1:right
-    void spin(float speed, int direction);  // direction = 0:left, 1:right
+    void turn(float speed, int direction);
+
+    /** Sets the side to spin and the speed of the motor
+     * 
+     * @param speed The speed of the motor as a normalised value between -1.0 and 1.0
+     * @param direction The desired direction to move the robot, LEFT or RIGHT.
+     */
+    void spin(float speed, int direction);
 };
  
 #endif
\ No newline at end of file