Présentation de la CLI OpenThread

Afficher le code source sur GitHub

La CLI OpenThread expose les API de configuration et de gestion à partir d'une interface de ligne de commande. Utilisez la CLI OT pour créer un environnement de développement OpenThread, ou utilisez-le comme outil avec du code d'application supplémentaire. Par exemple, les scripts de test d'OpenThread utilisent la CLI pour exécuter des scénarios de test.

Commencer

Suivez notre atelier de programmation sur la simulation avec Docker et consultez la documentation de référence sur les commandes de la CLI.

Accéder à l'atelier de programmation de simulation Accéder au document de référence sur les commandes de la CLI

Utiliser la CLI OT

Vous pouvez utiliser la CLI OTT avec les routeurs de bordure OpenThread (OTBR) et Thread. Les commandes CLI varient en fonction du type d'appareil et des indicateurs de compilation.

OTBR

Pour utiliser la CLI OT avec OTBR, saisissez le préfixe suivant avant chaque commande:

sudo ot-ctl

Appareils Thread

Pour utiliser les commandes CLI sur un appareil Thread, consultez la documentation, l'atelier de programmation ou le guide de la plate-forme. Pour de nombreux exemples, vous pouvez commencer à saisir des commandes sans préfixe:

state
router
Done

Voici quelques ressources pour vous aider à démarrer:

Caractères spéciaux

Le caractère d'espacement (' ') permet de délimiter le nom de la commande et les différents arguments, ainsi que la tabulation ('\t') et les sauts de ligne ('\r', '\n').

Certains arguments peuvent inclure des espaces, par exemple un nom de réseau Thread. Pour envoyer des arguments incluant des espaces, utilisez la barre oblique inverse ('\') pour échapper les séparateurs ou la barre oblique inverse:

networkname Test\ Network
Done
networkname
Test Network
Done

Mappages d'arguments

La CLI OT utilise des arguments prédéfinis qui correspondent aux valeurs de configuration de l'API. Ces mappages peuvent être transmis avec des commandes CLI et peuvent également être renvoyés à la console CLI pour diverses commandes de données réseau, par exemple netdata show.

OTBorderRouterConfig

Certaines commandes, par exemple prefix add, nécessitent des valeurs otBorderRouterConfig. Pour définir des membres otBorderRouterConfig à partir de la ligne de commande, la CLI OT: analyse un argument de lettre mappée pour chaque membre. Par exemple, la combinaison d'arguments paros définit les membres mPreferred, mSlaac, mDefaultRoute, mOnMesh et mStable respectivement.

Syntaxe

Dans l'exemple suivant, prefix est obligatoire et les arguments otBorderRouterConfig sont facultatifs, mappés en tant que p, a, d, c, r, o, s, n et D:

prefix add prefix [padcrosnD]

Utilisation

Pour utiliser des mappages d'arguments, ne saisissez pas d'espaces entre les lettres:

prefix add 2001:dead:beef:cafe::/64 paros

Préférence RouteRoute

Pour définir le paramètre otRoutePreference, utilisez high, med ou low dans les commandes de la CLI OT.

Syntaxe

prefix add prefix [padcrosnD] [high|med|low]

Utilisation

Voici un exemple d'utilisation des paramètres mappés otBorderRouterConfig et otRoutePreference:

prefix add 2001:dead:beef:cafe::/64 paros med
Done

OTExternalRouteConfig

Pour les valeurs otExternalRouteConfig, s correspond à mStable, et n correspond à mNat64.

Syntaxe

publish route prefix [sn]

Utilisation

route add 2001:dead:beef:cafe::/64 s
Done

Valeurs renvoyées

La plupart des commandes renvoient la valeur demandée, suivie de Done:

br onlinkprefix
fd41:2650:a6f5:0::/64
Done

D'autres commandes qui incluent des données réseau peuvent renvoyer des mappages d'arguments pour les enregistrements de préfixe, de route et de service. Pour en savoir plus, consultez la page Afficher et gérer des données réseau avec OT CLI.