## Introduction This document explains how to setup a development environment on Windows OS for the [DevEdge IoT Developer Kit](/solutions/iotdevkit)'s RTOS and SDK. ## Prerequisites - A computer with Linux Ubuntu operating system 22.04 or greater installed on it. - A serial app. - A computer with USB ports. - PIP3 installed - [SEGGER J-Link](https://www.segger.com/downloads/jlink/) installed software ## Why would I want to implement the instructions in this document? - To be able to upgrade or change the firmware on the [DevEdge IoT Developer Kit](/solutions/iotdevkit). ## Configuration ### Step A Backup your work. If you have previous installation of the T-Mobile RTOS and SDK downloaded on your machine, please save a copy of your work. If not, please skip to Step B. 1. Save a copy of the following folders or all your work in progress will be deleted: 1. $HOME/zephyrproject/DevEdge-IoTDevKit-ZephyrSDK 2. $HOME/zephyrproject/zephyr ### Step B Install Zephyr. 1. Follow the instructions [here](https://docs.zephyrproject.org/latest/develop/getting_started/index.html) to install Zephyr for Linux. 2. Under *Get Zephyr and install Python dependencies* > Step 2 or 4 (depending on whether you are installing a virtual or global environment) replace `west init zephyr` with `west init -m https://github.com/tmobile/DevEdge-IoTDevKit-ZephyrRTOS.git ~/zephyrproject` ![](https://devedge.t-mobile.com/uploads/ubuntu_west_call_change_b0792c9699.png?updated_at=2023-01-12T17:20:46.072Z) 3. The rest of the instructions remain the same. 4. Stop at the _Build the Blinky Sample_ section. ### Step C Clone the T-Mobile Zephyr RTOS and SDK. 1. Open Terminal. 2. Enter the following to download the T-Mobile Zephyr SDK, aka [tmo_shell](/documentation-hub/iot-developer-kit/interacting-with-the-kit-at-cli-via-tmo-shell).

The release version will change over time.

    cd ~/zephyrproject
    git clone https://github.com/tmobile/DevEdge-IoTDevKit-ZephyrSDK.git
    cd DevEdge-IoTDevKit-ZephyrSDK
    git checkout tmz-sdk-1.19.1-qa

3. Clone the T-Mobile Zephyr RTOS repository.

The release version will change over time.

    cd ~/zephyrproject
    rm -rf zephyr
    git clone https://github.com/tmobile/DevEdge-IoTDevKit-ZephyrRTOS.git zephyr
    cd zephyr
    git checkout tmz-1.19.1-qa

4. Refresh the Zephyr modules by running the following commands.

Do this whenever cloning or pulling the Zephyr repo.

    cd ~/zephyrproject
    west update

5. Stop here if all you wish to do is upgrade your tmo_shell to the latest version. ### Step D Build your "Hello World" sample then flash the board. 1. Set the build environment by entering the below code into Terminal.

    source DevEdge-IoTDevKit-ZephyrSDK/set-zephyr-build-env

2. Connect to your IoT Developer Kit via serial app. 1. Connect your developer kit to your Linux Ubuntu computer. Plug in your USB-C to USB-A cable into the board like in the screenshot below. Ensure that the USB-C end it plugged into the **J-Link USB-C Debug** port. ![](https://devedge.t-mobile.com/uploads/iot_dev_kit_how_to_connect_3e7f450c51.png?api=v2) 2. Open your serial app. For demonstration purposes we will use picocom. 3. Select the serial port that is connected to your IoT Developer Kit. 4. Set your rates to the following: 1. Baud Rate / Speed - 9600 2. Data Rate - 8 3. Parity - None 4. Stop Bits - 1 5. Flow Control - None ![](https://devedge.t-mobile.com/uploads/picocom_baud_raud_flow_db5bd5233c.png?updated_at=2023-01-12T17:03:08.076Z) 5. At the command line screen press **_Enter_** on your keyboard. The uart command prompt appears. To learn more about uart, please read the document [Interacting with the Kit at CLI via tmo_shell](/documentation-hub/iot-developer-kit/interacting-with-the-kit-at-cli-via-tmo-shell). ![](https://devedge.t-mobile.com/uploads/picocom_before_uart_5531a29e53.png?updated_at=2023-01-12T17:03:02.479Z) ![](https://devedge.t-mobile.com/uploads/picocom_uart_777a34624f.png?updated_at=2023-01-12T17:03:05.979Z) 3. In Terminal, build the "Hello World" sample.

    west build $HOME/zephyrproject/zephyr/samples/hello_world -p -b tmo_dev_edge

4. Flash the "Hello World" sample onto the kit.

    west flash

5. If the flash occurred successfully you should see the below screenshot in your serial app. ![](https://devedge.t-mobile.com/uploads/picocom_hello_world_b13ac16d9d.png?updated_at=2023-01-12T17:02:57.150Z) 6. Update the code found in the $HOME/zephyrproject/zephyr/samples/hello_world/src/main.c file to create whatever project you desire. ![](https://devedge.t-mobile.com/uploads/ubuntu_files_main_c_d5cd908e3b.png?updated_at=2023-01-12T17:03:04.879Z) ![](https://devedge.t-mobile.com/uploads/ubuntu_visual_studio_code_main_c_hello_kathleen_0a17f67c5f.png?updated_at=2023-01-12T17:02:55.022Z) 7. Flash the board again with your changes.

    west flash

8. Check that your "Hello World" project works. ![](https://devedge.t-mobile.com/uploads/picocom_hello_kathleen_2100c6666a.png?updated_at=2023-01-12T17:03:02.478Z) ### Step E Build your "tmo_shell" sample then flash the board. 1. Set the build environment by entering the below code into Terminal.

    cd ~/zephryproject
    source DevEdge-IoTDevKit-ZephyrSDK/set-zephyr-build-env

2. Enter the below in Terminal to build the [tmo_shell](/documentation-hub/iot-developer-kit/interacting-with-the-kit-at-cli-via-tmo-shell) sample.

    west build $HOME/zephyrproject/DevEdge-IoTDevKit-ZephyrSDK/samples/tmo_shell -p -b tmo_dev_edge

3. Flash the tmo_shell sample onto the kit.

    west flash

4. If the flash occurred successfully you should see, in your serial app, your kit going through a series of system checks then finally arrive at the following screenshot. ![](https://devedge.t-mobile.com/uploads/ubuntu_west_flash_finish_ebb5594151.png?updated_at=2023-01-12T21:27:22.167Z) 5. Press **_Return_** on your keyboard to get to the uart command line. ![](https://devedge.t-mobile.com/uploads/ubuntu_west_flash_uart_d4078e9625.png?updated_at=2023-01-12T21:27:21.868Z) 6. Enter `tmo version` to see the version of your SDK. It should be upgraded to tmz-1.19.1-qa. 7. Update the code found in the $HOME/zephyrproject/DevEdge-IoTDevKit-ZephyrSDK/samples/tmo_shell folder to create whatever project you desire. To understand what the various files in the **tmo_shell** folder do, please see the [Description of tmo_shell Source Files](/documentation-hub/iot-developer-kit/developer-environment-setup/description-of-tmo-shell-source-files) document. ![](https://devedge.t-mobile.com/uploads/ubuntu_tmo_shell_folder_1753e61c1c.png?updated_at=2023-01-12T21:27:17.677Z) 8. An example of a source file update is setting the SSID and PSK for Wi-Fi. 1. Open the $HOME/zephyrproject/DevEdge-IoTDevKit-ZephyrSDK/samples/tmo_shell/prj.conf in your IDE. 2. Find the `CONFIG_TMO_SHELL_SSID` and `CONFIG_TMO_SHELL_PSK` variables. 3. Set the arguments to your Wi-Fi SSID and PSK then save the file. ![](https://devedge.t-mobile.com/uploads/ubuntu_visual_studio_code_wi_fi_set_dd5aadfd5e.png?updated_at=2023-01-12T21:27:22.466Z) 4. Open your Terminal app, change directories to zephyrproject, then set your build environment.

        cd ~/zephryproject
        source DevEdge-IoTDevKit-ZephyrSDK/set-zephyr-build-env

5. Build the tmo_shell sample.

        west build $HOME/zephyrproject/DevEdge-IoTDevKit-ZephyrSDK/samples/tmo_shell -p -b tmo_dev_edge

6. Flash the sample onto the kit.

        west flash

7. In your serial app, your kit goes through a series of system checks then finally arrives at the following screenshot. Press **_Return_** on your keyboard to get to the uart command line. ![](https://devedge.t-mobile.com/uploads/ubuntu_west_flash_uart_d4078e9625.png?updated_at=2023-01-12T21:27:21.868Z) 8. Enter `tmo wifi status 2`. Instead of having to enter `tmo wifi connect 2 "" 0 ""` you'll notice that you are already connected to Wi-Fi automatically. ![](https://devedge.t-mobile.com/uploads/ubuntu_picocom_wifi_status_connected_33786ff464.png?updated_at=2023-01-12T21:27:22.467Z) 9. Update any other source files you desire. 10. Flash the board again with your changes.

        west flash

11. Test that your tmo_shell project works. ## Troubleshooting - **Issue** - I cannot get my "Hello World" project to work on the IoT Developer Kit. What could be the problem? - **Suggested Solution** - Try doing another `west update` in the the ~/zephyrproject folder then flashing the board again.
- **Issue** - When I try and flash the kit, I get a "required program JLinkExe not found; install it or add its location to PATH" error. - **Suggested Solution** - Install the SEGGER J-Link software found [here](https://www.segger.com/downloads/jlink/). ![](https://devedge.t-mobile.com/uploads/ubuntu_jlink_error_87591f4750.png?updated_at=2023-01-12T23:06:47.117Z)
- **Issue** - I do not know what my USB ports are my named on my Linux OS computer. How can I find the names? - **Suggested Solution** - Try entering `sudo dmesg | grep tty` in Terminal. ![](https://devedge.t-mobile.com/uploads/ubuntu_find_usb_933438eb5d.png?updated_at=2023-01-12T22:29:09.283Z) ## FAQ - **Question** - Will these instructions work on a Windows OS? - **Answer** - No these instructions will not. Please see the [Windows OS for Zephyr Development](/documentation-hub/iot-developer-kit/developer-environment-setup/windows-os-for-zephyr-development) doc for further details.
- **Question** - What do the different files in the $HOME/zephyrproject/DevEdge-IoTDevKit-ZephyrSDK/samples/tmo_shell folder do? - **Answer** - Please see the [Description of tmo_shell Source Files](/documentation-hub/iot-developer-kit/developer-environment-setup/description-of-tmo-shell-source-files) document to learn more.

Linux OS for Zephyr Development