1*cfb92d14SAndroid Build Coastguard Worker# `toranj` test framework 2*cfb92d14SAndroid Build Coastguard Worker 3*cfb92d14SAndroid Build Coastguard Worker`toranj` is a test framework for OpenThread. 4*cfb92d14SAndroid Build Coastguard Worker 5*cfb92d14SAndroid Build Coastguard WorkerIt provides two modes: 6*cfb92d14SAndroid Build Coastguard Worker 7*cfb92d14SAndroid Build Coastguard Worker- `toranj-cli` which enables testing of OpenThread using its CLI interface. 8*cfb92d14SAndroid Build Coastguard Worker- `toranj-ncp` which enables testing of the combined behavior of OpenThread (in NCP mode), spinel interface, and `wpantund` driver on linux. 9*cfb92d14SAndroid Build Coastguard Worker 10*cfb92d14SAndroid Build Coastguard Worker`toranj` features: 11*cfb92d14SAndroid Build Coastguard Worker 12*cfb92d14SAndroid Build Coastguard Worker- It is developed in Python. 13*cfb92d14SAndroid Build Coastguard Worker- It can be used to simulate multiple nodes forming complex network topologies. 14*cfb92d14SAndroid Build Coastguard Worker- It allows testing of network interactions between many nodes (IPv6 traffic exchanges). 15*cfb92d14SAndroid Build Coastguard Worker- `toranj` in NCP mode runs `wpantund` natively with OpenThread in NCP mode on simulation platform (real-time). 16*cfb92d14SAndroid Build Coastguard Worker- `toranj` in CLI mode runs `ot-cli-ftd` on simulation platform (real-time). 17*cfb92d14SAndroid Build Coastguard Worker- `toranj` tests run as part of GitHub Actions pull request validation in OpenThread and `wpantund` GitHub projects. 18*cfb92d14SAndroid Build Coastguard Worker 19*cfb92d14SAndroid Build Coastguard Worker## `toranj` modes 20*cfb92d14SAndroid Build Coastguard Worker 21*cfb92d14SAndroid Build Coastguard Worker- [`toranj-cli` guide](README_CLI.md) 22*cfb92d14SAndroid Build Coastguard Worker- [`toranj-ncp` guide](README_NCP.md) 23*cfb92d14SAndroid Build Coastguard Worker 24*cfb92d14SAndroid Build Coastguard Worker--- 25*cfb92d14SAndroid Build Coastguard Worker 26*cfb92d14SAndroid Build Coastguard WorkerWhat 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
){kind=link}