User Manual

ManualsBrandsTrinamic ManualsAutomationStepper Motor Controller 3A 24V

Module for Stepper

MODULE

TMCM-1276 TMCL

™

Firmware Manual

Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20

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

with coil currents of up to 3A RMS. The TMCM-1276 TMCL ﬁrmware allows to control the module

using TMCL™ commands, supporting standalone operation as well as direct mode control, making

use of the Trinamic TMC5160 motion controller and motor driver. 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 10. . . 30V DC

• TMCL™

• Motion Contoller

• CAN

• SixPoint™ ramp motion controller

• StealthChop™ silent PWM mode

• SpreadCycle™ smart mixed decay

• StallGuard2™ load detection

•

CoolStep

™

automatic current scal-

ing

• DcStep™

Applications

• Laboratory Automation

• Manufacturing

• Semiconductor Handling

• Robotics

• Factory Automation

• CNC

• Life Science

• Biotechnology

• Liquid Handling

Simpliﬁed Block Diagram

CAN

Stepper

Motor

Energy Efficient

Driver

TMC

262

TMCM-1276

Input

SPI

10...30V DC

TMCL™

Memory

I2C

ARM

Cortex M0+™

Microcontroller

REFL/REFR

ENCA/ENCB

ENABLE

Stepper

Motor

Controller

Driver

Terms of delivery and rights to technical change reserved.

Download newest version at: www.trinamic.com

Read entire documentation.

Summary of content (100 pages)

PAGE 1
MODULE Module for Stepper TMCM-1276 TMCL™ Firmware Manual Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 The TMCM-1276 is a single axis controller/driver module for 2-phase bipolar stepper motors with with coil currents of up to 3A RMS. The TMCM-1276 TMCL ﬁrmware allows to control the module using TMCL™ commands, supporting standalone operation as well as direct mode control, making use of the Trinamic TMC5160 motion controller and motor driver.
PAGE 2
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 2 / 100 Contents 1 Features 1.1 StallGuard2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.2 CoolStep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1.3 SixPoint Motion Controller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 6 6 7 2 First Steps with TMCL 2.
PAGE 3
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.26 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 AAP (Accu to Axis Parameter) . . . . . . . . . . . . . . . . . . . . . . . . . AGP (Accu to Global Parameter) . . . . . . . . . . . . . . . . . . . . . . . . CLE (Clear Error Flags) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EI (Enable Interrupt) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 4
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 4 / 100 10.7 Collateral Documents & Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 11 Revision History 100 11.1 Firmware Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 11.2 Document Revision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 ©2019 TRINAMIC Motion Control GmbH & Co.
PAGE 5
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 1 5 / 100 Features The TMCM-1276 is a single axis controller/driver module for 2-phase bipolar stepper motors with state of the art feature set. It has been designed for coil currents up to 3A RMS and 24V DC supply voltage. Three digital inputs can be conﬁgured as home and endstop switches or incremental encoder inputs.
PAGE 6
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 1.1 6 / 100 StallGuard2 StallGuard2 is a high-precision sensorless load measurement using the back EMF of the coils. It can be used for stall detection as well as other uses at loads below those which stall the motor. The StallGuard2 measurement value changes linearly over a wide range of load, velocity, and current settings. At maximum motor load, the value reaches zero or is near zero.
PAGE 7
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 1.3 7 / 100 SixPoint Motion Controller TRINAMIC’s SixPoint motion controller is a new type of ramp generator which offers faster machine operation compared to the classical linear acceleration ramps. The SixPoint ramp generator allows adapting the acceleration ramps to the torque curves of a stepper motor.
PAGE 8
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 2 8 / 100 First Steps with TMCL In this chapter you can ﬁnd some hints for your ﬁrst steps with the TMCM-1276 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-1276 Module. • A CAN adapter. • A power supply (24V DC) for your TMCM-1276 module. • The TMCL-IDE 3.x already installed on your PC • A two-phase bipolar stepper motor. 2.
PAGE 9
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 9 / 100 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. . .
PAGE 10
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 10 / 100 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 11
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3 11 / 100 TMCL and the TMCL-IDE — An Introduction As with most TRINAMIC modules the software running on the microprocessor of the TMCM-1276 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 12
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 12 / 100 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 13
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.2 13 / 100 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 14
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.3 14 / 100 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 15
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.4 15 / 100 TMCL Command Overview This sections gives a short overview of all TMCL commands.
PAGE 16
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.
PAGE 17
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 17 / 100 itself. These commands can also be used in direct mode and in standalone mode. 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.
PAGE 18
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.5.5 18 / 100 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 19
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 19 / 100 order to have symbolic constants for the interrupt numbers. Table 12 show all interrupts that are available on the TMCM-1276.
PAGE 20
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 20 / 100 • Do not allow the normal program ﬂow to run into an interrupt handling routine.
PAGE 21
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6 21 / 100 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 22
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.2 22 / 100 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 23
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.3 23 / 100 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 24
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.4 24 / 100 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 25
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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) 01h Value (Byte 1) 5Fh Value (Byte 0) 90h Checksum F5h Example Move motor 0 from current position 10000 steps backward.
PAGE 26
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 26 / 100 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. ©2019 TRINAMIC Motion Control GmbH & Co.
PAGE 27
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.5 27 / 100 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 28
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.6 28 / 100 GAP (Get Axis Parameter) Most motion / driver related parameters of the TMCM-1276 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 29
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.7 29 / 100 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 30
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.8 30 / 100 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 31
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.9 31 / 100 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 32
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.10 32 / 100 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 33
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.11 33 / 100 RFS (Reference Search) The TMCM-1276 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 34
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 ©2019 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 35
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.12 35 / 100 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 lines will read as 0 or 1, while the ADC channels deliver their 12 bit result in the range of 0. . . 4095.
PAGE 36
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 36 / 100 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 analog input lines can be read as digital or analog inputs at the same time. The digital input states can be accessed in bank 0.
PAGE 37
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.13 37 / 100 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 38
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.
PAGE 39
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.14 39 / 100 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 40
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.15 40 / 100 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 41
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 ©2019 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 42
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.16 42 / 100 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 43
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.17 43 / 100 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 44
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.18 44 / 100 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 45
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.19 45 / 100 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 46
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 ©2019 TRINAMIC Motion Control GmbH & Co.
PAGE 47
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.20 47 / 100 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 48
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.21 48 / 100 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 49
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.22 49 / 100 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 50
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 50 / 100 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 51
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.23 51 / 100 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 52
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.24 52 / 100 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 53
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.25 53 / 100 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 54
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 ©2019 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 55
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.26 55 / 100 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 56
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.27 56 / 100 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 57
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 58
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 ©2019 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 59
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.29 59 / 100 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-1276 module. Info Related commands: DI, VECT, RETI.
PAGE 60
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.30 60 / 100 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-1276 module. Info Related commands: EI, VECT, RETI.
PAGE 61
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.31 61 / 100 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 62
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 ©2019 TRINAMIC Motion Control GmbH & Co. KG, Hamburg, Germany Terms of delivery and rights to technical change reserved. Download newest version at www.trinamic.
PAGE 63
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.32 63 / 100 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 64
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.33 64 / 100 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 65
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.34 65 / 100 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 66
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.
PAGE 67
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 3.6.35 67 / 100 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 68
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 69
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 4 69 / 100 Axis Parameters Most motor controller features of the TMCM-1276 module are controlled by axis parameters. Axis parameters can be modiﬁed or read using SAP, GAP and AAP commands. This chapter describes all axis parameters that can be used on the TMCM-1276 module.
PAGE 70
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 70 / 100 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 71
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 71 / 100 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 72
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 72 / 100 Range [Units] Access step: 0..8 RW 162 Chopper blank time Selects the comparator blank time.
PAGE 73
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 73 / 100 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 74
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 74 / 100 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 75
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 75 / 100 Number Axis Parameter Description Range [Units] Access 192 PWM autoscale PWM automatic amplitude scaling for StealthChop. 0 - User deﬁned PWM amplitude. The current settings do not have any inﬂuence. 1 - Enable automatic current control. 0. . . 1 RW 1..8 RW 193 Reference search mode 1 Search left stop switch only. 4 Search left stop switch from both sides.
PAGE 76
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 Number Axis Parameter Description 207 Extended error ﬂags A combination 1 of the following values: 76 / 100 Range [Units] Access 0. . . 3 R 0. . . 255 R StallGuard error 2 deviation error These error ﬂags are cleared automatically when this parameter has been read out or when a motion command has been executed.
PAGE 77
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 77 / 100 Number Axis Parameter Description Range [Units] Access 255 Unit mode Units of velocity and acceleration/deceleration settings: 0 - the internal units of the TMC5130 are used directly 1 - the units are pps for velocity and pps2 for acceleration/deceleration Default value is 1 (pps units). 0/1 RW Table 14: All TMCM-1276 Axis Parameters ©2019 TRINAMIC Motion Control GmbH & Co.
PAGE 78
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 5 78 / 100 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 79
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 79 / 100 All Global Parameters of the TMCM-1276 Module in Bank 0 Number 69 Global Parameter CAN bit rate Description 2 20kBit/s 3 50kBit/s 4 100kBit/s 5 125kBit/s 6 250kBit/s 7 500kBit/s 8 1000kBit/s (Default) Range [Units] Access 2. . . 8 RWA 70 CAN reply ID The CAN ID for replies from the board (default: 2). 0. . .
PAGE 80
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 80 / 100 Number Global Parameter Description Range [Units] Access 128 TMCL application status 0 - stop 1 - run 2 - step 3 - reset 0. . . 3 R 129 Download mode 0 - normal mode 1 - download mode 0/1 R 130 TMCL program counter Contains the address of the currently executed TMCL command. 132 TMCL tick timer A 32 bit counter that gets incremented by one every millisecond.
PAGE 81
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 5.4 81 / 100 Bank 3 Bank 3 contains interrupt parameters. Some interrupts need conﬁguration (e.g. the timer interval of a timer interrupt). This can be done using the SGP commands with parameter bank 3 (SGP , 3, ). The priority of an interrupt depends on its number. Interrupts with a lower number have a higher priority. Table 18 shows all interrupt parameters that can be set.
PAGE 82
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 6 82 / 100 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. You will also ﬁnd basic information about StallGuard2™ and CoolStep™ in this chapter. 6.
PAGE 83
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 6.1.1 83 / 100 Mode 1 Reference search mode 1 only searches the left end switch. Select this mode by setting axis parameter #193 to 1. Figure 4 illustrates this. Add 64 to the mode number (i.e. set axis parameter #193 to 65) to search the right end switch instead of the left end switch.
PAGE 84
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 L 84 / 100 R start stop left limit / end / stop switch right limit / end / stop switch : reference search speed (axis parameter 194) : reference switch speed (axis parameter 195) Figure 6: Reference Search Mode 3 6.1.4 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 7.
PAGE 85
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 85 / 100 Home L R start stop left limit / end / stop switch home switch : reference search speed (axis parameter 194) : reference switch speed (axis parameter 195) Figure 8: Reference Search Mode 5 6.1.6 Mode 6 Reference search mode 6 searches the home switch in positive direction. The search direction will be reversed if the right limit switch is reached. This is shown in ﬁgure 9.
PAGE 86
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 L 86 / 100 R start stop home switch : reference search speed (axis parameter 194) : reference switch speed (axis parameter 195) Figure 10: Reference Search Mode 7 6.1.8 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.
PAGE 87
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 6.2 87 / 100 Using Encoders With the TMCM-1276 it is also possible to use encoders. Please note that the TMCM-1276 is an open-loop system, and hence encoders can only be used to check if the motor has really reached its target position or really follows the position counter.
PAGE 88
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 6.4 88 / 100 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 12 shows all the adjustment points for CoolStep.
PAGE 89
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 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 90
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 6.5 90 / 100 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-1276 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 91
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 6.6 91 / 100 SixPoint Ramp The TMCM-1276 is equipped with a motion controller that supports TRINAMIC’s SixPoint ramp technology. Please see also section 1.3 for more information about the SixPoint ramp.
PAGE 92
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 7 92 / 100 TMCL Programming Techniques and Structure 7.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. 7.2 Main Loop Embedded systems normally use a main loop that runs inﬁnitely.
PAGE 93
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 17 93 / 100 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. 7.
PAGE 94
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 7.5 94 / 100 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 95
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 95 / 100 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 96
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 8 96 / 100 Figures Index 1 2 3 4 5 6 StallGuard2 Load Measurement as a Function of Load . . . . . . . . . . . . . 6 Energy Eﬃciency Example with CoolStep 6 Typical motion proﬁle with TRINAMIC’s SixPoint motion controller . . . . . . . . 7 Reference Search Mode 1 . . . . . . . . 83 Reference Search Mode 2 . . . . . . . . 83 Reference Search Mode 3 . . . . . . . . 84 ©2019 TRINAMIC Motion Control GmbH & Co.
PAGE 97
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 9 97 / 100 Tables Index 1 2 3 4 5 6 7 8 9 10 11 12 13 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 98
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 10 98 / 100 Supplemental Directives 10.1 Producer Information 10.2 Copyright TRINAMIC owns the content of this user manual in its entirety, including but not limited to pictures, logos, trademarks, and resources. © Copyright 2019 TRINAMIC. All rights reserved. Electronically published by TRINAMIC, Germany.
PAGE 99
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 99 / 100 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 100
TMCM-1276 TMCL™ Firmware Manual • Firmware Version V1.13 | Document Revision V1.01 • 2019-MAR-20 11 Revision History 11.1 Firmware Revision Version Date Author Description V1.13 2018-JUN-28 OK First release. Table 22: Firmware Revision 11.2 Document Revision Version Date Author Description V1.00 2018-JUN-28 OK First release. V1.01 2019-MAR-20 OK Missing encoder functions included. Table 23: Document Revision ©2019 TRINAMIC Motion Control GmbH & Co.