Skip to content

Commit 15036fb

Browse files
committed
Update version number and documentation
1 parent b31fe7a commit 15036fb

File tree

3 files changed

+25
-19
lines changed

3 files changed

+25
-19
lines changed

.metadata/README.org

+4-1
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,14 @@
1212

1313
* Library Information
1414
- Name :: TMC2209
15-
- Version :: 9.4.2
15+
- Version :: 10.0.0
1616
- License :: BSD
1717
- URL :: https://github.com/janelia-arduino/TMC2209
1818
- Author :: Peter Polidoro
1919
20+
- Contributors
21+
- thinkier
22+
- pvginkel
2023

2124
** Description
2225

README.md

+20-17
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,29 @@
1-
- [Library Information](#orgcb6898d)
2-
- [Stepper Motors](#orgb4cdfb7)
3-
- [Stepper Motor Controllers and Drivers](#org5d75c4e)
4-
- [Communication](#org949962f)
5-
- [Settings](#org89e5ca7)
6-
- [Examples](#org2ea2a1e)
7-
- [Hardware Documentation](#orga8db4a1)
8-
- [Host Computer Setup](#org670ee5a)
1+
- [Library Information](#orgb375f8e)
2+
- [Stepper Motors](#orgd61846c)
3+
- [Stepper Motor Controllers and Drivers](#orgac79204)
4+
- [Communication](#org93469d8)
5+
- [Settings](#org3345be9)
6+
- [Examples](#org2caaf84)
7+
- [Hardware Documentation](#orge465dc8)
8+
- [Host Computer Setup](#org1da6ae5)
99

1010
<!-- This file is generated automatically from metadata -->
1111
<!-- File edits may be overwritten! -->
1212

1313

14-
<a id="orgcb6898d"></a>
14+
<a id="orgb375f8e"></a>
1515

1616
# Library Information
1717

1818
- **Name:** TMC2209
19-
- **Version:** 9.4.2
19+
- **Version:** 10.0.0
2020
- **License:** BSD
2121
- **URL:** <https://github.com/janelia-arduino/TMC2209>
2222
- **Author:** Peter Polidoro
2323
- **Email:** [email protected]
24+
- Contributors
25+
- thinkier
26+
- pvginkel
2427

2528

2629
## Description
@@ -30,7 +33,7 @@ The TMC2209 is an ultra-silent motor driver IC for two phase stepper motors with
3033
<img src="./images/trinamic_wiring-TMC2209-description.svg" width="1920px">
3134

3235

33-
<a id="orgb4cdfb7"></a>
36+
<a id="orgd61846c"></a>
3437

3538
# Stepper Motors
3639

@@ -41,7 +44,7 @@ A stepper motor, also known as step motor or stepping motor, is a brushless DC e
4144
[Wikipedia - Stepper Motor](https://en.wikipedia.org/wiki/Stepper_motor)
4245

4346

44-
<a id="org5d75c4e"></a>
47+
<a id="orgac79204"></a>
4548

4649
# Stepper Motor Controllers and Drivers
4750

@@ -89,7 +92,7 @@ Another controller option is to use both a microcontroller and a separate step a
8992
<img src="./images/trinamic_wiring-TMC2209-stepper-controller.svg" width="1920px">
9093

9194

92-
<a id="org949962f"></a>
95+
<a id="org93469d8"></a>
9396

9497
# Communication
9598

@@ -391,7 +394,7 @@ A library such as the Arduino TMC429 library may be used to control the step and
391394
[Arduino TMC429 Library](https://github.com/janelia-arduino/TMC429)
392395

393396

394-
<a id="org89e5ca7"></a>
397+
<a id="org3345be9"></a>
395398

396399
# Settings
397400

@@ -546,7 +549,7 @@ In voltage control mode, the hold current scales the PWM amplitude, but the curr
546549
In current control mode, setting the hold current is the way to adjust the stationary motor current. The driver will measure the current and automatically adjust the voltage to maintain the hold current, even with the operating conditions change. The PWM offset may be changed to help the automatic tuning procedure, but changing the hold current alone is enough to adjust the motor current since the driver will adjust the offset automatically.
547550

548551

549-
<a id="org2ea2a1e"></a>
552+
<a id="org2caaf84"></a>
550553

551554
# Examples
552555

@@ -574,7 +577,7 @@ In current control mode, setting the hold current is the way to adjust the stati
574577
<https://github.com/janelia-kicad/trinamic_wiring>
575578

576579

577-
<a id="orga8db4a1"></a>
580+
<a id="orge465dc8"></a>
578581

579582
# Hardware Documentation
580583

@@ -609,7 +612,7 @@ In current control mode, setting the hold current is the way to adjust the stati
609612
[Janelia Stepper Driver Web Page](https://github.com/janelia-kicad/stepper_driver)
610613

611614

612-
<a id="org670ee5a"></a>
615+
<a id="org1da6ae5"></a>
613616

614617
# Host Computer Setup
615618

library.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name=TMC2209
2-
version=9.4.2
2+
version=10.0.0
33
author=Peter Polidoro <[email protected]>
44
maintainer=Peter Polidoro <[email protected]>
55
sentence=The TMC2209 is an ultra-silent motor driver IC for two phase stepper motors with both UART serial and step and direction interfaces.

0 commit comments

Comments
 (0)