Getting Started with the USB-KW38

1. Build the platform library

These steps show how to open a demo workspace in IAR Embedded Workbench, how to build the platform library required by the demo, and how to build the demo application. The example used below is for the hello_world demo, but similar steps can be applied to any demo in the KSDK.

1. Open demo workspace (*.eww file) in:

   /examples/frdmk64f/demo_apps//iar

   After the workspace is open, two projects are shown: one for the KSDK platform library and one for the demo. Also, the platform library project is bold, indicating that it is the active project. The active project can be changed at any time by right clicking on the desired project and selecting "Set as Active" or via the build target drop-down at the top of the workspace browser.

   

2. 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. The tool allows you to select either the Debug or Release configuration on a per-project basis, but since the demo has a dependency on the platform library, whichever configuration is selected for the demo must also be selected for the platform library. Selecting a configuration in the drop-down also makes whichever project and configuration that is selected the active project. For this example, select the "ksdk_platform_lib – Debug" target.
   

3. Click the "Make" button, highlighted in red below.

   

4. When the build is complete, the library (libksdk_platform.a) is generated in one of the following directories, according to the chosen build target:

   /lib/ksdk_platform_lib/iar/K64F12/debug

   /lib/ksdk_platform_lib/iar/K64F12/release

2. Build a Demo Application

The KSDK demo applications are built upon the software building blocks provided in the Kinetis SDK platform library, built in the previous section. If the platform library is not present, the linker displays an error indicating that it cannot find the library. An easy way to check whether the library is present is to expand the Output folder in the ksdk_platform_lib project. If the platform library binary is not built and present, follow the steps on page 1 to build it. Otherwise, continue with the following steps to build the desired demo application.

1. If not already done, open the desired demo application workspace (*.eww file). This example's workspace file is located in:

   /examples/frdmk64f/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 demo application, click the "Make" button, highlighted in red below.

   

4. The build will complete without errors.

3. Run a Demo Application

The FRDM-K64F 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:

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

   

These steps show how to:

1. Load and build the demo application in IAR Embedded Workbench.

2. Download and run the demo application.

The example used below is for the IEEE 802.15.4 "MyWirelessApplication" (mwa) demo, but these steps can be applied to any of the Wireless Connectivity demo applications.

1. Load and build the coordinator application demo

1. Navigate to the mwa_coordinator IAR workspace (located at \boards\usbkw38\wireless_examples\ieee802_15_4\mwa_coordinator\FreeRTOS\iar)

   

2. After the workspace is open, select the project.

   

3. Click the Make button to build the project.

   

2. Download the coordinator application demo

1. Connect your USB-KW38 board to your PC.

2. Click on the Download and Debug button (green arrow located on the toolbar).

   

3. Once the project has loaded, the debugger should stop at main(). At this point, we need to program an end device. So terminate this debug session by clicking the terminate button shown in the figure below.

   

4. Unplug this board and connect a second USB-KW38 board.

3. Load and build the end device application demo

1. Navigate to the mwa_end_device IAR workspace (located at \boards\usbkw38\wireless_examples\ieee802_15_4\mwa_end_device\FreeRTOS\iar)

   

2. After the workspace is open, select the project.

   

3. Click the Make button to build the project.

   

4. Download the coordinator application demo

1. Connect your second USB-KW38 board to your PC (if not done so already).

2. Click on the Download and Debug button (green arrow located on the toolbar).

   

3. Once the project has loaded, the debugger should stop at main(). At this point, we need to run the coordinator and end device together. So terminate this debug session by clicking the terminate button shown in the figure below.

   

4. Unplug this board and connect both boards to your host PC.

Run the coordinator application demo

1. Open a Terminal Emulator program and open a session to one of the USB-KW38 COM ports.

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

2. Open a second Terminal Emulator program and open a session to the other USB-KW38 COM port.

   Configure the terminal with these settings:

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

3. Press the reset button on both boards.

4. The coordinator device should display the following screen:

   

5. The end device should display the following screen:

   

6. Press any switch on the coordinator board first. The screen should then display the following:

   

7. Then press any switch on the end device board. The end device should then connect and display the following screen.

   

8. You should now be able to type characters into either terminal and see the characters echoed in the opposite terminal.

9. Refer to \docs\wireless\IEEE 802.15.4\ IEEE 802.15.4 MAC Demo Applications User's Guide.pdf – "IEEE 802.15.4 Media Access Controller (MAC) Demo Applications" document for instructions on how to run all the demo applications.

These steps show how to:

1. Load and build the demo application in IAR Embedded Workbench.

2. Download and run the demo application.

The example used below is for the Generic FSK Connectivity Test demo, but these steps can be applied to any of the Wireless Connectivity demo applications.

1. Load and build the application demo

1. Navigate to the Connectivity Test IAR workspace (located at "<install_dir>\boards\USBKW38\wireless_examples\genfsk\connectivity_test\freertos\iar)"

   

2. After the workspace is open, select the project.

   

3. Click the Make button to build the project.

   

2. Download and Run the application demo

1. Connect your USB-KW38 board to your PC.

2. Click on the Download and Debug button (green arrow located on the toolbar).

   

3. Once the project has loaded, the debugger should stop at main(). Open a Terminal Emulator program and open a session to your USB-KW38 COM port.
   Configure the terminal with these settings:

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

4. Click the Go button to resume operation.

   

5. The following output will be displayed in the serial terminal.

   

   If you don't see this output, verify your terminal settings and connections.

6. 6. Refer to “<install_dir>\docs\wireless\GENFSK\Generic FSK Link Layer Quick Start Guide.pdf” – "MKW37A/MKW38A/MKW39A/MKW37Z/MKW38Z Generic FSK Link Layer Software" document for more information on this demo application.

These steps show how to:

1. Configure Kinetis Protocol Analyzer Adapter and Wireshark Network Analyzer.

2. Sniff IEEE 802.15.4 wireless applications.

1. Configure Kinetis Protocol Analyzer and Wireshark Network Analyzer

1. Open the "Kinetis Protocol Analyzer Adapter".

   

2. Make sure, you have USB-KW38 connected to your PC when opening Kinetis Protocol Analyzer Adapter, it will start looking for Kinetis sniffer hardware. Once USB-KW38 is detected, KW38 device will be displayed.

   

3. Click on the Wireshark icon to open Wireshark Network Protocol Analyzer.

   
   

4. Wireshark Network Analyzer will be opened. On the "Capture" option of the main window, select the Local Area Connection that was created by the Kinetis Protocol Analyzer, in this example, Kinetis Protocol Analyzer created "Local Area Connection 2", then click "Start" button.

   
   

5. "Capture" window will be opened.

6. Select the desired IEEE 802.15.4 channel to scan in the Kinetis Protocol Analyzer Adapter window. In this guide, we are going to select channel 19 as an example.

   

7. USB-KW38 will start to sniff and upcoming data will be displayed in the "Capture" window of the Wireshark Network Protocol Analyzer.

   
   

8. Refer to the "Kinetis Protocol Analyzer Adapter User's Guide" for more information about how to enable other features of your USB-KW38 sniffer. Document can be found in the next path: \Kinetis Protocol Analyzer Adapter\Kinetis Protocol Analyzer Adapter User's Guide.pdf

These steps show how to:

1. Configure Kinetis Protocol Analyzer Adapter and Wireshark Network Analyzer.

2. Sniff BLE wireless applications.

1. Configure Kinetis Protocol Analyzer and Wireshark Network Analyzer

1. Open the "Kinetis Protocol Analyzer Adapter".

   

2. Make sure, you have USB-KW38 connected to your PC when opening Kinetis Protocol Analyzer Adapter, it will start looking for Kinetis sniffer hardware. Once USB-KW38 is detected, KW38 device will be displayed.

   

3. Click on the Wireshark icon to open Wireshark Network Protocol Analyzer.

   
   

4. Wireshark Network Analyzer will be opened. On the "Capture" option of the main window, select the Local Area Connection that was created by the Kinetis Protocol Analyzer, in this example, Kinetis Protocol Analyzer created "Local Area Connection 2", then click "Start" button.

   
   

5. "Capture" window will be opened.

6. Select the desired advertising channel to scan in the Kinetis Protocol Analyzer Adapter window. In this guide, we are going to select All option to start sniffing on all advertising channels (37, 38 and 39). However, you could select different advertising channels of interest to sniff.

   

7. Address Filter is selected in this guide, hence, only data upcoming from the specified address will be displayed on the "Capture" window. If you are not interested on following any specific address, you can provide a Hopping interval to sniff any device in the advertising channels.

8. USB-KW38 will start to sniff and upcoming data will be displayed in the "Capture" window of the Wireshark Network Protocol Analyzer.

   
   

9. Refer to the "Kinetis Protocol Analyzer Adapter User's Guide" for more information about how to enable other features of your USB-KW38 sniffer. Document can be found in the next path: \Kinetis Protocol Analyzer Adapter\Kinetis Protocol Analyzer Adapter User's Guide.pdf

These steps show how to:

1. Load and build the demo application in MCUXpresso IDE.
2. Download and run the demo application.

The example used below is for the Generic FSK Connectivity Test demo, but these steps can be applied to any of the Wireless Connectivity demo applications.

1. Import the MCUXpresso SDK

1. Open up the MCUXpresso IDE

2. Switch to the Installed SDKs view within the MCUXpresso IDE window

   

3. Open Windows Explorer and drag and drop the USB-KW38 SDK (unzipped) file into the Installed SDKs view.

4. You will get the following pop-up. Click on OK to continue the import:

   

5. The installed SDK will appear in the Installed SDKs view as shown below:

   

2. Build an Example Application

The following steps will guide you through opening the GenFSK example.

1. Find the Quickstart Panel in the lower left hand corner

   

2. Then click on Import SDK examples(s)…

   

3. Click on the USB-KW38 board to select that you want to import an example that can run on that board, and then click on Next.

   

4. In the search text box, type “connectivity_test” to filter the example projects. Use the arrow button to expand the list and locate the “connectivity_test” project (wireless_examples -> genfsk -> connectivity_test), then, select the freertos version of the project and click “Finish”.

   

5. Now build the project by clicking on the project name and then in the Quickstart Panel click on Build.

   

6. You can see the status of the build in the Console tab.

   
7. Now that the project has been compiled, you can now flash it to the board and run it.
8. Make sure the USB-KW38 board is plugged in, and click in the Quickstart Panel click on Debug.
   
9. MCUXpresso IDE will probe for connected boards and should find the DAPLink CMSIS-DAP debug probe that is part of the integrated OpenSDA circuit on the USB-KW38. Click on OK to continue.
   
10. The firmware will be downloaded to the board and the debugger started
    
11. Once the project has loaded, the debugger should stop at main(). Open a Terminal Emulator program and open a session to your USB-KW38 COM port. Configure the terminal with these settings:
    • 115200 baud rate
    • No parity
    • 8 data bits
    • 1 stop bit.
12. Click the “Run” button to resume operation.
    
13. The following output will be displayed in the serial terminal.
    
14. Refer to “<install_dir>\docs\wireless\GENFSK\Generic FSK Link Layer Quick Start Guide.pdf” – " MKW37A/MKW38A/MKW39A/MKW37Z/MKW38Z Generic FSK Link Layer Software’" document for more information on this demo application

1. Import the MCUXpresso SDK

1. Open up the MCUXpresso IDE

2. Switch to the Installed SDKs view within the MCUXpresso IDE window

   

3. Open Windows Explorer, and drag and drop the USB-KW38 SDK (unzipped) file into the Installed SDKs view.

4. You will get the following pop-up. Click on OK to continue the import:

   

5. The installed SDK will appear in the Installed SDKs view as shown below:

   

2. Build an Example Application

The following steps will guide you through opening the 802.15.4 example.

1. Find the Quickstart Panel in the lower left hand corner

   

2. Then click on Import SDK examples(s)…

   

3. Click on the usbkw38 board to select that you want to import an example that can run on that board, and then click on Next.

   

4. Use the arrow button to expand the wireless_examples category, and then under the ieee_802_15_4 category expand the mwa_coordinator project and select the freertos version of project. To use the UART for printing (instead of the default semihosting), clear the “Enable semihost” checkbox under the project options. Then, click on Next.

   

5. On the Advanced Settings wizard, clear the checkbox “Redirect SDK “PRINTF” to C library “printf”“ in order to use the MCUXpresso SDK console functions for printing instead of generic C library ones. Then click on Finish.

   

6. Now build the project by clicking on the project name and then in the Quickstart Panel click on Build.

   

7. You can see the status of the build in the Console tab.

   

3. Download the coordinator device application demo

1. Now that the project has been compiled, you can now flash it to the board and run it.

2. Make sure the USB-KW38 board is plugged in, and click in the Quickstart Panel click on Debug ‘usbkw38_wireless_examples_ieee_802_15_4_maw_coordinator_freertos’ [Debug]

   

3. MCUXpresso IDE will probe for connected boards and should find the JLink debug probe that is part of the integrated OpenSDA circuit on the USB-KW38. Click on OK to continue.

   

4. You may see the following message if this is your first debug with JLink of the day. Click on the checkbox at the bottom to not display the message again, and then click on Accept

   

5. The firmware will be downloaded to the board and the debugger started

   

6. 6. At this point, we need to program an end device. So terminate this debug session by clicking the terminate button shown in the figure below. Then unplug this board, and plug up your second board.

   

4. Download the end device application demo

1. Connect your second USB-KW38 board to your PC (if not already done).

2. Import the wireless_demos->ieee_802_15_4->mwa_end_device_freertos demo using the same steps as you did for the coordinator demo.

   

3. Build and load the end device demo using the same steps as before so that the 2nd USB-KW38 has this firmware on it.

4. Stop the debugger.

   

5. Run the coordinator application demo

1. Open a Terminal Emulator program and open a session to one of the USB-KW38 COM ports.
   Configure the terminal with these settings:

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

2. Open a second Terminal Emulator program and open a session to the other USB-KW38 COM port.
   Configure the terminal with these settings:

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

3. Press the reset button on both boards.

4. The coordinator device should display the following screen:

   

5. The end device should display the following screen:

   

6. Press any switch on the coordinator board first. The screen should then display the following:

   

7. Then press any switch on the end device board. The end device should then connect and display the following screen.

   

8. You should now be able to type characters into either terminal and see the characters echoed in the opposite terminal.

9. Refer to \docs\wireless\IEEE 802.15.4\ IEEE 802.15.4 MAC Demo Applications User's Guide.pdf – "IEEE 802.15.4 Media Access Controller (MAC) Demo Applications" document for instructions on how to run all the demo applications.

1. Click the small arrow next to the green bug icon.

   

2. Select Debug Configurations.

   

3. Select a project under the GDB Segger J-Link Debugging category, and then select the Debugger tab.

   

4. Then select “Variables…” next to the Executable box.

   

5. In the next dialog box, find the jlink_path variable, select it, and then select Edit Variables...

   

6. The Preferences dialog box will open. Select the jlink_path variable and then select Edit.

   

7. In the Edit Variable: jlink_path dialog box, ensure the path and description are as shown below.

   

8. Be sure to click “OK” when closing all dialog boxes.