Посмотреть исходный код на GitHub
Интерфейс командной строки OpenThread предоставляет API-интерфейсы для настройки и управления из интерфейса командной строки. Используйте OT CLI для создания среды разработки OpenThread или используйте ее как инструмент с дополнительным кодом приложения. Например, тестовые сценарии OpenThread используют CLI для выполнения тестовых случаев.
Начать
Завершите нашу лабораторию Simulation Codelab с Docker и просмотрите Справочник по командам CLI.
Перейти к Simulation Codelab Перейти к Справочнику по командам CLI
Используйте интерфейс командной строки ОТ
Вы можете использовать интерфейс командной строки OT с пограничным маршрутизатором OpenThread (OTBR) и устройствами Thread. Команды CLI будут различаться в зависимости от типа вашего устройства и флагов сборки.
ОТБР
Чтобы использовать OT CLI с OTBR , введите следующий префикс перед каждой командой:
sudo ot-ctl
Потоковые устройства
Чтобы использовать команды CLI на устройстве Thread, обратитесь к документации по платформе, кодовой лаборатории или руководству. Во многих примерах вы можете начать вводить команды без префикса:
state
router
Done
Вот несколько ресурсов, которые помогут вам начать работу:
- Обзор платформ OpenThread
- Nordic Hardware Codelab
- Аппаратное обеспечение Silicon Labs Codelab
- Примеры платформ на GitHub
Специальные символы
Символ пробела ( ' '
) используется для разделения имени команды и различных аргументов вместе с табуляцией ( '\t'
) и символами новой строки ( '\r'
, '\n'
).
Некоторые аргументы могут включать пробелы, например сетевое имя потока. Чтобы отправить аргументы, включающие пробелы, используйте символ обратной косой черты ( '\'
), чтобы экранировать разделители или саму обратную косую черту:
networkname Test\ Network
Donenetworkname
Test Network Done
Сопоставления аргументов
OT CLI использует предопределенные аргументы, соответствующие значениям конфигурации API. Эти сопоставления могут передаваться с помощью команд CLI, а также могут возвращаться в консоль CLI для различных команд Network Data, например netdata show .
отбордерроутерконфиг
Некоторые команды, например prefix add
, требуют значений otBorderRouterConfig . Чтобы задать otBorderRouterConfig
из командной строки, интерфейс командной строки OT анализирует сопоставленный буквенный аргумент для каждого члена. Например, комбинация аргументов paros
устанавливает элементы mPreferred , mSlaac , mDefaultRoute , mOnMesh и mStable .
Синтаксис
В следующем примере требуется prefix
, а аргументы otBorderRouterConfig необязательны и отображаются как p
, a
, d
, c
, r
, o
, s
, n
и D
:
prefix add prefix [padcrosnD]
Применение
Чтобы использовать сопоставления аргументов, не вводите пробелы между буквами:
prefix add 2001:dead:beef:cafe::/64 paros
otRoutePreference
Чтобы установить otRoutePreference , используйте high
, med
или low
в командах OT CLI.
Синтаксис
prefix add prefix [padcrosnD] [high|med|low]
Применение
Вот пример использования сопоставленных параметров otBorderRouterConfig
и otRoutePreference
:
prefix add 2001:dead:beef:cafe::/64 paros med
Done
Отекстерналрутеконфиг
Для значений otExternalRouteConfig s
сопоставляется с mStable
а n
сопоставляется с mNat64
.
Синтаксис
publish route prefix [sn]
Применение
route add 2001:dead:beef:cafe::/64 s
Done
Возвращаемые значения
Большинство команд возвращают запрошенное значение, за которым следует Done
:
br onlinkprefix
fd41:2650:a6f5:0::/64
Done
Другие команды, включающие сетевые данные, могут возвращать сопоставления аргументов для записей префикса, маршрута и службы. Дополнительные сведения см. в разделе Отображение и управление сетевыми данными с помощью OT CLI .