Getting Started with TWR-KE18F Board

Last Modified: 2022-12-29 14:50:00Supports Kinetis KE18 MCU Tower System Module

Contents of this document

  • 1

    Plug It In

  • 2

    Get Software

  • 3

    Build, Run

  • 4

    Create

Purchase your Kinetis KE18 MCU Tower System Module

Contents of this document

Plug It In

Let's take your TWR-KE18F for a test drive! You have the choice of watching the sequence in a short video or following the detailed actions list below.

1.1 Attach the USB Cable

1.2 Run the Out-of-Box Demo

This bubble demo leverages the on board accelerometer. When the board is flat, the RGB LED is turned off, and when the board is tilted, the red or green LEDs gradually illuminate based on the degree of tilt on the X- and Y-axis.

NextGet Software

Get Software

Installing software for the TWR-KE18F

2.1 Jump Start Your Design with the Kinetis SDK

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 KE18 SDK package.

Get SDK

2.2 Install Your Toolchain

NXP offers a complimentary toolchain called Kinetis Design Studio (KDS)



Get Kinetis Design Studio

Want to use a different toolchain?

No problem! The Kinetis SDK includes support for other tools such as IAR (https://www.iar.com/products/architectures/nxp/), Keil (http://www2.keil.com/NXP/) and command-line GCC (https://launchpad.net/gcc-arm-embedded).

2.3 Tool Update

If using Kinetis Design Studio or Arm GCC tool chains, the latest Segger J-Link software tools need to be downloaded and installed. This update is required for those tools to support the KE1x family. Ensure you install this update after installing the IDE of your choice.

First, download the latest "Software and documentation pack" from https://www.segger.com/jlink-software.html

Then Install the software and at the end of the installation, there will be a dialog box asking to update installed IDEs. Make sure the KDS 3.2.0 IDE is checked if using Kinetis Design Studio.

2.4 PC Configuration

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. Before you run the driver installer, you MUST have the board plugged in to your PC.



Download Driver

With the serial port driver installed, run your favorite terminal application to view the serial output from the MCU's UART. Configure the terminal to 115200 baud rate, 8 data bits, no parity and 1 stop bit. To determine the port number of the TWR-KE18F'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.

  1. Download Tera Term from SourceForge. After the download, run the installer and then return to this webpage to continue.

    2. Download

  2. Launch Tera Term. The first time it launches, it will show you the following dialog. Select the serial option. Assuming your board is plugged in, there should be a COM port automatically populated in the list.
  3. Configure the serial port settings (using the COM port number identified earlier) to 115200 baud rate, 8 data bits, no parity and 1 stop bit. To do this, go to Setup -> Serial Port and change the settings.
  4. Verify that the connection is open. If connected, Tera Term will show something like below in it's title bar.
  5. You're ready to go

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.

  1. Download PuTTY using the button below. After the download, run the installer and then return to this webpage to continue.

    2. Download

  2. Launch PuTTY by either double clicking on the *.exe file you downloaded or from the Start menu, depending on the type of download you selected.
  3. Configure In the window that launches, select the Serial radio button and enter the COM port number that you determined earlier. Also enter the baud rate, in this case 115200.
  4. Click Open to open the serial connection. Assuming the board is connected and you entered the correct COM port, the terminal window will open. If the configuration is not correct, PuTTY will alert you.
  5. You're ready to go

PreviousPlug It In
NextBuild, Run

Build, Run

Build and Run SDK Demos on the TWR-KE18F

3.1 Explore the SDK Example Code

The Kinetis SDK comes with a long list of demo applications and driver examples. To see what's available, browse to the SDK boards folder of your SDK installation and select your board, the TWR-KE18F (/boards/twrke18f).

To learn more about demo applications or driver examples, open the Kinetis SDK v.2.0 API Reference Manual, located in /docs.

3.2 Build, Run and Debug SDK Examples

If one or more of the demo applications or driver examples sounds 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 demos for all toolchains supported by the SDK.

Use the guide below to learn how to open, build and debug an example application using the Kinetis Design Studio (KDS) IDE.

1. Install KDS Updates

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.


  1. Select "Help" -> "Check for Updates".

  2. Install all updates from Freescale/NXP – these are denoted by “com.NXP.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.

2. Build an Example Application

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.

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

  2. Click the "Browse" button next to the "Import from file:" option.

  3. Point to the example application project, which can be found using this path:

    /boards////kds

    For this guide, choose the specific location:

    /boards/twrke18f/demo_apps/hello_world/kds

  4. After pointing to the correct directory, your "Import Working Sets and Projects" window should look like the figure below. Click the "Finish" button.

  5. There are two project configurations (build targets) supported for each KSDK project:

    • Debug – Compiler optimization is set to low, and debug information is generated for the executable. This target should be selected for development and debug.
    • Release – Compiler optimization is set to high, and debug information is not generated. This target should be selected for final application deployment.

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

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

3. Run an Example Application

The TWR-KE18F board comes loaded with the mbed/CMSIS-DAP 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.

  1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.

  2. 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:

    • 15200 baud rate
    • No parity
    • 8 data bits
    • 1 stop bit

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

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

  5. The application is downloaded to the target and automatically run to main():

  6. Start the application by clicking the "Resume" button:

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

OpenSDA v2.1 J-link Firmware

3.3 Using a different toolchain?

1. Build an Example Application

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.

  1. If not already done, open the desired example application workspace. Most example application workspace files can be located using the following path:

    /boards////iar

    Using the hello_world demo as an example, the path is:

    /boards/twrke18f/demo_apps/hello_world/iar

  2. Select the desired build target from the drop-down. For this example, select the “hello_world – Debug” target.

  3. To build the application, click the “Make” button, highlighted in red below.

  4. The build will complete without errors.:

2. Run an Example Application

The TWR-KE18F board comes loaded with the mbed/CMSIS-DAP 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.

  1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.

  2. 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:

    • 15200 baud rate
    • No parity
    • 8 data bits
    • 1 stop bit

  3. Click the "Download and Debug" button to download the application to the target.

  4. The application is then downloaded to the target and automatically runs to the main() function.

  5. Run the code by clicking the "Go" button to start the application.

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

h4 class="modal-title" id="Running-demo-Keil"> Running a demo using Keil® MDK/µVision® Download PDF

1. Install CMSIS device pack

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.

  1. Open the MDK IDE, which is called µVision. In the IDE, select the "Pack Installer" icon.

  2. 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_K60_DFP". Because this example uses the TWR-KE18F platform, the K60 family pack is selected. Click on the "Install" button next to the pack. This process requires an internet connection to successfully complete.

  3. After the installation finishes, close the Pack Installer window and return to the µVision IDE.

2. Build the Example Application

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.

  1. If not already done, open the desired demo application workspace in:

    /boards////mdk

    The workspace file is named .uvmpw, so for this specific example, the actual path is:

    /boards/twrke18f/demo_apps/hello_world/iar/hello_world.uvmpw

  2. To build the demo project, select the "Rebuild" button, highlighted in red.

  3. The build will complete without errors.

3. Run an Example Application

The TWR-KE18F board comes loaded with the mbed/CMSIS-DAP 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.

  1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.

  2. 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:

    • 15200 baud rate
    • No parity
    • 8 data bits
    • 1 stop bit

  3. After the application is properly built, click the "Download" button to download the application to the target.

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

  5. Run the code by clicking the "Run" button to start the application.

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

1. Set Up Toolchain

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.


Install GCC Arm Embedded Toolchain

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.


Install MinGW

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.

  1. Download the latest MinGW mingw-get-setup installer from sourceforge.net/projects/mingw/files/Installer/.

  2. Run the installer. The recommended installation path is C:\MinGW, however, you may install to any location.

    3. NOTE

    The installation path cannot contain any spaces.

  3. Ensure that the "mingw32-base" and "msys-base" are selected under Basic Setup.

  4. Click "Apply Changes" in the "Installation" menu and follow the remaining instructions to complete the installation.

  5. 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:

    \bin

    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.

    6. Add a New Environment Variable for ARMGCC_DIR

    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\4.9 2015q3

    Reference the installation folder of the GNU Arm GCC Embedded tools for the exact path name of your installation.

    Install CMake

    1. Download CMake 3.0.x from www.cmake.org/cmake/resources/software.html.

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

    3. Follow the remaining instructions of the installer.

    4. You may need to reboot your system for the PATH changes to take effect.

2. Build an Example Application

To build an example application, follow these steps.

  1. 1. 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 ” and select “GCC Command Prompt”.

  2. Change the directory to the example application project directory, which has a path like this:

    /boards////armgcc

    For this guide, the exact path is:

    /boards/twrke18f/demo_apps/hello_world/armgcc

  3. 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:

3. Run an Example Application

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.

  1. Connect the development platform to your PC via USB cable between the "SDAUSB" USB port on the board and the PC USB connector.

  2. 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:

    • 15200 baud rate
    • No parity
    • 8 data bits
    • 1 stop bit

  3. 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".

  4. Modify the settings as shown below. The target device selection chosen for this example is the “MK64FN1M0xxx12” and use the SWD interface.

  5. After it is connected, the screen should resemble this figure:

  6. 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 " and select "GCC Command Prompt".

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

    /boards////armgcc/debug

    /boards////armgcc/release

    For this guide, the path is:

    /boards/twrke18f/demo_apps/hello_world/armgcc/debug

  8. Run the command "arm-none-eabi-gdb.exe .elf". For this example, it is "arm-none-eabi-gdb.exe hello_world.elf".

  9. Run these commands:

    • "target remote localhost:2331"
    • "monitor reset"
    • "monitor halt"
    • "load"
    • "monitor reset"

  10. The application is now downloaded and halted at the reset vector. Execute the "monitor go" command to start the example application.

    The hello_world application is now running and a banner is displayed in the terminal window.

PreviousGet Software
NextCreate

Create

NXP provides a project cloner tool which allows you to copy an existing demo to use as a base for your own development, keeping the original demo app resources for reference. Click on the link below to get the project generator tool.

Create an Application for the TWR-KE18F

4.1 Get SDK Project Generator

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 Generator

4.2 Run the SDK Project Generator

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.

4.3 Open Your Project

Your new project will be located in /boards/towerke18f/user_apps/myProject/kds. Open the project in your toolchain of choice by using the same process described in section 3.2.

4.4 Write Some Code

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 LED blink using the BSP macros.

Update the main() function in your project's main.c file with the following code:

volatile int delay;

// Configure board specific pin muxing
BOARD_InitPins();

// Configure clock source
BOARD_BootClockRUN();

// Initialize the UART terminal
BOARD_InitDebugConsole();

PRINTF("\r\nRunning the myProject project.\n");

// Enable GPIO port for the red LED
CLOCK_EnableClock(kCLOCK_PortE);
PORT_SetPinMux(BOARD_LED_RED_GPIO_PORT, BOARD_LED_RED_GPIO_PIN, kPORT_MuxAsGpio);
LED_RED_INIT(LOGIC_LED_OFF);

for (;;)
{
LED_RED_TOGGLE();

delay = 5000000;
while(delay--);
}

4.5 Build, Download, Run

With the changes made to your main() function, build your application. 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.

4.6 Success

With the application downloaded, you will see the TWR-KE18F's red LED blinking. You can also view terminal output using PRINTF.

PreviousBuild, Run
NextDesign Resources

Design Resources

Chip Documents

  • Kinetis KE1xF Sub-Family Reference Manual
  • Mask Set Errata for Mask 0N79P

    • Board Information

  • Microcontroller Symbols, Footprints and Models
  • TWR-KE18F Schematics and Design Files

    • Software

  • Getting Started with Kinetis® SDK v2
  • Software Development Kit for Kinetis® MCUs
  • MCU Bootloader for NXP Microcontrollers
  • Kinetis® SDK v2 API Reference Manual
  • Kinetis Bootloader v2.0.0 Reference Manual

    • PreviousCreate
    NextSupport

    Support

  • Support

    • PreviousDesign Resources