xref: /aosp_15_r20/external/openthread/tests/toranj/README.md (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1# `toranj` test framework
2
3`toranj` is a test framework for OpenThread.
4
5It provides two modes:
6
7- `toranj-cli` which enables testing of OpenThread using its CLI interface.
8- `toranj-ncp` which enables testing of the combined behavior of OpenThread (in NCP mode), spinel interface, and `wpantund` driver on linux.
9
10`toranj` features:
11
12- It is developed in Python.
13- It can be used to simulate multiple nodes forming complex network topologies.
14- It allows testing of network interactions between many nodes (IPv6 traffic exchanges).
15- `toranj` in NCP mode runs `wpantund` natively with OpenThread in NCP mode on simulation platform (real-time).
16- `toranj` in CLI mode runs `ot-cli-ftd` on simulation platform (real-time).
17- `toranj` tests run as part of GitHub Actions pull request validation in OpenThread and `wpantund` GitHub projects.
18
19## `toranj` modes
20
21- [`toranj-cli` guide](README_CLI.md)
22- [`toranj-ncp` guide](README_NCP.md)
23
24---
25
26What does `"toranj"` mean? it's the name of a common symmetric weaving [pattern](https://en.wikipedia.org/wiki/Persian_carpet#/media/File:Toranj_-_special_circular_design_of_Iranian_carpets.JPG) used in Persian carpets.
27