User Manual

ManualsBrandsTrinamic ManualsAutomationStepper Motor Controller 1.4A 30V

Module for Stepper Motors

MODULE

TMCM-1210 TMCL

™

Firmware Manual

Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19

The TMCM-1210 is a single axis controller/driver module for 2-phase bipolar stepper motors. The

TMCM-1210 TMCL ﬁrmware allows to control the module using TMCL™ commands, supporting

standalone operation as well as direct mode control, making use of the Trinamic TMC5130 con-

troller. Dynamic current control, and quiet, smooth and eﬃcient operation are combined with

stealthChop™, dcStep™, stallGuard™ and coolStep™ features.

Features

• Single Axis Stepper motor control

• Supply voltage 24V DC

• TMCL™

• RS485 interface

• coolStep™

• dcStep™

• stallGuard2™

• stealthChop™

Applications

• Laboratory Automation

• Manufacturing

• Semiconductor Handling

• Robotics

• Factory Automation

• Test & Measurement

• Life Science

• Biotechnology

• Liquid Handling

Simpliﬁed Block Diagram

12...24V DC

ARM-Cortex-M0+™

microcontroller

TMCL™

Memory

Step

Motor

RS485

TMC5130

Bipolar stepper

motor

controller + driver

TMCM-1210

I2C

SPI

Input

I2C

A/B

REFL/REFR

Hall

Encoder

Terms of delivery and rights to technical change reserved.

Download newest version at: www.trinamic.com

Read entire documentation.

Summary of content (96 pages)

PAGE 1
MODULE Module for Stepper Motors TMCM-1210 TMCL™ Firmware Manual Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 The TMCM-1210 is a single axis controller/driver module for 2-phase bipolar stepper motors. The TMCM-1210 TMCL ﬁrmware allows to control the module using TMCL™ commands, supporting standalone operation as well as direct mode control, making use of the Trinamic TMC5130 controller.
PAGE 2
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 2 / 96 Contents 1 Features 1.1 stallGuard2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 coolStep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 5 6 2 First Steps with TMCL 2.1 Basic Setup . . . . . . . . . . . . . . . . 2.2 Using the TMCL Direct Mode . . . . . 2.3 Changing Axis Parameters . . . . .
PAGE 3
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.27 3.6.28 3.6.29 3.6.30 3.6.31 3.6.32 3.6.33 3.6.34 3.6.35 3 / 96 AGP (Accu to Global Parameter) . . . . . . . . . . . . . . . . . . . . . . . CLE (Clear Error Flags) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EI (Enable Interrupt) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DI (Disable Interrupt) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 4
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 4 / 96 12 Revision History 96 12.1 Firmware Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 12.2 Document Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.
PAGE 5
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 1 5 / 96 Features The TMCM-1210 is a single axis controller/driver module for 2-phase bipolar stepper motors with state of the art feature set. It is highly integrated, offers a convenient handling and can be used in many decentralized applications. The module has been designed for coil currents up to 0.7A RMS and 24V DC supply voltage. One additional general purpose digital input is there e.g.
PAGE 6
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 6 / 96 stallGuard2 Load [Nm] Initial stallGuard2 (SG) value: 100% Max. load stallGuard2 (SG) value: 0 Maximum load reached. Motor close to stall. Motor stalls Figure 1: stallGuard2 Load Measurement as a Function of Load 1.2 coolStep coolStep is a load-adaptive automatic current scaling based on the load measurement via stallGuard2 adapting the required current to the load.
PAGE 7
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 2 7 / 96 First Steps with TMCL In this chapter you can ﬁnd some hints for your ﬁrst steps with the TMCM-1210 and TMCL. You may skip this chapter if you are already familiar with TMCL and the TMCL-IDE. Things that you will need • Your TMCM-1210 module. • An RS485 interface. • A power supply (24V DC) for your TMCM-1210 module. • The TMCL-IDE 3.
PAGE 8
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 8 / 96 Most important axis parameters Number Axis Parameter Description Range [Units] Access 4 Maximum positioning speed The maximum speed used for positioning ramps. 0. . . 7999774 [pps] RW 5 Maximum acceleration Maximum acceleration in positioning ramps. Acceleration and deceleration value in velocity mode. 0. . . 7629278 [pps2 ] RW 6 Maximum current Motor current used when motor is running.
PAGE 9
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 9 / 96 7 9 11 13 15 SAP 4 , 0 , 51200 SAP 5 , 0 , 51200 Loop : MVP ABS , 0 , 512000 WAIT POS , 0 , 0 MVP ABS , 0 , -512000 WAIT POS , 0 , 0 JA Loop // Set max . Velocity // Set max . Acceleration // Move to Position 512000 // Wait until position reached // Move to Position -512000 // Wait until position reached // Infinite Loop After you have done that, take the following steps: 1.
PAGE 10
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3 10 / 96 TMCL and the TMCL-IDE — An Introduction As with most TRINAMIC modules the software running on the microprocessor of the TMCM-1210 consists of two parts, a boot loader and the ﬁrmware itself. Whereas the boot loader is installed during production and testing at TRINAMIC and remains untouched throughout the whole lifetime, the ﬁrmware can be updated by the user.
PAGE 11
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 11 / 96 TMCL Command Format Bytes Meaning 1 Module address 1 Command number 1 Type number 1 Motor or Bank number 4 Value (MSB ﬁrst!) 1 Checksum Table 2: TMCL Command Format Info Note 3.1.1 The checksum is calculated by accumulating all the other bytes using an 8-bit addition. When using the CAN interface, leave out the address byte and the checksum byte.
PAGE 12
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.2 12 / 96 Reply Format Every time a command has been sent to a module, the module sends a reply. The reply format with RS-232, RS-485, RS-422 and USB is as follows: TMCL Reply Format Bytes Meaning 1 Reply address 1 Module address 1 Status (e.g.
PAGE 13
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.3 13 / 96 Standalone Applications The module is equipped with a TMCL memory for storing TMCL applications. You can use the TMCL-IDE for developing standalone TMCL applications. You can download a program into the EEPROM and afterwards it will run on the module. The TMCL-IDE contains an editor and the TMCL assembler where the commands can be entered using their mnemonic format.
PAGE 14
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.4 14 / 96 TMCL Command Overview This sections gives a short overview of all TMCL commands. 3.4.
PAGE 15
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.
PAGE 16
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 16 / 96 Parameter Commands Mnemonic Command number Meaning SAP 5 Set axis parameter GAP 6 Get axis parameter SGP 9 Set global parameter GGP 10 Get global parameter STGP 11 Store global parameter RSGP 12 Restore global parameter Table 7: Parameter Commands 3.5.3 Branch Commands These commands are used to control the program ﬂow (loops, conditions, jumps etc.).
PAGE 17
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.5.5 17 / 96 Calculation Commands These commands are intended to be used for calculations within TMCL applications. Although they could also be used in direct mode it does not make much sense to do so.
PAGE 18
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 18 / 96 Interrupt Vectors Interrupt number Interrupt type 0 Timer 0 1 Timer 1 2 Timer 2 3 Target position reached 0 15 stallGuard axis 0 21 Deviation axis 0 27 Left stop switch 0 28 Right stop switch 0 39 Input change 0 255 Global interrupts Table 12: Interrupt Vectors 3.5.6.
PAGE 19
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.
PAGE 20
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6 20 / 96 Detailed TMCL Command Descriptions The module speciﬁc commands are explained in more detail on the following pages. They are listed according to their command number. 3.6.1 ROR (Rotate Right) The motor is instructed to rotate with a speciﬁed velocity in right direction (increasing the position counter). The velocity is given in microsteps per second (pulse per second [pps]).
PAGE 21
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.2 21 / 96 ROL (Rotate Left) The motor is instructed to rotate with a speciﬁed velocity in left direction (decreasing the position counter). The velocity is given in microsteps per second (pulse per second [pps]). Internal function: • First, velocity mode is selected. • Then, the velocity value is transferred to axis parameter #2 (target velocity). Related commands: ROR, MST, SAP, GAP.
PAGE 22
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.3 22 / 96 MST (Motor Stop) The motor is instructed to stop with a soft stop. Internal function: The velocity mode is selected. Then, the target speed (axis parameter #0) is set to zero. Related commands: ROR, ROL, SAP, GAP. Mnemonic: MST Binary Representation Instruction Type Motor/Bank Value 3 0 0 0 Reply in Direct Mode Status Value 100 - OK don’t care Example Stop motor 0.
PAGE 23
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.4 23 / 96 MVP (Move to Position) With this command the motor will be instructed to move to a speciﬁed relative or absolute position. It will use the acceleration/deceleration ramp and the positioning speed programmed into the unit. This command is non-blocking - that is, a reply will be sent immediately after command interpretation and initialization of the motion controller.
PAGE 24
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Binary Form of MVP ABS, 0, 90000 Field Value Target address 01h Instruction number 04h Type 00h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 10h Value (Byte 1) 5Fh Value (Byte 0) 90h Checksum F5h Example Move motor 0 from current position 10000 microsteps backward.
PAGE 25
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 25 / 96 Binary Form of MVP COORD, 0, 8 Field Value Target address 01h Instruction number 04h Type 02h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 08h Checksum 0Fh Note Before moving to a stored coordinate, the coordinate has to be set using an SCO, CCO or ACO command. ©2017 TRINAMIC Motion Control GmbH & Co.
PAGE 26
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.5 26 / 96 SAP (Set Axis Parameter) With this command most of the motion control parameters of the module can be speciﬁed. The settings will be stored in SRAM and therefore are volatile. That is, information will be lost after power off. For a table with parameters and values which can be used together with this command please refer to section 4.
PAGE 27
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.6 27 / 96 GAP (Get Axis Parameter) Most motion / driver related parameters of the TMCM-1210 can be adjusted using e.g. the SAP command. With the GAP parameter they can be read out. In standalone mode the requested value is also transferred to the accumulator register for further processing purposes (such as conditional jumps).
PAGE 28
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.7 28 / 96 SGP (Set Global Parameter) With this command most of the module speciﬁc parameters not directly related to motion control can be speciﬁed and the TMCL user variables can be changed. Global parameters are related to the host interface, peripherals or application speciﬁc variables. The different groups of these parameters are organized in banks to allow a larger total number for future products.
PAGE 29
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.8 29 / 96 GGP (Get Global Parameter) All global parameters can be read with this function. Global parameters are related to the host interface, peripherals or application speciﬁc variables. The different groups of these parameters are organized in banks to allow a larger total number for future products. Currently, bank 0 is used for global parameters, and bank 2 is used for user variables.
PAGE 30
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.9 30 / 96 STGP (Store Global Parameter) This command is used to store TMCL global parameters permanently in the EEPROM of the module. This command is mainly needed to store the TMCL user variables (located in bank 2) in the EEPROM of the module, as most other global parameters (located in bank 0) are stored automatically when being modiﬁed.
PAGE 31
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.10 31 / 96 RSGP (Restore Global Parameter) With this command the contents of a TMCL user variable can be restored from the EEPROM. By default, all user variables are automatically restored after power up. A user variable that has been changed before can be reset to the stored value by this instruction.
PAGE 32
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.11 32 / 96 RFS (Reference Search) The TMCM-1210 has a built-in reference search algorithm. The reference search algorithm provides different refrence search modes. This command starts or stops the built-in reference search algorithm. The status of the reference search can also be queried to see if it already has ﬁnished.
PAGE 33
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Binary Form of RFS START Field Value Target address 01h Instruction number 0Dh Type 00h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 00h Checksum 0Eh ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.com Read entire documentation.
PAGE 34
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.12 34 / 96 GIO (Get Input) With this command the status of the available general purpose outputs of the module can be read. The function reads a digital or an analog input port. Digital input ports will read as 0 or 1. In standalone mode the requested value is copied to the accumulator register for further processing purposes such as conditional jumps.
PAGE 35
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 35 / 96 Reply (Status=no error, Value=302) Field Value Host address 02h Target address 01h Status 64h Instruction 0Fh Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 01h Value (Byte 0) 2Eh Checksum A5h Bank 0 – Digital Inputs The digital input states can be accessed in bank 0.
PAGE 36
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.13 36 / 96 CALC (Calculate) A value in the accumulator variable, previously read by a function such as GAP (get axis parameter) can be modiﬁed with this instruction. Nine different arithmetic functions can be chosen and one constant operand value must be speciﬁed. The result is written back to the accumulator, for further processing like comparisons or data transfer.
PAGE 37
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.
PAGE 38
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.14 38 / 96 COMP (Compare) The speciﬁed number is compared to the value in the accumulator register. The result of the comparison can for example be used by the conditional jump (JC) instruction. This command is intended for use in standalone operation only. Internal function: The accumulator register is compared with the sepciﬁed value.
PAGE 39
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.15 39 / 96 JC (Jump conditional) The JC instruction enables a conditional jump to a ﬁxed address in the TMCL program memory, if the speciﬁed condition is met. The conditions refer to the result of a preceding comparison. Please refer to COMP instruction for examples. This command is intended for standalone operation only.
PAGE 40
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Binary form of JC GE, Label assuming Label at address 10 Field Value Target address 01h Instruction number 15h Type 05h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 0Ah Checksum 25h ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 41
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.16 41 / 96 JA (Jump always) Jump to a ﬁxed address in the TMCL program memory. This command is intended for standalone operation only. Internal function: The TMCL program counter is set to the value passed to this command. Related commands: JC, WAIT, CSUB.
PAGE 42
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.17 42 / 96 CSUB (Call Subroutine) This function calls a subroutine in the TMCL program memory. It is intended for standalone operation only. Internal function: the actual TMCL program counter value is saved to an internal stack, afterwards overwritten with the passed value. The number of entries in the internal stack is limited to 8. This also limits nesting of subroutine calls to 8.
PAGE 43
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.18 43 / 96 RSUB (Return from Subroutine) Return from a subroutine to the command after the CSUB command. This command is intended for use in standalone mode only. Internal function: the TMCL program counter is set to the last value saved on the stack. The command will be ignored if the stack is empty. Related commands: CSUB.
PAGE 44
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.19 44 / 96 WAIT (Wait for an Event to occur) This instruction interrupts the execution of the TMCL program until the speciﬁed condition is met. This command is intended for standalone operation only. There are ﬁve different wait conditions that can be used: • TICKS: Wait until the number of timer ticks speciﬁed by the parameter has been reached.
PAGE 45
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Wait for motor 0 to reach its target position, without timeout. Mnemonic: WAIT POS, 0, 0 Binary Form of WAIT POS, 0, 0 Field Value Target address 01h Instruction number 1Bh Type 01h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 00h Checksum 1Dh ©2017 TRINAMIC Motion Control GmbH & Co.
PAGE 46
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.20 46 / 96 STOP (Stop TMCL Program Execution – End of TMCL Program) This command stops the execution of a TMCL program. It is intended for use in standalone operation only. Internal function: Execution of a TMCL program in standalone mode will be stopped. Related commands: none.
PAGE 47
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.21 47 / 96 SCO (Set Coordinate) Up to 20 position values (coordinates) can be stored for every axis for use with the MVP COORD command. This command sets a coordinate to a speciﬁed value. Depending on the global parameter 84, the coordinates are only stored in RAM or also stored in the EEPROM and copied back on startup (with the default setting the coordinates are stored in RAM only).
PAGE 48
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.22 48 / 96 GCO (Get Coordinate) Using this command previously stored coordinate can be read back. In standalone mode the requested value is copied to the accumulator register for further processing purposes such as conditional jumps. In direct mode, the value is only output in the value ﬁeld of the reply, without affecting the accumulator.
PAGE 49
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 49 / 96 Two special functions of this command have been introduced that make it possible to copy all coordinates or one selected coordinate from the EEPROM to the RAM. These functions can be accessed using the following special forms of the GCO command: • GCO 0, 255, 0 copies all coordinates (except coordinate number 0) from the EEPROM to the RAM.
PAGE 50
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.23 50 / 96 CCO (Capture Coordinate) This command copies the actual position of the axis to the selected coordinate variable. Depending on the global parameter 84, the coordinates are only stored in RAM or also stored in the EEPROM and copied back on startup (with the default setting the coordinates are stored in RAM only).
PAGE 51
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.24 51 / 96 ACO (Accu to Coordinate) With the ACO command the actual value of the accumulator is copied to a selected coordinate of the motor. Depending on the global parameter 84, the coordinates are only stored in RAM or also stored in the EEPROM and copied back on startup (with the default setting the coordinates are stored in RAM only). Note Coordinate #0 is always stored in RAM only.
PAGE 52
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.25 52 / 96 CALCX (Calculate using the X Register) This instruction is very similar to CALC, but the second operand comes from the X register. The X register can be loaded with the LOAD or the SWAP type of this instruction. The result is written back to the accumulator for further processing like comparisons or data transfer. This command is mainly intended for use in standalone mode.
PAGE 53
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Binary Form of CALCX MUL Field Value Target address 01h Instruction number 21h Type 02h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 00h Checksum 24h ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.com Read entire documentation.
PAGE 54
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.26 54 / 96 AAP (Accu to Axis Parameter) The content of the accumulator register is transferred to the speciﬁed axis parameter. For practical usage, the accumulator has to be loaded e.g. by a preceding GAP instruction. The accumulator may have been modiﬁed by the CALC or CALCX (calculate) instruction. This command is mainly intended for use in standalone mode.
PAGE 55
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.27 55 / 96 AGP (Accu to Global Parameter) The content of the accumulator register is transferred to the speciﬁed global parameter. For practical usage, the accumulator has to be loaded e.g. by a preceding GAP instruction. The accumulator may have been modiﬁed by the CALC or CALCX (calculate) instruction. This command is mainly intended for use in standalone mode.
PAGE 56
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.28 CLE (Clear Error Flags) This command clears the internal error ﬂags. It is mainly intended for use in standalone mode. The following error ﬂags can be cleared by this command (determined by the <ﬂag> parameter): • ALL: clear all error ﬂags. • ETO: clear the timeout ﬂag. • EAL: clear the external alarm ﬂag. • EDV: clear the deviation ﬂag. • EPO: clear the position error ﬂag. Related commands: JC, WAIT.
PAGE 57
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Binary Form of CLE ETO Field Value Target address 01h Instruction number 24h Type 01h Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 00h Checksum 26h ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.com Read entire documentation.
PAGE 58
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.29 58 / 96 EI (Enable Interrupt) The EI command enables an interrupt. It needs the interrupt number as parameter. Interrupt number 255 globally enables interrupt processing. This command is mainly intended for use in standalone mode. Please see table 12 for a list of interrupts that can be used on the TMCM-1210 module. Info Related commands: DI, VECT, RETI.
PAGE 59
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.30 59 / 96 DI (Disable Interrupt) The DI command disables an interrupt. It needs the interrupt number as parameter. Interrupt number 255 globally disables interrupt processing. This command is mainly intended for use in standalone mode. Please see table 12 for a list of interrupts that can be used on the TMCM-1210 module. Info Related commands: EI, VECT, RETI.
PAGE 60
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.31 60 / 96 VECT (Deﬁne Interrupt Vector) The VECT command deﬁnes an interrupt vector. It takes an interrupt number and a label (just like with JA, JC and CSUB commands) as parameters. The label must be the entry point of the interrupt handling routine for this interrupts. Interrupt vectors can also be re-deﬁned. This command is intended for use in standalone mode only.
PAGE 61
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Binary form of VECT (assuming label is at 50) Field Value Target address 01h Instruction number 25h Type FFh Motor/Bank 00h Value (Byte 3) 00h Value (Byte 2) 00h Value (Byte 1) 00h Value (Byte 0) 32h Checksum 58h ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 62
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.32 62 / 96 RETI (Return from Interrupt) This command terminates an interrupt handling routine. Normal program ﬂow will be continued then. This command is intended for use in standalone mode only. An interrupt routine must always end with a RETI command. Do not allow the normal program ﬂow to run into an interrupt routine.
PAGE 63
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.33 63 / 96 Customer speciﬁc Command Extensions (UF0. . . UF7 – User Functions) These commands are used for customer speciﬁc extensions of TMCL. They will be implemented in C by Trinamic. Please contact the sales department of Trinamic Motion Control GmbH & Co KG if you need a customized TMCL ﬁrmware. Related commands: none. Mnemonic: UF0. . .
PAGE 64
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.34 64 / 96 Request Target Position reached Event This command is the only exception to the TMCL protocol, as it sends two replies: One immediately after the command has been executed (like all other commands also), and one additional reply that will be sent when the motor has reached its target position.
PAGE 65
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.
PAGE 66
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 3.6.35 66 / 96 TMCL Control Commands There is a set of TMCL commands which are called TMCL control commands. These commands can only be used in direct mode and not in a standalone program. For this reason they only have opcodes, but no mnemonics. Most of these commands are only used by the TMCL-IDE (in order to implement e.g. the debugging functions in the TMCL creator).
PAGE 67
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Instruction Description Type Value 135 – get application status Return information about the current status, depending on the type ﬁeld. 0 - return mode, wait ﬂag, memory pointer 1 - return mode, wait ﬂag, program counter 2 - return accumulator 3 - return X register 0 (don’t care) 136 – get ﬁrmware version Return ﬁrmware version in string format (special reply) or binary format).
PAGE 68
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 4 68 / 96 Axis Parameters Most motor controller features of the TMCM-1210 module are controlled by axis parameters. Axis parameters can be modiﬁed or read using SAP, GAP, AAP, STAP and RSAP commands. This chapter describes all axis parameters that can be used on the TMCM-1210 module.
PAGE 69
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 69 / 96 Number Axis Parameter Description Range [Units] Access 7 Standby current The current used when the motor is not running. The maximum value is 255 which means 100% of the maximum current of the module. This value should be as low as possible so that the motor can cool down when it is not moving. Please see also parameter 214. 0. . .
PAGE 70
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 70 / 96 Number Axis Parameter Description Range [Units] Access 22 Speed threshold for coolStep / fullstep Speed threshold for de-activating coolStep or switching to fullstep mode. 0. . . 7999774 [pps] RW 23 Minimum speed for dcStep Minimum speed for switching to dcStep 0. . .
PAGE 71
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Number Axis Parameter Description 140 Microstep resolution Microstep resolutions 0 fullstep 1 halfstep 2 4 microsteps 3 8 microsteps 4 16 microsteps 5 32 microsteps 6 64 microsteps 7 128 microsteps 8 256 microsteps per full 71 / 96 Range [Units] Access step: 0..8 RW 162 Chopper blank time Selects the comparator blank time.
PAGE 72
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 72 / 96 Number Axis Parameter Description Range [Units] Access 168 smartEnergy current minimum (SEIMIN) Sets the lower motor current limit for coolStep operation by scaling the maximum current (see axis parameter 6) value.
PAGE 73
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 73 / 96 Number Axis Parameter Description Range [Units] Access 180 smartEnergy actual current This status value provides the actual motor current setting as controlled by coolStep. The value goes up to the CS value and down to the portion of CS as speciﬁed by SEIMIN. Actual motor current scaling factor: 0. . . 31: 1/32, 2/32, . . . 32/32 0. . .
PAGE 74
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 Number 193 Axis Parameter Reference search mode Description 1 Search left stop switch only. 4 Search left stop switch from both sides. 7 Search home switch in positive direction, ignore end switches. 8 Search home switch in negative direction, ignore end switches. 74 / 96 Range [Units] Access 1..
PAGE 75
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.
PAGE 76
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 5 76 / 96 Global Parameters The following sections describe all global parameters that can be used with the SGP, GGP, AGP, STGP and RSGP commands. Global parameters are grouped into banks: • Bank 0: Global conﬁguration of the module. • Bank 1: Not used. • Bank 2: TMCL user variables. • Bank 3: TMCL interrupt conﬁguration. 5.
PAGE 77
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 77 / 96 All Global Parameters of the TMCM-1210 Module in Bank 0 Number 65 Global Parameter RS485 baud rate Description 0 9600 1 14400 2 19200 3 28800 4 38400 5 57600 6 76800 7 115200 8 230400 Range [Units] Access 0. . . 8 RWA Default 66 Serial address Module (target) address for RS485. 1. . . 255 RWA 68 Serial heartbeat Serial heartbeat for RS485 interface and USB interface.
PAGE 78
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 78 / 96 Number Global Parameter Description Range [Units] Access 84 Coordinate storage 0 - coordinates are stored in RAM only (but can be copied explicitly between RAM and EEPROM) 1 - coordinates are always also stored in the EEPROM 0/1 RWA 85 Do not restore user variables Determines if TMCL user variables are to be restored from the EEPROM automatically on startup.
PAGE 79
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 79 / 96 User Variables in Bank 2 Number Global Parameter Description Range [Units] Access 0. . . 55 user variables #0. . . #55 TMCL user variables -2147483648 . . . 2147483647 RWE 56. . . 255 user variables #56. . . #255 TMCL user variables -2147483648 . . . 2147483647 RWE Table 17: User Variables in Bank 2 5.4 Bank 3 Bank 3 contains interrupt parameters. Some interrupts need conﬁguration (e.
PAGE 80
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 6 80 / 96 Module Speciﬁc Hints This section contains some hints that are speciﬁc to the TMCM-1210 module. 6.1 Accuracy of Velocity Values Due to the limited board space, the TMCM-1210 module does not use a crystal for clock generation. Instead, the ramp generator (TMC5130) runs on its internal clock.
PAGE 81
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 7 81 / 96 Hints and Tips This chapter gives some hints and tips on using the functionality of TMCL, for example how to use and parameterize the built-in reference search algorithm or using an incremental encoder. You will also ﬁnd basic information about stallGuard2™ and coolStep™ in this chapter. 7.
PAGE 82
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 L 82 / 96 R start stop left limit / end / stop switch : reference search speed (axis parameter 194) : reference switch speed (axis parameter 195) Figure 3: Reference search Mode 1 7.1.2 Mode 4 Reference search mode 4 searches the left end switch only, but from both sides so that the middle of the switch will be found and used as the zero point. This is shown in ﬁgure 4. Add 64 to the mode number (i.e.
PAGE 83
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 7.1.4 83 / 96 Mode 8 Reference search mode 8 searches the home switch in positive direction, ignoring the limit switch inputs. It is recommende mainly for use with a circular axis. The exact middle of the switch will be found and used as the zero point. Figure 6 illustrates this. Add 128 to the mode number (i.e. set axis parameter #193 to 132) to reverse the polarity of the home switch input.
PAGE 84
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 7.2 84 / 96 stallGuard2 The module is equipped with motor driver chips that feature load measurement. This load measurement can be used for stall detection. stallGuard2 delivers a sensorless load measurement of the motor as well as a stall detection signal. The measured value changes linear with the load on the motor in a wide range of load, velocity and current settings.
PAGE 85
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 7.3 85 / 96 coolStep This section gives an overview of the coolStep related parameters. Please bear in mind that the ﬁgure only shows one example for a drive. There are parameters which concern the conﬁguration of the current. Other parameters are there for velocity regulation and for time adjustment. Figure 7 shows all the adjustment points for coolStep.
PAGE 86
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 coolStep Adjustment Points and Thresholds Number Axis Parameter Description I6 Absolute maximum current The maximum value is 255. This value means 100% of the maximum current of the module. The current adjustment is within the range 0. . . 255 and can be adjusted in 32 steps (0. . . 255 divided by eight; e.g. step 0 = 0. . . 7, step 1 = 8. . . 15 and so on).
PAGE 87
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 7.4 87 / 96 Velocity and Acceleration Calculation When the unit mode (axis parameter #255) is set to 1 (which is also the default value), all velocity parameters on the TMCM-1210 are given in microsteps per second (also called pulse per second or pps). Acceleration and deceleration units are given in pps2 . When axis parameter #255 is set to 0 the internal units of the ramp generators are directly used.
PAGE 88
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 8 88 / 96 TMCL Programming Techniques and Structure 8.1 Initialization The ﬁrst task in a TMCL program (like in other programs also) is to initialize all parameters where different values than the default values are necessary. For this purpose, SAP and SGP commands are used. 8.2 Main Loop Embedded systems normally use a main loop that runs inﬁnitely.
PAGE 89
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 17 89 / 96 WAIT POS , Motor0 , 0 JA MainLoop Have a look at the ﬁle TMCLParam.tmc provided with the TMCL-IDE. It contains symbolic constants that deﬁne all important parameter numbers. Using constants for other values makes it easier to change them when they are used more than once in a program. You can change the deﬁnition of the constant and do not have to change all occurrences of it in your program. 8.
PAGE 90
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 8.5 90 / 96 Using Subroutines The CSUB and RSUB commands provide a mechanism for using subroutines. The CSUB command branches to the given label. When an RSUB command is executed the control goes back to the command that follows the CSUB command that called the subroutine. This mechanism can also be nested. From a subroutine called by a CSUB command other subroutines can be called.
PAGE 91
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 91 / 96 This example provides three very simple TMCL routines. They can be called from a host by issuing a run command with address 0 to call the ﬁrst function, or a run command with address 1 to call the second function, or a run command with address 2 to call the third function.
PAGE 92
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 9 92 / 96 Figures Index 1 2 3 4 stallGuard2 Load Measurement as a Function of Load . . . . . . . . . . . . Energy Eﬃciency Example with coolStep Reference search Mode 1 . . . . . . . Reference search Mode 4 . . . . . . . 6 6 82 82 ©2017 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 93
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 10 1 2 3 4 5 6 7 8 9 10 11 12 13 93 / 96 Tables Index Most important Axis Parameters . TMCL Command Format . . . . . . TMCL Reply Format . . . . . . . . . TMCL Status Codes . . . . . . . . . Overview of all TMCL Commands . Motion Commands . . . . . . . . . Parameter Commands . . . . . . . Branch Commands . . . . . . . . . I/O Port Commands . . . . . . . . Calculation Commands . . . . . .
PAGE 94
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 11 94 / 96 Supplemental Directives 11.1 Producer Information 11.2 Copyright TRINAMIC owns the content of this user manual in its entirety, including but not limited to pictures, logos, trademarks, and resources. © Copyright 2017 TRINAMIC. All rights reserved. Electronically published by TRINAMIC, Germany.
PAGE 95
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 95 / 96 or of any other nature are made hereunder with respect to information/speciﬁcation or the products to which information refers and no guarantee with respect to compliance to the intended use is given. In particular, this also applies to the stated possible applications or areas of applications of the product.
PAGE 96
TMCM-1210 TMCL™ Firmware Manual • Firmware Version V1.11 | Document Revision V1.00 • 2017-JUN-19 12 Revision History 12.1 Firmware Revision Version Date Author Description V1.08 2016-MAY-18 OK First release version. V1.11 2017-JUN-08 OK Added axis parameter #204. Command 138 improved. Table 21: Firmware Revision 12.2 Document Revision Version Date Author Description V1.00 2017-JUN-19 OK First release version. Table 22: Document Revision ©2017 TRINAMIC Motion Control GmbH & Co.