thomas
/
marlin
Obserwuj 1
Gwiazdka 0
Forkuj 0
Kod Problemy 0 Pull Requests 0 Wydania 0 Wiki Aktywność
My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2192 Commity
4 Gałęzie
Drzewo: 38500165ea
Gałęzie Tagi
${ item.name }
Utwórz gałąź ${ searchTerm }
z '38500165ea'
${ noResults }
marlin/ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8h.html

_t_m_c26_x_stepper_8h.html 12KB
Historia Czysty

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  2. <html xmlns="http://www.w3.org/1999/xhtml">

  3. <head>

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>

  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>

  6. <title>Trinamic TMC26X Stepper Driver for Arduino: TMC26XStepper.h File Reference</title>

  7. 

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

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

  10. 

  11. 

  12. 

  13. </head>

  14. <body>

  15. <div id="top"><!-- do not remove this div! -->

  16. 

  17. 

  18. <div id="titlearea">

  19. <table cellspacing="0" cellpadding="0">

  20.  <tbody>

  21.  <tr style="height: 56px;">

  22.   

  23.   

  24.   <td style="padding-left: 0.5em;">

  25.    <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino

  26.    

  27.    </div>

  28.    

  29.   </td>

  30.   

  31.   

  32.   

  33.  </tr>

  34.  </tbody>

  35. </table>

  36. </div>

  37. 

  38. <!-- Generated by Doxygen 1.7.6.1 -->

  39.   <div id="navrow1" class="tabs">

  40.     <ul class="tablist">

  41.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>

  42.       <li><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li class="current"><a href="files.html"><span>Files</span></a></li>

  44.     </ul>

  45.   </div>

  46.   <div id="navrow2" class="tabs2">

  47.     <ul class="tablist">

  48.       <li><a href="files.html"><span>File&#160;List</span></a></li>

  49.       <li><a href="globals.html"><span>File&#160;Members</span></a></li>

  50.     </ul>

  51.   </div>

  52. </div>

  53. <div class="header">

  54.   <div class="summary">

  55. <a href="#nested-classes">Classes</a> &#124;

  56. <a href="#define-members">Defines</a>  </div>

  57.   <div class="headertitle">

  58. <div class="title">TMC26XStepper.h File Reference</div>  </div>

  59. </div><!--header-->

  60. <div class="contents">

  61. 

  62. <p><a href="_t_m_c26_x_stepper_8h_source.html">Go to the source code of this file.</a></p>

  63. <table class="memberdecls">

  64. <tr><td colspan="2"><h2><a name="nested-classes"></a>

  65. Classes</h2></td></tr>

  66. <tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td></tr>

  67. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Class representing a TMC26X stepper driver.  <a href="class_t_m_c26_x_stepper.html#details">More...</a><br/></td></tr>

  68. <tr><td colspan="2"><h2><a name="define-members"></a>

  69. Defines</h2></td></tr>

  70. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">TMC26X_OVERTEMPERATURE_PREWARING</a>&#160;&#160;&#160;1</td></tr>

  71. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature situation in the TMC chip  <a href="#add42eee34f674f92c19bcd5266d2445f"></a><br/></td></tr>

  72. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">TMC26X_OVERTEMPERATURE_SHUTDOWN</a>&#160;&#160;&#160;2</td></tr>

  73. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature shutdown in the TMC chip  <a href="#adae814ce848677abd87758c7ac79a436"></a><br/></td></tr>

  74. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26X_READOUT_POSITION</a>&#160;&#160;&#160;0</td></tr>

  75. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">TMC26X_READOUT_STALLGUARD</a>&#160;&#160;&#160;1</td></tr>

  76. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">TMC26X_READOUT_CURRENT</a>&#160;&#160;&#160;3</td></tr>

  77. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">COOL_STEP_HALF_CS_LIMIT</a>&#160;&#160;&#160;0</td></tr>

  78. <tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">COOL_STEP_QUARTDER_CS_LIMIT</a>&#160;&#160;&#160;1</td></tr>

  79. </table>

  80. <hr/><h2>Define Documentation</h2>

  81. <a class="anchor" id="a28b1774bd4aa854fb5e4b6dc7db96ecb"></a><!-- doxytag: member="TMC26XStepper.h::COOL_STEP_HALF_CS_LIMIT" ref="a28b1774bd4aa854fb5e4b6dc7db96ecb" args="" -->

  82. <div class="memitem">

  83. <div class="memproto">

  84.       <table class="memname">

  85.         <tr>

  86.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">COOL_STEP_HALF_CS_LIMIT</a>&#160;&#160;&#160;0</td>

  87.         </tr>

  88.       </table>

  89. </div>

  90. <div class="memdoc">

  91. <p>Define to set the minimum current for CoolStep operation to 1/2 of the selected CS minium. </p>

  92. <dl class="see"><dt><b>See also:</b></dt><dd>setCoolStepConfiguration() </dd></dl>

  93. 

  94. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00070">70</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  95. 

  96. </div>

  97. </div>

  98. <a class="anchor" id="a1a4db5eafd0a9247677153cb4c8b7d54"></a><!-- doxytag: member="TMC26XStepper.h::COOL_STEP_QUARTDER_CS_LIMIT" ref="a1a4db5eafd0a9247677153cb4c8b7d54" args="" -->

  99. <div class="memitem">

  100. <div class="memproto">

  101.       <table class="memname">

  102.         <tr>

  103.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">COOL_STEP_QUARTDER_CS_LIMIT</a>&#160;&#160;&#160;1</td>

  104.         </tr>

  105.       </table>

  106. </div>

  107. <div class="memdoc">

  108. <p>Define to set the minimum current for CoolStep operation to 1/4 of the selected CS minium. </p>

  109. <dl class="see"><dt><b>See also:</b></dt><dd>setCoolStepConfiguration() </dd></dl>

  110. 

  111. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00075">75</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  112. 

  113. </div>

  114. </div>

  115. <a class="anchor" id="add42eee34f674f92c19bcd5266d2445f"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_OVERTEMPERATURE_PREWARING" ref="add42eee34f674f92c19bcd5266d2445f" args="" -->

  116. <div class="memitem">

  117. <div class="memproto">

  118.       <table class="memname">

  119.         <tr>

  120.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">TMC26X_OVERTEMPERATURE_PREWARING</a>&#160;&#160;&#160;1</td>

  121.         </tr>

  122.       </table>

  123. </div>

  124. <div class="memdoc">

  125. 

  126. <p>return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature situation in the TMC chip </p>

  127. <p>This warning indicates that the TCM chip is too warm. It is still working but some parameters may be inferior. You should do something against it. </p>

  128. 

  129. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00039">39</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  130. 

  131. </div>

  132. </div>

  133. <a class="anchor" id="adae814ce848677abd87758c7ac79a436"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_OVERTEMPERATURE_SHUTDOWN" ref="adae814ce848677abd87758c7ac79a436" args="" -->

  134. <div class="memitem">

  135. <div class="memproto">

  136.       <table class="memname">

  137.         <tr>

  138.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">TMC26X_OVERTEMPERATURE_SHUTDOWN</a>&#160;&#160;&#160;2</td>

  139.         </tr>

  140.       </table>

  141. </div>

  142. <div class="memdoc">

  143. 

  144. <p>return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature shutdown in the TMC chip </p>

  145. <p>This warning indicates that the TCM chip is too warm to operate and has shut down to prevent damage. It will stop working until it cools down again. If you encouter this situation you must do something against it. Like reducing the current or improving the PCB layout and/or heat management. </p>

  146. 

  147. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00047">47</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  148. 

  149. </div>

  150. </div>

  151. <a class="anchor" id="a01760ad15e3846536526a990efe47094"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_READOUT_CURRENT" ref="a01760ad15e3846536526a990efe47094" args="" -->

  152. <div class="memitem">

  153. <div class="memproto">

  154.       <table class="memname">

  155.         <tr>

  156.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">TMC26X_READOUT_CURRENT</a>&#160;&#160;&#160;3</td>

  157.         </tr>

  158.       </table>

  159. </div>

  160. <div class="memdoc">

  161. <p>Selects to read out the current current setting (acc. to CoolStep) and the upper bits of the StallGuard value from the motor. </p>

  162. <dl class="see"><dt><b>See also:</b></dt><dd>readStatus(), setCurrent() </dd></dl>

  163. 

  164. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00064">64</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  165. 

  166. </div>

  167. </div>

  168. <a class="anchor" id="aff05d4a47ef8821322ccc2a20785fbee"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_READOUT_POSITION" ref="aff05d4a47ef8821322ccc2a20785fbee" args="" -->

  169. <div class="memitem">

  170. <div class="memproto">

  171.       <table class="memname">

  172.         <tr>

  173.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26X_READOUT_POSITION</a>&#160;&#160;&#160;0</td>

  174.         </tr>

  175.       </table>

  176. </div>

  177. <div class="memdoc">

  178. <p>Selects to readout the microstep position from the motor. </p>

  179. <dl class="see"><dt><b>See also:</b></dt><dd>readStatus() </dd></dl>

  180. 

  181. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00054">54</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  182. 

  183. </div>

  184. </div>

  185. <a class="anchor" id="ac864ff8886123039c7d2d3c617f7ef87"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_READOUT_STALLGUARD" ref="ac864ff8886123039c7d2d3c617f7ef87" args="" -->

  186. <div class="memitem">

  187. <div class="memproto">

  188.       <table class="memname">

  189.         <tr>

  190.           <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">TMC26X_READOUT_STALLGUARD</a>&#160;&#160;&#160;1</td>

  191.         </tr>

  192.       </table>

  193. </div>

  194. <div class="memdoc">

  195. <p>Selects to read out the StallGuard value of the motor. </p>

  196. <dl class="see"><dt><b>See also:</b></dt><dd>readStatus() </dd></dl>

  197. 

  198. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00059">59</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  199. 

  200. </div>

  201. </div>

  202. </div><!-- contents -->

  203. 

  204. 

  205. <hr class="footer"/><address class="footer"><small>

  206. Generated on Mon Nov 19 2012 20:26:21 for Trinamic TMC26X Stepper Driver for Arduino by &#160;<a href="http://www.doxygen.org/index.html">

  207. <img class="footer" src="doxygen.png" alt="doxygen"/>

  208. </a> 1.7.6.1

  209. </small></address>

  210. 

  211. </body>

  212. </html>