Panoramica dell'interfaccia a riga di comando di OpenThread

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Visualizza origine su GitHub

L'interfaccia a riga di comando di OpenThread espone le API di configurazione e gestione da un'interfaccia a riga di comando. Usa l'interfaccia a riga di comando OT per creare un ambiente di sviluppo OpenThread o come strumento con codice di applicazione aggiuntivo. Ad esempio, gli script di test di OpenThread utilizzano l'interfaccia a riga di comando per eseguire scenari di test.

Inizia

Completa il nostro codelab di simulazione con Docker ed esamina il riferimento al comando dell'interfaccia a riga di comando.

Vai al codelab sulla simulazione Vai al riferimento del comando dell'interfaccia a riga di comando

Utilizza l'interfaccia a riga di comando OT

Puoi utilizzare l'interfaccia a riga di comando OT con i dispositivi Thread BROT (OpenThread Border Router) e Thread. I comandi dell'interfaccia a riga di comando variano in base al tipo di dispositivo e ai flag della build.

OTBR

Per utilizzare l'interfaccia a riga di comando OT con OTBR, inserisci il seguente prefisso prima di ogni comando:

sudo ot-ctl

Dispositivi con conversazioni in thread

Per utilizzare i comandi dell'interfaccia a riga di comando su un dispositivo Thread, consulta la documentazione, il codelab o la guida della piattaforma. Per molti esempi, puoi iniziare a digitare i comandi senza un prefisso:

state
router
Done

Per iniziare, fai riferimento alle seguenti risorse:

Caratteri speciali

Il carattere spazio vuoto (' ') viene utilizzato per delimitare il nome del comando e i diversi argomenti, insieme alla scheda ('\t') e ai nuovi caratteri della riga ('\r', '\n').

Alcuni argomenti potrebbero includere spazi, ad esempio il nome di una rete Thread. Per inviare argomenti che includono spazi, utilizza la barra rovesciata ('\') per eseguire l'escape dei separatori o della barra rovesciata stessa:

networkname Test\ Network
Done
networkname
Test Network
Done

Mappature degli argomenti

L'interfaccia a riga di comando OT utilizza argomenti predefiniti che corrispondono ai valori di configurazione dell'API. Queste mappature possono essere passate con i comandi dell'interfaccia a riga di comando e potrebbero anche tornare alla console dell'interfaccia a riga di comando per vari comandi di dati di rete, ad esempio netdata show.

otBorderRouterConfig

Alcuni comandi, ad esempio prefix add, richiedono valori otBorderRouterConfig. Per impostare i membri otBorderRouterConfig dalla riga di comando, l'interfaccia a riga di comando OT analizza un argomento di lettera mappata per ogni membro. Ad esempio, la combinazione di argomenti paros imposta contemporaneamente i membri mFavorite, mSlaac, mDefaultRoute, mOnMesh e mStable.

Sintassi

Nel seguente esempio, è obbligatorio prefix e gli argomenti otBorderRouterConfig sono facoltativi e mappati come p, a, d, c, r, o, s, n e D:

prefix add prefix [padcrosnD]

Utilizzo

Per utilizzare le mappature degli argomenti, non inserire spazi tra le lettere:

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

Destinazione route

Per impostare otRoutePreference, utilizza high, med o low nei comandi dell'interfaccia a riga di comando OT.

Sintassi

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

Utilizzo

Ecco un esempio di utilizzo dei parametri otBorderRouterConfig e otRoutePreference mappati:

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

OtExternalRouteConfig

Per i valori otExternalRouteConfig, s viene mappato a mStable e n mappato a mNat64.

Sintassi

publish route prefix [sn]

Utilizzo

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

Valori restituiti

La maggior parte dei comandi restituisce il valore richiesto, seguito da Done:

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

Altri comandi che includono i dati di rete potrebbero restituire mappature di argomenti per prefissi, route e record di servizio. Per ulteriori informazioni, consulta Visualizzare e gestire i dati di rete con l'interfaccia a riga di comando OT.