NXP Semiconductors AN13644 Getting Started
NXP Semiconductors AN13644 Getting Started

NXP Semiconductors AN13644 Getting Started

Industrial drive development platform

Advertisement

Quick Links

AN13644
Getting started with i.MX RT Industrial Drive Development Platform
Rev. 1.2 — 8 April 2024
Document information
Information
Keywords
Abstract
Content
i.MX, RT1170, multi-motor control, TSN
This document explains how to get started with the NXP i.MX RT Industrial Drive Development
Platform. It provides detailed instructions to assemble the hardware and program and run the NXP
i.MX RT Industrial Drive Development Platform demo application. This allows users to control and
monitor up to 4 PMSM motors using either FreeMASTER or a TSN master device.
Application note

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the AN13644 and is the answer not in the manual?

Questions and answers

Summary of Contents for NXP Semiconductors AN13644

  • Page 1 AN13644 Getting started with i.MX RT Industrial Drive Development Platform Rev. 1.2 — 8 April 2024 Application note Document information Information Content Keywords i.MX, RT1170, multi-motor control, TSN Abstract This document explains how to get started with the NXP i.MX RT Industrial Drive Development Platform.
  • Page 2: Abbreviations

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform 1 Abbreviations Table 1 summarizes the abbreviations used in this document. Table 1. Abbreviations Acronym Description ACIM AC Induction Motor BLDC Brushless DC Evaluation Kit Graphic User Interface Integrated Development Environment...
  • Page 3: How To Use This Document

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform reduces the effort required to develop multi-motor control applications, in turn reducing the time-to-market of the product. More information on the software package can be found in i.MX RT Industrial Drive Development Platform software overview (document AN13643).
  • Page 4 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Table 2. Hardware material ...continued Component name Description Picture Digital board The digital board works as an external platform to prototype multi-motor control applications. It includes (ISI-QMC-DB02) widely used industrial communication and peripheral interfaces.
  • Page 5 Two MIPI DSI connectors (J132 and J44, respectively) are provided to connect the 5.5" LCD panel (NXP Semiconductors module or a Raspberry Pi compatible LCD). The J53 jumper is used to connect the Raspberry Pi compatible LCD to the 5-V external power supply.
  • Page 6: Hardware Preparation

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Note: A Windows PC has been used to run the software tools listed in Table 3. Other operating systems might be supported as well. 4 Hardware preparation This section describes how to connect different hardware components of the i.MX RT Industrial Drive Development Platform.
  • Page 7 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 2. Daughter card DIP switch configurations 3. To check that the daughter card is properly working, connect it to a 5V power supply (for example, a laptop) using its micro-USB connector (J3) as shown in Figure 3.
  • Page 8 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 4. Connect the daughter card to the digital board 5. Check that the daughter card is properly connected to the digital board as shown in Figure (1) Connect the digital board to a 5V power supply (for example, a laptop) through a micro USB cable (J48 connector);...
  • Page 9: Connect The Power Stage Board To The Digital Board

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 5. Digital board supplied using the micro-USB connector (standalone operation) 4.2 Connect the power stage board to the digital board Up to 4 power stage boards can be connected to the digital board, each one supporting the connection and control of a 3-phase motor.
  • Page 10 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 6. Power stage board connectors in the digital board 2. Connect the power stage boards to the digital board using the connectors described in the previous step. Figure 7...
  • Page 11 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 7. Connect a power stage board to the digital board 3. Repeat the above step for all the power stage boards that you want to connect to your system. You can stack two power stage boards on top of one another using the standoffs and screws included in the i.MX RT...
  • Page 12: Connect The Motors And Power Up The System

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 8. Four power stage boards connected to the digital board 4.3 Connect the motors and power up the system To connect the PMSM motors to the power stage boards and supply and power up the system, follow these steps: 1.
  • Page 13 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 9. Teknic Industrial-Grade NEMA 23 motor - Connector pinout 2. Connect the motors to the power stage boards as shown in Figure (1) Encoder signals of the motor must be routed to the 5-pin J14 connector of the power stage board as...
  • Page 14 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 10. Connect a motor to the power stage board (incremental encoder and phase signals) 3. Connect the power supply to the power stage boards as shown in Figure (1) Connect the positive wire of the power supply to any of the two pins of the J7 connector of all connected power stage boards.
  • Page 15: Connect Lcd With Digital Board

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 11. Connect the power supply to a power stage board 4. If the power stage boards are correctly supplied and no fault has occurred, increase the maximum output current of the power supply unit to 3 A.
  • Page 16: Software Environment Preparation

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform compatible LCD. The J53 jumper is used to connect the Raspberry Pi compatible LCD to the 5-V external power supply. To enable the J132 connector, the J122 jumper must be in the open position. This enables the usage of the RK055HDMIPI4MA0 NXP LCD module.
  • Page 17: Install The Mcuxpresso Ide

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform 5.1 Install the MCUXpresso IDE MCUXpresso is an Eclipse-based development environment for NXP MCUs based on Arm Cortex-M cores offering advanced editing, compiling, and debugging features. In this document, MCUXpresso is used to build and run the i.MX RT Industrial Drive Development Platform software project.
  • Page 18: Install Freemaster

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform 3. Run the downloaded installer file and follow the setup wizard until the MCUXpresso installation is completed. Make sure you allow the installation of the additional drivers required by MCUXpresso during the...
  • Page 19 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 18. Download FreeMASTER - select the operating system 3. During installation, an activation code is requested to activate FreeMASTER Lite. Retrieve the activation code as shown in Figure (1) Click the yes button when you are prompted to visit the NXP licensing portal to retrieve the code;...
  • Page 20: Configure Mcu-Link Pro For J-Link Debugging

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 19. Retrieve FreeMASTER activation code 5.3 Configure MCU-Link Pro for J-Link debugging The MCU-Link Pro is a fully featured debug probe that can be used with MCUXpresso IDE or other IDEs supporting CMSIS-DAP and/or J-Link protocols.
  • Page 21 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 20. Flash J-Link firmware in MCU-Link Pro - Download MCU-Link installer 2. Run the MCU-Link installer executable and follow the installation wizard. By default, the installer creates an...
  • Page 22: Install Usb To Uart Drivers

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 22. Flash J-Link firmware in MCU-Link Pro - Configure MCU-Link Pro debug probe 4. Flash the J-Link firmware in the MCU-Link Pro debug probe. Open a command prompt in the folder where the MCU-Link installer has been already installed (by default C:\nxp\MCU-LINK_installer_2.250), then send...
  • Page 23 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 24. Download required Windows drivers 2. Run the executable and follow the steps of the installation wizard to install the drivers. Click the finish button to complete the installation as shown in...
  • Page 24 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 25. Complete installation of USB to UART Bridge Driver 3. Connect the digital board to the PC using the J1 micro-USB connector, then use the Windows device manager to check that the two COM ports of the digital board are correctly detected as shown in...
  • Page 25: Software Preparation

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 26. COM ports detected in Windows device manager 6 Software preparation The i.MX RT Industrial Drive Development Platform software package includes a demo application that demonstrates how to monitor and control up to four PMSM motors connected to the system. Follow the instructions in this section to provision the secure element through the provisioning tool, import, and configure the i.MX RT Industrial Drive Development Platform demo application in MCUXpresso, compile it, flash it in the...
  • Page 26 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform ini, comment out the default CARD READER, uncomment the ACS ACR1252, and skip steps 10 to 14 of this subchapter. There is an alternative path described at the end of the subchapter.
  • Page 27 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform 7. Take the unpowered Digital board and place the board by the NFC antenna below the NFC reader. The LED color changes to white once a connection is established. To ensure a strong and uninterrupted connection, make sure that the NFC reader is positioned properly on top of the digital board’s NFC antenna.
  • Page 28 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 31. Provision the Secure Element with Auth Objects and Apply Policies enabled 11. Deselect Auth Objects and set Apply Policies to NO. 12. Select all remaining checkboxes. 13. Click the Provision Selected button again, while still holding the NFC reader connected to the Secure Element on the Digital Board.
  • Page 29: Import The I.mx Rt Industrial Drive Development Platform Demo Application

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform 11. The Secure Element on the Digital board is provisioned and you are ready to program your board and try out the application. 6.2 Import the i.MX RT Industrial Drive Development Platform demo application 1.
  • Page 30: Option 2: Use The Command Line

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 34. Import remote SDK Git repository 3. In the dialog box that comes up: a. In the Location field, click the Browse button and create an empty directory named "ap-qmc2g-industrial"...
  • Page 31 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform 3. Drag and drop the "ap-qmc2g-industrial directory" that was created in the previous step into the Installed SDKs window located in a tab at the bottom of the screen named Installed SDKs. Click OK for pop-ups...
  • Page 32: Configure The Application

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform (4) Select all three given projects under Industrial Application: • Industrial_app_master_cm7 • Industrial_app_slave_cm4 • Industrial_bootloader 6. Click the Finish button to import the projects to MCUXpresso. Note: "Industrial" is the internal identifier of the i.MX RT Industrial Drive Development Platform.
  • Page 33: Compile The I.mx Rt Industrial Drive Development Platform Demo Application

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform connector on the Digital Board. Likewise, if two are connected, it is assumed that they are connected to Motor 1 (J153) and Motor 2 (J161), and so on.
  • Page 34: Install The J-Link Software And Configure The Flashloader

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 42. Build the isi_qmc_dgc_industrial_app_slave_cm4 project 2. Build the isi_qmc_dgc_industrial_app_master_cm7 project, as shown in Figure (1) Select the isi_qmc_dgc_industrial_app_master_cm7 project from the left pane. (2) Click the arrow next to the hammer icon in the top bar. Select the Debug (Debug build) option. Wait a few seconds for the project to compile.
  • Page 35 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform successfully. Use the following link for J-Link installations: https://wiki.segger.com/UM08001_J-Link_/_J- Trace_User_Guide Figure 44. Download J-Link installer 2. During the installation process, a J-Link configurations folder is created in "%APPDATA%/SEGGER/". Copy the JLinkDevices folder from the "tools"...
  • Page 36: Flash The I.mx Rt Industrial Drive Development Platform Demo Application And Execute It

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Table 6. Device file locations Location Windows C:\Users\<USER>\AppData\Roaming\SEGGER\JLink Devices Linux $HOME/.config/SEGGER/JLinkDevices macOS $HOME/Library/Application Support/SEGGER/JLinkDevices 6.6 Flash the i.MX RT Industrial Drive Development Platform demo application and execute it Follow the instructions provided below to flash the i.MX RT Industrial Drive Development Platform demo application in the daughter card and execute it: Note: In this section, the MCU-Link Pro debug probe is used to flash the software.
  • Page 37 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform to UART bridge ports: the enhanced COM port will be used for the FreeMASTER communication, while the standard COM port will be used to print debug logs in the terminal. Take note of the two COM port numbers.
  • Page 38 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 48. Open a serial terminal window in MCUXpresso 4. Start debugging the isi_qmc_dgc_industrial_app_master_cm7 project as shown in Figure (1) Select the isi_qmc_dgc_industrial_app_master_cm7 project; (2) Click the arrow next to the green debug icon;...
  • Page 39 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 50. Debug configurations for isi_qmc_dgc_industrial_app_master_cm7 6. The software starts running on the daughter card and will stop at a preconfigured breakpoint. Set a second breakpoint as shown in Figure (1) Double-click on the main() function running in thread #1;...
  • Page 40 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 51. Execute Software: set breakpoint in main() ofisi_qmc_dgc_industrial_app_master_cm7 7. Start a debugging session for isi_qmc_dgc_industrial_app_slave_cm4 following the same steps described for isi_qmc_dgc_industrial_app_master_cm7 (Step 4). Select the appropriate debugging configuration as...
  • Page 41 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 52. Start debugging session for isi_qmc_dgc_industrial_app_slave_cm4 8. Once the software is loaded (1), double-click the main() function of the isi_qmc_dgc_industrial_app_slave_ cm4, (2) then click the resume button as shown in...
  • Page 42: Control The Platform Through A Web Interface

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 53. Resume debugging session in isi_qmc_dgc_industrial_app_slave_cm4 9. Go back to the main() function of isi_qmc_dgc_industrial_app_master _cm7 and click the resume button to resume the execution of the software after the breakpoint. If the software is running correctly on the...
  • Page 43 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform platform. The host machine can be either a separate PC running a Linux or Windows OS or it can be the same PC used to program the boards. If you use the same PC, set up a dual network to allow the server connection to work correctly.
  • Page 44 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 56. Login screen 6. The login credentials were configured during the provisioning steps. The default login for an administrator is admin – Password1. Figure 57. Login credentials in the Provisioning Tool 7.
  • Page 45 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 58. Motor Control tab 8. The Logs tab shows the latest logs reported by the application. 9. The Settings tab can be used to reconfigure various device settings: AN13644 All information provided in this document is subject to legal disclaimers.
  • Page 46 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 59. Settings tab 10. The System Info tab is used for the system time and lifecycle state configuration and FW updates: AN13644 All information provided in this document is subject to legal disclaimers.
  • Page 47 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 60. System Info tab 11. The Admin tab is for user management. Its features are only available to administrators: AN13644 All information provided in this document is subject to legal disclaimers.
  • Page 48: Spin The Motors With Freemaster

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 61. User Management tab 7 Spin the motors with FreeMASTER This section describes how to spin the motors connected to the i.MX RT Industrial Drive Development Platform using the FreeMASTER GUI. If you have not installed FreeMASTER, follow the instructions in Section 5.2...
  • Page 49 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 62. Open the pmsm_demo_QUAD_release FreeMASTER project (1) Figure 63. Open the pmsm_demo_QUAD_release FreeMASTER project 2. Open the FreeMASTER communication with the daughter card as shown in Figure 64. Before executing...
  • Page 50 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 64. Start FreeMASTER communication 3. You can now control the motors using the FreeMASTER GUI as shown in Figure (1) Select the motor to which you want to send a command;...
  • Page 51: Spin The Motors With A Tsn Master Device

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 65. Send motor control commands to i.MX RT Industrial Drive Development Platform 8 Spin the motors with a TSN master device This section describes how to control the motors connected to the i.MX RT Industrial Drive Development Platform using a TSN master device.
  • Page 52: Setting Up The Tsn Master Device With I.mx Rt1170 Evk

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Table 7. Hardware required (TSN master demo) Component Name Description Picture i.MX RT1170 EVK The i.MX RT1170 EVK integrates the i.MX RT1170 crossover MCU and provides a high- performance solution in a highly integrated board.
  • Page 53: Flash The Tsn Master Device And Spin The Motors

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 66. Power up the i.MX RT1170 EVK board 2. Connect the i.MX RT1170 EVK to the i.MX RT Industrial Drive Development Platform using an RJ-45 Ethernet cable as shown in Figure (1) Connect one end of the RJ-45 Ethernet cable to the Gigabit Ethernet connector of the i.MX RT1170 EVK...
  • Page 54 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Note: Make sure that the i.MX RT Industrial Drive Development Platform demo application is running as described in Section 6 before executing the steps described in this section.
  • Page 55 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 69. Flash the imxrt1170evk_industrial_app_tsn_motion_controller.bin binary in the i.MX RT1170 EVK board 3. Power cycle the i.MX RT1170 EVK board using the ON-OFF switch (SW5). The TSN master demo application will start running and will send motor control commands to the i.MX RT Industrial Drive...
  • Page 56: Note About The Source Code In The Document

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Figure 70. Launch serial terminal in MCUXpresso Figure 71. Logs of i.MX RT1170 EVK demo application 9 Note about the source code in the document Example code shown in this document has the following copyright. The source code is licensed with LA_OPT_NXP_Software_License v53 December 2023.
  • Page 57: Revision History

    AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform Copyright 2024 NXP Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Page 58: Legal Information

    NXP Semiconductors. In the event that customer uses the product for design-in and use in In no event shall NXP Semiconductors be liable for any indirect, incidental, automotive applications to automotive specifications and standards, punitive, special or consequential damages (including - without limitation - customer (a) shall use the product without NXP Semiconductors’...
  • Page 59 AN13644 NXP Semiconductors Getting started with i.MX RT Industrial Drive Development Platform AMBA, Arm, Arm7, Arm7TDMI, Arm9, Arm11, Artisan, big.LITTLE, EdgeLock — is a trademark of NXP B.V. Cordio, CoreLink, CoreSight, Cortex, DesignStart, DynamIQ, Jazelle, i.MX — is a trademark of NXP B.V.
  • Page 60: Table Of Contents

    Please be aware that important notices concerning this document and the product(s) described herein, have been included in section 'Legal information'. © 2024 NXP B.V. All rights reserved. For more information, please visit: https://www.nxp.com Date of release: 8 April 2024 Document identifier: AN13644...

Table of Contents