mirror of https://github.com/espressif/openthread.git synced 2026-07-10 22:30:21 +00:00

Files

T

Esko Dijk 213745a81f [cli] provide default 'APP' log output implementation in CLI module (#12309 )

Refactors the example CLI app and the CLI module code to provide a
default implementation of the 'APP' log output option for any CLI
apps. This default is used when log output is configured to 'APP'
output and the CLI application itself does not provide its own
implementation of `otPlatLog()`.

This extends the current logging option (syslog) for the Posix app
ot-cli with the option to direct the log output to the CLI app, which
then prints it in stdout. This logging option can be enabled using the
existing -DOT_LOG_OUTPUT=APP. Previously, this gave a build error for
the Posix platform. This logging method is useful/required for running
NCPs in OTNS, such that the simulator can capture all log output and
at the same time syslog is not overly burdened on the host machine.

2026-01-21 12:30:29 -08:00

cli_uart.cpp

[build] add format-nonliteral to missed code (#12251 )

2026-01-06 14:53:38 -08:00

CMakeLists.txt

[cli] add cli-radio build (#6769 )

2021-09-18 09:51:35 -07:00

ftd.cmake

[examples] define OPENTHREAD_FTD and OPENTHREAD_MTD (#11516 )

2025-05-20 14:59:24 -07:00

main.c

[cli] provide default 'APP' log output implementation in CLI module (#12309 )

2026-01-21 12:30:29 -08:00

mtd.cmake

[examples] define OPENTHREAD_FTD and OPENTHREAD_MTD (#11516 )

2025-05-20 14:59:24 -07:00

radio.cmake

[examples] define OPENTHREAD_FTD and OPENTHREAD_MTD (#11516 )

2025-05-20 14:59:24 -07:00

README.md

[build] remove autotools (#9027 )

2023-06-28 08:54:23 -07:00

README.md

OpenThread CLI Example

This example application exposes OpenThread configuration and management APIs via a simple command-line interface. The steps below take you through the minimal steps required to ping one emulated Thread device from another emulated Thread device.

1. Build

$ cd <path-to-openthread>
$ ./script/cmake-build simulation

2. Start node 1

Spawn the process:

$ cd <path-to-openthread>/build/simulation/examples/apps/cli
$ ./ot-cli-ftd 1

Generate, view, and commit a new Active Operational Dataset:

> dataset init new
Done
> dataset
Active Timestamp: 1
Channel: 13
Channel Mask: 0x07fff800
Ext PAN ID: d63e8e3e495ebbc3
Mesh Local Prefix: fd3d:b50b:f96d:722d::/64
Network Key: dfd34f0f05cad978ec4e32b0413038ff
Network Name: OpenThread-8f28
PAN ID: 0x8f28
PSKc: c23a76e98f1a6483639b1ac1271e2e27
Security Policy: 0, onrc
Done
> dataset commit active
Done

Bring up the IPv6 interface:

> ifconfig up
Done

Start Thread protocol operation:

> thread start
Done

Wait a few seconds and verify that the device has become a Thread Leader:

> state
leader
Done

View IPv6 addresses assigned to Node 1's Thread interface:

> ipaddr
fd3d:b50b:f96d:722d:0:ff:fe00:fc00
fd3d:b50b:f96d:722d:0:ff:fe00:c00
fd3d:b50b:f96d:722d:7a73:bff6:9093:9117
fe80:0:0:0:6c41:9001:f3d6:4148
Done

2. Start node 2

Spawn the process:

$ cd <path-to-openthread>/build/simulation/examples/apps/cli
$ ./ot-cli-ftd 2

Configure Thread Network Key from Node 1's Active Operational Dataset:

> dataset networkkey dfd34f0f05cad978ec4e32b0413038ff
Done
> dataset commit active
Done

Bring up the IPv6 interface:

> ifconfig up
Done

Start Thread protocol operation:

> thread start
Done

Wait a few seconds and verify that the device has become a Thread Child or Router:

> state
child
Done

3. Ping Node 1 from Node 2

> ping fd3d:b50b:f96d:722d:7a73:bff6:9093:9117
16 bytes from fd3d:b50b:f96d:722d:558:f56b:d688:799: icmp_seq=1 hlim=64 time=24ms

4. Explore More

See the OpenThread CLI Reference README.md to explore more.