PageRenderTime 27ms CodeModel.GetById 24ms RepoModel.GetById 1ms app.codeStats 0ms

/generalDrivers/Documentation/_m_s_p_f_m-driver_8h.html

https://github.com/nfox/team_252_10-11
HTML | 79 lines | 75 code | 3 blank | 1 comment | 0 complexity | fc2325cccef7bb811623216eb322783b MD5 | raw file
    

  1. <HTML> 
    2. 

  2. <HEAD> 
    3. 

  3. 	<TITLE>3rd Party ROBOTC Drivers</TITLE> 
    4. 

  4. <link href="tabs.css" rel="stylesheet" type="text/css"/> 
    5. 

  5. <link href="doxygen.css" rel="stylesheet" type="text/css"/> 
    6. 

  6. </HEAD> 
    7. 

  7.  
    8. 

  8. <BODY bgcolor="#ffffff" link="#000000" vlink="#000000"> 
    9. 

  9. <table width="100%" bgcolor="navy" cellspacing=0 cellpadding=1 border=0> 
    10. 

  10. <tr><td><table width="100%" bgcolor="#EEEEDD" cellspacing=0 cellpadding=3 border=0> 
    11. 

  11. <tr> 
    12. 

  12.     <td width="33%" align="left"> <img src="images/LOGO_NXT.gif" width=266 height=44 border="0" alt="Mindstorms"></td> 
    13. 

  13.     <td><b><font size="+3" color="navy">3rd Party ROBOTC Drivers</font></b></td> 
    14. 

  14.     <td align="right"> <img src="images/logo.png" width=44 height=44 border="0" alt="RobotC"></td>     
    15. 

  15. </tr> 
    16. 

  16.   <tr bgcolor="#cccc99" align="right"> 
    17. 

  17.           <td colspan=3> <font face="arial" size="-1"> [<a href=main.html>Home</a>] [<a target=_top href="https://sourceforge.net/projects/rdpartyrobotcdr/">Download</a>] [<a target=_top href="http://apps.sourceforge.net/mantisbt/rdpartyrobotcdr/my_view_page.php">Submit a bug/suggestion</a>]  [<a target=_top href="http://www.robotc.net/forums/">ROBOTC Forums</a>] [<a href="http://mightor.wordpress.com">Blog</a>] [<a target=_top href="http://sourceforge.net/donate/index.php?group_id=257238">Support this project</a>]</font> </td> 
    18. 

  18. </tr> 
    19. 

  19. </table></td></tr> 
    20. 

  20. </table> 
    21. 

  21. <!-- Generated by Doxygen 1.6.3 -->
    22. 

  22. <div class="contents">
    23. 

  23. <h1>MSPFM-driver.h File Reference</h1>
    24. 

  24. <p>Mindsensors PFMate Sensor driver.  
    25. 

  25. <a href="#_details">More...</a></p>
    26. 

  26. <code>#include &quot;<a class="el" href="common_8h_source.html">common.h</a>&quot;</code><br/>
    27. 

  27. 

  28. <p><a href="_m_s_p_f_m-driver_8h_source.html">Go to the source code of this file.</a></p>
    29. 

  29. <table border="0" cellpadding="0" cellspacing="0">
    30. 

  30. <tr><td colspan="2"><h2>Defines</h2></td></tr>
    31. 

  31. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga2a1d39dac9245c27867fe26919f28338">MSPFM_I2C_ADDR</a>&nbsp;&nbsp;&nbsp;0x48</td></tr>
    32. 

  32. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga8ed140dd966e187fa028533472818b8c">MSPFM_CMD</a>&nbsp;&nbsp;&nbsp;0x41</td></tr>
    33. 

  33. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga98cb8aec27e0ae9377fa4c45f143eb6c">MSPFM_IRCHAN</a>&nbsp;&nbsp;&nbsp;0x42</td></tr>
    34. 

  34. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga218f114a8e7fc7c4a4cc67532b709483">MSPFM_MSELECT</a>&nbsp;&nbsp;&nbsp;0x43</td></tr>
    35. 

  35. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga34ba9ddcfc3a84002a3a19fda48ab67c">MSPFM_MOTOPA</a>&nbsp;&nbsp;&nbsp;0x44</td></tr>
    36. 

  36. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga9885b223370982e1da03609102886550">MSPFM_MOTSPA</a>&nbsp;&nbsp;&nbsp;0x45</td></tr>
    37. 

  37. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga27a9063e3e2edf1839b3035c6784db94">MSPFM_MOTOPB</a>&nbsp;&nbsp;&nbsp;0x46</td></tr>
    38. 

  38. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#gadb7b2312572a04cf8185472e628b150f">MSPFM_MOTSPB</a>&nbsp;&nbsp;&nbsp;0x47</td></tr>
    39. 

  39. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga2bd29a316381c2e960fd93a38182ca10">MSPFM_GOCMD</a>&nbsp;&nbsp;&nbsp;0x47</td></tr>
    40. 

  40. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga8a3932e570c46a6418551debffb3b3e2">MSPFM_MOTORAB</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>
    41. 

  41. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga3b45bd415ceeee316d024ee3ec0d5012">MSPFM_MOTORA</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>
    42. 

  42. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga71db9c09c7c8d0c311eb69fce41bb8da">MSPFM_MOTORB</a>&nbsp;&nbsp;&nbsp;0x02</td></tr>
    43. 

  43. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga367064634cae523bf2838d6839baf0fa">MSPFM_FLOAT</a>&nbsp;&nbsp;&nbsp;0x00</td></tr>
    44. 

  44. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga548757e965bce1f636e74f5493cb2871">MSPFM_FORWARD</a>&nbsp;&nbsp;&nbsp;0x01</td></tr>
    45. 

  45. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#gac9680e5a49cf90582263eab3ffd47fff">MSPFM_REVERSE</a>&nbsp;&nbsp;&nbsp;0x02</td></tr>
    46. 

  46. <tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga24b05cd721ebedd747d39212b10f13cb">MSPFM_BRAKE</a>&nbsp;&nbsp;&nbsp;0x03</td></tr>
    47. 

  47. <tr><td colspan="2"><h2>Functions</h2></td></tr>
    48. 

  48. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#gafd59d361ec060927ceb8fd55ea4c6dca">_MSPFMsendCommand</a> (tSensors link, byte command)</td></tr>
    49. 

  49. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga3abfde3359f75a5504351a88253e6830">_MSPFMcontrolMotors</a> (tSensors link, byte chan, byte mselect, byte motorA_op, byte motorA_sp, byte motorB_op, byte motorB_sp)</td></tr>
    50. 

  50. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga366a15559ef52cdabf70ceb1299d56c2">MSPFMcontrolMotorA</a> (tSensors link, byte chan, byte motor_op, byte motor_speed)</td></tr>
    51. 

  51. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#gabebb42dd79dd44aeb602ba6e49797af9">MSPFMcontrolMotorB</a> (tSensors link, byte chan, byte motor_op, byte motor_speed)</td></tr>
    52. 

  52. <tr><td class="memItemLeft" align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#gaef6fc49963100eb7b12ddcd60115cee6">MSPFMcontrolMotorAB</a> (tSensors link, byte chan, byte motorA_op, byte motorA_speed, byte motorB_op, byte motorB_speed)</td></tr>
    53. 

  53. <tr><td colspan="2"><h2>Variables</h2></td></tr>
    54. 

  54. <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="structt_byte_array.html">tByteArray</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__pfmate.html#ga365e9b978b20efeded8ec9b016d40a1d">MSPFM_I2CRequest</a></td></tr>
    55. 

  55. </table>
    56. 

  56. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    57. 

  57. <p>Mindsensors PFMate Sensor driver. </p>
    58. 

  58. <p><a class="el" href="_m_s_p_f_m-driver_8h.html" title="Mindsensors PFMate Sensor driver.">MSPFM-driver.h</a> provides an API for the Mindsensors PFMate Sensor driver</p>
    59. 

  59. <p>Changelog:</p>
    60. 

  60. <ul>
    61. 

  61. <li>0.1: Initial release</li>
    62. 

  62. </ul>
    63. 

  63. <p>Credits:</p>
    64. 

  64. <ul>
    65. 

  65. <li>Big thanks to Mindsensors for providing me with the hardware necessary to write and test this.</li>
    66. 

  66. </ul>
    67. 

  67. <p>License: You may use this code as you wish, provided you give credit where its due.</p>
    68. 

  68. <p>THIS CODE WILL ONLY WORK WITH ROBOTC VERSION 2.00 AND HIGHER. </p>
    69. 

  69. <dl class="author"><dt><b>Author:</b></dt><dd>Xander Soldaat (mightor_at_gmail.com) </dd></dl>
    70. 

  70. <dl class="date"><dt><b>Date:</b></dt><dd>22 July 2009 </dd></dl>
    71. 

  71. <dl class="version"><dt><b>Version:</b></dt><dd>0.1 </dd></dl>
    72. 

  72. 

  73. <p>Definition in file <a class="el" href="_m_s_p_f_m-driver_8h_source.html">MSPFM-driver.h</a>.</p>
    74. 

  74. </div>
    75. 

  75. <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Jun 25 14:58:54 2010 for ROBOTC Drivers by&nbsp;
    76. 

  76. <a href="http://www.doxygen.org/index.html">
    77. 

  77. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
    78. 

  78. </body>
    79. 

  79. </html>
    80. 

  80.