You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+13-11
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ The Documentation of the TMC2209 can be found here:
28
28
29
29
The code is also available on [PyPI](https://pypi.org/project/PyTmcStepper).
30
30
31
-
## Installation
31
+
## Installation (on Raspberry Pi)
32
32
33
33
### Installation with PIP
34
34
@@ -95,16 +95,16 @@ is split into their own classes to be able to support the diverse methods.
95
95
96
96
EnableControl | Class | Driver | Notes
97
97
-- | -- | -- | --
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).
100
100
101
101
### MotionControl
102
102
103
103
MotionControl | Class | Driver | Notes
104
104
-- | -- | -- | --
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.
108
108
109
109
Further methods of controlling a motor could be:
110
110
@@ -116,8 +116,8 @@ Further methods of controlling a motor could be:
116
116
117
117
Com | Class | Driver | Notes
118
118
-- | -- | -- | --
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
121
121
122
122
## Wiring
123
123
@@ -179,23 +179,25 @@ if not, check the connection of the pin.
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.
187
188
A funtion will be called, if the driver detects a stall. The functionstops the current movement.
188
189
The motor will be moved 10 revolutions. If the movement is finished unhindered, the script outputs ```Movement finished successfully```.
189
190
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```
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.
0 commit comments