## Introduction This document guides the reader on how to interact with the IoT Developer Kit at command line. ## Prerequisites * The [T-Mobile DevEdge IoT Developer Kit](https://devedge.t-mobile.com/solutions/iot-developer-kit). * A computer with Windows 10 or later installed * [Git](https://git-scm.com/downloads) installed installed on your computer * Internet access * [Tera Term](https://ttssh2.osdn.jp/index.html.en) installed on your computer

For demonstration purposes we will be using Tera Term in the rest of this document. Windows 10 is the operating system that Tera Term is installed on. Using a different serial app, however, on a different OS is perfectly acceptable.

## Interacting with the Kit at CLI via the tmo\_shell ### What is the tmo\_shell? The tmo\_shell is T-Mobile's general-purpose interactive app for testing many features on the DevEdge IoT Developer Kit. It is an application based on the Zephyr RTOS. Note that the tmo\_shell is already installed on the DevEdge IoT Developer Kit. ### Where can I find the code for the tmo\_shell? You can find the code for the tmo\_shell at [https://github.com/tmobile/DevEdge-IoTDevKit-ZephyrSDK](https://github.com/tmobile/DevEdge-IoTDevKit-ZephyrSDK) . ### How do I connect to the tmo\_shell? 1. On a computer with several USB-A ports, install a serial app (e.g. [Tera Term](https://ttssh2.osdn.jp/index.html.en) on Windows, 'screen' or Picocom on Linux). You will need this app to communicate with the serial ports on the T-Mobile DevEdge IoT Developer Kit. 2. Connect your IoT Developer Kit to your computer like in the screenshot below. ![](https://devedge.t-mobile.com/uploads/iot_dev_kit_how_to_connect_3e7f450c51.png) 3. On your computer, open the Tera Term app. The _Tera Term: New Connection_ window opens. 4. Select the "Serial" radio button then from the drop down select the port that your T-Mobile DevEdge IoT Developer Kit is connected to. Click _**OK**_. ![](https://devedge.t-mobile.com/uploads/10_05_2022_13_44_3279794910.png) 5. Under **Setup** > **Serial port...** the settings for the kit's port need to be assigned the following way or you will not be able to connect to the kit: 1. Speed / Baud Rate: 9600 2. Data: 8 3. Parity: none 4. Stop bits: 1 5. Flow control: none 6. Click _**New setting**_ if you had to change any of these values. _**Cancel**_ if you did not. The Tera Term command line appears. ![](https://devedge.t-mobile.com/uploads/image2022_7_13_15_48_26_3fc4be846c.png) 6. In the Tera Term command line console press _**Enter**_ on your keyboard. The Zephyr `uart` command line appears. ![](https://devedge.t-mobile.com/uploads/05_10_2022_12_43_2_2fde5125e2.png) ![](https://devedge.t-mobile.com/uploads/05_10_2022_12_43_e9fd5fced2.png) 7. Type `tmo`. This will display all of the commands available in the tmo\_shell. ![](https://devedge.t-mobile.com/uploads/10_05_2022_12_38_d34c1faa3f.png) 8. Below is a list of things you may want to do at CLI. ## What are some things I would want to do at tmo\_shell CLI? ### Connect to Wi-Fi 1. Enter `tmo ifaces` in Tera Term. Based on the [Data Sheet](/documentation-hub/iot-developer-kit/data-sheet), the murata.1sc is the LTE CAT-M1/NB1 cellular modemand the RS9116W is the Wi-Fi/BLE radio device. ![](https://devedge.t-mobile.com/uploads/05_10_2022_17_28_0b47a7e48a.png) 2. Scan for available networks by running `tmo wifi scan `. ![](https://devedge.t-mobile.com/uploads/05_10_2022_17_42_753caf265b.png) 3. Connect to a network by running `tmo wifi connect 2 "" 0 "" or tmo wifi connect ""` if your network lacks a password: 4. If the connection is successful you should receive a "Connected" response. 5. Check the status of the Wi-Fi connection by entering `tmo wifi status `. ![](https://devedge.t-mobile.com/uploads/10_24_2022_13_45_d5e96a9be5.png) You can also see that you are connected to your chosen Wi-Fi by looking at your smartphone > **DevEdge IoT** companion app > **Home** > **Connectivity** section.

### Testing TCP connect/send/recv/close 1. Create a TCP socket by calling `tmo tcp create ` .

For this to work, you must be connected to Wi-Fi. The error "Socket creation failed, errno = 0" indicates that you are not connected to Wi-Fi and, as a result, the TCP socket cannot be created.

![](https://devedge.t-mobile.com/uploads/05_11_2022_14_15_b47381efe3.png) 2. If the socket is created properly a will appear. In the case of the screenshot below the socket number is 0. ![](https://devedge.t-mobile.com/uploads/05_11_2022_16_35_f639a240ec.png) 3. To list all open sockets type `tmo sockets`. ![](https://devedge.t-mobile.com/uploads/05_11_2022_16_35_2_2b57fd15de.png) 4. Connect the socket to a server by calling `tmo tcp connect `:

You will need an echo server IP address in order to complete this part of the exercise.

![](https://devedge.t-mobile.com/uploads/image2022_5_11_16_42_16_d1160c9be3.png) The message "Connected socket 0" appears if the call was made successfully. ![](https://devedge.t-mobile.com/uploads/image2022_5_11_16_46_3_6c0819996d.png) 5. Send data by calling `tmo tcp send ""`. When you hit _**Enter**_ on your keyboard Tera Term will simple go back to the [uart](https://docs.zephyrproject.org/3.0.0/reference/peripherals/uart.html) prompt. ![](https://devedge.t-mobile.com/uploads/image2022_5_11_16_47_23_b2c6cc081d.png) 6. To see the data you just sent, call `tmo tcp recv `. ![](https://devedge.t-mobile.com/uploads/image2022_5_11_16_48_11_00a9e2e024.png) ![](https://devedge.t-mobile.com/uploads/image2022_5_11_17_26_37_c0f40296a6.png) 7. Close the socket by calling `tmo tcp close `. ![](https://devedge.t-mobile.com/uploads/image2022_5_11_17_28_22_4c3094198d.png) ### Testing UDP connect/send/recv/close 1. Create a UDP socket by calling `tmo udp create ` .

For this to work, you must be connected to Wi-Fi. The error "Socket creation failed, errno = 0" indicates that you are not connected to Wi-Fi and, as a result, the UDP socket cannot be created.

2. If the socket is created properly a will appear. In the case of the screenshot below the socket number is 0. 3. Connect the socket to a server by calling `tmo udp connect `.

You will need an echo server IP address in order to complete this part of the exercise.

4. The message "Connected socket 0" appears if the call was made successfully. 5. Send data by calling `tmo udp send ""`. 6. Receive data by calling `tmo udp recv `. 7. Close the socket by calling `tmo udp close `. ![](https://devedge.t-mobile.com/uploads/05_12_2022_10_35_fd7c10c815.png) 8. To check that the socket is closed type `tmo sockets`. ### Testing UDP sendto/recvfrom 1. Create a UDP socket by calling `tmo udp create ` .

For this to work, you must be connected to Wi-Fi. The error "Socket creation failed, errno = 0" indicates that you are not connected to Wi-Fi and, as a result, the UDP socket cannot be created.

2. If the socket is created properly a will appear. In the case of the screenshot below the socket number is 0. 3. Send data to by calling `tmo udp sendto ""`.

You will need an echo server IP address in order to complete this part of the exercise.

4. Receive data by calling `tmo udp recvfrom `. 5. Close the socket by calling `tmo udp close `. ![](https://devedge.t-mobile.com/uploads/05_12_2022_11_37_b6b5c25d0c.png) ### Testing SMS send message 1. Enter `modem list`. 2. Enter `modem sms send ""` . ![](https://devedge.t-mobile.com/uploads/05_12_2022_12_56_cd1505c40c.png)

Remember to replace 5555555555 with your cell phone number. In addition, spaces are not allowed in the message. If there are, please use quotes (single or double) around the message.

3. Check you phone for a text message from your IoT Developer Kit. ### Testing SMS receive message Send an SMS from your phone back to the device then receive it on the device with this command. 1. Enter `modem sms recv 0 10`. ![](https://devedge.t-mobile.com/uploads/10_10_2022_10_28_8ab6e115b6.png) ### Testing DNS Resolution To perform DNS resolve, use the syntax shown below.

For this to work, you must be connected to Wi-Fi. The error "zsock\_getaddrinfo failed (-2)" indicates that you are not connected to Wi-Fi and, as a result, the DNS call will fail.

1. Enter `tmo ifaces` . 2. Enter `tmo dns t-mobile.com`. 3. The IoT Developer Kit returns address information, IP address and more. ![](https://devedge.t-mobile.com/uploads/05_12_2022_13_14_f8e9dddc5f.png) ### Testing BLE SMP Pairing

Some things to note:

For Bluetooth Low Energy (BLE) features you need a BLE monitoring app. T-Mobile recommends the LightBlue app.
For Secure Manager Protocol (SMP) pairing, you may need to unpair the kit from the smartphone to test pairing again. This can be done in your smartphone's Bluetooth settings.

To enable SMP pairing enter `tmo ble smp enable`. After SMP is enabled if you try and pair your _DevEdge IoT_ companion app to your IoT Developer Kit a "Connected (random)" appears. A passkey appears as well. Enter this passkey in your smartphone's _DevEdge IoT_ companion app. ![](https://devedge.t-mobile.com/uploads/10_06_2022_16_22_aa067563e9.png) The result on your smartphone looks like the below. Again, enter this passkey in your companion app.

To disable SMP pairing enter `tmo ble smp disable` . To choose the pairing verification methodology, simply enable the relevant IO capabilities using the `tmo ble smp toggle`and `tmo ble smp callbacks` commands. For example, to test key entry on a device enable only keyboard enter the following at CLI:

uart:~$ tmo ble smp enable
SMP Enabled.
uart:~$ tmo ble smp callbacks
CONFIRM: disabled
DISPLAY: enabled
KEYBOARD: disabled
uart:~$ tmo ble smp toggle display
Display is now disabled
uart:~$ tmo ble smp toggle keyboard
Keyboard is now enabled
uart:~$ tmo ble smp callbacks
CONFIRM: disabled
DISPLAY: disabled
KEYBOARD: enabled
uart:~$

### Find the IMEI 1. Enter `tmo ifaces`. Based on the [Data Sheet](/documentation-hub/iot-developer-kit/data-sheet), the murata.1sc is the LTE CAT-M1/NB1 cellular modem and the RS9116W is the Wi-Fi/BLE radio device. 2. Enter `tmo modem`. 3. Enter `tmo modem 1 imei`. 4. The IMEI for your IoT Developer Kit appears. ![](https://devedge.t-mobile.com/uploads/10_05_2022_15_39_4bd76e3820.png) ### View JSON Data 1. Enter `tmo json payload` then press _**Enter**_ on your keyboard. ![](https://devedge.t-mobile.com/uploads/06_23_2022_13_27_c716ad647b.png) ### Turn on the Green LED

This command is utilizing the Zephyr shell instead of the tmo_shell. Please see the document API Sample Requests to learn more.

1. Enter `led on pwmleds 2`. ![](https://devedge.t-mobile.com/uploads/07_15_2022_08_49_6d8c76c407.png) 2. The green light on the IoT Developer Kit turns on. ![](https://devedge.t-mobile.com/uploads/image2022_7_18_14_49_57_1d5e1f6c29.png) ### Find the tmo\_shell / SDK Version Number 1. Type `tmo version` then press _**Enter**_ on your keyboard. ![](https://devedge.t-mobile.com/uploads/10_05_2022_15_45_ebe7944960.png) ## Further Resources Beyond the list above, there are other commands available at tmo\_shell. Take a look at the table below. ### tmo\_shell Commands

Commands	Command Description	Subcommands	Subcommand Descriptions	Required Arguments	Example Syntax
`battery`	Battery and charger status.	charger discharge percent voltage	Get charger status. Discharge battery for shipping. Get battery level (percent) Get battery level (volts)	Not applicable.	`tmo battery charger` `tmo battery discharge` `tmo battery percent` `tmo battery voltage`
`ble`	Various Bluetooth Low Energy (BLE) commands.	smp enable disable callbacks toggle respond adv conn eddystone ibeacon rssi	BLE SMP Controls Enable Security Manager Protocol (SMP) Disable Security Manager Protocol (SMP) Show enabled callbacks. Toggle call backs. Send response. BLE advertisement test controls Advertise as connectable Advertise as eddystone beacon Advertise as ibeacon BLE peripheral RSSI read		`tmo ble adv ibeacon`
`buzzer`	Buzzer test.	jingle ramp tone vol	Play TMO jingle Play ramp tune Play a tone for a time Set buzzer volume	Not applicable. Not applicable. <freq in Hz> <time in msecs> <volume percent>	`tmo buzzer jingle` `tmo buzzer ramp` `tmo buzzer tone <freq in Hz> <time in msecs>` `tmo buzzer vol 45`
`certs`	CA cert commands. Load, list, or dump certificates of authority on to your kit.	dld info list load modem_load	Download certificates. Print certificates. List certificates. Load certificates. Send loaded certificate to modem.		`tmo certs dld <devid> <URL>` `tmo certs info` `tmo certs list` `tmo certs load <indexid>` `tmo certs load <modem_load>`
`dfu`	Device firmware (FW) updates.	auth_key base_url download iface settings update version	Set firmware download auth key. Set firmware download base URL. Download firmware. Set firmware download iface. Print DFU settings. Update firmware. Get current firmware version.	<iface>	`tmo dfu version 1` `tmo dfu update 2 0` `tmo dfu download 2`
`dns`	Performs a DNS lookup.	None	Not applicable	<devid> <hostname>	`tmo dns 2 t-mobile.com`
`file`	File commands.	cp ll mv sha1	Copy a file. Detailed file list. Move a file. Compute a file SHA1.		`tmo file cp <source file> <destination file>` `tmo file ll <folder>`
`gnssversion`	Displays the GNSS / GPS device's firmware version number.	None	Not applicable	Not applicable	`tmo gnssversion`
`http`	Get http URL.	None	Not applicable	<devid> <URL>	`tmo http 2 http://www.t-mobile.com`
`hwid`	Read the HWID divider voltage.	None	Not applicable		`tmo hwid`
`ifaces`	List all the interfaces available on the kit with their ID number.	None	Not applicable	Not applicable.	`tmo ifaces`
`json`	JSON data options. This set of commands allows the user to send JSON data to a particular base URL and path (endpoint). It also allows for the printing of the JSON payload at CLI.	base_url disable enable iface path payload settings	Set JSON base URL. Disable JSON transmission. Enable JSON transmission. Set JSON iface. Set JSON path part of URL. Print JSON data. Print JSON settings to understand what base URL, path, and interface is being used in the JSON post.	<iface>	`tmo json base_url https://devkit.devedge.t-mobile.com` `tmo json disable` `tmo json enable` `tmo json iface 2` `tmo json path /device/12345678` `tmo json payload` `tmo json settings`
`kermit`	Embedded kermit.	-r -s <file> -p -b [12345] -k -B -T -R -L -h	Receive files Send files Parity: none, even, odd, mark, space Block check type: 1, 2, 3, or 5 Keep incompletely received files Force binary mode Force text mode Remote mode (vs local) Local mode (vs remote) Help (this message)		`tmo kermit -r` `tmo kermit -s /tmo/test.txt`
`location`	Get latitude, longitude, Sats, HDOP, TTFF, and 1PPS data.	None	Not applicable.	Not applicable.	`tmo location`
`modem`	Modem status and control.	None	Not applicable	<iface> <cmd_str> `cmd_str` has the following available arguments: <apn> <awake> <conn_sts> <edrx> <golden> <iccid> <imei> <imsi> <ip> <ip6> <msisdn> <psm> <ptw> <sim> <sleep> <ssi> <version> <wake>	`tmo modem 1 imei`
`ping`	Test and verify if a particular destination IP address exists.	-c -s -t	Defines the ping's count. Defines the ping's packet size. Defines the ping's timeout.	`<iface>`	`tmo ping [-c count] [-s packetsize] [-t timeout] 2 t-mobile.com`
pm	Device power management controls.	get lock off on resume suspend unlock	Get a device's power management state Lock a device's power management state Put a device into the off/unpowered state Put a device into the on/powered state Resume a device into the suspended state Put a device into the suspended state Unlock a device's power management state	Use the command `device list` to obtain the name of the device you wish to learn more about or type `tmo pm get`. Examples of device names include: murata_1sc rs9116w@0 pwmleds sonycxd5605@24 tsl2540@39	`tmo pm get murata_1sc` `tmo pm lock rs9116w@0` `tmo pm off sonycxd5605@24`
`sntp`	Synchronize your kit's system time with a server of your choice.	None	Not applicable	Not applicable	`tmo sntp <iface> <server>`
`sockets`	Lists all the open sockets available on the kit.	None	Not applicable	Not applicable	`tmo sockets`
`sys_pm`	System power management controls.	active fulloff idle off standby suspend	Put system into the active state Put system into the off state (without RTCC) Put system into an idle state Put system into the off state (retaining RTCC) Put system into the standby state Put system into the suspend state	Not applicable	`tmo sys_pm active` `tmo sys_pm fulloff` `tmo sys_pm idle` `tmo sys_pm off` `tmo sys_pm standby` `tmo sys_pm suspend`
`tcp`	Send/receive TCP packets.	close connect create recv recb recvsms secure_create send sendb sendsms xfersz	Close a TCP socket. Connect to another TCP. Create secure TCP packets. Receive TCP packets. Receive larger TCP packets, up to 5000 KB. Receive text message. Create a secure TCP socket. Send TCP packets. Send larger TCP packets, up to 5000 KB. Send text message. ???	<socket> <socket><ip><port> <iface> <socket> <socket> <size> <socket> <wait time (seconds)> <iface> <socket> <payload> <socket><size> <socket><phone number><message> [size]	`tmo tcp create <iface_id>`
`test`	Run automated tests.	mfg qa	Manufacturing Quality Assurance	Not applicable.	`tmo test mfg`
`udp`	Send/receive UDP packets.	cert ca close connect create key profile secure_create recv recvb recvfrom recvsms send sendb sendsms sendto xfersz	Create or delete a DTLS credential for a UDP socket. Create or delete a DTLS certificate of authority for a UDP socket. Close UDP socket. Connect to another UDP. Create UDP packets. Create or delete a DTLS credential key for a UDP socket. Create or delete a certificate profile for a UDP socket. Create a secure UDP socket. Receive UDP packets. Receive large UDP packets, up to 5000 KB. Receive UDP packets from a sender. Receive text message. Send UDP packets. Send UDP packets to a specific port. Send large UDP packets, up to 5000 KB. Send text message. ???	<w or d> <socket> <w or d> <socket> <socket> <socket> <ip> <port> <iface> <w or d> <socket> <a or d> <socket> <iface> <socket> <socket> <size> <socket> <ip> <port> <socket> <wait time (seconds)> <socket payload> <socket> <size> <socket> <phone number> <message> <socket> <ip> <port> <payload> <size>	`tmo udp connect <socket_number> <ip_addr> <port>`
`version`	Print the version details for the tmo_shell. Use this command to understand what version of the tmo_shell your IoT Developer Kit is on.	None	Not applicable.	Not applicable.	`tmo version`
`wifi`	Wi-Fi controls. Connect to Wi-Fi using these commands.	connect disconnect mac scan status	Connect to Wi-Fi. Disconnect from Wi-Fi. Obtain the media access control address for an interface. Scan for Wi-Fi SSIDs. Check the Wi-Fi status of an interface.	<iface> "<SSID>" <channel number (optional), 0 mean all><PSK (optional: valid only for secured SSIDs)> <iface> <iface> <iface> <iface>	`tmo wifi scan <iface_id>` `tmo wifi connect <iface_id> "<SSID>" 0 "<PSK>"` `tmo wifi mac 2`

### tmo\_shell Glossary | Term | Definition | | --- | --- | | FTDI | An acronym for **F**uture **T**echnology **D**evices **I**nternational. | | HDOP | An acronym for the phrase "**H**orizontal **D**ilution **O**f **P**recision". Please read [this Wikipedia article](https://en.wikipedia.org/wiki/Dilution_of_precision_(navigation)) to learn more about this GNSS data value. | | <iface> | Interface ID. | | <payload> | The data to be sent. | | <psk> | Password for your SSID or Wi-Fi network. | | <port> | Port number. | | <socket> | Socket ID. | | <SSID> | A wireless local area network identifier. | | TTFF | An acronym for the phrase "**T**ime **T**o **F**irst **F**ix". Please read [this Wikipedia article](https://en.wikipedia.org/wiki/Time_to_first_fix) to learn more about this GNSS data value. | ## Troubleshooting * **Issue** - I cannot connect to my IoT Developer Kit via serial app? What am I doing wrong? * **Suggested solution** - Please check to ensure that the **J-Link USB-C Debug** port is plugged into your computer like in the picture below. If it is plugged in any other way you will not be able to connect your serial port to your kit. ![](https://devedge.t-mobile.com/uploads/iot_dev_kit_how_to_connect_3e7f450c51.png) ## FAQ * **Question** - What API calls can I make to the sensors via CLI? * **Answer** - Please read the [API Sample Requests](/documentation-hub/iot-developer-kit/api-sample-requests) document to learn more.
* **Question** - What format is the resulting sensor data in? * **Answer** - JSON
* **Question** - Why am I seeing a "Disconnected from 01:23:45:67:89:01 (random) (reason 0x13)" message in Tera Term / my serial app? What is the caused from? * **Answer** - When you disconnect the Bluetooth _DevEdge IoT_ mobile app from the DevEdge IoT Developer Kit, the above message is what appears in your serial app. * In your mobile app:

* In your serial app: ![](https://devedge.t-mobile.com/uploads/06_23_2022_16_38_1_5634fba963.png)
* **Question** - Why am I seeing a "Connected 01:23:45:67:89:01 (random)" message in Tera Term / my serial app? * **Answer** - In the mobile app, when you tap the _T-Mobile DevEdge_ device, the bluetooth connection creates this message. * In your mobile app: ![](https://devedge.t-mobile.com/uploads/2022_10_10_09_12_22_c4cf64a645.png) * In your serial app: ![](https://devedge.t-mobile.com/uploads/06_23_2022_16_41_778d90dd47.png)
* **Question** - When using the command `tmo wifi connect 2 "" 0 ""` I get the following error: "Connection request failed (8)". What does this mean? * **Answer** - Your password is not being accepting by the Wi-Fi connection. Re-check your password and try again.

Interacting with the Kit at CLI via tmo_shell

Was this article helpful?