root / trunk / docs / libdragonfly / group__motors.html @ 948
History | View | Annotate | Download (9.44 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|---|
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>libdragonfly: Motors</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.3 -->
|
| 8 |
<div class="tabs"> |
| 9 |
<ul>
|
| 10 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 11 |
<li><a href="modules.html"><span>Modules</span></a></li> |
| 12 |
<li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
| 14 |
<li><a href="pages.html"><span>Related Pages</span></a></li> |
| 15 |
</ul>
|
| 16 |
</div>
|
| 17 |
<h1>Motors</h1>Functions for controlling the motors. Functions for controlling the motors. Found in <a class="el" href="motor_8h.html" title="Contains definitions for controlling the motors.">motor.h</a>. |
| 18 |
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0"> |
| 19 |
<tr><td></td></tr> |
| 20 |
<tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
| 21 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="g6ddfdda7a062d10cff4a72b76b44aeb8"></a><!-- doxytag: member="motors::FORWARD" ref="g6ddfdda7a062d10cff4a72b76b44aeb8" args="" --> |
| 22 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__motors.html#g6ddfdda7a062d10cff4a72b76b44aeb8">FORWARD</a> 1</td></tr> |
| 23 |
|
| 24 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">make the motors go forwards <br></td></tr> |
| 25 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="gdf445abfe1b77fa63f89e315ccc2f7f2"></a><!-- doxytag: member="motors::BACKWARD" ref="gdf445abfe1b77fa63f89e315ccc2f7f2" args="" --> |
| 26 |
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__motors.html#gdf445abfe1b77fa63f89e315ccc2f7f2">BACKWARD</a> 0</td></tr> |
| 27 |
|
| 28 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">make the motors go backwards <br></td></tr> |
| 29 |
<tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
| 30 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21">motors_init</a> (void)</td></tr> |
| 31 |
|
| 32 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the motors. <a href="#gbad32bfc46c9f31ba81955775611bd21"></a><br></td></tr> |
| 33 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__motors.html#g751a431c19cdb52bbbc8127455bd41ee">motor1_set</a> (int direction, int speed)</td></tr> |
| 34 |
|
| 35 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set speed and direction of motor1. <a href="#g751a431c19cdb52bbbc8127455bd41ee"></a><br></td></tr> |
| 36 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__motors.html#g23940fd8408c23fcf312b1d5937f0ab0">motor2_set</a> (int direction, int speed)</td></tr> |
| 37 |
|
| 38 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set speed and direction of motor2. <a href="#g23940fd8408c23fcf312b1d5937f0ab0"></a><br></td></tr> |
| 39 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__motors.html#g3c7ada13bc7d8ed5e819910da74bf9cd">motors_off</a> (void)</td></tr> |
| 40 |
|
| 41 |
<tr><td class="mdescLeft"> </td><td class="mdescRight">Turn the motors off. <a href="#g3c7ada13bc7d8ed5e819910da74bf9cd"></a><br></td></tr> |
| 42 |
</table>
|
| 43 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 44 |
Functions for controlling the motors. Functions for controlling the motors. Found in <a class="el" href="motor_8h.html" title="Contains definitions for controlling the motors.">motor.h</a>. |
| 45 |
<p>
|
| 46 |
<hr><h2>Function Documentation</h2> |
| 47 |
<a class="anchor" name="g751a431c19cdb52bbbc8127455bd41ee"></a><!-- doxytag: member="motor.c::motor1_set" ref="g751a431c19cdb52bbbc8127455bd41ee" args="(int direction, int speed)" --> |
| 48 |
<div class="memitem"> |
| 49 |
<div class="memproto"> |
| 50 |
<table class="memname"> |
| 51 |
<tr>
|
| 52 |
<td class="memname">void motor1_set </td> |
| 53 |
<td>(</td> |
| 54 |
<td class="paramtype">int </td> |
| 55 |
<td class="paramname"> <em>direction</em>, </td> |
| 56 |
</tr>
|
| 57 |
<tr>
|
| 58 |
<td class="paramkey"></td> |
| 59 |
<td></td> |
| 60 |
<td class="paramtype">int </td> |
| 61 |
<td class="paramname"> <em>speed</em></td><td> </td> |
| 62 |
</tr>
|
| 63 |
<tr>
|
| 64 |
<td></td> |
| 65 |
<td>)</td> |
| 66 |
<td></td><td></td><td width="100%"></td> |
| 67 |
</tr>
|
| 68 |
</table>
|
| 69 |
</div>
|
| 70 |
<div class="memdoc"> |
| 71 |
|
| 72 |
<p>
|
| 73 |
Set speed and direction of motor1. |
| 74 |
<p>
|
| 75 |
Sets the speed and direction of motor1. motors_init must be called before this function can be used.<p>
|
| 76 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 77 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 78 |
<tr><td valign="top"></td><td valign="top"><em>direction</em> </td><td>Either FORWARD or BACKWARD to set the direction of rotation. </td></tr> |
| 79 |
<tr><td valign="top"></td><td valign="top"><em>speed</em> </td><td>The speed the motor will run at, in the range 0-255.</td></tr> |
| 80 |
</table>
|
| 81 |
</dl>
|
| 82 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__motors.html#g23940fd8408c23fcf312b1d5937f0ab0" title="Set speed and direction of motor2.">motor2_set</a>, <a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21" title="Initialize the motors.">motors_init</a> </dd></dl> |
| 83 |
|
| 84 |
</div>
|
| 85 |
</div><p> |
| 86 |
<a class="anchor" name="g23940fd8408c23fcf312b1d5937f0ab0"></a><!-- doxytag: member="motor.c::motor2_set" ref="g23940fd8408c23fcf312b1d5937f0ab0" args="(int direction, int speed)" --> |
| 87 |
<div class="memitem"> |
| 88 |
<div class="memproto"> |
| 89 |
<table class="memname"> |
| 90 |
<tr>
|
| 91 |
<td class="memname">void motor2_set </td> |
| 92 |
<td>(</td> |
| 93 |
<td class="paramtype">int </td> |
| 94 |
<td class="paramname"> <em>direction</em>, </td> |
| 95 |
</tr>
|
| 96 |
<tr>
|
| 97 |
<td class="paramkey"></td> |
| 98 |
<td></td> |
| 99 |
<td class="paramtype">int </td> |
| 100 |
<td class="paramname"> <em>speed</em></td><td> </td> |
| 101 |
</tr>
|
| 102 |
<tr>
|
| 103 |
<td></td> |
| 104 |
<td>)</td> |
| 105 |
<td></td><td></td><td width="100%"></td> |
| 106 |
</tr>
|
| 107 |
</table>
|
| 108 |
</div>
|
| 109 |
<div class="memdoc"> |
| 110 |
|
| 111 |
<p>
|
| 112 |
Set speed and direction of motor2. |
| 113 |
<p>
|
| 114 |
Sets the speed and direction of motor2. motors_init must be called before this function can be used.<p>
|
| 115 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 116 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 117 |
<tr><td valign="top"></td><td valign="top"><em>direction</em> </td><td>Either FORWARD or BACKWARD to set the direction of rotation. </td></tr> |
| 118 |
<tr><td valign="top"></td><td valign="top"><em>speed</em> </td><td>The speed the motor will run at, in the range 0-255.</td></tr> |
| 119 |
</table>
|
| 120 |
</dl>
|
| 121 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__motors.html#g751a431c19cdb52bbbc8127455bd41ee" title="Set speed and direction of motor1.">motor1_set</a>, <a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21" title="Initialize the motors.">motors_init</a> </dd></dl> |
| 122 |
|
| 123 |
</div>
|
| 124 |
</div><p> |
| 125 |
<a class="anchor" name="gbad32bfc46c9f31ba81955775611bd21"></a><!-- doxytag: member="motor.c::motors_init" ref="gbad32bfc46c9f31ba81955775611bd21" args="(void)" --> |
| 126 |
<div class="memitem"> |
| 127 |
<div class="memproto"> |
| 128 |
<table class="memname"> |
| 129 |
<tr>
|
| 130 |
<td class="memname">void motors_init </td> |
| 131 |
<td>(</td> |
| 132 |
<td class="paramtype">void </td> |
| 133 |
<td class="paramname"> </td> |
| 134 |
<td> ) </td> |
| 135 |
<td width="100%"></td> |
| 136 |
</tr>
|
| 137 |
</table>
|
| 138 |
</div>
|
| 139 |
<div class="memdoc"> |
| 140 |
|
| 141 |
<p>
|
| 142 |
Initialize the motors. |
| 143 |
<p>
|
| 144 |
Initializes both motors so that they can be used with future calls to motor1_set and motor2_set.<p>
|
| 145 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__motors.html#g3c7ada13bc7d8ed5e819910da74bf9cd" title="Turn the motors off.">motors_off</a>, <a class="el" href="group__motors.html#g751a431c19cdb52bbbc8127455bd41ee" title="Set speed and direction of motor1.">motor1_set</a>, <a class="el" href="group__motors.html#g23940fd8408c23fcf312b1d5937f0ab0" title="Set speed and direction of motor2.">motor2_set</a> </dd></dl> |
| 146 |
|
| 147 |
</div>
|
| 148 |
</div><p> |
| 149 |
<a class="anchor" name="g3c7ada13bc7d8ed5e819910da74bf9cd"></a><!-- doxytag: member="motor.c::motors_off" ref="g3c7ada13bc7d8ed5e819910da74bf9cd" args="(void)" --> |
| 150 |
<div class="memitem"> |
| 151 |
<div class="memproto"> |
| 152 |
<table class="memname"> |
| 153 |
<tr>
|
| 154 |
<td class="memname">void motors_off </td> |
| 155 |
<td>(</td> |
| 156 |
<td class="paramtype">void </td> |
| 157 |
<td class="paramname"> </td> |
| 158 |
<td> ) </td> |
| 159 |
<td width="100%"></td> |
| 160 |
</tr>
|
| 161 |
</table>
|
| 162 |
</div>
|
| 163 |
<div class="memdoc"> |
| 164 |
|
| 165 |
<p>
|
| 166 |
Turn the motors off. |
| 167 |
<p>
|
| 168 |
Turns off both motors.<p>
|
| 169 |
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__motors.html#gbad32bfc46c9f31ba81955775611bd21" title="Initialize the motors.">motors_init</a> </dd></dl> |
| 170 |
|
| 171 |
</div>
|
| 172 |
</div><p> |
| 173 |
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Nov 5 19:59:43 2008 for libdragonfly by |
| 174 |
<a href="http://www.doxygen.org/index.html"> |
| 175 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address> |
| 176 |
</body>
|
| 177 |
</html>
|