Skip to content

Commit

Permalink
Update version number and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
peterpolidoro committed Dec 27, 2024
1 parent b31fe7a commit 15036fb
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 19 deletions.
5 changes: 4 additions & 1 deletion .metadata/README.org
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,14 @@

* Library Information
- Name :: TMC2209
- Version :: 9.4.2
- Version :: 10.0.0
- License :: BSD
- URL :: https://github.com/janelia-arduino/TMC2209
- Author :: Peter Polidoro
- Email :: [email protected]
- Contributors
- thinkier
- pvginkel

** Description

Expand Down
37 changes: 20 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
- [Library Information](#orgcb6898d)
- [Stepper Motors](#orgb4cdfb7)
- [Stepper Motor Controllers and Drivers](#org5d75c4e)
- [Communication](#org949962f)
- [Settings](#org89e5ca7)
- [Examples](#org2ea2a1e)
- [Hardware Documentation](#orga8db4a1)
- [Host Computer Setup](#org670ee5a)
- [Library Information](#orgb375f8e)
- [Stepper Motors](#orgd61846c)
- [Stepper Motor Controllers and Drivers](#orgac79204)
- [Communication](#org93469d8)
- [Settings](#org3345be9)
- [Examples](#org2caaf84)
- [Hardware Documentation](#orge465dc8)
- [Host Computer Setup](#org1da6ae5)

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


<a id="orgcb6898d"></a>
<a id="orgb375f8e"></a>

# Library Information

- **Name:** TMC2209
- **Version:** 9.4.2
- **Version:** 10.0.0
- **License:** BSD
- **URL:** <https://github.com/janelia-arduino/TMC2209>
- **Author:** Peter Polidoro
- **Email:** [email protected]
- Contributors
- thinkier
- pvginkel


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


<a id="orgb4cdfb7"></a>
<a id="orgd61846c"></a>

# Stepper Motors

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


<a id="org5d75c4e"></a>
<a id="orgac79204"></a>

# Stepper Motor Controllers and Drivers

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


<a id="org949962f"></a>
<a id="org93469d8"></a>

# Communication

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


<a id="org89e5ca7"></a>
<a id="org3345be9"></a>

# Settings

Expand Down Expand Up @@ -546,7 +549,7 @@ In voltage control mode, the hold current scales the PWM amplitude, but the curr
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.


<a id="org2ea2a1e"></a>
<a id="org2caaf84"></a>

# Examples

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


<a id="orga8db4a1"></a>
<a id="orge465dc8"></a>

# Hardware Documentation

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


<a id="org670ee5a"></a>
<a id="org1da6ae5"></a>

# Host Computer Setup

Expand Down
2 changes: 1 addition & 1 deletion library.properties
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=TMC2209
version=9.4.2
version=10.0.0
author=Peter Polidoro <[email protected]>
maintainer=Peter Polidoro <[email protected]>
sentence=The TMC2209 is an ultra-silent motor driver IC for two phase stepper motors with both UART serial and step and direction interfaces.
Expand Down

0 comments on commit 15036fb

Please sign in to comment.