Stepper 5 click

Besides these advanced technologies, the TM2208 driver employs a set of other features: full output protection and diagnostics, wide input voltage range and reasonably high currents, internal sensing resistor, highly efficient low RDS_ON output MOSFETs, UART communication over a single wire, OTP memory for permanent storing of the working parameters within the specific application, integrated pulse generator for standalone operation, a simple STEP/DIR GPIO interface for driving the motor, and more. All these features allow the developing of highly integrated and reliable step motor driving solution with outstanding performances. It can be used as a direct substitution for simpler step motor drivers in any application that employs one or more step motor drivers.

How does it work?

Stepper click 5 uses the TM2208, a highly integrated bipolar step motor power driver, with the UART interface, from the Trinamic company. As already mentioned, this device features many different features, which allow using the driver almost autonomously. It is equipped with the OTP memory, which can store the working parameters for a specific step motor, avoiding initialization by the MCU, after every Power ON Reset (POR) cycle. Technologies, such as stealthChop2™, spreadCycle™, and microPlayer™, help to achieve high autonomy for the motor driving, using only the STEP and DIR input pins to set the direction and step propagation. Even that can be automated by means of the microPlayer™ technology, reducing the impact on the MCU performance almost completely.

To best describe how to operate this device, it is best to divide its operation into three abstract modes:

A standalone STEP/DIR mode: this mode is also referred to as the legacy mode. The device is operated similar to other pin-driven step motor controllers/drivers – the step propagation is controlled by pulses on the STEP input, and the direction is determined by the DIR pin. MS1 and MS2 pins are used to set the microstep mode from 1:2 step to 1:16 step. VREF pin is used to set the maximum current limit, and on Stepper 5 click, it is set by the R2 resistor, to 1.24A RMS (1.76 peak). The DIAG pin provides diagnostic information, while the INDEX pin provides movement feedback. ENN pin is used to enable or disable the IC. This mode allows the driver to be used as a direct replacement for the simpler driver ICs, thus this mode is called the legacy mode.

A standalone STEP/DIR mode with preprogrammed OTP configuration: the driver IC appears as a standard MCU peripheral device, from the software point of view. A set of configuration and status registers can be used to set the working parameters, which is especially convenient if a specific step motor with known properties is used for the application. The OTP (One Time Programmable) memory is used to store the configuration. It can be stored on the MCU, too. Communication is done via the UART interface, which only requires a single wire for both READ and WRITE operations (a specific message format is utilized to allow this). UART can work on a wide range of baud rates, up to 500K. The UART interface features auto baud rate detection and the CRC generation, allowing for reliable and simple communications to be established with the MCU, even over distances. Once programmed either from the OTP or via the UART, the device can still be driven by the STEP/DIR pins, but the motor performance will be enhanced and fine-tuned to a specific application.

A STEP/DIR mode with the full diagnostics and control: this mode unleashes the full potential of the TM2208. All the parameters can be configured and controlled via the UART, also power and thermal data can be provided back to the MCU for further analysis and optimization. Passive braking and freewheeling modes become available, providing the lowest power consumption for the stop mode (when the step motor is standing still). The control of the microPlayer™ interpolation features become available, allowing more control over micro stepping and yielding even quieter operation. The spreadCycle™ and the stealth Chop2™ technologies offer even more control via the registers. Use of the external pins can be completely bypassed (with the configuration bits), by utilizing the internal programmable step pulse generator. This mode is useful when the absolute top performance is required, with no compromises.

These three modes do not have some special configuration bits that enable them. They are just abstractions of the scenarios in which the Stepper 5 click can be used, therefore they are referred to as the abstract modes. The TM2208 datasheet offers an extensive explanation of all the features of this IC, going into details about how to best use them for a specific application. However, Stepper 5 click comes with the library of functions that simplify its use, along with the example that can be used as a reference for custom projects.

VCC SEL onboard SMD jumper is used to set the logic voltage level for the communication interface. This allows both 3.3V and 5V MCUs to be interfaced with this Click board™. The power supply for the connected bipolar stepper motor can be selected by an onboard SMD jumper labeled as VS SEL, between the 5V rail from the mikroBUS™ and the external power supply. The external power supply can be connected between the VIN and GND inputs of the terminal. The connected voltage should stay within the range between 5V and 36V. The rest of the terminals allow bipolar stepper motor coils to be connected: OA1 and OA2 terminal inputs are used to connect the first coil, while the OB1 and OB2 inputs are used to connect the second motor coil. The microsteps can be configured using the MS SEL jumpers, according to the truth table below the text.

Note that while driving the motor with higher currents, the TM2208 might get warm, affecting its reliability. In that case, proper heat sinks should be used, or the driving current should be reduced.

Specifications

Pinout diagram

This table shows how the pinout on Stepper 5 click corresponds to the pinout on the mikroBUS™ socket (the latter shown in the two middle columns).

Notes	Pin					Pin	Notes
Error Diagnostics OUT	DIA	1	AN	PWM	16	STP	Step trigger IN
Motor Direction IN	DIR	2	RST	INT	15	IND	Pulse Index OUT
Chip Enable IN	EN	3	CS	RX	14	TX	UART Transmit
	NC	4	SCK	TX	13	RX	UART Receive
	NC	5	MISO	SCL	12	NC
	NC	6	MOSI	SDA	11	NC
Power supply	+3V	7	3.3V	5V	10	+5V	Power supply
Ground	GND	8	GND	GND	9	GND	Ground

Stepper 5 click electrical specifications

Microstep resolution configuration

Onboard settings and indicators

Software support

We provide a library for the Stepper 5 Click on our LibStock page, as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Library Description

The library carries everything needed for stepper motor control including speed and acceleration setup. The library is also adjustable to working on different amount of ticks per second, also speed and acceleration can be provided in float format. The buffer used for movement calculation is defined by the user so this library can be adjusted for MCUs with very limited RAM resources. Check the documentation for more details how to use it.

Key functions:

• uint8_t stepper5_setSpeed( float minSpeed, float maxSpeed, float accelRatio, T_STEPPER5_OBJ obj ) - Setup motor speed

• uint8_t stepper5_setRoute( const uint8_t direction, uint32_t steps, T_STEPPER5_OBJ obj ) - Setup new route

• void stepper5_start( T_STEPPER5_OBJ obj ) - Start motor movement

Examples Description

The application is composed of three sections:

• System Initialization - Initializes all GPIO pins found on Stepper 5 Click and timer to 1ms interrupt.
• Application Initialization - the First segment initializes driver and stepper control. The first segment also determines the microstep resolution and puts the motor in stealth mode. Second segment setup movement limits, maximum and minimum speed, and acceleration ratio. The third segment enables motor and sets up a new route which will be called from application task.
• Application Task - (code snippet) - Sequentially moves the motor. Executes movement until the end. 

When movement is finished, waits for two seconds and then repeats all operation.

void applicationTask()
{
stepper5_start( (T_STEPPER5_OBJ)&myStepper );
while ( myStepper.status.running )
{
stepper5_process( (T_STEPPER5_OBJ)&myStepper );
}
Delay_ms( 2000 );
}

In addition to the library, function calls example carries necessary Timer ISR and Timer initialization. Check 
Timer initialization settings and update it according to your MCU - Timer Calculator.

The full application code, and ready to use projects can be found on our 
LibStock page.

Additional notes and information

Depending on the development board you are using, you may need USB UART click,  USB UART 2 click or RS232 click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all MikroElektronika compilers, or any other terminal application of your choice, can be used to read the message.

mikroSDK

This click board is supported by mikroSDK - MikroElektronika Software Development Kit. To ensure proper operation of mikroSDK compliant click board demo applications, mikroSDK should be downloaded from the LibStock and installed for the compiler you are using.