Browse Source

First attempt at adding TMC Driver support. May need some cleanup.

domonoky 9 years ago
parent
commit
38500165ea
57 changed files with 33325 additions and 2 deletions
  1. 17
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/.gitignore
  2. 1813
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/Doxyfile
  3. 10
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/LICENSE
  4. 71
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/README.rst
  5. 999
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/TMC26XStepper.cpp
  6. 607
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/TMC26XStepper.h
  7. 848
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8cpp.html
  8. 1067
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8cpp_source.html
  9. 212
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8h.html
  10. 256
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8h_source.html
  11. 72
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/annotated.html
  12. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/bc_s.png
  13. 117
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/class_t_m_c26_x_stepper-members.html
  14. 1463
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/class_t_m_c26_x_stepper.html
  15. 78
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/classes.html
  16. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/closed.png
  17. 949
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/doxygen.css
  18. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/doxygen.png
  19. 72
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/files.html
  20. 261
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/functions.html
  21. 261
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/functions_func.html
  22. 289
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/globals.html
  23. 289
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/globals_defs.html
  24. 72
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/index.html
  25. 64
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/jquery.js
  26. 68
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/mainpage_8dox.html
  27. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/nav_f.png
  28. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/nav_h.png
  29. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/open.png
  30. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_a.png
  31. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_b.png
  32. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_h.png
  33. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_s.png
  34. 59
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tabs.css
  35. 82
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XExample/TMC26XExample.ino
  36. 176
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/Motor.ino
  37. 369
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/Serial.ino
  38. 61
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/TMC26XMotorTester.ino
  39. 306
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/Arduino.pde
  40. 175
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/ChopperConfiguration.pde
  41. 327
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/DataRendering.pde
  42. 49
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/DataTable.pde
  43. 335
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/RunConfiguration.pde
  44. 156
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/TMC26XMotorTest.pde
  45. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/data/mc_logo.jpg
  46. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/data/tmc_logo.jpg
  47. BIN
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/hysteresis.png
  48. 2
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/sketch.properties
  49. 75
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/keywords.txt
  50. 30
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/mainpage.dox
  51. 9797
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/schematics/tmc-260-shield.brd
  52. 11079
    0
      ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/schematics/tmc-260-shield.sch
  53. 61
    0
      Marlin/Configuration_adv.h
  54. 5
    0
      Marlin/Marlin.ino
  55. 81
    1
      Marlin/stepper.cpp
  56. 39
    1
      Marlin/stepper.h
  57. 106
    0
      Marlin/stepper_indirection.h

+ 17
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/.gitignore View File

@@ -0,0 +1,17 @@
1
+#mac stuff
2
+.DS_Store
3
+
4
+#eclipse stuff
5
+.classpath
6
+.project
7
+
8
+#processing stuff 
9
+generated/
10
+examples/TMC26XMotorTester/processing/TMC26XMotorTest/application.*/
11
+examples/TMC26XMotorTester/processing/TMC26XMotorTest/application.*
12
+
13
+#eagle stuff
14
+schematics/*.b#?
15
+schematics/*.s#?
16
+
17
+*.zip

+ 1813
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/Doxyfile
File diff suppressed because it is too large
View File


+ 10
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/LICENSE View File

@@ -0,0 +1,10 @@
1
+
2
+Copyright (c) 2012 Interactive Matter
3
+
4
+based on the stepper library by Tom Igoe, et. al.
5
+
6
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
7
+
8
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
9
+
10
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 71
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/README.rst View File

@@ -0,0 +1,71 @@
1
+Arduino TMC26X Stepper Motor Controller Library
2
+===============================================
3
+
4
+License
5
+-------
6
+
7
+TMC26XStepper.cpp - - TMC 260/261/262 Stepper library for Wiring/Arduino
8
+ 
9
+based on the stepper library by Tom Igoe, et. al.
10
+ 
11
+Copyright (c) 2011, Interactive Matter, Marcus Nowotny
12
+ 
13
+Permission is hereby granted, free of charge, to any person obtaining a copy
14
+of this software and associated documentation files (the "Software"), to deal
15
+in the Software without restriction, including without limitation the rights
16
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
+copies of the Software, and to permit persons to whom the Software is
18
+furnished to do so, subject to the following conditions:
19
+ 
20
+The above copyright notice and this permission notice shall be included in
21
+all copies or substantial portions of the Software.
22
+ 
23
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29
+THE SOFTWARE.
30
+
31
+About
32
+-----
33
+
34
+The TMC26X is a stepper motor controller for bipolar stepper motors. From the trinamic web site:
35
+
36
+ The TMC262 is the first energy efficient high current high precision microstepping driver 
37
+ IC for bipolar stepper motors. The unique high resolution sensorless load detection stallGuard2™ 
38
+ is used to for the world’s first integrated load dependent current control feature called coolStep™.
39
+ The ability to read out the load and detect an overload makes the TMC262 an optimum choice for 
40
+ drives where a high reliability is desired at a low cost. The new patented spreadCycle PWM mixed 
41
+ decay chopper scheme ensures best zero crossing performance as well as high speed operation. 
42
+ The TMC262 can be driven with Step & Direction signals as well as by serial SPI™ interface. 
43
+ Using the microPlyer allows to operate the motor with highest 256 μStep smoothness reducing the 
44
+ input frequency to 16 μSteps. A full set of protection and diagnostic features makes this device 
45
+ very rugged. It directly drives external MOSFETs for currents of up to 6A. This way it reaches 
46
+ highest energy efficiency and allows driving of a high motor current without cooling measures 
47
+ even at high environment temperatures.
48
+
49
+
50
+The unique features of the TMC26X are that everything can (and must) be controlled in software:
51
+
52
+* the motor current
53
+* microstepping
54
+* stall protection
55
+* current reduction according to load
56
+* stallGuard2™ sensorless load detection
57
+* coolStep™ load dependent current control
58
+* spreadCycle hysteresis PWM chopper 
59
+* microPlyer 16-to-256 μStep multiplier
60
+* full protection and diagnostics
61
+
62
+This makes the TMC26X a bit harder to use than other stepper motors but much more versatile.
63
+This library resolves all the complicated stuff so that you can use TMC26X straight away.
64
+Furthermore, all the settings are implemented in high level interfaces so that configuring your
65
+motor is a breeze.
66
+
67
+How to use
68
+----------
69
+
70
+Check out the Setup Guide here: 
71
+And the How To here:

+ 999
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/TMC26XStepper.cpp
File diff suppressed because it is too large
View File


+ 607
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/TMC26XStepper.h View File

@@ -0,0 +1,607 @@
1
+/*
2
+ TMC26XStepper.cpp - - TMC26X Stepper library for Wiring/Arduino
3
+ 
4
+ based on the stepper library by Tom Igoe, et. al.
5
+
6
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
7
+ 
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+ 
15
+ The above copyright notice and this permission notice shall be included in
16
+ all copies or substantial portions of the Software.
17
+ 
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
25
+
26
+ */
27
+
28
+
29
+// ensure this library description is only included once
30
+#ifndef TMC26XStepper_h
31
+#define TMC26XStepper_h
32
+
33
+//! return value for TMC26XStepper.getOverTemperature() if there is a overtemperature situation in the TMC chip
34
+/*!
35
+ * This warning indicates that the TCM chip is too warm. 
36
+ * It is still working but some parameters may be inferior. 
37
+ * You should do something against it.
38
+ */
39
+#define TMC26X_OVERTEMPERATURE_PREWARING 1
40
+//! return value for TMC26XStepper.getOverTemperature() if there is a overtemperature shutdown in the TMC chip
41
+/*!
42
+ * This warning indicates that the TCM chip is too warm to operate and has shut down to prevent damage. 
43
+ * It will stop working until it cools down again.
44
+ * If you encouter this situation you must do something against it. Like reducing the current or improving the PCB layout 
45
+ * and/or heat management.
46
+ */
47
+#define TMC26X_OVERTEMPERATURE_SHUTDOWN 2
48
+
49
+//which values can be read out
50
+/*!
51
+ * Selects to readout the microstep position from the motor.
52
+ *\sa readStatus()
53
+ */
54
+#define TMC26X_READOUT_POSITION 0
55
+/*!
56
+ * Selects to read out the StallGuard value of the motor.
57
+ *\sa readStatus()
58
+ */
59
+#define TMC26X_READOUT_STALLGUARD 1
60
+/*!
61
+ * Selects to read out the current current setting (acc. to CoolStep) and the upper bits of the StallGuard value from the motor.
62
+ *\sa readStatus(), setCurrent()
63
+ */
64
+#define TMC26X_READOUT_CURRENT 3
65
+
66
+/*!
67
+ * Define to set the minimum current for CoolStep operation to 1/2 of the selected CS minium.
68
+ *\sa setCoolStepConfiguration()
69
+ */
70
+#define COOL_STEP_HALF_CS_LIMIT 0
71
+/*!
72
+ * Define to set the minimum current for CoolStep operation to 1/4 of the selected CS minium.
73
+ *\sa setCoolStepConfiguration()
74
+ */
75
+#define COOL_STEP_QUARTDER_CS_LIMIT 1
76
+
77
+/*!
78
+ * \class TMC26XStepper
79
+ * \brief Class representing a TMC26X stepper driver
80
+ * 
81
+ * In order to use one fo those drivers in your Arduino code you have to create an object of that class:
82
+ * \code
83
+ * TMC26XStepper stepper = TMC26XStepper(200,1,2,3,500);
84
+ * \endcode
85
+ * see TMC26XStepper(int number_of_steps, int cs_pin, int dir_pin, int step_pin, unsigned int rms_current)
86
+ *
87
+ * Keep in mind that you need to start the driver with start() in order to get the TMC26X configured.
88
+ * 
89
+ * The most important function is the move(). It checks if the motor has to do a step or not.
90
+ * It is important that you call move() as often as possible in your Arduino loop() routine. I suggest
91
+ * to use a very fast loop routine and always call it at the beginning or the end.
92
+ *
93
+ * In order to move you have to provide a movement speed with setSpeed(). The speed is a positive value setting
94
+ * the rotations per minute.
95
+ *
96
+ * To really move the motor you have to call step() to tell the driver to move the motor the given number 
97
+ * of steps in the given direction. Positive values move the motor in one direction, negative values in the other direction.
98
+ *
99
+ * You can check with isMoving() if the mototr is still moving or stop it  apruptely with stop().
100
+ */
101
+class TMC26XStepper {
102
+  public:
103
+    /*!
104
+     * \brief creates a new represenatation of a stepper motor connected to a TMC26X stepper driver
105
+     *
106
+     * This is the main constructor. If in doubt use this. You must provide all parameters as described below.
107
+     *
108
+     * \param number_of_steps the number of steps the motor has per rotation.
109
+     * \param cs_pin The Arduino pin you have connected the Cient Select Pin (!CS) of the TMC26X for SPI
110
+     * \param dir_pin the number of the Arduino pin the Direction input of the TMC26X is connected
111
+     * \param step_pin the number of the Arduino pin the step pin of the TMC26X driver is connected.
112
+     * \param rms_current the maximum current to privide to the motor in mA (!). A value of 200 would send up to 200mA to the motor
113
+     * \param resistor the current sense resistor in milli Ohm, defaults to ,15 Ohm ( or 150 milli Ohm) as in the TMC260 Arduino Shield
114
+     *
115
+     * Keep in mind that you must also call TMC26XStepper.start() in order to configure the stepper driver for use.
116
+     *
117
+     * By default the Constant Off Time chopper is used, see TCM262Stepper.setConstantOffTimeChopper() for details. 
118
+     * This should work on most motors (YMMV). You may want to configure and use the Spread Cycle Chopper, see  setSpreadCycleChopper().
119
+     *
120
+     * By default a microstepping of 1/32th is used to provide a smooth motor run, while still giving a good progression per step.
121
+     * You can select a different stepping with setMicrosteps() to aa different value.
122
+     * \sa start(), setMicrosteps()
123
+     */
124
+	TMC26XStepper(int number_of_steps, int cs_pin, int dir_pin, int step_pin, unsigned int current, unsigned int resistor=150);
125
+	
126
+    /*!
127
+     * \brief configures and starts the TMC26X stepper driver. Before you called this function the stepper driver is in nonfunctional mode.
128
+     *
129
+     * This routine configures the TMC26X stepper driver for the given values via SPI. 
130
+     * Most member functions are non functional if the driver has not been started.
131
+     * Therefore it is best to call this in your Arduino setup() function.
132
+     */
133
+	void start();
134
+    
135
+    /*!
136
+     * \brief resets the stepper in unconfigured mode.
137
+     *
138
+     * This routine enables you to call start again. It does not change anything 
139
+     * in the internal stepper configuration or the desired configuration.
140
+     * It just marks the stepper as not yet startet. You do not have to reconfigure
141
+     * the stepper to start it again, but it is not reset to any factory settings
142
+     * this has to be configured back by yourself.
143
+     * (Hint: Normally you do not need this function)
144
+     */
145
+	void un_start();
146
+
147
+
148
+    /*!
149
+     * \brief Sets the rotation speed in revolutions per minute.
150
+     * \param whatSpeed the desired speed in rotations per minute.
151
+     */
152
+    void setSpeed(unsigned int whatSpeed);
153
+    
154
+    /*!
155
+     * \brief reads out the currently selected speed in revolutions per minute.
156
+     * \sa setSpeed()
157
+     */
158
+    unsigned int getSpeed(void);
159
+
160
+    /*!
161
+     * \brief Set the number of microsteps in 2^i values (rounded) up to 256
162
+     *
163
+     * This method set's the number of microsteps per step in 2^i interval.
164
+     * This means you can select 1, 2, 4, 16, 32, 64, 128 or 256 as valid microsteps.
165
+     * If you give any other value it will be rounded to the next smaller number (3 would give a microstepping of 2).
166
+     * You can always check the current microstepping with getMicrosteps(). 
167
+     */ 
168
+	void setMicrosteps(int number_of_steps);
169
+    
170
+	/*!
171
+     * \brief returns the effective current number of microsteps selected.
172
+     *
173
+     * This function always returns the effective number of microsteps. 
174
+     * This can be a bit different than the micro steps set in setMicrosteps() since it is rounded to 2^i.
175
+     *
176
+     * \sa setMicrosteps()
177
+     */
178
+	int getMicrosteps(void);
179
+
180
+    /*!
181
+     * \brief Initiate a movement for the given number of steps. Positive numbers move in one, negative numbers in the other direction.
182
+     *
183
+     * \param number_of_steps The number of steps to move the motor.
184
+     * \return 0 if the motor was not moving and moves now. -1 if the motor is moving and the new steps could not be set.
185
+     *
186
+     * If the previous movement is not finished yet the function will return -1 and not change the steps to move the motor.
187
+	 * If the motor does not move it return 0
188
+     *
189
+     * The direction of the movement is indicated by the sign of the steps parameter. It is not determinable if positive values are right 
190
+     * or left This depends on the internal construction of the motor and how you connected it to the stepper driver.
191
+     *
192
+     * You can always verify with isMoving() or even use stop() to stop the motor before giving it new step directions.
193
+     * \sa isMoving(), getStepsLeft(), stop()
194
+     */
195
+    char step(int number_of_steps);
196
+    
197
+    /*!
198
+     * \brief Central movement method, must be called as often as possible in the lopp function and is very fast.
199
+     *
200
+     * 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 
201
+     * and manages the number of steps yet to move to fulfill the current move command.
202
+     *
203
+     * This function is implemented to be as fast as possible to call it as often as possible in your loop routine.
204
+     * The more regurlarly you call this function the better. In both senses of 'regularly': Calling it as often as
205
+     * possible is not a bad idea and if you even manage that the intervals you call this function are not too irregular helps too.
206
+     *
207
+     * 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.
208
+     * You must not call isMoving() to determine if you need to call this function, since taht is done internally already and only 
209
+     * slows down you code.
210
+     * 
211
+     * How often you call this function directly influences your top miving speed for the motor. It may be a good idea to call this
212
+     * from an timer overflow interrupt to ensure proper calling.
213
+     * \sa step()
214
+     */
215
+    char move(void);
216
+
217
+    /*!
218
+     * \brief checks if the motor still has to move to fulfill the last movement command.
219
+     * \return 0 if the motor stops, -1 if the motor is moving.
220
+     *
221
+     * This method can be used to determine if the motor is ready for new movements.
222
+     *\sa step(), move()
223
+     */
224
+    char isMoving(void);
225
+    
226
+    /*!
227
+     * \brief Get the number of steps left in the current movement.
228
+     * \return The number of steps left in the movement. This number is always positive.
229
+     */
230
+    unsigned int getStepsLeft(void);
231
+    
232
+    /*!
233
+     * \brief Stops the motor regardless if it moves or not.
234
+     * \return -1 if the motor was moving and is really stoped or 0 if it was not moving at all.
235
+     *
236
+     * This method directly and apruptely stops the motor and may be used as an emergency stop.
237
+     */
238
+    char stop(void);
239
+    
240
+    /*!
241
+     * \brief Sets and configure the classical Constant Off Timer Chopper
242
+     * \param constant_off_time 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)
243
+     * \param blank_time 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
244
+     * \param fast_decay_time_setting 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
245
+     * \param sine_wave_offset 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
246
+     * \param use_curreent_comparator 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).
247
+     *
248
+     * The classic constant off time chopper uses a fixed portion of fast decay following each on phase. 
249
+     * While the duration of the on time is determined by the chopper comparator, the fast decay time needs 
250
+     * to be set by the user in a way, that the current decay is enough for the driver to be able to follow 
251
+     * the falling slope of the sine wave, and on the other hand it should not be too long, in order to minimize 
252
+     * motor current ripple and power dissipation. This best can be tuned using an oscilloscope or 
253
+     * trying out motor smoothness at different velocities. A good starting value is a fast decay time setting 
254
+     * similar to the slow decay time setting.
255
+     * After tuning of the fast decay time, the offset should be determined, in order to have a smooth zero transition. 
256
+     * This is necessary, because the fast decay phase leads to the absolute value of the motor current being lower 
257
+     * than the target current (see figure 17). If the zero offset is too low, the motor stands still for a short 
258
+     * moment during current zero crossing, if it is set too high, it makes a larger microstep.
259
+     * Typically, a positive offset setting is required for optimum operation.
260
+     *
261
+     * \sa setSpreadCycleChoper() for other alternatives.
262
+     * \sa setRandomOffTime() for spreading the noise over a wider spectrum
263
+     */
264
+	void setConstantOffTimeChopper(char constant_off_time, char blank_time, char fast_decay_time_setting, char sine_wave_offset, unsigned char use_current_comparator);
265
+    
266
+    /*!
267
+     * \brief Sets and configures with spread cycle chopper.
268
+     * \param constant_off_time 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)
269
+     * \param blank_time 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
270
+     * \param hysteresis_start Hysteresis start setting. Please remark, that this value is an offset to the hysteresis end value. 1 … 8
271
+     * \param hysteresis_end 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 <16. At a current setting CS of max. 30 (amplitude reduced to 240), the sum is not limited.
272
+     * \param hysteresis_decrement 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).
273
+     *
274
+     * The spreadCycle chopper scheme (pat.fil.) is a precise and simple to use chopper principle, which automatically determines 
275
+     * the optimum fast decay portion for the motor. Anyhow, a number of settings can be made in order to optimally fit the driver 
276
+     * to the motor.
277
+     * Each chopper cycle is comprised of an on-phase, a slow decay phase, a fast decay phase and a second slow decay phase.
278
+     * The slow decay phases limit the maximum chopper frequency and are important for low motor and driver power dissipation. 
279
+     * The hysteresis start setting limits the chopper frequency by forcing the driver to introduce a minimum amount of 
280
+     * current ripple into the motor coils. The motor inductivity determines the ability to follow a changing motor current. 
281
+     * The duration of the on- and fast decay phase needs to cover at least the blank time, because the current comparator is 
282
+     * disabled during this time.
283
+     * 
284
+     * \sa setRandomOffTime() for spreading the noise over a wider spectrum
285
+     */
286
+	void setSpreadCycleChopper(char constant_off_time, char blank_time, char hysteresis_start, char hysteresis_end, char hysteresis_decrement);
287
+
288
+	/*!
289
+     * \brief Use random off time for noise reduction (0 for off, -1 for on).
290
+     * \param value 0 for off, -1 for on
291
+     *
292
+     * In a constant off time chopper scheme both coil choppers run freely, i.e. are not synchronized. 
293
+     * The frequency of each chopper mainly depends on the coil current and the position dependant motor coil inductivity, 
294
+     * thus it depends on the microstep position. With some motors a slightly audible beat can occur between the chopper 
295
+     * frequencies, especially when they are near to each other. This typically occurs at a few microstep positions within 
296
+     * each quarter wave. 
297
+     * This effect normally is not audible when compared to mechanical noise generated by ball bearings, 
298
+     * etc. Further factors which can cause a similar effect are a poor layout of sense resistor GND connection.
299
+     * In order to minimize the effect of a beat between both chopper frequencies, an internal random generator is provided. 
300
+     * It modulates the slow decay time setting when switched on. The random off time feature further spreads the chopper spectrum,
301
+     * reducing electromagnetic emission on single frequencies.
302
+     */
303
+	void setRandomOffTime(char value);
304
+    
305
+	/*!
306
+     * \brief set the maximum motor current in mA (1000 is 1 Amp)
307
+     * 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
308
+     * by employing CoolStep.
309
+     * \param current the maximum motor current in mA
310
+     * \sa getCurrent(), getCurrentCurrent()
311
+     */
312
+	void setCurrent(unsigned int current);
313
+    
314
+    /*!
315
+     * \brief readout the motor maximum current in mA (1000 is an Amp)
316
+     * This is the maximum current. to get the current current - which may be affected by CoolStep us getCurrentCurrent()
317
+     *\return the maximum motor current in milli amps
318
+     * \sa getCurrentCurrent()
319
+     */
320
+    unsigned int getCurrent(void);
321
+    
322
+	/*!
323
+     * \brief set the StallGuard threshold in order to get sensible StallGuard readings.
324
+     * \param stall_guard_threshold -64 … 63 the StallGuard threshold
325
+     * \param stall_guard_filter_enabled 0 if the filter is disabled, -1 if it is enabled
326
+     *
327
+     * The StallGuard threshold is used to optimize the StallGuard reading to sensible values. It should be at 0 at
328
+     * the maximum allowable load on the otor (but not before). = is a good starting point (and the default)
329
+     * If you get Stall Gaurd readings of 0 without any load or with too little laod increase the value.
330
+     * If you get readings of 1023 even with load decrease the setting.
331
+     *
332
+     * If you switch on the filter the StallGuard reading is only updated each 4th full step to reduce the noise in the
333
+     * reading.
334
+     * 
335
+     * \sa getCurrentStallGuardReading() to read out the current value.
336
+     */ 
337
+	void setStallGuardThreshold(char stall_guard_threshold, char stall_guard_filter_enabled);
338
+    
339
+    /*!
340
+     * \brief reads out the StallGuard threshold
341
+     * \return a number between -64 and 63.
342
+     */
343
+    char getStallGuardThreshold(void);
344
+    
345
+    /*!
346
+     * \brief returns the current setting of the StallGuard filter
347
+     * \return 0 if not set, -1 if set
348
+     */
349
+    char getStallGuardFilter(void);
350
+    
351
+    /*!
352
+     * \brief 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.
353
+     * \param lower_SG_threshold Sets the lower threshold for stallGuard2TM reading. Below this value, the motor current becomes increased. Allowed values are 0...480
354
+     * \param SG_hysteresis 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
355
+     * \param current_decrement_step_size Sets the current decrement steps. If the StallGuard value is above the threshold the current gets decremented by this step size. 0...32
356
+     * \param current_increment_step_size Sets the current increment step. The current becomes incremented for each measured stallGuard2TM value below the lower threshold. 0...8
357
+     * \param lower_current_limit 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
358
+     * The CoolStep smart energy operation automatically adjust the current sent into the motor according to the current load,
359
+     * read out by the StallGuard in order to provide the optimum torque with the minimal current consumption.
360
+     * You configure the CoolStep current regulator by defining upper and lower bounds of StallGuard readouts. If the readout is above the 
361
+     * limit the current gets increased, below the limit the current gets decreased.
362
+     * 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
363
+     * StallGuard readings neccessary above or below the limit to get a more stable current adjustement.
364
+     * The current adjustement itself is configured by the number of steps the current gests in- or decreased and the absolut minimum current
365
+     * (1/2 or 1/4th otf the configured current).
366
+     * \sa COOL_STEP_HALF_CS_LIMIT, COOL_STEP_QUARTER_CS_LIMIT
367
+     */
368
+    void setCoolStepConfiguration(unsigned int lower_SG_threshold, unsigned int SG_hysteresis, unsigned char current_decrement_step_size,
369
+                                  unsigned char current_increment_step_size, unsigned char lower_current_limit);
370
+    
371
+    /*!
372
+     * \brief enables or disables the CoolStep smart energy operation feature. It must be configured before enabling it.
373
+     * \param enabled true if CoolStep should be enabled, false if not.
374
+     * \sa setCoolStepConfiguration()
375
+     */
376
+    void setCoolStepEnabled(boolean enabled);
377
+    
378
+    
379
+    /*!
380
+     * \brief check if the CoolStep feature is enabled
381
+     * \sa setCoolStepEnabled()
382
+     */
383
+    boolean isCoolStepEnabled();
384
+
385
+    /*!
386
+     * \brief returns the lower StallGuard threshold for the CoolStep operation
387
+     * \sa setCoolStepConfiguration()
388
+     */
389
+    unsigned int getCoolStepLowerSgThreshold();
390
+    
391
+    /*!
392
+     * \brief returns the upper StallGuard threshold for the CoolStep operation
393
+     * \sa setCoolStepConfiguration()
394
+     */
395
+    unsigned int getCoolStepUpperSgThreshold();
396
+    
397
+    /*!
398
+     * \brief returns the number of StallGuard readings befor CoolStep adjusts the motor current.
399
+     * \sa setCoolStepConfiguration()
400
+     */
401
+    unsigned char getCoolStepNumberOfSGReadings();
402
+    
403
+    /*!
404
+     * \brief returns the increment steps for the current for the CoolStep operation
405
+     * \sa setCoolStepConfiguration()
406
+     */
407
+    unsigned char getCoolStepCurrentIncrementSize();
408
+    
409
+    /*!
410
+     * \brief returns the absolut minium current for the CoolStep operation
411
+     * \sa setCoolStepConfiguration()
412
+     * \sa COOL_STEP_HALF_CS_LIMIT, COOL_STEP_QUARTER_CS_LIMIT
413
+     */
414
+    unsigned char getCoolStepLowerCurrentLimit();
415
+    
416
+	/*!
417
+     * \brief Get the current microstep position for phase A
418
+     * \return The current microstep position for phase A 0…255
419
+     * 
420
+     * Keep in mind that this routine reads and writes a value via SPI - so this may take a bit time.
421
+     */
422
+	int getMotorPosition(void);
423
+    
424
+    /*!
425
+     * \brief Reads the current StallGuard value.
426
+     * \return The current StallGuard value, lesser values indicate higher load, 0 means stall detected.
427
+     * Keep in mind that this routine reads and writes a value via SPI - so this may take a bit time.
428
+     * \sa setStallGuardThreshold() for tuning the readout to sensible ranges.
429
+     */
430
+	int getCurrentStallGuardReading(void);
431
+    
432
+    /*!
433
+     * \brief Reads the current current setting value as fraction of the maximum current
434
+     * Returns values between 0 and 31, representing 1/32 to 32/32 (=1)
435
+     * \sa setCoolStepConfiguration()
436
+     */
437
+    unsigned char getCurrentCSReading(void);
438
+    
439
+    
440
+    /*!
441
+     *\brief a convenience method to determine if the current scaling uses 0.31V or 0.165V as reference.
442
+     *\return false if 0.13V is the reference voltage, true if 0.165V is used.
443
+     */
444
+    boolean isCurrentScalingHalfed();
445
+
446
+    /*!
447
+     * \brief Reads the current current setting value and recalculates the absolute current in mA (1A would be 1000).
448
+     * This method calculates the currently used current setting (either by setting or by CoolStep) and reconstructs
449
+     * the current in mA by usinge the VSENSE and resistor value. This method uses floating point math - so it 
450
+     * may not be the fastest.
451
+     * \sa getCurrentCSReading(), getResistor(), isCurrentScalingHalfed(), getCurrent()
452
+     */
453
+    unsigned int getCurrentCurrent(void);
454
+    
455
+    /*!
456
+     * \brief checks if there is a StallGuard warning in the last status
457
+     * \return 0 if there was no warning, -1 if there was some warning.
458
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
459
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
460
+     *
461
+     * \sa setStallGuardThreshold() for tuning the readout to sensible ranges.
462
+     */
463
+	boolean isStallGuardOverThreshold(void);
464
+    
465
+    /*!
466
+     * \brief Return over temperature status of the last status readout
467
+     * 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.
468
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
469
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
470
+     */
471
+	char getOverTemperature(void);
472
+    
473
+    /*!
474
+     * \brief Is motor channel A shorted to ground detected in the last status readout.
475
+     * \return true is yes, false if not.
476
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
477
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
478
+     */
479
+     
480
+	boolean isShortToGroundA(void);
481
+
482
+    /*!
483
+     * \brief Is motor channel B shorted to ground detected in the last status readout.
484
+     * \return true is yes, false if not.
485
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
486
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
487
+     */
488
+	boolean isShortToGroundB(void);
489
+	/*!
490
+     * \brief iIs motor channel A connected according to the last statu readout.
491
+     * \return true is yes, false if not.
492
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
493
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
494
+     */
495
+	boolean isOpenLoadA(void);
496
+
497
+	/*!
498
+     * \brief iIs motor channel A connected according to the last statu readout.
499
+     * \return true is yes, false if not.
500
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
501
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
502
+     */
503
+	boolean isOpenLoadB(void);
504
+    
505
+    /*!
506
+     * \brief Is chopper inactive since 2^20 clock cycles - defaults to ~0,08s
507
+     * \return true is yes, false if not.
508
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
509
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
510
+     */
511
+	boolean isStandStill(void);
512
+
513
+    /*!
514
+     * \brief checks if there is a StallGuard warning in the last status
515
+     * \return 0 if there was no warning, -1 if there was some warning.
516
+     * Keep in mind that this method does not enforce a readout but uses the value of the last status readout.
517
+     * You may want to use getMotorPosition() or getCurrentStallGuardReading() to enforce an updated status readout.
518
+     *
519
+     * \sa isStallGuardOverThreshold()
520
+     * TODO why?
521
+     *
522
+     * \sa setStallGuardThreshold() for tuning the readout to sensible ranges.
523
+     */
524
+	boolean isStallGuardReached(void);
525
+    
526
+    /*!
527
+     *\brief enables or disables the motor driver bridges. If disabled the motor can run freely. If enabled not.
528
+     *\param enabled a boolean value true if the motor should be enabled, false otherwise.
529
+     */
530
+    void setEnabled(boolean enabled);
531
+    
532
+    /*!
533
+     *\brief checks if the output bridges are enabled. If the bridges are not enabled the motor can run freely
534
+     *\return true if the bridges and by that the motor driver are enabled, false if not.
535
+     *\sa setEnabled()
536
+     */
537
+    boolean isEnabled();
538
+
539
+	/*!
540
+     * \brief Manually read out the status register
541
+     * This function sends a byte to the motor driver in order to get the current readout. The parameter read_value
542
+     * seletcs which value will get returned. If the read_vlaue changes in respect to the previous readout this method
543
+     * automatically send two bytes to the motor: one to set the redout and one to get the actual readout. So this method 
544
+     * may take time to send and read one or two bits - depending on the previous readout.
545
+     * \param read_value 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
546
+     * \sa TMC26X_READOUT_POSITION, TMC_262_READOUT_STALLGUARD, TMC_262_READOUT_CURRENT
547
+     */
548
+	void readStatus(char read_value);
549
+    
550
+    /*!
551
+     * \brief Returns the current sense resistor value in milliohm.
552
+     * The default value of ,15 Ohm will return 150.
553
+     */
554
+    int getResistor();
555
+
556
+    /*!
557
+     * \brief Prints out all the information that can be found in the last status read out - it does not force a status readout. 
558
+     * The result is printed via Serial
559
+     */
560
+	void debugLastStatus(void);
561
+	/*!
562
+     * \brief library version
563
+     * \return the version number as int.
564
+     */
565
+    int version(void);
566
+
567
+  private:    
568
+  	unsigned int steps_left;		//the steps the motor has to do to complete the movement
569
+    int direction;        // Direction of rotation
570
+    unsigned long step_delay;    // delay between steps, in ms, based on speed
571
+    int number_of_steps;      // total number of steps this motor can take
572
+    unsigned int speed; // we need to store the current speed in order to change the speed after changing microstepping
573
+    unsigned int resistor; //current sense resitor value in milliohm
574
+        
575
+    unsigned long last_step_time;      // time stamp in ms of when the last step was taken
576
+    unsigned long next_step_time;      // time stamp in ms of when the last step was taken
577
+	
578
+	//driver control register copies to easily set & modify the registers
579
+	unsigned long driver_control_register_value;
580
+	unsigned long chopper_config_register;
581
+	unsigned long cool_step_register_value;
582
+	unsigned long stall_guard2_current_register_value;
583
+	unsigned long driver_configuration_register_value;
584
+	//the driver status result
585
+	unsigned long driver_status_result;
586
+	
587
+	//helper routione to get the top 10 bit of the readout
588
+	inline int getReadoutValue();
589
+	
590
+	//the pins for the stepper driver
591
+	unsigned char cs_pin;
592
+	unsigned char step_pin;
593
+	unsigned char dir_pin;
594
+	
595
+	//status values 
596
+	boolean started; //if the stepper has been started yet
597
+	int microsteps; //the current number of micro steps
598
+    char constant_off_time; //we need to remember this value in order to enable and disable the motor
599
+    unsigned char cool_step_lower_threshold; // we need to remember the threshold to enable and disable the CoolStep feature
600
+    boolean cool_step_enabled; //we need to remember this to configure the coolstep if it si enabled
601
+	
602
+	//SPI sender
603
+	inline void send262(unsigned long datagram);
604
+};
605
+
606
+#endif
607
+

+ 848
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8cpp.html View File

@@ -0,0 +1,848 @@
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.cpp File Reference</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+</div>
53
+<div class="header">
54
+  <div class="summary">
55
+<a href="#define-members">Defines</a>  </div>
56
+  <div class="headertitle">
57
+<div class="title">TMC26XStepper.cpp File Reference</div>  </div>
58
+</div><!--header-->
59
+<div class="contents">
60
+<div class="textblock"><code>#include &lt;WProgram.h&gt;</code><br/>
61
+<code>#include &lt;SPI.h&gt;</code><br/>
62
+<code>#include &quot;<a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>&quot;</code><br/>
63
+</div>
64
+<p><a href="_t_m_c26_x_stepper_8cpp_source.html">Go to the source code of this file.</a></p>
65
+<table class="memberdecls">
66
+<tr><td colspan="2"><h2><a name="define-members"></a>
67
+Defines</h2></td></tr>
68
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6560b3471273e99e280ba795e3469ede">DEFAULT_MICROSTEPPING_VALUE</a>&#160;&#160;&#160;32</td></tr>
69
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a108f18bf4a30a0e0f0991ac0e4ce0579">DRIVER_CONTROL_REGISTER</a>&#160;&#160;&#160;0x0ul</td></tr>
70
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a70a540d1090b989b8600b5e4776659fe">CHOPPER_CONFIG_REGISTER</a>&#160;&#160;&#160;0x80000ul</td></tr>
71
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab9828bfaa075a0a8647c709136016317">COOL_STEP_REGISTER</a>&#160;&#160;&#160;0xA0000ul</td></tr>
72
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a478d9bde09a6528eef6af6ffeeb6caba">STALL_GUARD2_LOAD_MEASURE_REGISTER</a>&#160;&#160;&#160;0xC0000ul</td></tr>
73
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#af35f569d42ea3b1d634901a3b6a908ee">DRIVER_CONFIG_REGISTER</a>&#160;&#160;&#160;0xE0000ul</td></tr>
74
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a3b02ee1f518b0c90c16488f937abd443">REGISTER_BIT_PATTERN</a>&#160;&#160;&#160;0xFFFFFul</td></tr>
75
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8f5cb0c066109ffb18cefc0e85ee1d1b">MICROSTEPPING_PATTERN</a>&#160;&#160;&#160;0xFul</td></tr>
76
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa64245f223209654c60588e4558e0bab">STEP_INTERPOLATION</a>&#160;&#160;&#160;0x200ul</td></tr>
77
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a770601bf0153e4bc639b9c3005b15af7">DOUBLE_EDGE_STEP</a>&#160;&#160;&#160;0x100ul</td></tr>
78
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a4fb1c008e2ff76eee9362600eed112e1">VSENSE</a>&#160;&#160;&#160;0x40ul</td></tr>
79
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a143b7757272f07866d9655bde8303d9a">READ_MICROSTEP_POSTION</a>&#160;&#160;&#160;0x0ul</td></tr>
80
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac1bd4da94fab7ce1049be2f866211819">READ_STALL_GUARD_READING</a>&#160;&#160;&#160;0x10ul</td></tr>
81
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aef62b7fdcbac0b33b2d6e9cea4b5f9b2">READ_STALL_GUARD_AND_COOL_STEP</a>&#160;&#160;&#160;0x20ul</td></tr>
82
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a88a4b45fa6385eba8aa4f0342334b832">READ_SELECTION_PATTERN</a>&#160;&#160;&#160;0x30ul</td></tr>
83
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a57418a67ff726d540b813230bca1d536">CHOPPER_MODE_STANDARD</a>&#160;&#160;&#160;0x0ul</td></tr>
84
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aaf1b564ced7de8ff3245c964e3775826">CHOPPER_MODE_T_OFF_FAST_DECAY</a>&#160;&#160;&#160;0x4000ul</td></tr>
85
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa4e49237f2671e7f28aa34ae0e89da8d">T_OFF_PATTERN</a>&#160;&#160;&#160;0xful</td></tr>
86
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a64520580cffd416668f3b91bd60f84e1">RANDOM_TOFF_TIME</a>&#160;&#160;&#160;0x2000ul</td></tr>
87
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a42cb2ce84258587d514ec3268548ba89">BLANK_TIMING_PATTERN</a>&#160;&#160;&#160;0x18000ul</td></tr>
88
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#abdac78f7f2c506972265a8e5883e1eae">BLANK_TIMING_SHIFT</a>&#160;&#160;&#160;15</td></tr>
89
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a424c248097b38c1e29e6a58ad48e6bd9">HYSTERESIS_DECREMENT_PATTERN</a>&#160;&#160;&#160;0x1800ul</td></tr>
90
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a36e554a87785ce6ba998b79aae9e74e0">HYSTERESIS_DECREMENT_SHIFT</a>&#160;&#160;&#160;11</td></tr>
91
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ad9d2302f6d61cd84a612a2e2bcdeb56e">HYSTERESIS_LOW_VALUE_PATTERN</a>&#160;&#160;&#160;0x780ul</td></tr>
92
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a38ce0bb0fa20db28351ac9167f28db98">HYSTERESIS_LOW_SHIFT</a>&#160;&#160;&#160;7</td></tr>
93
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a0de4e98b412dced62c3a4452b7483af3">HYSTERESIS_START_VALUE_PATTERN</a>&#160;&#160;&#160;0x78ul</td></tr>
94
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac2c1c939256126e605396c4aaee3c804">HYSTERESIS_START_VALUE_SHIFT</a>&#160;&#160;&#160;4</td></tr>
95
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a7659d842c803e47ba911a2a6e26327f3">T_OFF_TIMING_PATERN</a>&#160;&#160;&#160;0xFul</td></tr>
96
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8a261a77d198b85f6dd8416387b354b3">MINIMUM_CURRENT_FOURTH</a>&#160;&#160;&#160;0x8000ul</td></tr>
97
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbe13a0464355e42fbe786ca5f58ed8d">CURRENT_DOWN_STEP_SPEED_PATTERN</a>&#160;&#160;&#160;0x6000ul</td></tr>
98
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac8f748bf735c447dbed7dd4c7b631a87">SE_MAX_PATTERN</a>&#160;&#160;&#160;0xF00ul</td></tr>
99
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aba6c07e5672e34e618bb3a550ab0d2bc">SE_CURRENT_STEP_WIDTH_PATTERN</a>&#160;&#160;&#160;0x60ul</td></tr>
100
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae1862dfb958c03698b0abd95fda033ea">SE_MIN_PATTERN</a>&#160;&#160;&#160;0xful</td></tr>
101
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#afdbbefabd0c29c4b6e403c4663d0f0be">STALL_GUARD_FILTER_ENABLED</a>&#160;&#160;&#160;0x10000ul</td></tr>
102
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae631457932894a974334892704550ecc">STALL_GUARD_TRESHHOLD_VALUE_PATTERN</a>&#160;&#160;&#160;0x17F00ul</td></tr>
103
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99dcb8c6d98b0b54c23699a3f90450e4">CURRENT_SCALING_PATTERN</a>&#160;&#160;&#160;0x1Ful</td></tr>
104
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99ac04f0615556fc13c0c9f3e1c1b49d">STALL_GUARD_CONFIG_PATTERN</a>&#160;&#160;&#160;0x17F00ul</td></tr>
105
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6a1cb1fd61cf7c570f94376fa11fe55b">STALL_GUARD_VALUE_PATTERN</a>&#160;&#160;&#160;0x7F00ul</td></tr>
106
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa09ef662fd19bf2d063d6bd0f48eca14">STATUS_STALL_GUARD_STATUS</a>&#160;&#160;&#160;0x1ul</td></tr>
107
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbb23d2f055c9eab55eac29d1a75deb4">STATUS_OVER_TEMPERATURE_SHUTDOWN</a>&#160;&#160;&#160;0x2ul</td></tr>
108
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa317fd77f2f26fdfbfd331e21d9069e8">STATUS_OVER_TEMPERATURE_WARNING</a>&#160;&#160;&#160;0x4ul</td></tr>
109
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8e03041302a092174fa33b3cf837dca2">STATUS_SHORT_TO_GROUND_A</a>&#160;&#160;&#160;0x8ul</td></tr>
110
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a903c3eba99695a32c6736463dcfd93ae">STATUS_SHORT_TO_GROUND_B</a>&#160;&#160;&#160;0x10ul</td></tr>
111
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae9cbbe5af7188e6bff8fe412f8e42f59">STATUS_OPEN_LOAD_A</a>&#160;&#160;&#160;0x20ul</td></tr>
112
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab29dc5cd6c6c4e5bf99e71bd563e1be1">STATUS_OPEN_LOAD_B</a>&#160;&#160;&#160;0x40ul</td></tr>
113
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab96ed1635faee6650e9cce73598a2773">STATUS_STAND_STILL</a>&#160;&#160;&#160;0x80ul</td></tr>
114
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a5c3d76da63f585e37813c32be2e11ab7">READOUT_VALUE_PATTERN</a>&#160;&#160;&#160;0xFFC00ul</td></tr>
115
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8cpp.html#a54a6d12e96d851361974b10614a00e45">INITIAL_MICROSTEPPING</a>&#160;&#160;&#160;0x3ul</td></tr>
116
+</table>
117
+<hr/><h2>Define Documentation</h2>
118
+<a class="anchor" id="a42cb2ce84258587d514ec3268548ba89"></a><!-- doxytag: member="TMC26XStepper.cpp::BLANK_TIMING_PATTERN" ref="a42cb2ce84258587d514ec3268548ba89" args="" -->
119
+<div class="memitem">
120
+<div class="memproto">
121
+      <table class="memname">
122
+        <tr>
123
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a42cb2ce84258587d514ec3268548ba89">BLANK_TIMING_PATTERN</a>&#160;&#160;&#160;0x18000ul</td>
124
+        </tr>
125
+      </table>
126
+</div>
127
+<div class="memdoc">
128
+
129
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00063">63</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
130
+
131
+</div>
132
+</div>
133
+<a class="anchor" id="abdac78f7f2c506972265a8e5883e1eae"></a><!-- doxytag: member="TMC26XStepper.cpp::BLANK_TIMING_SHIFT" ref="abdac78f7f2c506972265a8e5883e1eae" args="" -->
134
+<div class="memitem">
135
+<div class="memproto">
136
+      <table class="memname">
137
+        <tr>
138
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#abdac78f7f2c506972265a8e5883e1eae">BLANK_TIMING_SHIFT</a>&#160;&#160;&#160;15</td>
139
+        </tr>
140
+      </table>
141
+</div>
142
+<div class="memdoc">
143
+
144
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00064">64</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
145
+
146
+</div>
147
+</div>
148
+<a class="anchor" id="a70a540d1090b989b8600b5e4776659fe"></a><!-- doxytag: member="TMC26XStepper.cpp::CHOPPER_CONFIG_REGISTER" ref="a70a540d1090b989b8600b5e4776659fe" args="" -->
149
+<div class="memitem">
150
+<div class="memproto">
151
+      <table class="memname">
152
+        <tr>
153
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a70a540d1090b989b8600b5e4776659fe">CHOPPER_CONFIG_REGISTER</a>&#160;&#160;&#160;0x80000ul</td>
154
+        </tr>
155
+      </table>
156
+</div>
157
+<div class="memdoc">
158
+
159
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00041">41</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
160
+
161
+</div>
162
+</div>
163
+<a class="anchor" id="a57418a67ff726d540b813230bca1d536"></a><!-- doxytag: member="TMC26XStepper.cpp::CHOPPER_MODE_STANDARD" ref="a57418a67ff726d540b813230bca1d536" args="" -->
164
+<div class="memitem">
165
+<div class="memproto">
166
+      <table class="memname">
167
+        <tr>
168
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a57418a67ff726d540b813230bca1d536">CHOPPER_MODE_STANDARD</a>&#160;&#160;&#160;0x0ul</td>
169
+        </tr>
170
+      </table>
171
+</div>
172
+<div class="memdoc">
173
+
174
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00059">59</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
175
+
176
+</div>
177
+</div>
178
+<a class="anchor" id="aaf1b564ced7de8ff3245c964e3775826"></a><!-- doxytag: member="TMC26XStepper.cpp::CHOPPER_MODE_T_OFF_FAST_DECAY" ref="aaf1b564ced7de8ff3245c964e3775826" args="" -->
179
+<div class="memitem">
180
+<div class="memproto">
181
+      <table class="memname">
182
+        <tr>
183
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aaf1b564ced7de8ff3245c964e3775826">CHOPPER_MODE_T_OFF_FAST_DECAY</a>&#160;&#160;&#160;0x4000ul</td>
184
+        </tr>
185
+      </table>
186
+</div>
187
+<div class="memdoc">
188
+
189
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00060">60</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
190
+
191
+</div>
192
+</div>
193
+<a class="anchor" id="ab9828bfaa075a0a8647c709136016317"></a><!-- doxytag: member="TMC26XStepper.cpp::COOL_STEP_REGISTER" ref="ab9828bfaa075a0a8647c709136016317" args="" -->
194
+<div class="memitem">
195
+<div class="memproto">
196
+      <table class="memname">
197
+        <tr>
198
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab9828bfaa075a0a8647c709136016317">COOL_STEP_REGISTER</a>&#160;&#160;&#160;0xA0000ul</td>
199
+        </tr>
200
+      </table>
201
+</div>
202
+<div class="memdoc">
203
+
204
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00042">42</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
205
+
206
+</div>
207
+</div>
208
+<a class="anchor" id="adbe13a0464355e42fbe786ca5f58ed8d"></a><!-- doxytag: member="TMC26XStepper.cpp::CURRENT_DOWN_STEP_SPEED_PATTERN" ref="adbe13a0464355e42fbe786ca5f58ed8d" args="" -->
209
+<div class="memitem">
210
+<div class="memproto">
211
+      <table class="memname">
212
+        <tr>
213
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbe13a0464355e42fbe786ca5f58ed8d">CURRENT_DOWN_STEP_SPEED_PATTERN</a>&#160;&#160;&#160;0x6000ul</td>
214
+        </tr>
215
+      </table>
216
+</div>
217
+<div class="memdoc">
218
+
219
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00075">75</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
220
+
221
+</div>
222
+</div>
223
+<a class="anchor" id="a99dcb8c6d98b0b54c23699a3f90450e4"></a><!-- doxytag: member="TMC26XStepper.cpp::CURRENT_SCALING_PATTERN" ref="a99dcb8c6d98b0b54c23699a3f90450e4" args="" -->
224
+<div class="memitem">
225
+<div class="memproto">
226
+      <table class="memname">
227
+        <tr>
228
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99dcb8c6d98b0b54c23699a3f90450e4">CURRENT_SCALING_PATTERN</a>&#160;&#160;&#160;0x1Ful</td>
229
+        </tr>
230
+      </table>
231
+</div>
232
+<div class="memdoc">
233
+
234
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00083">83</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
235
+
236
+</div>
237
+</div>
238
+<a class="anchor" id="a6560b3471273e99e280ba795e3469ede"></a><!-- doxytag: member="TMC26XStepper.cpp::DEFAULT_MICROSTEPPING_VALUE" ref="a6560b3471273e99e280ba795e3469ede" args="" -->
239
+<div class="memitem">
240
+<div class="memproto">
241
+      <table class="memname">
242
+        <tr>
243
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6560b3471273e99e280ba795e3469ede">DEFAULT_MICROSTEPPING_VALUE</a>&#160;&#160;&#160;32</td>
244
+        </tr>
245
+      </table>
246
+</div>
247
+<div class="memdoc">
248
+
249
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00037">37</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
250
+
251
+</div>
252
+</div>
253
+<a class="anchor" id="a770601bf0153e4bc639b9c3005b15af7"></a><!-- doxytag: member="TMC26XStepper.cpp::DOUBLE_EDGE_STEP" ref="a770601bf0153e4bc639b9c3005b15af7" args="" -->
254
+<div class="memitem">
255
+<div class="memproto">
256
+      <table class="memname">
257
+        <tr>
258
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a770601bf0153e4bc639b9c3005b15af7">DOUBLE_EDGE_STEP</a>&#160;&#160;&#160;0x100ul</td>
259
+        </tr>
260
+      </table>
261
+</div>
262
+<div class="memdoc">
263
+
264
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00051">51</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
265
+
266
+</div>
267
+</div>
268
+<a class="anchor" id="af35f569d42ea3b1d634901a3b6a908ee"></a><!-- doxytag: member="TMC26XStepper.cpp::DRIVER_CONFIG_REGISTER" ref="af35f569d42ea3b1d634901a3b6a908ee" args="" -->
269
+<div class="memitem">
270
+<div class="memproto">
271
+      <table class="memname">
272
+        <tr>
273
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#af35f569d42ea3b1d634901a3b6a908ee">DRIVER_CONFIG_REGISTER</a>&#160;&#160;&#160;0xE0000ul</td>
274
+        </tr>
275
+      </table>
276
+</div>
277
+<div class="memdoc">
278
+
279
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00044">44</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
280
+
281
+</div>
282
+</div>
283
+<a class="anchor" id="a108f18bf4a30a0e0f0991ac0e4ce0579"></a><!-- doxytag: member="TMC26XStepper.cpp::DRIVER_CONTROL_REGISTER" ref="a108f18bf4a30a0e0f0991ac0e4ce0579" args="" -->
284
+<div class="memitem">
285
+<div class="memproto">
286
+      <table class="memname">
287
+        <tr>
288
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a108f18bf4a30a0e0f0991ac0e4ce0579">DRIVER_CONTROL_REGISTER</a>&#160;&#160;&#160;0x0ul</td>
289
+        </tr>
290
+      </table>
291
+</div>
292
+<div class="memdoc">
293
+
294
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00040">40</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
295
+
296
+</div>
297
+</div>
298
+<a class="anchor" id="a424c248097b38c1e29e6a58ad48e6bd9"></a><!-- doxytag: member="TMC26XStepper.cpp::HYSTERESIS_DECREMENT_PATTERN" ref="a424c248097b38c1e29e6a58ad48e6bd9" args="" -->
299
+<div class="memitem">
300
+<div class="memproto">
301
+      <table class="memname">
302
+        <tr>
303
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a424c248097b38c1e29e6a58ad48e6bd9">HYSTERESIS_DECREMENT_PATTERN</a>&#160;&#160;&#160;0x1800ul</td>
304
+        </tr>
305
+      </table>
306
+</div>
307
+<div class="memdoc">
308
+
309
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00065">65</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
310
+
311
+</div>
312
+</div>
313
+<a class="anchor" id="a36e554a87785ce6ba998b79aae9e74e0"></a><!-- doxytag: member="TMC26XStepper.cpp::HYSTERESIS_DECREMENT_SHIFT" ref="a36e554a87785ce6ba998b79aae9e74e0" args="" -->
314
+<div class="memitem">
315
+<div class="memproto">
316
+      <table class="memname">
317
+        <tr>
318
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a36e554a87785ce6ba998b79aae9e74e0">HYSTERESIS_DECREMENT_SHIFT</a>&#160;&#160;&#160;11</td>
319
+        </tr>
320
+      </table>
321
+</div>
322
+<div class="memdoc">
323
+
324
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00066">66</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
325
+
326
+</div>
327
+</div>
328
+<a class="anchor" id="a38ce0bb0fa20db28351ac9167f28db98"></a><!-- doxytag: member="TMC26XStepper.cpp::HYSTERESIS_LOW_SHIFT" ref="a38ce0bb0fa20db28351ac9167f28db98" args="" -->
329
+<div class="memitem">
330
+<div class="memproto">
331
+      <table class="memname">
332
+        <tr>
333
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a38ce0bb0fa20db28351ac9167f28db98">HYSTERESIS_LOW_SHIFT</a>&#160;&#160;&#160;7</td>
334
+        </tr>
335
+      </table>
336
+</div>
337
+<div class="memdoc">
338
+
339
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00068">68</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
340
+
341
+</div>
342
+</div>
343
+<a class="anchor" id="ad9d2302f6d61cd84a612a2e2bcdeb56e"></a><!-- doxytag: member="TMC26XStepper.cpp::HYSTERESIS_LOW_VALUE_PATTERN" ref="ad9d2302f6d61cd84a612a2e2bcdeb56e" args="" -->
344
+<div class="memitem">
345
+<div class="memproto">
346
+      <table class="memname">
347
+        <tr>
348
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ad9d2302f6d61cd84a612a2e2bcdeb56e">HYSTERESIS_LOW_VALUE_PATTERN</a>&#160;&#160;&#160;0x780ul</td>
349
+        </tr>
350
+      </table>
351
+</div>
352
+<div class="memdoc">
353
+
354
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00067">67</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="a0de4e98b412dced62c3a4452b7483af3"></a><!-- doxytag: member="TMC26XStepper.cpp::HYSTERESIS_START_VALUE_PATTERN" ref="a0de4e98b412dced62c3a4452b7483af3" args="" -->
359
+<div class="memitem">
360
+<div class="memproto">
361
+      <table class="memname">
362
+        <tr>
363
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a0de4e98b412dced62c3a4452b7483af3">HYSTERESIS_START_VALUE_PATTERN</a>&#160;&#160;&#160;0x78ul</td>
364
+        </tr>
365
+      </table>
366
+</div>
367
+<div class="memdoc">
368
+
369
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00069">69</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
370
+
371
+</div>
372
+</div>
373
+<a class="anchor" id="ac2c1c939256126e605396c4aaee3c804"></a><!-- doxytag: member="TMC26XStepper.cpp::HYSTERESIS_START_VALUE_SHIFT" ref="ac2c1c939256126e605396c4aaee3c804" args="" -->
374
+<div class="memitem">
375
+<div class="memproto">
376
+      <table class="memname">
377
+        <tr>
378
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac2c1c939256126e605396c4aaee3c804">HYSTERESIS_START_VALUE_SHIFT</a>&#160;&#160;&#160;4</td>
379
+        </tr>
380
+      </table>
381
+</div>
382
+<div class="memdoc">
383
+
384
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00070">70</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
385
+
386
+</div>
387
+</div>
388
+<a class="anchor" id="a54a6d12e96d851361974b10614a00e45"></a><!-- doxytag: member="TMC26XStepper.cpp::INITIAL_MICROSTEPPING" ref="a54a6d12e96d851361974b10614a00e45" args="" -->
389
+<div class="memitem">
390
+<div class="memproto">
391
+      <table class="memname">
392
+        <tr>
393
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a54a6d12e96d851361974b10614a00e45">INITIAL_MICROSTEPPING</a>&#160;&#160;&#160;0x3ul</td>
394
+        </tr>
395
+      </table>
396
+</div>
397
+<div class="memdoc">
398
+
399
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00099">99</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
400
+
401
+</div>
402
+</div>
403
+<a class="anchor" id="a8f5cb0c066109ffb18cefc0e85ee1d1b"></a><!-- doxytag: member="TMC26XStepper.cpp::MICROSTEPPING_PATTERN" ref="a8f5cb0c066109ffb18cefc0e85ee1d1b" args="" -->
404
+<div class="memitem">
405
+<div class="memproto">
406
+      <table class="memname">
407
+        <tr>
408
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8f5cb0c066109ffb18cefc0e85ee1d1b">MICROSTEPPING_PATTERN</a>&#160;&#160;&#160;0xFul</td>
409
+        </tr>
410
+      </table>
411
+</div>
412
+<div class="memdoc">
413
+
414
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00049">49</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
415
+
416
+</div>
417
+</div>
418
+<a class="anchor" id="a8a261a77d198b85f6dd8416387b354b3"></a><!-- doxytag: member="TMC26XStepper.cpp::MINIMUM_CURRENT_FOURTH" ref="a8a261a77d198b85f6dd8416387b354b3" args="" -->
419
+<div class="memitem">
420
+<div class="memproto">
421
+      <table class="memname">
422
+        <tr>
423
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8a261a77d198b85f6dd8416387b354b3">MINIMUM_CURRENT_FOURTH</a>&#160;&#160;&#160;0x8000ul</td>
424
+        </tr>
425
+      </table>
426
+</div>
427
+<div class="memdoc">
428
+
429
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00074">74</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
430
+
431
+</div>
432
+</div>
433
+<a class="anchor" id="a64520580cffd416668f3b91bd60f84e1"></a><!-- doxytag: member="TMC26XStepper.cpp::RANDOM_TOFF_TIME" ref="a64520580cffd416668f3b91bd60f84e1" args="" -->
434
+<div class="memitem">
435
+<div class="memproto">
436
+      <table class="memname">
437
+        <tr>
438
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a64520580cffd416668f3b91bd60f84e1">RANDOM_TOFF_TIME</a>&#160;&#160;&#160;0x2000ul</td>
439
+        </tr>
440
+      </table>
441
+</div>
442
+<div class="memdoc">
443
+
444
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00062">62</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
445
+
446
+</div>
447
+</div>
448
+<a class="anchor" id="a143b7757272f07866d9655bde8303d9a"></a><!-- doxytag: member="TMC26XStepper.cpp::READ_MICROSTEP_POSTION" ref="a143b7757272f07866d9655bde8303d9a" args="" -->
449
+<div class="memitem">
450
+<div class="memproto">
451
+      <table class="memname">
452
+        <tr>
453
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a143b7757272f07866d9655bde8303d9a">READ_MICROSTEP_POSTION</a>&#160;&#160;&#160;0x0ul</td>
454
+        </tr>
455
+      </table>
456
+</div>
457
+<div class="memdoc">
458
+
459
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00053">53</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
460
+
461
+</div>
462
+</div>
463
+<a class="anchor" id="a88a4b45fa6385eba8aa4f0342334b832"></a><!-- doxytag: member="TMC26XStepper.cpp::READ_SELECTION_PATTERN" ref="a88a4b45fa6385eba8aa4f0342334b832" args="" -->
464
+<div class="memitem">
465
+<div class="memproto">
466
+      <table class="memname">
467
+        <tr>
468
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a88a4b45fa6385eba8aa4f0342334b832">READ_SELECTION_PATTERN</a>&#160;&#160;&#160;0x30ul</td>
469
+        </tr>
470
+      </table>
471
+</div>
472
+<div class="memdoc">
473
+
474
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00056">56</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
475
+
476
+</div>
477
+</div>
478
+<a class="anchor" id="aef62b7fdcbac0b33b2d6e9cea4b5f9b2"></a><!-- doxytag: member="TMC26XStepper.cpp::READ_STALL_GUARD_AND_COOL_STEP" ref="aef62b7fdcbac0b33b2d6e9cea4b5f9b2" args="" -->
479
+<div class="memitem">
480
+<div class="memproto">
481
+      <table class="memname">
482
+        <tr>
483
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aef62b7fdcbac0b33b2d6e9cea4b5f9b2">READ_STALL_GUARD_AND_COOL_STEP</a>&#160;&#160;&#160;0x20ul</td>
484
+        </tr>
485
+      </table>
486
+</div>
487
+<div class="memdoc">
488
+
489
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00055">55</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
490
+
491
+</div>
492
+</div>
493
+<a class="anchor" id="ac1bd4da94fab7ce1049be2f866211819"></a><!-- doxytag: member="TMC26XStepper.cpp::READ_STALL_GUARD_READING" ref="ac1bd4da94fab7ce1049be2f866211819" args="" -->
494
+<div class="memitem">
495
+<div class="memproto">
496
+      <table class="memname">
497
+        <tr>
498
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac1bd4da94fab7ce1049be2f866211819">READ_STALL_GUARD_READING</a>&#160;&#160;&#160;0x10ul</td>
499
+        </tr>
500
+      </table>
501
+</div>
502
+<div class="memdoc">
503
+
504
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00054">54</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
505
+
506
+</div>
507
+</div>
508
+<a class="anchor" id="a5c3d76da63f585e37813c32be2e11ab7"></a><!-- doxytag: member="TMC26XStepper.cpp::READOUT_VALUE_PATTERN" ref="a5c3d76da63f585e37813c32be2e11ab7" args="" -->
509
+<div class="memitem">
510
+<div class="memproto">
511
+      <table class="memname">
512
+        <tr>
513
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a5c3d76da63f585e37813c32be2e11ab7">READOUT_VALUE_PATTERN</a>&#160;&#160;&#160;0xFFC00ul</td>
514
+        </tr>
515
+      </table>
516
+</div>
517
+<div class="memdoc">
518
+
519
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00096">96</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
520
+
521
+</div>
522
+</div>
523
+<a class="anchor" id="a3b02ee1f518b0c90c16488f937abd443"></a><!-- doxytag: member="TMC26XStepper.cpp::REGISTER_BIT_PATTERN" ref="a3b02ee1f518b0c90c16488f937abd443" args="" -->
524
+<div class="memitem">
525
+<div class="memproto">
526
+      <table class="memname">
527
+        <tr>
528
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a3b02ee1f518b0c90c16488f937abd443">REGISTER_BIT_PATTERN</a>&#160;&#160;&#160;0xFFFFFul</td>
529
+        </tr>
530
+      </table>
531
+</div>
532
+<div class="memdoc">
533
+
534
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00046">46</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
535
+
536
+</div>
537
+</div>
538
+<a class="anchor" id="aba6c07e5672e34e618bb3a550ab0d2bc"></a><!-- doxytag: member="TMC26XStepper.cpp::SE_CURRENT_STEP_WIDTH_PATTERN" ref="aba6c07e5672e34e618bb3a550ab0d2bc" args="" -->
539
+<div class="memitem">
540
+<div class="memproto">
541
+      <table class="memname">
542
+        <tr>
543
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aba6c07e5672e34e618bb3a550ab0d2bc">SE_CURRENT_STEP_WIDTH_PATTERN</a>&#160;&#160;&#160;0x60ul</td>
544
+        </tr>
545
+      </table>
546
+</div>
547
+<div class="memdoc">
548
+
549
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00077">77</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
550
+
551
+</div>
552
+</div>
553
+<a class="anchor" id="ac8f748bf735c447dbed7dd4c7b631a87"></a><!-- doxytag: member="TMC26XStepper.cpp::SE_MAX_PATTERN" ref="ac8f748bf735c447dbed7dd4c7b631a87" args="" -->
554
+<div class="memitem">
555
+<div class="memproto">
556
+      <table class="memname">
557
+        <tr>
558
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac8f748bf735c447dbed7dd4c7b631a87">SE_MAX_PATTERN</a>&#160;&#160;&#160;0xF00ul</td>
559
+        </tr>
560
+      </table>
561
+</div>
562
+<div class="memdoc">
563
+
564
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00076">76</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
565
+
566
+</div>
567
+</div>
568
+<a class="anchor" id="ae1862dfb958c03698b0abd95fda033ea"></a><!-- doxytag: member="TMC26XStepper.cpp::SE_MIN_PATTERN" ref="ae1862dfb958c03698b0abd95fda033ea" args="" -->
569
+<div class="memitem">
570
+<div class="memproto">
571
+      <table class="memname">
572
+        <tr>
573
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae1862dfb958c03698b0abd95fda033ea">SE_MIN_PATTERN</a>&#160;&#160;&#160;0xful</td>
574
+        </tr>
575
+      </table>
576
+</div>
577
+<div class="memdoc">
578
+
579
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00078">78</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
580
+
581
+</div>
582
+</div>
583
+<a class="anchor" id="a478d9bde09a6528eef6af6ffeeb6caba"></a><!-- doxytag: member="TMC26XStepper.cpp::STALL_GUARD2_LOAD_MEASURE_REGISTER" ref="a478d9bde09a6528eef6af6ffeeb6caba" args="" -->
584
+<div class="memitem">
585
+<div class="memproto">
586
+      <table class="memname">
587
+        <tr>
588
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a478d9bde09a6528eef6af6ffeeb6caba">STALL_GUARD2_LOAD_MEASURE_REGISTER</a>&#160;&#160;&#160;0xC0000ul</td>
589
+        </tr>
590
+      </table>
591
+</div>
592
+<div class="memdoc">
593
+
594
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00043">43</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
595
+
596
+</div>
597
+</div>
598
+<a class="anchor" id="a99ac04f0615556fc13c0c9f3e1c1b49d"></a><!-- doxytag: member="TMC26XStepper.cpp::STALL_GUARD_CONFIG_PATTERN" ref="a99ac04f0615556fc13c0c9f3e1c1b49d" args="" -->
599
+<div class="memitem">
600
+<div class="memproto">
601
+      <table class="memname">
602
+        <tr>
603
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99ac04f0615556fc13c0c9f3e1c1b49d">STALL_GUARD_CONFIG_PATTERN</a>&#160;&#160;&#160;0x17F00ul</td>
604
+        </tr>
605
+      </table>
606
+</div>
607
+<div class="memdoc">
608
+
609
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00084">84</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
610
+
611
+</div>
612
+</div>
613
+<a class="anchor" id="afdbbefabd0c29c4b6e403c4663d0f0be"></a><!-- doxytag: member="TMC26XStepper.cpp::STALL_GUARD_FILTER_ENABLED" ref="afdbbefabd0c29c4b6e403c4663d0f0be" args="" -->
614
+<div class="memitem">
615
+<div class="memproto">
616
+      <table class="memname">
617
+        <tr>
618
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#afdbbefabd0c29c4b6e403c4663d0f0be">STALL_GUARD_FILTER_ENABLED</a>&#160;&#160;&#160;0x10000ul</td>
619
+        </tr>
620
+      </table>
621
+</div>
622
+<div class="memdoc">
623
+
624
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00081">81</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
625
+
626
+</div>
627
+</div>
628
+<a class="anchor" id="ae631457932894a974334892704550ecc"></a><!-- doxytag: member="TMC26XStepper.cpp::STALL_GUARD_TRESHHOLD_VALUE_PATTERN" ref="ae631457932894a974334892704550ecc" args="" -->
629
+<div class="memitem">
630
+<div class="memproto">
631
+      <table class="memname">
632
+        <tr>
633
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae631457932894a974334892704550ecc">STALL_GUARD_TRESHHOLD_VALUE_PATTERN</a>&#160;&#160;&#160;0x17F00ul</td>
634
+        </tr>
635
+      </table>
636
+</div>
637
+<div class="memdoc">
638
+
639
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00082">82</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
640
+
641
+</div>
642
+</div>
643
+<a class="anchor" id="a6a1cb1fd61cf7c570f94376fa11fe55b"></a><!-- doxytag: member="TMC26XStepper.cpp::STALL_GUARD_VALUE_PATTERN" ref="a6a1cb1fd61cf7c570f94376fa11fe55b" args="" -->
644
+<div class="memitem">
645
+<div class="memproto">
646
+      <table class="memname">
647
+        <tr>
648
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6a1cb1fd61cf7c570f94376fa11fe55b">STALL_GUARD_VALUE_PATTERN</a>&#160;&#160;&#160;0x7F00ul</td>
649
+        </tr>
650
+      </table>
651
+</div>
652
+<div class="memdoc">
653
+
654
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00085">85</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
655
+
656
+</div>
657
+</div>
658
+<a class="anchor" id="ae9cbbe5af7188e6bff8fe412f8e42f59"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_OPEN_LOAD_A" ref="ae9cbbe5af7188e6bff8fe412f8e42f59" args="" -->
659
+<div class="memitem">
660
+<div class="memproto">
661
+      <table class="memname">
662
+        <tr>
663
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae9cbbe5af7188e6bff8fe412f8e42f59">STATUS_OPEN_LOAD_A</a>&#160;&#160;&#160;0x20ul</td>
664
+        </tr>
665
+      </table>
666
+</div>
667
+<div class="memdoc">
668
+
669
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00093">93</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
670
+
671
+</div>
672
+</div>
673
+<a class="anchor" id="ab29dc5cd6c6c4e5bf99e71bd563e1be1"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_OPEN_LOAD_B" ref="ab29dc5cd6c6c4e5bf99e71bd563e1be1" args="" -->
674
+<div class="memitem">
675
+<div class="memproto">
676
+      <table class="memname">
677
+        <tr>
678
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab29dc5cd6c6c4e5bf99e71bd563e1be1">STATUS_OPEN_LOAD_B</a>&#160;&#160;&#160;0x40ul</td>
679
+        </tr>
680
+      </table>
681
+</div>
682
+<div class="memdoc">
683
+
684
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00094">94</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
685
+
686
+</div>
687
+</div>
688
+<a class="anchor" id="adbb23d2f055c9eab55eac29d1a75deb4"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_OVER_TEMPERATURE_SHUTDOWN" ref="adbb23d2f055c9eab55eac29d1a75deb4" args="" -->
689
+<div class="memitem">
690
+<div class="memproto">
691
+      <table class="memname">
692
+        <tr>
693
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbb23d2f055c9eab55eac29d1a75deb4">STATUS_OVER_TEMPERATURE_SHUTDOWN</a>&#160;&#160;&#160;0x2ul</td>
694
+        </tr>
695
+      </table>
696
+</div>
697
+<div class="memdoc">
698
+
699
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00089">89</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
700
+
701
+</div>
702
+</div>
703
+<a class="anchor" id="aa317fd77f2f26fdfbfd331e21d9069e8"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_OVER_TEMPERATURE_WARNING" ref="aa317fd77f2f26fdfbfd331e21d9069e8" args="" -->
704
+<div class="memitem">
705
+<div class="memproto">
706
+      <table class="memname">
707
+        <tr>
708
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa317fd77f2f26fdfbfd331e21d9069e8">STATUS_OVER_TEMPERATURE_WARNING</a>&#160;&#160;&#160;0x4ul</td>
709
+        </tr>
710
+      </table>
711
+</div>
712
+<div class="memdoc">
713
+
714
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00090">90</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
715
+
716
+</div>
717
+</div>
718
+<a class="anchor" id="a8e03041302a092174fa33b3cf837dca2"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_SHORT_TO_GROUND_A" ref="a8e03041302a092174fa33b3cf837dca2" args="" -->
719
+<div class="memitem">
720
+<div class="memproto">
721
+      <table class="memname">
722
+        <tr>
723
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8e03041302a092174fa33b3cf837dca2">STATUS_SHORT_TO_GROUND_A</a>&#160;&#160;&#160;0x8ul</td>
724
+        </tr>
725
+      </table>
726
+</div>
727
+<div class="memdoc">
728
+
729
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00091">91</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="a903c3eba99695a32c6736463dcfd93ae"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_SHORT_TO_GROUND_B" ref="a903c3eba99695a32c6736463dcfd93ae" args="" -->
734
+<div class="memitem">
735
+<div class="memproto">
736
+      <table class="memname">
737
+        <tr>
738
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a903c3eba99695a32c6736463dcfd93ae">STATUS_SHORT_TO_GROUND_B</a>&#160;&#160;&#160;0x10ul</td>
739
+        </tr>
740
+      </table>
741
+</div>
742
+<div class="memdoc">
743
+
744
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00092">92</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
745
+
746
+</div>
747
+</div>
748
+<a class="anchor" id="aa09ef662fd19bf2d063d6bd0f48eca14"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_STALL_GUARD_STATUS" ref="aa09ef662fd19bf2d063d6bd0f48eca14" args="" -->
749
+<div class="memitem">
750
+<div class="memproto">
751
+      <table class="memname">
752
+        <tr>
753
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa09ef662fd19bf2d063d6bd0f48eca14">STATUS_STALL_GUARD_STATUS</a>&#160;&#160;&#160;0x1ul</td>
754
+        </tr>
755
+      </table>
756
+</div>
757
+<div class="memdoc">
758
+
759
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00088">88</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
760
+
761
+</div>
762
+</div>
763
+<a class="anchor" id="ab96ed1635faee6650e9cce73598a2773"></a><!-- doxytag: member="TMC26XStepper.cpp::STATUS_STAND_STILL" ref="ab96ed1635faee6650e9cce73598a2773" args="" -->
764
+<div class="memitem">
765
+<div class="memproto">
766
+      <table class="memname">
767
+        <tr>
768
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab96ed1635faee6650e9cce73598a2773">STATUS_STAND_STILL</a>&#160;&#160;&#160;0x80ul</td>
769
+        </tr>
770
+      </table>
771
+</div>
772
+<div class="memdoc">
773
+
774
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00095">95</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
775
+
776
+</div>
777
+</div>
778
+<a class="anchor" id="aa64245f223209654c60588e4558e0bab"></a><!-- doxytag: member="TMC26XStepper.cpp::STEP_INTERPOLATION" ref="aa64245f223209654c60588e4558e0bab" args="" -->
779
+<div class="memitem">
780
+<div class="memproto">
781
+      <table class="memname">
782
+        <tr>
783
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa64245f223209654c60588e4558e0bab">STEP_INTERPOLATION</a>&#160;&#160;&#160;0x200ul</td>
784
+        </tr>
785
+      </table>
786
+</div>
787
+<div class="memdoc">
788
+
789
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00050">50</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
790
+
791
+</div>
792
+</div>
793
+<a class="anchor" id="aa4e49237f2671e7f28aa34ae0e89da8d"></a><!-- doxytag: member="TMC26XStepper.cpp::T_OFF_PATTERN" ref="aa4e49237f2671e7f28aa34ae0e89da8d" args="" -->
794
+<div class="memitem">
795
+<div class="memproto">
796
+      <table class="memname">
797
+        <tr>
798
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa4e49237f2671e7f28aa34ae0e89da8d">T_OFF_PATTERN</a>&#160;&#160;&#160;0xful</td>
799
+        </tr>
800
+      </table>
801
+</div>
802
+<div class="memdoc">
803
+
804
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00061">61</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
805
+
806
+</div>
807
+</div>
808
+<a class="anchor" id="a7659d842c803e47ba911a2a6e26327f3"></a><!-- doxytag: member="TMC26XStepper.cpp::T_OFF_TIMING_PATERN" ref="a7659d842c803e47ba911a2a6e26327f3" args="" -->
809
+<div class="memitem">
810
+<div class="memproto">
811
+      <table class="memname">
812
+        <tr>
813
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a7659d842c803e47ba911a2a6e26327f3">T_OFF_TIMING_PATERN</a>&#160;&#160;&#160;0xFul</td>
814
+        </tr>
815
+      </table>
816
+</div>
817
+<div class="memdoc">
818
+
819
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00071">71</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
820
+
821
+</div>
822
+</div>
823
+<a class="anchor" id="a4fb1c008e2ff76eee9362600eed112e1"></a><!-- doxytag: member="TMC26XStepper.cpp::VSENSE" ref="a4fb1c008e2ff76eee9362600eed112e1" args="" -->
824
+<div class="memitem">
825
+<div class="memproto">
826
+      <table class="memname">
827
+        <tr>
828
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a4fb1c008e2ff76eee9362600eed112e1">VSENSE</a>&#160;&#160;&#160;0x40ul</td>
829
+        </tr>
830
+      </table>
831
+</div>
832
+<div class="memdoc">
833
+
834
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html#l00052">52</a> of file <a class="el" href="_t_m_c26_x_stepper_8cpp_source.html">TMC26XStepper.cpp</a>.</p>
835
+
836
+</div>
837
+</div>
838
+</div><!-- contents -->
839
+
840
+
841
+<hr class="footer"/><address class="footer"><small>
842
+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">
843
+<img class="footer" src="doxygen.png" alt="doxygen"/>
844
+</a> 1.7.6.1
845
+</small></address>
846
+
847
+</body>
848
+</html>

+ 1067
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8cpp_source.html
File diff suppressed because it is too large
View File


+ 212
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8h.html View File

@@ -0,0 +1,212 @@
1
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
+<html xmlns="http://www.w3.org/1999/xhtml">
3
+<head>
4
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
+<title>Trinamic TMC26X Stepper Driver for Arduino: TMC26XStepper.h File Reference</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+</div>
53
+<div class="header">
54
+  <div class="summary">
55
+<a href="#nested-classes">Classes</a> &#124;
56
+<a href="#define-members">Defines</a>  </div>
57
+  <div class="headertitle">
58
+<div class="title">TMC26XStepper.h File Reference</div>  </div>
59
+</div><!--header-->
60
+<div class="contents">
61
+
62
+<p><a href="_t_m_c26_x_stepper_8h_source.html">Go to the source code of this file.</a></p>
63
+<table class="memberdecls">
64
+<tr><td colspan="2"><h2><a name="nested-classes"></a>
65
+Classes</h2></td></tr>
66
+<tr><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td></tr>
67
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Class representing a TMC26X stepper driver.  <a href="class_t_m_c26_x_stepper.html#details">More...</a><br/></td></tr>
68
+<tr><td colspan="2"><h2><a name="define-members"></a>
69
+Defines</h2></td></tr>
70
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">TMC26X_OVERTEMPERATURE_PREWARING</a>&#160;&#160;&#160;1</td></tr>
71
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature situation in the TMC chip  <a href="#add42eee34f674f92c19bcd5266d2445f"></a><br/></td></tr>
72
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">TMC26X_OVERTEMPERATURE_SHUTDOWN</a>&#160;&#160;&#160;2</td></tr>
73
+<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature shutdown in the TMC chip  <a href="#adae814ce848677abd87758c7ac79a436"></a><br/></td></tr>
74
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26X_READOUT_POSITION</a>&#160;&#160;&#160;0</td></tr>
75
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">TMC26X_READOUT_STALLGUARD</a>&#160;&#160;&#160;1</td></tr>
76
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">TMC26X_READOUT_CURRENT</a>&#160;&#160;&#160;3</td></tr>
77
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">COOL_STEP_HALF_CS_LIMIT</a>&#160;&#160;&#160;0</td></tr>
78
+<tr><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">COOL_STEP_QUARTDER_CS_LIMIT</a>&#160;&#160;&#160;1</td></tr>
79
+</table>
80
+<hr/><h2>Define Documentation</h2>
81
+<a class="anchor" id="a28b1774bd4aa854fb5e4b6dc7db96ecb"></a><!-- doxytag: member="TMC26XStepper.h::COOL_STEP_HALF_CS_LIMIT" ref="a28b1774bd4aa854fb5e4b6dc7db96ecb" args="" -->
82
+<div class="memitem">
83
+<div class="memproto">
84
+      <table class="memname">
85
+        <tr>
86
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">COOL_STEP_HALF_CS_LIMIT</a>&#160;&#160;&#160;0</td>
87
+        </tr>
88
+      </table>
89
+</div>
90
+<div class="memdoc">
91
+<p>Define to set the minimum current for CoolStep operation to 1/2 of the selected CS minium. </p>
92
+<dl class="see"><dt><b>See also:</b></dt><dd>setCoolStepConfiguration() </dd></dl>
93
+
94
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00070">70</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
95
+
96
+</div>
97
+</div>
98
+<a class="anchor" id="a1a4db5eafd0a9247677153cb4c8b7d54"></a><!-- doxytag: member="TMC26XStepper.h::COOL_STEP_QUARTDER_CS_LIMIT" ref="a1a4db5eafd0a9247677153cb4c8b7d54" args="" -->
99
+<div class="memitem">
100
+<div class="memproto">
101
+      <table class="memname">
102
+        <tr>
103
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">COOL_STEP_QUARTDER_CS_LIMIT</a>&#160;&#160;&#160;1</td>
104
+        </tr>
105
+      </table>
106
+</div>
107
+<div class="memdoc">
108
+<p>Define to set the minimum current for CoolStep operation to 1/4 of the selected CS minium. </p>
109
+<dl class="see"><dt><b>See also:</b></dt><dd>setCoolStepConfiguration() </dd></dl>
110
+
111
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00075">75</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
112
+
113
+</div>
114
+</div>
115
+<a class="anchor" id="add42eee34f674f92c19bcd5266d2445f"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_OVERTEMPERATURE_PREWARING" ref="add42eee34f674f92c19bcd5266d2445f" args="" -->
116
+<div class="memitem">
117
+<div class="memproto">
118
+      <table class="memname">
119
+        <tr>
120
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">TMC26X_OVERTEMPERATURE_PREWARING</a>&#160;&#160;&#160;1</td>
121
+        </tr>
122
+      </table>
123
+</div>
124
+<div class="memdoc">
125
+
126
+<p>return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature situation in the TMC chip </p>
127
+<p>This warning indicates that the TCM chip is too warm. It is still working but some parameters may be inferior. You should do something against it. </p>
128
+
129
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00039">39</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
130
+
131
+</div>
132
+</div>
133
+<a class="anchor" id="adae814ce848677abd87758c7ac79a436"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_OVERTEMPERATURE_SHUTDOWN" ref="adae814ce848677abd87758c7ac79a436" args="" -->
134
+<div class="memitem">
135
+<div class="memproto">
136
+      <table class="memname">
137
+        <tr>
138
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">TMC26X_OVERTEMPERATURE_SHUTDOWN</a>&#160;&#160;&#160;2</td>
139
+        </tr>
140
+      </table>
141
+</div>
142
+<div class="memdoc">
143
+
144
+<p>return value for <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">TMC26XStepper.getOverTemperature()</a> if there is a overtemperature shutdown in the TMC chip </p>
145
+<p>This warning indicates that the TCM chip is too warm to operate and has shut down to prevent damage. It will stop working until it cools down again. If you encouter this situation you must do something against it. Like reducing the current or improving the PCB layout and/or heat management. </p>
146
+
147
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00047">47</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
148
+
149
+</div>
150
+</div>
151
+<a class="anchor" id="a01760ad15e3846536526a990efe47094"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_READOUT_CURRENT" ref="a01760ad15e3846536526a990efe47094" args="" -->
152
+<div class="memitem">
153
+<div class="memproto">
154
+      <table class="memname">
155
+        <tr>
156
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">TMC26X_READOUT_CURRENT</a>&#160;&#160;&#160;3</td>
157
+        </tr>
158
+      </table>
159
+</div>
160
+<div class="memdoc">
161
+<p>Selects to read out the current current setting (acc. to CoolStep) and the upper bits of the StallGuard value from the motor. </p>
162
+<dl class="see"><dt><b>See also:</b></dt><dd>readStatus(), setCurrent() </dd></dl>
163
+
164
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00064">64</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
165
+
166
+</div>
167
+</div>
168
+<a class="anchor" id="aff05d4a47ef8821322ccc2a20785fbee"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_READOUT_POSITION" ref="aff05d4a47ef8821322ccc2a20785fbee" args="" -->
169
+<div class="memitem">
170
+<div class="memproto">
171
+      <table class="memname">
172
+        <tr>
173
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26X_READOUT_POSITION</a>&#160;&#160;&#160;0</td>
174
+        </tr>
175
+      </table>
176
+</div>
177
+<div class="memdoc">
178
+<p>Selects to readout the microstep position from the motor. </p>
179
+<dl class="see"><dt><b>See also:</b></dt><dd>readStatus() </dd></dl>
180
+
181
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00054">54</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
182
+
183
+</div>
184
+</div>
185
+<a class="anchor" id="ac864ff8886123039c7d2d3c617f7ef87"></a><!-- doxytag: member="TMC26XStepper.h::TMC26X_READOUT_STALLGUARD" ref="ac864ff8886123039c7d2d3c617f7ef87" args="" -->
186
+<div class="memitem">
187
+<div class="memproto">
188
+      <table class="memname">
189
+        <tr>
190
+          <td class="memname">#define <a class="el" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">TMC26X_READOUT_STALLGUARD</a>&#160;&#160;&#160;1</td>
191
+        </tr>
192
+      </table>
193
+</div>
194
+<div class="memdoc">
195
+<p>Selects to read out the StallGuard value of the motor. </p>
196
+<dl class="see"><dt><b>See also:</b></dt><dd>readStatus() </dd></dl>
197
+
198
+<p>Definition at line <a class="el" href="_t_m_c26_x_stepper_8h_source.html#l00059">59</a> of file <a class="el" href="_t_m_c26_x_stepper_8h_source.html">TMC26XStepper.h</a>.</p>
199
+
200
+</div>
201
+</div>
202
+</div><!-- contents -->
203
+
204
+
205
+<hr class="footer"/><address class="footer"><small>
206
+Generated on Mon Nov 19 2012 20:26:21 for Trinamic TMC26X Stepper Driver for Arduino by &#160;<a href="http://www.doxygen.org/index.html">
207
+<img class="footer" src="doxygen.png" alt="doxygen"/>
208
+</a> 1.7.6.1
209
+</small></address>
210
+
211
+</body>
212
+</html>

+ 256
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/_t_m_c26_x_stepper_8h_source.html View File

@@ -0,0 +1,256 @@
1
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2
+<html xmlns="http://www.w3.org/1999/xhtml">
3
+<head>
4
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6
+<title>Trinamic TMC26X Stepper Driver for Arduino: TMC26XStepper.h Source File</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+</div>
53
+<div class="header">
54
+  <div class="headertitle">
55
+<div class="title">TMC26XStepper.h</div>  </div>
56
+</div><!--header-->
57
+<div class="contents">
58
+<a href="_t_m_c26_x_stepper_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
59
+<a name="l00002"></a>00002 <span class="comment"> TMC26XStepper.cpp - - TMC26X Stepper library for Wiring/Arduino - Version 0.1</span>
60
+<a name="l00003"></a>00003 <span class="comment"> </span>
61
+<a name="l00004"></a>00004 <span class="comment"> based on the stepper library by Tom Igoe, et. al.</span>
62
+<a name="l00005"></a>00005 <span class="comment"></span>
63
+<a name="l00006"></a>00006 <span class="comment"> Copyright (c) 2011, Interactive Matter, Marcus Nowotny</span>
64
+<a name="l00007"></a>00007 <span class="comment"> </span>
65
+<a name="l00008"></a>00008 <span class="comment"> Permission is hereby granted, free of charge, to any person obtaining a copy</span>
66
+<a name="l00009"></a>00009 <span class="comment"> of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
67
+<a name="l00010"></a>00010 <span class="comment"> in the Software without restriction, including without limitation the rights</span>
68
+<a name="l00011"></a>00011 <span class="comment"> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
69
+<a name="l00012"></a>00012 <span class="comment"> copies of the Software, and to permit persons to whom the Software is</span>
70
+<a name="l00013"></a>00013 <span class="comment"> furnished to do so, subject to the following conditions:</span>
71
+<a name="l00014"></a>00014 <span class="comment"> </span>
72
+<a name="l00015"></a>00015 <span class="comment"> The above copyright notice and this permission notice shall be included in</span>
73
+<a name="l00016"></a>00016 <span class="comment"> all copies or substantial portions of the Software.</span>
74
+<a name="l00017"></a>00017 <span class="comment"> </span>
75
+<a name="l00018"></a>00018 <span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
76
+<a name="l00019"></a>00019 <span class="comment"> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
77
+<a name="l00020"></a>00020 <span class="comment"> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
78
+<a name="l00021"></a>00021 <span class="comment"> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
79
+<a name="l00022"></a>00022 <span class="comment"> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
80
+<a name="l00023"></a>00023 <span class="comment"> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
81
+<a name="l00024"></a>00024 <span class="comment"> THE SOFTWARE.</span>
82
+<a name="l00025"></a>00025 <span class="comment"></span>
83
+<a name="l00026"></a>00026 <span class="comment"> */</span>
84
+<a name="l00027"></a>00027 
85
+<a name="l00028"></a>00028 
86
+<a name="l00029"></a>00029 <span class="comment">// ensure this library description is only included once</span>
87
+<a name="l00030"></a>00030 <span class="preprocessor">#ifndef TMC26XStepper_h</span>
88
+<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define TMC26XStepper_h</span>
89
+<a name="l00032"></a>00032 <span class="preprocessor"></span>
90
+<a name="l00034"></a>00034 
91
+<a name="l00039"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">00039</a> <span class="preprocessor">#define TMC26X_OVERTEMPERATURE_PREWARING 1</span>
92
+<a name="l00040"></a>00040 <span class="preprocessor"></span>
93
+<a name="l00041"></a>00041 
94
+<a name="l00047"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">00047</a> <span class="preprocessor">#define TMC26X_OVERTEMPERATURE_SHUTDOWN 2</span>
95
+<a name="l00048"></a>00048 <span class="preprocessor"></span>
96
+<a name="l00049"></a>00049 <span class="comment">//which values can be read out</span>
97
+<a name="l00054"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">00054</a> <span class="comment"></span><span class="preprocessor">#define TMC26X_READOUT_POSITION 0</span>
98
+<a name="l00055"></a>00055 <span class="preprocessor"></span>
99
+<a name="l00059"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">00059</a> <span class="preprocessor">#define TMC26X_READOUT_STALLGUARD 1</span>
100
+<a name="l00060"></a>00060 <span class="preprocessor"></span>
101
+<a name="l00064"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">00064</a> <span class="preprocessor">#define TMC26X_READOUT_CURRENT 3</span>
102
+<a name="l00065"></a>00065 <span class="preprocessor"></span>
103
+<a name="l00070"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">00070</a> <span class="preprocessor">#define COOL_STEP_HALF_CS_LIMIT 0</span>
104
+<a name="l00071"></a>00071 <span class="preprocessor"></span>
105
+<a name="l00075"></a><a class="code" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">00075</a> <span class="preprocessor">#define COOL_STEP_QUARTDER_CS_LIMIT 1</span>
106
+<a name="l00076"></a>00076 <span class="preprocessor"></span>
107
+<a name="l00101"></a><a class="code" href="class_t_m_c26_x_stepper.html">00101</a> <span class="keyword">class </span><a class="code" href="class_t_m_c26_x_stepper.html" title="Class representing a TMC26X stepper driver.">TMC26XStepper</a> {
108
+<a name="l00102"></a>00102   <span class="keyword">public</span>:
109
+<a name="l00124"></a>00124         <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>(<span class="keywordtype">int</span> number_of_steps, <span class="keywordtype">int</span> cs_pin, <span class="keywordtype">int</span> dir_pin, <span class="keywordtype">int</span> step_pin, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> current, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> resistor=150);
110
+<a name="l00125"></a>00125         
111
+<a name="l00133"></a>00133         <span class="keywordtype">void</span> <a class="code" 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>();
112
+<a name="l00134"></a>00134     
113
+<a name="l00145"></a>00145         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#af968e70a13068f1e71ac0fa6865630c5" title="resets the stepper in unconfigured mode.">un_start</a>();
114
+<a name="l00146"></a>00146 
115
+<a name="l00147"></a>00147 
116
+<a name="l00152"></a>00152     <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd" title="Sets the rotation speed in revolutions per minute.">setSpeed</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> whatSpeed);
117
+<a name="l00153"></a>00153     
118
+<a name="l00158"></a>00158     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#aa564f5cc0218d30ef897c2830c768c29" title="reads out the currently selected speed in revolutions per minute.">getSpeed</a>(<span class="keywordtype">void</span>);
119
+<a name="l00159"></a>00159 
120
+<a name="l00168"></a>00168         <span class="keywordtype">void</span> <a class="code" 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>(<span class="keywordtype">int</span> number_of_steps);
121
+<a name="l00169"></a>00169     
122
+<a name="l00178"></a>00178         <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3" title="returns the effective current number of microsteps selected.">getMicrosteps</a>(<span class="keywordtype">void</span>);
123
+<a name="l00179"></a>00179 
124
+<a name="l00195"></a>00195     <span class="keywordtype">char</span> <a class="code" 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>(<span class="keywordtype">int</span> number_of_steps);
125
+<a name="l00196"></a>00196     
126
+<a name="l00215"></a>00215     <span class="keywordtype">char</span> <a class="code" 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>(<span class="keywordtype">void</span>);
127
+<a name="l00216"></a>00216 
128
+<a name="l00224"></a>00224     <span class="keywordtype">char</span> <a class="code" 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>(<span class="keywordtype">void</span>);
129
+<a name="l00225"></a>00225     
130
+<a name="l00230"></a>00230     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7" title="Get the number of steps left in the current movement.">getStepsLeft</a>(<span class="keywordtype">void</span>);
131
+<a name="l00231"></a>00231     
132
+<a name="l00238"></a>00238     <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123" title="Stops the motor regardless if it moves or not.">stop</a>(<span class="keywordtype">void</span>);
133
+<a name="l00239"></a>00239     
134
+<a name="l00264"></a>00264         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#ac2d8a2bbae2aba3ed7c98e3ff1a06649" title="Sets and configure the classical Constant Off Timer Chopper.">setConstantOffTimeChopper</a>(<span class="keywordtype">char</span> constant_off_time, <span class="keywordtype">char</span> blank_time, <span class="keywordtype">char</span> fast_decay_time_setting, <span class="keywordtype">char</span> sine_wave_offset, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> use_current_comparator);
135
+<a name="l00265"></a>00265     
136
+<a name="l00286"></a>00286         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#aa152bb7ddb72a2bc8465553a39232df2" title="Sets and configures with spread cycle chopper.">setSpreadCycleChopper</a>(<span class="keywordtype">char</span> constant_off_time, <span class="keywordtype">char</span> blank_time, <span class="keywordtype">char</span> hysteresis_start, <span class="keywordtype">char</span> hysteresis_end, <span class="keywordtype">char</span> hysteresis_decrement);
137
+<a name="l00287"></a>00287 
138
+<a name="l00303"></a>00303         <span class="keywordtype">void</span> <a class="code" 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>(<span class="keywordtype">char</span> value);
139
+<a name="l00304"></a>00304     
140
+<a name="l00312"></a>00312         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#aaa35fac83417c16b3a941fa168e4a4d2" title="set the maximum motor current in mA (1000 is 1 Amp) Keep in mind this is the maximum peak Current...">setCurrent</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> current);
141
+<a name="l00313"></a>00313     
142
+<a name="l00320"></a>00320     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" 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>(<span class="keywordtype">void</span>);
143
+<a name="l00321"></a>00321     
144
+<a name="l00337"></a>00337         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a" title="set the StallGuard threshold in order to get sensible StallGuard readings.">setStallGuardThreshold</a>(<span class="keywordtype">char</span> stall_guard_threshold, <span class="keywordtype">char</span> stall_guard_filter_enabled);
145
+<a name="l00338"></a>00338     
146
+<a name="l00343"></a>00343     <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#a056661f444725c3ae15696d1e8d91def" title="reads out the StallGuard threshold">getStallGuardThreshold</a>(<span class="keywordtype">void</span>);
147
+<a name="l00344"></a>00344     
148
+<a name="l00349"></a>00349     <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#a47e3443e3e786314c1099b8f14a91b8a" title="returns the current setting of the StallGuard filter">getStallGuardFilter</a>(<span class="keywordtype">void</span>);
149
+<a name="l00350"></a>00350     
150
+<a name="l00368"></a>00368     <span class="keywordtype">void</span> <a class="code" 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>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lower_SG_threshold, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> SG_hysteresis, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> current_decrement_step_size,
151
+<a name="l00369"></a>00369                                   <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> current_increment_step_size, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> lower_current_limit);
152
+<a name="l00370"></a>00370     
153
+<a name="l00376"></a>00376     <span class="keywordtype">void</span> <a class="code" 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>(<span class="keywordtype">boolean</span> enabled);
154
+<a name="l00377"></a>00377     
155
+<a name="l00378"></a>00378     
156
+<a name="l00383"></a>00383     <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#a6de2306b6d8dc1fa2e50fccb66d8e66d" title="check if the CoolStep feature is enabled">isCoolStepEnabled</a>();
157
+<a name="l00384"></a>00384 
158
+<a name="l00389"></a>00389     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#aa7469949deaa39a58038b3ddef532bc8" title="returns the lower StallGuard threshold for the CoolStep operation">getCoolStepLowerSgThreshold</a>();
159
+<a name="l00390"></a>00390     
160
+<a name="l00395"></a>00395     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#ac61298fd658773c28823d33ab04e970f" title="returns the upper StallGuard threshold for the CoolStep operation">getCoolStepUpperSgThreshold</a>();
161
+<a name="l00396"></a>00396     
162
+<a name="l00401"></a>00401     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#aad44ee5ae73bf8e69af05674a304ba46" title="returns the number of StallGuard readings befor CoolStep adjusts the motor current.">getCoolStepNumberOfSGReadings</a>();
163
+<a name="l00402"></a>00402     
164
+<a name="l00407"></a>00407     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#ababe688a15f087d23d4ff2094fcee883" title="returns the increment steps for the current for the CoolStep operation">getCoolStepCurrentIncrementSize</a>();
165
+<a name="l00408"></a>00408     
166
+<a name="l00414"></a>00414     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#a0c7e8541abc120a3910e35c6fbf2167c" title="returns the absolut minium current for the CoolStep operation">getCoolStepLowerCurrentLimit</a>();
167
+<a name="l00415"></a>00415     
168
+<a name="l00422"></a>00422         <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125" title="Get the current microstep position for phase A.">getMotorPosition</a>(<span class="keywordtype">void</span>);
169
+<a name="l00423"></a>00423     
170
+<a name="l00430"></a>00430         <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e" title="Reads the current StallGuard value.">getCurrentStallGuardReading</a>(<span class="keywordtype">void</span>);
171
+<a name="l00431"></a>00431     
172
+<a name="l00437"></a>00437     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" 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>(<span class="keywordtype">void</span>);
173
+<a name="l00438"></a>00438     
174
+<a name="l00439"></a>00439     
175
+<a name="l00444"></a>00444     <span class="keywordtype">boolean</span> <a class="code" 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>();
176
+<a name="l00445"></a>00445 
177
+<a name="l00453"></a>00453     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" 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>(<span class="keywordtype">void</span>);
178
+<a name="l00454"></a>00454     
179
+<a name="l00463"></a>00463         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41" title="checks if there is a StallGuard warning in the last status">isStallGuardOverThreshold</a>(<span class="keywordtype">void</span>);
180
+<a name="l00464"></a>00464     
181
+<a name="l00471"></a>00471         <span class="keywordtype">char</span> <a class="code" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7" title="Return over temperature status of the last status readout return 0 is everything is OK...">getOverTemperature</a>(<span class="keywordtype">void</span>);
182
+<a name="l00472"></a>00472     
183
+<a name="l00480"></a>00480         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#ad329fa4693d3139dea241ebe3d0f33cf" title="Is motor channel A shorted to ground detected in the last status readout.">isShortToGroundA</a>(<span class="keywordtype">void</span>);
184
+<a name="l00481"></a>00481 
185
+<a name="l00488"></a>00488         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#a0ccb54d40cce0d802aa56ff6261f9f3b" title="Is motor channel B shorted to ground detected in the last status readout.">isShortToGroundB</a>(<span class="keywordtype">void</span>);
186
+<a name="l00495"></a>00495         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#af97b2ab9d1ba36765ac6f17cf25ec45c" title="iIs motor channel A connected according to the last statu readout.">isOpenLoadA</a>(<span class="keywordtype">void</span>);
187
+<a name="l00496"></a>00496 
188
+<a name="l00503"></a>00503         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#a303590124f5ac6d6a06d0ec60d0b5303" title="iIs motor channel A connected according to the last statu readout.">isOpenLoadB</a>(<span class="keywordtype">void</span>);
189
+<a name="l00504"></a>00504     
190
+<a name="l00511"></a>00511         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#ab26602f360a4fb6ec6d262011675b2b0" title="Is chopper inactive since 2^20 clock cycles - defaults to ~0,08s.">isStandStill</a>(<span class="keywordtype">void</span>);
191
+<a name="l00512"></a>00512 
192
+<a name="l00524"></a>00524         <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#afdeded501ec2cabeffde33d31b6573f7" title="checks if there is a StallGuard warning in the last status">isStallGuardReached</a>(<span class="keywordtype">void</span>);
193
+<a name="l00525"></a>00525     
194
+<a name="l00530"></a>00530     <span class="keywordtype">void</span> <a class="code" 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>(<span class="keywordtype">boolean</span> enabled);
195
+<a name="l00531"></a>00531     
196
+<a name="l00537"></a>00537     <span class="keywordtype">boolean</span> <a class="code" href="class_t_m_c26_x_stepper.html#a15796c0cbdeab23a343c3f25327283b6" title="checks if the output bridges are enabled. If the bridges are not enabled the motor can run freely...">isEnabled</a>();
197
+<a name="l00538"></a>00538 
198
+<a name="l00548"></a>00548         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#af95a824bfdf49ef979b5354798e52967" title="Manually read out the status register This function sends a byte to the motor driver in order to get ...">readStatus</a>(<span class="keywordtype">char</span> read_value);
199
+<a name="l00549"></a>00549     
200
+<a name="l00554"></a>00554     <span class="keywordtype">int</span> <a class="code" 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>();
201
+<a name="l00555"></a>00555 
202
+<a name="l00560"></a>00560         <span class="keywordtype">void</span> <a class="code" href="class_t_m_c26_x_stepper.html#ad5e5b1bf5a46d02577dd548083877ec3" title="Prints out all the information that can be found in the last status read out - it does not force a st...">debugLastStatus</a>(<span class="keywordtype">void</span>);
203
+<a name="l00565"></a>00565     <span class="keywordtype">int</span> <a class="code" href="class_t_m_c26_x_stepper.html#ab040d9df1e85d6fb0c105205a36b0215" title="library version">version</a>(<span class="keywordtype">void</span>);
204
+<a name="l00566"></a>00566 
205
+<a name="l00567"></a>00567   <span class="keyword">private</span>:    
206
+<a name="l00568"></a>00568         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> steps_left;                <span class="comment">//the steps the motor has to do to complete the movement</span>
207
+<a name="l00569"></a>00569     <span class="keywordtype">int</span> direction;        <span class="comment">// Direction of rotation</span>
208
+<a name="l00570"></a>00570     <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> step_delay;    <span class="comment">// delay between steps, in ms, based on speed</span>
209
+<a name="l00571"></a>00571     <span class="keywordtype">int</span> number_of_steps;      <span class="comment">// total number of steps this motor can take</span>
210
+<a name="l00572"></a>00572     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> speed; <span class="comment">// we need to store the current speed in order to change the speed after changing microstepping</span>
211
+<a name="l00573"></a>00573     <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> resistor; <span class="comment">//current sense resitor value in milliohm</span>
212
+<a name="l00574"></a>00574         
213
+<a name="l00575"></a>00575     <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> last_step_time;      <span class="comment">// time stamp in ms of when the last step was taken</span>
214
+<a name="l00576"></a>00576     <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> next_step_time;      <span class="comment">// time stamp in ms of when the last step was taken</span>
215
+<a name="l00577"></a>00577         
216
+<a name="l00578"></a>00578         <span class="comment">//driver control register copies to easily set &amp; modify the registers</span>
217
+<a name="l00579"></a>00579         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> driver_control_register_value;
218
+<a name="l00580"></a>00580         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> chopper_config_register;
219
+<a name="l00581"></a>00581         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> cool_step_register_value;
220
+<a name="l00582"></a>00582         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> stall_guard2_current_register_value;
221
+<a name="l00583"></a>00583         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> driver_configuration_register_value;
222
+<a name="l00584"></a>00584         <span class="comment">//the driver status result</span>
223
+<a name="l00585"></a>00585         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> driver_status_result;
224
+<a name="l00586"></a>00586         
225
+<a name="l00587"></a>00587         <span class="comment">//helper routione to get the top 10 bit of the readout</span>
226
+<a name="l00588"></a>00588         <span class="keyword">inline</span> <span class="keywordtype">int</span> getReadoutValue();
227
+<a name="l00589"></a>00589         
228
+<a name="l00590"></a>00590         <span class="comment">//the pins for the stepper driver</span>
229
+<a name="l00591"></a>00591         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> cs_pin;
230
+<a name="l00592"></a>00592         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> step_pin;
231
+<a name="l00593"></a>00593         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> dir_pin;
232
+<a name="l00594"></a>00594         
233
+<a name="l00595"></a>00595         <span class="comment">//status values </span>
234
+<a name="l00596"></a>00596         <span class="keywordtype">boolean</span> started; <span class="comment">//if the stepper has been started yet</span>
235
+<a name="l00597"></a>00597         <span class="keywordtype">int</span> microsteps; <span class="comment">//the current number of micro steps</span>
236
+<a name="l00598"></a>00598     <span class="keywordtype">char</span> constant_off_time; <span class="comment">//we need to remember this value in order to enable and disable the motor</span>
237
+<a name="l00599"></a>00599     <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> cool_step_lower_threshold; <span class="comment">// we need to remember the threshold to enable and disable the CoolStep feature</span>
238
+<a name="l00600"></a>00600     <span class="keywordtype">boolean</span> cool_step_enabled; <span class="comment">//we need to remember this to configure the coolstep if it si enabled</span>
239
+<a name="l00601"></a>00601         
240
+<a name="l00602"></a>00602         <span class="comment">//SPI sender</span>
241
+<a name="l00603"></a>00603         <span class="keyword">inline</span> <span class="keywordtype">void</span> send262(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> datagram);
242
+<a name="l00604"></a>00604 };
243
+<a name="l00605"></a>00605 
244
+<a name="l00606"></a>00606 <span class="preprocessor">#endif</span>
245
+<a name="l00607"></a>00607 <span class="preprocessor"></span>
246
+</pre></div></div><!-- contents -->
247
+
248
+
249
+<hr class="footer"/><address class="footer"><small>
250
+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">
251
+<img class="footer" src="doxygen.png" alt="doxygen"/>
252
+</a> 1.7.6.1
253
+</small></address>
254
+
255
+</body>
256
+</html>

+ 72
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/annotated.html View File

@@ -0,0 +1,72 @@
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: Class List</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 class="current"><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="headertitle">
56
+<div class="title">Class List</div>  </div>
57
+</div><!--header-->
58
+<div class="contents">
59
+<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><table>
60
+  <tr><td class="indexkey"><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td class="indexvalue">Class representing a TMC26X stepper driver </td></tr>
61
+</table>
62
+</div><!-- contents -->
63
+
64
+
65
+<hr class="footer"/><address class="footer"><small>
66
+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">
67
+<img class="footer" src="doxygen.png" alt="doxygen"/>
68
+</a> 1.7.6.1
69
+</small></address>
70
+
71
+</body>
72
+</html>

BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/bc_s.png View File


+ 117
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/class_t_m_c26_x_stepper-members.html View File

@@ -0,0 +1,117 @@
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: Member List</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="headertitle">
56
+<div class="title">TMC26XStepper Member List</div>  </div>
57
+</div><!--header-->
58
+<div class="contents">
59
+This is the complete list of members for <a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a>, including all inherited members.<table>
60
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ad5e5b1bf5a46d02577dd548083877ec3">debugLastStatus</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
61
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ababe688a15f087d23d4ff2094fcee883">getCoolStepCurrentIncrementSize</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
62
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a0c7e8541abc120a3910e35c6fbf2167c">getCoolStepLowerCurrentLimit</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
63
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aa7469949deaa39a58038b3ddef532bc8">getCoolStepLowerSgThreshold</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
64
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aad44ee5ae73bf8e69af05674a304ba46">getCoolStepNumberOfSGReadings</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
65
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ac61298fd658773c28823d33ab04e970f">getCoolStepUpperSgThreshold</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
66
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f">getCurrent</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
67
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a1a939fb495d747c2c11be99a740371e1">getCurrentCSReading</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
68
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7">getCurrentCurrent</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
69
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e">getCurrentStallGuardReading</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
70
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3">getMicrosteps</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
71
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125">getMotorPosition</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
72
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7">getOverTemperature</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
73
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ae1db5ec2ec9bfbfaea83c659e006692e">getResistor</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
74
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aa564f5cc0218d30ef897c2830c768c29">getSpeed</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
75
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a47e3443e3e786314c1099b8f14a91b8a">getStallGuardFilter</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
76
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a056661f444725c3ae15696d1e8d91def">getStallGuardThreshold</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
77
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7">getStepsLeft</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
78
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a6de2306b6d8dc1fa2e50fccb66d8e66d">isCoolStepEnabled</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
79
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ad435db189ebb101fb2de90a484f33905">isCurrentScalingHalfed</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
80
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a15796c0cbdeab23a343c3f25327283b6">isEnabled</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
81
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e">isMoving</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
82
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#af97b2ab9d1ba36765ac6f17cf25ec45c">isOpenLoadA</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
83
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a303590124f5ac6d6a06d0ec60d0b5303">isOpenLoadB</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
84
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ad329fa4693d3139dea241ebe3d0f33cf">isShortToGroundA</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
85
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a0ccb54d40cce0d802aa56ff6261f9f3b">isShortToGroundB</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
86
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41">isStallGuardOverThreshold</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
87
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#afdeded501ec2cabeffde33d31b6573f7">isStallGuardReached</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
88
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ab26602f360a4fb6ec6d262011675b2b0">isStandStill</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
89
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415">move</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
90
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#af95a824bfdf49ef979b5354798e52967">readStatus</a>(char read_value)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
91
+  <tr class="memlist"><td><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><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
92
+  <tr class="memlist"><td><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><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
93
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a15bf0ed5a166a5d9a41f90f3ccbc6157">setCoolStepEnabled</a>(boolean enabled)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
94
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aaa35fac83417c16b3a941fa168e4a4d2">setCurrent</a>(unsigned int current)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
95
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a4472cd86ad5b65dec5ec45ce69158305">setEnabled</a>(boolean enabled)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
96
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0">setMicrosteps</a>(int number_of_steps)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
97
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a">setRandomOffTime</a>(char value)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
98
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd">setSpeed</a>(unsigned int whatSpeed)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
99
+  <tr class="memlist"><td><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><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
100
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a">setStallGuardThreshold</a>(char stall_guard_threshold, char stall_guard_filter_enabled)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
101
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7">start</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
102
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d">step</a>(int number_of_steps)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
103
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123">stop</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
104
+  <tr class="memlist"><td><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><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
105
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#af968e70a13068f1e71ac0fa6865630c5">un_start</a>()</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
106
+  <tr class="memlist"><td><a class="el" href="class_t_m_c26_x_stepper.html#ab040d9df1e85d6fb0c105205a36b0215">version</a>(void)</td><td><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a></td><td></td></tr>
107
+</table></div><!-- contents -->
108
+
109
+
110
+<hr class="footer"/><address class="footer"><small>
111
+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">
112
+<img class="footer" src="doxygen.png" alt="doxygen"/>
113
+</a> 1.7.6.1
114
+</small></address>
115
+
116
+</body>
117
+</html>

+ 1463
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/class_t_m_c26_x_stepper.html
File diff suppressed because it is too large
View File


+ 78
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/classes.html View File

@@ -0,0 +1,78 @@
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: Class Index</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 class="current"><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="headertitle">
56
+<div class="title">Class Index</div>  </div>
57
+</div><!--header-->
58
+<div class="contents">
59
+<div class="qindex"><a class="qindex" href="#letter_T">T</a></div>
60
+<table style="margin: 10px; white-space: nowrap;" align="center" width="95%" border="0" cellspacing="0" cellpadding="0">
61
+<tr><td rowspan="2" valign="bottom"><a name="letter_T"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;T&#160;&#160;</div></td></tr></table>
62
+</td><td></td></tr>
63
+<tr><td></td></tr>
64
+<tr><td valign="top"><a class="el" href="class_t_m_c26_x_stepper.html">TMC26XStepper</a>&#160;&#160;&#160;</td><td></td></tr>
65
+<tr><td></td><td></td></tr>
66
+</table>
67
+<div class="qindex"><a class="qindex" href="#letter_T">T</a></div>
68
+</div><!-- contents -->
69
+
70
+
71
+<hr class="footer"/><address class="footer"><small>
72
+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">
73
+<img class="footer" src="doxygen.png" alt="doxygen"/>
74
+</a> 1.7.6.1
75
+</small></address>
76
+
77
+</body>
78
+</html>

BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/closed.png View File


+ 949
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/doxygen.css View File

@@ -0,0 +1,949 @@
1
+/* The standard CSS for doxygen */
2
+
3
+body, table, div, p, dl {
4
+	font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
5
+	font-size: 13px;
6
+	line-height: 1.3;
7
+}
8
+
9
+/* @group Heading Levels */
10
+
11
+h1 {
12
+	font-size: 150%;
13
+}
14
+
15
+.title {
16
+	font-size: 150%;
17
+	font-weight: bold;
18
+	margin: 10px 2px;
19
+}
20
+
21
+h2 {
22
+	font-size: 120%;
23
+}
24
+
25
+h3 {
26
+	font-size: 100%;
27
+}
28
+
29
+dt {
30
+	font-weight: bold;
31
+}
32
+
33
+div.multicol {
34
+	-moz-column-gap: 1em;
35
+	-webkit-column-gap: 1em;
36
+	-moz-column-count: 3;
37
+	-webkit-column-count: 3;
38
+}
39
+
40
+p.startli, p.startdd, p.starttd {
41
+	margin-top: 2px;
42
+}
43
+
44
+p.endli {
45
+	margin-bottom: 0px;
46
+}
47
+
48
+p.enddd {
49
+	margin-bottom: 4px;
50
+}
51
+
52
+p.endtd {
53
+	margin-bottom: 2px;
54
+}
55
+
56
+/* @end */
57
+
58
+caption {
59
+	font-weight: bold;
60
+}
61
+
62
+span.legend {
63
+        font-size: 70%;
64
+        text-align: center;
65
+}
66
+
67
+h3.version {
68
+        font-size: 90%;
69
+        text-align: center;
70
+}
71
+
72
+div.qindex, div.navtab{
73
+	background-color: #EBEFF6;
74
+	border: 1px solid #A3B4D7;
75
+	text-align: center;
76
+}
77
+
78
+div.qindex, div.navpath {
79
+	width: 100%;
80
+	line-height: 140%;
81
+}
82
+
83
+div.navtab {
84
+	margin-right: 15px;
85
+}
86
+
87
+/* @group Link Styling */
88
+
89
+a {
90
+	color: #3D578C;
91
+	font-weight: normal;
92
+	text-decoration: none;
93
+}
94
+
95
+.contents a:visited {
96
+	color: #4665A2;
97
+}
98
+
99
+a:hover {
100
+	text-decoration: underline;
101
+}
102
+
103
+a.qindex {
104
+	font-weight: bold;
105
+}
106
+
107
+a.qindexHL {
108
+	font-weight: bold;
109
+	background-color: #9CAFD4;
110
+	color: #ffffff;
111
+	border: 1px double #869DCA;
112
+}
113
+
114
+.contents a.qindexHL:visited {
115
+        color: #ffffff;
116
+}
117
+
118
+a.el {
119
+	font-weight: bold;
120
+}
121
+
122
+a.elRef {
123
+}
124
+
125
+a.code, a.code:visited {
126
+	color: #4665A2; 
127
+}
128
+
129
+a.codeRef, a.codeRef:visited {
130
+	color: #4665A2; 
131
+}
132
+
133
+/* @end */
134
+
135
+dl.el {
136
+	margin-left: -1cm;
137
+}
138
+
139
+.fragment {
140
+	font-family: monospace, fixed;
141
+	font-size: 105%;
142
+}
143
+
144
+pre.fragment {
145
+	border: 1px solid #C4CFE5;
146
+	background-color: #FBFCFD;
147
+	padding: 4px 6px;
148
+	margin: 4px 8px 4px 2px;
149
+	overflow: auto;
150
+	word-wrap: break-word;
151
+	font-size:  9pt;
152
+	line-height: 125%;
153
+}
154
+
155
+div.ah {
156
+	background-color: black;
157
+	font-weight: bold;
158
+	color: #ffffff;
159
+	margin-bottom: 3px;
160
+	margin-top: 3px;
161
+	padding: 0.2em;
162
+	border: solid thin #333;
163
+	border-radius: 0.5em;
164
+	-webkit-border-radius: .5em;
165
+	-moz-border-radius: .5em;
166
+	box-shadow: 2px 2px 3px #999;
167
+	-webkit-box-shadow: 2px 2px 3px #999;
168
+	-moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
169
+	background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
170
+	background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
171
+}
172
+
173
+div.groupHeader {
174
+	margin-left: 16px;
175
+	margin-top: 12px;
176
+	font-weight: bold;
177
+}
178
+
179
+div.groupText {
180
+	margin-left: 16px;
181
+	font-style: italic;
182
+}
183
+
184
+body {
185
+	background-color: white;
186
+	color: black;
187
+        margin: 0;
188
+}
189
+
190
+div.contents {
191
+	margin-top: 10px;
192
+	margin-left: 8px;
193
+	margin-right: 8px;
194
+}
195
+
196
+td.indexkey {
197
+	background-color: #EBEFF6;
198
+	font-weight: bold;
199
+	border: 1px solid #C4CFE5;
200
+	margin: 2px 0px 2px 0;
201
+	padding: 2px 10px;
202
+        white-space: nowrap;
203
+        vertical-align: top;
204
+}
205
+
206
+td.indexvalue {
207
+	background-color: #EBEFF6;
208
+	border: 1px solid #C4CFE5;
209
+	padding: 2px 10px;
210
+	margin: 2px 0px;
211
+}
212
+
213
+tr.memlist {
214
+	background-color: #EEF1F7;
215
+}
216
+
217
+p.formulaDsp {
218
+	text-align: center;
219
+}
220
+
221
+img.formulaDsp {
222
+	
223
+}
224
+
225
+img.formulaInl {
226
+	vertical-align: middle;
227
+}
228
+
229
+div.center {
230
+	text-align: center;
231
+        margin-top: 0px;
232
+        margin-bottom: 0px;
233
+        padding: 0px;
234
+}
235
+
236
+div.center img {
237
+	border: 0px;
238
+}
239
+
240
+address.footer {
241
+	text-align: right;
242
+	padding-right: 12px;
243
+}
244
+
245
+img.footer {
246
+	border: 0px;
247
+	vertical-align: middle;
248
+}
249
+
250
+/* @group Code Colorization */
251
+
252
+span.keyword {
253
+	color: #008000
254
+}
255
+
256
+span.keywordtype {
257
+	color: #604020
258
+}
259
+
260
+span.keywordflow {
261
+	color: #e08000
262
+}
263
+
264
+span.comment {
265
+	color: #800000
266
+}
267
+
268
+span.preprocessor {
269
+	color: #806020
270
+}
271
+
272
+span.stringliteral {
273
+	color: #002080
274
+}
275
+
276
+span.charliteral {
277
+	color: #008080
278
+}
279
+
280
+span.vhdldigit { 
281
+	color: #ff00ff 
282
+}
283
+
284
+span.vhdlchar { 
285
+	color: #000000 
286
+}
287
+
288
+span.vhdlkeyword { 
289
+	color: #700070 
290
+}
291
+
292
+span.vhdllogic { 
293
+	color: #ff0000 
294
+}
295
+
296
+/* @end */
297
+
298
+/*
299
+.search {
300
+	color: #003399;
301
+	font-weight: bold;
302
+}
303
+
304
+form.search {
305
+	margin-bottom: 0px;
306
+	margin-top: 0px;
307
+}
308
+
309
+input.search {
310
+	font-size: 75%;
311
+	color: #000080;
312
+	font-weight: normal;
313
+	background-color: #e8eef2;
314
+}
315
+*/
316
+
317
+td.tiny {
318
+	font-size: 75%;
319
+}
320
+
321
+.dirtab {
322
+	padding: 4px;
323
+	border-collapse: collapse;
324
+	border: 1px solid #A3B4D7;
325
+}
326
+
327
+th.dirtab {
328
+	background: #EBEFF6;
329
+	font-weight: bold;
330
+}
331
+
332
+hr {
333
+	height: 0px;
334
+	border: none;
335
+	border-top: 1px solid #4A6AAA;
336
+}
337
+
338
+hr.footer {
339
+	height: 1px;
340
+}
341
+
342
+/* @group Member Descriptions */
343
+
344
+table.memberdecls {
345
+	border-spacing: 0px;
346
+	padding: 0px;
347
+}
348
+
349
+.mdescLeft, .mdescRight,
350
+.memItemLeft, .memItemRight,
351
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
352
+	background-color: #F9FAFC;
353
+	border: none;
354
+	margin: 4px;
355
+	padding: 1px 0 0 8px;
356
+}
357
+
358
+.mdescLeft, .mdescRight {
359
+	padding: 0px 8px 4px 8px;
360
+	color: #555;
361
+}
362
+
363
+.memItemLeft, .memItemRight, .memTemplParams {
364
+	border-top: 1px solid #C4CFE5;
365
+}
366
+
367
+.memItemLeft, .memTemplItemLeft {
368
+        white-space: nowrap;
369
+}
370
+
371
+.memItemRight {
372
+	width: 100%;
373
+}
374
+
375
+.memTemplParams {
376
+	color: #4665A2;
377
+        white-space: nowrap;
378
+}
379
+
380
+/* @end */
381
+
382
+/* @group Member Details */
383
+
384
+/* Styles for detailed member documentation */
385
+
386
+.memtemplate {
387
+	font-size: 80%;
388
+	color: #4665A2;
389
+	font-weight: normal;
390
+	margin-left: 9px;
391
+}
392
+
393
+.memnav {
394
+	background-color: #EBEFF6;
395
+	border: 1px solid #A3B4D7;
396
+	text-align: center;
397
+	margin: 2px;
398
+	margin-right: 15px;
399
+	padding: 2px;
400
+}
401
+
402
+.mempage {
403
+	width: 100%;
404
+}
405
+
406
+.memitem {
407
+	padding: 0;
408
+	margin-bottom: 10px;
409
+	margin-right: 5px;
410
+}
411
+
412
+.memname {
413
+        white-space: nowrap;
414
+        font-weight: bold;
415
+        margin-left: 6px;
416
+}
417
+
418
+.memproto, dl.reflist dt {
419
+        border-top: 1px solid #A8B8D9;
420
+        border-left: 1px solid #A8B8D9;
421
+        border-right: 1px solid #A8B8D9;
422
+        padding: 6px 0px 6px 0px;
423
+        color: #253555;
424
+        font-weight: bold;
425
+        text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
426
+        /* opera specific markup */
427
+        box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
428
+        border-top-right-radius: 8px;
429
+        border-top-left-radius: 8px;
430
+        /* firefox specific markup */
431
+        -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
432
+        -moz-border-radius-topright: 8px;
433
+        -moz-border-radius-topleft: 8px;
434
+        /* webkit specific markup */
435
+        -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
436
+        -webkit-border-top-right-radius: 8px;
437
+        -webkit-border-top-left-radius: 8px;
438
+        background-image:url('nav_f.png');
439
+        background-repeat:repeat-x;
440
+        background-color: #E2E8F2;
441
+
442
+}
443
+
444
+.memdoc, dl.reflist dd {
445
+        border-bottom: 1px solid #A8B8D9;      
446
+        border-left: 1px solid #A8B8D9;      
447
+        border-right: 1px solid #A8B8D9; 
448
+        padding: 2px 5px;
449
+        background-color: #FBFCFD;
450
+        border-top-width: 0;
451
+        /* opera specific markup */
452
+        border-bottom-left-radius: 8px;
453
+        border-bottom-right-radius: 8px;
454
+        box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
455
+        /* firefox specific markup */
456
+        -moz-border-radius-bottomleft: 8px;
457
+        -moz-border-radius-bottomright: 8px;
458
+        -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
459
+        background-image: -moz-linear-gradient(center top, #FFFFFF 0%, #FFFFFF 60%, #F7F8FB 95%, #EEF1F7);
460
+        /* webkit specific markup */
461
+        -webkit-border-bottom-left-radius: 8px;
462
+        -webkit-border-bottom-right-radius: 8px;
463
+        -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
464
+        background-image: -webkit-gradient(linear,center top,center bottom,from(#FFFFFF), color-stop(0.6,#FFFFFF), color-stop(0.60,#FFFFFF), color-stop(0.95,#F7F8FB), to(#EEF1F7));
465
+}
466
+
467
+dl.reflist dt {
468
+        padding: 5px;
469
+}
470
+
471
+dl.reflist dd {
472
+        margin: 0px 0px 10px 0px;
473
+        padding: 5px;
474
+}
475
+
476
+.paramkey {
477
+	text-align: right;
478
+}
479
+
480
+.paramtype {
481
+	white-space: nowrap;
482
+}
483
+
484
+.paramname {
485
+	color: #602020;
486
+	white-space: nowrap;
487
+}
488
+.paramname em {
489
+	font-style: normal;
490
+}
491
+
492
+.params, .retval, .exception, .tparams {
493
+        border-spacing: 6px 2px;
494
+}       
495
+
496
+.params .paramname, .retval .paramname {
497
+        font-weight: bold;
498
+        vertical-align: top;
499
+}
500
+        
501
+.params .paramtype {
502
+        font-style: italic;
503
+        vertical-align: top;
504
+}       
505
+        
506
+.params .paramdir {
507
+        font-family: "courier new",courier,monospace;
508
+        vertical-align: top;
509
+}
510
+
511
+
512
+
513
+
514
+/* @end */
515
+
516
+/* @group Directory (tree) */
517
+
518
+/* for the tree view */
519
+
520
+.ftvtree {
521
+	font-family: sans-serif;
522
+	margin: 0px;
523
+}
524
+
525
+/* these are for tree view when used as main index */
526
+
527
+.directory {
528
+	font-size: 9pt;
529
+	font-weight: bold;
530
+	margin: 5px;
531
+}
532
+
533
+.directory h3 {
534
+	margin: 0px;
535
+	margin-top: 1em;
536
+	font-size: 11pt;
537
+}
538
+
539
+/*
540
+The following two styles can be used to replace the root node title
541
+with an image of your choice.  Simply uncomment the next two styles,
542
+specify the name of your image and be sure to set 'height' to the
543
+proper pixel height of your image.
544
+*/
545
+
546
+/*
547
+.directory h3.swap {
548
+	height: 61px;
549
+	background-repeat: no-repeat;
550
+	background-image: url("yourimage.gif");
551
+}
552
+.directory h3.swap span {
553
+	display: none;
554
+}
555
+*/
556
+
557
+.directory > h3 {
558
+	margin-top: 0;
559
+}
560
+
561
+.directory p {
562
+	margin: 0px;
563
+	white-space: nowrap;
564
+}
565
+
566
+.directory div {
567
+	display: none;
568
+	margin: 0px;
569
+}
570
+
571
+.directory img {
572
+	vertical-align: -30%;
573
+}
574
+
575
+/* these are for tree view when not used as main index */
576
+
577
+.directory-alt {
578
+	font-size: 100%;
579
+	font-weight: bold;
580
+}
581
+
582
+.directory-alt h3 {
583
+	margin: 0px;
584
+	margin-top: 1em;
585
+	font-size: 11pt;
586
+}
587
+
588
+.directory-alt > h3 {
589
+	margin-top: 0;
590
+}
591
+
592
+.directory-alt p {
593
+	margin: 0px;
594
+	white-space: nowrap;
595
+}
596
+
597
+.directory-alt div {
598
+	display: none;
599
+	margin: 0px;
600
+}
601
+
602
+.directory-alt img {
603
+	vertical-align: -30%;
604
+}
605
+
606
+/* @end */
607
+
608
+div.dynheader {
609
+        margin-top: 8px;
610
+}
611
+
612
+address {
613
+	font-style: normal;
614
+	color: #2A3D61;
615
+}
616
+
617
+table.doxtable {
618
+	border-collapse:collapse;
619
+}
620
+
621
+table.doxtable td, table.doxtable th {
622
+	border: 1px solid #2D4068;
623
+	padding: 3px 7px 2px;
624
+}
625
+
626
+table.doxtable th {
627
+	background-color: #374F7F;
628
+	color: #FFFFFF;
629
+	font-size: 110%;
630
+	padding-bottom: 4px;
631
+	padding-top: 5px;
632
+	text-align:left;
633
+}
634
+
635
+table.fieldtable {
636
+        width: 100%;
637
+        margin-bottom: 10px;
638
+        border: 1px solid #A8B8D9;
639
+        border-spacing: 0px;
640
+        -moz-border-radius: 4px;
641
+        -webkit-border-radius: 4px;
642
+        border-radius: 4px;
643
+        -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
644
+        -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
645
+        box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
646
+}
647
+
648
+.fieldtable td, .fieldtable th {
649
+        padding: 3px 7px 2px;
650
+}
651
+
652
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
653
+        white-space: nowrap;
654
+        border-right: 1px solid #A8B8D9;
655
+        border-bottom: 1px solid #A8B8D9;
656
+        vertical-align: top;
657
+}
658
+
659
+.fieldtable td.fielddoc {
660
+        border-bottom: 1px solid #A8B8D9;
661
+        width: 100%;
662
+}
663
+
664
+.fieldtable tr:last-child td {
665
+        border-bottom: none;
666
+}
667
+
668
+.fieldtable th {
669
+        background-image:url('nav_f.png');
670
+        background-repeat:repeat-x;
671
+        background-color: #E2E8F2;
672
+        font-size: 90%;
673
+        color: #253555;
674
+        padding-bottom: 4px;
675
+        padding-top: 5px;
676
+        text-align:left;
677
+        -moz-border-radius-topleft: 4px;
678
+        -moz-border-radius-topright: 4px;
679
+        -webkit-border-top-left-radius: 4px;
680
+        -webkit-border-top-right-radius: 4px;
681
+        border-top-left-radius: 4px;
682
+        border-top-right-radius: 4px;
683
+        border-bottom: 1px solid #A8B8D9;
684
+}
685
+
686
+
687
+.tabsearch {
688
+	top: 0px;
689
+	left: 10px;
690
+	height: 36px;
691
+	background-image: url('tab_b.png');
692
+	z-index: 101;
693
+	overflow: hidden;
694
+	font-size: 13px;
695
+}
696
+
697
+.navpath ul
698
+{
699
+	font-size: 11px;
700
+	background-image:url('tab_b.png');
701
+	background-repeat:repeat-x;
702
+	height:30px;
703
+	line-height:30px;
704
+	color:#8AA0CC;
705
+	border:solid 1px #C2CDE4;
706
+	overflow:hidden;
707
+	margin:0px;
708
+	padding:0px;
709
+}
710
+
711
+.navpath li
712
+{
713
+	list-style-type:none;
714
+	float:left;
715
+	padding-left:10px;
716
+	padding-right:15px;
717
+	background-image:url('bc_s.png');
718
+	background-repeat:no-repeat;
719
+	background-position:right;
720
+	color:#364D7C;
721
+}
722
+
723
+.navpath li.navelem a
724
+{
725
+	height:32px;
726
+	display:block;
727
+	text-decoration: none;
728
+	outline: none;
729
+}
730
+
731
+.navpath li.navelem a:hover
732
+{
733
+	color:#6884BD;
734
+}
735
+
736
+.navpath li.footer
737
+{
738
+        list-style-type:none;
739
+        float:right;
740
+        padding-left:10px;
741
+        padding-right:15px;
742
+        background-image:none;
743
+        background-repeat:no-repeat;
744
+        background-position:right;
745
+        color:#364D7C;
746
+        font-size: 8pt;
747
+}
748
+
749
+
750
+div.summary
751
+{
752
+	float: right;
753
+	font-size: 8pt;
754
+	padding-right: 5px;
755
+	width: 50%;
756
+	text-align: right;
757
+}       
758
+
759
+div.summary a
760
+{
761
+	white-space: nowrap;
762
+}
763
+
764
+div.ingroups
765
+{
766
+	margin-left: 5px;
767
+	font-size: 8pt;
768
+	padding-left: 5px;
769
+	width: 50%;
770
+	text-align: left;
771
+}
772
+
773
+div.ingroups a
774
+{
775
+	white-space: nowrap;
776
+}
777
+
778
+div.header
779
+{
780
+        background-image:url('nav_h.png');
781
+        background-repeat:repeat-x;
782
+	background-color: #F9FAFC;
783
+	margin:  0px;
784
+	border-bottom: 1px solid #C4CFE5;
785
+}
786
+
787
+div.headertitle
788
+{
789
+	padding: 5px 5px 5px 7px;
790
+}
791
+
792
+dl
793
+{
794
+        padding: 0 0 0 10px;
795
+}
796
+
797
+dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug
798
+{
799
+        border-left:4px solid;
800
+        padding: 0 0 0 6px;
801
+}
802
+
803
+dl.note
804
+{
805
+        border-color: #D0C000;
806
+}
807
+
808
+dl.warning, dl.attention
809
+{
810
+        border-color: #FF0000;
811
+}
812
+
813
+dl.pre, dl.post, dl.invariant
814
+{
815
+        border-color: #00D000;
816
+}
817
+
818
+dl.deprecated
819
+{
820
+        border-color: #505050;
821
+}
822
+
823
+dl.todo
824
+{
825
+        border-color: #00C0E0;
826
+}
827
+
828
+dl.test
829
+{
830
+        border-color: #3030E0;
831
+}
832
+
833
+dl.bug
834
+{
835
+        border-color: #C08050;
836
+}
837
+
838
+#projectlogo
839
+{
840
+	text-align: center;
841
+	vertical-align: bottom;
842
+	border-collapse: separate;
843
+}
844
+ 
845
+#projectlogo img
846
+{ 
847
+	border: 0px none;
848
+}
849
+ 
850
+#projectname
851
+{
852
+	font: 300% Tahoma, Arial,sans-serif;
853
+	margin: 0px;
854
+	padding: 2px 0px;
855
+}
856
+    
857
+#projectbrief
858
+{
859
+	font: 120% Tahoma, Arial,sans-serif;
860
+	margin: 0px;
861
+	padding: 0px;
862
+}
863
+
864
+#projectnumber
865
+{
866
+	font: 50% Tahoma, Arial,sans-serif;
867
+	margin: 0px;
868
+	padding: 0px;
869
+}
870
+
871
+#titlearea
872
+{
873
+	padding: 0px;
874
+	margin: 0px;
875
+	width: 100%;
876
+	border-bottom: 1px solid #5373B4;
877
+}
878
+
879
+.image
880
+{
881
+        text-align: center;
882
+}
883
+
884
+.dotgraph
885
+{
886
+        text-align: center;
887
+}
888
+
889
+.mscgraph
890
+{
891
+        text-align: center;
892
+}
893
+
894
+.caption
895
+{
896
+	font-weight: bold;
897
+}
898
+
899
+div.zoom
900
+{
901
+	border: 1px solid #90A5CE;
902
+}
903
+
904
+dl.citelist {
905
+        margin-bottom:50px;
906
+}
907
+
908
+dl.citelist dt {
909
+        color:#334975;
910
+        float:left;
911
+        font-weight:bold;
912
+        margin-right:10px;
913
+        padding:5px;
914
+}
915
+
916
+dl.citelist dd {
917
+        margin:2px 0;
918
+        padding:5px 0;
919
+}
920
+
921
+@media print
922
+{
923
+  #top { display: none; }
924
+  #side-nav { display: none; }
925
+  #nav-path { display: none; }
926
+  body { overflow:visible; }
927
+  h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
928
+  .summary { display: none; }
929
+  .memitem { page-break-inside: avoid; }
930
+  #doc-content
931
+  {
932
+    margin-left:0 !important;
933
+    height:auto !important;
934
+    width:auto !important;
935
+    overflow:inherit;
936
+    display:inline;
937
+  }
938
+  pre.fragment
939
+  {
940
+    overflow: visible;
941
+    text-wrap: unrestricted;
942
+    white-space: -moz-pre-wrap; /* Moz */
943
+    white-space: -pre-wrap; /* Opera 4-6 */
944
+    white-space: -o-pre-wrap; /* Opera 7 */
945
+    white-space: pre-wrap; /* CSS3  */
946
+    word-wrap: break-word; /* IE 5.5+ */
947
+  }
948
+}
949
+

BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/doxygen.png View File


+ 72
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/files.html View File

@@ -0,0 +1,72 @@
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: File List</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li class="current"><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+</div>
53
+<div class="header">
54
+  <div class="headertitle">
55
+<div class="title">File List</div>  </div>
56
+</div><!--header-->
57
+<div class="contents">
58
+<div class="textblock">Here is a list of all files with brief descriptions:</div><table>
59
+  <tr><td class="indexkey"><a class="el" href="_t_m_c26_x_stepper_8cpp.html">TMC26XStepper.cpp</a> <a href="_t_m_c26_x_stepper_8cpp_source.html">[code]</a></td><td class="indexvalue"></td></tr>
60
+  <tr><td class="indexkey"><a class="el" href="_t_m_c26_x_stepper_8h.html">TMC26XStepper.h</a> <a href="_t_m_c26_x_stepper_8h_source.html">[code]</a></td><td class="indexvalue"></td></tr>
61
+</table>
62
+</div><!-- contents -->
63
+
64
+
65
+<hr class="footer"/><address class="footer"><small>
66
+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">
67
+<img class="footer" src="doxygen.png" alt="doxygen"/>
68
+</a> 1.7.6.1
69
+</small></address>
70
+
71
+</body>
72
+</html>

+ 261
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/functions.html View File

@@ -0,0 +1,261 @@
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: Class Members</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 class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
51
+    </ul>
52
+  </div>
53
+  <div id="navrow3" class="tabs2">
54
+    <ul class="tablist">
55
+      <li class="current"><a href="functions.html"><span>All</span></a></li>
56
+      <li><a href="functions_func.html"><span>Functions</span></a></li>
57
+    </ul>
58
+  </div>
59
+  <div id="navrow4" class="tabs3">
60
+    <ul class="tablist">
61
+      <li><a href="#index_d"><span>d</span></a></li>
62
+      <li><a href="#index_g"><span>g</span></a></li>
63
+      <li><a href="#index_i"><span>i</span></a></li>
64
+      <li><a href="#index_m"><span>m</span></a></li>
65
+      <li><a href="#index_r"><span>r</span></a></li>
66
+      <li><a href="#index_s"><span>s</span></a></li>
67
+      <li><a href="#index_t"><span>t</span></a></li>
68
+      <li><a href="#index_u"><span>u</span></a></li>
69
+      <li><a href="#index_v"><span>v</span></a></li>
70
+    </ul>
71
+  </div>
72
+</div>
73
+<div class="contents">
74
+<div class="textblock">Here is a list of all class members with links to the classes they belong to:</div>
75
+
76
+<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
77
+<li>debugLastStatus()
78
+: <a class="el" href="class_t_m_c26_x_stepper.html#ad5e5b1bf5a46d02577dd548083877ec3">TMC26XStepper</a>
79
+</li>
80
+</ul>
81
+
82
+
83
+<h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
84
+<li>getCoolStepCurrentIncrementSize()
85
+: <a class="el" href="class_t_m_c26_x_stepper.html#ababe688a15f087d23d4ff2094fcee883">TMC26XStepper</a>
86
+</li>
87
+<li>getCoolStepLowerCurrentLimit()
88
+: <a class="el" href="class_t_m_c26_x_stepper.html#a0c7e8541abc120a3910e35c6fbf2167c">TMC26XStepper</a>
89
+</li>
90
+<li>getCoolStepLowerSgThreshold()
91
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa7469949deaa39a58038b3ddef532bc8">TMC26XStepper</a>
92
+</li>
93
+<li>getCoolStepNumberOfSGReadings()
94
+: <a class="el" href="class_t_m_c26_x_stepper.html#aad44ee5ae73bf8e69af05674a304ba46">TMC26XStepper</a>
95
+</li>
96
+<li>getCoolStepUpperSgThreshold()
97
+: <a class="el" href="class_t_m_c26_x_stepper.html#ac61298fd658773c28823d33ab04e970f">TMC26XStepper</a>
98
+</li>
99
+<li>getCurrent()
100
+: <a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f">TMC26XStepper</a>
101
+</li>
102
+<li>getCurrentCSReading()
103
+: <a class="el" href="class_t_m_c26_x_stepper.html#a1a939fb495d747c2c11be99a740371e1">TMC26XStepper</a>
104
+</li>
105
+<li>getCurrentCurrent()
106
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7">TMC26XStepper</a>
107
+</li>
108
+<li>getCurrentStallGuardReading()
109
+: <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e">TMC26XStepper</a>
110
+</li>
111
+<li>getMicrosteps()
112
+: <a class="el" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3">TMC26XStepper</a>
113
+</li>
114
+<li>getMotorPosition()
115
+: <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125">TMC26XStepper</a>
116
+</li>
117
+<li>getOverTemperature()
118
+: <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7">TMC26XStepper</a>
119
+</li>
120
+<li>getResistor()
121
+: <a class="el" href="class_t_m_c26_x_stepper.html#ae1db5ec2ec9bfbfaea83c659e006692e">TMC26XStepper</a>
122
+</li>
123
+<li>getSpeed()
124
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa564f5cc0218d30ef897c2830c768c29">TMC26XStepper</a>
125
+</li>
126
+<li>getStallGuardFilter()
127
+: <a class="el" href="class_t_m_c26_x_stepper.html#a47e3443e3e786314c1099b8f14a91b8a">TMC26XStepper</a>
128
+</li>
129
+<li>getStallGuardThreshold()
130
+: <a class="el" href="class_t_m_c26_x_stepper.html#a056661f444725c3ae15696d1e8d91def">TMC26XStepper</a>
131
+</li>
132
+<li>getStepsLeft()
133
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7">TMC26XStepper</a>
134
+</li>
135
+</ul>
136
+
137
+
138
+<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
139
+<li>isCoolStepEnabled()
140
+: <a class="el" href="class_t_m_c26_x_stepper.html#a6de2306b6d8dc1fa2e50fccb66d8e66d">TMC26XStepper</a>
141
+</li>
142
+<li>isCurrentScalingHalfed()
143
+: <a class="el" href="class_t_m_c26_x_stepper.html#ad435db189ebb101fb2de90a484f33905">TMC26XStepper</a>
144
+</li>
145
+<li>isEnabled()
146
+: <a class="el" href="class_t_m_c26_x_stepper.html#a15796c0cbdeab23a343c3f25327283b6">TMC26XStepper</a>
147
+</li>
148
+<li>isMoving()
149
+: <a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e">TMC26XStepper</a>
150
+</li>
151
+<li>isOpenLoadA()
152
+: <a class="el" href="class_t_m_c26_x_stepper.html#af97b2ab9d1ba36765ac6f17cf25ec45c">TMC26XStepper</a>
153
+</li>
154
+<li>isOpenLoadB()
155
+: <a class="el" href="class_t_m_c26_x_stepper.html#a303590124f5ac6d6a06d0ec60d0b5303">TMC26XStepper</a>
156
+</li>
157
+<li>isShortToGroundA()
158
+: <a class="el" href="class_t_m_c26_x_stepper.html#ad329fa4693d3139dea241ebe3d0f33cf">TMC26XStepper</a>
159
+</li>
160
+<li>isShortToGroundB()
161
+: <a class="el" href="class_t_m_c26_x_stepper.html#a0ccb54d40cce0d802aa56ff6261f9f3b">TMC26XStepper</a>
162
+</li>
163
+<li>isStallGuardOverThreshold()
164
+: <a class="el" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41">TMC26XStepper</a>
165
+</li>
166
+<li>isStallGuardReached()
167
+: <a class="el" href="class_t_m_c26_x_stepper.html#afdeded501ec2cabeffde33d31b6573f7">TMC26XStepper</a>
168
+</li>
169
+<li>isStandStill()
170
+: <a class="el" href="class_t_m_c26_x_stepper.html#ab26602f360a4fb6ec6d262011675b2b0">TMC26XStepper</a>
171
+</li>
172
+</ul>
173
+
174
+
175
+<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
176
+<li>move()
177
+: <a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415">TMC26XStepper</a>
178
+</li>
179
+</ul>
180
+
181
+
182
+<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
183
+<li>readStatus()
184
+: <a class="el" href="class_t_m_c26_x_stepper.html#af95a824bfdf49ef979b5354798e52967">TMC26XStepper</a>
185
+</li>
186
+</ul>
187
+
188
+
189
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
190
+<li>setConstantOffTimeChopper()
191
+: <a class="el" href="class_t_m_c26_x_stepper.html#ac2d8a2bbae2aba3ed7c98e3ff1a06649">TMC26XStepper</a>
192
+</li>
193
+<li>setCoolStepConfiguration()
194
+: <a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e">TMC26XStepper</a>
195
+</li>
196
+<li>setCoolStepEnabled()
197
+: <a class="el" href="class_t_m_c26_x_stepper.html#a15bf0ed5a166a5d9a41f90f3ccbc6157">TMC26XStepper</a>
198
+</li>
199
+<li>setCurrent()
200
+: <a class="el" href="class_t_m_c26_x_stepper.html#aaa35fac83417c16b3a941fa168e4a4d2">TMC26XStepper</a>
201
+</li>
202
+<li>setEnabled()
203
+: <a class="el" href="class_t_m_c26_x_stepper.html#a4472cd86ad5b65dec5ec45ce69158305">TMC26XStepper</a>
204
+</li>
205
+<li>setMicrosteps()
206
+: <a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0">TMC26XStepper</a>
207
+</li>
208
+<li>setRandomOffTime()
209
+: <a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a">TMC26XStepper</a>
210
+</li>
211
+<li>setSpeed()
212
+: <a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd">TMC26XStepper</a>
213
+</li>
214
+<li>setSpreadCycleChopper()
215
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa152bb7ddb72a2bc8465553a39232df2">TMC26XStepper</a>
216
+</li>
217
+<li>setStallGuardThreshold()
218
+: <a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a">TMC26XStepper</a>
219
+</li>
220
+<li>start()
221
+: <a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7">TMC26XStepper</a>
222
+</li>
223
+<li>step()
224
+: <a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d">TMC26XStepper</a>
225
+</li>
226
+<li>stop()
227
+: <a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123">TMC26XStepper</a>
228
+</li>
229
+</ul>
230
+
231
+
232
+<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
233
+<li>TMC26XStepper()
234
+: <a class="el" href="class_t_m_c26_x_stepper.html#a3ef40763b8b8ab2b6ed4978c0647906c">TMC26XStepper</a>
235
+</li>
236
+</ul>
237
+
238
+
239
+<h3><a class="anchor" id="index_u"></a>- u -</h3><ul>
240
+<li>un_start()
241
+: <a class="el" href="class_t_m_c26_x_stepper.html#af968e70a13068f1e71ac0fa6865630c5">TMC26XStepper</a>
242
+</li>
243
+</ul>
244
+
245
+
246
+<h3><a class="anchor" id="index_v"></a>- v -</h3><ul>
247
+<li>version()
248
+: <a class="el" href="class_t_m_c26_x_stepper.html#ab040d9df1e85d6fb0c105205a36b0215">TMC26XStepper</a>
249
+</li>
250
+</ul>
251
+</div><!-- contents -->
252
+
253
+
254
+<hr class="footer"/><address class="footer"><small>
255
+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">
256
+<img class="footer" src="doxygen.png" alt="doxygen"/>
257
+</a> 1.7.6.1
258
+</small></address>
259
+
260
+</body>
261
+</html>

+ 261
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/functions_func.html View File

@@ -0,0 +1,261 @@
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: Class Members - Functions</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 class="current"><a href="functions.html"><span>Class&#160;Members</span></a></li>
51
+    </ul>
52
+  </div>
53
+  <div id="navrow3" class="tabs2">
54
+    <ul class="tablist">
55
+      <li><a href="functions.html"><span>All</span></a></li>
56
+      <li class="current"><a href="functions_func.html"><span>Functions</span></a></li>
57
+    </ul>
58
+  </div>
59
+  <div id="navrow4" class="tabs3">
60
+    <ul class="tablist">
61
+      <li><a href="#index_d"><span>d</span></a></li>
62
+      <li><a href="#index_g"><span>g</span></a></li>
63
+      <li><a href="#index_i"><span>i</span></a></li>
64
+      <li><a href="#index_m"><span>m</span></a></li>
65
+      <li><a href="#index_r"><span>r</span></a></li>
66
+      <li><a href="#index_s"><span>s</span></a></li>
67
+      <li><a href="#index_t"><span>t</span></a></li>
68
+      <li><a href="#index_u"><span>u</span></a></li>
69
+      <li><a href="#index_v"><span>v</span></a></li>
70
+    </ul>
71
+  </div>
72
+</div>
73
+<div class="contents">
74
+&#160;
75
+
76
+<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
77
+<li>debugLastStatus()
78
+: <a class="el" href="class_t_m_c26_x_stepper.html#ad5e5b1bf5a46d02577dd548083877ec3">TMC26XStepper</a>
79
+</li>
80
+</ul>
81
+
82
+
83
+<h3><a class="anchor" id="index_g"></a>- g -</h3><ul>
84
+<li>getCoolStepCurrentIncrementSize()
85
+: <a class="el" href="class_t_m_c26_x_stepper.html#ababe688a15f087d23d4ff2094fcee883">TMC26XStepper</a>
86
+</li>
87
+<li>getCoolStepLowerCurrentLimit()
88
+: <a class="el" href="class_t_m_c26_x_stepper.html#a0c7e8541abc120a3910e35c6fbf2167c">TMC26XStepper</a>
89
+</li>
90
+<li>getCoolStepLowerSgThreshold()
91
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa7469949deaa39a58038b3ddef532bc8">TMC26XStepper</a>
92
+</li>
93
+<li>getCoolStepNumberOfSGReadings()
94
+: <a class="el" href="class_t_m_c26_x_stepper.html#aad44ee5ae73bf8e69af05674a304ba46">TMC26XStepper</a>
95
+</li>
96
+<li>getCoolStepUpperSgThreshold()
97
+: <a class="el" href="class_t_m_c26_x_stepper.html#ac61298fd658773c28823d33ab04e970f">TMC26XStepper</a>
98
+</li>
99
+<li>getCurrent()
100
+: <a class="el" href="class_t_m_c26_x_stepper.html#a0c544e23efe3e4a912aacf57de84b71f">TMC26XStepper</a>
101
+</li>
102
+<li>getCurrentCSReading()
103
+: <a class="el" href="class_t_m_c26_x_stepper.html#a1a939fb495d747c2c11be99a740371e1">TMC26XStepper</a>
104
+</li>
105
+<li>getCurrentCurrent()
106
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa00741168a7def0a7a9d2f2c9d3b99d7">TMC26XStepper</a>
107
+</li>
108
+<li>getCurrentStallGuardReading()
109
+: <a class="el" href="class_t_m_c26_x_stepper.html#aed570ce3eea640e087b046333015de1e">TMC26XStepper</a>
110
+</li>
111
+<li>getMicrosteps()
112
+: <a class="el" href="class_t_m_c26_x_stepper.html#a5808551ced98b79c09bbb4bf47ecfec3">TMC26XStepper</a>
113
+</li>
114
+<li>getMotorPosition()
115
+: <a class="el" href="class_t_m_c26_x_stepper.html#a1019f6f889acfd3176eecd60a0a20125">TMC26XStepper</a>
116
+</li>
117
+<li>getOverTemperature()
118
+: <a class="el" href="class_t_m_c26_x_stepper.html#a7662c2fbc03d1f5a7da5cabcc153b2d7">TMC26XStepper</a>
119
+</li>
120
+<li>getResistor()
121
+: <a class="el" href="class_t_m_c26_x_stepper.html#ae1db5ec2ec9bfbfaea83c659e006692e">TMC26XStepper</a>
122
+</li>
123
+<li>getSpeed()
124
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa564f5cc0218d30ef897c2830c768c29">TMC26XStepper</a>
125
+</li>
126
+<li>getStallGuardFilter()
127
+: <a class="el" href="class_t_m_c26_x_stepper.html#a47e3443e3e786314c1099b8f14a91b8a">TMC26XStepper</a>
128
+</li>
129
+<li>getStallGuardThreshold()
130
+: <a class="el" href="class_t_m_c26_x_stepper.html#a056661f444725c3ae15696d1e8d91def">TMC26XStepper</a>
131
+</li>
132
+<li>getStepsLeft()
133
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa6c3211f85301ca0fb2e7b73cb8142a7">TMC26XStepper</a>
134
+</li>
135
+</ul>
136
+
137
+
138
+<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
139
+<li>isCoolStepEnabled()
140
+: <a class="el" href="class_t_m_c26_x_stepper.html#a6de2306b6d8dc1fa2e50fccb66d8e66d">TMC26XStepper</a>
141
+</li>
142
+<li>isCurrentScalingHalfed()
143
+: <a class="el" href="class_t_m_c26_x_stepper.html#ad435db189ebb101fb2de90a484f33905">TMC26XStepper</a>
144
+</li>
145
+<li>isEnabled()
146
+: <a class="el" href="class_t_m_c26_x_stepper.html#a15796c0cbdeab23a343c3f25327283b6">TMC26XStepper</a>
147
+</li>
148
+<li>isMoving()
149
+: <a class="el" href="class_t_m_c26_x_stepper.html#a880d602be8414b7b965287c1790cd50e">TMC26XStepper</a>
150
+</li>
151
+<li>isOpenLoadA()
152
+: <a class="el" href="class_t_m_c26_x_stepper.html#af97b2ab9d1ba36765ac6f17cf25ec45c">TMC26XStepper</a>
153
+</li>
154
+<li>isOpenLoadB()
155
+: <a class="el" href="class_t_m_c26_x_stepper.html#a303590124f5ac6d6a06d0ec60d0b5303">TMC26XStepper</a>
156
+</li>
157
+<li>isShortToGroundA()
158
+: <a class="el" href="class_t_m_c26_x_stepper.html#ad329fa4693d3139dea241ebe3d0f33cf">TMC26XStepper</a>
159
+</li>
160
+<li>isShortToGroundB()
161
+: <a class="el" href="class_t_m_c26_x_stepper.html#a0ccb54d40cce0d802aa56ff6261f9f3b">TMC26XStepper</a>
162
+</li>
163
+<li>isStallGuardOverThreshold()
164
+: <a class="el" href="class_t_m_c26_x_stepper.html#aea4c6e1fac909116c6b55f902d6cff41">TMC26XStepper</a>
165
+</li>
166
+<li>isStallGuardReached()
167
+: <a class="el" href="class_t_m_c26_x_stepper.html#afdeded501ec2cabeffde33d31b6573f7">TMC26XStepper</a>
168
+</li>
169
+<li>isStandStill()
170
+: <a class="el" href="class_t_m_c26_x_stepper.html#ab26602f360a4fb6ec6d262011675b2b0">TMC26XStepper</a>
171
+</li>
172
+</ul>
173
+
174
+
175
+<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
176
+<li>move()
177
+: <a class="el" href="class_t_m_c26_x_stepper.html#aed5d81f1549615529c723600a68ba415">TMC26XStepper</a>
178
+</li>
179
+</ul>
180
+
181
+
182
+<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
183
+<li>readStatus()
184
+: <a class="el" href="class_t_m_c26_x_stepper.html#af95a824bfdf49ef979b5354798e52967">TMC26XStepper</a>
185
+</li>
186
+</ul>
187
+
188
+
189
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
190
+<li>setConstantOffTimeChopper()
191
+: <a class="el" href="class_t_m_c26_x_stepper.html#ac2d8a2bbae2aba3ed7c98e3ff1a06649">TMC26XStepper</a>
192
+</li>
193
+<li>setCoolStepConfiguration()
194
+: <a class="el" href="class_t_m_c26_x_stepper.html#a381fbcce7c586ca2f1da8f9e704df14e">TMC26XStepper</a>
195
+</li>
196
+<li>setCoolStepEnabled()
197
+: <a class="el" href="class_t_m_c26_x_stepper.html#a15bf0ed5a166a5d9a41f90f3ccbc6157">TMC26XStepper</a>
198
+</li>
199
+<li>setCurrent()
200
+: <a class="el" href="class_t_m_c26_x_stepper.html#aaa35fac83417c16b3a941fa168e4a4d2">TMC26XStepper</a>
201
+</li>
202
+<li>setEnabled()
203
+: <a class="el" href="class_t_m_c26_x_stepper.html#a4472cd86ad5b65dec5ec45ce69158305">TMC26XStepper</a>
204
+</li>
205
+<li>setMicrosteps()
206
+: <a class="el" href="class_t_m_c26_x_stepper.html#a21041579c7f9284567ee2e2a55a3afd0">TMC26XStepper</a>
207
+</li>
208
+<li>setRandomOffTime()
209
+: <a class="el" href="class_t_m_c26_x_stepper.html#a7ffd602cf4bf385847cba034417d5f0a">TMC26XStepper</a>
210
+</li>
211
+<li>setSpeed()
212
+: <a class="el" href="class_t_m_c26_x_stepper.html#a9478f43090995c8d5cdb4d4e8c07cdbd">TMC26XStepper</a>
213
+</li>
214
+<li>setSpreadCycleChopper()
215
+: <a class="el" href="class_t_m_c26_x_stepper.html#aa152bb7ddb72a2bc8465553a39232df2">TMC26XStepper</a>
216
+</li>
217
+<li>setStallGuardThreshold()
218
+: <a class="el" href="class_t_m_c26_x_stepper.html#af1a5abc23757860baf8ff421689a425a">TMC26XStepper</a>
219
+</li>
220
+<li>start()
221
+: <a class="el" href="class_t_m_c26_x_stepper.html#aad1ed82b3e05940bde5a6c7ed3d3e8f7">TMC26XStepper</a>
222
+</li>
223
+<li>step()
224
+: <a class="el" href="class_t_m_c26_x_stepper.html#ac073a742496885f1f60751f9fb9c395d">TMC26XStepper</a>
225
+</li>
226
+<li>stop()
227
+: <a class="el" href="class_t_m_c26_x_stepper.html#a6315c18eadbc6bf4f3d81a6f80296123">TMC26XStepper</a>
228
+</li>
229
+</ul>
230
+
231
+
232
+<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
233
+<li>TMC26XStepper()
234
+: <a class="el" href="class_t_m_c26_x_stepper.html#a3ef40763b8b8ab2b6ed4978c0647906c">TMC26XStepper</a>
235
+</li>
236
+</ul>
237
+
238
+
239
+<h3><a class="anchor" id="index_u"></a>- u -</h3><ul>
240
+<li>un_start()
241
+: <a class="el" href="class_t_m_c26_x_stepper.html#af968e70a13068f1e71ac0fa6865630c5">TMC26XStepper</a>
242
+</li>
243
+</ul>
244
+
245
+
246
+<h3><a class="anchor" id="index_v"></a>- v -</h3><ul>
247
+<li>version()
248
+: <a class="el" href="class_t_m_c26_x_stepper.html#ab040d9df1e85d6fb0c105205a36b0215">TMC26XStepper</a>
249
+</li>
250
+</ul>
251
+</div><!-- contents -->
252
+
253
+
254
+<hr class="footer"/><address class="footer"><small>
255
+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">
256
+<img class="footer" src="doxygen.png" alt="doxygen"/>
257
+</a> 1.7.6.1
258
+</small></address>
259
+
260
+</body>
261
+</html>

+ 289
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/globals.html View File

@@ -0,0 +1,289 @@
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: File Members</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li class="current"><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+  <div id="navrow3" class="tabs2">
53
+    <ul class="tablist">
54
+      <li class="current"><a href="globals.html"><span>All</span></a></li>
55
+      <li><a href="globals_defs.html"><span>Defines</span></a></li>
56
+    </ul>
57
+  </div>
58
+  <div id="navrow4" class="tabs3">
59
+    <ul class="tablist">
60
+      <li><a href="#index_b"><span>b</span></a></li>
61
+      <li><a href="#index_c"><span>c</span></a></li>
62
+      <li><a href="#index_d"><span>d</span></a></li>
63
+      <li><a href="#index_h"><span>h</span></a></li>
64
+      <li><a href="#index_i"><span>i</span></a></li>
65
+      <li><a href="#index_m"><span>m</span></a></li>
66
+      <li><a href="#index_r"><span>r</span></a></li>
67
+      <li><a href="#index_s"><span>s</span></a></li>
68
+      <li><a href="#index_t"><span>t</span></a></li>
69
+      <li><a href="#index_v"><span>v</span></a></li>
70
+    </ul>
71
+  </div>
72
+</div>
73
+<div class="contents">
74
+<div class="textblock">Here is a list of all file members with links to the files they belong to:</div>
75
+
76
+<h3><a class="anchor" id="index_b"></a>- b -</h3><ul>
77
+<li>BLANK_TIMING_PATTERN
78
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a42cb2ce84258587d514ec3268548ba89">TMC26XStepper.cpp</a>
79
+</li>
80
+<li>BLANK_TIMING_SHIFT
81
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#abdac78f7f2c506972265a8e5883e1eae">TMC26XStepper.cpp</a>
82
+</li>
83
+</ul>
84
+
85
+
86
+<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
87
+<li>CHOPPER_CONFIG_REGISTER
88
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a70a540d1090b989b8600b5e4776659fe">TMC26XStepper.cpp</a>
89
+</li>
90
+<li>CHOPPER_MODE_STANDARD
91
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a57418a67ff726d540b813230bca1d536">TMC26XStepper.cpp</a>
92
+</li>
93
+<li>CHOPPER_MODE_T_OFF_FAST_DECAY
94
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aaf1b564ced7de8ff3245c964e3775826">TMC26XStepper.cpp</a>
95
+</li>
96
+<li>COOL_STEP_HALF_CS_LIMIT
97
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">TMC26XStepper.h</a>
98
+</li>
99
+<li>COOL_STEP_QUARTDER_CS_LIMIT
100
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">TMC26XStepper.h</a>
101
+</li>
102
+<li>COOL_STEP_REGISTER
103
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab9828bfaa075a0a8647c709136016317">TMC26XStepper.cpp</a>
104
+</li>
105
+<li>CURRENT_DOWN_STEP_SPEED_PATTERN
106
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbe13a0464355e42fbe786ca5f58ed8d">TMC26XStepper.cpp</a>
107
+</li>
108
+<li>CURRENT_SCALING_PATTERN
109
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99dcb8c6d98b0b54c23699a3f90450e4">TMC26XStepper.cpp</a>
110
+</li>
111
+</ul>
112
+
113
+
114
+<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
115
+<li>DEFAULT_MICROSTEPPING_VALUE
116
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6560b3471273e99e280ba795e3469ede">TMC26XStepper.cpp</a>
117
+</li>
118
+<li>DOUBLE_EDGE_STEP
119
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a770601bf0153e4bc639b9c3005b15af7">TMC26XStepper.cpp</a>
120
+</li>
121
+<li>DRIVER_CONFIG_REGISTER
122
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#af35f569d42ea3b1d634901a3b6a908ee">TMC26XStepper.cpp</a>
123
+</li>
124
+<li>DRIVER_CONTROL_REGISTER
125
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a108f18bf4a30a0e0f0991ac0e4ce0579">TMC26XStepper.cpp</a>
126
+</li>
127
+</ul>
128
+
129
+
130
+<h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
131
+<li>HYSTERESIS_DECREMENT_PATTERN
132
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a424c248097b38c1e29e6a58ad48e6bd9">TMC26XStepper.cpp</a>
133
+</li>
134
+<li>HYSTERESIS_DECREMENT_SHIFT
135
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a36e554a87785ce6ba998b79aae9e74e0">TMC26XStepper.cpp</a>
136
+</li>
137
+<li>HYSTERESIS_LOW_SHIFT
138
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a38ce0bb0fa20db28351ac9167f28db98">TMC26XStepper.cpp</a>
139
+</li>
140
+<li>HYSTERESIS_LOW_VALUE_PATTERN
141
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ad9d2302f6d61cd84a612a2e2bcdeb56e">TMC26XStepper.cpp</a>
142
+</li>
143
+<li>HYSTERESIS_START_VALUE_PATTERN
144
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a0de4e98b412dced62c3a4452b7483af3">TMC26XStepper.cpp</a>
145
+</li>
146
+<li>HYSTERESIS_START_VALUE_SHIFT
147
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac2c1c939256126e605396c4aaee3c804">TMC26XStepper.cpp</a>
148
+</li>
149
+</ul>
150
+
151
+
152
+<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
153
+<li>INITIAL_MICROSTEPPING
154
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a54a6d12e96d851361974b10614a00e45">TMC26XStepper.cpp</a>
155
+</li>
156
+</ul>
157
+
158
+
159
+<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
160
+<li>MICROSTEPPING_PATTERN
161
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8f5cb0c066109ffb18cefc0e85ee1d1b">TMC26XStepper.cpp</a>
162
+</li>
163
+<li>MINIMUM_CURRENT_FOURTH
164
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8a261a77d198b85f6dd8416387b354b3">TMC26XStepper.cpp</a>
165
+</li>
166
+</ul>
167
+
168
+
169
+<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
170
+<li>RANDOM_TOFF_TIME
171
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a64520580cffd416668f3b91bd60f84e1">TMC26XStepper.cpp</a>
172
+</li>
173
+<li>READ_MICROSTEP_POSTION
174
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a143b7757272f07866d9655bde8303d9a">TMC26XStepper.cpp</a>
175
+</li>
176
+<li>READ_SELECTION_PATTERN
177
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a88a4b45fa6385eba8aa4f0342334b832">TMC26XStepper.cpp</a>
178
+</li>
179
+<li>READ_STALL_GUARD_AND_COOL_STEP
180
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aef62b7fdcbac0b33b2d6e9cea4b5f9b2">TMC26XStepper.cpp</a>
181
+</li>
182
+<li>READ_STALL_GUARD_READING
183
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac1bd4da94fab7ce1049be2f866211819">TMC26XStepper.cpp</a>
184
+</li>
185
+<li>READOUT_VALUE_PATTERN
186
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a5c3d76da63f585e37813c32be2e11ab7">TMC26XStepper.cpp</a>
187
+</li>
188
+<li>REGISTER_BIT_PATTERN
189
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a3b02ee1f518b0c90c16488f937abd443">TMC26XStepper.cpp</a>
190
+</li>
191
+</ul>
192
+
193
+
194
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
195
+<li>SE_CURRENT_STEP_WIDTH_PATTERN
196
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aba6c07e5672e34e618bb3a550ab0d2bc">TMC26XStepper.cpp</a>
197
+</li>
198
+<li>SE_MAX_PATTERN
199
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac8f748bf735c447dbed7dd4c7b631a87">TMC26XStepper.cpp</a>
200
+</li>
201
+<li>SE_MIN_PATTERN
202
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae1862dfb958c03698b0abd95fda033ea">TMC26XStepper.cpp</a>
203
+</li>
204
+<li>STALL_GUARD2_LOAD_MEASURE_REGISTER
205
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a478d9bde09a6528eef6af6ffeeb6caba">TMC26XStepper.cpp</a>
206
+</li>
207
+<li>STALL_GUARD_CONFIG_PATTERN
208
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99ac04f0615556fc13c0c9f3e1c1b49d">TMC26XStepper.cpp</a>
209
+</li>
210
+<li>STALL_GUARD_FILTER_ENABLED
211
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#afdbbefabd0c29c4b6e403c4663d0f0be">TMC26XStepper.cpp</a>
212
+</li>
213
+<li>STALL_GUARD_TRESHHOLD_VALUE_PATTERN
214
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae631457932894a974334892704550ecc">TMC26XStepper.cpp</a>
215
+</li>
216
+<li>STALL_GUARD_VALUE_PATTERN
217
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6a1cb1fd61cf7c570f94376fa11fe55b">TMC26XStepper.cpp</a>
218
+</li>
219
+<li>STATUS_OPEN_LOAD_A
220
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae9cbbe5af7188e6bff8fe412f8e42f59">TMC26XStepper.cpp</a>
221
+</li>
222
+<li>STATUS_OPEN_LOAD_B
223
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab29dc5cd6c6c4e5bf99e71bd563e1be1">TMC26XStepper.cpp</a>
224
+</li>
225
+<li>STATUS_OVER_TEMPERATURE_SHUTDOWN
226
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbb23d2f055c9eab55eac29d1a75deb4">TMC26XStepper.cpp</a>
227
+</li>
228
+<li>STATUS_OVER_TEMPERATURE_WARNING
229
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa317fd77f2f26fdfbfd331e21d9069e8">TMC26XStepper.cpp</a>
230
+</li>
231
+<li>STATUS_SHORT_TO_GROUND_A
232
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8e03041302a092174fa33b3cf837dca2">TMC26XStepper.cpp</a>
233
+</li>
234
+<li>STATUS_SHORT_TO_GROUND_B
235
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a903c3eba99695a32c6736463dcfd93ae">TMC26XStepper.cpp</a>
236
+</li>
237
+<li>STATUS_STALL_GUARD_STATUS
238
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa09ef662fd19bf2d063d6bd0f48eca14">TMC26XStepper.cpp</a>
239
+</li>
240
+<li>STATUS_STAND_STILL
241
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab96ed1635faee6650e9cce73598a2773">TMC26XStepper.cpp</a>
242
+</li>
243
+<li>STEP_INTERPOLATION
244
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa64245f223209654c60588e4558e0bab">TMC26XStepper.cpp</a>
245
+</li>
246
+</ul>
247
+
248
+
249
+<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
250
+<li>T_OFF_PATTERN
251
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa4e49237f2671e7f28aa34ae0e89da8d">TMC26XStepper.cpp</a>
252
+</li>
253
+<li>T_OFF_TIMING_PATERN
254
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a7659d842c803e47ba911a2a6e26327f3">TMC26XStepper.cpp</a>
255
+</li>
256
+<li>TMC26X_OVERTEMPERATURE_PREWARING
257
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">TMC26XStepper.h</a>
258
+</li>
259
+<li>TMC26X_OVERTEMPERATURE_SHUTDOWN
260
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">TMC26XStepper.h</a>
261
+</li>
262
+<li>TMC26X_READOUT_CURRENT
263
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">TMC26XStepper.h</a>
264
+</li>
265
+<li>TMC26X_READOUT_POSITION
266
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26XStepper.h</a>
267
+</li>
268
+<li>TMC26X_READOUT_STALLGUARD
269
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">TMC26XStepper.h</a>
270
+</li>
271
+</ul>
272
+
273
+
274
+<h3><a class="anchor" id="index_v"></a>- v -</h3><ul>
275
+<li>VSENSE
276
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a4fb1c008e2ff76eee9362600eed112e1">TMC26XStepper.cpp</a>
277
+</li>
278
+</ul>
279
+</div><!-- contents -->
280
+
281
+
282
+<hr class="footer"/><address class="footer"><small>
283
+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">
284
+<img class="footer" src="doxygen.png" alt="doxygen"/>
285
+</a> 1.7.6.1
286
+</small></address>
287
+
288
+</body>
289
+</html>

+ 289
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/globals_defs.html View File

@@ -0,0 +1,289 @@
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: File Members</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li class="current"><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+  <div id="navrow3" class="tabs2">
53
+    <ul class="tablist">
54
+      <li><a href="globals.html"><span>All</span></a></li>
55
+      <li class="current"><a href="globals_defs.html"><span>Defines</span></a></li>
56
+    </ul>
57
+  </div>
58
+  <div id="navrow4" class="tabs3">
59
+    <ul class="tablist">
60
+      <li><a href="#index_b"><span>b</span></a></li>
61
+      <li><a href="#index_c"><span>c</span></a></li>
62
+      <li><a href="#index_d"><span>d</span></a></li>
63
+      <li><a href="#index_h"><span>h</span></a></li>
64
+      <li><a href="#index_i"><span>i</span></a></li>
65
+      <li><a href="#index_m"><span>m</span></a></li>
66
+      <li><a href="#index_r"><span>r</span></a></li>
67
+      <li><a href="#index_s"><span>s</span></a></li>
68
+      <li><a href="#index_t"><span>t</span></a></li>
69
+      <li><a href="#index_v"><span>v</span></a></li>
70
+    </ul>
71
+  </div>
72
+</div>
73
+<div class="contents">
74
+&#160;
75
+
76
+<h3><a class="anchor" id="index_b"></a>- b -</h3><ul>
77
+<li>BLANK_TIMING_PATTERN
78
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a42cb2ce84258587d514ec3268548ba89">TMC26XStepper.cpp</a>
79
+</li>
80
+<li>BLANK_TIMING_SHIFT
81
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#abdac78f7f2c506972265a8e5883e1eae">TMC26XStepper.cpp</a>
82
+</li>
83
+</ul>
84
+
85
+
86
+<h3><a class="anchor" id="index_c"></a>- c -</h3><ul>
87
+<li>CHOPPER_CONFIG_REGISTER
88
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a70a540d1090b989b8600b5e4776659fe">TMC26XStepper.cpp</a>
89
+</li>
90
+<li>CHOPPER_MODE_STANDARD
91
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a57418a67ff726d540b813230bca1d536">TMC26XStepper.cpp</a>
92
+</li>
93
+<li>CHOPPER_MODE_T_OFF_FAST_DECAY
94
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aaf1b564ced7de8ff3245c964e3775826">TMC26XStepper.cpp</a>
95
+</li>
96
+<li>COOL_STEP_HALF_CS_LIMIT
97
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#a28b1774bd4aa854fb5e4b6dc7db96ecb">TMC26XStepper.h</a>
98
+</li>
99
+<li>COOL_STEP_QUARTDER_CS_LIMIT
100
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#a1a4db5eafd0a9247677153cb4c8b7d54">TMC26XStepper.h</a>
101
+</li>
102
+<li>COOL_STEP_REGISTER
103
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab9828bfaa075a0a8647c709136016317">TMC26XStepper.cpp</a>
104
+</li>
105
+<li>CURRENT_DOWN_STEP_SPEED_PATTERN
106
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbe13a0464355e42fbe786ca5f58ed8d">TMC26XStepper.cpp</a>
107
+</li>
108
+<li>CURRENT_SCALING_PATTERN
109
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99dcb8c6d98b0b54c23699a3f90450e4">TMC26XStepper.cpp</a>
110
+</li>
111
+</ul>
112
+
113
+
114
+<h3><a class="anchor" id="index_d"></a>- d -</h3><ul>
115
+<li>DEFAULT_MICROSTEPPING_VALUE
116
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6560b3471273e99e280ba795e3469ede">TMC26XStepper.cpp</a>
117
+</li>
118
+<li>DOUBLE_EDGE_STEP
119
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a770601bf0153e4bc639b9c3005b15af7">TMC26XStepper.cpp</a>
120
+</li>
121
+<li>DRIVER_CONFIG_REGISTER
122
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#af35f569d42ea3b1d634901a3b6a908ee">TMC26XStepper.cpp</a>
123
+</li>
124
+<li>DRIVER_CONTROL_REGISTER
125
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a108f18bf4a30a0e0f0991ac0e4ce0579">TMC26XStepper.cpp</a>
126
+</li>
127
+</ul>
128
+
129
+
130
+<h3><a class="anchor" id="index_h"></a>- h -</h3><ul>
131
+<li>HYSTERESIS_DECREMENT_PATTERN
132
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a424c248097b38c1e29e6a58ad48e6bd9">TMC26XStepper.cpp</a>
133
+</li>
134
+<li>HYSTERESIS_DECREMENT_SHIFT
135
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a36e554a87785ce6ba998b79aae9e74e0">TMC26XStepper.cpp</a>
136
+</li>
137
+<li>HYSTERESIS_LOW_SHIFT
138
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a38ce0bb0fa20db28351ac9167f28db98">TMC26XStepper.cpp</a>
139
+</li>
140
+<li>HYSTERESIS_LOW_VALUE_PATTERN
141
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ad9d2302f6d61cd84a612a2e2bcdeb56e">TMC26XStepper.cpp</a>
142
+</li>
143
+<li>HYSTERESIS_START_VALUE_PATTERN
144
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a0de4e98b412dced62c3a4452b7483af3">TMC26XStepper.cpp</a>
145
+</li>
146
+<li>HYSTERESIS_START_VALUE_SHIFT
147
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac2c1c939256126e605396c4aaee3c804">TMC26XStepper.cpp</a>
148
+</li>
149
+</ul>
150
+
151
+
152
+<h3><a class="anchor" id="index_i"></a>- i -</h3><ul>
153
+<li>INITIAL_MICROSTEPPING
154
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a54a6d12e96d851361974b10614a00e45">TMC26XStepper.cpp</a>
155
+</li>
156
+</ul>
157
+
158
+
159
+<h3><a class="anchor" id="index_m"></a>- m -</h3><ul>
160
+<li>MICROSTEPPING_PATTERN
161
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8f5cb0c066109ffb18cefc0e85ee1d1b">TMC26XStepper.cpp</a>
162
+</li>
163
+<li>MINIMUM_CURRENT_FOURTH
164
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8a261a77d198b85f6dd8416387b354b3">TMC26XStepper.cpp</a>
165
+</li>
166
+</ul>
167
+
168
+
169
+<h3><a class="anchor" id="index_r"></a>- r -</h3><ul>
170
+<li>RANDOM_TOFF_TIME
171
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a64520580cffd416668f3b91bd60f84e1">TMC26XStepper.cpp</a>
172
+</li>
173
+<li>READ_MICROSTEP_POSTION
174
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a143b7757272f07866d9655bde8303d9a">TMC26XStepper.cpp</a>
175
+</li>
176
+<li>READ_SELECTION_PATTERN
177
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a88a4b45fa6385eba8aa4f0342334b832">TMC26XStepper.cpp</a>
178
+</li>
179
+<li>READ_STALL_GUARD_AND_COOL_STEP
180
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aef62b7fdcbac0b33b2d6e9cea4b5f9b2">TMC26XStepper.cpp</a>
181
+</li>
182
+<li>READ_STALL_GUARD_READING
183
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac1bd4da94fab7ce1049be2f866211819">TMC26XStepper.cpp</a>
184
+</li>
185
+<li>READOUT_VALUE_PATTERN
186
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a5c3d76da63f585e37813c32be2e11ab7">TMC26XStepper.cpp</a>
187
+</li>
188
+<li>REGISTER_BIT_PATTERN
189
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a3b02ee1f518b0c90c16488f937abd443">TMC26XStepper.cpp</a>
190
+</li>
191
+</ul>
192
+
193
+
194
+<h3><a class="anchor" id="index_s"></a>- s -</h3><ul>
195
+<li>SE_CURRENT_STEP_WIDTH_PATTERN
196
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aba6c07e5672e34e618bb3a550ab0d2bc">TMC26XStepper.cpp</a>
197
+</li>
198
+<li>SE_MAX_PATTERN
199
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ac8f748bf735c447dbed7dd4c7b631a87">TMC26XStepper.cpp</a>
200
+</li>
201
+<li>SE_MIN_PATTERN
202
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae1862dfb958c03698b0abd95fda033ea">TMC26XStepper.cpp</a>
203
+</li>
204
+<li>STALL_GUARD2_LOAD_MEASURE_REGISTER
205
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a478d9bde09a6528eef6af6ffeeb6caba">TMC26XStepper.cpp</a>
206
+</li>
207
+<li>STALL_GUARD_CONFIG_PATTERN
208
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a99ac04f0615556fc13c0c9f3e1c1b49d">TMC26XStepper.cpp</a>
209
+</li>
210
+<li>STALL_GUARD_FILTER_ENABLED
211
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#afdbbefabd0c29c4b6e403c4663d0f0be">TMC26XStepper.cpp</a>
212
+</li>
213
+<li>STALL_GUARD_TRESHHOLD_VALUE_PATTERN
214
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae631457932894a974334892704550ecc">TMC26XStepper.cpp</a>
215
+</li>
216
+<li>STALL_GUARD_VALUE_PATTERN
217
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a6a1cb1fd61cf7c570f94376fa11fe55b">TMC26XStepper.cpp</a>
218
+</li>
219
+<li>STATUS_OPEN_LOAD_A
220
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ae9cbbe5af7188e6bff8fe412f8e42f59">TMC26XStepper.cpp</a>
221
+</li>
222
+<li>STATUS_OPEN_LOAD_B
223
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab29dc5cd6c6c4e5bf99e71bd563e1be1">TMC26XStepper.cpp</a>
224
+</li>
225
+<li>STATUS_OVER_TEMPERATURE_SHUTDOWN
226
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#adbb23d2f055c9eab55eac29d1a75deb4">TMC26XStepper.cpp</a>
227
+</li>
228
+<li>STATUS_OVER_TEMPERATURE_WARNING
229
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa317fd77f2f26fdfbfd331e21d9069e8">TMC26XStepper.cpp</a>
230
+</li>
231
+<li>STATUS_SHORT_TO_GROUND_A
232
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a8e03041302a092174fa33b3cf837dca2">TMC26XStepper.cpp</a>
233
+</li>
234
+<li>STATUS_SHORT_TO_GROUND_B
235
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a903c3eba99695a32c6736463dcfd93ae">TMC26XStepper.cpp</a>
236
+</li>
237
+<li>STATUS_STALL_GUARD_STATUS
238
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa09ef662fd19bf2d063d6bd0f48eca14">TMC26XStepper.cpp</a>
239
+</li>
240
+<li>STATUS_STAND_STILL
241
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#ab96ed1635faee6650e9cce73598a2773">TMC26XStepper.cpp</a>
242
+</li>
243
+<li>STEP_INTERPOLATION
244
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa64245f223209654c60588e4558e0bab">TMC26XStepper.cpp</a>
245
+</li>
246
+</ul>
247
+
248
+
249
+<h3><a class="anchor" id="index_t"></a>- t -</h3><ul>
250
+<li>T_OFF_PATTERN
251
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#aa4e49237f2671e7f28aa34ae0e89da8d">TMC26XStepper.cpp</a>
252
+</li>
253
+<li>T_OFF_TIMING_PATERN
254
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a7659d842c803e47ba911a2a6e26327f3">TMC26XStepper.cpp</a>
255
+</li>
256
+<li>TMC26X_OVERTEMPERATURE_PREWARING
257
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#add42eee34f674f92c19bcd5266d2445f">TMC26XStepper.h</a>
258
+</li>
259
+<li>TMC26X_OVERTEMPERATURE_SHUTDOWN
260
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#adae814ce848677abd87758c7ac79a436">TMC26XStepper.h</a>
261
+</li>
262
+<li>TMC26X_READOUT_CURRENT
263
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#a01760ad15e3846536526a990efe47094">TMC26XStepper.h</a>
264
+</li>
265
+<li>TMC26X_READOUT_POSITION
266
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#aff05d4a47ef8821322ccc2a20785fbee">TMC26XStepper.h</a>
267
+</li>
268
+<li>TMC26X_READOUT_STALLGUARD
269
+: <a class="el" href="_t_m_c26_x_stepper_8h.html#ac864ff8886123039c7d2d3c617f7ef87">TMC26XStepper.h</a>
270
+</li>
271
+</ul>
272
+
273
+
274
+<h3><a class="anchor" id="index_v"></a>- v -</h3><ul>
275
+<li>VSENSE
276
+: <a class="el" href="_t_m_c26_x_stepper_8cpp.html#a4fb1c008e2ff76eee9362600eed112e1">TMC26XStepper.cpp</a>
277
+</li>
278
+</ul>
279
+</div><!-- contents -->
280
+
281
+
282
+<hr class="footer"/><address class="footer"><small>
283
+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">
284
+<img class="footer" src="doxygen.png" alt="doxygen"/>
285
+</a> 1.7.6.1
286
+</small></address>
287
+
288
+</body>
289
+</html>

+ 72
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/index.html View File

@@ -0,0 +1,72 @@
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: TMC 260, 261, 262 Stepper Driver for Arduino</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 class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><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>
47
+<div class="header">
48
+  <div class="headertitle">
49
+<div class="title">TMC 260, 261, 262 Stepper Driver for Arduino </div>  </div>
50
+</div><!--header-->
51
+<div class="contents">
52
+<div class="textblock"><dl class="author"><dt><b>Author:</b></dt><dd>Interactive MAtter, MArcus Nowotny, <a href="mailto:marcus@interactive-matter.eu">marcus@interactive-matter.eu</a> </dd></dl>
53
+<h2><a class="anchor" id="HOWTO"></a>
54
+How to use the driver</h2>
55
+<p>Here we go with aminial how to description</p>
56
+<h2><a class="anchor" id="COPYRIGHT_NOTIFICATION"></a>
57
+COPYRIGHT NOTIFICATION</h2>
58
+<dl class="user"><dt><b>(c) 2011 Interactive MAtter, Marcus Nowotny </b></dt><dd></dd></dl>
59
+<dl class="user"><dt><b></b></dt><dd>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</dd></dl>
60
+<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
61
+<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. </p>
62
+</div></div><!-- contents -->
63
+
64
+
65
+<hr class="footer"/><address class="footer"><small>
66
+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">
67
+<img class="footer" src="doxygen.png" alt="doxygen"/>
68
+</a> 1.7.6.1
69
+</small></address>
70
+
71
+</body>
72
+</html>

+ 64
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/jquery.js
File diff suppressed because it is too large
View File


+ 68
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/mainpage_8dox.html View File

@@ -0,0 +1,68 @@
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: mainpage.dox File Reference</title>
7
+
8
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
9
+<link href="doxygen.css" rel="stylesheet" type="text/css" />
10
+
11
+
12
+
13
+</head>
14
+<body>
15
+<div id="top"><!-- do not remove this div! -->
16
+
17
+
18
+<div id="titlearea">
19
+<table cellspacing="0" cellpadding="0">
20
+ <tbody>
21
+ <tr style="height: 56px;">
22
+  
23
+  
24
+  <td style="padding-left: 0.5em;">
25
+   <div id="projectname">Trinamic TMC26X Stepper Driver for Arduino
26
+   
27
+   </div>
28
+   
29
+  </td>
30
+  
31
+  
32
+  
33
+ </tr>
34
+ </tbody>
35
+</table>
36
+</div>
37
+
38
+<!-- Generated by Doxygen 1.7.6.1 -->
39
+  <div id="navrow1" class="tabs">
40
+    <ul class="tablist">
41
+      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
42
+      <li><a href="annotated.html"><span>Classes</span></a></li>
43
+      <li class="current"><a href="files.html"><span>Files</span></a></li>
44
+    </ul>
45
+  </div>
46
+  <div id="navrow2" class="tabs2">
47
+    <ul class="tablist">
48
+      <li><a href="files.html"><span>File&#160;List</span></a></li>
49
+      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
50
+    </ul>
51
+  </div>
52
+</div>
53
+<div class="header">
54
+  <div class="headertitle">
55
+<div class="title">mainpage.dox File Reference</div>  </div>
56
+</div><!--header-->
57
+<div class="contents">
58
+</div><!-- contents -->
59
+
60
+
61
+<hr class="footer"/><address class="footer"><small>
62
+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">
63
+<img class="footer" src="doxygen.png" alt="doxygen"/>
64
+</a> 1.7.6.1
65
+</small></address>
66
+
67
+</body>
68
+</html>

BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/nav_f.png View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/nav_h.png View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/open.png View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_a.png View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_b.png View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_h.png View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tab_s.png View File


+ 59
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/documentation/html/tabs.css View File

@@ -0,0 +1,59 @@
1
+.tabs, .tabs2, .tabs3 {
2
+    background-image: url('tab_b.png');
3
+    width: 100%;
4
+    z-index: 101;
5
+    font-size: 13px;
6
+}
7
+
8
+.tabs2 {
9
+    font-size: 10px;
10
+}
11
+.tabs3 {
12
+    font-size: 9px;
13
+}
14
+
15
+.tablist {
16
+    margin: 0;
17
+    padding: 0;
18
+    display: table;
19
+}
20
+
21
+.tablist li {
22
+    float: left;
23
+    display: table-cell;
24
+    background-image: url('tab_b.png');
25
+    line-height: 36px;
26
+    list-style: none;
27
+}
28
+
29
+.tablist a {
30
+    display: block;
31
+    padding: 0 20px;
32
+    font-weight: bold;
33
+    background-image:url('tab_s.png');
34
+    background-repeat:no-repeat;
35
+    background-position:right;
36
+    color: #283A5D;
37
+    text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
38
+    text-decoration: none;
39
+    outline: none;
40
+}
41
+
42
+.tabs3 .tablist a {
43
+    padding: 0 10px;
44
+}
45
+
46
+.tablist a:hover {
47
+    background-image: url('tab_h.png');
48
+    background-repeat:repeat-x;
49
+    color: #fff;
50
+    text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
51
+    text-decoration: none;
52
+}
53
+
54
+.tablist li.current a {
55
+    background-image: url('tab_a.png');
56
+    background-repeat:repeat-x;
57
+    color: #fff;
58
+    text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
59
+}

+ 82
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XExample/TMC26XExample.ino View File

@@ -0,0 +1,82 @@
1
+/*
2
+ TMC26XExample.ino - - TMC26X Stepper library Example for Wiring/Arduino
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+#include <SPI.h>
26
+#include <TMC26XStepper.h>
27
+
28
+//we have a stepper motor with 200 steps per rotation, CS pin 2, dir pin 6, step pin 7 and a current of 300mA
29
+TMC26XStepper tmc26XStepper = TMC26XStepper(200,2,6,7,700);
30
+int curr_step;
31
+int speed =  0;
32
+int speedDirection = 100;
33
+int maxSpeed = 1000;
34
+
35
+void setup() {
36
+  Serial.begin(9600);
37
+  Serial.println("==============================");
38
+  Serial.println("TMC26X Stepper Driver Demo App");
39
+  Serial.println("==============================");
40
+  //set this according to you stepper
41
+  Serial.println("Configuring stepper driver");
42
+  //char constant_off_time, char blank_time, char hysteresis_start, char hysteresis_end, char hysteresis_decrement
43
+  tmc26XStepper.setSpreadCycleChopper(2,24,8,6,0);
44
+  tmc26XStepper.setRandomOffTime(0);
45
+  
46
+  tmc26XStepper.setMicrosteps(32);
47
+  tmc26XStepper.setStallGuardThreshold(4,0);
48
+  Serial.println("config finished, starting");
49
+  tmc26XStepper.start();
50
+  Serial.println("started");
51
+}
52
+
53
+void loop() {
54
+  if (!tmc26XStepper.isMoving()) {
55
+    speed+=speedDirection;
56
+    if (speed>maxSpeed) {
57
+      speed = maxSpeed;
58
+      speedDirection = -speedDirection;
59
+    } else if (speed<0) {
60
+      speedDirection = -speedDirection;
61
+      speed=speedDirection;
62
+    }
63
+    //setting the speed
64
+    Serial.print("setting speed to ");
65
+    Serial.println(speed);
66
+    tmc26XStepper.setSpeed(speed);
67
+    //we want some kind of constant running time - so the length is just a product of speed
68
+    Serial.print("Going ");
69
+    Serial.print(10*speed);
70
+    Serial.println(" steps");
71
+    tmc26XStepper.step(10*speed);
72
+  } else {
73
+    //we put out the status every 100 steps
74
+    if (tmc26XStepper.getStepsLeft()%100==0) {
75
+      Serial.print("Stall Guard: ");
76
+      Serial.println(tmc26XStepper.getCurrentStallGuardReading());
77
+    }    
78
+  }  
79
+  tmc26XStepper.move();
80
+}
81
+
82
+

+ 176
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/Motor.ino View File

@@ -0,0 +1,176 @@
1
+/*
2
+ TMC26XMotorTest.ino - - TMC26X Stepper library tester for Wiring/Arduino
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+ unsigned int motor_counter = 0;
26
+unsigned char motor_moved = 0;
27
+int sgThreshold = 4;
28
+int sgFilter = 0;
29
+int direction = 1;
30
+
31
+unsigned int lower_SG_threshold = 0;
32
+unsigned int upper_SG_threshold = 0;
33
+unsigned char number_of_SG_readings=0;
34
+unsigned char current_increment_step_size=0;
35
+unsigned char lower_current_limit=0;
36
+
37
+
38
+char chopperMode = 0; //0 for spread, 1 for constant off
39
+char t_off = 2;
40
+char t_blank = 24;
41
+char h_start = 8;
42
+char h_end = 6;
43
+char h_decrement = 0;
44
+
45
+
46
+void startMotor() {
47
+  Serial.println(F("Configuring stepper driver"));
48
+  //char constant_off_time, char blank_time, char hysteresis_start, char hysteresis_end, char hysteresis_decrement
49
+  tmc26XStepper.setSpreadCycleChopper(t_off,t_blank,h_start,h_end,h_decrement);
50
+  tmc26XStepper.setRandomOffTime(0);
51
+
52
+  tmc26XStepper.setMicrosteps(32);
53
+  tmc26XStepper.setStallGuardThreshold(sgThreshold,sgFilter);
54
+  //  Serial.println("config finished, starting");
55
+  digitalWrite(ENABLE_PIN,LOW);
56
+  tmc26XStepper.start();
57
+  tmc26XStepper.setSpeed(10);
58
+  TCNT2=setupTimer2(10000);
59
+  sei();
60
+}
61
+
62
+void runMotor() {
63
+  if (running && !tmc26XStepper.isMoving()) {
64
+    tmc26XStepper.step(direction*10000);
65
+    Serial.println("run");
66
+  }
67
+  if (!running & tmc26XStepper.isMoving()) {
68
+    tmc26XStepper.stop();
69
+    Serial.println("stop");
70
+  }
71
+}
72
+
73
+void setSpeed(unsigned int targetSpeed) {
74
+  if (targetSpeed>0 && targetSpeed<MAX_SPEED) {
75
+    Serial.print(F("Setting speed: ")); 
76
+    Serial.println(targetSpeed);
77
+    tmc26XStepper.setSpeed(targetSpeed);
78
+  } 
79
+  else {
80
+    Serial.print(F("improper speed "));
81
+    Serial.println(targetSpeed);
82
+  }
83
+}
84
+
85
+void setMicrostepping(int microstepping) {
86
+  if (microstepping<1 || microstepping>256) {
87
+    Serial.print(F("Improperd microstepping setting [1...256]: "));
88
+    Serial.print(microstepping);
89
+  } 
90
+  else {
91
+    tmc26XStepper.setMicrosteps(microstepping);
92
+  }
93
+}
94
+
95
+void setStallGuardThreshold(int threshold) {
96
+  if (threshold<-64 || threshold > 63) {
97
+    Serial.print(F("Improper Stall Guard Threshold [-64...63]: "));
98
+    Serial.println(threshold);
99
+  } 
100
+  else {
101
+    sgThreshold = threshold;
102
+    tmc26XStepper.setStallGuardThreshold(threshold,sgFilter);
103
+  }
104
+}
105
+
106
+void setStallGuardFilter(int filter) {
107
+  if (filter) {
108
+    sgFilter=1;
109
+  } 
110
+  else {
111
+    sgFilter=0;
112
+  }
113
+  tmc26XStepper.setStallGuardThreshold(sgThreshold,sgFilter);
114
+}
115
+
116
+void setCurrent(int current) {
117
+  if (current>0 && current <1700) {
118
+    tmc26XStepper.setCurrent(current);
119
+  } 
120
+  else {
121
+    Serial.print(F("Improper current {0 ... 1200}: "));
122
+    Serial.print(current);
123
+  }
124
+}
125
+
126
+void updateChopper() {
127
+  //we can do only spread now
128
+  if (chopperMode==0) {
129
+    tmc26XStepper.setSpreadCycleChopper(t_off,t_blank,h_start,h_end,h_decrement);
130
+  }    
131
+}
132
+
133
+void updateCoolStep() {
134
+  tmc26XStepper.setCoolStepConfiguration(
135
+    lower_SG_threshold, upper_SG_threshold, number_of_SG_readings,
136
+    current_increment_step_size, lower_current_limit);
137
+}
138
+
139
+//from http://www.uchobby.com/index.php/2007/11/24/arduino-interrupts/
140
+//Setup Timer2.s
141
+//Configures the ATMega168 8-Bit Timer2 to generate an interrupt
142
+//at the specified frequency.
143
+//Returns the timer load value which must be loaded into TCNT2
144
+//inside your ISR routine.
145
+//See the example usage below.
146
+unsigned char setupTimer2(float timeoutFrequency){
147
+  unsigned char result; //The timer load value.
148
+
149
+  //Calculate the timer load value
150
+  result=(int)((257.0-(TIMER_CLOCK_FREQ/timeoutFrequency))+0.5);
151
+  //The 257 really should be 256 but I get better results with 257.
152
+
153
+  //Timer2 Settings: Timer Prescaler /8, mode 0
154
+  //Timer clock = 16MHz/8 = 2Mhz or 0.5us
155
+  //The /8 prescale gives us a good range to work with
156
+  //so we just hard code this for now.
157
+  TCCR2A = 0;
158
+  TCCR2B = 0<<CS22 | 1<<CS21 | 0<<CS20;
159
+
160
+  //Timer2 Overflow Interrupt Enable
161
+  TIMSK2 = 1<<TOIE2;
162
+
163
+  //load the timer for its first cycle
164
+  TCNT2=result;
165
+
166
+  return(result);
167
+}
168
+
169
+ISR(TIMER2_OVF_vect) {
170
+  motor_moved = tmc26XStepper.move();
171
+  motor_counter++;
172
+}
173
+
174
+
175
+
176
+

+ 369
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/Serial.ino View File

@@ -0,0 +1,369 @@
1
+/*
2
+ TMC26XMotorTest.ino - - TMC26X Stepper library tester for Wiring/Arduino
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+ #define INPUT_BUFFER_LENGTH 32
26
+
27
+#define SERIAL_SPEED 115200
28
+#define STATUS_COUNTER 100
29
+
30
+char inputBuffer[INPUT_BUFFER_LENGTH+1]; //ad on character to keep the trainling 0
31
+unsigned char inputBufferPosition;
32
+
33
+void startSerial() {
34
+  Serial.begin(SERIAL_SPEED);
35
+  Serial.println(F("================================="));
36
+  Serial.println(F("TMC26X Stepper Driver Motor Tester"));
37
+  Serial.println(F("================================="));
38
+  //empty the input buffer
39
+  for (unsigned char i=0; i< INPUT_BUFFER_LENGTH+1; i++) {
40
+    inputBuffer[i]=0;
41
+  }
42
+  inputBufferPosition=0;
43
+}
44
+
45
+void loopSerial() {
46
+  if (Serial.available()>0 && inputBufferPosition<INPUT_BUFFER_LENGTH) {
47
+    char c = Serial.read();
48
+    //Read the char
49
+    inputBuffer[inputBufferPosition]=c;
50
+    inputBufferPosition++;
51
+    //always terminate the string
52
+    inputBuffer[inputBufferPosition]=0;
53
+    //and if the line ended we execute the command
54
+    if (c=='\n') {
55
+      executeSerialCommand();   
56
+    }
57
+  }
58
+  if (motor_moved) {
59
+    Serial.print("#sg");
60
+    Serial.print(tmc26XStepper.getCurrentStallGuardReading(),DEC);
61
+    Serial.print(",p");
62
+    Serial.print(tmc26XStepper.getMotorPosition(),DEC);
63
+    Serial.print(",k");
64
+    Serial.print(tmc26XStepper.getCurrentCurrent(),DEC);
65
+    Serial.println(',');
66
+    motor_moved=0;
67
+  }
68
+  if (motor_counter>STATUS_COUNTER) {
69
+    motor_counter=0;
70
+    char moving = tmc26XStepper.isMoving();
71
+    Serial.print('#');
72
+    if (moving) {
73
+      Serial.print('r');
74
+    } 
75
+    else {
76
+      Serial.print('s');
77
+    }
78
+    Serial.print(',');
79
+    Serial.print('d');
80
+    Serial.print(direction);
81
+    Serial.print(',');
82
+    Serial.print("c");
83
+    Serial.print(tmc26XStepper.getCurrent(),DEC);
84
+    Serial.print(',');
85
+    Serial.print('S');
86
+    Serial.print(tmc26XStepper.getSpeed(),DEC);
87
+    Serial.print(',');
88
+    Serial.print('m');
89
+    Serial.print(tmc26XStepper.getMicrosteps(),DEC);
90
+    Serial.print(',');
91
+    Serial.print("t");
92
+    Serial.print(tmc26XStepper.getStallGuardThreshold(),DEC);
93
+    Serial.print(',');
94
+    Serial.print('f');
95
+    Serial.print(tmc26XStepper.getStallGuardFilter(),DEC);
96
+    Serial.print(',');
97
+    //print out the general cool step config
98
+    if (tmc26XStepper.isCoolStepEnabled()) {
99
+      Serial.print("Ke+,");
100
+    } 
101
+    else {
102
+      Serial.print("Ke-,");
103
+    }
104
+    Serial.print("Kl");
105
+    Serial.print(tmc26XStepper.getCoolStepLowerSgThreshold(),DEC);
106
+    Serial.print(",Ku");
107
+    Serial.print(tmc26XStepper.getCoolStepUpperSgThreshold(),DEC);
108
+    Serial.print(",Kn");
109
+    Serial.print(tmc26XStepper.getCoolStepNumberOfSGReadings(),DEC);
110
+    Serial.print(",Ki");
111
+    Serial.print(tmc26XStepper.getCoolStepCurrentIncrementSize(),DEC);
112
+    Serial.print(",Km");
113
+    Serial.print(tmc26XStepper.getCoolStepLowerCurrentLimit(),DEC);
114
+    Serial.print(',');
115
+    //detect the winding status
116
+    if (tmc26XStepper.isOpenLoadA()) {
117
+      Serial.print("ao,");
118
+    } 
119
+    else if(tmc26XStepper.isShortToGroundA()) {
120
+      Serial.print("ag,");
121
+    } 
122
+    else {
123
+      Serial.print("a-,");
124
+    }
125
+    //detect the winding status
126
+    if (tmc26XStepper.isOpenLoadB()) {
127
+      Serial.print("bo,");
128
+    } 
129
+    else if(tmc26XStepper.isShortToGroundB()) {
130
+      Serial.print("bg,");
131
+    } 
132
+    else {
133
+      Serial.print("b-,");
134
+    }
135
+    char temperature = tmc26XStepper.getOverTemperature();
136
+    if (temperature==0) {
137
+      Serial.print("x-,");
138
+    } 
139
+    else if (temperature==TMC26X_OVERTEMPERATURE_PREWARING) {
140
+      Serial.print("xw,");
141
+    } 
142
+    else {
143
+      Serial.print("xe,");
144
+    }
145
+    if (tmc26XStepper.isEnabled()) {
146
+      Serial.print("e1,");
147
+    } 
148
+    else {
149
+      Serial.print("e0,");
150
+    }
151
+    //write out the current chopper config
152
+    Serial.print("Cm");
153
+    Serial.print(chopperMode,DEC);
154
+    Serial.print(",Co");
155
+    Serial.print(t_off,DEC);
156
+    Serial.print(",Cb");
157
+    Serial.print(t_blank,DEC);
158
+    if (chopperMode==0) {
159
+      Serial.print(",Cs");
160
+      Serial.print(h_start,DEC);
161
+      Serial.print(",Ce");
162
+      Serial.print(h_end,DEC);
163
+      Serial.print(",Cd");
164
+      Serial.print(h_decrement,DEC);
165
+    }
166
+    Serial.print(',');
167
+    Serial.println();
168
+  }
169
+}
170
+
171
+void executeSerialCommand() {
172
+  Serial.print("Executing ");
173
+  Serial.println(inputBuffer);
174
+  //stimple runn & stop commands
175
+  switch(inputBuffer[0]) {
176
+  case 's':
177
+    running = 0;
178
+    break;
179
+  case 'r':
180
+    running = -1;
181
+    break;
182
+  case 'S':
183
+    {
184
+      int targetSpeed = decode(1);
185
+      setSpeed(targetSpeed);
186
+    }
187
+    break;
188
+  case 'm':
189
+    {
190
+      int microstepping = decode(1);
191
+      setMicrostepping(microstepping);
192
+    }
193
+    break;
194
+  case 't':
195
+    {
196
+      int threshold = decode(1);
197
+      setStallGuardThreshold(threshold);
198
+    }
199
+    break;
200
+  case 'f':
201
+    {
202
+      int filter = decode(1);
203
+      setStallGuardFilter(filter);
204
+    }
205
+    break;
206
+  case 'd':
207
+    {
208
+      int value = decode(1);
209
+      tmc26XStepper.stop();
210
+      if (value<0) {
211
+        direction=-1;
212
+      } 
213
+      else {
214
+        direction=1;
215
+      }
216
+    }
217
+    break;
218
+  case 'c':
219
+    {
220
+      int current = decode(1);
221
+      setCurrent(current);
222
+    }
223
+    break;
224
+  case 'e':
225
+    {
226
+      int enabled = decode(1);
227
+      if (enabled) {
228
+        tmc26XStepper.setEnabled(true);
229
+      } 
230
+      else {
231
+        tmc26XStepper.setEnabled(false);
232
+      }
233
+    }
234
+    break;
235
+  case 'C':
236
+    switch(inputBuffer[1]) {
237
+    case 'o':
238
+      {
239
+        int value = decode(2);
240
+        if (value>0 && value<16) {
241
+          t_off=value;
242
+          updateChopper();
243
+        }
244
+      }
245
+      break;
246
+    case 'b':
247
+      {
248
+        int value = decode(2);
249
+        if (value>=0 && value<=3) {
250
+          t_blank=value;
251
+          updateChopper();
252
+        }
253
+      }
254
+      break;
255
+    case 's':
256
+      {
257
+        int value = decode(2);
258
+        if (value>=0 && value<=8) {
259
+          h_start=value;
260
+          updateChopper();
261
+        }
262
+      }
263
+      break;
264
+    case 'e':
265
+      {
266
+        int value = decode(2);
267
+        if (value>=-3 && value<=12) {
268
+          h_end=value;
269
+          updateChopper();
270
+        }
271
+      }
272
+      break;
273
+    case 'd':
274
+      {
275
+        int value = decode(2);
276
+        if (value>=0 && value<=3) {
277
+          h_decrement=value;
278
+          updateChopper();
279
+        }
280
+      }
281
+      break;
282
+    }
283
+    break;
284
+  case 'K':
285
+    switch(inputBuffer[1]) {
286
+    case '+':
287
+      tmc26XStepper.setCoolStepEnabled(true);
288
+      break;
289
+    case '-':
290
+      tmc26XStepper.setCoolStepEnabled(false);
291
+      break;
292
+    case 'l':
293
+      {
294
+        int value = decode(2);
295
+        if (value>=0 && value<480) {
296
+          lower_SG_threshold=value;
297
+          updateCoolStep();
298
+        }
299
+      }
300
+      break;
301
+    case 'u':
302
+      {
303
+        int value = decode(2);
304
+        if (value>=0 && value<480) {
305
+          upper_SG_threshold=value;
306
+          updateCoolStep();
307
+        }
308
+      }
309
+      break;
310
+    case 'n':
311
+      {
312
+        int value = decode(2);
313
+        if (value>=0 && value<4) {
314
+          number_of_SG_readings=value;
315
+          updateCoolStep();
316
+        }
317
+      }
318
+      break;
319
+    case 'i':
320
+      {
321
+        int value = decode(2);
322
+        if (value>=0 && value<4) {
323
+          current_increment_step_size=value;
324
+          updateCoolStep();
325
+        }
326
+      }
327
+      break;
328
+    case 'm':
329
+      {
330
+        int value = decode(2);
331
+        if (value>=0 && value<2) {
332
+          lower_current_limit=value;
333
+          updateCoolStep();
334
+        }
335
+      }
336
+      break;
337
+    }
338
+    break;
339
+  }
340
+  //at the end delete buffer
341
+  inputBufferPosition=0;
342
+  inputBuffer[0]=0;
343
+}
344
+
345
+int decode(unsigned char startPosition) {
346
+  int result=0;
347
+  boolean negative = false;
348
+  if (inputBuffer[startPosition]=='-') {
349
+    negative=true;
350
+    startPosition++;
351
+  }
352
+  for (unsigned char i=startPosition; i< (INPUT_BUFFER_LENGTH+1) && inputBuffer[i]!=0; i++) {
353
+    char number = inputBuffer[i];
354
+    //this very dumb approac can lead to errors, but we expect only numbers after the command anyway
355
+    if (number <= '9' && number >='0') {
356
+      result *= 10;
357
+      result += number - '0';
358
+    } 
359
+  }
360
+  if (negative) {
361
+    return -result;
362
+  } 
363
+  else {
364
+    return result;
365
+  }
366
+}
367
+
368
+
369
+

+ 61
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/TMC26XMotorTester.ino View File

@@ -0,0 +1,61 @@
1
+/*
2
+ TMC26XMotorTest.ino - - TMC26X Stepper library Example for Wiring/Arduino
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+#include <SPI.h>
26
+#include <TMC26XStepper.h>
27
+
28
+//you may adapt this to your shield or breakout board connection
29
+#define CS_PIN 2
30
+#define DIR_PIN 6
31
+#define STEP_PIN 7
32
+#define ENABLE_PIN 8 //if it is not connected it won't be a problem
33
+
34
+
35
+#define TIMER_CLOCK_FREQ 2000000.0 //2MHz for /8 prescale from 16MHz
36
+#define INITIAL_CURRENT 500 //in mA
37
+#define MAX_SPEED 1000
38
+
39
+
40
+//we have a stepper motor with 200 steps per rotation, CS pin 2, dir pin 3, step pin 4 and a current of 300mA
41
+TMC26XStepper tmc26XStepper = TMC26XStepper(200,CS_PIN,DIR_PIN,STEP_PIN,INITIAL_CURRENT);
42
+char running;
43
+
44
+void setup() {
45
+  //configure the enable pin
46
+  pinMode(ENABLE_PIN, OUTPUT);
47
+  digitalWrite(ENABLE_PIN,HIGH);
48
+
49
+  startSerial();
50
+  startMotor();
51
+  //set this according to you stepper
52
+  Serial.println(F("started"));
53
+}
54
+
55
+void loop() {
56
+  loopSerial();
57
+  runMotor();
58
+}
59
+
60
+
61
+

+ 306
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/Arduino.pde View File

@@ -0,0 +1,306 @@
1
+/*
2
+ TMC26XMotorTest.pde - - TMC26X Stepper Tester for Processing
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+
26
+String channelAStatus=null;
27
+String channelBStatus=null;
28
+String temperatureStatus=null;
29
+boolean motor_connected = false;
30
+
31
+RadioButton serialButtons;
32
+Button serialOkButton;
33
+Button helpButton;
34
+Textarea statusArea;
35
+String[] ports;
36
+int activePortIndex = -1;
37
+
38
+String identString="TMC26X Stepper Driver Motor Tester";
39
+int connectTimeout=10*1000; //how long do we wait until the Arduino is connected
40
+
41
+StringBuilder serialStringBuilder = new StringBuilder();
42
+
43
+void setupSerialConfig() {
44
+  Tab defaultTab = controlP5.getTab("default");
45
+  //add the list of serial interfaces - it get's populated later
46
+  serialButtons = controlP5.addRadioButton("serialport", 200, 100+TMCLogo.height*2+50);
47
+  serialConfigElements.add(serialButtons);
48
+  serialButtons.captionLabel().set("Select Serial Port");
49
+  serialButtons.showBar();
50
+  serialButtons.moveTo(defaultTab);
51
+  //ad the ok button
52
+  serialOkButton = controlP5.addButton("serialOk", 1, 200, height-300, 30, 30);
53
+  serialConfigElements.add(serialOkButton);
54
+  serialOkButton.setCaptionLabel("OK");
55
+  runToggle.moveTo(defaultTab);
56
+  //add the status area
57
+  statusArea = controlP5.addTextarea("statusArea","",200,height-250,300,50);
58
+  serialConfigElements.add(statusArea);
59
+  statusArea.moveTo(defaultTab);
60
+  
61
+  helpButton =  controlP5.addButton("help", 1, 200, height-250, 80, 30);
62
+  serialConfigElements.add(helpButton);
63
+  helpButton.moveTo(defaultTab);
64
+  
65
+
66
+  //finally update the list of serial ports
67
+  updateSerialPortList();
68
+}
69
+
70
+void updateSerialPortList() {
71
+  //first remove all present serial ports
72
+  List items = serialButtons.getItems();
73
+  for (Object i:items) {
74
+    Toggle item = (Toggle) i;
75
+    serialButtons.removeItem(item.getName());
76
+  }
77
+  //add the serial ports
78
+  ports = Serial.list();
79
+  for (int i=0; i< ports.length; i++) {
80
+    serialButtons.addItem(ports[i],i);
81
+  }
82
+  serialButtons.setValue(-1);
83
+  serialOkButton.setVisible(false);
84
+}
85
+
86
+void serialport(int value) {
87
+  //ok button is only active if a serial port is selected
88
+  serialOkButton.setVisible(value>-1);
89
+  if (value>-1) {
90
+    statusArea.setText("");
91
+  }
92
+  activePortIndex = value;
93
+}
94
+
95
+void serialOk(int value) {
96
+  String error = null;
97
+  if (value!=0 && activePortIndex>-1) {
98
+    try {
99
+      arduinoPort = new Serial(this, ports[activePortIndex], 115200);
100
+      int timeStarted = millis();
101
+      StringBuilder identBuffer = new StringBuilder();
102
+      while (!motor_connected && (millis()-timeStarted)<connectTimeout) {
103
+        if (arduinoPort.available ()>0) {
104
+          char c = arduinoPort.readChar();
105
+          identBuffer.append(c);
106
+          if (c=='\n') {
107
+            if (identString.contains(identString)) {
108
+              motor_connected = true;
109
+              toggleUi(true);
110
+              return;
111
+            }
112
+            identBuffer = new StringBuilder();
113
+          }
114
+        } 
115
+      }
116
+    } catch (RuntimeException e) {
117
+      //we simply do nothing
118
+      //TODO set status label
119
+      error = "There was a problem with serial port "+ports[activePortIndex]+": "+e.getMessage();
120
+    }
121
+    //ok appearantly we did not find an motor tester - so lets deselect that port
122
+    if (error == null) {
123
+      error = "Could not find TMC26XMotorTester on serial port "+ports[activePortIndex];
124
+    }
125
+    statusArea.setText(error);
126
+    Toggle selected = serialButtons.getItem(activePortIndex);
127
+    selected.setState(false);
128
+    serialOkButton.setVisible(false);
129
+  }
130
+}
131
+
132
+
133
+void decodeSerial() {
134
+  if (motor_connected) {
135
+    while (arduinoPort.available ()>0) {
136
+      char c = arduinoPort.readChar();
137
+      serialStringBuilder.append(c);
138
+      if (c=='\n') {
139
+        decodeSerial(serialStringBuilder.toString());
140
+        serialStringBuilder = new StringBuilder();
141
+      }
142
+    }
143
+  }
144
+}
145
+
146
+void sendCommand(String command) {
147
+  if (motor_connected) {
148
+    arduinoPort.write(command+"\n");
149
+  }
150
+}
151
+
152
+void decodeSerial(String line) {
153
+  settingStatus=true;
154
+  if (line.startsWith("#")) {
155
+    String status = line.substring(1);
156
+    StringTokenizer statusTokenizer = new StringTokenizer(status, ",");
157
+    while (statusTokenizer.hasMoreTokens ()) {
158
+      String statusToken = statusTokenizer.nextToken();
159
+      if ("s".equals(statusToken)) {
160
+        runToggle.setValue(0);
161
+      } 
162
+      else if ("r".equals(statusToken)) {
163
+        runToggle.setValue(1);
164
+      } 
165
+      else if (statusToken.startsWith("e")) {
166
+        int enabled = getValueOfToken(statusToken, 1);
167
+        if (enabled!=0) {
168
+          enabledToggle.setValue(1);
169
+        } 
170
+        else {
171
+          enabledToggle.setValue(0);
172
+        }
173
+      }
174
+      else if (statusToken.startsWith("S")) {
175
+        speedSlider.setValue(getValueOfToken(statusToken, 1));
176
+      } 
177
+      else if (statusToken.startsWith("m")) {
178
+        microsteppingButtons.activate("m_1/"+String.valueOf(getValueOfToken(statusToken, 1)));
179
+      } 
180
+      else if (statusToken.startsWith("sg")) {
181
+        addStallGuardReading(getValueOfToken(statusToken, 2));
182
+      } 
183
+      else if (statusToken.startsWith("p")) {
184
+        addPositionReading(getValueOfToken(statusToken, 1));
185
+      } 
186
+      else if (statusToken.startsWith("k")) {
187
+        addCurrentReading(getValueOfToken(statusToken, 1));
188
+      } 
189
+      else if (statusToken.startsWith("t")) {
190
+        sgtSlider.setValue(getValueOfToken(statusToken, 1));
191
+      } 
192
+      else if (statusToken.startsWith("f")) {
193
+        sgFilterToggle.setValue(getValueOfToken(statusToken, 1));
194
+      } 
195
+      else if (statusToken.startsWith("d")) {
196
+        setDirection(getValueOfToken(statusToken, 1));
197
+      }
198
+      else if (statusToken.startsWith("c")) {
199
+        setCurrent(getValueOfToken(statusToken, 1));
200
+      } 
201
+      else if (statusToken.startsWith("a")) {
202
+        if (statusToken.charAt(1)=='o') {
203
+          channelAStatus="Open Load";
204
+        } 
205
+        else if (statusToken.charAt(1)=='g') {
206
+          channelAStatus="Short to Ground!";
207
+        } 
208
+        else {
209
+          channelAStatus=null;
210
+        }
211
+      } 
212
+      else if (statusToken.startsWith("b")) {
213
+        if (statusToken.charAt(1)=='o') {
214
+          channelBStatus="Open Load";
215
+        } 
216
+        else if (statusToken.charAt(1)=='g') {
217
+          channelBStatus="Short to Ground!";
218
+        } 
219
+        else {
220
+          channelBStatus=null;
221
+        }
222
+      } 
223
+      else if (statusToken.startsWith("x")) {
224
+        if (statusToken.charAt(1)=='w') {
225
+          temperatureStatus="Prewarning!";
226
+        } 
227
+        else if (statusToken.charAt(1)=='e') {
228
+          temperatureStatus="Error";
229
+        } 
230
+        else {
231
+          temperatureStatus=null;
232
+        }
233
+      }
234
+      else if (statusToken.startsWith("Cm")) {
235
+        //chopper mode is currently ignored
236
+      } 
237
+      else if (statusToken.startsWith("Co")) {
238
+        constantOffSlider.setValue(getValueOfToken(statusToken, 2));
239
+      }  
240
+      else if (statusToken.startsWith("Cb")) {
241
+        blankTimeSlider.setValue(getValueOfToken(statusToken, 2));
242
+      } 
243
+      else if (statusToken.startsWith("Cs")) {
244
+        hysteresisStartSlider.setValue(getValueOfToken(statusToken, 2));
245
+      } 
246
+      else if (statusToken.startsWith("Ce")) {
247
+        hysteresisEndSlider.setValue(getValueOfToken(statusToken, 2));
248
+      } 
249
+      else if (statusToken.startsWith("Cd")) {
250
+        setHystDecrement(getValueOfToken(statusToken, 2));
251
+      } 
252
+      else if ("Ke+".equals(statusToken)) {
253
+        coolStepActiveToggle.setValue(1);
254
+      } 
255
+      else if ("Ke-".equals(statusToken)) {
256
+        coolStepActiveToggle.setValue(0);
257
+      } 
258
+      else if (statusToken.startsWith("Kl")) {
259
+        coolStepMinSlider.setValue(getValueOfToken(statusToken, 2));
260
+      } 
261
+      else if (statusToken.startsWith("Ku")) {
262
+        coolStepMaxSlider.setValue(getValueOfToken(statusToken, 2));
263
+      }
264
+      else if (statusToken.startsWith("Kn")) {
265
+        coolStepDecrementButtons.activate(getValueOfToken(statusToken, 2));
266
+      } 
267
+      else if (statusToken.startsWith("Ki")) {
268
+        coolStepIncrementButtons.activate(getValueOfToken(statusToken, 2));
269
+      }
270
+      else if (statusToken.startsWith("Km")) {
271
+        coolStepMinButtons.activate(getValueOfToken(statusToken, 2));
272
+      }
273
+    }
274
+  }
275
+  else {
276
+    println(line);
277
+  }
278
+  settingStatus=false;
279
+}
280
+
281
+int getValueOfToken(String token, int position) {
282
+  String value = token.substring(position);
283
+  try {
284
+    return Integer.valueOf(value);
285
+  } 
286
+  catch (NumberFormatException e) {
287
+    println("Unable to decode '"+value+"'of '"+token+"' !");
288
+    return 0;
289
+  }
290
+}
291
+
292
+void drawSerial() {
293
+  //draw the logo and some epxlaining text while setting up the serial port
294
+  if (!motor_connected) {
295
+    image(TMCLogo,200, 100);
296
+    fill(uiTextColor);
297
+    text("Select the serial port where your Arduino is connected\nIf in doubt check it in the Arduino IDE.\nThe Motor Tester will automatically verify if it can find an Motor tester ath the port.",200,100+TMCLogo.height+50);
298
+  }
299
+}
300
+
301
+void help(float value) {
302
+  if (value!=0) {
303
+    link(helpUrl);
304
+  }
305
+}
306
+

+ 175
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/ChopperConfiguration.pde View File

@@ -0,0 +1,175 @@
1
+/*
2
+ TMC26XMotorTest.pde - - TMC26X Stepper Tester for Processing
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+
26
+Slider constantOffSlider;
27
+Slider blankTimeSlider;
28
+Toggle randomOffTimeToggle;
29
+RadioButton ChopperModeButtons;
30
+//for constant off time chopeer
31
+Slider fastDecaySlider;
32
+Slider sineWaveOffsetSlider;
33
+Toggle currentComparatorToggle;
34
+//for spread chopper
35
+Slider hysteresisStartSlider;
36
+Slider hysteresisEndSlider;
37
+Numberbox motorVoltageBox;
38
+Numberbox motorCurrentBox;
39
+Numberbox motorResistanceBox;
40
+Numberbox motorInductanceBox;
41
+
42
+RadioButton hysteresisDecrementButtons;
43
+
44
+PImage spreadChopperImage;
45
+
46
+void setupChooperConfig() {
47
+  //add input fields for the various motor parameters
48
+  motorVoltageBox = controlP5.addNumberbox("motorvoltage",12.0,20,40,100,20);
49
+  motorVoltageBox.setCaptionLabel("Motor Voltage (V)");
50
+  motorVoltageBox.setMultiplier(0.025);
51
+  motorVoltageBox.setMin(0);
52
+  motorVoltageBox.setMax(40.0);
53
+  motorVoltageBox.moveTo(configureTab);
54
+  
55
+  motorCurrentBox = controlP5.addNumberbox("motorcurrent",0.5,140,40,100,20);
56
+  motorCurrentBox.setCaptionLabel("Motor Current (A)");
57
+  motorCurrentBox.setMultiplier(0.025);
58
+  motorCurrentBox.setMin(0.46);
59
+  motorCurrentBox.setMax(1.7);
60
+  motorCurrentBox.moveTo(configureTab);
61
+  
62
+  motorResistanceBox = controlP5.addNumberbox("motorresistance",2,260,40,100,20);
63
+  motorResistanceBox.setCaptionLabel("Motor Resistance (Ohm)");
64
+  motorResistanceBox.setMultiplier(0.1);
65
+  motorResistanceBox.setMin(0);
66
+  motorResistanceBox.setMax(250);
67
+  motorResistanceBox.moveTo(configureTab);
68
+  
69
+  motorInductanceBox = controlP5.addNumberbox("motorinductance",2,380,40,100,20);
70
+  motorInductanceBox.setMultiplier(0.1);
71
+  motorInductanceBox.setMin(0);
72
+  motorInductanceBox.setMax(250);
73
+  motorInductanceBox.setCaptionLabel("Motor Inductance (mH)");
74
+  motorInductanceBox.moveTo(configureTab);
75
+  // add a vertical slider for speed  
76
+  constantOffSlider = controlP5.addSlider("constantoff", 1, 15, 1, 20, 80, 400, 20);
77
+  constantOffSlider.setCaptionLabel("Constant Off Time");
78
+  constantOffSlider.setSliderMode(Slider.FIX);
79
+  constantOffSlider.moveTo(configureTab);
80
+
81
+  blankTimeSlider =  controlP5.addSlider("blanktime", 0, 3, 2, 20, 120, 400, 20);
82
+  blankTimeSlider.setCaptionLabel("Blank Time");
83
+  blankTimeSlider.moveTo(configureTab);
84
+
85
+  hysteresisStartSlider =  controlP5.addSlider("hysteresisstart", 0, 8, 2, 20, 160, 400, 20);
86
+  hysteresisStartSlider.setCaptionLabel("Hysteresis Start");
87
+  hysteresisStartSlider.moveTo(configureTab);
88
+
89
+  hysteresisEndSlider =  controlP5.addSlider("hysteresisend", -3, 12, 2, 20, 200, 400, 20);
90
+  hysteresisEndSlider.setCaptionLabel("Hysteresis End");
91
+  hysteresisEndSlider.moveTo(configureTab);
92
+
93
+  hysteresisDecrementButtons =controlP5.addRadioButton("decrement", 20, 240);
94
+  hysteresisDecrementButtons.addItem("fastest", 0);
95
+  hysteresisDecrementButtons.addItem("fast", 1);
96
+  hysteresisDecrementButtons.addItem("medium", 2);
97
+  hysteresisDecrementButtons.addItem("slow", 3);
98
+  hysteresisDecrementButtons.showBar();
99
+  hysteresisDecrementButtons.moveTo(configureTab);
100
+
101
+  spreadChopperImage = loadImage("hysteresis.png");
102
+}
103
+
104
+void drawChopper() {
105
+  if (activeTab!=null && configureTab.equals(activeTab)) {
106
+    image(spreadChopperImage, 200, 400);
107
+  }
108
+}
109
+
110
+void constantoff(int theValue) {
111
+  if (!settingStatus) {
112
+    if (theValue>0 && theValue<16) {
113
+      println("Constant off "+theValue);
114
+      sendCommand("cO"+theValue);
115
+    } 
116
+    else {
117
+      println("invalid blank time of "+theValue);
118
+    }
119
+  }
120
+}
121
+
122
+void blanktime(int theValue) {
123
+  if (!settingStatus) {
124
+    if (theValue>=0 && theValue<=3) {
125
+      println("blank time "+theValue);
126
+      sendCommand("Cb"+theValue);
127
+    }
128
+  }
129
+}
130
+
131
+void hysteresisstart(int start) {
132
+  if (!settingStatus) {
133
+    if (start>=1 && start<=8) {
134
+      println("hystereis start "+start);
135
+      sendCommand("Cs"+start);
136
+    }
137
+  }
138
+}
139
+
140
+void hysteresisend(int end) {
141
+  if (!settingStatus) {
142
+    if (end>=-3 && end<=12) {
143
+      println("hystereis end "+end);
144
+      sendCommand("Ce"+end);
145
+    }
146
+  }
147
+}
148
+
149
+void setHysteresisDecrement(int theValue) {
150
+  if (!settingStatus) {
151
+    if (theValue>=0 && theValue<=3) {
152
+      println("Hysteresis decrement "+theValue);
153
+      sendCommand("Cd"+theValue);
154
+    } 
155
+    else {
156
+      println("cannot set decrement to "+theValue);
157
+    }
158
+  }
159
+}
160
+
161
+void setHystDecrement(int value) {
162
+  if (value>=0 && value<=3) {
163
+    hysteresisDecrementButtons.activate(value);
164
+  } 
165
+  else {
166
+    println("this is no proper hysteresis decerement value: "+value);
167
+  }
168
+}
169
+
170
+void motorcurrent(float value) {
171
+  if (activeTab!=null && "default".equals(activeTab.name())) {
172
+    currentSlider.setValue(value);
173
+  }
174
+}
175
+

+ 327
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/DataRendering.pde View File

@@ -0,0 +1,327 @@
1
+/*
2
+ TMC26XMotorTest.pde - - TMC26X Stepper Tester for Processing
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+
26
+//our graph dimensions
27
+int plotBottom, plotTop;
28
+int plotLeft, plotRight;
29
+
30
+
31
+//we already know the minima and maxima of certain dates
32
+int stallGuardMin =  0;
33
+int stallGuardMax =1024;
34
+
35
+int positionMin = 0;
36
+int positionMax = 1024;
37
+
38
+int dataPointsWidth = 3;
39
+int dataLineWidth = 2;
40
+int highLightWidth = 7;
41
+
42
+int numberOfDataPoints=1000;
43
+
44
+int legendTitleSize = 10;
45
+int legendTextSize = 10;
46
+int currentLabelInterval = 500;
47
+int currentMinorTickInterval = 25;
48
+DecimalFormat currentLabelFormat = new DecimalFormat("#0.0A");
49
+
50
+int stallGuardLabelInterval = 100;
51
+int stallGuardMinorTickInterval = 10;
52
+int positionLabelInterval = 64;
53
+int positionMinorTickInterval = 8;
54
+
55
+int coolStepActiveStroke = 2;
56
+int coolStepInactiveStroke = 1;
57
+int stallGuardHighLightDistance = 1;
58
+int positionHighLightDistance = 3;
59
+int currentHighLightDistance = 3;
60
+
61
+DataTable stallGuardTable = new DataTable(numberOfDataPoints);
62
+DataTable positionTable = new DataTable(numberOfDataPoints);
63
+DataTable currentTable =  new DataTable(numberOfDataPoints);
64
+
65
+int logoLeft = 10;
66
+int logoTop = 50;
67
+int logoWidth = 75;
68
+int logoHeight = 75;
69
+
70
+void setupData() {
71
+  plotBottom = height-50;
72
+  plotTop = 300;
73
+
74
+  plotLeft = 150;
75
+  plotRight= width-50;
76
+  //recalculate the image dimension for the Logo
77
+  logoHeight = (int)((float)logoWidth/(float)TMCLogo.width*(float)TMCLogo.height);
78
+  logoTop = height - 10 - logoHeight;
79
+}
80
+
81
+void drawData() {
82
+
83
+  if (motor_connected && activeTab!=null && runTab.equals(activeTab)) {
84
+    fill(diagramBackgroundColor);
85
+    noStroke();
86
+    rect(plotLeft, plotTop, plotRight, plotBottom);
87
+    noFill();
88
+    rectMode(CORNERS);
89
+    noStroke();
90
+    //rect(plotLeft, plotBottom, plotRight, plotTop);
91
+
92
+    strokeWeight(dataLineWidth);
93
+    stroke(positionColor);
94
+    drawDataLine(positionTable, positionMin, positionMax);
95
+    drawDataHighLight(positionTable, positionMin, positionMax, positionHighLightDistance, labelColor, "Microstep Position", false);
96
+
97
+    strokeWeight(dataLineWidth);
98
+    stroke(coolStepColor);
99
+    drawCurrentLine(currentTable);
100
+    drawCurrentHighLight(positionTable, currentHighLightDistance, labelColor, "Current Ratio", false);
101
+
102
+    strokeWeight(dataPointsWidth);
103
+    stroke(stallGuardColor);
104
+    drawDataPoints(stallGuardTable, stallGuardMin, stallGuardMax);
105
+    drawDataHighLight(stallGuardTable, stallGuardMin, stallGuardMax, stallGuardHighLightDistance, labelColor, "Stall Guard", true);
106
+    
107
+    if (coolStepActive) {
108
+      strokeWeight(coolStepActiveStroke); 
109
+    } else {
110
+      strokeWeight(coolStepInactiveStroke);
111
+    }
112
+    stroke(coolStepColor);
113
+    float coolStepMinHeight = map(coolStepMin, 0, stallGuardMax, plotBottom, plotTop);
114
+    line(plotLeft,coolStepMinHeight, plotRight, coolStepMinHeight);
115
+    float coolStepMaxHeight = map(coolStepMin+coolStepMax+1, 0, stallGuardMax, plotBottom, plotTop);
116
+    line(plotLeft,coolStepMaxHeight, plotRight, coolStepMaxHeight);
117
+
118
+    textSize(legendTitleSize);
119
+    textAlign(RIGHT);
120
+    fill(coolStepColor);
121
+    text("Motor Current", plotLeft - 50, plotTop - 10);
122
+    textSize(legendTextSize);
123
+    textAlign(RIGHT);
124
+    strokeWeight(1);
125
+    stroke(coolStepColor);
126
+    int currentScaleMax = (int)(maxCurrent*1000.0);
127
+    for (int i=0; i<=currentScaleMax; i++) {
128
+      float y = map(i, 0, currentScaleMax, plotBottom, plotTop);
129
+      if (i % currentLabelInterval == 0) {
130
+        if (i==0) {
131
+          textAlign(RIGHT, BOTTOM);
132
+        } 
133
+        else if (i==currentScaleMax) {
134
+          textAlign(RIGHT, TOP);
135
+        } 
136
+        else {
137
+          textAlign(RIGHT, CENTER);
138
+        }        
139
+        text(currentLabelFormat.format((float)i/1000.0), plotLeft-58, y);
140
+        line (plotLeft-55, y, plotLeft-50, y);
141
+      } 
142
+      else if (i % currentMinorTickInterval == 0) {
143
+        line (plotLeft-53, y, plotLeft-50, y);
144
+      }
145
+      
146
+    }
147
+
148
+    textSize(legendTitleSize);
149
+    textAlign(LEFT);
150
+    fill(stallGuardColor);
151
+    text("Stall Guard Reading", plotLeft - 30, plotTop - 10);
152
+    textSize(legendTextSize);
153
+    textAlign(RIGHT);
154
+    strokeWeight(1);
155
+    stroke(stallGuardColor);
156
+    for (int i=stallGuardMin; i<=stallGuardMax; i++) {
157
+      float y = map(i, stallGuardMin, stallGuardMax, plotBottom, plotTop);
158
+      if (i % stallGuardLabelInterval == 0) {
159
+        if (i==stallGuardMin) {
160
+          textAlign(RIGHT, BOTTOM);
161
+        } 
162
+        else if (i==stallGuardMax) {
163
+          textAlign(RIGHT, TOP);
164
+        } 
165
+        else {
166
+          textAlign(RIGHT, CENTER);
167
+        }        
168
+        text(i, plotLeft-8, y);
169
+        line (plotLeft-5, y, plotLeft, y);
170
+      } 
171
+      else if (i % stallGuardMinorTickInterval == 0) {
172
+        line (plotLeft-3, y, plotLeft, y);
173
+      }
174
+    }
175
+
176
+    textSize(legendTitleSize);
177
+    fill(positionColor);
178
+    textAlign(RIGHT);
179
+    text("Position", plotRight + 30, plotTop - 10);
180
+    textSize(legendTextSize);
181
+    textAlign(LEFT);
182
+    strokeWeight(1);
183
+    stroke(positionColor);
184
+    for (int i=positionMin; i<=positionMax; i++) {
185
+      float y = map(i, positionMin, positionMax, plotBottom, plotTop);
186
+      if (i % positionLabelInterval == 0) {
187
+        if (i==positionMin) {
188
+          textAlign(LEFT, BOTTOM);
189
+        } 
190
+        else if (i==stallGuardMax) {
191
+          textAlign(LEFT, TOP);
192
+        } 
193
+        else {
194
+          textAlign(LEFT, CENTER);
195
+        }        
196
+        text(i, plotRight+8, y);
197
+        line (plotRight, y, plotRight+5, y);
198
+      } 
199
+      else if (i % positionMinorTickInterval == 0) {
200
+        line (plotRight, y, plotRight+3, y);
201
+      }
202
+    }
203
+    //draw the channel status
204
+    textSize(legendTextSize);
205
+    textAlign(CENTER);
206
+    strokeWeight(1);
207
+    int statusY = height - 20;
208
+    int channelAX = width/4;
209
+    int temperatureX = width/2;
210
+    int channelBX = width/4*3;
211
+    if (channelAStatus==null) {
212
+      fill(goodStatusColor);
213
+      text("Channel A: OK", channelAX, statusY);
214
+    } 
215
+    else {
216
+      fill(badStatusColor);
217
+      text("Channel A: "+channelAStatus, channelAX, statusY);
218
+    }    
219
+    if (channelBStatus==null) {
220
+      fill(goodStatusColor);
221
+      text("Channel B: OK", channelBX, statusY);
222
+    } 
223
+    else {
224
+      fill(badStatusColor);
225
+      text("Channel B: "+channelBStatus, channelBX, statusY);
226
+    }    
227
+    if (temperatureStatus==null) {
228
+      fill(goodStatusColor);
229
+      text("Temperature: OK", temperatureX, statusY);
230
+    } 
231
+    else {
232
+      fill(badStatusColor);
233
+      text("Temperature: "+temperatureStatus, temperatureX, statusY);
234
+    }
235
+  }
236
+}
237
+void drawDataPoints(DataTable table, int minValue, int maxValue) {
238
+  int dataCount = table.getSize();
239
+  for (int i=0; i<dataCount; i++) {
240
+    int value = table.getEntry(i);
241
+    float x = map(i, 0, numberOfDataPoints-1, plotLeft+dataPointsWidth, plotRight-dataPointsWidth);
242
+    float y = map(value, minValue, maxValue, plotBottom-dataPointsWidth, plotTop+dataPointsWidth);
243
+    point(x, y);
244
+  }
245
+}
246
+
247
+void drawDataLine(DataTable table, int minValue, int maxValue) {
248
+  beginShape();
249
+  int dataCount = table.getSize();
250
+  for (int i=0; i<dataCount; i++) {
251
+    int value = table.getEntry(i);
252
+    float x = map(i, 0, numberOfDataPoints-1, plotLeft+dataPointsWidth, plotRight-dataPointsWidth);
253
+    float y = map(value, minValue, maxValue, plotBottom-dataPointsWidth, plotTop+dataPointsWidth);
254
+    vertex(x, y);
255
+  }
256
+  endShape();
257
+}
258
+
259
+void drawDataHighLight(DataTable table, int minValue, int maxValue, int distance, color textColor, String name, boolean top) {
260
+  int dataCount = table.getSize();
261
+  for (int i=0; i<dataCount; i++) {
262
+    int value = table.getEntry(i);
263
+    float x = map(i, 0, numberOfDataPoints-1, plotLeft+dataPointsWidth, plotRight-dataPointsWidth);
264
+    float y = map(value, minValue, maxValue, plotBottom-dataPointsWidth, plotTop+dataPointsWidth);
265
+    if (dist(mouseX, mouseY, x, y) < distance) {
266
+      strokeWeight(highLightWidth);
267
+      point(x, y);
268
+      fill(textColor);
269
+      textSize(10);
270
+      textAlign(CENTER);
271
+      if (top) {
272
+        text(name+": "+value, x, y-8);
273
+      } 
274
+      else {
275
+        text(name+": "+value, x, y+8);
276
+      }
277
+    }
278
+  }
279
+}
280
+
281
+void drawCurrentLine(DataTable table) {
282
+  noFill();
283
+  beginShape();
284
+  int dataCount = table.getSize();
285
+  for (int i=0; i<dataCount; i++) {
286
+    float value = (table.getEntry(i)+1)/1000.0;
287
+    float x = map(i, 0, numberOfDataPoints-1, plotLeft+dataPointsWidth, plotRight-dataPointsWidth);
288
+    float y = map(value, 0.0, maxCurrent, (float)plotBottom-dataPointsWidth, (float)plotTop+dataPointsWidth);
289
+    vertex(x, y);
290
+  }
291
+  endShape();
292
+}
293
+
294
+void drawCurrentHighLight(DataTable table, int distance, color textColor, String name, boolean top) {
295
+  int dataCount = table.getSize();
296
+  for (int i=0; i<dataCount; i++) {
297
+    float value = (table.getEntry(i)+1)/1000.0;
298
+    float x = map(i, 0, numberOfDataPoints-1, plotLeft+dataPointsWidth, plotRight-dataPointsWidth);
299
+    float y = map(value, 0.0, maxCurrent, plotBottom-dataPointsWidth, plotTop+dataPointsWidth);
300
+    if (dist(mouseX, mouseY, x, y) < distance) {
301
+      strokeWeight(highLightWidth);
302
+      point(x, y);
303
+      fill(textColor);
304
+      textSize(10);
305
+      textAlign(CENTER);
306
+      if (top) {
307
+        text(name+": "+value, x, y-8);
308
+      } 
309
+      else {
310
+        text(name+": "+value, x, y+8);
311
+      }
312
+    }
313
+  }
314
+}
315
+
316
+void addStallGuardReading(int value) {
317
+  stallGuardTable.addData(value);
318
+}
319
+
320
+void addPositionReading(int value) {
321
+  positionTable.addData(value);
322
+}
323
+
324
+void addCurrentReading(int value) {
325
+  currentTable.addData(value);
326
+}
327
+

+ 49
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/DataTable.pde View File

@@ -0,0 +1,49 @@
1
+/*
2
+ TMC26XMotorTest.pde - - TMC26X Stepper Tester for Processing
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+
26
+class DataTable {
27
+  
28
+  LinkedList<Integer> dataList = new LinkedList<Integer>();
29
+  int maxEntries;
30
+  
31
+  DataTable(int maxEntries) {
32
+    this.maxEntries = maxEntries;
33
+  }
34
+  
35
+  void addData(int value) {
36
+    dataList.add(value);
37
+    if (dataList.size()>maxEntries) {
38
+      dataList.remove();
39
+    }
40
+  }
41
+  
42
+  int getSize() {
43
+    return dataList.size();
44
+  }
45
+  
46
+  int getEntry(int position) {
47
+    return dataList.get(position);
48
+  }
49
+}

+ 335
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/RunConfiguration.pde View File

@@ -0,0 +1,335 @@
1
+/*
2
+ TMC26XMotorTest.pde - - TMC26X Stepper Tester for Processing
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+
26
+Slider speedSlider;
27
+Toggle runToggle;
28
+RadioButton directionButtons;
29
+Toggle enabledToggle;
30
+RadioButton microsteppingButtons;
31
+Slider sgtSlider;
32
+Button sgtPlus;
33
+Button sgtMinus;
34
+Toggle sgFilterToggle;
35
+Slider currentSlider;
36
+Slider coolStepMinSlider;
37
+Slider coolStepMaxSlider;
38
+Toggle coolStepActiveToggle;
39
+RadioButton coolStepIncrementButtons;
40
+RadioButton coolStepDecrementButtons;
41
+RadioButton coolStepMinButtons;
42
+List runControls = new LinkedList();
43
+
44
+Button trinamicButton;
45
+Button motionControlButton;
46
+
47
+void setupRunConfig() {
48
+  //the run configuration
49
+  //controlP5.getControlFont().setSize(10); - the font is too small, try to increase it!
50
+  //add a button te let the motor run
51
+  runToggle = controlP5.addToggle("run", false, 20, 40, 30, 30);
52
+  controlElements.add(runToggle);
53
+  runToggle.moveTo(runTab);
54
+  //add some directions buttons
55
+  directionButtons = controlP5.addRadioButton("direction", 20, 90);
56
+  controlElements.add(directionButtons);
57
+  directionButtons.addItem("forward", 1);
58
+  directionButtons.addItem("backward", -1);
59
+  directionButtons.activate(0);
60
+  directionButtons.moveTo(runTab);
61
+  enabledToggle = controlP5.addToggle("enabled", false, 20, 220, 30, 30);
62
+  controlElements.add(enabledToggle);
63
+  enabledToggle.moveTo(runTab);
64
+
65
+  // add a vertical slider for speed  
66
+  speedSlider = controlP5.addSlider("speed", 1, 100, 10, 85, 40, 20, 210);
67
+  controlElements.add(speedSlider);
68
+  speedSlider.moveTo(runTab);
69
+
70
+  //ad a multilist for the microstepping setting
71
+  microsteppingButtons = controlP5.addRadioButton("microstepping", 150, 40);
72
+  controlElements.add(microsteppingButtons);
73
+  microsteppingButtons.addItem("m_1/1", 1);
74
+  microsteppingButtons.addItem("m_1/2", 2);
75
+  microsteppingButtons.addItem("m_1/4", 4);
76
+  microsteppingButtons.addItem("m_1/8", 8);
77
+  microsteppingButtons.addItem("m_1/16", 16);
78
+  microsteppingButtons.addItem("m_1/32", 32);
79
+  microsteppingButtons.addItem("m_1/64", 64);
80
+  microsteppingButtons.addItem("m_1/128", 128);
81
+  microsteppingButtons.addItem("m_1/256", 256);
82
+  for (Object o:microsteppingButtons.getItems()) {
83
+    Toggle t = (Toggle) o;
84
+    t.setCaptionLabel(t.getName().substring(2));
85
+  }
86
+  microsteppingButtons.showBar();
87
+  microsteppingButtons.moveTo(runTab);
88
+
89
+
90
+
91
+  currentSlider = controlP5.addSlider("current", 0.46, maxCurrent, 0.4, 250, 40, 20, 210);
92
+  controlElements.add(currentSlider);
93
+  currentSlider.moveTo(runTab);
94
+
95
+  // add a vertical slider for stallGuard threshold  
96
+  sgtPlus = controlP5.addButton("sgtplus", 0, 400, 40, 20, 20);
97
+  controlElements.add(sgtPlus);
98
+  sgtPlus.setCaptionLabel("+");
99
+  sgtPlus.moveTo(runTab);
100
+  sgtMinus = controlP5.addButton("sgtminus", 1, 400, 70, 20, 20);
101
+  controlElements.add(sgtMinus);
102
+  sgtMinus.setCaptionLabel("-");
103
+  sgtMinus.moveTo(runTab);
104
+  sgtSlider = controlP5.addSlider("stallguardthreshold", -64, 63, 0, 350, 40, 20, 150);
105
+  controlElements.add(sgtSlider);
106
+  sgtSlider.setSliderMode(Slider.FIX);
107
+  sgtSlider.setCaptionLabel("Stall Guard Threshold");
108
+  sgtSlider.moveTo(runTab);
109
+  //ading some buttons to have finer sg control
110
+  //adding a button for the filter
111
+  sgFilterToggle = controlP5.addToggle("sgfilter", false, 350, 220, 30, 30);
112
+  controlElements.add(sgFilterToggle);
113
+  sgFilterToggle.setCaptionLabel("Stall GuardFilter");
114
+  sgFilterToggle.moveTo(runTab);
115
+  
116
+  //add the coolstep sliders
117
+  coolStepMaxSlider = controlP5.addSlider("coolStepUpper", 0, 480, 0, 500, 40, 20, 90);
118
+  controlElements.add(coolStepMaxSlider);
119
+  coolStepMaxSlider.setCaptionLabel("Cool Step Hysteresis");
120
+  coolStepMaxSlider.moveTo(runTab);
121
+
122
+  coolStepMinSlider = controlP5.addSlider("coolStepLower", 0, 480, 0, 500, 160, 20, 90);
123
+  controlElements.add(coolStepMinSlider);
124
+  coolStepMinSlider.setCaptionLabel("Cool Step Minimum");
125
+  coolStepMinSlider.moveTo(runTab);
126
+  
127
+  coolStepActiveToggle = controlP5.addToggle("coolStepActive", false, 600, 220, 30, 30);  
128
+  controlElements.add(coolStepActiveToggle);
129
+  coolStepActiveToggle.setCaptionLabel("Enable CoolStep");
130
+  coolStepActiveToggle.moveTo(runTab);
131
+
132
+  coolStepIncrementButtons = controlP5.addRadioButton("coolStepIncrement", 600, 40);
133
+  controlElements.add(coolStepIncrementButtons);
134
+  coolStepIncrementButtons.captionLabel().set("Cool Step  Increment");
135
+  coolStepIncrementButtons.addItem("i_1", 0);
136
+  coolStepIncrementButtons.addItem("i_2", 1);
137
+  coolStepIncrementButtons.addItem("i_4", 2);
138
+  coolStepIncrementButtons.addItem("i_8", 3);
139
+  for (Object o:coolStepIncrementButtons.getItems()) {
140
+    Toggle t = (Toggle) o;
141
+    t.setCaptionLabel(t.getName().substring(2));
142
+  }
143
+  coolStepIncrementButtons.showBar();
144
+  coolStepIncrementButtons.moveTo(runTab);
145
+
146
+  coolStepDecrementButtons = controlP5.addRadioButton("coolStepDecrement", 600, 110);
147
+  controlElements.add(coolStepDecrementButtons);
148
+  coolStepDecrementButtons.captionLabel().set("Cool Step Decrement");
149
+  coolStepDecrementButtons.addItem("d_32", 0);
150
+  coolStepDecrementButtons.addItem("d_8", 1);
151
+  coolStepDecrementButtons.addItem("d_2", 2);
152
+  coolStepDecrementButtons.addItem("d_1", 3);
153
+  for (Object o:coolStepDecrementButtons.getItems()) {
154
+    Toggle t = (Toggle) o;
155
+    t.setCaptionLabel(t.getName().substring(2));
156
+  }
157
+  coolStepDecrementButtons.showBar();
158
+  coolStepDecrementButtons.moveTo(runTab);
159
+
160
+  coolStepMinButtons = controlP5.addRadioButton("coolStepMin", 600, 180);
161
+  controlElements.add(coolStepMinButtons);
162
+  coolStepMinButtons.addItem("s_1/2", 0);
163
+  coolStepMinButtons.addItem("s_1/4", 1);
164
+  for (Object o:coolStepMinButtons.getItems()) {
165
+    Toggle t = (Toggle) o;
166
+    t.setCaptionLabel(t.getName().substring(2));
167
+  }
168
+  coolStepMinButtons.showBar();
169
+  coolStepMinButtons.moveTo(runTab);
170
+  
171
+  trinamicButton = controlP5.addButton("trinamicLogo", 1.0, 750, 40, 200, 100);
172
+  trinamicButton.setImage(TMCLogo);
173
+  trinamicButton.moveTo(runTab);
174
+  controlElements.add(trinamicButton);
175
+  
176
+  motionControlButton = controlP5.addButton("mcLogo", 1.0, 750, 150, 200, 100);
177
+  motionControlButton.setImage(MCLogo);
178
+  motionControlButton.moveTo(runTab);
179
+  controlElements.add(motionControlButton);
180
+}
181
+
182
+void speed(int theSpeed) {
183
+  if (!settingStatus) {
184
+    int speed = (int) theSpeed;
185
+    println("setting speed to "+speed);
186
+    sendCommand("S"+speed);
187
+  }
188
+}
189
+
190
+void run(int value) {
191
+  if (!settingStatus) {
192
+    println("button pressed");
193
+    if (running) {
194
+      println("stopping motor");
195
+      sendCommand("s");
196
+      running = false;
197
+    } 
198
+    else {
199
+      println("starting motor");
200
+      sendCommand("r");
201
+      running = true;
202
+    }
203
+  }
204
+}
205
+
206
+void enabled(int value) {
207
+  if (!settingStatus) {
208
+    println("enabled: "+value);
209
+    sendCommand("e"+value);
210
+  }
211
+}
212
+
213
+void microstepping(int value) {
214
+  if (!settingStatus) {
215
+    println("microstepping: "+value);
216
+    sendCommand("m"+value);
217
+  }
218
+}
219
+
220
+void stallguardthreshold(int value) {
221
+  if (!settingStatus) {
222
+    println("stall guard threshold: "+value);
223
+    sendCommand("t"+value);
224
+  }
225
+  if (value==sgtSlider.max()) {
226
+    sgtPlus.lock();
227
+  } 
228
+  else {
229
+    sgtPlus.unlock();
230
+  }
231
+  if (value==sgtSlider.min()) {
232
+    sgtMinus.lock();
233
+  } 
234
+  else {
235
+    sgtMinus.unlock();
236
+  }
237
+}
238
+
239
+void sgtplus(int value) {
240
+  sgtSlider.setValue(sgtSlider.value()+1);
241
+}
242
+
243
+void sgtminus(int value) {
244
+  sgtSlider.setValue(sgtSlider.value()-1);
245
+}
246
+
247
+void sgfilter(int value) {
248
+  if (!settingStatus) {
249
+    println("filter: "+value);
250
+    sendCommand("f"+value);
251
+  }
252
+}  
253
+
254
+void current(float value) {
255
+  if (!settingStatus) {
256
+    int realValue=(int)(value*1000.0);
257
+    println("current: "+((float)realValue/1000.0)+" = "+realValue);
258
+    sendCommand("c"+realValue);
259
+    if (activeTab!=null && "run".equals(activeTab.name())) {
260
+      motorCurrentBox.setValue(value);
261
+    }
262
+  }
263
+}
264
+
265
+void coolStepUpper(int value) {
266
+  coolStepMax=value;
267
+  if (!settingStatus) {
268
+    sendCommand("Ku"+value);
269
+  }
270
+}
271
+
272
+void coolStepLower(int value) {
273
+  coolStepMin = value;
274
+  if (!settingStatus) {
275
+    sendCommand("Kl"+value);
276
+  }
277
+}
278
+
279
+
280
+void setCoolStepIncrement(int value) {
281
+  if (!settingStatus) {
282
+    println("cool step increment :"+value);
283
+    sendCommand("Ki"+value);
284
+  }
285
+}
286
+
287
+void setCoolStepDecrement(int value) {
288
+  if (!settingStatus) {
289
+    println("cool step decrement :"+value);
290
+    sendCommand("Kn"+value);
291
+  }
292
+}
293
+
294
+void setCoolStepMin(int value) {
295
+  if (!settingStatus) {
296
+    println("cool step minimum :"+value);
297
+    sendCommand("Km"+value);
298
+  }
299
+}
300
+
301
+void coolStepActive(int value) {
302
+  if (!settingStatus) {
303
+    coolStepActive = (value!=0);
304
+    sendCommand(coolStepActive? "K+":"K-");
305
+  }
306
+}
307
+
308
+void setCurrent(int current) {
309
+  currentSlider.setValue((float)current/1000.0);
310
+}
311
+
312
+void setDirection(int direction) {
313
+  if (!settingStatus) {
314
+    if (direction<0) {
315
+      println("back");
316
+      sendCommand("d-1");
317
+    } 
318
+    else {
319
+      sendCommand("d1");
320
+    }
321
+  }
322
+}
323
+
324
+void trinamicLogo(float value){
325
+  if (value!=0) {
326
+    link(trinamicUrl);
327
+  }
328
+}
329
+
330
+void mcLogo(float value) {
331
+  if (value!=0) {
332
+    link(mcUrl);
333
+  }
334
+}
335
+

+ 156
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/TMC26XMotorTest.pde View File

@@ -0,0 +1,156 @@
1
+/*
2
+ TMC26XMotorTest.pde - - TMC26X Stepper Tester for Processing
3
+ 
4
+ Copyright (c) 2011, Interactive Matter, Marcus Nowotny
5
+ 
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+ 
13
+ The above copyright notice and this permission notice shall be included in
14
+ all copies or substantial portions of the Software.
15
+ 
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22
+ THE SOFTWARE.
23
+ 
24
+ */
25
+import controlP5.*;
26
+import processing.serial.*;
27
+import java.util.*;
28
+import java.text.*;
29
+
30
+ControlP5 controlP5;
31
+
32
+Serial arduinoPort;
33
+
34
+String helpUrl = "http://www.motioncontrol-community.org/";
35
+String trinamicUrl = "http://trinamic.com";
36
+String mcUrl = "http://www.motioncontrol-community.org/";
37
+
38
+//TODO comde up with a nice color scheme
39
+color activeColor = #01ADF1;
40
+color foreGroundColor = #01ADF1; 
41
+color uiTextColor = #4D4D4F;
42
+color uiElementColor = #ffffff;
43
+color labelColor = #f0f0f0;
44
+color valueColor = #f0f0f0;
45
+color backgroundColor = #EDEEEF;
46
+color stallGuardColor = #969696;
47
+color positionColor = #01ADF1;
48
+color goodStatusColor = labelColor;
49
+color badStatusColor = stallGuardColor;
50
+color coolStepColor = #4D4D4F;
51
+color diagramBackgroundColor = #ffffff;
52
+
53
+CColor uiColor = new CColor( foreGroundColor, uiElementColor, activeColor, uiTextColor, uiTextColor);
54
+
55
+Tab configureTab;
56
+Tab runTab;
57
+Tab activeTab;
58
+
59
+boolean settingStatus=false;
60
+
61
+boolean running = false;
62
+int coolStepMin = 0;
63
+int coolStepMax = 0;
64
+boolean coolStepActive = false;
65
+
66
+float maxCurrent = 1.7;
67
+
68
+List controlElements = new LinkedList();
69
+List serialConfigElements = new LinkedList();
70
+
71
+PImage TMCLogo;
72
+PImage MCLogo;
73
+
74
+void setup() {
75
+  size(1000, 800);
76
+  //load the logos
77
+  TMCLogo=loadImage("tmc_logo.jpg");
78
+  MCLogo=loadImage("mc_logo.jpg");
79
+  
80
+  //create the UI
81
+  controlP5 = new ControlP5(this);
82
+  controlP5.setColor(uiColor);
83
+  runTab = controlP5.getTab("default");
84
+  configureTab =controlP5.addTab("configure"); 
85
+  //customize the tabs a bit
86
+  configureTab.setLabel("configure");
87
+  controlElements.add(configureTab);
88
+  activeTab =  controlP5.getTab("default");
89
+  controlP5.setTabEventsActive(true);
90
+  configureTab.activateEvent(true);
91
+  runTab.activateEvent(true);
92
+
93
+  //configuring the general UI l&f
94
+  //the configuration UI
95
+
96
+  setupRunConfig();
97
+  setupChooperConfig();
98
+  setupSerialConfig();
99
+  //directly hide the controls again since we are not connected to the Arduino yet
100
+  toggleUi(motor_connected);
101
+
102
+  smooth();
103
+  setupData();
104
+}
105
+
106
+
107
+void toggleUi(boolean show_controls) {
108
+  for (Object c:controlElements) {
109
+    ControllerInterface controller = (ControllerInterface) c;
110
+    if (show_controls) {
111
+      controller.show();
112
+    } else {
113
+      controller.hide();
114
+    }
115
+  }
116
+  for (Object c:serialConfigElements) {
117
+    ControllerInterface controller = (ControllerInterface) c;
118
+    if (show_controls) {
119
+      controller.hide();
120
+    } else {
121
+      controller.show();
122
+    }
123
+  }    
124
+}
125
+
126
+void draw() {
127
+  background(backgroundColor);
128
+  drawSerial();
129
+  drawChopper();
130
+  drawData();
131
+  decodeSerial();
132
+}
133
+
134
+
135
+void controlEvent(ControlEvent theEvent) {
136
+  if (theEvent.isGroup() && !settingStatus) {
137
+    if ("microstepping".equals(theEvent.group().name())) { 
138
+      microstepping((int)theEvent.group().value());
139
+    } else 
140
+    if ("direction".equals(theEvent.group().name())) {
141
+      setDirection((int)theEvent.group().value());
142
+    } else if ("decrement".equals(theEvent.group().name())) {
143
+      setHysteresisDecrement((int)theEvent.group().value());
144
+    } else if ("coolStepIncrement".equals(theEvent.group().name())) {
145
+      setCoolStepIncrement((int)theEvent.group().value());
146
+    } else if ("coolStepDecrement".equals(theEvent.group().name())) {
147
+      setCoolStepDecrement((int)theEvent.group().value());
148
+    } else if ("coolStepMin".equals(theEvent.group().name())) {
149
+      setCoolStepMin((int)theEvent.group().value());
150
+    }
151
+  } 
152
+  else if (theEvent.isTab()) {
153
+    activeTab = theEvent.tab();
154
+    println("Tab: "+activeTab.name());
155
+  } 
156
+}

BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/data/mc_logo.jpg View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/data/tmc_logo.jpg View File


BIN
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/hysteresis.png View File


+ 2
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/examples/TMC26XMotorTester/processing/TMC26XMotorTest/sketch.properties View File

@@ -0,0 +1,2 @@
1
+mode.id=processing.mode.java.JavaMode
2
+mode=Java

+ 75
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/keywords.txt View File

@@ -0,0 +1,75 @@
1
+#######################################
2
+# Syntax Coloring Map For Test
3
+#######################################
4
+
5
+#######################################
6
+# Datatypes (KEYWORD1)
7
+#######################################
8
+
9
+Stepper	TMC26XStepper
10
+
11
+#######################################
12
+# Methods and Functions (KEYWORD2)
13
+#######################################
14
+
15
+start				KEYWORD2
16
+step				KEYWORD2
17
+setSpeed			KEYWORD2
18
+getSpeed			KEYWORD2
19
+setMicrosteps			KEYWORD2
20
+getMicrosteps			KEYWORD2
21
+move				KEYWORD2
22
+isMoving			KEYWORD2
23
+getStepsLeft			KEYWORD2
24
+stop				KEYWORD2
25
+setConstantOffTimeChopper	KEYWORD2
26
+setSpreadCycleChopper		KEYWORD2
27
+setRandomOffTime		KEYWORD2
28
+setCurrent			KEYWORD2
29
+getCurrent			KEYWORD2
30
+setStallGuardThreshold		KEYWORD2
31
+getStallGuardThreshold		KEYWORD2
32
+getStallGuardFilter		KEYWORD2
33
+setCoolStepConfiguration	KEYWORD2
34
+setCoolStepEnabled		KEYWORD2
35
+isCoolStepEnabled		KEYWORD2
36
+getCoolStepLowerSgThreshold	KEYWORD2
37
+getCoolStepUpperSgThreshold	KEYWORD2
38
+getCoolStepNumberOfSGReadings	KEYWORD2
39
+getCoolStepCurrentIncrementSize	KEYWORD2
40
+getCoolStepLowerCurrentLimit	KEYWORD2
41
+getMotorPosition		KEYWORD2
42
+getCurrentStallGuardReading	KEYWORD2
43
+getCurrentCSReading		KEYWORD2
44
+isCurrentScalingHalfed		KEYWORD2
45
+getCurrentCurrent		KEYWORD2
46
+isStallGuardOverThreshold	KEYWORD2
47
+getOverTemperature		KEYWORD2
48
+isShortToGroundA		KEYWORD2
49
+isShortToGroundB		KEYWORD2
50
+isOpenLoadA			KEYWORD2
51
+isOpenLoadB			KEYWORD2
52
+isStandStill			KEYWORD2
53
+isStallGuardReached		KEYWORD2
54
+setEnabled			KEYWORD2
55
+isEnabled			KEYWORD2
56
+readStatus			KEYWORD2
57
+getResistor			KEYWORD2
58
+debugLastStatus			KEYWORD2
59
+version				KEYWORD2
60
+
61
+######################################
62
+# Instances (KEYWORD2)
63
+#######################################
64
+
65
+#######################################
66
+# Constants (LITERAL1)
67
+#######################################
68
+
69
+TMC262_OVERTEMPERATURE_PREWARING	LITERAL1
70
+TMC262_OVERTEMPERATURE_SHUTDOWN 	LITERAL1
71
+TMC262_READOUT_POSITION 		LITERAL1
72
+TMC262_READOUT_STALLGUARD 		LITERAL1
73
+TMC262_READOUT_CURRENT 		LITERAL1
74
+COOL_STEP_HALF_CS_LIMIT		LITERAL1
75
+COOL_STEP_QUARTDER_CS_LIMIT		LITERAL1

+ 30
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/mainpage.dox View File

@@ -0,0 +1,30 @@
1
+/*!
2
+ * \mainpage TMC 260, 261, 262 Stepper Driver for Arduino
3
+ * \author Interactive MAtter, MArcus Nowotny, marcus@interactive-matter.eu
4
+ * \section HOWTO How to use the driver
5
+ * Here we go with aminial how to description
6
+ *
7
+ *
8
+ * \section  COPYRIGHT_NOTIFICATION COPYRIGHT NOTIFICATION
9
+ * \par (c) 2011 Interactive MAtter, Marcus Nowotny 
10
+ *
11
+ * \par
12
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
13
+ * of this software and associated documentation files (the "Software"), to deal
14
+ *  in the Software without restriction, including without limitation the rights
15
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
+ *  copies of the Software, and to permit persons to whom the Software is
17
+ *  furnished to do so, subject to the following conditions:
18
+ *  
19
+ *  The above copyright notice and this permission notice shall be included in
20
+ *  all copies or substantial portions of the Software.
21
+ 
22
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
28
+ *  THE SOFTWARE.
29
+ *
30
+ */

+ 9797
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/schematics/tmc-260-shield.brd
File diff suppressed because it is too large
View File


+ 11079
- 0
ArduinoAddons/Arduino_1.x.x/libraries/TMC26XStepper/schematics/tmc-260-shield.sch
File diff suppressed because it is too large
View File


+ 61
- 0
Marlin/Configuration_adv.h View File

@@ -461,6 +461,67 @@ const unsigned int dropsegments=5; //everything with less than this number of st
461 461
   #endif
462 462
 #endif
463 463
 
464
+
465
+/******************************************************************************\
466
+ * enable this section if you have TMC26X motor drivers. 
467
+ * you need to import the TMC26XStepper library into the arduino IDE for this
468
+ ******************************************************************************/
469
+
470
+#define HAVE_TMCDRIVER
471
+#ifdef HAVE_TMCDRIVER
472
+
473
+	#define X_IS_TMC
474
+	#define X_MAX_CURRENT 2000  //in mA
475
+	#define X_SENSE_RESISTOR 91 //in mOhms
476
+	#define X_MICROSTEPS 16     //number of microsteps
477
+	
478
+//	#define X2_IS_TMC
479
+	#define X2_MAX_CURRENT 2000  //in mA
480
+	#define X2_SENSE_RESISTOR 91 //in mOhms
481
+	#define X2_MICROSTEPS 16     //number of microsteps
482
+	
483
+	#define Y_IS_TMC
484
+	#define Y_MAX_CURRENT 2000  //in mA
485
+	#define Y_SENSE_RESISTOR 91 //in mOhms
486
+	#define Y_MICROSTEPS 16     //number of microsteps
487
+	
488
+//	#define Y2_IS_TMC
489
+	#define Y2_MAX_CURRENT 2000  //in mA
490
+	#define Y2_SENSE_RESISTOR 91 //in mOhms
491
+	#define Y2_MICROSTEPS 16     //number of microsteps	
492
+	
493
+	#define Z_IS_TMC
494
+	#define Z_MAX_CURRENT 2000  //in mA
495
+	#define Z_SENSE_RESISTOR 91 //in mOhms
496
+	#define Z_MICROSTEPS 16     //number of microsteps
497
+	
498
+//	#define Z2_IS_TMC
499
+	#define Z2_MAX_CURRENT 2000  //in mA
500
+	#define Z2_SENSE_RESISTOR 91 //in mOhms
501
+	#define Z2_MICROSTEPS 16     //number of microsteps
502
+	
503
+	#define E0_IS_TMC
504
+	#define E0_MAX_CURRENT 2000  //in mA
505
+	#define E0_SENSE_RESISTOR 91 //in mOhms
506
+	#define E0_MICROSTEPS 16     //number of microsteps
507
+	
508
+	#define E1_IS_TMC
509
+	#define E1_MAX_CURRENT 2000  //in mA
510
+	#define E1_SENSE_RESISTOR 91 //in mOhms
511
+	#define E1_MICROSTEPS 16     //number of microsteps	
512
+	
513
+//	#define E2_IS_TMC
514
+	#define E2_MAX_CURRENT 2000  //in mA
515
+	#define E2_SENSE_RESISTOR 91 //in mOhms
516
+	#define E2_MICROSTEPS 16     //number of microsteps	
517
+	
518
+//	#define E3_IS_TMC
519
+	#define E3_MAX_CURRENT 2000  //in mA
520
+	#define E3_SENSE_RESISTOR 91 //in mOhms
521
+	#define E3_MICROSTEPS 16     //number of microsteps		
522
+
523
+#endif
524
+
464 525
 //===========================================================================
465 526
 //=============================  Define Defines  ============================
466 527
 //===========================================================================

+ 5
- 0
Marlin/Marlin.ino View File

@@ -54,3 +54,8 @@
54 54
 #if defined(DIGIPOT_I2C)
55 55
   #include <Wire.h>
56 56
 #endif
57
+
58
+#ifdef HAVE_TMCDRIVER
59
+  #include <SPI.h>
60
+  #include <TMC26XStepper.h>
61
+#endif

+ 81
- 1
Marlin/stepper.cpp View File

@@ -33,7 +33,6 @@
33 33
 #include <SPI.h>
34 34
 #endif
35 35
 
36
-
37 36
 //===========================================================================
38 37
 //=============================public variables  ============================
39 38
 //===========================================================================
@@ -88,6 +87,37 @@ static bool check_endstops = true;
88 87
 volatile long count_position[NUM_AXIS] = { 0, 0, 0, 0};
89 88
 volatile signed char count_direction[NUM_AXIS] = { 1, 1, 1, 1};
90 89
 
90
+// Stepper objects of TMC steppers are used
91
+#ifdef X_IS_TMC
92
+	TMC26XStepper stepperX(200,X_ENABLE_PIN,X_STEP_PIN,X_DIR_PIN,X_MAX_CURRENT,X_SENSE_RESISTOR);
93
+#endif
94
+#ifdef X2_IS_TMC
95
+	TMC26XStepper stepperX2(200,X2_ENABLE_PIN,X2_STEP_PIN,X2_DIR_PIN,X2_MAX_CURRENT,X2_SENSE_RESISTOR);
96
+#endif
97
+#ifdef Y_IS_TMC
98
+	TMC26XStepper stepperY(200,Y_ENABLE_PIN,Y_STEP_PIN,Y_DIR_PIN,Y_MAX_CURRENT,Y_SENSE_RESISTOR);
99
+#endif
100
+#ifdef Y2_IS_TMC
101
+	TMC26XStepper stepperY2(200,Y2_ENABLE_PIN,Y2_STEP_PIN,Y2_DIR_PIN,Y2_MAX_CURRENT,Y2_SENSE_RESISTOR);
102
+#endif
103
+#ifdef Z_IS_TMC
104
+	TMC26XStepper stepperZ(200,Z_ENABLE_PIN,Z_STEP_PIN,Z_DIR_PIN,Z_MAX_CURRENT,Z_SENSE_RESISTOR);
105
+#endif
106
+#ifdef Z2_IS_TMC
107
+	TMC26XStepper stepperZ2(200,Z2_ENABLE_PIN,Z2_STEP_PIN,Z2_DIR_PIN,Z2_MAX_CURRENT,Z2_SENSE_RESISTOR);
108
+#endif
109
+#ifdef E0_IS_TMC
110
+	TMC26XStepper stepperE0(200,E0_ENABLE_PIN,E0_STEP_PIN,E0_DIR_PIN,E0_MAX_CURRENT,E0_SENSE_RESISTOR);
111
+#endif
112
+#ifdef E1_IS_TMC
113
+	TMC26XStepper stepperE1(200,E1_ENABLE_PIN,E1_STEP_PIN,E1_DIR_PIN,E1_MAX_CURRENT,E1_SENSE_RESISTOR);
114
+#endif
115
+#ifdef E2_IS_TMC
116
+	TMC26XStepper stepperE2(200,E2_ENABLE_PIN,E2_STEP_PIN,E2_DIR_PIN,E2_MAX_CURRENT,E2_SENSE_RESISTOR);
117
+#endif
118
+#ifdef E3_IS_TMC
119
+	TMC26XStepper stepperE3(200,E3_ENABLE_PIN,E3_STEP_PIN,E3_DIR_PIN,E3_MAX_CURRENT,E3_SENSE_RESISTOR);
120
+#endif	
91 121
 //===========================================================================
92 122
 //=============================functions         ============================
93 123
 //===========================================================================
@@ -838,6 +868,11 @@ void st_init()
838 868
   digipot_init(); //Initialize Digipot Motor Current
839 869
   microstep_init(); //Initialize Microstepping Pins
840 870
 
871
+  // initialise TMC Steppers
872
+  #ifdef HAVE_TMCDRIVER
873
+     tmc_init();
874
+  #endif
875
+  
841 876
   //Initialize Dir Pins
842 877
   #if defined(X_DIR_PIN) && X_DIR_PIN > -1
843 878
     X_DIR_INIT;
@@ -1386,3 +1421,48 @@ void microstep_readings()
1386 1421
       #endif
1387 1422
 }
1388 1423
 
1424
+#ifdef HAVE_TMCDRIVER
1425
+void tmc_init()
1426
+{
1427
+#ifdef X_IS_TMC
1428
+	stepperX.setMicrosteps(X_MICROSTEPS);
1429
+	stepperX.start();
1430
+#endif
1431
+#ifdef X2_IS_TMC
1432
+	stepperX2.setMicrosteps(X2_MICROSTEPS);
1433
+	stepperX2.start();
1434
+#endif
1435
+#ifdef Y_IS_TMC
1436
+	stepperY.setMicrosteps(Y_MICROSTEPS);
1437
+	stepperY.start();
1438
+#endif
1439
+#ifdef Y2_IS_TMC
1440
+	stepperY2.setMicrosteps(Y2_MICROSTEPS);
1441
+	stepperY2.start();
1442
+#endif
1443
+#ifdef Z_IS_TMC
1444
+	stepperZ.setMicrosteps(Z_MICROSTEPS);
1445
+	stepperZ.start();
1446
+#endif
1447
+#ifdef Z2_IS_TMC
1448
+	stepperZ2.setMicrosteps(Z2_MICROSTEPS);
1449
+	stepperZ2.start();
1450
+#endif
1451
+#ifdef E0_IS_TMC
1452
+	stepperE0.setMicrosteps(E0_MICROSTEPS);
1453
+	stepperE0.start();
1454
+#endif
1455
+#ifdef E1_IS_TMC
1456
+	stepperE1.setMicrosteps(E1_MICROSTEPS);
1457
+	stepperE1.start();
1458
+#endif
1459
+#ifdef E2_IS_TMC
1460
+	stepperE2.setMicrosteps(E2_MICROSTEPS);
1461
+	stepperE2.start();
1462
+#endif
1463
+#ifdef E3_IS_TMC
1464
+	stepperE3.setMicrosteps(E3_MICROSTEPS);
1465
+	stepperE3.start();
1466
+#endif
1467
+}
1468
+#endif

+ 39
- 1
Marlin/stepper.h View File

@@ -24,6 +24,11 @@
24 24
 #include "planner.h"
25 25
 #include "stepper_indirection.h"
26 26
 
27
+#ifdef HAVE_TMCDRIVER
28
+#include <SPI.h>
29
+#include <TMC26XStepper.h>
30
+#endif
31
+
27 32
 #if EXTRUDERS > 3
28 33
   #define WRITE_E_STEP(v) { if(current_block->active_extruder == 3) { E3_STEP_WRITE(v); } else { if(current_block->active_extruder == 2) { E2_STEP_WRITE(v); } else { if(current_block->active_extruder == 1) { E1_STEP_WRITE(v); } else { E0_STEP_WRITE(v); }}}}
29 34
   #define NORM_E_DIR() { if(current_block->active_extruder == 3) { E3_DIR_WRITE( !INVERT_E3_DIR); } else { if(current_block->active_extruder == 2) { E2_DIR_WRITE(!INVERT_E2_DIR); } else { if(current_block->active_extruder == 1) { E1_DIR_WRITE(!INVERT_E1_DIR); } else { E0_DIR_WRITE(!INVERT_E0_DIR); }}}}
@@ -101,6 +106,39 @@ void microstep_readings();
101 106
   void babystep(const uint8_t axis,const bool direction); // perform a short step with a single stepper motor, outside of any convention
102 107
 #endif
103 108
      
104
-
109
+#ifdef HAVE_TMCDRIVER
110
+void tmc_init();
111
+	 
112
+#ifdef X_IS_TMC
113
+	extern TMC26XStepper stepperX;
114
+#endif
115
+#ifdef X2_IS_TMC
116
+	extern TMC26XStepper stepperX2;
117
+#endif
118
+#ifdef Y_IS_TMC
119
+	extern TMC26XStepper stepperY;
120
+#endif
121
+#ifdef Y2_IS_TMC
122
+	extern TMC26XStepper stepperY2;
123
+#endif
124
+#ifdef Z_IS_TMC
125
+	extern TMC26XStepper stepperZ;
126
+#endif
127
+#ifdef Z2_IS_TMC
128
+	extern TMC26XStepper stepperZ2;
129
+#endif
130
+#ifdef E0_IS_TMC
131
+	extern TMC26XStepper stepperE0;
132
+#endif
133
+#ifdef E1_IS_TMC
134
+	extern TMC26XStepper stepperE1;
135
+#endif
136
+#ifdef E2_IS_TMC
137
+	extern TMC26XStepper stepperE2;
138
+#endif
139
+#ifdef E3_IS_TMC
140
+	extern TMC26XStepper stepperE3;
141
+#endif	
142
+#endif
105 143
 
106 144
 #endif

+ 106
- 0
Marlin/stepper_indirection.h View File

@@ -152,5 +152,111 @@
152 152
 #define E3_ENABLE_WRITE(STATE) WRITE(E3_ENABLE_PIN,STATE)
153 153
 #define E3_ENABLE_READ READ(E3_ENABLE_PIN)
154 154
 
155
+//////////////////////////////////
156
+// Pin redefines for TMC drivers. 
157
+// TMC26X drivers have step and dir on normal pins, but everything else via SPI
158
+//////////////////////////////////
159
+#ifdef HAVE_TMCDRIVER
160
+#ifdef X_IS_TMC
161
+   #undef X_ENABLE_INIT 
162
+   #define X_ENABLE_INIT 
163
+   
164
+   #undef X_ENABLE_WRITE
165
+   #define X_ENABLE_WRITE(STATE) stepperX.setEnabled(STATE)
166
+   
167
+   #undef X_ENABLE_READ
168
+   #define X_ENABLE_READ stepperX.isEnabled()
169
+#endif
170
+#ifdef X2_IS_TMC
171
+   #undef X2_ENABLE_INIT
172
+   #define X2_ENABLE_INIT
173
+   
174
+   #undef X2_ENABLE_WRITE
175
+   #define X2_ENABLE_WRITE(STATE) stepperX2.setEnabled(STATE)
176
+   
177
+   #undef X2_ENABLE_READ
178
+   #define X2_ENABLE_READ stepperX2.isEnabled()   
179
+#endif
180
+#ifdef Y_IS_TMC
181
+   #undef Y_ENABLE_INIT
182
+   #define Y_ENABLE_INIT
183
+   
184
+   #undef Y_ENABLE_WRITE
185
+   #define Y_ENABLE_WRITE(STATE) stepperY.setEnabled(STATE)
186
+   
187
+   #undef Y_ENABLE_READ
188
+   #define Y_ENABLE_READ stepperY.isEnabled()   
189
+#endif
190
+#ifdef Y2_IS_TMC
191
+   #undef Y2_ENABLE_INIT
192
+   #define Y2_ENABLE_INIT
193
+   
194
+   #undef Y2_ENABLE_WRITE
195
+   #define Y2_ENABLE_WRITE(STATE) stepperY2.setEnabled(STATE)
196
+   
197
+   #undef Y2_ENABLE_READ
198
+   #define Y2_ENABLE_READ stepperY2.isEnabled()     
199
+#endif
200
+#ifdef Z_IS_TMC
201
+   #undef Z_ENABLE_INIT
202
+   #define Z_ENABLE_INIT
203
+   
204
+   #undef Z_ENABLE_WRITE
205
+   #define Z_ENABLE_WRITE(STATE) stepperZ.setEnabled(STATE)
206
+   
207
+   #undef Z_ENABLE_READ
208
+   #define Z_ENABLE_READ stepperZ.isEnabled()       
209
+#endif
210
+#ifdef Z2_IS_TMC
211
+   #undef Z2_ENABLE_INIT
212
+   #define Z2_ENABLE_INIT
213
+   
214
+   #undef Z2_ENABLE_WRITE
215
+   #define Z2_ENABLE_WRITE(STATE) stepperZ2.setEnabled(STATE)
216
+   
217
+   #undef Z2_ENABLE_READ
218
+   #define Z2_ENABLE_READ stepperZ2.isEnabled()   
219
+#endif
220
+#ifdef E0_IS_TMC
221
+   #undef E0_ENABLE_INIT
222
+   #define E0_ENABLE_INIT
223
+   
224
+   #undef E0_ENABLE_WRITE
225
+   #define E0_ENABLE_WRITE(STATE) stepperE0.setEnabled(STATE)
226
+   
227
+   #undef E0_ENABLE_READ
228
+   #define E0_ENABLE_READ stepperE0.isEnabled()   
229
+#endif
230
+#ifdef E1_IS_TMC
231
+   #undef E1_ENABLE_INIT
232
+   #define E1_ENABLE_INIT
233
+   
234
+   #undef E1_ENABLE_WRITE
235
+   #define E1_ENABLE_WRITE(STATE) stepperE1.setEnabled(STATE)
236
+   
237
+   #undef E1_ENABLE_READ
238
+   #define E1_ENABLE_READ stepperE1.isEnabled()   
239
+#endif
240
+#ifdef E2_IS_TMC
241
+   #undef E2_ENABLE_INIT
242
+   #define E2_ENABLE_INIT
243
+   
244
+   #undef E2_ENABLE_WRITE
245
+   #define E2_ENABLE_WRITE(STATE) stepperE2.setEnabled(STATE)
246
+   
247
+   #undef E2_ENABLE_READ
248
+   #define E2_ENABLE_READ stepperE2.isEnabled()   
249
+#endif
250
+#ifdef E3_IS_TMC
251
+   #undef E3_ENABLE_INIT
252
+   #define E3_ENABLE_INIT
253
+   
254
+   #undef E3_ENABLE_WRITE
255
+   #define E3_ENABLE_WRITE(STATE) stepperE3.setEnabled(STATE)
256
+   
257
+   #undef E3_ENABLE_READ
258
+   #define E3_ENABLE_READ stepperE3.isEnabled()   
259
+#endif
260
+#endif
155 261
 
156 262
 #endif

Loading…
Cancel
Save