Changeset 788 for firmware/trunk/libraries/servo/servo.c

Timestamp:

08/06/08 13:40:24 (5 months ago)

Author:

liamstask

Message:

- adding examples to servo doc

Files:

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

firmware/trunk/libraries/servo/servo.c

@@ -106 +106 @@
   You can also specify the speed with which the motors will respond to new position commands - a high
   value will result in an immediate response, while a lower value can offer some smoothing when appropriate.
+  
+  See the servo section in the <a href="http://www.makingthings.com/documentation/tutorial/application-board-overview/servos">
+  Application Board overview</a> for more detailed info.
 * \ingroup Libraries
 * @{
@@ -116 +119 @@
   @param state An integer specifying the active state - 1 (active) or 0 (inactive).
   @return Zero on success.
+  
+  \b Example
+  \code
+  // enable servo 2
+  Servo_SetActive(2, 1);
+  \endcode
 */
 int Servo_SetActive( int index, int state )
@@ -152 +161 @@
   @param index An integer specifying which servo (0-3).
   @return State - 1 (active) or 0 (inactive).
+  
+  \b Example
+  \code
+  if( Servo_GetActive(2) )
+  {
+    // Servo 2 is active
+  }
+  else
+  {
+    // Servo 2 is inactive
+  }
+  \endcode
 */
 int Servo_GetActive( int index )
@@ -177 +198 @@
   @param position An integer specifying the servo position (0 - 1023).
   @return status (0 = OK).
+  
+  \b Example
+  \code
+  // set servo 1 to midway through the "safe" range
+  Servo_SetPosition(1, 512);
+  \endcode
 */
 int Servo_SetPosition( int index, int position )
@@ -206 +233 @@
   @param speed An integer specifying the servo speed (0 - 1023).
   @return status (0 = OK).
+  
+  \b Example
+  \code
+  // set servo 1 half speed
+  Servo_SetSpeed(1, 512);
+  \endcode
 */
 int Servo_SetSpeed( int index, int speed )
@@ -229 +262 @@
   @param index An integer specifying which servo (0 - 3).
   @return The position (0 - 1023), or 0 on error.
+  
+  \b Example
+  \code
+  int srv0_pos = Servo_GetPosition(0);
+  // now srv0_pos is the current position
+  \endcode
 */
 int Servo_GetPosition( int index )
@@ -244 +283 @@
   @param index An integer specifying which servo (0 - 3).
   @return The speed (0 - 1023), or 0 on error.
+  
+  \b Example
+  \code
+  int srv0_speed = Servo_GetSpeed(0);
+  // now srv0_speed is the current speed
+  \endcode
 */
 int Servo_GetSpeed( int index )