Add unidirectional TestRP2040 example

Author: peterpolidoro

.metadata/README.org

@@ -12,7 +12,7 @@
 
 * Library Information
 - Name :: TMC2209
-- Version :: 9.4.0
+- Version :: 9.4.1
 - License :: BSD
 - URL :: https://github.com/janelia-arduino/TMC2209
 - Author :: Peter Polidoro

README.md

@@ -1,22 +1,22 @@
-- [Library Information](#org492394f)
-- [Stepper Motors](#orgf7138df)
-- [Stepper Motor Controllers and Drivers](#orgf2cb8c3)
-- [Communication](#orgb9a56de)
-- [Settings](#org3f9ff61)
-- [Examples](#org6021d16)
-- [Hardware Documentation](#org7006dc6)
-- [Host Computer Setup](#org33743be)
+- [Library Information](#org2f9c034)
+- [Stepper Motors](#org46f7059)
+- [Stepper Motor Controllers and Drivers](#orga565949)
+- [Communication](#org7308e9d)
+- [Settings](#org1c50612)
+- [Examples](#orgaacfc7b)
+- [Hardware Documentation](#orgdb15521)
+- [Host Computer Setup](#org0850996)
 
     <!-- This file is generated automatically from metadata -->
     <!-- File edits may be overwritten! -->
 
 
-<a id="org492394f"></a>
+<a id="org2f9c034"></a>
 
 # Library Information
 
 -   **Name:** TMC2209
--   **Version:** 9.4.0
+-   **Version:** 9.4.1
 -   **License:** BSD
 -   **URL:** <https://github.com/janelia-arduino/TMC2209>
 -   **Author:** Peter Polidoro
@@ -30,7 +30,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="orgf7138df"></a>
+<a id="org46f7059"></a>
 
 # Stepper Motors
 
@@ -41,7 +41,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="orgf2cb8c3"></a>
+<a id="orga565949"></a>
 
 # Stepper Motor Controllers and Drivers
 
@@ -89,7 +89,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="orgb9a56de"></a>
+<a id="org7308e9d"></a>
 
 # Communication
 
@@ -391,7 +391,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="org3f9ff61"></a>
+<a id="org1c50612"></a>
 
 # Settings
 
@@ -546,7 +546,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="org6021d16"></a>
+<a id="orgaacfc7b"></a>
 
 # Examples
 
@@ -574,7 +574,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="org7006dc6"></a>
+<a id="orgdb15521"></a>
 
 # Hardware Documentation
 
@@ -609,7 +609,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="org33743be"></a>
+<a id="org0850996"></a>
 
 # Host Computer Setup
 

examples/BidirectionalCommunication/TestRP2040/TestRP2040.ino

@@ -1,18 +1,22 @@
 #include <TMC2209.h>
 
-// This example is meant to test the RP2040
+// This example is meant to test multiple ways of using bidirectional UART on RP2040
 //
 // See this reference for more details:
 // https://arduino-pico.readthedocs.io/en/latest/serial.html
 
-SerialUART & serial_stream1 = Serial1;
-HardwareSerial & serial_stream2 = Serial2;
-SerialPIO Serial3(27,26);
-
 const long SERIAL_BAUD_RATE = 115200;
 const int DELAY = 3000;
-const uint8_t SERIAL_RX_PIN1 = 9;
-const uint8_t SERIAL_TX_PIN1 = 8;
+const uint8_t SERIAL1_RX_PIN = 13;
+const uint8_t SERIAL1_TX_PIN = 12;
+const uint8_t SERIAL2_RX_PIN = 5;
+const uint8_t SERIAL2_TX_PIN = 4;
+const uint8_t SERIAL3_RX_PIN = 26;
+const uint8_t SERIAL3_TX_PIN = 27;
+
+SerialUART & serial_stream1 = Serial1;
+HardwareSerial & serial_stream2 = Serial2;
+SerialPIO Serial3(SERIAL3_TX_PIN, SERIAL3_RX_PIN);
 
 // Instantiate TMC2209
 TMC2209 stepper_driver1;
@@ -24,7 +28,10 @@ void setup()
 {
   Serial.begin(SERIAL_BAUD_RATE);
 
-  stepper_driver1.setup(serial_stream1, SERIAL_BAUD_RATE, TMC2209::SERIAL_ADDRESS_0, SERIAL_RX_PIN1, SERIAL_TX_PIN1);
+  Serial2.setRX(SERIAL2_RX_PIN);
+  Serial2.setTX(SERIAL2_TX_PIN);
+
+  stepper_driver1.setup(serial_stream1, SERIAL_BAUD_RATE, TMC2209::SERIAL_ADDRESS_0, SERIAL1_RX_PIN, SERIAL1_TX_PIN);
   stepper_driver2.setup(serial_stream2, SERIAL_BAUD_RATE);
   stepper_driver3.setup(Serial3, SERIAL_BAUD_RATE);
 }

examples/UnidirectionalCommunication/TestRP2040/TestRP2040.ino

@@ -0,0 +1,45 @@
+#include <TMC2209.h>
+
+// This example is meant to test a FYSETC-ERB board containing an RP2040 and
+// two TMC2209 chips
+//
+// See this reference for more details:
+// https://github.com/FYSETC/FYSETC-ERB
+
+
+const uint8_t X_TX_PIN = 20;
+const uint8_t Y_TX_PIN = 17;
+const long SERIAL_BAUD_RATE = 115200;
+
+SerialPIO x_serial(X_TX_PIN, SerialPIO::NOPIN);
+SerialPIO y_serial(Y_TX_PIN, SerialPIO::NOPIN);
+
+// Instantiate TMC2209
+TMC2209 x_stepper_driver;
+TMC2209 y_stepper_driver;
+
+// current values may need to be reduced to prevent overheating depending on
+// specific motor and power supply voltage
+const uint8_t RUN_CURRENT_PERCENT = 100;
+
+const int32_t RUN_VELOCITY = 20000;
+
+
+void setup()
+{
+  x_stepper_driver.setup(x_serial, SERIAL_BAUD_RATE);
+  x_stepper_driver.setRunCurrent(RUN_CURRENT_PERCENT);
+  x_stepper_driver.enableCoolStep();
+  x_stepper_driver.enable();
+  x_stepper_driver.moveAtVelocity(RUN_VELOCITY);
+
+  y_stepper_driver.setup(y_serial, SERIAL_BAUD_RATE);
+  y_stepper_driver.setRunCurrent(RUN_CURRENT_PERCENT);
+  y_stepper_driver.enableCoolStep();
+  y_stepper_driver.enable();
+  y_stepper_driver.moveAtVelocity(RUN_VELOCITY);
+}
+
+void loop()
+{
+}

library.properties

@@ -1,5 +1,5 @@
 name=TMC2209
-version=9.4.0
+version=9.4.1
 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.

platformio.ini

@@ -2,6 +2,7 @@
 src_dir = examples/UnidirectionalCommunication/MoveAtVelocity
 #src_dir = examples/UnidirectionalCommunication/SoftwareSerial
 #src_dir = examples/BidirectionalCommunication/TestRP2040
+#src_dir = examples/UnidirectionalCommunication/TestRP2040
 
 lib_dir = src
 default_envs = teensy40