Visão geral da CLI OpenThread

Veja o código-fonte no GitHub

A CLI do OpenThread expõe APIs de configuração e gerenciamento em uma interface de linha de comando. Use a CLI OT para criar um ambiente de desenvolvimento do OpenThread ou use-o como uma ferramenta com outro código de aplicativo. Por exemplo, os scripts de teste do OpenThread usam a CLI para executar casos de teste.

Começar

Concluir o codelab de simulação com o Docker e consultar a referência do comando da CLI.

Acessar o codelab de simulação.Acessar a referência do comando da CLI

Usar a CLI OT

É possível usar a CLI OT com o OpenThread Border Router (OTBR) e dispositivos Thread. Os comandos da CLI variam de acordo com o tipo de dispositivo e as sinalizações de build.

OTBR

Para usar a CLI de OT com OTBR, insira o seguinte prefixo antes de cada comando:

sudo ot-ctl

Dispositivos da linha de execução

Para usar os comandos da CLI em um dispositivo Thread, consulte a documentação, o codelab ou o guia da plataforma. Para muitos exemplos, é possível começar a digitar comandos sem um prefixo:

state
router
Done

Veja alguns recursos para ajudar você a começar:

Caracteres especiais

O caractere de espaço em branco (' ') é usado para delimitar o nome do comando e os argumentos diferentes com a guia ('\t') e novos caracteres de linha ('\r', '\n').

Alguns argumentos podem incluir espaços, por exemplo, um nome de rede Thread. Para enviar argumentos que incluam espaços, use o caractere de barra invertida ('\') para fazer o escape de separadores ou da própria barra invertida:

networkname Test\ Network
Done
networkname
Test Network
Done

Mapeamentos de argumentos

A CLI OT usa argumentos predefinidos que correspondem aos valores de configuração da API. Esses mapeamentos podem ser transmitidos com comandos da CLI e também podem retornar ao console da CLI para vários comandos de dados de rede, por exemplo, netdata show.

OtBorderRouterConfig

Alguns comandos, como prefix add, exigem valores otBorderRouterConfig. Para definir membros otBorderRouterConfig na linha de comando, a CLI de OT analisa um argumento de letra mapeado para cada membro. Por exemplo, a combinação de argumentos paros define os membros mpreferred, mSlaac, mDefaultRoute, mOnMesh e mStable consecutivamente.

Sintaxe

No exemplo a seguir, prefix é obrigatório, e os argumentos otBorderRouterConfig são opcionais, mapeados como p, a, d, c, r, o, s, n e D:

prefix add prefix [padcrosnD]

Uso

Para usar mapeamentos de argumentos, não insira espaços entre as letras:

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

Preferência de rota

Para definir o otRoutePreference, use high, med ou low nos comandos da CLI de OT.

Sintaxe

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

Uso

Veja um exemplo de como usar os parâmetros otBorderRouterConfig e otRoutePreference mapeados:

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

otExternalRouteConfig

Para valores de otExternalRouteConfig, s é mapeado para mStable e n é mapeado para mNat64.

Sintaxe

publish route prefix [sn]

Uso

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

Valores de retorno

A maioria dos comandos retorna o valor solicitado, seguido de Done:

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

Outros comandos que incluem dados de rede podem retornar mapeamentos de argumentos para registros de prefixo, rota e serviço. Para mais informações, consulte Exibir e gerenciar dados de rede com a CLI de OT.