Changeset 786 for firmware/trunk/libraries/motor/motor.c

Timestamp:

08/06/08 13:25:02 (5 months ago)

Author:

liamstask

Message:

- add examples to motor doc

Files:

• firmware/trunk/libraries/motor/motor.c (modified) (7 diffs)

firmware/trunk/libraries/motor/motor.c

@@ -51 +51 @@
 Other output devices cannot be used simultaneously - for example, the DigitalOuts cannot be called without
 first setting overlapping the DC motor I/O lines to inactive.
+
+See the digital out section of the 
+<a href="http://www.makingthings.com/documentation/tutorial/application-board-overview/digital-outputs">
+Application Board overview</a> for more details.
 \ingroup Libraries
 @{
@@ -60 +64 @@
   @param state An integer specifying the availability of the motor's I/O lines - 1 (active) or 0 (inactive).
   @return Zero on success.
+  
+  \b Example
+  \code
+  // Enable motor 0
+  Motor_SetActive(0, 1);
+  \endcode
 */
 int Motor_SetActive( int index, int state )
@@ -76 +86 @@
   @param index An integer specifying which DC Motor (0-3).
   @return The availability of the motor's I/O lines - 1 (active) or 0 (inactive).
+  
+  \b Example
+  \code
+  if( Motor_GetActive(0) )
+  {
+    // Motor 0 is active
+  }
+  else
+  {
+    // Motor 0 is inactive
+  }
+  \endcode
 */
 int Motor_GetActive( int index )
@@ -89 +111 @@
   @param duty An integer (0 - 1023) specifying the speed.
   @returns Zero on success.
+  
+  \b Example
+  \code
+  // Set the speed of motor 3 to %75
+  Motor_SetSpeed(3, 768);
+  \endcode
 */
 int Motor_SetSpeed( int index, int duty )
@@ -114 +142 @@
   @param forward A character specifying direction - 1/non-zero (forward) or 0 (reverse).
   @return Zero on success.
+  
+  \b Example
+  \code
+  // Set the direction of motor 2 to reverse.
+  Motor_SetDirection(2, 0);
+  \endcode
 */
 int Motor_SetDirection( int index, char forward )
@@ -138 +172 @@
   @param index An integer specifying which DC Motor (0-3).
   @return the speed (0 - 1023)
+  
+  \b Example
+  \code
+  // check the current speed of motor 1
+  int motor1_speed = Motor_GetSpeed(1);
+  \endcode
 */
 int Motor_GetSpeed( int index )
@@ -159 +199 @@
   Read the direction of a DC motor.
   @param index An integer specifying which DC Motor (0-3).
-  @return Direction - 1/non-zero (forward) or 0 (reverse).
+  @return Direction - non-zero (forward) or 0 (reverse).
+  
+  \b Example
+  \code
+  if( Motor_GetDirection(0) )
+  {
+    // Motor 0 is going forward
+  }
+  else
+  {
+    // Motor 0 is going in reverse
+  }
+  \endcode
 */
 int Motor_GetDirection( int index )