Trinamic TMCM-6110 FIRMWARE MANUAL

Download

MODULE FOR STEPPER MOTORS MODULE

Firmware Version V1.19

TMCL™ FIRMWARE MANUAL

+ +

6 axes stepper

controller / driver up to 1.1A RMS / 24V DC USB, CAN, RS485 [or RS232]

+ +

TMCM-6110

TRINAMIC Motion Control GmbH & Co. KG Hamburg, Germany

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 2

Table of Contents

2 Features ........................................................................................................................................................................... 4

3 Overview ......................................................................................................................................................................... 5

4 Putting the Module into Operation ........................................................................................................................ 6

4.1 Basic Set-up ........................................................................................................................................................... 6

4.1.1 Connecting the Module ............................................................................................................................... 6

4.1.2 Start the TMCL-IDE Software Development Environment ................................................................. 9

4.1.3 Using TMCL Direct Mode ............................................................................................................................. 9

4.1.4 Important Motor Settings ......................................................................................................................... 10

4.1.5 Your First TMCL Program .......................................................................................................................... 11

5 TMCL and TMCL-IDE ................................................................................................................................................... 13

5.1 Binary Command Format ................................................................................................................................ 13

5.2 Reply Format ....................................................................................................................................................... 14

5.2.1 Status Codes ................................................................................................................................................. 14

5.3 Standalone Applications .................................................................................................................................. 15

5.4 TMCL Command Overview .............................................................................................................................. 15

5.4.1 TMCL Commands ......................................................................................................................................... 15

5.4.2 Commands Listed According to Subject Area .................................................................................... 16

5.5 The ASCII Interface ........................................................................................................................................... 20

5.5.1 Format of the Command Line ................................................................................................................. 20

5.5.2 Format of a Reply ....................................................................................................................................... 20

5.5.3 Commands That Can be Used in ASCII Mode .................................................................................... 20

5.5.4 Configuring the ASCII Interface ............................................................................................................. 20

5.6 Commands ........................................................................................................................................................... 22

5.6.1 ROR (rotate right) ........................................................................................................................................ 22

5.6.2 ROL (rotate left) ........................................................................................................................................... 23

5.6.3 MST (motor stop)......................................................................................................................................... 24

5.6.4 MVP (move to position) ............................................................................................................................ 25

5.6.5 SAP (set axis parameter) ........................................................................................................................... 27

5.6.6 GAP (get axis parameter) .......................................................................................................................... 28

5.6.7 STAP (store axis parameter) ..................................................................................................................... 29

5.6.8 RSAP (restore axis parameter) ................................................................................................................. 30

5.6.9 SGP (set global parameter) ...................................................................................................................... 31

5.6.10 GGP (get global parameter)...................................................................................................................... 32

5.6.11 STGP (store global parameter) ................................................................................................................ 33

5.6.12 RSGP (restore global parameter) ............................................................................................................ 34

5.6.13 RFS (reference search) ................................................................................................................................ 35

5.6.14 SIO (set input / output) ............................................................................................................................. 36

5.6.15 GIO (get input /output) ............................................................................................................................. 38

5.6.16 CALC (calculate) ............................................................................................................................................ 41

5.6.17 COMP (compare)........................................................................................................................................... 42

5.6.18 JC (jump conditional) ................................................................................................................................. 43

5.6.19 JA (jump always) ......................................................................................................................................... 44

5.6.20 CSUB (call subroutine) ............................................................................................................................... 45

5.6.21 RSUB (return from subroutine) ................................................................................................................ 46

5.6.22 WAIT (wait for an event to occur) ......................................................................................................... 47

5.6.23 STOP (stop TMCL program execution) ................................................................................................... 48

5.6.24 SCO (set coordinate) ................................................................................................................................... 49

5.6.25 GCO (get coordinate) .................................................................................................................................. 50

5.6.26 CCO (capture coordinate) .......................................................................................................................... 51

5.6.27 ACO (accu to coordinate) .......................................................................................................................... 52

5.6.28 CALCX (calculate using the X register) .................................................................................................. 53

5.6.29 AAP (accumulator to axis parameter) .................................................................................................... 54

5.6.30 AGP (accumulator to global parameter) ............................................................................................... 55

5.6.31 CLE (clear error flags) ................................................................................................................................. 56

5.6.32 VECT (set interrupt vector) ........................................................................................................................ 57

5.6.33 EI (enable interrupt) ................................................................................................................................... 58

5.6.34 DI (disable interrupt) .................................................................................................................................. 59

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 3

5.6.35 RETI (return from interrupt) ..................................................................................................................... 60

5.6.36 Customer Specific TMCL Command Extension (UF0… UF7 - user function) ................................ 61

5.6.37 Request Target Position Reached Event ............................................................................................... 62

5.6.38 BIN (return to binary mode) .................................................................................................................... 63

5.6.39 TMCL Control Functions ............................................................................................................................. 64

6 Axis Parameters .......................................................................................................................................................... 65

6.1 stallGuard2 Related Parameters .................................................................................................................... 72

6.2 coolStep Related Parameters ......................................................................................................................... 73

6.3 Reference Search ............................................................................................................................................... 76

6.3.1 Reference Search Modes (Axis Parameter 193) ................................................................................... 77

6.4 Calculation: Velocity and Acceleration vs. Microstep- and Fullstep-Frequency ............................... 79

6.4.1 Microstep Frequency ................................................................................................................................... 79

6.4.2 Fullstep Frequency ...................................................................................................................................... 80

7 Global Parameters ...................................................................................................................................................... 81

7.1 Bank 0 ................................................................................................................................................................... 81

7.2 Bank 1 ................................................................................................................................................................... 83

7.3 Bank 2 ................................................................................................................................................................... 84

7.4 Bank 3 ................................................................................................................................................................... 85

8 TMCL Programming Techniques and Structure ................................................................................................. 86

8.1 Initialization ........................................................................................................................................................ 86

8.2 Main Loop ............................................................................................................................................................ 86

8.3 Using Symbolic Constants .............................................................................................................................. 86

8.4 Using Variables .................................................................................................................................................. 87

8.5 Using Subroutines ............................................................................................................................................. 87

8.6 Mixing Direct Mode and Standalone Mode ................................................................................................ 87

9 Life Support Policy ..................................................................................................................................................... 89

10 Revision History .......................................................................................................................................................... 90

10.1 Firmware Revision ............................................................................................................................................ 90

10.2 Document Revision ........................................................................................................................................... 90

11 References .................................................................................................................................................................... 90

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 4

2 Features

The TMCM-6110 is a compact 6-axes stepper motor controller/driver standalone board. It supports up to 6 bipolar stepper motors with up to 1.1A RMS coil current. There are separate motor and reference/end switch connectors for each motor. In addition, the module offers 8 general purpose inputs and 8 general purpose outputs.

Applications

 Highly compact multi-axes stepper motor solutions

Electrical data

 Supply voltage: +9V… +28V DC  Motor current: up to 1.1A RMS (programmable) per axis

Mechanical data

 Board size: 130mm x 100mm, height 30mm max.  4 mounting holes for M3 screws

Interfaces

 Up to 8 multi-purpose inputs (+24V compatible, incl. 2 dedicated analog inputs)  Up to 8 multi-purpose outputs (open-drain, incl. 2 outputs for currents up to 1A)  RS485 2-wire communication interface  USB 2.0 full speed (12Mbit/s) communication interface (mini-USB connector)  CAN 2.0B communication interface (9pin D-SUB)

Features

 Uses TMC429 stepper motor controller for on-the-fly alteration of many motion specific parameters  Uses TMC260 advanced stepper motor driver IC  Up to 256 microsteps per fullstep  Integrated protection: overtemperature/undervoltage

Software

 TMCL remote (direct mode) and standalone operation (memory for up to 2048 TMCL commands)  Fully supported by TMCL-IDE (PC based integrated development environment)

Please see separate Hardware Manual for additional information

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 5

3 Overview

The software running on the microprocessor of the TMCM-6110 consists of two parts, a boot loader and the firmware itself. Whereas the boot loader is installed during production and testing at TRINAMIC and remains untouched throughout the whole lifetime, the firmware can be updated by the user. New versions can be downloaded free of charge from the TRINAMIC website (http://www.trinamic.com).

The firmware of this module is related to the standard TMCL firmware shipped with regard to protocol and commands. Corresponding, this module is based on the TMC429 stepper motor controller and the TMC260 power driver and supports the standard TMCL with a special range of values.

The TMC260 is a new energy efficient high current high precision microstepping driver IC for bipolar

stepper motors and offers TRINAMICs patented coolStep™ feature with its special commands. Please mind

this technical innovation.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 6

1 4

Reference switch connectors

0 1 2 3 4 5

Motor connectors

1 4

CAN connector

RS485 connector

Mini-USB connector

I/O connector 0

I/O connector 1

Power connector

PRECAUTIONS

Do not mix up connections or short-circuit pins. Avoid bounding I/O wires with motor power wires. Do not exceed the maximum power supply of 28V DC! Do not connect or disconnect the motor while powered! START WITH POWER SUPPLY OFF!

4 Putting the Module into Operation

In this chapter you will find basic information for putting your module into operation. This includes a simple example for a TMCL program and a short description of operating the module in direct mode.

THINGS YOU NEED

- TMCM-6110 with up to six appropriate motors (e.g. QSH4218)

- Interface (RS485, CAN or USB) suitable to your TMCM-6110 module with cables

- Nominal supply voltage +24V DC (+9… +28V DC) for your module

- TMCL-IDE program (can be downloaded free of charge from www.trinamic.com)

- Appropriate cables

4.1 Basic Set-up

The following paragraph will guide you through the steps of connecting the unit and making first movements with the motor.

4.1.1 Connecting the Module

For first steps you will need a power supply and a communication between PC and one of the serial interfaces of the module (USB, RS485 or CAN).

Please note: later on it is perfectly possible to operate the unit as stand-alone device, using the available multi-purpose inputs and outputs for control.

Figure 4.1: Connectors of TMCM-6110

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 7

Label

Connector type

Mating connector type

Power Connector

JST B3P-VH (JST VH series, 3pins, 3.96mm pitch)

Connector housing: JST VHR-3N Contacts: JST SVH-21T-P1.1 Wire: 0.83mm2, AWG 18

Label

Connector type

Mating connector type

RS485 Connector

Tyco electronics 3-1634218-2 D-SUB socket with 4-40 female screw locks

Any standard D-SUB female 9-pin Label

Connector type

Mating connector type

Mini-USB connector

Molex 500075-1517 Mini USB Type B vertical receptacle

Any standard mini-USB plug Label

Connector type

Mating connector type

CAN connector

Male D-SUB 9-pin

Any standard D-SUB female 9-pin

4.1.1.1 Power Supply

Connect the power supply with the power supply connector (see Figure 4.1).

Do not exceed the maximum power supply of +28V DC!

The device is protected against wrong polarity by a diode that shorts the power supply when the polarity is wrong.

4.1.1.2 Communication

Choose your communication interface out of three serial interfaces: RS485, USB and CAN. If you need more information about the interfaces (e.g. pin assignments), refer to the Hardware Manual, please.

4.1.1.2.1 RS485

Connect the RS485 interface with the appropriate connector (see Figure 4.1).

RS485 as field bus interface normally requires an adapter. From TRINAMIC the USB-2-485 converter between USB and RS485 is available.

4.1.1.2.2 USB

Connect the USB interface with the appropriate connector (see Figure 4.1). To make use of the USB interface, a device driver has to be installed first. When the TMCM-6110 module is connected to the USB interface of a PC for the first time, you will be prompted for a driver by the operating system. The tmcm-

6110.inf file is available on www.trinamic.com. After downloading and installing the driver the module is ready for use.

CAN interface will be deactivated as soon as USB is connected (V On-board digital core logic (mainly processor and EEPROM) will be powered via USB in case no other supply is connected. This can be used to set parameters / download TMCL programs or perform firmware updates with the module connected via USB only or inside the machine while the machine is powered off.

voltage available)

BUS

4.1.1.2.3 CAN

Connect the CAN interface with the appropriate connector (see Figure 4.1). The dip switch can be used for setting the address of the module. If all switches are off the address set by global parameter 71 (CAN ID) is valid.

TRINAMIC offers the CANnes card, which is a CAN-bus PCI-card and provides a simple and easy use of the CAN interface.

CAN interface will be de-activated in case USB is connected due to internal sharing of hardware resources.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 8

Label

Connector type

Mating connector type

Motor connectors

JST B4B-PH-K-S (JST PH series, 4pins, 2mm pitch)

Connector housing: JST PHR-4 Contacts: JST SPH-002T-P0.5S Wire: 0.22mm2, AWG 24

Motor 0… 5

Label

Connector type

Mating connector type

Reference Switch Connectors

JST B4B-PH-K-S (JST PH series, 4pins, 2mm pitch)

Connector housing: JST PHR-4 Contacts: JST SPH-002T-P0.5S Wire: 0.22mm2, AWG 24

Label

Connector type

Mating connector type

I/O Connector 0 + 1

JST B10B-PH-K-S (JST PH series, 10pins, 2mm pitch)

Connector housing: JST PHR-10 Contacts: JST SPH-002T-P0.5S Wire: 0.22mm2, AWG 24

Before connecting a motor please make sure which cable belongs to which coil. Wrong connections may lead to damage of the driver chips or the motor!

4.1.1.3 Motor

The TMCM-6110 controls up to six 2-phase stepper motors. Connect one coil of each motor to the terminals marked A0 and A1 and the other coil to the connectors marked B0 and B1.

Figure 4.2: Motor connection

4.1.1.4 Reference / Home Switches

Connect the switches with the appropriate connectors (see Figure 4.1), if you need them.

Please refer to the Hardware Manual for more information about the reference switch connectors.

4.1.1.5 I/Os

Connect inputs and outputs with the appropriate connectors (see Figure 4.1), if you want to use them.

Please refer to the Hardware Manual for more information about the I/O connectors.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 9

Direct Mode

4.1.2 Start the TMCL-IDE Software Development Environment

The TMCL-IDE is available on the TechLibCD and on www.trinamic.com.

Installing the TMCL-IDE:

Make sure the COM port you intend to use is not blocked by another program. Open TMCL-IDE by clicking TMCL.exe. Choose Setup and Options and thereafter the Connection tab. For RS485 choose COM port and type with the parameters shown in Figure 4.3 (baud rate 9600). Click OK.

Figure 4.3: Setup dialogue and connection tab of the TMCL-IDE

Please refer to the TMCL-IDE User Manual for more information about connecting the other interfaces (see

www.TRINAMIC.com).

4.1.3 Using TMCL Direct Mode

Start TMCL Direct Mode.

If the communication is established the TMCM-6110 is automatically detected.

If the module is not detected, please check cables, interface, power supply, COM port, and baud rate.

Issue a command by choosing Instruction, Type (if necessary), Motor, and Value and click Execute to send it to the module.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 10

Number

Axis Parameter

Description

Range [Unit]

maximum positioning speed

Should not exceed the physically highest possible value. Adjust the pulse divisor (no. 154), if the speed value is very low (<50) or above the upper limit. See TMC 429 datasheet for calculation of physical units.

0… 2047







 









maximum acceleration

The limit for acceleration (and deceleration). Changing this parameter requires re-calculation of the acceleration factor (no. 146) and the acceleration divisor (no. 137), which is done automatically. See TMC 429 datasheet for calculation of physical units.

0… 2047*1

Top right of the TMCL Direct Mode window is the button Copy to editor. Click here to copy the chosen command and create your own TMCL program. The command will be shown immediately on the editor.

ATTENTION

The most important motor setting is the absolute maximum motor current setting, since too high values might cause motor damage!

Examples:

- ROR rotate right, motor 0, value 500 -> Click Execute. The first motor is rotating now.

- MST motor stop, motor 0 -> Click Execute. The first motor stops now.

You will find a description of all TMCLTM commands in the following chapters.

4.1.4 Important Motor Settings

There are some axis parameters which have to be adjusted right in the beginning after installing your module. Please set the upper limiting values for the speed (axis parameter 4), the acceleration (axis parameter 5), and the current (axis parameter 6). Further set the standby current (axis parameter 7) and choose your microstep resolution with axis parameter 140. Please use the SAP (Set Axis Parameter) command for adjusting these values. The SAP command is described in paragraph 5.6.5. You can use the TMCM-IDE direct mode for easily configuring your module.

IMPORTANT AXIS PARAMETERS FOR MOTOR SETTING

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 11

Number

Axis Parameter

Description

Range [Unit]

absolute max. current (CS / Current Scale)

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… 7

79…87

160… 167

240… 247

8… 15

88… 95

168… 175

248… 255

16… 23

96… 103

176… 183

24… 31

104… 111

184… 191

32… 39

112… 119

192… 199

40… 47

120… 127

200… 207

48… 55

128… 135

208… 215

56… 63

136… 143

216… 223

64… 71

144… 151

224… 231

72… 79

152… 159

232… 239

0… 255





  

 





  





standby current

The current limit two seconds after the motor has stopped.

0… 255





  

 





  





140

microstep resolution

full step

half step

4 microsteps

8 microsteps

16 microsteps

32 microsteps

64 microsteps

128 microsteps

256 microsteps

0… 8

Assemble

Download Run

Stop

//A simple example for using TMCL and TMCL-IDE

ROL 0, 500 //Rotate motor 0 with speed 500 WAIT TICKS, 0, 500 MST 0 ROR 1, 250 //Rotate motor 0 with 250 WAIT TICKS, 0, 500 MST 1

SAP 4, 2, 500 //Set max. Velocity SAP 5, 2, 50 //Set max. Acceleration Loop: MVP ABS, 2, 10000 //Move to Position 10000 WAIT POS, 2, 0 //Wait until position reached MVP ABS, 2, -10000 //Move to Position -10000 WAIT POS, 2, 0 //Wait until position reached JA Loop //Infinite Loop

*1 Unit of acceleration:















4.1.5 Your First TMCL Program

Open the file test2.tmc. Now your test program looks as follows: A description for the TMCL commands can be found in Appendix A.

www.trinamic.com



TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 12

1. Click on Icon Assemble to convert the TMCL into machine code.

2. Then download the program to the TMCM-6110 module via the icon Download.

3. Press icon Run. The desired program will be executed.

4. Click Stop button to stop the program.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 13

Bytes

Meaning

Module address

Command number

Type number

Motor or Bank number

Value (MSB first!)

Checksum

5 TMCL and TMCL-IDE

The TMCM-6110 supports TMCL direct mode (binary commands or ASCII interface) and standalone TMCL program execution. You can store up to 2048 TMCL instructions on it.

In direct mode and most cases the TMCL communication over RS485, USB or CAN follows a strict master/slave relationship. That is, a host computer (e.g. PC/PLC) acting as the interface bus master will send a command to the TMCM-6110. The TMCL interpreter on the module will then interpret this command, do the initialization of the motion controller, read inputs and write outputs or whatever is necessary according to the specified command. As soon as this step has been done, the module will send a reply back over RS485/USB/CAN to the bus master. Only then should the master transfer the next command. Normally, the module will just switch to transmission and occupy the bus for a reply, otherwise it will stay in receive mode. It will not send any data over the interface without receiving a command first. This way, any collision on the bus will be avoided when there are more than two nodes connected to a single bus.

The Trinamic Motion Control Language [TMCL™] provides a set of structured motion control commands. Every motion control command can be given by a host computer or can be stored in an EEPROM on the TMCM module to form programs that run standalone on the module. For this purpose there are not only motion control commands but also commands to control the program structure (like conditional jumps, compare and calculating).

Every command has a binary representation and a mnemonic. The binary format is used to send commands from the host to a module in direct mode, whereas the mnemonic format is used for easy usage of the commands when developing standalone TMCL applications using the TMCL-IDE (IDE means Integrated Development Environment).

There is also a set of configuration variables for the axis and for global parameters which allow individual configuration of nearly every function of a module. This manual gives a detailed description of all TMCL commands and their usage.

5.1 Binary Command Format

When commands are sent from a host to a module, the binary format has to be used. Every command consists of a one-byte command field, a one-byte type field, a one-byte motor/bank field and a four-byte value field. So the binary representation of a command always has seven bytes. When a command is to be sent via RS485 or USB interface, it has to be enclosed by an address byte at the beginning and a checksum byte at the end. In this case it consists of nine bytes.

This is different when communicating is via the CAN bus. Address and checksum are included in the CAN standard and do not have to be supplied by the user.

The binary command format for RS485/USB is as follows:

 The checksum is calculated by adding up all the other bytes using an 8-bit addition.  When using CAN bus, just leave out the first byte (module address) and the last byte (checksum).

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 14

Bytes

Meaning

Reply address

Module address

Status (e.g. 100 means “no error”)

Command number

Value (MSB first!)

Checksum

Code

Meaning

100

Successfully executed, no error

101

Command loaded into TMCL program EEPROM

Wrong checksum

Invalid command

Wrong type

Invalid value

Configuration EEPROM locked

Command not available

Checksum calculation

As mentioned above, the checksum is calculated by adding up all bytes (including the module address byte) using 8-bit addition. Here are two examples to show how to do this:

 in C:

unsigned char i, Checksum; unsigned char Command[9];

//Set the “Command” array to the desired command Checksum = Command[0]; for(i=1; i<8; i++)

Checksum+=Command[i];

Command[8]=Checksum; //insert checksum as last byte of the command

//Now, send it to the module

5.2 Reply Format

Every time a command has been sent to a module, the module sends a reply.

The reply format for RS485/USB is as follows:

 The checksum is also calculated by adding up all the other bytes using an 8-bit addition.  When using CAN bus, the first byte (reply address) and the last byte (checksum) are left out.  Do not send the next command before you have received the reply!

5.2.1 Status Codes

The reply contains a status code.

The status code can have one of the following values:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 15

Command

Number

Parameter

Description

ROR

Rotate right with specified velocity

ROL

Rotate left with specified velocity

MST

Stop motor movement

MVP

ABS|REL|COORD, <motor number>, <position|offset>

Move to position (absolute or relative)

SAP

Set axis parameter (motion control specific settings)

GAP

Get axis parameter (read out motion control specific settings)

STAP

Store axis parameter permanently (non volatile)

RSAP

Restore axis parameter

SGP

<parameter>, <bank number>, value

Set global parameter (module specific settings e.g. communication settings or TMCL user variables)

GGP

Get global parameter (read out module specific settings e.g. communication settings or TMCL user variables)

STGP

Store global parameter (TMCL user variables only)

RSGP

Restore global parameter (TMCL user variable only)

RFS

START|STOP|STATUS, <motor number>

Reference search

SIO

Set digital output to specified value

GIO

Get value of analogue/digital input

CALC

Process accumulator & value

COMP

<value>

Compare accumulator <-> value

Jump conditional

Jump absolute

CSUB

Call subroutine

RSUB

24 Return from subroutine

Enable interrupt

Disable interrupt

WAIT

Wait with further program execution

STOP

28 Stop program execution

SCO

Set coordinate GCO

Get coordinate

CCO

Capture coordinate

CALCX

Process accumulator & X-register

AAP

Accumulator to axis parameter

5.3 Standalone Applications

The module is equipped with an EEPROM for storing TMCL applications. You can use TMCL-IDE for developing standalone TMCL applications. You can load them down into the EEPROM and then 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. They will be assembled automatically into their binary representations. Afterwards this code can be downloaded into the module to be executed there.

5.4 TMCL Command Overview

In this section a short overview of the TMCL commands is given.

5.4.1 TMCL Commands

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 16

Command

Number

Parameter

Description

AGP

Accumulator to global parameter

VECT

Set interrupt vector

RETI

38 Return from interrupt

ACO

Accu to coordinate

Mnemonic

Command number

Meaning

ROL

Rotate left

ROR

Rotate right

MVP

Move to position

MST

Motor stop

RFS

Reference search

SCO

Store coordinate

CCO

Capture coordinate

GCO

Get coordinate

Mnemonic

Command number

Meaning

Jump always

Jump conditional

COMP

Compare accumulator with constant value

CSUB

Call subroutine

RSUB

Return from subroutine

WAIT

Wait for a specified event

STOP

End of a TMCL program

Mnemonic

Command number

Meaning

SAP

Set axis parameter

GAP

Get axis parameter

STAP

Store axis parameter into EEPROM

RSAP

Restore axis parameter from EEPROM

SGP

Set global parameter

GGP

Get global parameter

STGP

Store global parameter into EEPROM

RSGP

Restore global parameter from EEPROM

5.4.2 Commands Listed According to Subject Area

5.4.2.1 Motion Commands

These commands control the motion of the motor. They are the most important commands and can be used in direct mode or in standalone mode.

5.4.2.2 Parameter Commands

These commands are used to set, read and store axis parameters or global parameters. Axis parameters can be set independently for the axis, whereas global parameters control the behavior of the module itself. These commands can also be used in direct mode and in standalone mode.

5.4.2.3 Control Commands

These commands are used to control the program flow (loops, conditions, jumps etc.). It does not make sense to use them in direct mode. They are intended for standalone mode only.

5.4.2.4 I/O Port Commands

These commands control the external I/O ports and can be used in direct mode and in standalone mode.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 17

Mnemonic

Command number

Meaning

SIO

Set output

GIO

Get input

Mnemonic

Command number

Meaning

CALC

Calculate using the accumulator and a constant value

CALCX

Calculate using the accumulator and the X register

AAP

Copy accumulator to an axis parameter

AGP

Copy accumulator to a global parameter

ACO

Copy accu to coordinate

Mnemonic

Command number

Meaning

Enable interrupt

Disable interrupt

VECT

Set interrupt vector

RETI

Return from interrupt

5.4.2.5 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.

For calculating purposes there is an accumulator (or accu or A register) and an X register. When executed in a TMCL program (in standalone mode), all TMCL commands that read a value store the result in the accumulator. The X register can be used as an additional memory when doing calculations. It can be loaded from the accumulator.

When a command that reads a value is executed in direct mode the accumulator will not be affected. This means that while a TMCL program is running on the module (standalone mode), a host can still send commands like GAP and GGP to the module (e.g. to query the actual position of the motor) without affecting the flow of the TMCL program running on the module.

5.4.2.6 Interrupt Commands

Due to some customer requests, interrupt processing has been introduced in the TMCL firmware for ARM based modules.

5.4.2.6.1 Interrupt Types:

There are many different interrupts in TMCL™, like timer interrupts, stop switch interrupts, position reached

interrupts, and input pin change interrupts. Each of these interrupts has its own interrupt vector. Each interrupt vector is identified by its interrupt number. Please use the TMCL included file Interrupts.inc for symbolic constants of the interrupt numbers.

5.4.2.6.2 Interrupt Processing:

When an interrupt occurs and this interrupt is enabled and a valid interrupt vector has been defined for that interrupt, the normal TMCL program flow will be interrupted and the interrupt handling routine will be called. Before an interrupt handling routine gets called, the context of the normal program will be saved automatically (i.e. accumulator register, X register, TMCL flags).

There is no interrupt nesting, i.e. all other interrupts are disabled while an interrupt handling routine is being executed.

On return from an interrupt handling routine, the context of the normal program will automatically be restored and the execution of the normal program will be continued.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 18

Interrupt number

Interrupt type

Timer 0

Timer 1

Timer 2

Target position reached

stallGuard™

Deviation

Left stop switch

Right stop switch

Input change 0

Input change 1

255

Global interrupts

5.4.2.6.3 Interrupt Vectors:

The following table shows all interrupt vectors that can be used.

5.4.2.6.4 Further Configuration of Interrupts

Some interrupts need further configuration (e.g. the timer interval of a timer interrupt). This can be done using SGP commands with parameter bank 3 (SGP <type>, 3, <value>). Please refer to the SGP command (paragraph 5.6.9) for further information about that.

5.4.2.6.5 Using Interrupts in TMCL

To use an interrupt the following things have to be done:

 Define an interrupt handling routine using the VECT command.  If necessary, configure the interrupt using an SGP <type>, 3, <value> command.  Enable the interrupt using an EI <interrupt> command.  Globally enable interrupts using an EI 255 command.  An interrupt handling routine must always end with a RETI command

The following example shows the use of a timer interrupt:

VECT 0, Timer0Irq //define the interrupt vector SGP 0, 3, 1000 //configure the interrupt: set its period to 1000ms EI 0 //enable this interrupt EI 255 //globally switch on interrupt processing

//Main program: toggles output 3, using a WAIT command for the delay Loop: SIO 3, 2, 1 WAIT TICKS, 0, 50 SIO 3, 2, 0 WAIT TICKS, 0, 50 JA Loop

//Here is the interrupt handling routine Timer0Irq: GIO 0, 2 //check if OUT0 is high JC NZ, Out0Off //jump if not SIO 0, 2, 1 //switch OUT0 high RETI //end of interrupt Out0Off: SIO 0, 2, 0 //switch OUT0 low RETI //end of interrupt

In the example above, the interrupt numbers are used directly. To make the program better readable use the provided include file Interrupts.inc. This file defines symbolic constants for all interrupt numbers which can be used in all interrupt commands. The beginning of the program above then looks like the following:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 19

#include Interrupts.inc VECT TI_TIMER0, Timer0Irq SGP TI_TIMER0, 3, 1000 EI TI_TIMER0 EI TI_GLOBAL

Please also take a look at the other example programs.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 20

5.5 The ASCII Interface

There is also an ASCII interface that can be used to communicate with the module and to send some commands as text strings.

 The ASCII command line interface is entered by sending the binary command 139 (enter ASCII

mode).

 Afterwards the commands are entered as in the TMCL-IDE. Please note that only those commands,

which can be used in direct mode, also can be entered in ASCII mode.

 For leaving the ASCII mode and re-enter the binary mode enter the command BIN.

5.5.1 Format of the Command Line

As the first character, the address character has to be sent. The address character is A when the module address is 1, B for modules with address 2 and so on. After the address character there may be spaces (but this is not necessary). Then, send the command with its parameters. At the end of a command line a <CR> character has to be sent.

Here are some examples for valid command lines:

AMVP ABS, 1, 50000 A MVP ABS, 1, 50000 AROL 2, 500 A MST 1 ABIN

These command lines would address the module with address 1. To address e.g. module 3, use address character C instead of A. The last command line shown above will make the module return to binary mode.

5.5.2 Format of a Reply

After executing the command the module sends back a reply in ASCII format. This reply consists of:

 the address character of the host (host address that can be set in the module)  the address character of the module  the status code as a decimal number  the return value of the command as a decimal number  a <CR> character

So, after sending AGAP 0, 1 the reply would be BA 100 –5000 if the actual position of axis 1 is –5000, the host address is set to 2 and the module address is 1. The value 100 is the status code 100 that means command successfully executed.

5.5.3 Commands That Can be Used in ASCII Mode

The following commands can be used in ASCII mode: ROL, ROR, MST, MVP, SAP, GAP, STAP, RSAP, SGP, GGP, STGP, RSGP, RFS, SIO, GIO, SCO, GCO, CCO, UF0, UF1, UF2, UF3, UF4, UF5, UF6, and UF7.

There are also special commands that are only available in ASCII mode:

 BIN: This command quits ASCII mode and returns to binary TMCL mode.  RUN: This command can be used to start a TMCL program in memory.  STOP: Stops a running TMCL application.

5.5.4 Configuring the ASCII Interface

The module can be configured so that it starts up either in binary mode or in ASCII mode. Global parameter 67 is used for this purpose (please see also chapter 7.1).

Bit 0 determines the startup mode: if this bit is set, the module starts up in ASCII mode, else it will start up in binary mode (default).

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 21

Bit 4 and Bit 5 determine how the characters that are entered are echoed back. Normally, both bits are set to zero. In this case every character that is entered is echoed back when the module is addressed. Character can also be erased using the backspace character (press the backspace key in a terminal program).

When bit 4 is set and bit 5 is clear the characters that are entered are not echoed back immediately but the entire line will be echoed back after the <CR> character has been sent.

When bit 5 is set and bit 4 is clear there will be no echo, only the reply will be sent. This may be useful in RS485 systems.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 22

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don't care

<motor>

0… 5

0… 2047

STATUS

VALUE

100 – OK

don't care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$00

$02

$00

$01

$5e

5.6 Commands

The module specific commands are explained in more detail on the following pages. They are listed according to their command number.

5.6.1 ROR (rotate right)

The motor will be instructed to rotate with a specified velocity in right direction (increasing the position counter).

Internal function: first, velocity mode is selected. Then, the velocity value is transferred to axis parameter #0 (target velocity).

The module is based on the TMC429 stepper motor controller and the TMC260 power driver. This makes possible choosing a velocity between 0 and 2047.

Related commands: ROL, MST, SAP, GAP

Mnemonic: ROR <motor>, <velocity>

Binary representation:

Reply in direct mode:

Example:

Rotate right motor 2, velocity = 350

Mnemonic: ROR 2, 350

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 23

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don't care

<motor>

0… 5

0… 2047

STATUS

VALUE

100 – OK

don't care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$02

$00

$04

$b0

5.6.2 ROL (rotate left)

The motor will be instructed to rotate with a specified velocity (opposite direction compared to ROR, decreasing the position counter).

Internal function: first, velocity mode is selected. Then, the velocity value is transferred to axis parameter #0 (target velocity).

The module is based on the TMC429 stepper motor controller and the TMC260 power driver. This makes possible choosing a velocity between 0 and 2047.

Related commands: ROR, MST, SAP, GAP

Mnemonic: ROL <motor>, <velocity>

Binary representation:

Reply in direct mode:

Example:

Rotate left motor 0, velocity = 1200

Mnemonic: ROL 0, 1200

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 24

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

<motor>

0… 5

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$03

$00

5.6.3 MST (motor stop)

The motor will be instructed to stop.

Internal function: the axis parameter target velocity is set to zero.

Related commands: ROL, ROR, SAP, GAP

Mnemonic: MST <motor>

Binary representation:

Reply in direct mode:

Example:

Stop motor 0

Mnemonic: MST 0

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 25

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0 ABS – absolute

<motor>

0… 5

1 REL – relative

2 COORD – coordinate

<coordinate number> 0… 20

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$04

$00

$01

$5f

$90

Byte Index

0 1 2 3 4 5 6 7 8

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Checksum

Value (hex)

$01

$04

$01

$00

$ff

$fc

$18

5.6.4 MVP (move to position)

The motor will be instructed to move to a specified relative or absolute position or a pre-programmed coordinate. 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. Further commands may follow without waiting for the motor reaching its end position. The maximum velocity and acceleration are defined by axis parameters #4 and #5.

Three operation types are available:

 Moving to an absolute position in the range from - 8388608 to +8388607 (-2  Starting a relative movement by means of an offset to the actual position. In this case, the new

resulting position value must not exceed the above mentioned limits, too.

 Moving the motor to a (previously stored) coordinate (refer to SCO for details).

Please note, that the distance between the actual position and the new one should not be more than 8388607 microsteps. Otherwise the motor will run in the wrong direction for taking a shorter way. If the value is exactly 8388608 the motor maybe stops.

Internal function: A new position value is transferred to the axis parameter #2 target position”.

Related commands: SAP, GAP, SCO, CCO, GCO, MST

Mnemonic: MVP <ABS|REL|COORD>, <motor>, <position|offset|coordinate number>

Binary representation:

to+223-1).

Reply in direct mode:

Example:

Move motor 0 to (absolute) position 90000

Mnemonic: MVP ABS, 0, 9000

Binary:

Example:

Move motor 0 from current position 1000 steps backward (move relative –1000)

Mnemonic: MVP REL, 0, -1000

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 26

Byte Index

0 1 2 3 4 5 6 7 8

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Checksum

Value (hex)

$01

$04

$02

$00

$08

$11

Example:

Move motor 0 to previously stored coordinate #8

Mnemonic: MVP COORD, 0, 8

Binary:

 When moving to a coordinate, the coordinate has to be set properly in advance with the help

of the SCO, CCO or ACO command.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 27

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<motor>

0… 5

<value>

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$05

$06

$02

$00

$2f

5.6.5 SAP (set axis parameter)

With this command most of the motion control parameters can be specified. The settings will be stored in SRAM and therefore are volatile. That is, information will be lost after power off. Please use command STAP (store axis parameter) in order to store any setting permanently.

Internal function: the parameter format is converted ignoring leading zeros (or ones for negative values). The parameter is transferred to the correct position in the appropriate device.

Related commands: GAP, STAP, RSAP, AAP

Mnemonic: SAP <parameter number>, <motor>, <value>

Binary representation:

Reply in direct mode:

For a table with parameters and values which can be used together with this command please refer to chapter 6.

Example:

Set the absolute maximum current of motor 2 to 200mA

Binary:

Because of the current unit 

  



for current setting: 0… 255). The value for current setting has to be calculated before using this special SAP command.

Mnemonic: SAP 6, 2, 47



the 200mA setting has the <value> 47 (value range



www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 28

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<motor>

0… 5

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$06

$01

$00

Byte Index

0 1 2 3 4 5 6

Function

Host-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

$64

$06

$00

$02

$80

5.6.6 GAP (get axis parameter)

Most parameters of the TMCM-6110 can be adjusted individually for the axis. With this 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 conditioned jumps). In direct mode the value read is only output in the value field of the reply (without affecting the accumulator).

Internal function: the parameter is read out of the correct position in the appropriate device. The parameter format is converted adding leading zeros (or ones for negative values).

Related commands: SAP, STAP, AAP, RSAP

Mnemonic: GAP <parameter number>, <motor>

Binary representation:

Reply in direct mode:

For a table with parameters and values which can be used together with this command please refer to chapter 6.

Example:

Get the maximum current of motor 1

Mnemonic: GAP 6, 1

Binary:

Reply:

 Status = no error, value = 128

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 29

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<motor>

0… 5

don’t care*

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Targetaddress

Instruction Number

Type

Motor/ Bank

Operand Byte3

Operand Byte2

Operand Byte1

Operand Byte0

Value (hex)

$01

$07

$04

$00

5.6.7 STAP (store axis parameter)

An axis parameter previously set with a Set Axis Parameter command (SAP) will be stored permanent. Most parameters are automatically restored after power up.

Internal function: an axis parameter value stored in SRAM will be transferred to EEPROM and loaded from EEPORM after next power up.

Related commands: SAP, RSAP, GAP, AAP

Mnemonic: STAP <parameter number>, <motor>

Binary representation:

* the value operand of this function has no effect. Instead, the currently used value (e.g. selected by SAP) is saved

Reply in direct mode:

For a table with parameters and values which can be used together with this command please refer to chapter 6.

Example:

Store the maximum speed of motor 0

Mnemonic: STAP 4, 0

Binary:

The STAP command will not have any effect when the configuration EEPROM is locked (refer to 7.1). In direct mode, the error code 5 (configuration EEPROM locked, see also section 5.2.1) will be returned in this case.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 30

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<motor>

0… 5

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Targetaddress

Instruction Number

Type

Motor/ Bank

Operand Byte3

Operand Byte2

Operand Byte1

Operand Byte0

Value (hex)

$01

$08

$06

$03

$00

5.6.8 RSAP (restore axis parameter)

For all configuration-related axis parameters non-volatile memory locations are provided. By default, most parameters are automatically restored after power up. A single parameter that has been changed before can be reset by this instruction also.

Internal function: the specified parameter is copied from the configuration EEPROM memory to its RAM location.

Relate commands: SAP, STAP, GAP, and AAP

Mnemonic: RSAP <parameter number>, <motor>

Binary representation:

Reply structure in direct mode:

For a table with parameters and values which can be used together with this command please refer to chapter 6.

Example:

Restore the maximum current of motor 3

Mnemonic: RSAP 6, 0

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 31

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<value>

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Targetaddress

Instruction Number

Type

Motor/ Bank

Operand Byte3

Operand Byte2

Operand Byte1

Operand Byte0

Value (hex)

$01

$09

$42

$00

$03

5.6.9 SGP (set global parameter)

With this command most of the module specific parameters not directly related to motion control can be specified and the TMCL user variables can be changed. Global parameters are related to the host interface, peripherals or application specific variables. The different groups of these parameters are organized in banks to allow a larger total number for future products. Currently, only bank 0 and 1 are used for global parameters, and bank 2 is used for user variables.

All module settings will automatically be stored non-volatile (internal EEPROM of the processor). The TMCL user variables will not be stored in the EEPROM automatically, but this can be done by using STGP commands.

Internal function: the parameter format is converted ignoring leading zeros (or ones for negative values). The parameter is transferred to the correct position in the appropriate (on board) device.

Related commands: GGP, STGP, RSGP, AGP

Mnemonic: SGP <parameter number>, <bank number>, <value>

Binary representation:

Reply in direct mode:

For a table with parameters and bank numbers which can be used together with this command please refer to chapter 7.

Example:

Set the serial address of the target device to 3

Mnemonic: SGP 66, 0, 3

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 32

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$0a

$42

$00

Byte Index

0 1 2 3 4 5 6

Function

Host-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

$64

$0a

$00

$01

5.6.10 GGP (get global parameter)

All global parameters can be read with this function. Global parameters are related to the host interface, peripherals or application specific variables. The different groups of these parameters are organized in banks to allow a larger total number for future products. Currently, only bank 0 and 1 are used for global parameters, and bank 2 is used for user variables.

Internal function: the parameter is read out of the correct position in the appropriate device. The parameter format is converted adding leading zeros (or ones for negative values).

Related commands: SGP, STGP, RSGP, AGP

Mnemonic: GGP <parameter number>, <bank number>

Binary representation:

Reply in direct mode:

For a table with parameters and bank numbers which can be used together with this command please refer to chapter 7.

Example:

Get the serial address of the target device

Mnemonic: GGP 66, 0

Binary:

Reply:

 Status = no error, value = 1

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 33

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$0b

$2a

$02

$00

5.6.11 STGP (store global parameter)

This command is used to store TMCL user variables permanently in the EEPROM of the module. Some global parameters are located in RAM memory, so without storing modifications are lost at power down. This instruction enables enduring storing. Most parameters are automatically restored after power up.

Internal function: the specified parameter is copied from its RAM location to the configuration EEPROM.

Related commands: SGP, GGP, RSGP, AGP

Mnemonic: STGP <parameter number>, <bank number>

Binary representation:

Reply in direct mode:

For a table with parameters and bank numbers which can be used together with this command please refer to chapter 7.

Example:

Store the user variable #42

Mnemonic: STGP 42, 2

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 34

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$0c

$2a

$02

$00

5.6.12 RSGP (restore global parameter)

With this command the contents of a TMCL user variable can be restored from the EEPROM. For all configuration-related axis parameters, non-volatile memory locations are provided. By default, most parameters are automatically restored after power up. A single parameter that has been changed before can be reset by this instruction.

Internal function: The specified parameter is copied from the configuration EEPROM memory to its RAM location.

Relate commands: SGP, STGP, GGP, and AGP

Mnemonic: RSGP <parameter number>, <bank number>

Binary representation:

Reply structure in direct mode:

For a table with parameters and bank numbers which can be used together with this command please refer to chapter 7.

Example:

Restore the user variable #42

Mnemonic: RSGP 42, 2

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 35

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0 START – start ref. search 1 STOP – abort ref. search 2 STATUS – get status

<motor>

0… 5

see below

STATUS

VALUE

100 – OK

don’t care

STATUS

VALUE

100 – OK

ref. search active

other values

no ref. search active

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$0d

$00

5.6.13 RFS (reference search)

The TMCM-6110 has a built-in reference search algorithm which can be used. The reference search algorithm provides switching point calibration and three switch modes. The status of the reference search can also be queried to see if it has already finished. (In a TMCL program it is better to use the WAIT command to wait for the end of a reference search.) Please see the appropriate parameters in the axis parameter table to configure the reference search algorithm to meet your needs (chapter 6). The reference search can be started, stopped, and the actual status of the reference search can be checked.

Internal function: the reference search is implemented as a state machine, so interaction is possible during execution.

Related commands: WAIT

Mnemonic: RFS <START|STOP|STATUS>, <motor>

Binary representation:

Reply in direct mode:

When using type 0 (START) or 1 (STOP):

When using type 2 (STATUS):

Example:

Start reference search of motor 0

Mnemonic: RFS START, 0

Binary:

With this module it is possible to use stall detection instead of a reference search.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 36

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<value>

0/1

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$0e

$07

$02

$00

$01

I/O connector 0

I/O connector 1

5.6.14 SIO (set input / output)

This command sets the status of the general digital output either to low (0) or to high (1).

Internal function: the passed value is transferred to the specified output line.

Related commands: GIO, WAIT

Mnemonic: SIO <port number>, <bank number>, <value>

Binary representation:

Reply structure:

Example:

Set OUT_7 to high (bank 2, output 7)

Mnemonic: SIO 7, 2, 1

Binary:

Figure 5.1: connectors of TMCM-6110

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 37

Connector 0

Connector 1

Direction

Description

GND

Power (GND)

GND

DIGITAL

Power (supply output)

Connected to V

DIGITAL

of power connector

AIN_0

AIN_4

Input

Dedicated analog input, input voltage range: 0… +10V, resolution: 12bit (0… 4095)

IN_1

IN_5

Input

Digital input (+24V compatible)

IN_2

IN_6

Input

Digital input (+24V compatible)

IN_3

IN_7

Input

Digital input (+24V compatible)

OUT_0

OUT_4

Output

Open-drain output (max. 100mA) Integrated freewheeling diode

OUT_1

OUT_5

Output

Open-drain output (max. 100mA) Integrated freewheeling diode

OUT_2

OUT_6

Output

Open-drain output (max. 100mA) Integrated freewheeling diode

OUT_3

OUT_7

Output

Open-drain output (max. 1A) Integrated freewheeling diode

I/O Connector

I/O port

Command

Range

OUT_0

SIO 0, 2, <n>

1/0

OUT_1

SIO 1, 2, <n>

1/0 0 9

OUT_2

SIO 2, 2, <n>

1/0

OUT_3

SIO 3, 2, <n>

1/0

OUT_4

SIO 4, 2, <n>

1/0 1 8

OUT_5

SIO 5, 2, <n>

1/0

OUT_6

SIO 6, 2, <n>

1/0

OUT_7

SIO 7, 2, <n>

1/0

I/O CONNECTOR 0 AND 1

Bank 2 is used for setting the status of the general digital output either to low (0) or to high (1).

I/O PORTS USED FOR SIO AND COMMAND

Addressing all output lines with one SIO command:

 Set the type parameter to 255 and the bank parameter to 2.  The value parameter must then be set to a value between 0… 255, where every bit represents one

output line.

 Furthermore, the value can also be set to -1. In this special case, the contents of the lower 8 bits

of the accumulator are copied to the output pins.

Example:

Set all output pins high. Mnemonic: SIO 255, 2, 3

The following program will show the states of the input lines on the output lines:

Loop: GIO 255, 0

SIO 255, 2,-1

JA Loop

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 38

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

STATUS

VALUE

100 – OK

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$0f

$00

$01

$00

Byte Index

0 1 2 3 4 5 6

Function

Host-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

$64

$0f

$00

$01

$2e

5.6.15 GIO (get input /output)

With this command the status of the two available general purpose inputs of the module can be read out. The function reads a digital or analogue input port. Digital lines will read 0 and 1, while the ADC channels deliver their 12 bit result in the range of 0… 4095.

In standalone mode the requested value is copied to the accumulator (accu) for further processing purposes such as conditioned jumps.

In direct mode the value is only output in the value field of the reply, without affecting the accumulator. The actual status of a digital output line can also be read.

Internal function: the specified line is read.

Related commands: SIO, WAIT

Mnemonic: GIO <port number>, <bank number>

Binary representation:

Reply in direct mode:

Example:

Get the analogue value of ADC channel 0

Mnemonic: GIO 0, 1

Binary:

Reply:

Status = no error, value = 46

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 39

I/O connector 0

I/O connector 1

Connector 0

Connector 1

Direction

Description

GND

Power (GND)

GND

DIGITAL

Power (supply output)

Connected to V

DIGITAL

of Power connector

AIN_0

AIN_4

Input

Dedicated analog input, input voltage range: 0… +10V, resolution: 12bit (0… 4095)

IN_1

IN_5

Input

Digital input (+24V compatible)

IN_2

IN_6

Input

Digital input (+24V compatible)

IN_3

IN_7

Input

Digital input (+24V compatible)

OUT_0

OUT_4

Output

Open-drain output (max. 100mA) Integrated freewheeling diode

OUT_1

OUT_5

Output

Open-drain output (max. 100mA) Integrated freewheeling diode

OUT_2

OUT_6

Output

Open-drain output (max. 100mA) Integrated freewheeling diode

OUT_3

OUT_7

Output

Open-drain output (max. 1A) Integrated freewheeling diode

I/O Connector

I/O port

Command

Range

IN_1

GIO 1, 0

0/1

IN_2

GIO 2, 0

0/1

IN_3

GIO 3, 0

0/1

IN_5

GIO 5, 0

0/1 1 5

IN_6

GIO 6, 0

0/1

IN_7

GIO 7, 0

0/1

Figure 5.2: connectors of TMCM-6110

I/O CONNECTOR 0 AND 1

5.6.15.1 I/O bank 0 – digital inputs:

The ADIN lines can be read as digital or analogue inputs at the same time. The analogue values can be accessed in bank 1.

Reading all digital inputs with one GIO command:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 40

I/O Connector

I/O port

Command

Range

AIN_0

GIO 0, 1

0… 4095

AIN_4

GIO 4, 1

0… 4095

I/O Connector

I/O port

Command

Range

OUT_0

GIO 0, 2, <n>

1/0 0 8

OUT_1

GIO 1, 2, <n>

1/0

OUT_2

GIO 2, 2, <n>

1/0

OUT_3

GIO 3, 2, <n>

1/0 1 7

OUT_4

GIO 4, 2, <n>

1/0

OUT_5

GIO 5, 2, <n>

1/0

OUT_6

GIO 6, 2, <n>

1/0

OUT_7

GIO 7, 2, <n>

1/0

 Set the type parameter to 255 and the bank parameter to 0.  In this case the status of all digital input lines will be read to the lower eight bits of the

accumulator.

Use following program to represent the states of the input lines on the output lines:

Loop: GIO 255, 0

SIO 255, 2,-1

JA Loop

5.6.15.2 I/O bank 1 – analogue inputs:

The ADIN lines can be read back as digital or analogue inputs at the same time. The digital states can be accessed in bank 0.

5.6.15.3 I/O bank 2 – the states of digital outputs

The states of the OUT lines (that have been set by SIO commands) can be read back using bank 2.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 41

INSTRUCTION NO.

TYPE <operation>

MOT/BANK

VALUE

0 ADD – add to accu 1 SUB – subtract from accu 2 MUL – multiply accu by 3 DIV – divide accu by 4 MOD – modulo divide by 5 AND – logical and accu with 6 OR – logical or accu with 7 XOR – logical exor accu with 8 NOT – logical invert accu 9 LOAD – load operand to accu

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$13

$02

$00

$FF

$EC

$78

Byte Index

0 1 2 3 4 5 6

Function

Host-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

$64

$13

$ff

$ec

$78

5.6.16 CALC (calculate)

A value in the accumulator variable, previously read by a function such as GAP (get axis parameter) can be modified with this instruction. Nine different arithmetic functions can be chosen and one constant operand value must be specified. The result is written back to the accumulator, for further processing like comparisons or data transfer.

Related commands: CALCX, COMP, JC, AAP, AGP, GAP, GGP, GIO

Mnemonic: CALC <operation>, <value>

Binary representation:

Example:

Multiply accu by -5000

Mnemonic: CALC MUL, -5000

Binary:

Reply:

Status = no error, value = -5000

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 42

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$14

$00

$03

$e8

5.6.17 COMP (compare)

The specified 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.

The host address and the reply are only used to take the instruction to the TMCL program memory while the program loads down. It does not make sense to use this command in direct mode.

Internal function: the specified value is compared to the internal "accumulator", which holds the value of a preceding "get" or calculate instruction (see GAP/GGP/GIO/CALC/CALCX). The internal arithmetic status flags are set according to the comparison result.

Related commands: JC (jump conditional), GAP, GGP, GIO, CALC, CALCX

Mnemonic: COMP <value>

Binary representation:

Example:

Jump to the address given by the label when the position of motor is greater than or equal to

1000.

GAP 1, 2, 0 //get axis parameter, type: no. 1 (actual position), motor: 0, value: 0 don’t care COMP 1000 //compare actual value to 1000 JC GE, Label //jump, type: 5 greater/equal, the label must be defined somewhere else in the

program

Binary format of the COMP 1000 command:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 43

INSTRUCTION NO.

TYPE <condition>

MOT/BANK

VALUE

0 ZE - zero 1 NZ - not zero 2 EQ - equal 3 NE - not equal 4 GT - greater 5 GE - greater/equal 6 LT - lower 7 LE - lower/equal 8 ETO - time out error 9 EAL – external alarm 12 ESD – shutdown error

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$15

$05

$00

$0a

5.6.18 JC (jump conditional)

The JC instruction enables a conditional jump to a fixed address in the TMCL program memory, if the specified condition is met. The conditions refer to the result of a preceding comparison. Please refer to COMP instruction for examples. This function is for standalone operation only.

The host address and the reply are only used to take the instruction to the TMCL program memory while the program loads down. It does not make sense to use this command in direct mode. See the host-only control functions for details.

Internal function: the TMCL program counter is set to the passed value if the arithmetic status flags are in the appropriate state(s).

Related commands: JA, COMP, WAIT, CLE

Mnemonic: JC <condition>, <label>

Binary representation:

Example:

Jump to address given by the label when the position of motor is greater than or equal to 1000.

GAP 1, 0, 0 //get axis parameter, type: no. 1 (actual position), motor: 0, value: 0 don’t care COMP 1000 //compare actual value to 1000 JC GE, Label //jump, type: 5 greater/equal ... ... Label: ROL 0, 1000

Binary format of JC GE, Label when Label is at address 10:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 44

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$16

$00

$14

5.6.19 JA (jump always)

Jump to a fixed address in the TMCL program memory. This command is intended for standalone operation only.

The host address and the reply are only used to take the instruction to the TMCL program memory while the program loads down. This command cannot be used in direct mode.

Internal function: the TMCL program counter is set to the passed value.

Related commands: JC, WAIT, CSUB

Mnemonic: JA <Label>

Binary representation:

Example: An infinite loop in TMCL™

Loop: MVP ABS, 0, 10000 WAIT POS, 0, 0 MVP ABS, 0, 0 WAIT POS, 0, 0 JA Loop //Jump to the label Loop

Binary format of JA Loop assuming that the label Loop is at address 20:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 45

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$17

$00

$64

5.6.20 CSUB (call subroutine)

This function calls a subroutine in the TMCL program memory. It is intended for standalone operation only.

The host address and the reply are only used to take the instruction to the TMCL program memory while the program loads down. This command cannot be used in direct mode.

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. The command will be ignored if there is no more stack space left.

Related commands: RSUB, JA

Mnemonic: CSUB <Label>

Binary representation:

Example: Call a subroutine

Loop: MVP ABS, 0, 10000

CSUB SubW //Save program counter and jump to label SubW

MVP ABS, 0, 0

JA Loop

SubW: WAIT POS, 0, 0

WAIT TICKS, 0, 50

RSUB //Continue with the command following the CSUB command

Binary format of the CSUB SubW command assuming that the label SubW is at address 100:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 46

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$18

$00

5.6.21 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.

The host address and the reply are only used to take the instruction to the TMCL program memory while the program loads down. This command cannot be used in direct mode.

Internal function: the TMCL program counter is set to the last value of the stack. The command will be ignored if the stack is empty.

Related command: CSUB

Mnemonic: RSUB

Binary representation:

Example: please see the CSUB example (section 5.6.20).

Binary format of RSUB:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 47

INSTRUCTION NO.

TYPE <condition>

MOT/BANK

VALUE

0 TICKS - timer ticks*1

don’t care

<no. of ticks*>

1 POS - target position reached

<motor>

0… 5

<no. of ticks* for timeout>, 0 for no timeout

2 REFSW – reference switch

<motor>

0… 5

<no. of ticks* for timeout>, 0 for no timeout

3 LIMSW – limit switch

<motor>

0… 5

<no. of ticks* for timeout>, 0 for no timeout

4 RFS – reference search completed

<motor>

0… 5

<no. of ticks* for timeout>, 0 for no timeout

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$1b

$01

$00

5.6.22 WAIT (wait for an event to occur)

This instruction interrupts the execution of the TMCL program until the specified condition is met. This command is intended for standalone operation only.

The host address and the reply are only used to take the instruction to the TMCL program memory while the program loads down. This command cannot be used in direct mode.

There are five different wait conditions that can be used:

 TICKS: Wait until the number of timer ticks specified by the <ticks> parameter has been

reached.

 POS: Wait until the target position of the motor specified by the <motor> parameter has been

reached. An optional timeout value (0 for no timeout) must be specified by the <ticks> parameter.

 REFSW: Wait until the reference switch of the motor specified by the <motor> parameter has

been triggered. An optional timeout value (0 for no timeout) must be specified by the <ticks> parameter.

 LIMSW: Wait until a limit switch of the motor specified by the <motor> parameter has been

triggered. An optional timeout value (0 for no timeout) must be specified by the <ticks> parameter.

 RFS: Wait until the reference search of the motor specified by the <motor> field has been

reached. An optional timeout value (0 for no timeout) must be specified by the <ticks> parameter.

The timeout flag (ETO) will be set after a timeout limit has been reached. You can then use a JC ETO command to check for such errors or clear the error using the CLE command.

Internal function: the TMCL program counter is held until the specified condition is met.

Related commands: JC, CLE

Mnemonic: WAIT <condition>, <motor>, <ticks>

Binary representation:

one tick is 10 milliseconds

Example:

Wait for motor 0 to reach its target position, without timeout

Mnemonic: WAIT POS, 0, 0

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 48

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$1c

$00

5.6.23 STOP (stop TMCL program execution)

This function stops executing a TMCL program. The host address and the reply are only used to transfer the instruction to the TMCL program memory.

The STOP command should be placed at the end of every standalone TMCL program. It is not to be used in direct mode.

Internal function: TMCL instruction fetching is stopped.

Related commands: none Mnemonic: STOP

Binary representation:

Example:

Mnemonic: STOP

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 49

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0… 20

<motor>

0… 5

-223… +223

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$1e

$01

$00

$03

$e8

5.6.24 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 specified 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).

Please note that the coordinate number 0 is always stored in RAM only.

Internal function: the passed value is stored in the internal position array.

Related commands: GCO, CCO, MVP

Mnemonic: SCO <coordinate number>, <motor>, <position>

Binary representation:

Reply in direct mode:

Example:

Set coordinate #1 of motor to 1000

Mnemonic: SCO 1, 0, 1000

Binary:

Two special functions of this command have been introduced that make it possible to copy all coordinates or one selected coordinate to the EEPROM.

These functions can be accessed using the following special forms of the SCO command:

SCO 0, 255, 0 copies all coordinates (except coordinate number 0) from RAM to

the EEPROM.

SCO <coordinate number>, 255, 0 copies the coordinate selected by <coordinate number> to the

EEPROM. The coordinate number must be a value between 1 and

20.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 50

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0… 20

<motor>

0… 5

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$1f

$01

$00

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

$64

$0a

$00

5.6.25 GCO (get coordinate)

This command makes possible to read out a previously stored coordinate. In standalone mode the requested value is copied to the accumulator register for further processing purposes such as conditioned jumps. In direct mode, the value is only output in the value field of the reply, without affecting the accumulator. 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).

Please note that the coordinate number 0 is always stored in RAM, only.

Internal function: the desired value is read out of the internal coordinate array, copied to the accumulator register and – in direct mode – returned in the value field of the reply.

Related commands: SCO, CCO, MVP

Mnemonic: GCO <coordinate number>, <motor>

Binary representation:

Reply in direct mode:

Example:

Get motor value of coordinate 1

Mnemonic: GCO 1, 0

Binary:

Reply:

 Value: 0

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.

GCO <coordinate number>, 255, 0 copies the coordinate selected by <coordinate number> from the

EEPROM to the RAM. The coordinate number must be a value between 1 and 20.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 51

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0… 20

<motor>

0… 5

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$20

$03

$00

5.6.26 CCO (capture coordinate)

The actual position of the axis is copied 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). Please see the SCO and GCO commands on how to copy coordinates between RAM and EEPROM.

Note, that the coordinate number 0 is always stored in RAM only.

Internal function: the selected (24 bit) position values are written to the 20 by 3 bytes wide coordinate array.

Related commands: SCO, GCO, MVP

Mnemonic: CCO <coordinate number>, <motor>

Binary representation:

Reply in direct mode:

Example:

Store current position of the axis 0 to coordinate 3

Mnemonic: CCO 3, 0

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 52

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0… 20

<motor>

0… 5

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$27

$01

$00

5.6.27 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).

Please note also that the coordinate number 0 is always stored in RAM only. For Information about storing coordinates refer to the SCO command.

Internal function: the actual value of the accumulator is stored in the internal position array.

Related commands: GCO, CCO, MVP COORD, SCO

Mnemonic: ACO <coordinate number>, <motor>

Binary representation:

Reply in direct mode:

Example:

Copy the actual value of the accumulator to coordinate 1 of motor 0

Mnemonic: ACO 1, 0

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 53

INSTRUCTION NO.

TYPE <operation>

MOT/BANK

VALUE

0 ADD – add X register to accu 1 SUB – subtract X register from accu 2 MUL – multiply accu by X register 3 DIV – divide accu by X-register 4 MOD – modulo divide accu by x-register 5 AND – logical and accu with X-register 6 OR – logical or accu with X-register 7 XOR – logical exor accu with X-register 8 NOT – logical invert X-register 9 LOAD – load accu to X-register 10 SWAP – swap accu with X-register

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$21

$02

$00

5.6.28 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.

Related commands: CALC, COMP, JC, AAP, AGP

Mnemonic: CALCX <operation>

Binary representation:

Example:

Multiply accu by X-register

Mnemonic: CALCX MUL Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 54

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

<motor>

0… 5

<don't care>

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$22

$00

5.6.29 AAP (accumulator to axis parameter)

The content of the accumulator register is transferred to the specified axis parameter. For practical usage, the accumulator has to be loaded e.g. by a preceding GAP instruction. The accumulator may have been modified by the CALC or CALCX (calculate) instruction.

Related commands: AGP, SAP, GAP, SGP, GGP, GIO, GCO, CALC, CALCX

Mnemonic: AAP <parameter number>, <motor>

Binary representation:

Reply in direct mode:

For a table with parameters and values which can be used together with this command please refer to chapter 6.

Example:

Positioning motor by a potentiometer connected to the analogue input #0:

Start: GIO 0,1 // get value of analogue input line 0

CALC MUL, 4 // multiply by 4 AAP 0,0 // transfer result to target position of motor 0 JA Start // jump back to start

Binary format of the AAP 0,0 command:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 55

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

STATUS

VALUE

100 – OK

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$23

$03

$02

$00

5.6.30 AGP (accumulator to global parameter)

The content of the accumulator register is transferred to the specified global parameter. For practical usage, the accumulator has to be loaded e.g. by a preceding GAP instruction. The accumulator may have been modified by the CALC or CALCX (calculate) instruction. Note that the global parameters in bank 0 are EEPROM-only and thus should not be modified automatically by a standalone application.

Related commands: AAP, SGP, GGP, SAP, GAP, GIO

Mnemonic: AGP <parameter number>, <bank number>

Binary representation:

Reply in direct mode:

For a table with parameters and bank numbers which can be used together with this command please refer to chapter 7.

Example:

Copy accumulator to TMCL user variable #3

Mnemonic: AGP 3, 2

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 56

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

0 – (ALL) all flags 1 – (ETO) timeout flag 2 – (EAL) alarm flag 3 – (EDV) deviation flag 4 – (EPO) position flag 5 – (ESD) shutdown flag

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$24

$01

$00

5.6.31 CLE (clear error flags)

This command clears the internal error flags. It is intended for use in standalone mode only and must not be used in direct mode.

The following error flags can be cleared by this command (determined by the <flag> parameter):

 ALL: clear all error flags.

 ETO: clear the timeout flag.

 EAL: clear the external alarm flag

 EDV: clear the deviation flag

 EPO: clear the position error flag

Related commands: JC

Mnemonic: CLE <flags>

where <flags>=ALL|ETO|EDV|EPO

Binary representation:

Example:

Reset the timeout flag

Mnemonic: CLE ETO

Binary:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 57

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

<label>

Interrupt number

Interrupt type

Timer 0

Timer 1

Timer 2

Target position reached

stallGuard2™

Deviation

Left stop switch

Right stop switch

Input change 0

Input change 1

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$25

$03

$00

$01

$F4

5.6.32 VECT (set interrupt vector)

The VECT command defines an interrupt vector. It needs an interrupt number and a label as parameter (like in JA, JC and CSUB commands).

This label must be the entry point of the interrupt handling routine.

Related commands: EI, DI, RETI

Mnemonic: VECT <interrupt number>, <label>

Binary representation:

The following table shows all interrupt vectors that can be used:

Example: Define interrupt vector at target position 500 VECT 3, 500

Binary format of VECT:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 58

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Interrupt number

Interrupt type

Timer 0

Timer 1

Timer 2

Target position reached

stallGuard2™

Deviation

Left stop switch

Right stop switch

Input change 0

Input change 1

255

Global interrupts

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$19

$FF

$00

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$19

$03

$00

5.6.33 EI (enable interrupt)

The EI command enables an interrupt. It needs the interrupt number as parameter. Interrupt number 255 globally enables interrupts.

Related command: DI, VECT, RETI

Mnemonic: EI <interrupt number>

Binary representation:

The following table shows all interrupt vectors that can be used:

Examples:

Enable interrupts globally EI, 255

Binary format of EI:

Enable interrupt when target position reached EI, 3

Binary format of EI:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 59

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Interrupt number

Interrupt type

Timer 0

Timer 1

Timer 2

Target position reached

stallGuard2™

Deviation

Left stop switch

Right stop switch

Input change 0

Input change 1

255

Global interrupts

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$1A

$FF

$00

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$1A

$03

$00

5.6.34 DI (disable interrupt)

The DI command disables an interrupt. It needs the interrupt number as parameter. Interrupt number 255 globally disables interrupts.

Related command: EI, VECT, RETI

Mnemonic: DI <interrupt number>

Binary representation:

The following table shows all interrupt vectors that can be used:

Examples:

Disable interrupts globally DI, 255

Binary format of DI:

Disable interrupt when target position reached DI, 3

Binary format of DI:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 60

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

don’t care

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Instruction

Number

Type

Motor/

Bank

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$01

$26

$00

$01

$00

5.6.35 RETI (return from interrupt)

This command terminates the interrupt handling routine, and the normal program execution continues. At the end of an interrupt handling routine the RETI command must be executed.

Internal function: the saved registers (A register, X register, flags) are copied back. Normal program execution continues.

Related commands: EI, DI, VECT

Mnemonic: RETI

Binary representation:

Example: Terminate interrupt handling and continue with normal program execution

RETI

Binary format of RETI:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 61

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

64… 71

user defined

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

user

defined

64… 71

user

defined

user

defined

user

defined

user

defined

5.6.36 Customer Specific TMCL Command Extension (UF0… UF7 - user

function)

The user definable functions UF0… UF7 are predefined functions without topic for user specific purposes. A user function (UF) command uses three parameters. Please contact TRINAMIC for a customer specific programming.

Internal function: Call user specific functions implemented in C by TRINAMIC.

Related commands: none

Mnemonic: UF0… UF7 <parameter number>

Binary representation:

Reply in direct mode:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 62

INSTRUCTION NO.

TYPE

MOT/BANK

VALUE

138

don’t care

<motor>

0… 5

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

100

138

$00

Motor bit

mask

Byte Index

0 1 2 3 4 5 6

Function

Target-

address

Target-

address

Status

Instruction

Operand

Byte3

Operand

Byte2

Operand

Byte1

Operand

Byte0

Value (hex)

$02

$01

128

138

$00

Motor bit

mask

5.6.37 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. This instruction can only be used in direct mode (in

standalone mode, it is covered by the WAIT command) and hence does not have a mnemonic.

Internal function: send an additional reply when the motor has reached its target position

Mnemonic: ---

Binary representation:

Reply in direct mode (right after execution of this command):

Additional reply in direct mode (after motors have reached their target positions):

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 63

5.6.38 BIN (return to binary mode)

This command can only be used in ASCII mode. It quits the ASCII mode and returns to binary mode.

Related Commands: none

Mnemonic: BIN

Binary representation: This command does not have a binary representation as it can only be used in

ASCII mode.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 64

Instruction number

Type

Command

Description

136

0 – string 1 – binary

Firmware version

Get the module type and firmware revision as a string or in binary format. (Motor/Bank and Value are ignored.)

137

don’t care

Reset to factory defaults

Reset all settings stored in the EEPROM to their factory defaults

This command does not send back a reply.

Value must be 1234

Byte index

Contents

Host Address

2… 9

Version string (8 characters, e.g. 6110V100)

Byte index in value field

Contents

Version number, low byte

Version number, high byte

Type number, low byte (currently not used)

Type number, high byte (currently not used)

5.6.39 TMCL Control Functions

There are several TMCL control functions, but for the user are only 136 and 137 interesting. Other control functions can be used with axis parameters.

Further information about command 136

- Type set to 0 - reply as a string:

There is no checksum in this reply format!

- Type set to 1 - version number in binary format:

Please use the normal reply format. The version number is output in the value field of the reply in

the following way:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 65

Access

type

command(s)

Description

GAP

Parameter readable

SAP, AAP

Parameter writable

STAP, RSAP

Parameter automatically restored from EEPROM after reset or power-on. These parameters can be stored permanently in EEPROM using STAP command and also explicitly restored (copied back from EEPROM into RAM) using RSAP.

Number

Axis Parameter

Description

Range [Unit]

Acc.

target (next) position

The desired position in position mode (see ramp mode, no. 138).

 223 [µsteps]

actual position

The current position of the motor. Should only be overwritten for reference point setting.

 2

[µsteps]

target (next) speed

The desired speed in velocity mode (see ramp mode, no. 138). In position mode, this parameter is set by hardware: to the maximum speed during acceleration, and to zero during deceleration and rest.

2047







 









actual speed

The current rotation speed.

2047







 









maximum positioning speed

Should not exceed the physically highest possible value. Adjust the pulse divisor (no.

154), if the speed value is very low (<50) or above the upper limit. See TMC 429 datasheet for calculation of physical units.

0… 2047







 









RWE

maximum acceleration

The limit for acceleration (and deceleration). Changing this parameter requires recalculation of the acceleration factor (no. 146) and the acceleration divisor (no. 137), which is done automatically. See TMC 429 datasheet for calculation of physical units.

0… 2047*1

RWE

6 Axis Parameters

The following sections describe all axis parameters that can be used with the SAP, GAP, AAP, STAP and RSAP commands.

Meaning of the letters in column Access:

Basic parameters should be adjusted to motor / application for proper module operation.

Parameters for the more experienced user – please do not change unless you are absolutely sure.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 66

Number

Axis Parameter

Description

Range [Unit]

Acc.

absolute max. current (CS / Current Scale)

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.

The most important motor setting, since too high values might cause motor damage!

0… 7

79…87

160… 167

240… 247

8… 15

88… 95

168… 175

248… 255

16… 23

96… 103

176… 183

24… 31

104… 111

184… 191

32… 39

112… 119

192… 199

40… 47

120… 127

200… 207

48… 55

128… 135

208… 215

56… 63

136… 143

216… 223

64… 71

144… 151

224… 231

72… 79

152… 159

232… 239

0… 255





  









  





RWE

standby current

The current limit two seconds after the motor has stopped.

0… 255





  









  





RWE

target pos. reached

Indicates that the actual position equals the target position.

0/1

ref. switch status

The logical state of the reference (left) switch. See the TMC 429 data sheet for the different switch modes. The default has two switch modes: the left switch as the reference switch, the right switch as a limit (stop) switch.

0/1

right limit switch status

The logical state of the (right) limit switch.

0/1

left limit switch status

The logical state of the left limit switch (in three switch mode)

0/1 R 12

right limit switch disable

If set, deactivates the stop function of the right switch

0/1

RWE

left limit switch disable

Deactivates the stop function of the left switch resp. reference switch if set.

0/1

RWE

130

minimum speed

Should always be set 1 to ensure exact reaching of the target position. Do not change!

0… 2047







 









RWE 135

actual acceleration

The current acceleration (read only).

0… 2047*1

138

ramp mode

Automatically set when using ROR, ROL, MST and MVP. 0: position mode. Steps are generated, when the parameters actual position and target position differ. Trapezoidal speed ramps are provided. 2: velocity mode. The motor will run continuously and the speed will be changed with constant (maximum) acceleration, if the parameter target speed is changed. For special purposes, the soft mode (value 1) with exponential decrease of speed can be selected.

0/1/2

RWE

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 67

Number

Axis Parameter

Description

Range [Unit]

Acc.

140

microstep resolution

full step

half step

4 microsteps

8 microsteps

16 microsteps

32 microsteps

64 microsteps

128 microsteps

256 microsteps

0… 8

RWE

149

soft stop flag

If cleared, the motor will stop immediately (disregarding motor limits), when the reference or limit switch is hit.

0/1

RWE

153

ramp divisor

The exponent of the scaling factor for the ramp generator- should be de/incremented carefully (in steps of one).

0… 13

RWE

154

pulse divisor

The exponent of the scaling factor for the pulse (step) generator – should be de/incremented carefully (in steps of one).

0… 13

RWE

160

step interpolation enable

Step interpolation is supported with a 16 microstep setting only. In this setting, each step impulse at the input causes the execution of 16 times 1/256 microsteps. This way, a smooth motor movement like in 256 microstep resolution is achieved. 0 – step interpolation off 1 – step interpolation on

0/1

RW 161

double step enable

Every edge of the cycle releases a step/microstep. It does not make sense to activate this parameter for internal use. Double step enable can be used with Step/Dir interface. 0 – double step off 1 – double step on

0/1

162

chopper blank time

Selects the comparator blank time. This time needs to safely cover the switching event and the duration of the ringing on the sense resistor. For low current drivers, a setting of 1 or 2 is good. For higher current applications like the TMCM-6110 a setting of 2 or 3 will be required.

0… 3

163

chopper mode

Selection of the chopper mode: 0 – spread cycle 1 – classic const. off time

0/1

164

chopper hysteresis decrement

Hysteresis decrement setting. This setting determines the slope of the hysteresis during on time and during fast decay time. 0 – fast decrement 3 – very slow decrement

0… 3

165

chopper hysteresis end

Hysteresis end setting. Sets the hysteresis end value after a number of decrements. Decrement interval time is controlled by axis parameter 164.

-3… -1

negative hysteresis end setting

zero hysteresis end setting

1… 12

positive hysteresis end setting

-3… 12

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 68

Number

Axis Parameter

Description

Range [Unit]

Acc.

166

chopper hysteresis start

Hysteresis start setting. Please remark, that this value is an offset to the hysteresis end value.

0… 8

167

chopper off time

The off time setting controls the minimum chopper frequency. An off time within the range of 5µs to 20µs will fit.

Off time setting for constant t

Off

chopper:

CLK

= 12 + 32*t

OFF

(Minimum is 64 clocks)

Setting this parameter to zero completely disables all driver transistors and the motor can free-wheel.

0 / 2… 15

168

smartEnergy current minimum (SEIMIN)

Sets the lower motor current limit for

coolStep™ operation by scaling the CS

(Current Scale, see axis parameter 6) value. minimum motor current: 0 – 1/2 of CS 1 – 1/4 of CS

0/1

169

smartEnergy current down step

Sets the number of stallGuard2™ readings

above the upper threshold necessary for each current decrement of the motor current.

Number of stallGuard2™ measurements per

decrement: Scaling: 0… 3: 32, 8, 2, 1

0: slow decrement 3: fast decrement

0… 3

170

smartEnergy hysteresis

Sets the distance between the lower and the

upper threshold for stallGuard2™ reading.

Above the upper threshold the motor current becomes decreased.

0… 15

Hysteresis: (smartEnergy hysteresis value + 1) * 32

Upper stallGuard2™ threshold: (smartEnergy hysteresis start + smartEnergy

hysteresis + 1) * 32

171

smartEnergy current up step

Sets the current increment step. The current becomes incremented for each measured

stallGuard2™ value below the lower threshold

(see smartEnergy hysteresis start). current increment step size: Scaling: 0… 3: 1, 2, 4, 8

0: slow increment 3: fast increment / fast reaction to rising load

1… 3

172

smartEnergy hysteresis start

The lower threshold for the stallGuard2™

value (see smart Energy current up step).

0… 15

173

stallGuard2™

filter enable

Enables the stallGuard2™ filter for more

precision of the measurement. If set, reduces the measurement frequency to one measurement per four fullsteps.

In most cases it is expedient to set the filtered mode before using coolStep™. Use the standard mode for step loss detection.

0 – standard mode 1 – filtered mode

0/1

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 69

Number

Axis Parameter

Description

Range [Unit]

Acc.

174

stallGuard2™

threshold

This signed value controls stallGuard2™ threshold level for stall output and sets the

optimum measurement range for readout. A lower value gives a higher sensitivity. Zero is the starting value. A higher value makes

stallGuard2™ less sensitive and requires more

torque to indicate a stall.

Indifferent value

1… 63

less sensitivity

-1 64

higher sensitivity

-64… 63

175

slope control high side

Determines the slope of the motor driver outputs. Set to 2 or 3 for this module or rather use the default value. 0: lowest slope 3: fastest slope

0… 3

176

slope control low side

Determines the slope of the motor driver outputs. Set identical to slope control high

side.

0… 3

177

short protection disable

0: Short to GND protection is on 1: Short to GND protection is disabled

Use default value!

0/1

178

short detection timer

0: 3.2µs 1: 1.6µs 2: 1.2µs 3: 0.8µs

Use default value!

0… 3

179

Vsense

sense resistor voltage based current scaling 0: Full scale sense resistor voltage is 1/18 VDD 1: Full scale sense resistor voltage is 1/36 VDD (refers to a current setting of 31 and DAC value 255)

Use default value. Do not change!

0/1

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 specified by SEIMIN.

actual motor current scaling factor:

0 … 31: 1/32, 2/32, … 32/32

0… 31

181

stop on stall

Below this speed motor will not be stopped. Above this speed motor will stop in case

stallGuard2™ load value reaches zero.

0… 2047







 









RW 182

smartEnergy threshold speed

Above this speed coolStep™ becomes

enabled.

0… 2047







 









183

smartEnergy slow run current

Sets the motor current which is used below the threshold speed.

0… 255





  









  





www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 70

Number

Axis Parameter

Description

Range [Unit]

Acc.

193

ref. search mode

search left stop switch only

search rightstop switch, then search left stop switch

search right stop switch, then search left stop switch from both sides

search left stop switch from both sides

search home switch in negative direction, reverse the direction when left stop switch reached

search home switch in positive direction, reverse the direction when right stop switch reached

search home switch in positive direction, ignore end switches

search home switch in negative direction, ignore end switches

Adding 128 to these values reverses the polarity of the home switch input.

1… 8

RWE

194

referencing search speed

For the reference search this value directly specifies the search speed.

0… 2047

RWE

195

referencing switch speed

Similar to parameter no. 194, the speed for the switching point calibration can be selected.

0… 2047

RWE

196

distance end switches

This parameter provides the distance between the end switches after executing the RFS command (mode 2 or 3).

0… 8388307

204

freewheeling

Time after which the power to the motor will be cut when its velocity has reached zero.

0… 65535 0 = never [msec]

RWE 206

actual load value

Readout of the actual load value used for stall

detection (stallGuard2™).

0… 1023

208

TMC260 driver error flags

Bit 0

stallGuard2™ status (1:threshold reached)

Bit 1

Overtemperature (1: driver is shut down due to overtemperature)

Bit 2

Pre-warning overtemperature (1: treshold is exceeded)

Bit 3

Short to ground A (1: short condition deteted, driver currently shut down)

Bit 4

Short to ground B (1: short condition detected, driver currently shut down)

Bit 5

Open load A (1: no chopper event has happened during the last period with constant coil polarity)

Bit 6

Open load B (1: no chopper event has happened during the last period with constant coil polarity)

Bit 7

Stand still (1: no step impulse occurred on the step input during the last 2^20 clock cycles)

Please refer to the TMC260 Datasheet for more information.

0/1

213

Group index

All motors on the module which have the same group index will get the same commands when a ROL, ROR, MST, MVP or RFS is issued for one of these motors.

0… 255

RW 214

power down delay

Standstill period before the current is changed down to standby current. The standard value is 200 (value equates 2000msec).

1… 65535 [10msec]

RWE

*1 Unit of acceleration:



www.trinamic.com















TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 71

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 72

Number

Axis Parameter

Description

absolute max. current (CS / Current Scale)

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.

The most important motor setting, since too high values might cause motor damage!

0… 7

79…87

160… 167

240… 247

8… 15

88… 95

168… 175

248… 255

16… 23

96… 103

176… 183

24… 31

104… 111

184… 191

32… 39

112… 119

192… 199

40… 47

120… 127

200… 207

48… 55

128… 135

208… 215

56… 63

136… 143

216… 223

64… 71

144… 151

224… 231

72… 79

152… 159

232… 239

173

stallGuard2™

filter enable

Enables the stallGuard2™ filter for more precision of the measurement. If set,

reduces the measurement frequency to one measurement per four fullsteps.

In most cases it is expedient to set the filtered mode before using coolStep™. Use the standard mode for step loss detection.

0 – standard mode 1 – filtered mode

motor load

(% max. torque)

stallGuard2

reading

100

200

300

400

500

600

700

800

900

1000

0 10 20 30 40 50 60 70 80 90 100

Start value depends on motor and operating conditions

Motor stalls above this point. Load angle exceeds 90° and available torque sinks.

stallGuard value reaches zero

and indicates danger of stall.

This point is set by stallGuard

threshold value SGT.

6.1 stallGuard2 Related Parameters

The module is equipped with TMC260 motor driver chip. The TMC260 features load measurement that 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. At maximum motor load the stallGuard2™ value goes to zero. This corresponds to a load angle of 90° between the magnetic field of the stator and magnets in the rotor. This also is the most energy efficient point of operation for the motor.

Figure 6.1: Principle function of stallGuard2

Stall detection means that the motor will be stopped when the load gets too high. This level is set using axis parameter #174 (stallGuard2™ threshold). In order to exclude e.g. resonances during motor acceleration and deceleration phases it is also possible to set a minimum speed for motor being stopped due to stall detection using axis parameter #181. Stall detection can also be used for finding the reference point. Do not use RFS in this case.

PARAMETERS NEEDED FOR ADJUSTING THE STALLGUARD2™ FEATURE

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 73

Number

Axis Parameter

Description

174

stallGuard2™

threshold

This signed value controls stallGuard2™ threshold level for stall output and sets the optimum measurement range for readout. A lower value gives a higher sensitivity. Zero is the starting value. A higher value makes stallGuard2™ less sensitive and requires more torque to indicate a stall.

Indifferent value

1… 63

less sensitivity

-1… -64

higher sensitivity

181

stop on stall

Below this speed motor will not be stopped. Above this speed motor will stop in case stallGuard2™ load value reaches zero.

206

actual load value

Readout of the actual load value used for stall detection (stallGuard2™).

In this chapter only basic axis parameters are mentioned which concern stallGuard2™. The complete list of axis parameters in chapter 6 contains further parameters which offer more configuration possibilities.

6.2 coolStep Related Parameters

The figure below gives an overview of the coolStep™ related parameters. Please have in mind that the figure shows only one example for a drive. There are parameters which concern the configuration of the current. Other parameters are for velocity regulation and for time adjustment.

It is necessary to identify and configure the thresholds for current (I6, I7 and I183) and velocity (V182). Furthermore the stallGuard2™ feature has to be adjusted and enabled (SG170 and SG181).

The reduction or increasing of the current in the coolStep™ area (depending on the load) has to be configured with parameters I169 and I171.

In this chapter only basic axis parameters are mentioned which concern coolStep™ and stallGuard2™. The complete list of axis parameters in chapter 6 contains further parameters which offer more configuration possibilities.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 74

Velocity

Time

T214

coolStep™ area

area without coolStep™

coolStep™ adjustment points and thresholds

SG170 SG181

V182

I183 I183

Current

V123 Velocity and parameter

I123 Current and parameter

T123 Time parameter

I183

I6/2*

* The lower threshold of the coolStep™ current can be adjusted up to I6/4. Refer to parameter 168.

The current depends on the load of the motor.

SG123 stallGuard2™ parameter

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 75

Number

Axis parameter

Description

absolute max. current (CS / Current Scale)

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.

The most important motor setting, since too high values might cause motor damage!

0… 7

79…87

160… 167

240… 247

8… 15

88… 95

168… 175

248… 255

16… 23

96… 103

176… 183

24… 31

104… 111

184… 191

32… 39

112… 119

192… 199

40… 47

120… 127

200… 207

48… 55

128… 135

208… 215

56… 63

136… 143

216… 223

64… 71

144… 151

224… 231

72… 79

152… 159

232… 239

standby current

The current limit two seconds after the motor has stopped.

168

smartEnergy current minimum (SEIMIN)

Sets the lower motor current limit for coolStep™ operation by

scaling the CS (Current Scale, see axis parameter 6) value. Minimum motor current: 0 – 1/2 of CS 1 – 1/4 of CS

169

smartEnergy current down step

Sets the number of stallGuard2™ readings above the upper

threshold necessary for each current decrement of the motor current. Number of stallGuard2™ measurements per decrement: Scaling: 0… 3: 32, 8, 2, 1 0: slow decrement 3: fast decrement

171

smartEnergy current up step

Sets the current increment step. The current becomes

incremented for each measured stallGuard2™ value below the

lower threshold (see smartEnergy hysteresis start). current increment step size: Scaling: 0… 3: 1, 2, 4, 8

0: slow increment 3: fast increment / fast reaction to rising load

183

smartEnergy slow run current

Sets the motor current which is used below the threshold speed. Please adjust the threshold speed with axis parameter

182.

170

smartEnergy hysteresis

Sets the distance between the lower and the upper threshold

for stallGuard2™ reading. Above the upper threshold the motor

current becomes decreased.

181

stop on stall

Below this speed motor will not be stopped. Above this speed motor will stop in case stallGuard2™ load value reaches zero.

182

smartEnergy threshold speed

Above this speed coolStep™ becomes enabled.

214

power down delay

Standstill period before the current is changed down to standby current. The standard value is 200 (value equates 2000msec).

PARAMETERS NEEDED FOR ADJUSTING THE COOLSTEP™ FEATURE

For further information about the coolStep™ feature please refer to the TMC260 Datasheet.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 76

Number

Axis Parameter

Description

ref. switch status

right limit switch status

The logical state of the (right) limit switch.

left limit switch status

The logical state of the left limit switch (in three switch mode)

right limit switch disable

If set, deactivates the stop function of the right switch

left limit switch disable

Deactivates the stop function of the left switch resp. reference switch if set.

141

ref. switch tolerance

For three-switch mode: a position range, where an additional switch (connected to the REFL input) won't cause motor stop.

149

soft stop flag

If cleared, the motor will stop immediately (disregarding motor limits), when the reference or limit switch is hit.

193

ref. search mode

search left stop switch only

search right stop switch, then search left stop switch

search right stop switch, then search left stop switch from both sides

search left stop switch from both sides

search home switch in negative direction, reverse the direction when left stop switch reached

search home switch in positive direction, reverse the direction when right stop switch reached

search home switch in positive direction, ignore end switches

search home switch in negative direction, ignore end switches

Adding 128 to these values reverses the polarity of the home switch input.

194

referencing search speed

For the reference search this value directly specifies the search speed.

195

referencing switch speed

Similar to parameter no. 194, the speed for the switching point calibration can be selected.

196

distance end switches

This parameter provides the distance between the end switches after executing the RFS command (mode 2 or 3).

6.3 Reference Search

The built-in reference search features switching point calibration and support of one or two reference switches. The internal operation is based on a state machine that can be started, stopped and monitored (instruction RFS, no. 13). The reference switch is connected in series with the left limit switch. The differentiation between the left limit switch and the home switch is made through software. Switches with open contacts (normally closed) are used.

Hints for reference search:

- The settings of the automatic stop functions corresponding to the switches (axis parameters 12

and 13) have no influence on the reference search.

- Until the reference switch is found for the first time, the searching speed is identical to the

maximum positioning speed (axis parameter 4), unless reduced by axis parameter 194.

- After hitting the reference switch, the motor slowly moves until the switch is released. Finally the

switch is re-entered in the other direction, setting the reference point to the center of the two switching points. This low calibrating speed is a quarter of the maximum positioning speed by default (axis parameter 195).

- Set one of the values for axis parameter 193 for selecting the reference search mode.

PARAMETERS NEEDED FOR REFERENCE SEARCH

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 77

SAP 193, 0, 3

negative limit switch

positive limit switch

SAP 193, 0, 4

negative limit switch

Search right stop switch, then search left stop switch from both sides.

Search left stop switch from both sides.

SAP 193, 0, 1

negative limit switch

SAP 193, 0, 2

negative limit switch

positive limit switch

Search left stop switch only.

Search right stop switch, then search left stop switch.

6.3.1 Reference Search Modes (Axis Parameter 193)

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 78

SAP 193, 0, 5

negative limit switch

positive limit switch

home switch

SAP 193, 0, 6

negative limit switch

positive limit switch

home switch

SAP 193, 0, 7

home switch

SAP 193, 0, 8

home switch

Search home switch in negative direction, reverse the direction when left stop switch reached.

Search home switch in positive direction, reverse the direction when right stop switch reached.

Search home switch in positive direction, ignore end switches.

Search home switch in negative direction, ignore end switches.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 79

TMC429

velocity parameters

Related TMCM-6110 axis parameters

Range

(TMC429 and

TMCM-6110)

Velocity

Axis parameter 2

target (next) speed

Axis parameter 3

actual speed

Axis parameter 4

maximum positioning speed

Axis parameter 13

minimum speed

Axis parameter 194

referencing search speed

Axis parameter 195

referencing switch speed

0… 2047

a_max / maximum acceleration

Axis parameter 5

0… 2047

µsrs / microstep resolution

microsteps per fullstep = 2

µsrs

Axis parameter 140 offers the following settings:

full step

half step

4 microsteps

8 microsteps

16 microsteps

32 microsteps

64 microsteps

128 microsteps

256 microsteps

0… 8

ramp_div / ramp divisor

Axis parameter 153: divider for the acceleration. The higher the value is, the less is the maximum acceleration Default: 0

0… 13

pulse_div / pulse divisor

Axis parameter 153: divider for the velocity. Increasing the value by one halves the acceleration, decreasing the value by one doubles the acceleration. Default: 0

0… 13

CLK

clock frequency

---

16MHz

322048

][







divpulse

velocityHz

CLK

Hzsf



6.4 Calculation: Velocity and Acceleration vs. Microstep- and

Fullstep-Frequency

The values of the axis parameters, sent to the TMC429 do not have typical motor values, like rotations per second as velocity. But these values can be calculated from the TMC429 parameters, as shown in this document.

TMC429 VELOCITY PARAMETERS

6.4.1 Microstep Frequency

The microstep frequency of the stepper motor is calculated with

µsf: microstep-frequency

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 80

srs

Hzsf

Hzfsf



][

][ 

29__

max







divrampdivpulse

CLK

srs





Signal

Value

CLK

16 MHz

velocity

1000

a_max

1000

pulse_div

ramp_div

µsrs

MHz

sf 31.122070

322048

100016











HzHzfsf 34.1907

31.122070

][ 

MHzMhz

a 21.119

2911

1000

)16(









MHz

af 863.1

21.119



49.26

34.1907



rotationperfullsteps

fsf

RPS

46.1589

6034.190760











rotationperfullsteps

fsf

RPM

6.4.2 Fullstep Frequency

To calculate the fullstep frequency from the microstep frequency, the microstep frequency must be divided by the number of microsteps per fullstep.

fsf: fullstep-frequency

The change in the pulse rate per time unit (a: pulse frequency change per second) is given by

This results in acceleration in fullsteps of:

af: acceleration in fullsteps

Example:

6.4.2.1 Calculation of Number of Rotations:

A stepper motor has e.g. 72 fullsteps per rotation.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 81

Number

Parameter

datagram low word (read only)

datagram high word (read only)

cover datagram position

cover datagram length

cover datagram contents

reference switch states (read only)

TMC429 SMGP register

7… 22

driver chain configuration long words 0… 15

23… 38

microstep table long word 0… 15

Access type

Related command

Description

GGP

Parameter readable

SGP, AGP

Parameter writable

SGP, AGP

Parameter stored permanently in EEPROM

7 Global Parameters

Global parameters are grouped into 4 banks:

 bank 0 (global configuration of the module)  bank 1 (user C variables)  bank 2 (user TMCL variables)  bank 3 (interrupt configuration)

Please use SGP and GGP commands to write and read global parameters.

7.1 Bank 0

Parameters 0… 38

The first parameters 0… 38 are only mentioned here for completeness. They are used for the internal

handling of the TMCL-IDE and serve for loading microstep and driver tables. Normally these parameters remain untouched. If you want to use them for loading your specific values with your PC software

please contact TRINAMIC and ask how to do this. Otherwise you might cause damage on the motor driver!

Parameters 64… 132

Parameters with numbers from 64 on configure stuff like the serial address of the module RS485 baud rate or the CAN bit rate. Change these parameters to meet your needs. The best and easiest way to do this is to use the appropriate functions of the TMCL-IDE. The parameters with numbers between 64 and 128 are stored in EEPROM only.

An SGP command on such a parameter will always store it permanently and no extra STGP command is needed. Take care when changing these parameters, and use the appropriate functions of the TMCL-IDE to do it in an interactive way.

Meaning of the letters in column Access:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 82

Number

Global parameter

Description

Range

Access

EEPROM magic

Setting this parameter to a different value as $E4 will cause re-initialization of the axis and global parameters (to factory defaults) after the next power up. This is useful in case of miss-configuration.

0… 255

RWE

RS485 baud rate*)

9600 baud

Default

14400 baud

19200 baud

3 28800 baud

38400 baud

57600 baud

6 76800 baud

Not supported by Windows!

115200 baud

230400 baud

9 250000 baud

Not supported by Windows!

500000 baud

Not supported by Windows!

1000000 baud

Not supported by Windows!

0… 11

RWE

Serial address

The module (target) address for RS485.

0… 255

RWE

ASCII mode

Configure the TMCL ASCII interface: Bit 0: 0 – start up in binary (normal) mode 1 – start up in ASCII mode Bits 4 and 5: 00 – Echo back each character 01 – Echo back complete command 10 – Do not send echo, only send command reply

RWE

CAN bit rate

20kBit/s

3 50kBit/s

100kBit/s

125kBit/s

6 250kBit/s

500kBit/s

1000kBit/s

Default

2… 8

RWE

CAN reply ID

The CAN ID for replies from the board (default: 2)

0… 7ff

RWE

CAN ID

The module (target) address for CAN (default: 1)

0… 7ff

RWE

configuration EEPROM lock flag

Write: 1234 to lock the EEPROM, 4321 to unlock it. Read: 1=EEPROM locked, 0=EEPROM unlocked.

0/1

RWE

Telegram pause time

Pause time before the reply via RS485 is sent. For RS485 it is often necessary to set it to 15 (for RS485 adapters controlled by the RTS pin). For CAN interface this parameter has no effect!

0… 255

RWE

Serial host address

Host address used in the reply telegrams sent back via RS485.

0… 255

RWE

Auto start mode

0: Do not start TMCL application after power up (default). 1: Start TMCL application automatically after power up.

0/1

RWE

End switch polarity

0: normal polarity 1: reverse polarity

0/1

RWE

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 83

Number

Global parameter

Description

Range

Access

TMCL code protection

Protect a TMCL program against disassembling or overwriting. 0 – no protection 1 – protection against disassembling 2 – protection against overwriting 3 – protection against disassembling and overwriting

If you switch off the protection against disassembling, the program will be erased first! Changing this value from 1 or 3 to 0 or 2, the TMCL program will be wiped off.

0,1,2,3

RWE

CAN secondary address

Second CAN ID for the module. Switched off when set to zero.

0… 7ff

RWE

Coordinate storage

0 – coordinates are stored in the RAM only (but can be copied explicitly between RAM and EEPROM) 1 – coordinates are always stored in the EEPROM only

0 or 1

RWE

128

TMCL application status

0 –stop 1 – run 2 – step 3 – reset

0… 3

129

Download mode

0 – normal mode 1 – download mode

0/1 R 130

TMCL program counter

The index of the currently executed TMCL instruction.

R 132

Tick timer

A 32 bit counter that gets incremented by one every millisecond. It can also be reset to any start value.

133

Random number

Choose a random number. Read only!

0… 214748364 7

*) With most RS485 converters that can be attached to the COM port of a PC the data direction is

controlled by the RTS pin of the COM port. Please note that this will only work with Windows 2000, Windows XP or Windows NT4, not with Windows 95, Windows 98 or Windows ME (due to a bug in these operating systems). Another problem is that Windows 2000/XP/NT4 switches the direction back to receive too late. To overcome this problem, set the telegram pause time (global parameter #75) of the module to 15 (or more if needed) by issuing an SGP 75, 0, 15 command in direct mode. The parameter will automatically be stored in the configuration EEPROM.

7.2 Bank 1

The global parameter bank 1 is normally not available. It may be used for customer specific extensions of the firmware. Together with user definable commands (see section 6.3) these variables form the interface between extensions of the firmware (written in C) and TMCL applications.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 84

Access type

Related command

Description

GGP

Parameter readable

SGP, AGP

Parameter writable

SGP, AGP

Parameter stored permanently in EEPROM

Number

Global parameter

Description

Range

Access

general purpose variable #0

for use in TMCL applications

-231… +2

RWE

general purpose variable #1

for use in TMCL applications

-231… +2

RWE

general purpose variable #2

for use in TMCL applications

-231… +2

RWE

general purpose variable #3

for use in TMCL applications

-231… +2

RWE

general purpose variable #4

for use in TMCL applications

-231… +2

RWE

general purpose variable #5

for use in TMCL applications

-231… +2

RWE

general purpose variable #6

for use in TMCL applications

-231… +2

RWE

general purpose variable #7

for use in TMCL applications

-231… +2

RWE

general purpose variable #8

for use in TMCL applications

-231… +2

RWE

general purpose variable #9

for use in TMCL applications

-231… +2

RWE

general purpose variable #10

for use in TMCL applications

-231… +2

RWE

general purpose variable #11

for use in TMCL applications

-231… +2

RWE

general purpose variable #12

for use in TMCL applications

-231… +2

RWE

general purpose variable #13

for use in TMCL applications

-231… +2

RWE

general purpose variable #14

for use in TMCL applications

-231… +2

RWE

general purpose variable #15

for use in TMCL applications

-231… +2

RWE

general purpose variable #16

for use in TMCL applications

-231… +2

RWE

general purpose variable #17

for use in TMCL applications

-231… +2

RWE

general purpose variable #18

for use in TMCL applications

-231… +2

RWE

general purpose variable #19

for use in TMCL applications

-231… +2

RWE

20… 55

general purpose variables #20… #55

for use in TMCL applications

-231… +2

RWE

7.3 Bank 2

Bank 2 contains general purpose 32 bit variables for the use in TMCL applications. They are located in RAM and can be stored to EEPROM. After booting, their values are automatically restored to the RAM.

Up to 56 user variables are available.

Meaning of the letters in column Access:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 85

Access type

Related command

Description

GGP

Parameter readable

SGP, AGP

Parameter writable

SGP, AGP

Parameter stored permanently in EEPROM

Number

Global parameter

Description

Range

Access

Timer 0 period (ms)

Time between two interrupts (ms)

32 bit unsigned [ms]

RWE

Timer 1 period (ms)

Time between two interrupts (ms)

32 bit unsigned [ms]

RWE

Timer 2 period (ms)

Time between two interrupts (ms)

32 bit unsigned [ms]

RWE

Input 0 edge type

0=off, 1=low-high, 2=high-low, 3=both

0… 3

RWE

Input 1 edge type

0=off, 1=low-high, 2=high-low, 3=both

0… 3

RWE

7.4 Bank 3

Bank 3 contains interrupt parameters. Some interrupts need configuration (e.g. the timer interval of a timer interrupt). This can be done using the SGP commands with parameter bank 3 (SGP <type>, 3, <value>). The

priority of an interrupt depends on its number. Interrupts with a lower number have a higher priority.

The following table shows all interrupt parameters that can be set.

Meaning of the letters in column Access:

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 86

8 TMCL Programming Techniques and Structure

8.1 Initialization

The first 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 infinitely. This is also the case in a TMCL application that is running stand alone. Normally the auto start mode of the module should be turned on. After power up, the module then starts the TMCL program, which first does all necessary initializations and then enters the main loop, which does all necessary tasks end never ends (only when the module is powered off or reset).

There are exceptions to this, e.g. when TMCL routines are called from a host in direct mode.

So most (but not all) stand alone TMCL programs look like this:

//Initialization

SAP 4, 0, 500 //define max. positioning speed SAP 5, 0, 100 //define max. acceleration

MainLoop: //do something, in this example just running between two positions MVP ABS, 0, 5000 WAIT POS, 0, 0 MVP ABS, 0, 0 WAIT POS, 0, 0 JA MainLoop //end of the main loop => run infinitely

8.3 Using Symbolic Constants

To make your program better readable and understandable, symbolic constants should be taken for all important numerical values that are used in the program. The TMCL-IDE provides an include file with symbolic names for all important axis parameters and global parameters.

Example:

//Define some constants #include TMCLParam.tmc MaxSpeed = 500 MaxAcc = 100 Position0 = 0 Position1 = 5000

//Initialization SAP APMaxPositioningSpeed, Motor0, MaxSpeed SAP APMaxAcceleration, Motor0, MaxAcc

MainLoop: MVP ABS, Motor0, Position1 WAIT POS, Motor0, 0 MVP ABS, Motor0, Position0 WAIT POS, Motor0, 0 JA MainLoop

Just have a look at the file TMCLParam.tmc provided with the TMCL-IDE. It contains symbolic constants that define all important parameter numbers.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 87

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 definition of the constant and do not have to change all occurrences of it in your program.

8.4 Using Variables

The User Variables can be used if variables are needed in your program. They can store temporary values. The commands SGP, GGP and AGP are used to work with user variables:

SGP is used to set a variable to a constant value (e.g. during initialization phase).

GGP is used to read the contents of a user variable and to copy it to the accumulator register for further

usage.

AGP can be used to copy the contents of the accumulator register to a user variable, e.g. to store the

result of a calculation.

Example:

MyVariable = 42

//Use a symbolic name for the user variable //(This makes the program better readable and understandable.)

SGP MyVariable, 2, 1234 //Initialize the variable with the value 1234 ... ... GGP MyVariable, 2 //Copy the contents of the variable to the accumulator register CALC MUL, 2 //Multiply accumulator register with two AAP MyVariable, 2 //Store contents of the accumulator register to the variable ... ...

Furthermore, these variables can provide a powerful way of communication between a TMCL program running on a module and a host. The host can change a variable by issuing a direct mode SGP command (remember that while a TMCL program is running direct mode commands can still be executed, without interfering with the running program). If the TMCL program polls this variable regularly it can react on such changes of its contents.

The host can also poll a variable using GGP in direct mode and see if it has been changed by the TMCL program.

8.5 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. In the current version of TMCL eight levels of nested subroutine calls are allowed.

8.6 Mixing Direct Mode and Standalone Mode

Direct mode and stand alone mode can also be mixed. When a TMCL program is being executed in standalone mode, direct mode commands are also processed (and they do not disturb the flow of the program running in standalone mode). So, it is also possible to query e.g. the actual position of the motor in direct mode while a TMCL program is running.

Communication between a program running in standalone mode and a host can be done using the TMCL user variables. The host can then change the value of a user variable (using a direct mode SGP command)

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 88

which is regularly polled by the TMCL program (e.g. in its main loop) and so the TMCL program can react on such changes. Vice versa, a TMCL program can change a user variable that is polled by the host (using a direct mode GGP command).

A TMCL program can be started by the host using the run command in direct mode. This way, also a set of TMCL routines can be defined that are called by a host. In this case it is recommended to place JA commands at the beginning of the TMCL program that jump to the specific routines. This assures that the entry addresses of the routines will not change even when the TMCL routines are changed (so when changing the TMCL routines the host program does not have to be changed).

Example:

//Jump commands to the TMCL routines Func1: JA Func1Start Func2: JA Func2Start Func3: JA Func3Start

Func1Start: MVP ABS, 0, 1000 WAIT POS, 0, 0 MVP ABS, 0, 0 WAIT POS, 0, 0 STOP

Func2Start: ROL 0, 500 WAIT TICKS, 0, 100 MST 0 STOP

Func3Start:

ROR 0, 1000 WAIT TICKS, 0, 700 MST 0 STOP

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 first 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. You can see the addresses of the TMCL labels (that are needed for the run commands) by using the Generate symbol file function of the TMCL-IDE.

Please refer to the TMCL-IDE User Guide for further information about the TMCL-IDE.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 89

9 Life Support Policy

TRINAMIC Motion Control GmbH & Co. KG does not authorize or warrant any of its products for use in life support systems, without the specific written consent of TRINAMIC Motion Control GmbH & Co. KG.

Life support systems are equipment intended to support or sustain life, and whose failure to perform, when properly used in accordance with instructions provided, can be reasonably expected to result in personal injury or death.

Information given in this data sheet is believed to be accurate and reliable. However neither responsibility is assumed for the consequences of its use nor for any infringement of patents or other rights of third parties, which may result from its use.

Specifications are subject to change without notice.

www.trinamic.com

TMCM-6110 TMCL Firmware V1.19 Manual (Rev. 1.03 / 2012-JUL-31) 90

Version

Date

Author

Description

1.10

2011-AUG-22

First version supporting all features

1.11

2011-SEP-05

Version

Date

Author

Description

0.90

2011-AUG-24

Preliminary version

1.00

2011-SEP-12

- Start up new.

- Axis parameter commands actualized.

- New subchapters for special axis parameters added.

- Chapter with TMCL programming techniques added.

1.01

2011-NOV-10

- Information about USB interface corrected (4.1.1.2.2)

- TMCL control function 137 (restore to factory defaults,

5.6.39) added.

1.02

2011-NOV-14

Information about dip switch (4.1.1.2.3) added.

10 Revision History

10.1 Firmware Revision

10.2 Document Revision

11 References

[TMCM-6110] TMCM-6110 Hardware Manual [TMC260] TMC260 Datasheet [TMC429] TMC429 Datasheet [TMCL-IDE] TMCL-IDE User Manual

Please refer to www.trinamic.com.

www.trinamic.com

Trinamic TMCM-6110 FIRMWARE MANUAL

Specifications and Main Features

Frequently Asked Questions

User Manual