Présentation de la CLI OpenThread

<ph type="x-smartling-placeholder"></ph> Consulter le code source sur GitHub

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

Commencer

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

Accéder à l'atelier de programmation sur la simulation Accéder à la documentation de référence des commandes CLI

Utiliser la CLI OT

Vous pouvez utiliser la CLI OT avec le routeur de bordure OpenThread (OTBR) et les appareils Thread. CLI varient en fonction de votre type d'appareil et des indicateurs de compilation.

RDP

Pour utiliser la CLI OT avec OTBR, saisissez ce qui suit : avant chaque commande:

sudo ot-ctl

Appareils Thread

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

state
router
Done

Voici quelques ressources pour vous aider à démarrer:

Caractères spéciaux

L'espace blanc (' ') permet de délimiter le nom de la commande et la arguments différents, 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. À envoyez des arguments incluant des espaces, utilisez la barre oblique inverse ('\') pour échappement ou la barre oblique inverse elle-même:

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 les mappages peuvent être transmis à l'aide de commandes CLI et peuvent également être renvoyés à la CLI console pour diverses commandes de données réseau, par exemple netdata show.

otBorderRouterConfig

Certaines commandes, comme prefix add, nécessitent otBorderRouterConfig valeurs. Pour définir des membres otBorderRouterConfig à partir de la ligne de commande, OT CLI analyse un argument de lettre mappé pour chaque membre. Par exemple, l'argument la combinaison paros définit mPreferred, mSlaac mDefaultRoute, mOnMesh, et mStable plusieurs membres de façon consécutive.

Syntaxe

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

prefix add prefix [padcrosnD]

Utilisation

Pour utiliser le mappage d'arguments, ne saisissez pas d'espaces entre les lettres:

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

otRoutePreference

Pour définir otRoutePreference, procédez comme suit : 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 de otBorderRouterConfig et otRoutePreference mappés paramètres:

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

otExternalRouteConfig

Pour otExternalRouteConfig , s correspond à mStable et n à 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 Display and Manage Network Data with OT CLI :