1
Plug It In2
Get Software3
Build, Run4
CreateSign in to save your progress. Don't have an account? Create one.
Something went wrong! Please try again.
Your FRDM-KV31F comes loaded with the Kinetis Motor Suite “Sensorless Velocity” program. RGB LED will illuminate red and flash blue, like a heartbeat, signaling that the KMS software is operating. When combined with a FRDM-LVPMSM driver board, you can be spinning your motor in minutes.
Something went wrong! Please try again.
The Kinetis Software Development Kit (SDK) is complimentary and includes full source code under a permissive open-source license for all hardware abstraction and peripheral driver software.
Click below to download the SDK Release appropriate for your computer's operating system.
Something went wrong! Please try again.
Want to use a different toolchain?
No problem! The Kinetis SDK includes support for other tools such as IAR, Keil and command-line GCC.
Something went wrong! Please try again.
Many of the example applications output data over the MCU UART so you'll want to make sure that the driver for the board's virtual COM port is installed. Download Driver - download the file:PEDrivers_install.exe.
With the serial port driver installed you can determine the port number of the FRDM-KV31F's virtual COM port, open the device manager and look under the "Ports" group.
Not sure how to use a terminal application? Try one of these tutorials:
Tera Term is a very popular open source terminal emulation application. This program can be used to display information sent from your NXP development platform's virtual serial port.
PuTTY is a popular terminal emulation application. This program can be used to display information sent from your NXP development platform's virtual serial port.
Something went wrong! Please try again.
The Kinetis SDK comes with a long list of example applications code. To see what's available, browse to the SDK boards folder of your SDK installation and select your board, the FRDM-KV31F (
To learn more about specific example code, open the readme.txt file in an example’s directory.
Something went wrong! Please try again.
If one or more of the example applications sound interesting, you're probably wanting to know how you can build and debug yourself. The Getting Started with Kinetis SDK guide provides easy, step-by-step instructions on how to configure, build, and debug SDK example code for all supported toolchains.
Use the guide below to learn how to open, build and debug an example application using the Kinetis Design Studio (KDS) IDE.
Using a different toolchain?
The following steps will guide you through opening the hello_world application. These steps may change slightly for other example applications as some of these applications may have additional layers of folders in their path.
If not already done, open the desired example application workspace. Most example application workspace files can be located using the following path:
Using the hello_world demo as an example, the path is:
Select the desired build target from the drop-down. For this example, select the "hello_world — Debug" target.
To build the application, click the "Make" button, highlighted in red below.
The build will complete without errors.
The FRDM-KV31F board comes loaded with the PE micro debug interface from the factory. If you have changed the debug OpenSDA application on your board, visit http://www.nxp.com/opensda for information on updating or restoring your board to the factory state.
Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.
Open the terminal application on the PC (such as PuTTY or TeraTerm) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:
Click the "Download and Debug" button to download the application to the target.
The application is then downloaded to the target and automatically runs to the main() function.
Run the code by clicking the "Go" button to start the application.
The hello_world application is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections.
After the MDK tools are installed, Cortex® Microcontroller Software Interface Standard (CMSIS) device packs must be installed to fully support the device from a debug perspective. These packs include things such as memory map information, register definitions and flash programming algorithms. Follow these steps to install the appropriate CMSIS pack.
Open the MDK IDE, which is called µVision. In the IDE, select the "Pack Installer" icon.
In the Pack Installer window, navigate to the section with the Kinetis packs (they are in alphabetical order). The Kinetis packs start with "Keil::Kinetis" and are followed by the MCU family name, for example "Keil::Kinetis_KLxx_DFP". Because this example uses the FRDM-KV31F platform, the KLxx family pack is selected. Click on the "Install" button next to the pack. This process requires an internet connection to successfully complete.
After the installation finishes, close the Pack Installer window and return to the µVision IDE.
The following steps will guide you through opening the hello_world application. These steps may change slightly for other example applications as some of these applications may have additional layers of folders in their path.
If not already done, open the desired demo application workspace in:
The workspace file is named
To build the demo project, select the "Rebuild" button, highlighted in red.
The build will complete without errors.
The FRDM-KV31F board comes loaded with the P&E Micro debug interface from the factory. If you have changed the debug OpenSDA application on your board, visit http://www.nxp.com/opensda for information on updating or restoring your board to the factory state.
Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.
Open the terminal application on the PC (such as PuTTY or TeraTerm) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:
After the application is properly built, click the "Download" button to download the application to the target.
After clicking the "Download" button, the application downloads to the target and should be running. To debug the application, click the "Start/Stop Debug Session" button, highlighted in red.
Run the code by clicking the "Run" button to start the application.
The hello_world application is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections.
Before using KDS IDE with KSDK, it is recommended that you make sure that your tools are up-to-date. The steps discussed below are shown using the Windows version of KDS, but are identical for Mac and Linux users.
Select "Help" -> "Check for Updates".
Install all updates from Freescale/NXP – these are denoted by “com.freescale.xxx” or “com.nxp.xxx”. There may also be updates for things such as toolchain or debug interfaces. While these additional updates are typically OK to install, sometimes they may cause issues since they aren’t released as part of the KDS toolchain.
The following steps will guide you through opening the hello_world application. These steps may change slightly for other example applications as some of these applications may have additional layers of folders in their path.
NOTE
The steps required for Linux and Mac OS are identical to those for Windows.
Select File->Import from the KDS IDE menu. In the window that appears, expand the "Project of Projects" folder and select "Existing Project Sets". Then, click the "Next" button.
Click the "Browse" button next to the "Import from file:" option.
Point to the example application project, which can be found using this path:
For this guide, choose the specific location:
After pointing to the correct directory, your "Import Working Sets and Projects" window should look like the figure below. Click the "Finish" button.
There are two project configurations (build targets) supported for each KSDK project:
Choose the appropriate build target, "Debug" or "Release", by clicking the downward facing arrow next to the hammer icon, as shown below. For this example, select the "Debug" target.
The library starts building after the build target is selected. To rebuild the library in the future, click the hammer icon (assuming the same build target is chosen).
The FRDM-KV31F board comes loaded with the PE Micro debug interface from the factory. If you have changed the debug OpenSDA application on your board, visit http://www.nxp.com/opensda for information on updating or restoring your board to the factory state.
NOTE
Mac users must install the J-Link OpenSDA application in order to use the KDS IDE to download and debug their board.
Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.
Open the terminal application on the PC (such as PuTTY or TeraTerm) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:
For Linux OS users only, run the following commands in your terminal. These install libudev onto your system, which is required by KDS IDE to launch the debugger.
user@ubuntu:~$ sudo apt-get install libudev-dev
libudev1
user@ubuntu:~$ sudo ln –s
/usr/lib/x86_64-linux-gnu/libudev.so
/usr/lib/x86_64-linux-gnu/libudev.so.0
Ensure that the debugger configuration is correct for the target you're attempting to connect to. This refers to the OpenSDA interface of your board. If you’re unsure what your board has, please consult Appendix B of the PDF linked in the top right hand corner of this dialog.
To check the available debugger configurations, click the small downward arrow next to the green "Debug" button and select "Debug Configurations".
In the Debug Configurations dialog box, select debug configuration that corresponds to the hardware platform you’re using. For Windows or Linux users, select is the mbed/CMSIS-DAP option under OpenOCD For Mac users, select J-Link.
After selecting the debugger interface, click the "Debug" button to launch the debugger.
The application is downloaded to the target and automatically run to main():
Start the application by clicking the "Resume" button:
The hello_world application is now running and a banner is displayed on the terminal. If this is not the case, check your terminal settings and connections.
This section contains the steps to install the necessary components required to build and run a KSDK demo application with the Arm GCC toolchain, as supported by the Kinetis SDK.
There are many ways to use Arm GCC tools, but this example focuses on a Windows environment. Though not discussed here, GCC tools can also be used with both Linux OS and Mac OSX.
Download and run the installer from launchpad.net/gcc-arm-embedded. This is the actual toolchain (i.e., compiler, linker, etc.). The GCC toolchain should correspond to the latest supported version, as described in the Kinetis SDK Release Notes.
The Minimalist GNU for Windows (MinGW) development tools provide a set of tools that are not dependent on third party C-Runtime DLLs (such as Cygwin). The build environment used by the KSDK does not utilize the MinGW build tools, but does leverage the base install of both MinGW and MSYS. MSYS provides a basic shell with a Unix-like interface and tools.
Download the latest MinGW mingw-get-setup installer from sourceforge.net/projects/mingw/files/Installer/.
Run the installer. The recommended installation path is C:\MinGW, however, you may install to any location.
NOTE
The installation path cannot contain any spaces.
Ensure that the "mingw32-base" and "msys-base" are selected under Basic Setup.
Click "Apply Changes" in the "Installation" menu and follow the remaining instructions to complete the installation.
Add the appropriate item to the Windows operating system Path environment variable. It can be found under Control Panel -> System and Security -> System -> Advanced System Settings in the "Environment Variables..." section. The path is:
Assuming the default installation path, C:\MinGW, an example is shown below. If the path is not set correctly, the toolchain does not work.
NOTE
If you have "C:\MinGW\msys\x.x\bin" in your PATH variable (as required by KSDK 1.0.0), remove it to ensure that the new GCC build system works correctly.
Create a new system environment variable and name it ARMGCC_DIR. The value of this variable should point to the Arm GCC Embedded tool chain installation path, which, for this example, is:
C:\Program Files (x86)\GNU Tools Arm Embedded\5.2 2015q4
Reference the installation folder of the GNU Arm GCC Embedded tools for the exact path name of your installation.
Download CMake 3.0.x from www.cmake.org/cmake/resources/software.html.
Install CMake, ensuring that the option "Add CMake to system PATH" is selected when installing. It's up to the user to select whether it's installed into the PATH for all users or just the current user. In this example, the assumption is that it's installed for all users.
Follow the remaining instructions of the installer.
You may need to reboot your system for the PATH changes to take effect.
Open a GCC Arm Embedded tool chain command window. To
launch the window, from the Windows operating system Start
menu, go to "Programs -> GNU Tools Arm Embedded
Change the directory of the command window to the platform library directory in the KSDK:
There are two project configurations (build targets) supported for each KSDK project:
There are batch files provided to build both configurations. For this example, the "Debug" target is built and "build_debug.bat" is typed on the command line. If the "Release" target is desired, type the "build_release.bat" instead. Alternatively, if using the command line is not desired, you can double click on the batch files from Windows Explorer.
When the build finishes, the output looks like the image below.
The library (libksdk_platform.a) is generated in one of these directories, according to the build target:
KSDK demo applications require that the platform library for the same build target (Debug or Release) is present. Please ensure that you follow the steps in section 7.2 prior to attempting to build a demo application.
To build an example application, follow these steps.
If not already running, open a GCC Arm Embedded tool chain
command window. To launch the window, from the Windows
operating system Start menu, go to "Programs -> GNU
Tools Arm Embedded
Change the directory to the demo application project directory, which has a path like this:
For this example, the exact path is:
Type "build_debug.bat" on the command line or double click on the "build_debug.bat" file in Windows operating system Explorer to perform the build. The output is shown in this figure:
The GCC tools require a J-Link debug interface. To update the OpenSDA firmware on your board to the latest J-Link app, visit www.nxp.com/opensda. After installing the J-Link OpenSDA application, download the J-Link driver and software package from www.segger.com/downloads.html.
Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.
Open the terminal application on the PC (such as PuTTY or TeraTerm) and connect to the debug COM port you determined earlier. Configure the terminal with these settings:
Open the J-Link GDB Server application. Assuming the J-Link software is installed, the application can be launched by going to the Windows operating system Start menu and selecting "Programs -> SEGGER -> J-Link J-Link GDB Server".
Modify the settings as shown below. The target device selection chosen for this example is the "MKV31F512xxx12".
Hit OK to connect to the board. You may see a warning about licensing, so accept the terms to move on.
After it is connected, the screen should resemble this figure:
If not already running, open a GCC Arm Embedded tool chain
command window. To launch the window, from the Windows
operating system Start menu, go to "Programs -> GNU Tools
Arm Embedded
Change to the directory that contains the demo application output. The output can be found in using one of these paths, depending on the build target selected:
For this example, the path is:
Run the command "arm-none-eabi-gdb.exe
Run these commands:
The application is now downloaded and halted at the reset vector. By executing the "monitor go" command, the demo application will begin.
The bubble_level_ftm application is now running and a banner is displayed in the terminal window.
Something went wrong! Please try again.
Let's create our own project and make a simple SDK-based application. NXP provides an intuitive, simple project generation utility that allows creation of custom projects based on the Kinetis SDK.
Get Project GeneratorSomething went wrong! Please try again.
After extracting the ZIP file, open the utility by clicking on the KSDK_Project_Generator executable for your computer's operating system. Point the tool to your SDK installation path, name your project, and select the board that it uses as a reference. Click on the Quick Generate button to finish.
Something went wrong! Please try again.
Your new project will be located in
Something went wrong! Please try again.
Now, let's make our new project do something other than spin in an infinite loop. The SDK examples provide a board support package (BSP) to do various things specific to the board, including macros and definitions for items such as LEDs, switches and peripheral instances. To keep things simple, lets make the LEDs blink using the BSP macros.
Update the main() function in your project's main.c file with the following code:
let copy = ""
let copied = ""
let lang = NXP.locale ? NXP.locale : "en"
switch (lang) {
case "en":
copy = "Copy"
copied = "Copied"
break
case "zh":
copy = "复制"
copied = "已复制"
break
case "cn":
copy = "复制"
copied = "已复制"
break
case "ja":
copy = "コピー"
copied = "コピー済"
break
default:
break
}
volatile int delay;
// Configure board specific pin muxing
hardware_init();
// Initialize the UART terminal
dbg_uart_init();
PRINTF("Create_My_Project Running\n");
// Initialize the LEDs used by this application.
LED1_EN;
LED2_EN;
LED3_EN;;
for (;;)
{
LED1_TOGGLE;
delay = 5000000;
while(delay--);
LED1_TOGGLE;
LED2_TOGGLE;
delay = 5000000;
while(delay--);
LED2_TOGGLE;
LED3_TOGGLE;
delay = 5000000;
while(delay--);
LED3_TOGGLE;
}
Something went wrong! Please try again.
With the changes made to your main() function, build your application. Remember to build the SDK platform library first if you did not build any of the other SDK examples in the previous steps. Once the build is complete, download the application to your board.
If you need help figuring out how to build, download or run an application, reference your tool-specific guide from section 3.2.
Something went wrong! Please try again.
With the application downloaded, you will see the FRDM-KV31F's Tricolor LED blinking. You can also view terminal output using PRINTF.
Something went wrong! Please try again.