From 15036fbe5fb4c130264d84915df64b3069e1b90d Mon Sep 17 00:00:00 2001 From: Peter Polidoro Date: Fri, 27 Dec 2024 12:10:47 -0500 Subject: [PATCH] Update version number and documentation --- .metadata/README.org | 5 ++++- README.md | 37 ++++++++++++++++++++----------------- library.properties | 2 +- 3 files changed, 25 insertions(+), 19 deletions(-) diff --git a/.metadata/README.org b/.metadata/README.org index 1442e43..c470413 100644 --- a/.metadata/README.org +++ b/.metadata/README.org @@ -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 :: peter@polidoro.io +- Contributors + - thinkier + - pvginkel ** Description diff --git a/README.md b/README.md index 227ee6d..a14bb15 100644 --- a/README.md +++ b/README.md @@ -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) - + # Library Information - **Name:** TMC2209 -- **Version:** 9.4.2 +- **Version:** 10.0.0 - **License:** BSD - **URL:** - **Author:** Peter Polidoro - **Email:** peter@polidoro.io +- Contributors + - thinkier + - pvginkel ## Description @@ -30,7 +33,7 @@ The TMC2209 is an ultra-silent motor driver IC for two phase stepper motors with - + # Stepper Motors @@ -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) - + # Stepper Motor Controllers and Drivers @@ -89,7 +92,7 @@ Another controller option is to use both a microcontroller and a separate step a - + # Communication @@ -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) - + # Settings @@ -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. - + # Examples @@ -574,7 +577,7 @@ In current control mode, setting the hold current is the way to adjust the stati - + # Hardware Documentation @@ -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) - + # Host Computer Setup diff --git a/library.properties b/library.properties index 3d5ad35..f8fdd06 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=TMC2209 -version=9.4.2 +version=10.0.0 author=Peter Polidoro maintainer=Peter Polidoro sentence=The TMC2209 is an ultra-silent motor driver IC for two phase stepper motors with both UART serial and step and direction interfaces.