Add block diagram and wiring information to the documentation

janelia-arduino · Sep 29, 2022 · 415c8fe · 415c8fe
1 parent ee65ea3
commit 415c8fe
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 2 deletions.
diff --git a/README.org b/README.org
@@ -4,7 +4,7 @@
 
 * Library Information
 - Name :: TMC429
-- Version :: 1.3.2
+- Version :: 1.3.3
 - License :: BSD
 - URL :: https://github.com/janelia-arduino/TMC429
 - Author :: Peter Polidoro
@@ -54,5 +54,23 @@ stepper motor controller.
 
 [[./images/stepper_driver.png]]
 
+* TMC429
 
+[[./images/block_diagram.png]]
 
+** Wiring
+
+[[https://github.com/janelia-kicad/stepper_controller_3x2][Example Circuit Board]]
+
+*** Required
+
+- Power supply (3.3V or 5V)
+- Clock (4-32MHz)
+- SPI to microcontroller (MOSI, MISO, SCK, CS)
+- Step and Direction signals to each of the stepper drivers
+
+*** Optional
+
+- INT and POSCOMP signals to microcontroller
+- Reference signals (left and/or right) from limit switches attached to each
+  stepper motor
diff --git a/images/block_diagram.png b/images/block_diagram.png
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=TMC429
-version=1.3.2
+version=1.3.3
 author=Peter Polidoro <peter@polidoro.io>
 maintainer=Peter Polidoro <peter@polidoro.io>
 sentence=Trinamic TMC429 triple-axis dedicated step and direction motion controller.