thomas
/
marlin
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
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 Commits
4 Branches
Tree: 38500165ea
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '38500165ea'
${ noResults }
marlin/ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/class_t_m_c26_x_stepper.html

class_t_m_c26_x_stepper.html 106KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463 
  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 Class 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 class="current"><a href="annotated.html"><span>Classes</span></a></li>

  43.       <li><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="annotated.html"><span>Class&#160;List</span></a></li>

  49.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>

  50.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>

  51.     </ul>

  52.   </div>

  53. </div>

  54. <div class="header">

  55.   <div class="summary">

  56. <a href="#pub-methods">Public Member Functions</a>  </div>

  57.   <div class="headertitle">

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

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

  60. <div class="contents">

  61. <!-- doxytag: class="TMC26XStepper" -->

  62. <p>Class representing a TMC26X stepper driver.  

  63.  <a href="class_t_m_c26_x_stepper.html#details">More...</a></p>

  64. 

  65. <p><code>#include &lt;<a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>&gt;</code></p>

  66. 

  67. <p><a href="class_t_m_c26_x_stepper-members.html">List of all members.</a></p>

  68. <table class="memberdecls">

  69. <tr><td colspan="2"><h2><a name="pub-methods"></a>

  70. Public Member Functions</h2></td></tr>

  71. <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a3ef40763b8b8ab2b6ed4978c0647906c">TMC26XStepper</a> (int number_of_steps, int cs_pin, int dir_pin, int step_pin, unsigned int current, unsigned int resistor=150)</td></tr>

  72. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">creates a new represenatation of a stepper motor connected to a TMC26X stepper driver  <a href="#a3ef40763b8b8ab2b6ed4978c0647906c"></a><br/></td></tr>

  73. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7">start</a> ()</td></tr>

  74. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">configures and starts the TMC26X stepper driver. Before you called this function the stepper driver is in nonfunctional mode.  <a href="#aad1ed82b3e05940bde5a6c7ed3d3e8f7"></a><br/></td></tr>

  75. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#af968e70a13068f1e71ac0fa6865630c5">un_start</a> ()</td></tr>

  76. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">resets the stepper in unconfigured mode.  <a href="#af968e70a13068f1e71ac0fa6865630c5"></a><br/></td></tr>

  77. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd">setSpeed</a> (unsigned int whatSpeed)</td></tr>

  78. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the rotation speed in revolutions per minute.  <a href="#a9478f43090995c8d5cdb4d4e8c07cdbd"></a><br/></td></tr>

  79. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aa564f5cc0218d30ef897c2830c768c29">getSpeed</a> (void)</td></tr>

  80. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">reads out the currently selected speed in revolutions per minute.  <a href="#aa564f5cc0218d30ef897c2830c768c29"></a><br/></td></tr>

  81. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0">setMicrosteps</a> (int number_of_steps)</td></tr>

  82. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the number of microsteps in 2^i values (rounded) up to 256.  <a href="#a21041579c7f9284567ee2e2a55a3afd0"></a><br/></td></tr>

  83. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3">getMicrosteps</a> (void)</td></tr>

  84. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the effective current number of microsteps selected.  <a href="#a5808551ced98b79c09bbb4bf47ecfec3"></a><br/></td></tr>

  85. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d">step</a> (int number_of_steps)</td></tr>

  86. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a movement for the given number of steps. Positive numbers move in one, negative numbers in the other direction.  <a href="#ac073a742496885f1f60751f9fb9c395d"></a><br/></td></tr>

  87. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415">move</a> (void)</td></tr>

  88. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Central movement method, must be called as often as possible in the lopp function and is very fast.  <a href="#aed5d81f1549615529c723600a68ba415"></a><br/></td></tr>

  89. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e">isMoving</a> (void)</td></tr>

  90. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">checks if the motor still has to move to fulfill the last movement command.  <a href="#a880d602be8414b7b965287c1790cd50e"></a><br/></td></tr>

  91. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7">getStepsLeft</a> (void)</td></tr>

  92. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the number of steps left in the current movement.  <a href="#aa6c3211f85301ca0fb2e7b73cb8142a7"></a><br/></td></tr>

  93. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123">stop</a> (void)</td></tr>

  94. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Stops the motor regardless if it moves or not.  <a href="#a6315c18eadbc6bf4f3d81a6f80296123"></a><br/></td></tr>

  95. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ac2d8a2bbae2aba3ed7c98e3ff1a06649">setConstantOffTimeChopper</a> (char constant_off_time, char blank_time, char fast_decay_time_setting, char sine_wave_offset, unsigned char use_current_comparator)</td></tr>

  96. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets and configure the classical Constant Off Timer Chopper.  <a href="#ac2d8a2bbae2aba3ed7c98e3ff1a06649"></a><br/></td></tr>

  97. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aa152bb7ddb72a2bc8465553a39232df2">setSpreadCycleChopper</a> (char constant_off_time, char blank_time, char hysteresis_start, char hysteresis_end, char hysteresis_decrement)</td></tr>

  98. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets and configures with spread cycle chopper.  <a href="#aa152bb7ddb72a2bc8465553a39232df2"></a><br/></td></tr>

  99. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a">setRandomOffTime</a> (char value)</td></tr>

  100. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Use random off time for noise reduction (0 for off, -1 for on).  <a href="#a7ffd602cf4bf385847cba034417d5f0a"></a><br/></td></tr>

  101. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aaa35fac83417c16b3a941fa168e4a4d2">setCurrent</a> (unsigned int current)</td></tr>

  102. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set the maximum motor current in mA (1000 is 1 Amp) Keep in mind this is the maximum peak Current. The RMS current will be 1/sqrt(2) smaller. The actual current can also be smaller by employing CoolStep.  <a href="#aaa35fac83417c16b3a941fa168e4a4d2"></a><br/></td></tr>

  103. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f">getCurrent</a> (void)</td></tr>

  104. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">readout the motor maximum current in mA (1000 is an Amp) This is the maximum current. to get the current current - which may be affected by CoolStep us <a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7" title="Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000...">getCurrentCurrent()</a>  <a href="#a0c544e23efe3e4a912aacf57de84b71f"></a><br/></td></tr>

  105. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a">setStallGuardThreshold</a> (char stall_guard_threshold, char stall_guard_filter_enabled)</td></tr>

  106. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">set the StallGuard threshold in order to get sensible StallGuard readings.  <a href="#af1a5abc23757860baf8ff421689a425a"></a><br/></td></tr>

  107. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a056661f444725c3ae15696d1e8d91def">getStallGuardThreshold</a> (void)</td></tr>

  108. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">reads out the StallGuard threshold  <a href="#a056661f444725c3ae15696d1e8d91def"></a><br/></td></tr>

  109. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a47e3443e3e786314c1099b8f14a91b8a">getStallGuardFilter</a> (void)</td></tr>

  110. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the current setting of the StallGuard filter  <a href="#a47e3443e3e786314c1099b8f14a91b8a"></a><br/></td></tr>

  111. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e">setCoolStepConfiguration</a> (unsigned int lower_SG_threshold, unsigned int SG_hysteresis, unsigned char current_decrement_step_size, unsigned char current_increment_step_size, unsigned char lower_current_limit)</td></tr>

  112. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">This method configures the CoolStep smart energy operation. You must have a proper StallGuard configuration for the motor situation (current, voltage, speed) in rder to use this feature.  <a href="#a381fbcce7c586ca2f1da8f9e704df14e"></a><br/></td></tr>

  113. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a15bf0ed5a166a5d9a41f90f3ccbc6157">setCoolStepEnabled</a> (boolean enabled)</td></tr>

  114. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">enables or disables the CoolStep smart energy operation feature. It must be configured before enabling it.  <a href="#a15bf0ed5a166a5d9a41f90f3ccbc6157"></a><br/></td></tr>

  115. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a6de2306b6d8dc1fa2e50fccb66d8e66d">isCoolStepEnabled</a> ()</td></tr>

  116. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">check if the CoolStep feature is enabled  <a href="#a6de2306b6d8dc1fa2e50fccb66d8e66d"></a><br/></td></tr>

  117. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aa7469949deaa39a58038b3ddef532bc8">getCoolStepLowerSgThreshold</a> ()</td></tr>

  118. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the lower StallGuard threshold for the CoolStep operation  <a href="#aa7469949deaa39a58038b3ddef532bc8"></a><br/></td></tr>

  119. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ac61298fd658773c28823d33ab04e970f">getCoolStepUpperSgThreshold</a> ()</td></tr>

  120. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the upper StallGuard threshold for the CoolStep operation  <a href="#ac61298fd658773c28823d33ab04e970f"></a><br/></td></tr>

  121. <tr><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aad44ee5ae73bf8e69af05674a304ba46">getCoolStepNumberOfSGReadings</a> ()</td></tr>

  122. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the number of StallGuard readings befor CoolStep adjusts the motor current.  <a href="#aad44ee5ae73bf8e69af05674a304ba46"></a><br/></td></tr>

  123. <tr><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ababe688a15f087d23d4ff2094fcee883">getCoolStepCurrentIncrementSize</a> ()</td></tr>

  124. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the increment steps for the current for the CoolStep operation  <a href="#ababe688a15f087d23d4ff2094fcee883"></a><br/></td></tr>

  125. <tr><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a0c7e8541abc120a3910e35c6fbf2167c">getCoolStepLowerCurrentLimit</a> ()</td></tr>

  126. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">returns the absolut minium current for the CoolStep operation  <a href="#a0c7e8541abc120a3910e35c6fbf2167c"></a><br/></td></tr>

  127. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125">getMotorPosition</a> (void)</td></tr>

  128. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current microstep position for phase A.  <a href="#a1019f6f889acfd3176eecd60a0a20125"></a><br/></td></tr>

  129. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e">getCurrentStallGuardReading</a> (void)</td></tr>

  130. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current StallGuard value.  <a href="#aed570ce3eea640e087b046333015de1e"></a><br/></td></tr>

  131. <tr><td class="memItemLeft" align="right" valign="top">unsigned char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a1a939fb495d747c2c11be99a740371e1">getCurrentCSReading</a> (void)</td></tr>

  132. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current current setting value as fraction of the maximum current Returns values between 0 and 31, representing 1/32 to 32/32 (=1)  <a href="#a1a939fb495d747c2c11be99a740371e1"></a><br/></td></tr>

  133. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ad435db189ebb101fb2de90a484f33905">isCurrentScalingHalfed</a> ()</td></tr>

  134. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">a convenience method to determine if the current scaling uses 0.31V or 0.165V as reference.  <a href="#ad435db189ebb101fb2de90a484f33905"></a><br/></td></tr>

  135. <tr><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7">getCurrentCurrent</a> (void)</td></tr>

  136. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000). This method calculates the currently used current setting (either by setting or by CoolStep) and reconstructs the current in mA by usinge the VSENSE and resistor value. This method uses floating point math - so it may not be the fastest.  <a href="#aa00741168a7def0a7a9d2f2c9d3b99d7"></a><br/></td></tr>

  137. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41">isStallGuardOverThreshold</a> (void)</td></tr>

  138. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">checks if there is a StallGuard warning in the last status  <a href="#aea4c6e1fac909116c6b55f902d6cff41"></a><br/></td></tr>

  139. <tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7">getOverTemperature</a> (void)</td></tr>

  140. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return over temperature status of the last status readout return 0 is everything is OK, TMC26X_OVERTEMPERATURE_PREWARING if status is reached, TMC26X_OVERTEMPERATURE_SHUTDOWN is the chip is shutdown, -1 if the status is unknown. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout.  <a href="#a7662c2fbc03d1f5a7da5cabcc153b2d7"></a><br/></td></tr>

  141. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ad329fa4693d3139dea241ebe3d0f33cf">isShortToGroundA</a> (void)</td></tr>

  142. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Is motor channel A shorted to ground detected in the last status readout.  <a href="#ad329fa4693d3139dea241ebe3d0f33cf"></a><br/></td></tr>

  143. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a0ccb54d40cce0d802aa56ff6261f9f3b">isShortToGroundB</a> (void)</td></tr>

  144. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Is motor channel B shorted to ground detected in the last status readout.  <a href="#a0ccb54d40cce0d802aa56ff6261f9f3b"></a><br/></td></tr>

  145. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#af97b2ab9d1ba36765ac6f17cf25ec45c">isOpenLoadA</a> (void)</td></tr>

  146. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">iIs motor channel A connected according to the last statu readout.  <a href="#af97b2ab9d1ba36765ac6f17cf25ec45c"></a><br/></td></tr>

  147. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a303590124f5ac6d6a06d0ec60d0b5303">isOpenLoadB</a> (void)</td></tr>

  148. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">iIs motor channel A connected according to the last statu readout.  <a href="#a303590124f5ac6d6a06d0ec60d0b5303"></a><br/></td></tr>

  149. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ab26602f360a4fb6ec6d262011675b2b0">isStandStill</a> (void)</td></tr>

  150. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Is chopper inactive since 2^20 clock cycles - defaults to ~0,08s.  <a href="#ab26602f360a4fb6ec6d262011675b2b0"></a><br/></td></tr>

  151. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#afdeded501ec2cabeffde33d31b6573f7">isStallGuardReached</a> (void)</td></tr>

  152. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">checks if there is a StallGuard warning in the last status  <a href="#afdeded501ec2cabeffde33d31b6573f7"></a><br/></td></tr>

  153. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a4472cd86ad5b65dec5ec45ce69158305">setEnabled</a> (boolean enabled)</td></tr>

  154. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">enables or disables the motor driver bridges. If disabled the motor can run freely. If enabled not.  <a href="#a4472cd86ad5b65dec5ec45ce69158305"></a><br/></td></tr>

  155. <tr><td class="memItemLeft" align="right" valign="top">boolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#a15796c0cbdeab23a343c3f25327283b6">isEnabled</a> ()</td></tr>

  156. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">checks if the output bridges are enabled. If the bridges are not enabled the motor can run freely  <a href="#a15796c0cbdeab23a343c3f25327283b6"></a><br/></td></tr>

  157. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#af95a824bfdf49ef979b5354798e52967">readStatus</a> (char read_value)</td></tr>

  158. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Manually read out the status register This function sends a byte to the motor driver in order to get the current readout. The parameter read_value seletcs which value will get returned. If the read_vlaue changes in respect to the previous readout this method automatically send two bytes to the motor: one to set the redout and one to get the actual readout. So this method may take time to send and read one or two bits - depending on the previous readout.  <a href="#af95a824bfdf49ef979b5354798e52967"></a><br/></td></tr>

  159. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ae1db5ec2ec9bfbfaea83c659e006692e">getResistor</a> ()</td></tr>

  160. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current sense resistor value in milliohm. The default value of ,15 Ohm will return 150.  <a href="#ae1db5ec2ec9bfbfaea83c659e006692e"></a><br/></td></tr>

  161. <tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ad5e5b1bf5a46d02577dd548083877ec3">debugLastStatus</a> (void)</td></tr>

  162. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Prints out all the information that can be found in the last status read out - it does not force a status readout. The result is printed via Serial.  <a href="#ad5e5b1bf5a46d02577dd548083877ec3"></a><br/></td></tr>

  163. <tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html#ab040d9df1e85d6fb0c105205a36b0215">version</a> (void)</td></tr>

  164. <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">library version  <a href="#ab040d9df1e85d6fb0c105205a36b0215"></a><br/></td></tr>

  165. </table>

  166. <hr/><a name="details" id="details"></a><h2>Detailed Description</h2>

  167. <div class="textblock"><p>Class representing a TMC26X stepper driver. </p>

  168. <p>In order to use one fo those drivers in your Arduino code you have to create an object of that class: </p>

  169. <div class="fragment"><pre class="fragment"> <a class="code" href="class_t_m_c26_x_stepper.html" title="Class representing a TMC26X stepper driver.">TMC26XStepper</a> stepper = <a class="code" href="class_t_m_c26_x_stepper.html#a3ef40763b8b8ab2b6ed4978c0647906c" title="creates a new represenatation of a stepper motor connected to a TMC26X stepper driver">TMC26XStepper</a>(200,1,2,3,500);

  170. </pre></div><p> see TMC26XStepper(int number_of_steps, int cs_pin, int dir_pin, int step_pin, unsigned int rms_current)</p>

  171. <p>Keep in mind that you need to start the driver with <a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7" title="configures and starts the TMC26X stepper driver. Before you called this function the stepper driver i...">start()</a> in order to get the TMC26X configured.</p>

  172. <p>The most important function is the <a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415" title="Central movement method, must be called as often as possible in the lopp function and is very fast...">move()</a>. It checks if the motor has to do a step or not. It is important that you call <a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415" title="Central movement method, must be called as often as possible in the lopp function and is very fast...">move()</a> as often as possible in your Arduino loop() routine. I suggest to use a very fast loop routine and always call it at the beginning or the end.</p>

  173. <p>In order to move you have to provide a movement speed with <a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd" title="Sets the rotation speed in revolutions per minute.">setSpeed()</a>. The speed is a positive value setting the rotations per minute.</p>

  174. <p>To really move the motor you have to call <a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d" title="Initiate a movement for the given number of steps. Positive numbers move in one, negative numbers in ...">step()</a> to tell the driver to move the motor the given number of steps in the given direction. Positive values move the motor in one direction, negative values in the other direction.</p>

  175. <p>You can check with <a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e" title="checks if the motor still has to move to fulfill the last movement command.">isMoving()</a> if the mototr is still moving or stop it apruptely with <a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123" title="Stops the motor regardless if it moves or not.">stop()</a>. </p>

  176. 

  177. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00101">101</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>

  178. </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>

  179. <a class="anchor" id="a3ef40763b8b8ab2b6ed4978c0647906c"></a><!-- doxytag: member="TMC26XStepper::TMC26XStepper" ref="a3ef40763b8b8ab2b6ed4978c0647906c" args="(int number_of_steps, int cs_pin, int dir_pin, int step_pin, unsigned int current, unsigned int resistor=150)" -->

  180. <div class="memitem">

  181. <div class="memproto">

  182.       <table class="memname">

  183.         <tr>

  184.           <td class="memname"><a class="el" href="class_t_m_c26_x_stepper.html#a3ef40763b8b8ab2b6ed4978c0647906c">TMC26XStepper::TMC26XStepper</a> </td>

  185.           <td>(</td>

  186.           <td class="paramtype">int&#160;</td>

  187.           <td class="paramname"><em>number_of_steps</em>, </td>

  188.         </tr>

  189.         <tr>

  190.           <td class="paramkey"></td>

  191.           <td></td>

  192.           <td class="paramtype">int&#160;</td>

  193.           <td class="paramname"><em>cs_pin</em>, </td>

  194.         </tr>

  195.         <tr>

  196.           <td class="paramkey"></td>

  197.           <td></td>

  198.           <td class="paramtype">int&#160;</td>

  199.           <td class="paramname"><em>dir_pin</em>, </td>

  200.         </tr>

  201.         <tr>

  202.           <td class="paramkey"></td>

  203.           <td></td>

  204.           <td class="paramtype">int&#160;</td>

  205.           <td class="paramname"><em>step_pin</em>, </td>

  206.         </tr>

  207.         <tr>

  208.           <td class="paramkey"></td>

  209.           <td></td>

  210.           <td class="paramtype">unsigned int&#160;</td>

  211.           <td class="paramname"><em>current</em>, </td>

  212.         </tr>

  213.         <tr>

  214.           <td class="paramkey"></td>

  215.           <td></td>

  216.           <td class="paramtype">unsigned int&#160;</td>

  217.           <td class="paramname"><em>resistor</em> = <code>150</code>&#160;</td>

  218.         </tr>

  219.         <tr>

  220.           <td></td>

  221.           <td>)</td>

  222.           <td></td><td></td>

  223.         </tr>

  224.       </table>

  225. </div>

  226. <div class="memdoc">

  227. 

  228. <p>creates a new represenatation of a stepper motor connected to a TMC26X stepper driver </p>

  229. <p>This is the main constructor. If in doubt use this. You must provide all parameters as described below.</p>

  230. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  231.   <table class="params">

  232.     <tr><td class="paramname">number_of_steps</td><td>the number of steps the motor has per rotation. </td></tr>

  233.     <tr><td class="paramname">cs_pin</td><td>The Arduino pin you have connected the Cient Select Pin (!CS) of the TMC26X for SPI </td></tr>

  234.     <tr><td class="paramname">dir_pin</td><td>the number of the Arduino pin the Direction input of the TMC26X is connected </td></tr>

  235.     <tr><td class="paramname">step_pin</td><td>the number of the Arduino pin the step pin of the TMC26X driver is connected. </td></tr>

  236.     <tr><td class="paramname">rms_current</td><td>the maximum current to privide to the motor in mA (!). A value of 200 would send up to 200mA to the motor </td></tr>

  237.     <tr><td class="paramname">resistor</td><td>the current sense resistor in milli Ohm, defaults to ,15 Ohm ( or 150 milli Ohm) as in the TMC260 Arduino Shield</td></tr>

  238.   </table>

  239.   </dd>

  240. </dl>

  241. <p>Keep in mind that you must also call <a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7" title="configures and starts the TMC26X stepper driver. Before you called this function the stepper driver i...">TMC26XStepper.start()</a> in order to configure the stepper driver for use.</p>

  242. <p>By default the Constant Off Time chopper is used, see TCM262Stepper.setConstantOffTimeChopper() for details. This should work on most motors (YMMV). You may want to configure and use the Spread Cycle Chopper, see <a class="el" href="class_t_m_c26_x_stepper.html#aa152bb7ddb72a2bc8465553a39232df2" title="Sets and configures with spread cycle chopper.">setSpreadCycleChopper()</a>.</p>

  243. <p>By default a microstepping of 1/32th is used to provide a smooth motor run, while still giving a good progression per step. You can select a different stepping with <a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0" title="Set the number of microsteps in 2^i values (rounded) up to 256.">setMicrosteps()</a> to aa different value. </p>

  244. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7" title="configures and starts the TMC26X stepper driver. Before you called this function the stepper driver i...">start()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0" title="Set the number of microsteps in 2^i values (rounded) up to 256.">setMicrosteps()</a> </dd></dl>

  245. 

  246. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00111">111</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  247. 

  248. </div>

  249. </div>

  250. <hr/><h2>Member Function Documentation</h2>

  251. <a class="anchor" id="ad5e5b1bf5a46d02577dd548083877ec3"></a><!-- doxytag: member="TMC26XStepper::debugLastStatus" ref="ad5e5b1bf5a46d02577dd548083877ec3" args="(void)" -->

  252. <div class="memitem">

  253. <div class="memproto">

  254.       <table class="memname">

  255.         <tr>

  256.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#ad5e5b1bf5a46d02577dd548083877ec3">TMC26XStepper::debugLastStatus</a> </td>

  257.           <td>(</td>

  258.           <td class="paramtype">void&#160;</td>

  259.           <td class="paramname"></td><td>)</td>

  260.           <td></td>

  261.         </tr>

  262.       </table>

  263. </div>

  264. <div class="memdoc">

  265. 

  266. <p>Prints out all the information that can be found in the last status read out - it does not force a status readout. The result is printed via Serial. </p>

  267. 

  268. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00902">902</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  269. 

  270. </div>

  271. </div>

  272. <a class="anchor" id="ababe688a15f087d23d4ff2094fcee883"></a><!-- doxytag: member="TMC26XStepper::getCoolStepCurrentIncrementSize" ref="ababe688a15f087d23d4ff2094fcee883" args="()" -->

  273. <div class="memitem">

  274. <div class="memproto">

  275.       <table class="memname">

  276.         <tr>

  277.           <td class="memname">unsigned char <a class="el" href="class_t_m_c26_x_stepper.html#ababe688a15f087d23d4ff2094fcee883">TMC26XStepper::getCoolStepCurrentIncrementSize</a> </td>

  278.           <td>(</td>

  279.           <td class="paramname"></td><td>)</td>

  280.           <td></td>

  281.         </tr>

  282.       </table>

  283. </div>

  284. <div class="memdoc">

  285. 

  286. <p>returns the increment steps for the current for the CoolStep operation </p>

  287. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd></dl>

  288. 

  289. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00704">704</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  290. 

  291. </div>

  292. </div>

  293. <a class="anchor" id="a0c7e8541abc120a3910e35c6fbf2167c"></a><!-- doxytag: member="TMC26XStepper::getCoolStepLowerCurrentLimit" ref="a0c7e8541abc120a3910e35c6fbf2167c" args="()" -->

  294. <div class="memitem">

  295. <div class="memproto">

  296.       <table class="memname">

  297.         <tr>

  298.           <td class="memname">unsigned char <a class="el" href="class_t_m_c26_x_stepper.html#a0c7e8541abc120a3910e35c6fbf2167c">TMC26XStepper::getCoolStepLowerCurrentLimit</a> </td>

  299.           <td>(</td>

  300.           <td class="paramname"></td><td>)</td>

  301.           <td></td>

  302.         </tr>

  303.       </table>

  304. </div>

  305. <div class="memdoc">

  306. 

  307. <p>returns the absolut minium current for the CoolStep operation </p>

  308. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd>

  309. <dd>

  310. <a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">COOL_STEP_HALF_CS_LIMIT</a>, COOL_STEP_QUARTER_CS_LIMIT </dd></dl>

  311. 

  312. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00712">712</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  313. 

  314. </div>

  315. </div>

  316. <a class="anchor" id="aa7469949deaa39a58038b3ddef532bc8"></a><!-- doxytag: member="TMC26XStepper::getCoolStepLowerSgThreshold" ref="aa7469949deaa39a58038b3ddef532bc8" args="()" -->

  317. <div class="memitem">

  318. <div class="memproto">

  319.       <table class="memname">

  320.         <tr>

  321.           <td class="memname">unsigned int <a class="el" href="class_t_m_c26_x_stepper.html#aa7469949deaa39a58038b3ddef532bc8">TMC26XStepper::getCoolStepLowerSgThreshold</a> </td>

  322.           <td>(</td>

  323.           <td class="paramname"></td><td>)</td>

  324.           <td></td>

  325.         </tr>

  326.       </table>

  327. </div>

  328. <div class="memdoc">

  329. 

  330. <p>returns the lower StallGuard threshold for the CoolStep operation </p>

  331. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd></dl>

  332. 

  333. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00695">695</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  334. 

  335. </div>

  336. </div>

  337. <a class="anchor" id="aad44ee5ae73bf8e69af05674a304ba46"></a><!-- doxytag: member="TMC26XStepper::getCoolStepNumberOfSGReadings" ref="aad44ee5ae73bf8e69af05674a304ba46" args="()" -->

  338. <div class="memitem">

  339. <div class="memproto">

  340.       <table class="memname">

  341.         <tr>

  342.           <td class="memname">unsigned char <a class="el" href="class_t_m_c26_x_stepper.html#aad44ee5ae73bf8e69af05674a304ba46">TMC26XStepper::getCoolStepNumberOfSGReadings</a> </td>

  343.           <td>(</td>

  344.           <td class="paramname"></td><td>)</td>

  345.           <td></td>

  346.         </tr>

  347.       </table>

  348. </div>

  349. <div class="memdoc">

  350. 

  351. <p>returns the number of StallGuard readings befor CoolStep adjusts the motor current. </p>

  352. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd></dl>

  353. 

  354. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00708">708</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  355. 

  356. </div>

  357. </div>

  358. <a class="anchor" id="ac61298fd658773c28823d33ab04e970f"></a><!-- doxytag: member="TMC26XStepper::getCoolStepUpperSgThreshold" ref="ac61298fd658773c28823d33ab04e970f" args="()" -->

  359. <div class="memitem">

  360. <div class="memproto">

  361.       <table class="memname">

  362.         <tr>

  363.           <td class="memname">unsigned int <a class="el" href="class_t_m_c26_x_stepper.html#ac61298fd658773c28823d33ab04e970f">TMC26XStepper::getCoolStepUpperSgThreshold</a> </td>

  364.           <td>(</td>

  365.           <td class="paramname"></td><td>)</td>

  366.           <td></td>

  367.         </tr>

  368.       </table>

  369. </div>

  370. <div class="memdoc">

  371. 

  372. <p>returns the upper StallGuard threshold for the CoolStep operation </p>

  373. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd></dl>

  374. 

  375. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00700">700</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  376. 

  377. </div>

  378. </div>

  379. <a class="anchor" id="a0c544e23efe3e4a912aacf57de84b71f"></a><!-- doxytag: member="TMC26XStepper::getCurrent" ref="a0c544e23efe3e4a912aacf57de84b71f" args="(void)" -->

  380. <div class="memitem">

  381. <div class="memproto">

  382.       <table class="memname">

  383.         <tr>

  384.           <td class="memname">unsigned int <a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f">TMC26XStepper::getCurrent</a> </td>

  385.           <td>(</td>

  386.           <td class="paramtype">void&#160;</td>

  387.           <td class="paramname"></td><td>)</td>

  388.           <td></td>

  389.         </tr>

  390.       </table>

  391. </div>

  392. <div class="memdoc">

  393. 

  394. <p>readout the motor maximum current in mA (1000 is an Amp) This is the maximum current. to get the current current - which may be affected by CoolStep us <a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7" title="Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000...">getCurrentCurrent()</a> </p>

  395. <dl class="return"><dt><b>Returns:</b></dt><dd>the maximum motor current in milli amps </dd></dl>

  396. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7" title="Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000...">getCurrentCurrent()</a> </dd></dl>

  397. 

  398. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00336">336</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  399. 

  400. </div>

  401. </div>

  402. <a class="anchor" id="a1a939fb495d747c2c11be99a740371e1"></a><!-- doxytag: member="TMC26XStepper::getCurrentCSReading" ref="a1a939fb495d747c2c11be99a740371e1" args="(void)" -->

  403. <div class="memitem">

  404. <div class="memproto">

  405.       <table class="memname">

  406.         <tr>

  407.           <td class="memname">unsigned char <a class="el" href="class_t_m_c26_x_stepper.html#a1a939fb495d747c2c11be99a740371e1">TMC26XStepper::getCurrentCSReading</a> </td>

  408.           <td>(</td>

  409.           <td class="paramtype">void&#160;</td>

  410.           <td class="paramname"></td><td>)</td>

  411.           <td></td>

  412.         </tr>

  413.       </table>

  414. </div>

  415. <div class="memdoc">

  416. 

  417. <p>Reads the current current setting value as fraction of the maximum current Returns values between 0 and 31, representing 1/32 to 32/32 (=1) </p>

  418. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd></dl>

  419. 

  420. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00781">781</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  421. 

  422. </div>

  423. </div>

  424. <a class="anchor" id="aa00741168a7def0a7a9d2f2c9d3b99d7"></a><!-- doxytag: member="TMC26XStepper::getCurrentCurrent" ref="aa00741168a7def0a7a9d2f2c9d3b99d7" args="(void)" -->

  425. <div class="memitem">

  426. <div class="memproto">

  427.       <table class="memname">

  428.         <tr>

  429.           <td class="memname">unsigned int <a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7">TMC26XStepper::getCurrentCurrent</a> </td>

  430.           <td>(</td>

  431.           <td class="paramtype">void&#160;</td>

  432.           <td class="paramname"></td><td>)</td>

  433.           <td></td>

  434.         </tr>

  435.       </table>

  436. </div>

  437. <div class="memdoc">

  438. 

  439. <p>Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000). This method calculates the currently used current setting (either by setting or by CoolStep) and reconstructs the current in mA by usinge the VSENSE and resistor value. This method uses floating point math - so it may not be the fastest. </p>

  440. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a1a939fb495d747c2c11be99a740371e1" title="Reads the current current setting value as fraction of the maximum current Returns values between 0 a...">getCurrentCSReading()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#ae1db5ec2ec9bfbfaea83c659e006692e" title="Returns the current sense resistor value in milliohm. The default value of ,15 Ohm will return 150...">getResistor()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#ad435db189ebb101fb2de90a484f33905" title="a convenience method to determine if the current scaling uses 0.31V or 0.165V as reference.">isCurrentScalingHalfed()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f" title="readout the motor maximum current in mA (1000 is an Amp) This is the maximum current. to get the current current - which may be affected by CoolStep us getCurrentCurrent()">getCurrent()</a> </dd></dl>

  441. 

  442. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00792">792</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  443. 

  444. </div>

  445. </div>

  446. <a class="anchor" id="aed570ce3eea640e087b046333015de1e"></a><!-- doxytag: member="TMC26XStepper::getCurrentStallGuardReading" ref="aed570ce3eea640e087b046333015de1e" args="(void)" -->

  447. <div class="memitem">

  448. <div class="memproto">

  449.       <table class="memname">

  450.         <tr>

  451.           <td class="memname">int <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e">TMC26XStepper::getCurrentStallGuardReading</a> </td>

  452.           <td>(</td>

  453.           <td class="paramtype">void&#160;</td>

  454.           <td class="paramname"></td><td>)</td>

  455.           <td></td>

  456.         </tr>

  457.       </table>

  458. </div>

  459. <div class="memdoc">

  460. 

  461. <p>Reads the current StallGuard value. </p>

  462. <dl class="return"><dt><b>Returns:</b></dt><dd>The current StallGuard value, lesser values indicate higher load, 0 means stall detected. Keep in mind that this routine reads and writes a value via SPI - so this may take a bit time. </dd></dl>

  463. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a" title="set the StallGuard threshold in order to get sensible StallGuard readings.">setStallGuardThreshold()</a> for tuning the readout to sensible ranges. </dd></dl>

  464. 

  465. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00770">770</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  466. 

  467. </div>

  468. </div>

  469. <a class="anchor" id="a5808551ced98b79c09bbb4bf47ecfec3"></a><!-- doxytag: member="TMC26XStepper::getMicrosteps" ref="a5808551ced98b79c09bbb4bf47ecfec3" args="(void)" -->

  470. <div class="memitem">

  471. <div class="memproto">

  472.       <table class="memname">

  473.         <tr>

  474.           <td class="memname">int <a class="el" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3">TMC26XStepper::getMicrosteps</a> </td>

  475.           <td>(</td>

  476.           <td class="paramtype">void&#160;</td>

  477.           <td class="paramname"></td><td>)</td>

  478.           <td></td>

  479.         </tr>

  480.       </table>

  481. </div>

  482. <div class="memdoc">

  483. 

  484. <p>returns the effective current number of microsteps selected. </p>

  485. <p>This function always returns the effective number of microsteps. This can be a bit different than the micro steps set in <a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0" title="Set the number of microsteps in 2^i values (rounded) up to 256.">setMicrosteps()</a> since it is rounded to 2^i.</p>

  486. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0" title="Set the number of microsteps in 2^i values (rounded) up to 256.">setMicrosteps()</a> </dd></dl>

  487. 

  488. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00446">446</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  489. 

  490. </div>

  491. </div>

  492. <a class="anchor" id="a1019f6f889acfd3176eecd60a0a20125"></a><!-- doxytag: member="TMC26XStepper::getMotorPosition" ref="a1019f6f889acfd3176eecd60a0a20125" args="(void)" -->

  493. <div class="memitem">

  494. <div class="memproto">

  495.       <table class="memname">

  496.         <tr>

  497.           <td class="memname">int <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125">TMC26XStepper::getMotorPosition</a> </td>

  498.           <td>(</td>

  499.           <td class="paramtype">void&#160;</td>

  500.           <td class="paramname"></td><td>)</td>

  501.           <td></td>

  502.         </tr>

  503.       </table>

  504. </div>

  505. <div class="memdoc">

  506. 

  507. <p>Get the current microstep position for phase A. </p>

  508. <dl class="return"><dt><b>Returns:</b></dt><dd>The current microstep position for phase A 0…255</dd></dl>

  509. <p>Keep in mind that this routine reads and writes a value via SPI - so this may take a bit time. </p>

  510. 

  511. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00762">762</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  512. 

  513. </div>

  514. </div>

  515. <a class="anchor" id="a7662c2fbc03d1f5a7da5cabcc153b2d7"></a><!-- doxytag: member="TMC26XStepper::getOverTemperature" ref="a7662c2fbc03d1f5a7da5cabcc153b2d7" args="(void)" -->

  516. <div class="memitem">

  517. <div class="memproto">

  518.       <table class="memname">

  519.         <tr>

  520.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7">TMC26XStepper::getOverTemperature</a> </td>

  521.           <td>(</td>

  522.           <td class="paramtype">void&#160;</td>

  523.           <td class="paramname"></td><td>)</td>

  524.           <td></td>

  525.         </tr>

  526.       </table>

  527. </div>

  528. <div class="memdoc">

  529. 

  530. <p>Return over temperature status of the last status readout return 0 is everything is OK, TMC26X_OVERTEMPERATURE_PREWARING if status is reached, TMC26X_OVERTEMPERATURE_SHUTDOWN is the chip is shutdown, -1 if the status is unknown. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout. </p>

  531. 

  532. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00816">816</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  533. 

  534. </div>

  535. </div>

  536. <a class="anchor" id="ae1db5ec2ec9bfbfaea83c659e006692e"></a><!-- doxytag: member="TMC26XStepper::getResistor" ref="ae1db5ec2ec9bfbfaea83c659e006692e" args="()" -->

  537. <div class="memitem">

  538. <div class="memproto">

  539.       <table class="memname">

  540.         <tr>

  541.           <td class="memname">int <a class="el" href="class_t_m_c26_x_stepper.html#ae1db5ec2ec9bfbfaea83c659e006692e">TMC26XStepper::getResistor</a> </td>

  542.           <td>(</td>

  543.           <td class="paramname"></td><td>)</td>

  544.           <td></td>

  545.         </tr>

  546.       </table>

  547. </div>

  548. <div class="memdoc">

  549. 

  550. <p>Returns the current sense resistor value in milliohm. The default value of ,15 Ohm will return 150. </p>

  551. 

  552. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00883">883</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  553. 

  554. </div>

  555. </div>

  556. <a class="anchor" id="aa564f5cc0218d30ef897c2830c768c29"></a><!-- doxytag: member="TMC26XStepper::getSpeed" ref="aa564f5cc0218d30ef897c2830c768c29" args="(void)" -->

  557. <div class="memitem">

  558. <div class="memproto">

  559.       <table class="memname">

  560.         <tr>

  561.           <td class="memname">unsigned int <a class="el" href="class_t_m_c26_x_stepper.html#aa564f5cc0218d30ef897c2830c768c29">TMC26XStepper::getSpeed</a> </td>

  562.           <td>(</td>

  563.           <td class="paramtype">void&#160;</td>

  564.           <td class="paramname"></td><td>)</td>

  565.           <td></td>

  566.         </tr>

  567.       </table>

  568. </div>

  569. <div class="memdoc">

  570. 

  571. <p>reads out the currently selected speed in revolutions per minute. </p>

  572. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd" title="Sets the rotation speed in revolutions per minute.">setSpeed()</a> </dd></dl>

  573. 

  574. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00221">221</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  575. 

  576. </div>

  577. </div>

  578. <a class="anchor" id="a47e3443e3e786314c1099b8f14a91b8a"></a><!-- doxytag: member="TMC26XStepper::getStallGuardFilter" ref="a47e3443e3e786314c1099b8f14a91b8a" args="(void)" -->

  579. <div class="memitem">

  580. <div class="memproto">

  581.       <table class="memname">

  582.         <tr>

  583.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#a47e3443e3e786314c1099b8f14a91b8a">TMC26XStepper::getStallGuardFilter</a> </td>

  584.           <td>(</td>

  585.           <td class="paramtype">void&#160;</td>

  586.           <td class="paramname"></td><td>)</td>

  587.           <td></td>

  588.         </tr>

  589.       </table>

  590. </div>

  591. <div class="memdoc">

  592. 

  593. <p>returns the current setting of the StallGuard filter </p>

  594. <dl class="return"><dt><b>Returns:</b></dt><dd>0 if not set, -1 if set </dd></dl>

  595. 

  596. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00381">381</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  597. 

  598. </div>

  599. </div>

  600. <a class="anchor" id="a056661f444725c3ae15696d1e8d91def"></a><!-- doxytag: member="TMC26XStepper::getStallGuardThreshold" ref="a056661f444725c3ae15696d1e8d91def" args="(void)" -->

  601. <div class="memitem">

  602. <div class="memproto">

  603.       <table class="memname">

  604.         <tr>

  605.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#a056661f444725c3ae15696d1e8d91def">TMC26XStepper::getStallGuardThreshold</a> </td>

  606.           <td>(</td>

  607.           <td class="paramtype">void&#160;</td>

  608.           <td class="paramname"></td><td>)</td>

  609.           <td></td>

  610.         </tr>

  611.       </table>

  612. </div>

  613. <div class="memdoc">

  614. 

  615. <p>reads out the StallGuard threshold </p>

  616. <dl class="return"><dt><b>Returns:</b></dt><dd>a number between -64 and 63. </dd></dl>

  617. 

  618. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00368">368</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  619. 

  620. </div>

  621. </div>

  622. <a class="anchor" id="aa6c3211f85301ca0fb2e7b73cb8142a7"></a><!-- doxytag: member="TMC26XStepper::getStepsLeft" ref="aa6c3211f85301ca0fb2e7b73cb8142a7" args="(void)" -->

  623. <div class="memitem">

  624. <div class="memproto">

  625.       <table class="memname">

  626.         <tr>

  627.           <td class="memname">unsigned int <a class="el" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7">TMC26XStepper::getStepsLeft</a> </td>

  628.           <td>(</td>

  629.           <td class="paramtype">void&#160;</td>

  630.           <td class="paramname"></td><td>)</td>

  631.           <td></td>

  632.         </tr>

  633.       </table>

  634. </div>

  635. <div class="memdoc">

  636. 

  637. <p>Get the number of steps left in the current movement. </p>

  638. <dl class="return"><dt><b>Returns:</b></dt><dd>The number of steps left in the movement. This number is always positive. </dd></dl>

  639. 

  640. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00278">278</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  641. 

  642. </div>

  643. </div>

  644. <a class="anchor" id="a6de2306b6d8dc1fa2e50fccb66d8e66d"></a><!-- doxytag: member="TMC26XStepper::isCoolStepEnabled" ref="a6de2306b6d8dc1fa2e50fccb66d8e66d" args="()" -->

  645. <div class="memitem">

  646. <div class="memproto">

  647.       <table class="memname">

  648.         <tr>

  649.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#a6de2306b6d8dc1fa2e50fccb66d8e66d">TMC26XStepper::isCoolStepEnabled</a> </td>

  650.           <td>(</td>

  651.           <td class="paramtype">void&#160;</td>

  652.           <td class="paramname"></td><td>)</td>

  653.           <td></td>

  654.         </tr>

  655.       </table>

  656. </div>

  657. <div class="memdoc">

  658. 

  659. <p>check if the CoolStep feature is enabled </p>

  660. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a15bf0ed5a166a5d9a41f90f3ccbc6157" title="enables or disables the CoolStep smart energy operation feature. It must be configured before enablin...">setCoolStepEnabled()</a> </dd></dl>

  661. 

  662. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00691">691</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  663. 

  664. </div>

  665. </div>

  666. <a class="anchor" id="ad435db189ebb101fb2de90a484f33905"></a><!-- doxytag: member="TMC26XStepper::isCurrentScalingHalfed" ref="ad435db189ebb101fb2de90a484f33905" args="()" -->

  667. <div class="memitem">

  668. <div class="memproto">

  669.       <table class="memname">

  670.         <tr>

  671.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#ad435db189ebb101fb2de90a484f33905">TMC26XStepper::isCurrentScalingHalfed</a> </td>

  672.           <td>(</td>

  673.           <td class="paramname"></td><td>)</td>

  674.           <td></td>

  675.         </tr>

  676.       </table>

  677. </div>

  678. <div class="memdoc">

  679. 

  680. <p>a convenience method to determine if the current scaling uses 0.31V or 0.165V as reference. </p>

  681. <dl class="return"><dt><b>Returns:</b></dt><dd>false if 0.13V is the reference voltage, true if 0.165V is used. </dd></dl>

  682. 

  683. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00887">887</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  684. 

  685. </div>

  686. </div>

  687. <a class="anchor" id="a15796c0cbdeab23a343c3f25327283b6"></a><!-- doxytag: member="TMC26XStepper::isEnabled" ref="a15796c0cbdeab23a343c3f25327283b6" args="()" -->

  688. <div class="memitem">

  689. <div class="memproto">

  690.       <table class="memname">

  691.         <tr>

  692.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#a15796c0cbdeab23a343c3f25327283b6">TMC26XStepper::isEnabled</a> </td>

  693.           <td>(</td>

  694.           <td class="paramname"></td><td>)</td>

  695.           <td></td>

  696.         </tr>

  697.       </table>

  698. </div>

  699. <div class="memdoc">

  700. 

  701. <p>checks if the output bridges are enabled. If the bridges are not enabled the motor can run freely </p>

  702. <dl class="return"><dt><b>Returns:</b></dt><dd>true if the bridges and by that the motor driver are enabled, false if not. </dd></dl>

  703. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a4472cd86ad5b65dec5ec45ce69158305" title="enables or disables the motor driver bridges. If disabled the motor can run freely. If enabled not.">setEnabled()</a> </dd></dl>

  704. 

  705. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00729">729</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  706. 

  707. </div>

  708. </div>

  709. <a class="anchor" id="a880d602be8414b7b965287c1790cd50e"></a><!-- doxytag: member="TMC26XStepper::isMoving" ref="a880d602be8414b7b965287c1790cd50e" args="(void)" -->

  710. <div class="memitem">

  711. <div class="memproto">

  712.       <table class="memname">

  713.         <tr>

  714.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e">TMC26XStepper::isMoving</a> </td>

  715.           <td>(</td>

  716.           <td class="paramtype">void&#160;</td>

  717.           <td class="paramname"></td><td>)</td>

  718.           <td></td>

  719.         </tr>

  720.       </table>

  721. </div>

  722. <div class="memdoc">

  723. 

  724. <p>checks if the motor still has to move to fulfill the last movement command. </p>

  725. <dl class="return"><dt><b>Returns:</b></dt><dd>0 if the motor stops, -1 if the motor is moving.</dd></dl>

  726. <p>This method can be used to determine if the motor is ready for new movements. </p>

  727. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d" title="Initiate a movement for the given number of steps. Positive numbers move in one, negative numbers in ...">step()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415" title="Central movement method, must be called as often as possible in the lopp function and is very fast...">move()</a> </dd></dl>

  728. 

  729. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00274">274</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  730. 

  731. </div>

  732. </div>

  733. <a class="anchor" id="af97b2ab9d1ba36765ac6f17cf25ec45c"></a><!-- doxytag: member="TMC26XStepper::isOpenLoadA" ref="af97b2ab9d1ba36765ac6f17cf25ec45c" args="(void)" -->

  734. <div class="memitem">

  735. <div class="memproto">

  736.       <table class="memname">

  737.         <tr>

  738.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#af97b2ab9d1ba36765ac6f17cf25ec45c">TMC26XStepper::isOpenLoadA</a> </td>

  739.           <td>(</td>

  740.           <td class="paramtype">void&#160;</td>

  741.           <td class="paramname"></td><td>)</td>

  742.           <td></td>

  743.         </tr>

  744.       </table>

  745. </div>

  746. <div class="memdoc">

  747. 

  748. <p>iIs motor channel A connected according to the last statu readout. </p>

  749. <dl class="return"><dt><b>Returns:</b></dt><dd>true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout. </dd></dl>

  750. 

  751. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00846">846</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  752. 

  753. </div>

  754. </div>

  755. <a class="anchor" id="a303590124f5ac6d6a06d0ec60d0b5303"></a><!-- doxytag: member="TMC26XStepper::isOpenLoadB" ref="a303590124f5ac6d6a06d0ec60d0b5303" args="(void)" -->

  756. <div class="memitem">

  757. <div class="memproto">

  758.       <table class="memname">

  759.         <tr>

  760.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#a303590124f5ac6d6a06d0ec60d0b5303">TMC26XStepper::isOpenLoadB</a> </td>

  761.           <td>(</td>

  762.           <td class="paramtype">void&#160;</td>

  763.           <td class="paramname"></td><td>)</td>

  764.           <td></td>

  765.         </tr>

  766.       </table>

  767. </div>

  768. <div class="memdoc">

  769. 

  770. <p>iIs motor channel A connected according to the last statu readout. </p>

  771. <dl class="return"><dt><b>Returns:</b></dt><dd>true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout. </dd></dl>

  772. 

  773. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00854">854</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  774. 

  775. </div>

  776. </div>

  777. <a class="anchor" id="ad329fa4693d3139dea241ebe3d0f33cf"></a><!-- doxytag: member="TMC26XStepper::isShortToGroundA" ref="ad329fa4693d3139dea241ebe3d0f33cf" args="(void)" -->

  778. <div class="memitem">

  779. <div class="memproto">

  780.       <table class="memname">

  781.         <tr>

  782.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#ad329fa4693d3139dea241ebe3d0f33cf">TMC26XStepper::isShortToGroundA</a> </td>

  783.           <td>(</td>

  784.           <td class="paramtype">void&#160;</td>

  785.           <td class="paramname"></td><td>)</td>

  786.           <td></td>

  787.         </tr>

  788.       </table>

  789. </div>

  790. <div class="memdoc">

  791. 

  792. <p>Is motor channel A shorted to ground detected in the last status readout. </p>

  793. <dl class="return"><dt><b>Returns:</b></dt><dd>true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout. </dd></dl>

  794. 

  795. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00830">830</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  796. 

  797. </div>

  798. </div>

  799. <a class="anchor" id="a0ccb54d40cce0d802aa56ff6261f9f3b"></a><!-- doxytag: member="TMC26XStepper::isShortToGroundB" ref="a0ccb54d40cce0d802aa56ff6261f9f3b" args="(void)" -->

  800. <div class="memitem">

  801. <div class="memproto">

  802.       <table class="memname">

  803.         <tr>

  804.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#a0ccb54d40cce0d802aa56ff6261f9f3b">TMC26XStepper::isShortToGroundB</a> </td>

  805.           <td>(</td>

  806.           <td class="paramtype">void&#160;</td>

  807.           <td class="paramname"></td><td>)</td>

  808.           <td></td>

  809.         </tr>

  810.       </table>

  811. </div>

  812. <div class="memdoc">

  813. 

  814. <p>Is motor channel B shorted to ground detected in the last status readout. </p>

  815. <dl class="return"><dt><b>Returns:</b></dt><dd>true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout. </dd></dl>

  816. 

  817. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00838">838</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  818. 

  819. </div>

  820. </div>

  821. <a class="anchor" id="aea4c6e1fac909116c6b55f902d6cff41"></a><!-- doxytag: member="TMC26XStepper::isStallGuardOverThreshold" ref="aea4c6e1fac909116c6b55f902d6cff41" args="(void)" -->

  822. <div class="memitem">

  823. <div class="memproto">

  824.       <table class="memname">

  825.         <tr>

  826.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41">TMC26XStepper::isStallGuardOverThreshold</a> </td>

  827.           <td>(</td>

  828.           <td class="paramtype">void&#160;</td>

  829.           <td class="paramname"></td><td>)</td>

  830.           <td></td>

  831.         </tr>

  832.       </table>

  833. </div>

  834. <div class="memdoc">

  835. 

  836. <p>checks if there is a StallGuard warning in the last status </p>

  837. <dl class="return"><dt><b>Returns:</b></dt><dd>0 if there was no warning, -1 if there was some warning. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout.</dd></dl>

  838. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a" title="set the StallGuard threshold in order to get sensible StallGuard readings.">setStallGuardThreshold()</a> for tuning the readout to sensible ranges. </dd></dl>

  839. 

  840. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00803">803</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  841. 

  842. </div>

  843. </div>

  844. <a class="anchor" id="afdeded501ec2cabeffde33d31b6573f7"></a><!-- doxytag: member="TMC26XStepper::isStallGuardReached" ref="afdeded501ec2cabeffde33d31b6573f7" args="(void)" -->

  845. <div class="memitem">

  846. <div class="memproto">

  847.       <table class="memname">

  848.         <tr>

  849.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#afdeded501ec2cabeffde33d31b6573f7">TMC26XStepper::isStallGuardReached</a> </td>

  850.           <td>(</td>

  851.           <td class="paramtype">void&#160;</td>

  852.           <td class="paramname"></td><td>)</td>

  853.           <td></td>

  854.         </tr>

  855.       </table>

  856. </div>

  857. <div class="memdoc">

  858. 

  859. <p>checks if there is a StallGuard warning in the last status </p>

  860. <dl class="return"><dt><b>Returns:</b></dt><dd>0 if there was no warning, -1 if there was some warning. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout.</dd></dl>

  861. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41" title="checks if there is a StallGuard warning in the last status">isStallGuardOverThreshold()</a> TODO why?</dd>

  862. <dd>

  863. <a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a" title="set the StallGuard threshold in order to get sensible StallGuard readings.">setStallGuardThreshold()</a> for tuning the readout to sensible ranges. </dd></dl>

  864. 

  865. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00870">870</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  866. 

  867. </div>

  868. </div>

  869. <a class="anchor" id="ab26602f360a4fb6ec6d262011675b2b0"></a><!-- doxytag: member="TMC26XStepper::isStandStill" ref="ab26602f360a4fb6ec6d262011675b2b0" args="(void)" -->

  870. <div class="memitem">

  871. <div class="memproto">

  872.       <table class="memname">

  873.         <tr>

  874.           <td class="memname">boolean <a class="el" href="class_t_m_c26_x_stepper.html#ab26602f360a4fb6ec6d262011675b2b0">TMC26XStepper::isStandStill</a> </td>

  875.           <td>(</td>

  876.           <td class="paramtype">void&#160;</td>

  877.           <td class="paramname"></td><td>)</td>

  878.           <td></td>

  879.         </tr>

  880.       </table>

  881. </div>

  882. <div class="memdoc">

  883. 

  884. <p>Is chopper inactive since 2^20 clock cycles - defaults to ~0,08s. </p>

  885. <dl class="return"><dt><b>Returns:</b></dt><dd>true is yes, false if not. Keep in mind that this method does not enforce a readout but uses the value of the last status readout. You may want to use <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition()</a> or <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to enforce an updated status readout. </dd></dl>

  886. 

  887. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00862">862</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  888. 

  889. </div>

  890. </div>

  891. <a class="anchor" id="aed5d81f1549615529c723600a68ba415"></a><!-- doxytag: member="TMC26XStepper::move" ref="aed5d81f1549615529c723600a68ba415" args="(void)" -->

  892. <div class="memitem">

  893. <div class="memproto">

  894.       <table class="memname">

  895.         <tr>

  896.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415">TMC26XStepper::move</a> </td>

  897.           <td>(</td>

  898.           <td class="paramtype">void&#160;</td>

  899.           <td class="paramname"></td><td>)</td>

  900.           <td></td>

  901.         </tr>

  902.       </table>

  903. </div>

  904. <div class="memdoc">

  905. 

  906. <p>Central movement method, must be called as often as possible in the lopp function and is very fast. </p>

  907. <p>This routine checks if the motor still has to move, if the waiting delay has passed to send a new step command to the motor and manages the number of steps yet to move to fulfill the current move command.</p>

  908. <p>This function is implemented to be as fast as possible to call it as often as possible in your loop routine. The more regurlarly you call this function the better. In both senses of 'regularly': Calling it as often as possible is not a bad idea and if you even manage that the intervals you call this function are not too irregular helps too.</p>

  909. <p>You can call this routine even if you know that the motor is not miving. It introduces just a very small penalty in your code. You must not call <a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e" title="checks if the motor still has to move to fulfill the last movement command.">isMoving()</a> to determine if you need to call this function, since taht is done internally already and only slows down you code.</p>

  910. <p>How often you call this function directly influences your top miving speed for the motor. It may be a good idea to call this from an timer overflow interrupt to ensure proper calling. </p>

  911. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d" title="Initiate a movement for the given number of steps. Positive numbers move in one, negative numbers in ...">step()</a> </dd></dl>

  912. 

  913. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00246">246</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  914. 

  915. </div>

  916. </div>

  917. <a class="anchor" id="af95a824bfdf49ef979b5354798e52967"></a><!-- doxytag: member="TMC26XStepper::readStatus" ref="af95a824bfdf49ef979b5354798e52967" args="(char read_value)" -->

  918. <div class="memitem">

  919. <div class="memproto">

  920.       <table class="memname">

  921.         <tr>

  922.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#af95a824bfdf49ef979b5354798e52967">TMC26XStepper::readStatus</a> </td>

  923.           <td>(</td>

  924.           <td class="paramtype">char&#160;</td>

  925.           <td class="paramname"><em>read_value</em></td><td>)</td>

  926.           <td></td>

  927.         </tr>

  928.       </table>

  929. </div>

  930. <div class="memdoc">

  931. 

  932. <p>Manually read out the status register This function sends a byte to the motor driver in order to get the current readout. The parameter read_value seletcs which value will get returned. If the read_vlaue changes in respect to the previous readout this method automatically send two bytes to the motor: one to set the redout and one to get the actual readout. So this method may take time to send and read one or two bits - depending on the previous readout. </p>

  933. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  934.   <table class="params">

  935.     <tr><td class="paramname">read_value</td><td>selects which value to read out (0..3). You can use the defines TMC26X_READOUT_POSITION, TMC_262_READOUT_STALLGUARD, or TMC_262_READOUT_CURRENT </td></tr>

  936.   </table>

  937.   </dd>

  938. </dl>

  939. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26X_READOUT_POSITION</a>, TMC_262_READOUT_STALLGUARD, TMC_262_READOUT_CURRENT </dd></dl>

  940. 

  941. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00742">742</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  942. 

  943. </div>

  944. </div>

  945. <a class="anchor" id="ac2d8a2bbae2aba3ed7c98e3ff1a06649"></a><!-- doxytag: member="TMC26XStepper::setConstantOffTimeChopper" ref="ac2d8a2bbae2aba3ed7c98e3ff1a06649" args="(char constant_off_time, char blank_time, char fast_decay_time_setting, char sine_wave_offset, unsigned char use_current_comparator)" -->

  946. <div class="memitem">

  947. <div class="memproto">

  948.       <table class="memname">

  949.         <tr>

  950.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#ac2d8a2bbae2aba3ed7c98e3ff1a06649">TMC26XStepper::setConstantOffTimeChopper</a> </td>

  951.           <td>(</td>

  952.           <td class="paramtype">char&#160;</td>

  953.           <td class="paramname"><em>constant_off_time</em>, </td>

  954.         </tr>

  955.         <tr>

  956.           <td class="paramkey"></td>

  957.           <td></td>

  958.           <td class="paramtype">char&#160;</td>

  959.           <td class="paramname"><em>blank_time</em>, </td>

  960.         </tr>

  961.         <tr>

  962.           <td class="paramkey"></td>

  963.           <td></td>

  964.           <td class="paramtype">char&#160;</td>

  965.           <td class="paramname"><em>fast_decay_time_setting</em>, </td>

  966.         </tr>

  967.         <tr>

  968.           <td class="paramkey"></td>

  969.           <td></td>

  970.           <td class="paramtype">char&#160;</td>

  971.           <td class="paramname"><em>sine_wave_offset</em>, </td>

  972.         </tr>

  973.         <tr>

  974.           <td class="paramkey"></td>

  975.           <td></td>

  976.           <td class="paramtype">unsigned char&#160;</td>

  977.           <td class="paramname"><em>use_current_comparator</em>&#160;</td>

  978.         </tr>

  979.         <tr>

  980.           <td></td>

  981.           <td>)</td>

  982.           <td></td><td></td>

  983.         </tr>

  984.       </table>

  985. </div>

  986. <div class="memdoc">

  987. 

  988. <p>Sets and configure the classical Constant Off Timer Chopper. </p>

  989. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  990.   <table class="params">

  991.     <tr><td class="paramname">constant_off_time</td><td>The off time setting controls the minimum chopper frequency. For most applications an off time within the range of 5μs to 20μs will fit. Setting this parameter to zero completely disables all driver transistors and the motor can free-wheel. 0: chopper off, 1:15: off time setting (1 will work with minimum blank time of 24 clocks) </td></tr>

  992.     <tr><td class="paramname">blank_time</td><td>Selects the comparator blank time. This time needs to safely cover the switching event and the duration of the ringing on the sense resistor. For most low current drivers, a setting of 1 or 2 is good. For high current applications with large MOSFETs, a setting of 2 or 3 will be required. 0 (min setting) … (3) amx setting </td></tr>

  993.     <tr><td class="paramname">fast_decay_time_setting</td><td>Fast decay time setting. Controls the portion of fast decay for each chopper cycle. 0: slow decay only, 1…15: duration of fast decay phase </td></tr>

  994.     <tr><td class="paramname">sine_wave_offset</td><td>Sine wave offset. Controls the sine wave offset. A positive offset corrects for zero crossing error. -3…-1: negative offset, 0: no offset,1…12: positive offset </td></tr>

  995.     <tr><td class="paramname">use_curreent_comparator</td><td>Selects usage of the current comparator for termination of the fast decay cycle. If current comparator is enabled, it terminates the fast decay cycle in case the current reaches a higher negative value than the actual positive value. (0 disable, -1 enable).</td></tr>

  996.   </table>

  997.   </dd>

  998. </dl>

  999. <p>The classic constant off time chopper uses a fixed portion of fast decay following each on phase. While the duration of the on time is determined by the chopper comparator, the fast decay time needs to be set by the user in a way, that the current decay is enough for the driver to be able to follow the falling slope of the sine wave, and on the other hand it should not be too long, in order to minimize motor current ripple and power dissipation. This best can be tuned using an oscilloscope or trying out motor smoothness at different velocities. A good starting value is a fast decay time setting similar to the slow decay time setting. After tuning of the fast decay time, the offset should be determined, in order to have a smooth zero transition. This is necessary, because the fast decay phase leads to the absolute value of the motor current being lower than the target current (see figure 17). If the zero offset is too low, the motor stands still for a short moment during current zero crossing, if it is set too high, it makes a larger microstep. Typically, a positive offset setting is required for optimum operation.</p>

  1000. <dl class="see"><dt><b>See also:</b></dt><dd>setSpreadCycleChoper() for other alternatives. </dd>

  1001. <dd>

  1002. <a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a" title="Use random off time for noise reduction (0 for off, -1 for on).">setRandomOffTime()</a> for spreading the noise over a wider spectrum </dd></dl>

  1003. 

  1004. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00473">473</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1005. 

  1006. </div>

  1007. </div>

  1008. <a class="anchor" id="a381fbcce7c586ca2f1da8f9e704df14e"></a><!-- doxytag: member="TMC26XStepper::setCoolStepConfiguration" ref="a381fbcce7c586ca2f1da8f9e704df14e" args="(unsigned int lower_SG_threshold, unsigned int SG_hysteresis, unsigned char current_decrement_step_size, unsigned char current_increment_step_size, unsigned char lower_current_limit)" -->

  1009. <div class="memitem">

  1010. <div class="memproto">

  1011.       <table class="memname">

  1012.         <tr>

  1013.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e">TMC26XStepper::setCoolStepConfiguration</a> </td>

  1014.           <td>(</td>

  1015.           <td class="paramtype">unsigned int&#160;</td>

  1016.           <td class="paramname"><em>lower_SG_threshold</em>, </td>

  1017.         </tr>

  1018.         <tr>

  1019.           <td class="paramkey"></td>

  1020.           <td></td>

  1021.           <td class="paramtype">unsigned int&#160;</td>

  1022.           <td class="paramname"><em>SG_hysteresis</em>, </td>

  1023.         </tr>

  1024.         <tr>

  1025.           <td class="paramkey"></td>

  1026.           <td></td>

  1027.           <td class="paramtype">unsigned char&#160;</td>

  1028.           <td class="paramname"><em>current_decrement_step_size</em>, </td>

  1029.         </tr>

  1030.         <tr>

  1031.           <td class="paramkey"></td>

  1032.           <td></td>

  1033.           <td class="paramtype">unsigned char&#160;</td>

  1034.           <td class="paramname"><em>current_increment_step_size</em>, </td>

  1035.         </tr>

  1036.         <tr>

  1037.           <td class="paramkey"></td>

  1038.           <td></td>

  1039.           <td class="paramtype">unsigned char&#160;</td>

  1040.           <td class="paramname"><em>lower_current_limit</em>&#160;</td>

  1041.         </tr>

  1042.         <tr>

  1043.           <td></td>

  1044.           <td>)</td>

  1045.           <td></td><td></td>

  1046.         </tr>

  1047.       </table>

  1048. </div>

  1049. <div class="memdoc">

  1050. 

  1051. <p>This method configures the CoolStep smart energy operation. You must have a proper StallGuard configuration for the motor situation (current, voltage, speed) in rder to use this feature. </p>

  1052. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1053.   <table class="params">

  1054.     <tr><td class="paramname">lower_SG_threshold</td><td>Sets the lower threshold for stallGuard2TM reading. Below this value, the motor current becomes increased. Allowed values are 0...480 </td></tr>

  1055.     <tr><td class="paramname">SG_hysteresis</td><td>Sets the distance between the lower and the upper threshold for stallGuard2TM reading. Above the upper threshold (which is lower_SG_threshold+SG_hysteresis+1) the motor current becomes decreased. Allowed values are 0...480 </td></tr>

  1056.     <tr><td class="paramname">current_decrement_step_size</td><td>Sets the current decrement steps. If the StallGuard value is above the threshold the current gets decremented by this step size. 0...32 </td></tr>

  1057.     <tr><td class="paramname">current_increment_step_size</td><td>Sets the current increment step. The current becomes incremented for each measured stallGuard2TM value below the lower threshold. 0...8 </td></tr>

  1058.     <tr><td class="paramname">lower_current_limit</td><td>Sets the lower motor current limit for coolStepTM operation by scaling the CS value. Values can be COOL_STEP_HALF_CS_LIMIT, COOL_STEP_QUARTER_CS_LIMIT The CoolStep smart energy operation automatically adjust the current sent into the motor according to the current load, read out by the StallGuard in order to provide the optimum torque with the minimal current consumption. You configure the CoolStep current regulator by defining upper and lower bounds of StallGuard readouts. If the readout is above the limit the current gets increased, below the limit the current gets decreased. You can specify the upper an lower threshold of the StallGuard readout in order to adjust the current. You can also set the number of StallGuard readings neccessary above or below the limit to get a more stable current adjustement. The current adjustement itself is configured by the number of steps the current gests in- or decreased and the absolut minimum current (1/2 or 1/4th otf the configured current). </td></tr>

  1059.   </table>

  1060.   </dd>

  1061. </dl>

  1062. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">COOL_STEP_HALF_CS_LIMIT</a>, COOL_STEP_QUARTER_CS_LIMIT </dd></dl>

  1063. 

  1064. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00636">636</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1065. 

  1066. </div>

  1067. </div>

  1068. <a class="anchor" id="a15bf0ed5a166a5d9a41f90f3ccbc6157"></a><!-- doxytag: member="TMC26XStepper::setCoolStepEnabled" ref="a15bf0ed5a166a5d9a41f90f3ccbc6157" args="(boolean enabled)" -->

  1069. <div class="memitem">

  1070. <div class="memproto">

  1071.       <table class="memname">

  1072.         <tr>

  1073.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#a15bf0ed5a166a5d9a41f90f3ccbc6157">TMC26XStepper::setCoolStepEnabled</a> </td>

  1074.           <td>(</td>

  1075.           <td class="paramtype">boolean&#160;</td>

  1076.           <td class="paramname"><em>enabled</em></td><td>)</td>

  1077.           <td></td>

  1078.         </tr>

  1079.       </table>

  1080. </div>

  1081. <div class="memdoc">

  1082. 

  1083. <p>enables or disables the CoolStep smart energy operation feature. It must be configured before enabling it. </p>

  1084. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1085.   <table class="params">

  1086.     <tr><td class="paramname">enabled</td><td>true if CoolStep should be enabled, false if not. </td></tr>

  1087.   </table>

  1088.   </dd>

  1089. </dl>

  1090. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e" title="This method configures the CoolStep smart energy operation. You must have a proper StallGuard configu...">setCoolStepConfiguration()</a> </dd></dl>

  1091. 

  1092. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00676">676</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1093. 

  1094. </div>

  1095. </div>

  1096. <a class="anchor" id="aaa35fac83417c16b3a941fa168e4a4d2"></a><!-- doxytag: member="TMC26XStepper::setCurrent" ref="aaa35fac83417c16b3a941fa168e4a4d2" args="(unsigned int current)" -->

  1097. <div class="memitem">

  1098. <div class="memproto">

  1099.       <table class="memname">

  1100.         <tr>

  1101.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#aaa35fac83417c16b3a941fa168e4a4d2">TMC26XStepper::setCurrent</a> </td>

  1102.           <td>(</td>

  1103.           <td class="paramtype">unsigned int&#160;</td>

  1104.           <td class="paramname"><em>current</em></td><td>)</td>

  1105.           <td></td>

  1106.         </tr>

  1107.       </table>

  1108. </div>

  1109. <div class="memdoc">

  1110. 

  1111. <p>set the maximum motor current in mA (1000 is 1 Amp) Keep in mind this is the maximum peak Current. The RMS current will be 1/sqrt(2) smaller. The actual current can also be smaller by employing CoolStep. </p>

  1112. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1113.   <table class="params">

  1114.     <tr><td class="paramname">current</td><td>the maximum motor current in mA </td></tr>

  1115.   </table>

  1116.   </dd>

  1117. </dl>

  1118. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f" title="readout the motor maximum current in mA (1000 is an Amp) This is the maximum current. to get the current current - which may be affected by CoolStep us getCurrentCurrent()">getCurrent()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7" title="Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000...">getCurrentCurrent()</a> </dd></dl>

  1119. 

  1120. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00292">292</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1121. 

  1122. </div>

  1123. </div>

  1124. <a class="anchor" id="a4472cd86ad5b65dec5ec45ce69158305"></a><!-- doxytag: member="TMC26XStepper::setEnabled" ref="a4472cd86ad5b65dec5ec45ce69158305" args="(boolean enabled)" -->

  1125. <div class="memitem">

  1126. <div class="memproto">

  1127.       <table class="memname">

  1128.         <tr>

  1129.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#a4472cd86ad5b65dec5ec45ce69158305">TMC26XStepper::setEnabled</a> </td>

  1130.           <td>(</td>

  1131.           <td class="paramtype">boolean&#160;</td>

  1132.           <td class="paramname"><em>enabled</em></td><td>)</td>

  1133.           <td></td>

  1134.         </tr>

  1135.       </table>

  1136. </div>

  1137. <div class="memdoc">

  1138. 

  1139. <p>enables or disables the motor driver bridges. If disabled the motor can run freely. If enabled not. </p>

  1140. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1141.   <table class="params">

  1142.     <tr><td class="paramname">enabled</td><td>a boolean value true if the motor should be enabled, false otherwise. </td></tr>

  1143.   </table>

  1144.   </dd>

  1145. </dl>

  1146. 

  1147. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00716">716</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1148. 

  1149. </div>

  1150. </div>

  1151. <a class="anchor" id="a21041579c7f9284567ee2e2a55a3afd0"></a><!-- doxytag: member="TMC26XStepper::setMicrosteps" ref="a21041579c7f9284567ee2e2a55a3afd0" args="(int number_of_steps)" -->

  1152. <div class="memitem">

  1153. <div class="memproto">

  1154.       <table class="memname">

  1155.         <tr>

  1156.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0">TMC26XStepper::setMicrosteps</a> </td>

  1157.           <td>(</td>

  1158.           <td class="paramtype">int&#160;</td>

  1159.           <td class="paramname"><em>number_of_steps</em></td><td>)</td>

  1160.           <td></td>

  1161.         </tr>

  1162.       </table>

  1163. </div>

  1164. <div class="memdoc">

  1165. 

  1166. <p>Set the number of microsteps in 2^i values (rounded) up to 256. </p>

  1167. <p>This method set's the number of microsteps per step in 2^i interval. This means you can select 1, 2, 4, 16, 32, 64, 128 or 256 as valid microsteps. If you give any other value it will be rounded to the next smaller number (3 would give a microstepping of 2). You can always check the current microstepping with <a class="el" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3" title="returns the effective current number of microsteps selected.">getMicrosteps()</a>. </p>

  1168. 

  1169. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00394">394</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1170. 

  1171. </div>

  1172. </div>

  1173. <a class="anchor" id="a7ffd602cf4bf385847cba034417d5f0a"></a><!-- doxytag: member="TMC26XStepper::setRandomOffTime" ref="a7ffd602cf4bf385847cba034417d5f0a" args="(char value)" -->

  1174. <div class="memitem">

  1175. <div class="memproto">

  1176.       <table class="memname">

  1177.         <tr>

  1178.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a">TMC26XStepper::setRandomOffTime</a> </td>

  1179.           <td>(</td>

  1180.           <td class="paramtype">char&#160;</td>

  1181.           <td class="paramname"><em>value</em></td><td>)</td>

  1182.           <td></td>

  1183.         </tr>

  1184.       </table>

  1185. </div>

  1186. <div class="memdoc">

  1187. 

  1188. <p>Use random off time for noise reduction (0 for off, -1 for on). </p>

  1189. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1190.   <table class="params">

  1191.     <tr><td class="paramname">value</td><td>0 for off, -1 for on</td></tr>

  1192.   </table>

  1193.   </dd>

  1194. </dl>

  1195. <p>In a constant off time chopper scheme both coil choppers run freely, i.e. are not synchronized. The frequency of each chopper mainly depends on the coil current and the position dependant motor coil inductivity, thus it depends on the microstep position. With some motors a slightly audible beat can occur between the chopper frequencies, especially when they are near to each other. This typically occurs at a few microstep positions within each quarter wave. This effect normally is not audible when compared to mechanical noise generated by ball bearings, etc. Further factors which can cause a similar effect are a poor layout of sense resistor GND connection. In order to minimize the effect of a beat between both chopper frequencies, an internal random generator is provided. It modulates the slow decay time setting when switched on. The random off time feature further spreads the chopper spectrum, reducing electromagnetic emission on single frequencies. </p>

  1196. 

  1197. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00624">624</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1198. 

  1199. </div>

  1200. </div>

  1201. <a class="anchor" id="a9478f43090995c8d5cdb4d4e8c07cdbd"></a><!-- doxytag: member="TMC26XStepper::setSpeed" ref="a9478f43090995c8d5cdb4d4e8c07cdbd" args="(unsigned int whatSpeed)" -->

  1202. <div class="memitem">

  1203. <div class="memproto">

  1204.       <table class="memname">

  1205.         <tr>

  1206.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd">TMC26XStepper::setSpeed</a> </td>

  1207.           <td>(</td>

  1208.           <td class="paramtype">unsigned int&#160;</td>

  1209.           <td class="paramname"><em>whatSpeed</em></td><td>)</td>

  1210.           <td></td>

  1211.         </tr>

  1212.       </table>

  1213. </div>

  1214. <div class="memdoc">

  1215. 

  1216. <p>Sets the rotation speed in revolutions per minute. </p>

  1217. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1218.   <table class="params">

  1219.     <tr><td class="paramname">whatSpeed</td><td>the desired speed in rotations per minute. </td></tr>

  1220.   </table>

  1221.   </dd>

  1222. </dl>

  1223. 

  1224. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00208">208</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1225. 

  1226. </div>

  1227. </div>

  1228. <a class="anchor" id="aa152bb7ddb72a2bc8465553a39232df2"></a><!-- doxytag: member="TMC26XStepper::setSpreadCycleChopper" ref="aa152bb7ddb72a2bc8465553a39232df2" args="(char constant_off_time, char blank_time, char hysteresis_start, char hysteresis_end, char hysteresis_decrement)" -->

  1229. <div class="memitem">

  1230. <div class="memproto">

  1231.       <table class="memname">

  1232.         <tr>

  1233.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#aa152bb7ddb72a2bc8465553a39232df2">TMC26XStepper::setSpreadCycleChopper</a> </td>

  1234.           <td>(</td>

  1235.           <td class="paramtype">char&#160;</td>

  1236.           <td class="paramname"><em>constant_off_time</em>, </td>

  1237.         </tr>

  1238.         <tr>

  1239.           <td class="paramkey"></td>

  1240.           <td></td>

  1241.           <td class="paramtype">char&#160;</td>

  1242.           <td class="paramname"><em>blank_time</em>, </td>

  1243.         </tr>

  1244.         <tr>

  1245.           <td class="paramkey"></td>

  1246.           <td></td>

  1247.           <td class="paramtype">char&#160;</td>

  1248.           <td class="paramname"><em>hysteresis_start</em>, </td>

  1249.         </tr>

  1250.         <tr>

  1251.           <td class="paramkey"></td>

  1252.           <td></td>

  1253.           <td class="paramtype">char&#160;</td>

  1254.           <td class="paramname"><em>hysteresis_end</em>, </td>

  1255.         </tr>

  1256.         <tr>

  1257.           <td class="paramkey"></td>

  1258.           <td></td>

  1259.           <td class="paramtype">char&#160;</td>

  1260.           <td class="paramname"><em>hysteresis_decrement</em>&#160;</td>

  1261.         </tr>

  1262.         <tr>

  1263.           <td></td>

  1264.           <td>)</td>

  1265.           <td></td><td></td>

  1266.         </tr>

  1267.       </table>

  1268. </div>

  1269. <div class="memdoc">

  1270. 

  1271. <p>Sets and configures with spread cycle chopper. </p>

  1272. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1273.   <table class="params">

  1274.     <tr><td class="paramname">constant_off_time</td><td>The off time setting controls the minimum chopper frequency. For most applications an off time within the range of 5μs to 20μs will fit. Setting this parameter to zero completely disables all driver transistors and the motor can free-wheel. 0: chopper off, 1:15: off time setting (1 will work with minimum blank time of 24 clocks) </td></tr>

  1275.     <tr><td class="paramname">blank_time</td><td>Selects the comparator blank time. This time needs to safely cover the switching event and the duration of the ringing on the sense resistor. For most low current drivers, a setting of 1 or 2 is good. For high current applications with large MOSFETs, a setting of 2 or 3 will be required. 0 (min setting) … (3) amx setting </td></tr>

  1276.     <tr><td class="paramname">hysteresis_start</td><td>Hysteresis start setting. Please remark, that this value is an offset to the hysteresis end value. 1 … 8 </td></tr>

  1277.     <tr><td class="paramname">hysteresis_end</td><td>Hysteresis end setting. Sets the hysteresis end value after a number of decrements. Decrement interval time is controlled by hysteresis_decrement. The sum hysteresis_start + hysteresis_end must be &lt;16. At a current setting CS of max. 30 (amplitude reduced to 240), the sum is not limited. </td></tr>

  1278.     <tr><td class="paramname">hysteresis_decrement</td><td>Hysteresis decrement setting. This setting determines the slope of the hysteresis during on time and during fast decay time. 0 (fast decrement) … 3 (slow decrement).</td></tr>

  1279.   </table>

  1280.   </dd>

  1281. </dl>

  1282. <p>The spreadCycle chopper scheme (pat.fil.) is a precise and simple to use chopper principle, which automatically determines the optimum fast decay portion for the motor. Anyhow, a number of settings can be made in order to optimally fit the driver to the motor. Each chopper cycle is comprised of an on-phase, a slow decay phase, a fast decay phase and a second slow decay phase. The slow decay phases limit the maximum chopper frequency and are important for low motor and driver power dissipation. The hysteresis start setting limits the chopper frequency by forcing the driver to introduce a minimum amount of current ripple into the motor coils. The motor inductivity determines the ability to follow a changing motor current. The duration of the on- and fast decay phase needs to cover at least the blank time, because the current comparator is disabled during this time.</p>

  1283. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a" title="Use random off time for noise reduction (0 for off, -1 for on).">setRandomOffTime()</a> for spreading the noise over a wider spectrum </dd></dl>

  1284. 

  1285. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00552">552</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1286. 

  1287. </div>

  1288. </div>

  1289. <a class="anchor" id="af1a5abc23757860baf8ff421689a425a"></a><!-- doxytag: member="TMC26XStepper::setStallGuardThreshold" ref="af1a5abc23757860baf8ff421689a425a" args="(char stall_guard_threshold, char stall_guard_filter_enabled)" -->

  1290. <div class="memitem">

  1291. <div class="memproto">

  1292.       <table class="memname">

  1293.         <tr>

  1294.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a">TMC26XStepper::setStallGuardThreshold</a> </td>

  1295.           <td>(</td>

  1296.           <td class="paramtype">char&#160;</td>

  1297.           <td class="paramname"><em>stall_guard_threshold</em>, </td>

  1298.         </tr>

  1299.         <tr>

  1300.           <td class="paramkey"></td>

  1301.           <td></td>

  1302.           <td class="paramtype">char&#160;</td>

  1303.           <td class="paramname"><em>stall_guard_filter_enabled</em>&#160;</td>

  1304.         </tr>

  1305.         <tr>

  1306.           <td></td>

  1307.           <td>)</td>

  1308.           <td></td><td></td>

  1309.         </tr>

  1310.       </table>

  1311. </div>

  1312. <div class="memdoc">

  1313. 

  1314. <p>set the StallGuard threshold in order to get sensible StallGuard readings. </p>

  1315. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1316.   <table class="params">

  1317.     <tr><td class="paramname">stall_guard_threshold</td><td>-64 … 63 the StallGuard threshold </td></tr>

  1318.     <tr><td class="paramname">stall_guard_filter_enabled</td><td>0 if the filter is disabled, -1 if it is enabled</td></tr>

  1319.   </table>

  1320.   </dd>

  1321. </dl>

  1322. <p>The StallGuard threshold is used to optimize the StallGuard reading to sensible values. It should be at 0 at the maximum allowable load on the otor (but not before). = is a good starting point (and the default) If you get Stall Gaurd readings of 0 without any load or with too little laod increase the value. If you get readings of 1023 even with load decrease the setting.</p>

  1323. <p>If you switch on the filter the StallGuard reading is only updated each 4th full step to reduce the noise in the reading.</p>

  1324. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading()</a> to read out the current value. </dd></dl>

  1325. 

  1326. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00346">346</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1327. 

  1328. </div>

  1329. </div>

  1330. <a class="anchor" id="aad1ed82b3e05940bde5a6c7ed3d3e8f7"></a><!-- doxytag: member="TMC26XStepper::start" ref="aad1ed82b3e05940bde5a6c7ed3d3e8f7" args="()" -->

  1331. <div class="memitem">

  1332. <div class="memproto">

  1333.       <table class="memname">

  1334.         <tr>

  1335.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7">TMC26XStepper::start</a> </td>

  1336.           <td>(</td>

  1337.           <td class="paramname"></td><td>)</td>

  1338.           <td></td>

  1339.         </tr>

  1340.       </table>

  1341. </div>

  1342. <div class="memdoc">

  1343. 

  1344. <p>configures and starts the TMC26X stepper driver. Before you called this function the stepper driver is in nonfunctional mode. </p>

  1345. <p>This routine configures the TMC26X stepper driver for the given values via SPI. Most member functions are non functional if the driver has not been started. Therefore it is best to call this in your Arduino setup() function. </p>

  1346. 

  1347. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00157">157</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1348. 

  1349. </div>

  1350. </div>

  1351. <a class="anchor" id="ac073a742496885f1f60751f9fb9c395d"></a><!-- doxytag: member="TMC26XStepper::step" ref="ac073a742496885f1f60751f9fb9c395d" args="(int number_of_steps)" -->

  1352. <div class="memitem">

  1353. <div class="memproto">

  1354.       <table class="memname">

  1355.         <tr>

  1356.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d">TMC26XStepper::step</a> </td>

  1357.           <td>(</td>

  1358.           <td class="paramtype">int&#160;</td>

  1359.           <td class="paramname"><em>number_of_steps</em></td><td>)</td>

  1360.           <td></td>

  1361.         </tr>

  1362.       </table>

  1363. </div>

  1364. <div class="memdoc">

  1365. 

  1366. <p>Initiate a movement for the given number of steps. Positive numbers move in one, negative numbers in the other direction. </p>

  1367. <dl class="params"><dt><b>Parameters:</b></dt><dd>

  1368.   <table class="params">

  1369.     <tr><td class="paramname">number_of_steps</td><td>The number of steps to move the motor. </td></tr>

  1370.   </table>

  1371.   </dd>

  1372. </dl>

  1373. <dl class="return"><dt><b>Returns:</b></dt><dd>0 if the motor was not moving and moves now. -1 if the motor is moving and the new steps could not be set.</dd></dl>

  1374. <p>If the previous movement is not finished yet the function will return -1 and not change the steps to move the motor. If the motor does not move it return 0</p>

  1375. <p>The direction of the movement is indicated by the sign of the steps parameter. It is not determinable if positive values are right or left This depends on the internal construction of the motor and how you connected it to the stepper driver.</p>

  1376. <p>You can always verify with <a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e" title="checks if the motor still has to move to fulfill the last movement command.">isMoving()</a> or even use <a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123" title="Stops the motor regardless if it moves or not.">stop()</a> to stop the motor before giving it new step directions. </p>

  1377. <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e" title="checks if the motor still has to move to fulfill the last movement command.">isMoving()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7" title="Get the number of steps left in the current movement.">getStepsLeft()</a>, <a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123" title="Stops the motor regardless if it moves or not.">stop()</a> </dd></dl>

  1378. 

  1379. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00229">229</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1380. 

  1381. </div>

  1382. </div>

  1383. <a class="anchor" id="a6315c18eadbc6bf4f3d81a6f80296123"></a><!-- doxytag: member="TMC26XStepper::stop" ref="a6315c18eadbc6bf4f3d81a6f80296123" args="(void)" -->

  1384. <div class="memitem">

  1385. <div class="memproto">

  1386.       <table class="memname">

  1387.         <tr>

  1388.           <td class="memname">char <a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123">TMC26XStepper::stop</a> </td>

  1389.           <td>(</td>

  1390.           <td class="paramtype">void&#160;</td>

  1391.           <td class="paramname"></td><td>)</td>

  1392.           <td></td>

  1393.         </tr>

  1394.       </table>

  1395. </div>

  1396. <div class="memdoc">

  1397. 

  1398. <p>Stops the motor regardless if it moves or not. </p>

  1399. <dl class="return"><dt><b>Returns:</b></dt><dd>-1 if the motor was moving and is really stoped or 0 if it was not moving at all.</dd></dl>

  1400. <p>This method directly and apruptely stops the motor and may be used as an emergency stop. </p>

  1401. 

  1402. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00282">282</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1403. 

  1404. </div>

  1405. </div>

  1406. <a class="anchor" id="af968e70a13068f1e71ac0fa6865630c5"></a><!-- doxytag: member="TMC26XStepper::un_start" ref="af968e70a13068f1e71ac0fa6865630c5" args="()" -->

  1407. <div class="memitem">

  1408. <div class="memproto">

  1409.       <table class="memname">

  1410.         <tr>

  1411.           <td class="memname">void <a class="el" href="class_t_m_c26_x_stepper.html#af968e70a13068f1e71ac0fa6865630c5">TMC26XStepper::un_start</a> </td>

  1412.           <td>(</td>

  1413.           <td class="paramname"></td><td>)</td>

  1414.           <td></td>

  1415.         </tr>

  1416.       </table>

  1417. </div>

  1418. <div class="memdoc">

  1419. 

  1420. <p>resets the stepper in unconfigured mode. </p>

  1421. <p>This routine enables you to call start again. It does not change anything in the internal stepper configuration or the desired configuration. It just marks the stepper as not yet startet. You do not have to reconfigure the stepper to start it again, but it is not reset to any factory settings this has to be configured back by yourself. (Hint: Normally you do not need this function) </p>

  1422. 

  1423. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00199">199</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1424. 

  1425. </div>

  1426. </div>

  1427. <a class="anchor" id="ab040d9df1e85d6fb0c105205a36b0215"></a><!-- doxytag: member="TMC26XStepper::version" ref="ab040d9df1e85d6fb0c105205a36b0215" args="(void)" -->

  1428. <div class="memitem">

  1429. <div class="memproto">

  1430.       <table class="memname">

  1431.         <tr>

  1432.           <td class="memname">int <a class="el" href="class_t_m_c26_x_stepper.html#ab040d9df1e85d6fb0c105205a36b0215">TMC26XStepper::version</a> </td>

  1433.           <td>(</td>

  1434.           <td class="paramtype">void&#160;</td>

  1435.           <td class="paramname"></td><td>)</td>

  1436.           <td></td>

  1437.         </tr>

  1438.       </table>

  1439. </div>

  1440. <div class="memdoc">

  1441. 

  1442. <p>library version </p>

  1443. <dl class="return"><dt><b>Returns:</b></dt><dd>the version number as int. </dd></dl>

  1444. 

  1445. <p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00897">897</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>

  1446. 

  1447. </div>

  1448. </div>

  1449. <hr/>The documentation for this class was generated from the following files:<ul>

  1450. <li><a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a></li>

  1451. <li><a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a></li>

  1452. </ul>

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

  1454. 

  1455. 

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

  1457. 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">

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

  1459. </a> 1.7.6.1

  1460. </small></address>

  1461. 

  1462. </body>

  1463. </html>