PyTmcStepper 0.14.0__tar.gz → 0.15.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/PKG-INFO +1 -1
  2. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/pyproject.toml +1 -1
  3. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/PyTmcStepper.egg-info/PKG-INFO +1 -1
  4. pytmcstepper-0.15.0/src/tmc_driver/_tmc_stepperdriver.py +210 -0
  5. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/_tmc_xxxx.py +6 -1
  6. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/_tmc_mc.py +12 -2
  7. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/_tmc_shared_regs.py +1 -1
  8. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_220x.py +1 -7
  9. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_2240.py +0 -13
  10. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_5160.py +0 -13
  11. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_modules.py +8 -0
  12. pytmcstepper-0.14.0/src/tmc_driver/_tmc_stepperdriver.py +0 -294
  13. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/LICENSE +0 -0
  14. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/README.md +0 -0
  15. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/setup.cfg +0 -0
  16. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/PyTmcStepper.egg-info/SOURCES.txt +0 -0
  17. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/PyTmcStepper.egg-info/dependency_links.txt +0 -0
  18. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/PyTmcStepper.egg-info/requires.txt +0 -0
  19. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/PyTmcStepper.egg-info/top_level.txt +0 -0
  20. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/__init__.py +0 -0
  21. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/_tmc_exceptions.py +0 -0
  22. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/_tmc_math.py +0 -0
  23. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/_tmc_stallguard.py +0 -0
  24. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/_tmc_validation.py +0 -0
  25. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/__init__.py +0 -0
  26. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com.py +0 -0
  27. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_spi.py +0 -0
  28. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_spi_base.py +0 -0
  29. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_spi_ftdi.py +0 -0
  30. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_spi_micropython.py +0 -0
  31. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_uart.py +0 -0
  32. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_uart_base.py +0 -0
  33. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/com/_tmc_com_uart_micropython.py +0 -0
  34. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/enable_control/__init__.py +0 -0
  35. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/enable_control/_tmc_ec.py +0 -0
  36. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/enable_control/_tmc_ec_pin.py +0 -0
  37. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/enable_control/_tmc_ec_toff.py +0 -0
  38. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/__init__.py +0 -0
  39. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/_tmc_mc_int_ramp_generator.py +0 -0
  40. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/_tmc_mc_step_dir.py +0 -0
  41. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/_tmc_mc_step_pwm_dir.py +0 -0
  42. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/_tmc_mc_step_reg.py +0 -0
  43. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/motion_control/_tmc_mc_vactual.py +0 -0
  44. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/platform_utils.py +0 -0
  45. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/__init__.py +0 -0
  46. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/_tmc2209_reg.py +0 -0
  47. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/_tmc220x_reg.py +0 -0
  48. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/_tmc224x_reg.py +0 -0
  49. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/_tmc5160_reg.py +0 -0
  50. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/reg/_tmc_reg.py +0 -0
  51. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_2208.py +0 -0
  52. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_2209.py +0 -0
  53. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/__init__.py +0 -0
  54. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/_tmc_gpio_board_base.py +0 -0
  55. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/_tmc_gpio_board_ftdi.py +0 -0
  56. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/_tmc_gpio_board_gpiozero.py +0 -0
  57. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/_tmc_gpio_board_micropython.py +0 -0
  58. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/_tmc_gpio_board_periphery.py +0 -0
  59. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_gpio/_tmc_gpio_board_rpi_gpio.py +0 -0
  60. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_logger/__init__.py +0 -0
  61. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_logger/_tmc_logger_base.py +0 -0
  62. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_logger/_tmc_logger_cpython.py +0 -0
  63. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/src/tmc_driver/tmc_logger/_tmc_logger_micropython.py +0 -0
  64. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc2209.py +0 -0
  65. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc2240.py +0 -0
  66. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_com_spi.py +0 -0
  67. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_com_uart.py +0 -0
  68. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_ec_pin.py +0 -0
  69. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_math.py +0 -0
  70. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_move.py +0 -0
  71. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_set_current.py +0 -0
  72. {pytmcstepper-0.14.0 → pytmcstepper-0.15.0}/tests/test_tmc_stallguard.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: PyTmcStepper
3
- Version: 0.14.0
3
+ Version: 0.15.0
4
4
  Summary: This is a Python libary to drive a stepper motor with a Trinamic stepper driver and a single board computer like a Raspberry Pi
5
5
  Author-email: Christian Köhlke <christian@koehlke.de>
6
6
  License-Expression: GPL-3.0
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "PyTmcStepper"
7
- version = "0.14.0"
7
+ version = "0.15.0"
8
8
  authors = [{ name = "Christian Köhlke", email = "christian@koehlke.de" }]
9
9
  description = "This is a Python libary to drive a stepper motor with a Trinamic stepper driver and a single board computer like a Raspberry Pi"
10
10
  readme = "README.md"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: PyTmcStepper
3
- Version: 0.14.0
3
+ Version: 0.15.0
4
4
  Summary: This is a Python libary to drive a stepper motor with a Trinamic stepper driver and a single board computer like a Raspberry Pi
5
5
  Author-email: Christian Köhlke <christian@koehlke.de>
6
6
  License-Expression: GPL-3.0
@@ -0,0 +1,210 @@
1
+ # pylint: disable=too-many-arguments
2
+ # pylint: disable=too-many-public-methods
3
+ # pylint: disable=too-many-branches
4
+ # pylint: disable=too-many-positional-arguments
5
+ # pylint: disable=import-outside-toplevel
6
+ # pylint: disable=bare-except
7
+ # pylint: disable=unused-import
8
+ # pylint: disable=wildcard-import
9
+ # pylint: disable=unused-wildcard-import
10
+ """TmcStepperDriver module
11
+
12
+ this module has the function to move the motor via STEP/DIR pins
13
+ """
14
+
15
+ try:
16
+ from typing import TYPE_CHECKING
17
+ except ImportError:
18
+ TYPE_CHECKING = False
19
+ from .tmc_gpio import Board
20
+ from . import tmc_gpio
21
+ from .motion_control._tmc_mc import (
22
+ TmcMotionControl,
23
+ MovementAbsRel,
24
+ MovementPhase,
25
+ StopMode,
26
+ Direction,
27
+ )
28
+ from .enable_control._tmc_ec import TmcEnableControl
29
+ from .enable_control._tmc_ec_pin import TmcEnableControlPin
30
+ from .motion_control._tmc_mc_step_dir import TmcMotionControlStepDir
31
+ from .motion_control._tmc_mc_step_pwm_dir import TmcMotionControlStepPwmDir
32
+ from .tmc_logger import *
33
+ from . import _tmc_math as tmc_math
34
+
35
+
36
+ class TmcStepperDriver:
37
+ """TmcStepperDriver
38
+
39
+ this class has two different functions:
40
+ 1. change setting in the TMC-driver via UART
41
+ 2. move the motor via STEP/DIR pins
42
+
43
+ Attributes forwarded to tmc_mc (motion control):
44
+ current_pos, current_pos_fullstep, mres, steps_per_rev, fullsteps_per_rev,
45
+ movement_abs_rel, movement_phase, speed, max_speed, max_speed_fullstep,
46
+ acceleration, acceleration_fullstep
47
+ """
48
+
49
+ # Attributes that are automatically forwarded to tmc_mc submodule
50
+ _MC_FORWARDED_ATTRS = {
51
+ "current_pos",
52
+ "current_pos_fullstep",
53
+ "mres",
54
+ "steps_per_rev",
55
+ "fullsteps_per_rev",
56
+ "movement_abs_rel",
57
+ "movement_phase",
58
+ "speed",
59
+ "max_speed",
60
+ "max_speed_fullstep",
61
+ "acceleration",
62
+ "acceleration_fullstep",
63
+ }
64
+
65
+ if TYPE_CHECKING:
66
+ # Type hints for IDE/type checkers - these attributes are forwarded via __getattr__
67
+ current_pos: int
68
+ current_pos_fullstep: int
69
+ mres: int
70
+ steps_per_rev: int
71
+ fullsteps_per_rev: int
72
+ movement_abs_rel: MovementAbsRel
73
+ movement_phase: MovementPhase
74
+ speed: float
75
+ max_speed: int
76
+ max_speed_fullstep: int
77
+ acceleration: int
78
+ acceleration_fullstep: int
79
+
80
+ # Constructor/Destructor
81
+ # ----------------------------
82
+ def __init__(
83
+ self,
84
+ tmc_ec: TmcEnableControl,
85
+ tmc_mc: TmcMotionControl,
86
+ gpio_mode=None,
87
+ loglevel: Loglevel = Loglevel.INFO,
88
+ logprefix: str | None = None,
89
+ log_handlers: list | None = None,
90
+ log_formatter: logging.Formatter | None = None,
91
+ ):
92
+ """constructor
93
+
94
+ Args:
95
+ tmc_ec (TmcEnableControl): TMC Enable Control object
96
+ tmc_mc (TmcMotionControl): TMC Motion Control object
97
+ gpio_mode (enum, optional): gpio mode. Defaults to None.
98
+ loglevel (enum, optional): loglevel. Defaults to None.
99
+ logprefix (str, optional): log prefix (name of the logger).
100
+ Defaults to None (standard TMC prefix).
101
+ log_handlers (list, optional): list of logging handlers.
102
+ Defaults to None (log to console).
103
+ log_formatter (logging.Formatter, optional): formatter for the log messages.
104
+ Defaults to None (messages are logged in the format
105
+ '%(asctime)s - %(name)s - %(levelname)s - %(message)s').
106
+ """
107
+ self.BOARD: Board = tmc_gpio.BOARD
108
+ self.tmc_ec = tmc_ec
109
+ self.tmc_mc = tmc_mc
110
+ self.tmc_logger: TmcLogger
111
+
112
+ if logprefix is None:
113
+ logprefix = "StepperDriver"
114
+ self.tmc_logger = TmcLogger(loglevel, logprefix, log_handlers, log_formatter)
115
+
116
+ self.tmc_logger.log("Init", Loglevel.INFO)
117
+
118
+ tmc_gpio.tmc_gpio.init(gpio_mode)
119
+
120
+ if self.tmc_mc is not None:
121
+ self.tmc_mc.init(self.tmc_logger)
122
+
123
+ if self.tmc_ec is not None:
124
+ self.tmc_ec.init(self.tmc_logger)
125
+
126
+ def __del__(self):
127
+ self.deinit()
128
+
129
+ def deinit(self):
130
+ """destructor"""
131
+ if hasattr(self, "tmc_ec") and self.tmc_ec is not None:
132
+ self.tmc_ec.deinit()
133
+ self.tmc_ec = None
134
+ if hasattr(self, "tmc_mc") and self.tmc_mc is not None:
135
+ self.tmc_mc.deinit()
136
+ self.tmc_mc = None
137
+ if hasattr(self, "tmc_logger") and self.tmc_logger is not None:
138
+ self.tmc_logger.deinit()
139
+ del self.tmc_logger
140
+
141
+ # Attribute Forwarding
142
+ # ----------------------------
143
+ def __getattr__(self, name):
144
+ """Forward attribute access to tmc_mc submodule dynamically"""
145
+ if name in self._MC_FORWARDED_ATTRS:
146
+ if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
147
+ raise AttributeError(
148
+ f"Cannot access '{name}': TmcMotionControl is not set"
149
+ )
150
+ return getattr(self.tmc_mc, name)
151
+
152
+ raise AttributeError(
153
+ f"'{type(self).__name__}' object has no attribute '{name}'"
154
+ )
155
+
156
+ def __setattr__(self, name, value):
157
+ """Forward attribute setting to tmc_mc submodule dynamically"""
158
+ # Forward to tmc_mc if it's a forwarded attribute and tmc_mc exists
159
+ if name in self._MC_FORWARDED_ATTRS:
160
+ # Only forward if tmc_mc is already initialized (not during __init__)
161
+ if hasattr(self, "tmc_mc") and self.tmc_mc is not None:
162
+ setattr(self.tmc_mc, name, value)
163
+ return
164
+ # During __init__, tmc_mc doesn't exist yet, so fall through
165
+
166
+ # Normal attribute assignment (self.tmc_mc, self.tmc_ec, etc.)
167
+ super().__setattr__(name, value)
168
+
169
+ # TmcEnableControl Wrapper
170
+ # ----------------------------
171
+ def set_motor_enabled(self, en: bool):
172
+ """enable control wrapper"""
173
+ if self.tmc_ec is not None:
174
+ self.tmc_ec.set_motor_enabled(en)
175
+
176
+ # TmcMotionControl Wrapper
177
+ # ----------------------------
178
+ def run_to_position_steps(
179
+ self, steps, movement_abs_rel: MovementAbsRel | None = None
180
+ ) -> StopMode:
181
+ """motioncontrol wrapper"""
182
+ if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
183
+ raise AttributeError("TmcMotionControl is not set")
184
+ return self.tmc_mc.run_to_position_steps(steps, movement_abs_rel)
185
+
186
+ def run_to_position_fullsteps(
187
+ self, steps, movement_abs_rel: MovementAbsRel | None = None
188
+ ) -> StopMode:
189
+ """motioncontrol wrapper"""
190
+ return self.run_to_position_steps(steps * self.mres, movement_abs_rel)
191
+
192
+ def run_to_position_revolutions(
193
+ self, revs, movement_abs_rel: MovementAbsRel | None = None
194
+ ) -> StopMode:
195
+ """motioncontrol wrapper"""
196
+ return self.run_to_position_steps(revs * self.steps_per_rev, movement_abs_rel)
197
+
198
+ def reset_position(self):
199
+ """resets the current position to 0"""
200
+ self.current_pos_fullstep = 0
201
+
202
+ # Test Methods
203
+ # ----------------------------
204
+ def test_step(self):
205
+ """test method"""
206
+ if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
207
+ raise AttributeError("TmcMotionControl is not set")
208
+ for _ in range(100):
209
+ self.tmc_mc.set_direction(Direction.CW)
210
+ self.tmc_mc.make_a_step()
@@ -271,13 +271,18 @@ class TmcXXXX(TmcStepperDriver):
271
271
  )
272
272
  return self.tmc_mc.mres
273
273
 
274
- @abstractmethod
275
274
  def set_microstepping_resolution(self, mres: int):
276
275
  """sets the current native microstep resolution (1,2,4,8,16,32,64,128,256)
277
276
 
278
277
  Args:
279
278
  mres (int): µstep resolution; has to be a power of 2 or 1 for fullstep
280
279
  """
280
+ if self.tmc_mc is not None:
281
+ self.tmc_mc.mres = mres
282
+
283
+ self.chopconf.read()
284
+ self.chopconf.mres_ms = mres
285
+ self.chopconf.write_check()
281
286
 
282
287
  @abstractmethod
283
288
  def set_current_peak(
@@ -55,6 +55,16 @@ class TmcMotionControl:
55
55
  """_current_pos setter"""
56
56
  self._current_pos = current_pos
57
57
 
58
+ @property
59
+ def current_pos_fullstep(self) -> int:
60
+ """_current_pos as fullstep property"""
61
+ return self.current_pos // self.mres
62
+
63
+ @current_pos_fullstep.setter
64
+ def current_pos_fullstep(self, current_pos: int):
65
+ """_current_pos as fullstep setter"""
66
+ self.current_pos = current_pos * self.mres
67
+
58
68
  @property
59
69
  def mres(self):
60
70
  """_mres property"""
@@ -130,7 +140,7 @@ class TmcMotionControl:
130
140
  @property
131
141
  def max_speed_fullstep(self):
132
142
  """_max_speed_fullstep property"""
133
- return self.max_speed * self.mres
143
+ return self.max_speed // self.mres
134
144
 
135
145
  @max_speed_fullstep.setter
136
146
  def max_speed_fullstep(self, max_speed_fullstep: int):
@@ -155,7 +165,7 @@ class TmcMotionControl:
155
165
  @property
156
166
  def acceleration_fullstep(self):
157
167
  """_acceleration_fullstep property"""
158
- return self._acceleration * self.mres
168
+ return self._acceleration // self.mres
159
169
 
160
170
  @acceleration_fullstep.setter
161
171
  def acceleration_fullstep(self, acceleration_fullstep: int):
@@ -111,7 +111,7 @@ class ChopConf(TmcReg):
111
111
  dedge: bool
112
112
  intpol: bool
113
113
  mres: int
114
- mres_ms: bool
114
+ mres_ms: int
115
115
  tbl: int
116
116
  hend: int
117
117
  hstrt: int
@@ -326,13 +326,7 @@ class Tmc220x(TmcXXXX):
326
326
  Args:
327
327
  mres (int): µstep resolution; has to be a power of 2 or 1 for fullstep
328
328
  """
329
- if self.tmc_mc is not None:
330
- self.tmc_mc.mres = mres
331
-
332
- self.chopconf.read()
333
- self.chopconf.mres_ms = mres
334
- self.chopconf.write_check()
335
-
329
+ super().set_microstepping_resolution(mres)
336
330
  self.set_mstep_resolution_reg_select(True)
337
331
 
338
332
  def set_mstep_resolution_reg_select(self, en: bool):
@@ -282,19 +282,6 @@ class Tmc2240(TmcXXXX, StallGuard):
282
282
  """
283
283
  self.gconf.modify("en_pwm_mode", not en)
284
284
 
285
- def set_microstepping_resolution(self, mres: int):
286
- """sets the current native microstep resolution (1,2,4,8,16,32,64,128,256)
287
-
288
- Args:
289
- mres (int): µstep resolution; has to be a power of 2 or 1 for fullstep
290
- """
291
- if self.tmc_mc is not None:
292
- self.tmc_mc.mres = mres
293
-
294
- self.chopconf.read()
295
- self.chopconf.mres_ms = mres
296
- self.chopconf.write_check()
297
-
298
285
  def get_interface_transmission_counter(self) -> int:
299
286
  """reads the interface transmission counter from the tmc register
300
287
  this value is increased on every succesfull write access
@@ -264,19 +264,6 @@ class Tmc5160(TmcXXXX, StallGuard):
264
264
  """
265
265
  self.gconf.modify("en_pwm_mode", not en)
266
266
 
267
- def set_microstepping_resolution(self, mres: int):
268
- """sets the current native microstep resolution (1,2,4,8,16,32,64,128,256)
269
-
270
- Args:
271
- mres (int): µstep resolution; has to be a power of 2 or 1 for fullstep
272
- """
273
- if self.tmc_mc is not None:
274
- self.tmc_mc.mres = mres
275
-
276
- self.chopconf.read()
277
- self.chopconf.mres_ms = mres
278
- self.chopconf.write_check()
279
-
280
267
  def get_interface_transmission_counter(self) -> int:
281
268
  """reads the interface transmission counter from the tmc register
282
269
  this value is increased on every succesfull write access
@@ -165,6 +165,14 @@ class TestTMCModules(unittest.TestCase):
165
165
  self.assertIsInstance(instance.tmc_mc, mc.__class__)
166
166
  self.assertIsInstance(instance.tmc_com, com.__class__)
167
167
 
168
+ instance.set_microstepping_resolution(2)
169
+
170
+ instance.acceleration_fullstep = 1000
171
+ instance.max_speed_fullstep = 250
172
+
173
+ self.assertEqual(instance.acceleration_fullstep, 1000)
174
+ self.assertEqual(instance.max_speed_fullstep, 250)
175
+
168
176
  instance.set_motor_enabled(True)
169
177
  instance.set_motor_enabled(False)
170
178
 
@@ -1,294 +0,0 @@
1
- # pylint: disable=too-many-arguments
2
- # pylint: disable=too-many-public-methods
3
- # pylint: disable=too-many-branches
4
- # pylint: disable=too-many-positional-arguments
5
- # pylint: disable=import-outside-toplevel
6
- # pylint: disable=bare-except
7
- # pylint: disable=unused-import
8
- # pylint: disable=wildcard-import
9
- # pylint: disable=unused-wildcard-import
10
- """TmcStepperDriver module
11
-
12
- this module has the function to move the motor via STEP/DIR pins
13
- """
14
-
15
- from .tmc_gpio import Board
16
- from . import tmc_gpio
17
- from .motion_control._tmc_mc import (
18
- TmcMotionControl,
19
- MovementAbsRel,
20
- MovementPhase,
21
- StopMode,
22
- Direction,
23
- )
24
- from .enable_control._tmc_ec import TmcEnableControl
25
- from .enable_control._tmc_ec_pin import TmcEnableControlPin
26
- from .motion_control._tmc_mc_step_dir import TmcMotionControlStepDir
27
- from .motion_control._tmc_mc_step_pwm_dir import TmcMotionControlStepPwmDir
28
- from .tmc_logger import *
29
- from . import _tmc_math as tmc_math
30
-
31
-
32
- class TmcStepperDriver:
33
- """TmcStepperDriver
34
-
35
- this class has two different functions:
36
- 1. change setting in the TMC-driver via UART
37
- 2. move the motor via STEP/DIR pins
38
- """
39
-
40
- # Constructor/Destructor
41
- # ----------------------------
42
- def __init__(
43
- self,
44
- tmc_ec: TmcEnableControl,
45
- tmc_mc: TmcMotionControl,
46
- gpio_mode=None,
47
- loglevel: Loglevel = Loglevel.INFO,
48
- logprefix: str | None = None,
49
- log_handlers: list | None = None,
50
- log_formatter: logging.Formatter | None = None,
51
- ):
52
- """constructor
53
-
54
- Args:
55
- pin_en (int): EN pin number
56
- pin_step (int, optional): STEP pin number. Defaults to -1.
57
- pin_dir (int, optional): DIR pin number. Defaults to -1.
58
- tmc_com (TmcUart, optional): TMC UART object. Defaults to None.
59
- driver_address (int, optional): driver address [0-3]. Defaults to 0.
60
- gpio_mode (enum, optional): gpio mode. Defaults to None.
61
- loglevel (enum, optional): loglevel. Defaults to None.
62
- logprefix (str, optional): log prefix (name of the logger).
63
- Defaults to None (standard TMC prefix).
64
- log_handlers (list, optional): list of logging handlers.
65
- Defaults to None (log to console).
66
- log_formatter (logging.Formatter, optional): formatter for the log messages.
67
- Defaults to None (messages are logged in the format
68
- '%(asctime)s - %(name)s - %(levelname)s - %(message)s').
69
- """
70
- self.BOARD: Board = tmc_gpio.BOARD
71
- self.tmc_ec = tmc_ec
72
- self.tmc_mc = tmc_mc
73
- self.tmc_logger: TmcLogger
74
-
75
- if logprefix is None:
76
- logprefix = "StepperDriver"
77
- self.tmc_logger = TmcLogger(loglevel, logprefix, log_handlers, log_formatter)
78
-
79
- self.tmc_logger.log("Init", Loglevel.INFO)
80
-
81
- tmc_gpio.tmc_gpio.init(gpio_mode)
82
-
83
- if self.tmc_mc is not None:
84
- self.tmc_mc.init(self.tmc_logger)
85
-
86
- if self.tmc_ec is not None:
87
- self.tmc_ec.init(self.tmc_logger)
88
-
89
- def __del__(self):
90
- self.deinit()
91
-
92
- def deinit(self):
93
- """destructor"""
94
- if hasattr(self, "tmc_ec") and self.tmc_ec is not None:
95
- self.tmc_ec.deinit()
96
- self.tmc_ec = None
97
- if hasattr(self, "tmc_mc") and self.tmc_mc is not None:
98
- self.tmc_mc.deinit()
99
- self.tmc_mc = None
100
- if hasattr(self, "tmc_logger") and self.tmc_logger is not None:
101
- self.tmc_logger.deinit()
102
- del self.tmc_logger
103
-
104
- # TmcEnableControl Wrapper
105
- # ----------------------------
106
- def set_motor_enabled(self, en: bool):
107
- """enable control wrapper"""
108
- if self.tmc_ec is not None:
109
- self.tmc_ec.set_motor_enabled(en)
110
-
111
- # TmcMotionControl Wrapper
112
- # ----------------------------
113
- @property
114
- def current_pos(self) -> int:
115
- """_current_pos property"""
116
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
117
- raise AttributeError("TmcMotionControl is not set")
118
- return self.tmc_mc.current_pos
119
-
120
- @current_pos.setter
121
- def current_pos(self, current_pos: int):
122
- """_current_pos setter"""
123
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
124
- raise AttributeError("TmcMotionControl is not set")
125
- self.tmc_mc.current_pos = current_pos
126
-
127
- @property
128
- def current_pos_fullstep(self) -> int:
129
- """_current_pos as fullstep property"""
130
- return self.current_pos // self.mres
131
-
132
- @current_pos_fullstep.setter
133
- def current_pos_fullstep(self, current_pos: int):
134
- """_current_pos as fullstep setter"""
135
- self.current_pos = current_pos * self.mres
136
-
137
- @property
138
- def mres(self) -> int:
139
- """_mres property"""
140
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
141
- raise AttributeError("TmcMotionControl is not set")
142
- return self.tmc_mc.mres
143
-
144
- @mres.setter
145
- def mres(self, mres: int):
146
- """_mres setter"""
147
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
148
- raise AttributeError("TmcMotionControl is not set")
149
- self.tmc_mc.mres = mres
150
-
151
- @property
152
- def steps_per_rev(self) -> int:
153
- """_steps_per_rev property"""
154
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
155
- raise AttributeError("TmcMotionControl is not set")
156
- return self.tmc_mc.steps_per_rev
157
-
158
- @property
159
- def fullsteps_per_rev(self) -> int:
160
- """_fullsteps_per_rev property"""
161
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
162
- raise AttributeError("TmcMotionControl is not set")
163
- return self.tmc_mc.fullsteps_per_rev
164
-
165
- @fullsteps_per_rev.setter
166
- def fullsteps_per_rev(self, fullsteps_per_rev: int):
167
- """_fullsteps_per_rev setter"""
168
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
169
- raise AttributeError("TmcMotionControl is not set")
170
- self.tmc_mc.fullsteps_per_rev = fullsteps_per_rev
171
-
172
- @property
173
- def movement_abs_rel(self) -> MovementAbsRel:
174
- """_movement_abs_rel property"""
175
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
176
- raise AttributeError("TmcMotionControl is not set")
177
- return self.tmc_mc.movement_abs_rel
178
-
179
- @movement_abs_rel.setter
180
- def movement_abs_rel(self, movement_abs_rel: MovementAbsRel):
181
- """_movement_abs_rel setter"""
182
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
183
- raise AttributeError("TmcMotionControl is not set")
184
- self.tmc_mc.movement_abs_rel = movement_abs_rel
185
-
186
- @property
187
- def movement_phase(self) -> MovementPhase:
188
- """_movement_phase property"""
189
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
190
- raise AttributeError("TmcMotionControl is not set")
191
- return self.tmc_mc.movement_phase
192
-
193
- @property
194
- def speed(self) -> float:
195
- """_speed property"""
196
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
197
- raise AttributeError("TmcMotionControl is not set")
198
- return self.tmc_mc.speed
199
-
200
- @speed.setter
201
- def speed(self, speed: int):
202
- """_speed setter"""
203
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
204
- raise AttributeError("TmcMotionControl is not set")
205
- self.tmc_mc.speed = speed
206
-
207
- @property
208
- def max_speed(self) -> int:
209
- """_max_speed property"""
210
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
211
- raise AttributeError("TmcMotionControl is not set")
212
- return self.tmc_mc.max_speed
213
-
214
- @max_speed.setter
215
- def max_speed(self, speed: int):
216
- """_max_speed setter"""
217
- if self.tmc_mc is not None:
218
- self.tmc_mc.max_speed = speed
219
-
220
- @property
221
- def max_speed_fullstep(self) -> int:
222
- """_max_speed_fullstep property"""
223
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
224
- raise AttributeError("TmcMotionControl is not set")
225
- return self.tmc_mc.max_speed_fullstep
226
-
227
- @max_speed_fullstep.setter
228
- def max_speed_fullstep(self, max_speed_fullstep: int):
229
- """_max_speed_fullstep setter"""
230
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
231
- raise AttributeError("TmcMotionControl is not set")
232
- self.tmc_mc.max_speed_fullstep = max_speed_fullstep
233
-
234
- @property
235
- def acceleration(self) -> int:
236
- """_acceleration property"""
237
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
238
- raise AttributeError("TmcMotionControl is not set")
239
- return self.tmc_mc.acceleration
240
-
241
- @acceleration.setter
242
- def acceleration(self, acceleration: int):
243
- """_acceleration setter"""
244
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
245
- raise AttributeError("TmcMotionControl is not set")
246
- self.tmc_mc.acceleration = acceleration
247
-
248
- @property
249
- def acceleration_fullstep(self) -> int:
250
- """_acceleration_fullstep property"""
251
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
252
- raise AttributeError("TmcMotionControl is not set")
253
- return self.tmc_mc.acceleration_fullstep
254
-
255
- @acceleration_fullstep.setter
256
- def acceleration_fullstep(self, acceleration_fullstep: int):
257
- """_acceleration_fullstep setter"""
258
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
259
- raise AttributeError("TmcMotionControl is not set")
260
- self.tmc_mc.acceleration_fullstep = acceleration_fullstep
261
-
262
- def run_to_position_steps(
263
- self, steps, movement_abs_rel: MovementAbsRel | None = None
264
- ) -> StopMode:
265
- """motioncontrol wrapper"""
266
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
267
- raise AttributeError("TmcMotionControl is not set")
268
- return self.tmc_mc.run_to_position_steps(steps, movement_abs_rel)
269
-
270
- def run_to_position_fullsteps(
271
- self, steps, movement_abs_rel: MovementAbsRel | None = None
272
- ) -> StopMode:
273
- """motioncontrol wrapper"""
274
- return self.run_to_position_steps(steps * self.mres, movement_abs_rel)
275
-
276
- def run_to_position_revolutions(
277
- self, revs, movement_abs_rel: MovementAbsRel | None = None
278
- ) -> StopMode:
279
- """motioncontrol wrapper"""
280
- return self.run_to_position_steps(revs * self.steps_per_rev, movement_abs_rel)
281
-
282
- def reset_position(self):
283
- """resets the current position to 0"""
284
- self.current_pos_fullstep = 0
285
-
286
- # Test Methods
287
- # ----------------------------
288
- def test_step(self):
289
- """test method"""
290
- if not hasattr(self, "tmc_mc") or self.tmc_mc is None:
291
- raise AttributeError("TmcMotionControl is not set")
292
- for _ in range(100):
293
- self.tmc_mc.set_direction(Direction.CW)
294
- self.tmc_mc.make_a_step()
File without changes
File without changes
File without changes