Skip to content

Commit 0863396

Browse files
committed
updated readme
1 parent b0c4148 commit 0863396

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The Documentation of the TMC2209 can be found here:
2828

2929
The code is also available on [PyPI](https://pypi.org/project/PyTmcStepper).
3030

31-
## Installation
31+
## Installation (on Raspberry Pi)
3232

3333
### Installation with PIP
3434

@@ -95,16 +95,16 @@ is split into their own classes to be able to support the diverse methods.
9595

9696
EnableControl | Class | Driver | Notes
9797
-- | -- | -- | --
98-
Pin | TmcEnableControlPin | all | the EN Pin of the Driver needs to be connected to a GPIO of the Pi
99-
TOff | TmcEnableControlToff | all | the EN Pin needs to be connected to GND.<br />On the TMC2209 this enables current Output on Startup!<br />On the TMC2240 this works fine, because TOff is per default 0 (off).
98+
Pin | [TmcEnableControlPin](src/tmc_driver/enable_control/_tmc_ec_pin.py) | all | the EN Pin of the Driver needs to be connected to a GPIO of the Pi
99+
TOff | [TmcEnableControlToff](src/tmc_driver/enable_control/_tmc_ec_toff.py) | all | the EN Pin needs to be connected to GND.<br />On the TMC2209 this enables current Output on Startup!<br />On the TMC2240 this works fine, because TOff is per default 0 (off).
100100

101101
### MotionControl
102102

103103
MotionControl | Class | Driver | Notes
104104
-- | -- | -- | --
105-
STEP/DIR | TmcMotionControlStepDir | all | the STEP and DIR pin of the driver must each be connected to a GPIO of the Pi
106-
STEP/REG | TmcMotionControlStepReg | all | only the STEP pin needs to be connected to a GPIO of the Pi.<br />The direction is controlled via the Register.
107-
VACTUAL | TmcMotionControlVActual | TMC220x | the Direction and Speed is controlled via Register. But VActual does only allow setting a speed and therefore cannot control positioning of the Motor.
105+
STEP/DIR | [TmcMotionControlStepDir](src/tmc_driver/motion_control/_tmc_mc_step_dir.py) | all | the STEP and DIR pin of the driver must each be connected to a GPIO of the Pi
106+
STEP/REG | [TmcMotionControlStepReg](src/tmc_driver/motion_control/_tmc_mc_step_reg.py) | all | only the STEP pin needs to be connected to a GPIO of the Pi.<br />The direction is controlled via the Register.
107+
VACTUAL | [TmcMotionControlVActual](src/tmc_driver/motion_control/_tmc_mc_vactual.py) | TMC220x | the Direction and Speed is controlled via Register. But VActual does only allow setting a speed and therefore cannot control positioning of the Motor.
108108

109109
Further methods of controlling a motor could be:
110110

@@ -116,8 +116,8 @@ Further methods of controlling a motor could be:
116116

117117
Com | Class | Driver | Notes
118118
-- | -- | -- | --
119-
UART | TmcComUart | all | Communication via UART (RX, TX). See [Wiring](#uart)<br />[pyserial](https://pypi.org/project/pyserial) needs to be installed
120-
SPI | TmcComSpi | TMC2240 | Communication via SPI (MOSI, MISO, CLK, CS). See [Wiring](#spi)<br />[spidev](https://pypi.org/project/spidev) needs to be installed
119+
UART | [TmcComUart](src/tmc_driver/com/_tmc_com_uart.py) | all | Communication via UART (RX, TX). See [Wiring](#uart)<br />[pyserial](https://pypi.org/project/pyserial) needs to be installed
120+
SPI | [TmcComSpi](src/tmc_driver/com/_tmc_com_spi.py) | TMC2240 | Communication via SPI (MOSI, MISO, CLK, CS). See [Wiring](#spi)<br />[spidev](https://pypi.org/project/spidev) needs to be installed
121121

122122
## Wiring
123123

@@ -179,23 +179,25 @@ if not, check the connection of the pin.
179179

180180
### [demo_script_03_basic_movement.py](demo/demo_script_03_basic_movement.py)
181181

182-
This script should move the motor 6 times, one revolution back and forth.
182+
This script shows the different functions available to move the motors.
183+
The motor is moved 4 times one revolution back and forth.
183184

184185
### [demo_script_04_stallguard.py](demo/demo_script_04_stallguard.py)
185186

186-
In this script the stallguard feature of the TMC2209 is beeing setup.
187+
In this script the stallguard feature of the TMC2209 is being setup.
187188
A funtion will be called, if the driver detects a stall. The function stops the current movement.
188189
The motor will be moved 10 revolutions. If the movement is finished unhindered, the script outputs ```Movement finished successfully```.
189190
If you block the motor with pliers or something similar, the the motor will stop and the script outputs ```StallGuard!``` and ```Movement was not completed```
190191

191192
### [demo_script_05_vactual.py](demo/demo_script_05_vactual.py)
192193

193-
VACTUAL allows moving the motor by UART control. It gives the motor velocity in +-(2^23)-1 [μsteps / t]
194+
VACTUAL enables the motor to be moved via the COM interface (UART) without additional GPIOs. The motor speed is transmitted as a value in +-(2^23)-1 [µsteps / t] via the COM interface.
194195

195196
### [demo_script_06_multiple_drivers.py](demo/demo_script_06_multiple_drivers.py)
196197

197198
Multiple drivers can be addressed via UART by setting different addresses with the MS1 and MS2 pins.
198199
Simultaneous movement of multiple motors can be done with threaded movement.
200+
When using SPI different Drivers are accessed via the Chip Select pin.
199201

200202
### [demo_script_07_threads.py](demo/demo_script_07_threads.py)
201203

0 commit comments

Comments
 (0)