Справочник команд CLI

ба эфемерный ключ

Указывает, активен ли в данный момент эфемерный ключ.

Требуется OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE .

Параметры

Никаких параметров.

Примеры

ba ephemeralkey
active
Done

Ссылки на CLI и API

обратный вызов ba ephemeralkey (включить, отключить)

Устанавливает функцию обратного вызова, используемую пограничным агентом для уведомления о любых изменениях, связанных с использованием эфемерного ключа.

Требуется OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE .

Последующий вызов этой функции заменит любой ранее установленный обратный вызов.

Параметры

Никаких параметров.

Примеры

ba ephemeralkey callback enable
Done
ba ephemeralkey set W10X1 5000 49155
Done
BorderAgent callback: Ephemeral key active, port:49155
BorderAgent callback: Ephemeral key inactive

Ссылки на CLI и API

ба эфемерный ключ ясно

Отменяет используемый эфемерный ключ.

Требуется OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE .

Может использоваться для отмены ранее установленного эфемерного ключа до истечения срока его действия. Если пограничный агент не запущен или не используется эфемерный ключ, вызов этой функции не имеет никакого эффекта.

Если комиссар подключен по эфемерному ключу и в данный момент активен, вызов этой функции не меняет его состояния. В этом случае otBorderAgentIsEphemeralKeyActive() будет продолжать возвращать TRUE до тех пор, пока комиссар не отключится.

Параметры

Никаких параметров.

Примеры

ba ephemeralkey clear
Done

Ссылки на CLI и API

ба набор эфемерных ключей [таймаут в мс] [порт]

Устанавливает эфемерный ключ на заданную продолжительность тайм-аута.

Требуется OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE .

Эфемерный ключ может быть установлен, когда пограничный агент уже запущен и в данный момент не подключен к какому-либо внешнему комиссионеру (т. е. он находится в состоянии OT_BORDER_AGENT_STATE_STARTED ). В противном случае возвращается OT_ERROR_INVALID_STATE .

Данная aKeyString напрямую используется как эфемерный PSK (за исключением завершающего нулевого символа \0 ). Длина aKeyString должна находиться в диапазоне от OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH до OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH включительно.

Повторная установка эфемерного ключа до истечения срока действия ранее установленного ключа приведет к замене ранее установленного ключа и сбросу тайм-аута.

Пока действует тайм-аут, внешний комиссар может использовать эфемерный ключ только один раз для подключения. Как только комиссар отключается, эфемерный ключ очищается, и пограничный агент возвращается к использованию PSKc.

Параметры

Никаких параметров.

Примеры

ba ephemeralkey set Z10X20g3J15w1000P60m16 5000 1234
Done

Ссылки на CLI и API

ba id (получить, установить)

Получает или задает 16-байтовый идентификатор пограничного маршрутизатора, который может однозначно идентифицировать устройство среди нескольких BR.

Параметры

ba id [border-agent-id]

Используйте необязательный аргумент border-agent-id чтобы установить идентификатор пограничного агента.

Примеры

ba id
cb6da1e0c0448aaec39fa90f3d58f45c
Done
ba id 00112233445566778899aabbccddeeff
Done

Ссылки на CLI и API

порт Ба

Получает UDP-порт службы агента границы потока.

Параметры

Никаких параметров.

Примеры

ba port
49153
Done

Ссылки на CLI и API

штат Ба

Получает otBorderAgentState роли агента границы потока.

Параметры

Никаких параметров.

Примеры

ba state
Started
Done

Ссылки на CLI и API

ббр

Возвращает текущую информацию об основном магистральном маршрутизаторе для устройства Thread.

Параметры

Никаких параметров.

Примеры

bbr
BBR Primary:
server16: 0xE400
seqno:    10
delay:    120 secs
timeout:  300 secs
Done
bbr
BBR Primary: None
Done

Ссылки на CLI и API

  • Нет связанного API

конфигурация bbr (набор)

Устанавливает конфигурацию локального магистрального маршрутизатора otBackboneRouterConfig .

Сообщение запроса данных сервера SRV_DATA.ntf инициируется автоматически, если набор данных BBR изменяется для основного магистрального маршрутизатора.

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

bbr register должен быть указан явно для регистрации службы магистрального маршрутизатора для лидера для вторичного магистрального маршрутизатора.

Параметры

bbr config [seqno seqno] [delay delay] [timeout timeout]

Примеры

bbr config seqno 20 delay 30
Done

Ссылки на CLI и API

конфигурация bbr

Получает конфигурацию локального магистрального маршрутизатора.

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Параметры

Никаких параметров.

Примеры

bbr config
seqno:    10
delay:    120 secs
timeout:  300 secs
Done

Ссылки на CLI и API

bbr отключить

Включает или отключает функциональность Backbone.

Если этот параметр включен, сообщение запроса данных сервера SRV_DATA.ntf инициируется для подключенного устройства, если в сетевых данных потока нет службы магистрального маршрутизатора.

Если этот параметр отключен, SRV_DATA.ntf запускается, если магистральный маршрутизатор находится в состоянии «Основной».

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Параметры

Никаких параметров.

Примеры

bbr disable
Done

Ссылки на CLI и API

включение bbr

Включает или отключает функциональность Backbone.

Если этот параметр включен, сообщение запроса данных сервера SRV_DATA.ntf инициируется для подключенного устройства, если в сетевых данных потока нет службы магистрального маршрутизатора.

Если этот параметр отключен, SRV_DATA.ntf запускается, если магистральный маршрутизатор находится в состоянии «Основной».

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Параметры

Никаких параметров.

Примеры

bbr enable
Done

Ссылки на CLI и API

bbr джиттер (получить, установить)

Получает или задает джиттер (в секундах) для регистрации магистрального маршрутизатора.

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Параметры

bbr jitter [jitter]

Примеры

bbr jitter
20
Done
bbr jitter 10
Done

Ссылки на CLI и API

ББР МГМТ Дуа

С включенным meshLocalIid эта команда настраивает статус ответа для следующей регистрации DUA. Без meshLocalIid ответьте на следующий DUA.req с указанным status или coap-code .

Доступно, если включен OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Параметры

bbr mgmt dua status|coap-code [meshLocalIid]

Для status или coap-code используйте:

  • 0: ST_DUA_SUCCESS
  • 1: ST_DUA_REREGISTER
  • 2: ST_DUA_INVALID
  • 3: ST_DUA_DUPLICATE
  • 4: ST_DUA_NO_RESOURCES
  • 5: ST_DUA_BBR_NOT_PRIMARY
  • 6: ST_DUA_GENERAL_FAILURE
  • 160: код COAP 5.00

Примеры

bbr mgmt dua 1 2f7c235e5025a2fd
Done
bbr mgmt dua 160
Done

Ссылки на CLI и API

добавить прослушиватель bbr mgmt mlr

Добавляет прослушиватель многоадресной рассылки со значением тайм-аута в секундах.

Передайте 0 , чтобы использовать тайм-аут MLR по умолчанию.

Доступно, когда OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE , OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE и OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE включены.

Параметры

bbr mgmt mlr listener add ipaddress [timeout-seconds]

Примеры

bbr mgmt mlr listener add ff04::1
Done
bbr mgmt mlr listener add ff04::2 300
Done

Ссылки на CLI и API

прослушиватель bbr mgmt mlr

Возвращает прослушиватели многоадресной рассылки с параметром otBackboneRouterMulticastListenerInfo mTimeout в секундах.

Доступно, если включены OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE и OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE .

Параметры

Никаких параметров.

Примеры

bbr mgmt mlr listener
ff04:0:0:0:0:0:0:abcd 3534000
ff04:0:0:0:0:0:0:eeee 3537610
Done

Ссылки на CLI и API

bbr mgmt mlr прослушиватель очистить

Очищает прослушиватели многоадресной рассылки.

Доступно, когда OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE , OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE и OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE включены.

Параметры

Никаких параметров.

Примеры

bbr mgmt mlr listener clear
Done

Ссылки на CLI и API

ответ bbr mgmt mlr

Настраивает статус ответа для следующей регистрации прослушивателя многоадресной рассылки.

Доступно, когда OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE , OPENTHREAD_CONFIG_BACKBONE_ROUTER_MULTICAST_ROUTING_ENABLE и OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE включены.

Параметры

bbr mgmt mlr response status-code

Для status-code используйте:

  • 0: ST_MLR_SUCCESS
  • 2: ST_MLR_INVALID
  • 3: ST_MLR_NO_PERSISTENT
  • 4: ST_MLR_NO_RESOURCES
  • 5: ST_MLR_BBR_NOT_PRIMARY
  • 6: ST_MLR_GENERAL_FAILURE

Примеры

bbr mgmt mlr response 2
Done

Ссылки на CLI и API

регистр bbr

Явно регистрирует конфигурацию локального магистрального маршрутизатора.

Для подключенного устройства запускается сообщение запроса данных сервера SRV_DATA.ntf .

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Параметры

Никаких параметров.

Примеры

bbr register
Done

Ссылки на CLI и API

штат ББР

Получает магистральный маршрутизатор otBackboneRouterState .

Доступно, если включен OPENTHREAD_CONFIG_BACKBONE_ROUTER_ENABLE .

Параметры

Никаких параметров.

Примеры

bbr state
Disabled
Done
bbr state
Primary
Done
bbr state
Secondary
Done

Ссылки на CLI и API

отключить

Отключает диспетчер пограничной маршрутизации.

Параметры

Никаких параметров.

Примеры

br disable
Done

Ссылки на CLI и API

br включить

Включает диспетчер пограничной маршрутизации.

Параметры

Никаких параметров.

Примеры

br enable
Done

Ссылки на CLI и API

br инициализация

Инициализирует диспетчер пограничной маршрутизации.

Параметры

br init infrastructure-network-index is-running

Примеры

br init 2 1
Done

Ссылки на CLI и API

br префикс nat64

Выводит как локальные, так и избранные префиксы NAT64.

Параметры

Никаких параметров.

Примеры

br nat64prefix
Local: fd14:1078:b3d5:b0b0:0:0::/96
Favored: fd14:1078:b3d5:b0b0:0:0::/96 prf:low
Done

Ссылки на CLI и API

br nat64prefix избранный

Получает предпочитаемый в данный момент префикс NAT64.

Предпочтительный префикс NAT64 можно обнаружить по инфраструктурному каналу или он может быть локальным префиксом NAT64 этого устройства.

Параметры

Никаких параметров.

Примеры

br nat64prefix favored
fd14:1078:b3d5:b0b0:0:0::/96 prf:low
Done

Ссылки на CLI и API

br nat64prefix локальный

Получает локальный префикс NAT64 пограничного маршрутизатора.

Префикс NAT64 может не объявляться в сети Thread.

OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE должен быть включен.

Параметры

Никаких параметров.

Примеры

br nat64prefix local
fd14:1078:b3d5:b0b0:0:0::/96
Done

Ссылки на CLI и API

бр омрпрефикс

Выводит как локальный, так и предпочтительный префикс OMR.

Параметры

Никаких параметров.

Примеры

br omrprefix
Local: fdfc:1ff5:1512:5622::/64
Favored: fdfc:1ff5:1512:5622::/64 prf:low
Done

Ссылки на CLI и API

br omrprefix избранное

Получает предпочитаемый в данный момент префикс Off-Mesh-Routable (OMR).

Предпочтительный префикс OMR можно узнать из сетевых данных или использовать локальный префикс OMR этого устройства.

Параметры

Никаких параметров.

Примеры

br omrprefix favored
fdfc:1ff5:1512:5622::/64 prf:low
Done

Ссылки на CLI и API

br omrprefix локальный

Получает локальный префикс Off-Mesh-Routable (OMR), например fdfc:1ff5:1512:5622::/64 .

Префикс OMR — это случайно сгенерированный 64-битный префикс, который публикуется в сети Thread, если префикс OMR еще не существует. Доступ к этой приставке возможен из локальной сети Wi-Fi или Ethernet.

Параметры

Никаких параметров.

Примеры

br omrprefix local
fdfc:1ff5:1512:5622::/64
Done

Ссылки на CLI и API

br onlinkprefix

Выводит как локальные, так и избранные префиксы on-link.

Параметры

Никаких параметров.

Примеры

br onlinkprefix
Local: fd41:2650:a6f5:0::/64
Favored: 2600::0:1234:da12::/64
Done

Ссылки на CLI и API

br onlinkprefix избранное

Получает предпочитаемый в данный момент префикс On-Link.

Предпочтительным префиксом является либо обнаруженный префикс on-link в инфраструктурном канале, либо локальный префикс on-link.

Параметры

Никаких параметров.

Примеры

br onlinkprefix favored
2600::0:1234:da12::/64
Done

Ссылки на CLI и API

br onlinkprefix локальный

Получает локальный префикс On-Link для соседнего канала инфраструктуры.

Локальный префикс on-link — это 64-битный префикс, который объявляется в инфраструктурном канале, если в канале еще не объявлен пригодный для использования префикс on-link.

Параметры

Никаких параметров.

Примеры

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

Ссылки на CLI и API

br с префиксом

Получите обнаруженные префиксы с помощью Border Routing Manager по инфраструктурной ссылке. Информация для каждой записи префикса:

  • Префикс
  • Является ли префикс on-link или маршрутом
  • Количество миллисекунд с момента последнего получения объявления маршрутизатора, содержащего этот префикс.
  • Время жизни префикса в секундах
  • Предпочтительное время жизни в секундах, только если префикс включен по ссылке.
  • Предпочтение маршрута (низкий, средний, высокий), только если префиксом является маршрут (не для канала).
  • IPv6-адрес маршрутизатора, на котором рекламируется этот префикс.
  • Флаги в полученном заголовке объявления маршрутизатора:
    • M: Флаг конфигурации управляемого адреса.
    • O: Другой флаг конфигурации.
    • Stub: Флаг стабового маршрутизатора (указывает, является ли маршрутизатор тупиковым).

Параметры

Никаких параметров.

Примеры

br prefixtable
prefix:fd00:1234:5678:0::/64, on-link:no, ms-since-rx:29526, lifetime:1800, route-prf:med,
router:ff02:0:0:0:0:0:0:1 (M:0 O:0 Stub:1)
prefix:1200:abba:baba:0::/64, on-link:yes, ms-since-rx:29527, lifetime:1800, preferred:1800,
router:ff02:0:0:0:0:0:0:1 (M:0 O:0 Stub:1)
Done

Ссылки на CLI и API

br raoptions (установить, очистить)

Устанавливает дополнительные параметры для добавления в конец отправляемых сообщений объявления маршрутизатора (RA).

Содержимое aOptions копируется внутри, поэтому оно может быть временным буфером (например, массивом, выделенным в стеке).

Последующие вызовы этой функции перезаписывают ранее установленное значение.

Параметры

br raoptions options|clear

br raoptions clear передает nullptr в otBorderRoutingSetExtraRouterAdvertOptions . В противном случае вы можете передать байт options как шестнадцатеричные данные.

Примеры

br raoptions 0400ff00020001
Done
br raoptions clear
Done

Ссылки на CLI и API

br rioprf (высокий, средний, низкий)

Явно задает предпочтение, которое будет использоваться при объявлении параметров информации о маршруте (RIO) в сообщениях объявления маршрутизатора, отправляемых по каналу инфраструктуры.

После вызова этой функции BR будет использовать заданное предпочтение для всех своих объявленных RIO. Предпочтение можно очистить, вызвав otBorderRoutingClearRouteInfoOptionPreference() .

Параметры

br rioprf [high|med|low]

Примеры

br rioprf low
Done

Ссылки на CLI и API

бр риопрф

Получает текущее предпочтение, используемое при объявлении параметров информации о маршруте (RIO) в сообщениях объявления маршрутизатора, отправляемых по каналу инфраструктуры.

Предпочтение RIO определяется следующим образом:

  • Если это явно задано пользователем путем вызова otBorderRoutingSetRouteInfoOptionPreference() , используется данное предпочтение.
  • В противном случае оно определяется на основе текущей роли устройства: средний уровень предпочтения в роли маршрутизатора/лидера и низкий уровень предпочтения в дочерней роли.

Параметры

Никаких параметров.

Примеры

br rioprf
med
Done

Ссылки на CLI и API

бр риопрф ясно

Очищает ранее установленное значение предпочтения для объявленных параметров информации о маршруте.

После вызова этой функции BR будет использовать роль устройства для определения предпочтения RIO: средний уровень предпочтения в роли маршрутизатора/лидера и низкий уровень предпочтения в дочерней роли.

Параметры

Никаких параметров.

Примеры

br rioprf clear
Done

Ссылки на CLI и API

brrouteprf (высокий,средний,низкий)

Явно задает предпочтения опубликованных маршрутов в сетевых данных.

После вызова этой функции BR будет использовать заданное предпочтение. Предпочтение можно очистить, вызвав otBorderRoutingClearRoutePreference() .

Параметры

br routeprf [high|med|low]

Примеры

br routeprf low
Done

Ссылки на CLI и API

бр маршрутпрф

Получает текущие предпочтения, используемые для опубликованных маршрутов в сетевых данных.

Предпочтение определяется следующим образом:

  • Если это явно задано пользователем путем вызова otBorderRoutingSetRoutePreference() , используется данное предпочтение.
  • В противном случае оно определяется автоматически RoutingManager на основе роли устройства и качества соединения.

Параметры

Никаких параметров.

Примеры

br routeprf
med
Done

Ссылки на CLI и API

br RoutePRF очистить

Очищает ранее установленное значение предпочтения для опубликованных маршрутов в сетевых данных.

После вызова этой функции BR автоматически определит предпочтение на основе роли устройства и качества соединения (с родительским устройством, когда оно выступает в качестве конечного устройства).

Параметры

Никаких параметров.

Примеры

br routeprf clear
Done

Ссылки на CLI и API

маршрутизаторы BR

Получите список обнаруженных маршрутизаторов с помощью Border Routing Manager по инфраструктурному каналу. Информация по маршрутизатору:

  • IPv6-адрес маршрутизатора
  • Флаги в полученном заголовке объявления маршрутизатора:
    • M: Флаг конфигурации управляемого адреса.
    • O: Другой флаг конфигурации.
    • Stub: Флаг стабового маршрутизатора (указывает, является ли маршрутизатор тупиковым).

Параметры

Никаких параметров.

Примеры

br routers
ff02:0:0:0:0:0:0:1 (M:0 O:0 Stub:1)
Done

Ссылки на CLI и API

Британский штат

Получает текущее состояние диспетчера пограничной маршрутизации.

Параметры

Никаких параметров.

Примеры

br state
running

Ссылки на CLI и API

информация о буфере

Получает текущую информацию о буфере сообщений.

  • total отображает общее количество буферов сообщений в пуле.
  • free отображает количество свободных буферов сообщений.
  • max-used отображает максимальное количество используемых буферов одновременно с момента инициализации стека OT или последнего bufferinfo reset .

Затем CLI отображает информацию о различных очередях, используемых стеком OpenThread, например 6lo send . Каждая строка после очереди представляет информацию об очереди:

  • Первое число показывает количество сообщений в очереди.
  • Второе число показывает количество буферов, используемых всеми сообщениями в очереди.
  • Третье число показывает общее количество байтов всех сообщений в очереди.

Параметры

Никаких параметров.

Примеры

bufferinfo
total: 40
free: 40
max-used: 5
6lo send: 0 0 0
6lo reas: 0 0 0
ip6: 0 0 0
mpl: 0 0 0
mle: 0 0 0
coap: 0 0 0
coap secure: 0 0 0
application coap: 0 0 0
Done

Ссылки на CLI и API

сброс информации о буфере

Сбросьте счетчик информации о буфере сообщений, отслеживая максимальное количество одновременно используемых буферов.

Это сбрасывает mMaxUsedBuffers в otBufferInfo .

Параметры

Никаких параметров.

Примеры

bufferinfo reset
Done

Ссылки на CLI и API

ccathreshold (получить, установить)

Получает или задает порог CCA в дБм, измеренный на антенном разъеме в соответствии со стандартом IEEE 802.15.4 — 2015, раздел 10.1.4.

Параметры

ccathreshold [CCA-threshold-dBm]

Используйте дополнительный аргумент CCA-threshold-dBm чтобы установить порог CCA.

Примеры

ccathreshold
-75 dBm
Done
ccathreshold -62
Done

Ссылки на CLI и API

канал (получить, установить)

Получает или задает значение канала IEEE 802.15.4.

Параметры

channel [channel-num]

Используйте channel-num , чтобы установить канал.

Примеры

channel
11
Done
channel 11
Done

Ссылки на CLI и API

  • Нет связанного API

менеджер каналов авто

Включает или отключает функцию автоматического выбора канала для сетевого канала.

Если этот параметр включен, ChannelManager будет периодически вызывать RequestChannelSelect(false) . Интервал периода можно установить с помощью otChannelManagerSetAutoChannelSelectionInterval() .

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager auto enable

1 — логическое значение для enable .

Примеры

channel manager auto 1
channel manager auto 1
Done

Ссылки на CLI и API

смена менеджера канала

Запрашивает изменение сетевого канала потока.

Сеть переключается на данный канал после заданной задержки (см. otChannelManagerSetDelay() ). Смена канала выполняется путем обновления набора ожидающих операций.

Последующий вызов отменит текущее ранее запрошенное изменение канала.

Требуется OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE .

Параметры

channel manager change channel-num

Примеры

channel manager change 11
channel manager change 11
Done

Ссылки на CLI и API

менеджер канала

Получите состояние менеджера каналов. Требуется OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE .

Параметры

Никаких параметров.

Примеры

channel manager
channel: 11
auto: 1
delay: 120
interval: 10800
supported: { 11-26}
favored: { 11-26}
Done

Ссылки на CLI и API

задержка менеджера канала

Устанавливает задержку (в секундах), используемую для смены сетевого канала.

Доступно только на FTD. Задержка предпочтительно должна быть больше, чем максимальный интервал опроса данных, используемый всеми спящими конечными устройствами в сети Thread.

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager delay delay-seconds

Примеры

channel manager delay 120
channel manager delay 120
Done

Ссылки на CLI и API

менеджер канала предпочитает

Устанавливает маску предпочтительного канала.

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager favored mask

Примеры

channel manager favored 0x7fffc00
channel manager favored 0x7fffc00
Done

Ссылки на CLI и API

интервал менеджера каналов

Устанавливает интервал периода (в секундах), используемый функцией автоматического выбора канала.

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager interval interval-seconds

Примеры

channel manager interval 10800
channel manager interval 10800
Done

Ссылки на CLI и API

менеджер каналов выбрать

Запрашивает, чтобы ChannelManager проверил и выбрал новый канал и начал смену канала.

В отличие от otChannelManagerRequestChannelChange() , где канал должен быть указан в качестве параметра, эта функция просит ChannelManager выбрать канал самостоятельно (на основе собранной информации о качестве канала).

После вызова менеджер каналов выполнит следующие 3 шага:

1) ChannelManager решает, будет ли полезно изменение канала. Эту проверку можно пропустить, если для aSkipQualityCheck установлено значение true (принудительный выбор канала и пропуск проверки качества). На этом этапе используются собранные показатели качества канала на устройстве (например, частота отказов CCA, частота ошибок кадров и сообщений на соседа и т. д.), чтобы определить, находится ли текущее качество канала на уровне, оправдывающем смену канала.

2) Если первый шаг пройден, ChannelManager выбирает потенциально лучший канал. Он использует данные о качестве канала, собранные модулем ChannelMonitor . На этом этапе используются поддерживаемые и избранные каналы. (см. otChannelManagerSetSupportedChannels() и otChannelManagerSetFavoredChannels() ).

3) Если вновь выбранный канал отличается от текущего канала, ChannelManager запрашивает/запускает процесс смены канала (внутренний вызов RequestChannelChange() ).

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager select skip-quality-check

Используйте 1 или 0 для логической skip-quality-check .

Примеры

channel manager select 1
channel manager select 1
Done

Ссылки на CLI и API

поддерживается менеджер каналов

Устанавливает поддерживаемую маску канала.

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager supported mask

Примеры

channel manager supported 0x7fffc00
channel manager supported 0x7fffc00
Done

Ссылки на CLI и API

порог менеджера канала

Устанавливает порог частоты отказов CCA.

OPENTHREAD_CONFIG_CHANNEL_MANAGER_ENABLE или OPENTHREAD_CONFIG_MAC_CSL_RECEIVER_ENABLE && OPENTHREAD_CONFIG_CHANNEL_MANAGER_CSL_CHANNEL_SELECT_ENABLE и OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE являются обязательными.

Параметры

channel manager threshold threshold-percent

Используйте шестнадцатеричное значение для threshold-percent . 0 отображает 0%, а 0xffff отображает 100%.

Примеры

channel manager threshold 0xffff
channel manager threshold 0xffff
Done

Ссылки на CLI и API

монитор канала

Получите текущее состояние монитора канала и занятость канала. Требуется OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE .

Параметры

Никаких параметров.

Примеры

channel monitor
enabled: 1
interval: 41000
threshold: -75
window: 960
count: 10552
occupancies:
ch 11 (0x0cb7)  4.96% busy
ch 12 (0x2e2b) 18.03% busy
ch 13 (0x2f54) 18.48% busy
ch 14 (0x0fef)  6.22% busy
ch 15 (0x1536)  8.28% busy
ch 16 (0x1746)  9.09% busy
ch 17 (0x0b8b)  4.50% busy
ch 18 (0x60a7) 37.75% busy
ch 19 (0x0810)  3.14% busy
ch 20 (0x0c2a)  4.75% busy
ch 21 (0x08dc)  3.46% busy
ch 22 (0x101d)  6.29% busy
ch 23 (0x0092)  0.22% busy
ch 24 (0x0028)  0.06% busy
ch 25 (0x0063)  0.15% busy
ch 26 (0x058c)  2.16% busy
Done

Ссылки на CLI и API

  • Нет связанного API

запуск монитора каналов

Запустите монитор каналов. OT CLI отправляет логическое значение true в otChannelMonitorSetEnabled . Требуется OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE .

Параметры

Никаких параметров.

Примеры

channel monitor start
channel monitor start
Done

Ссылки на CLI и API

остановка монитора канала

Остановите монитор канала. OT CLI отправляет логическое значение false в otChannelMonitorSetEnabled . Требуется OPENTHREAD_CONFIG_CHANNEL_MONITOR_ENABLE .

Параметры

Никаких параметров.

Примеры

channel monitor stop
channel monitor stop
Done

Ссылки на CLI и API

предпочтительный канал

Получает маску предпочтительного радиоканала, которую устройство предпочитает формировать.

Параметры

Никаких параметров.

Примеры

channel preferred
0x7fff800
Done

Ссылки на CLI и API

канал поддерживается

Получите маску радиоканала, на которой разрешено использование устройства.

Параметры

Никаких параметров.

Примеры

channel supported
0x7fff800
Done

Ссылки на CLI и API

ребенок (идентификатор)

Получает диагностическую информацию о подключенном дочернем элементе по его идентификатору дочернего элемента или RLOC16.

Параметры

child child-id

Примеры

child 1
Child ID: 1
Rloc: 9c01
Ext Addr: e2b3540590b0fd87
Mode: rn
CSL Synchronized: 1
Net Data: 184
Timeout: 100
Age: 0
Link Quality In: 3
RSSI: -20
Done

Ссылки на CLI и API

дочерний список

Возвращает список прикрепленных дочерних идентификаторов.

Параметры

Никаких параметров.

Примеры

child list
1 2 3 6 7 8
Done

Ссылки на CLI и API

дочерний стол

Печатает таблицу присоединенных дочерних элементов.

Параметры

Никаких параметров.

Примеры

child table
| ID  | RLOC16 | Timeout    | Age        | LQ In | C_VN |R|D|N|Ver|CSL|QMsgCnt| Extended MAC     |
+-----+--------+------------+------------+-------+------+-+-+-+---+---+-------+------------------+
|   1 | 0xc801 |        240 |         24 |     3 |  131 |1|0|0|  3| 0 |     0 | 4ecede68435358ac |
|   2 | 0xc802 |        240 |          2 |     3 |  131 |0|0|0|  3| 1 |     0 | a672a601d2ce37d8 |
Done

Ссылки на CLI и API

детство

Получает список IP-адресов, хранящихся для дочерних элементов MTD.

Параметры

Никаких параметров.

Примеры

childip
3401: fdde:ad00:beef:0:3037:3e03:8c5f:bc0c
Done

Ссылки на CLI и API

Чайлдип Макс (набор)

Устанавливает или восстанавливает максимальное количество IP-адресов, которые каждый дочерний элемент MTD может зарегистрировать на этом устройстве в качестве родительского.

Введите 0 , чтобы очистить настройку и восстановить значения по умолчанию.

Доступно, если включен OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Параметры

childip max count

Примеры

childip max 2
Done

Ссылки на CLI и API

Чайлдип Макс

Получает максимальное количество IP-адресов, которые каждый дочерний элемент MTD может зарегистрировать на этом устройстве в качестве родительского.

Параметры

Никаких параметров.

Примеры

childip max
4
Done

Ссылки на CLI и API

ребенокмакс (набор)

Устанавливает максимальное количество дочерних элементов, разрешенное в настоящее время.

Этот параметр можно установить только в том случае, если работа протокола Thread остановлена.

Параметры

childmax count

Примеры

childmax 2
Done

Ссылки на CLI и API

ребенокмакс

Получает максимальное количество дочерних элементов, разрешенное в настоящее время.

Параметры

Никаких параметров.

Примеры

childmax
5
Done

Ссылки на CLI и API

Получает или задает значение MLE_CHILD_ROUTER_LINKS.

Параметры

childrouterlinks [links]

Примеры

childrouterlinks
16
Done
childrouterlinks 16
Done

Ссылки на CLI и API

тайм-аут проверки детского надзора (установлен)

Устанавливает интервал тайм-аута проверки контроля (в секундах) для дочернего элемента.

Параметры

childsupervision checktimeout timeout-seconds

Примеры

childsupervision checktimeout 30
Done

Ссылки на CLI и API

контроль над детьми

Получает интервал тайм-аута проверки контроля (в секундах) для дочернего элемента.

Если устройство является сонным дочерним устройством и не получает ответа от своего родителя в течение указанного тайм-аута проверки, оно инициирует процесс повторного подключения (обмен запросом/ответом на обновление дочернего устройства MLE со своим родителем).

Параметры

Никаких параметров.

Примеры

childsupervision checktimeout
30
Done

Ссылки на CLI и API

интервал наблюдения за детьми (набор)

Устанавливает интервал наблюдения за ребенком (в секундах).

Параметры

childsupervision interval interval-seconds

Примеры

childsupervision interval 30
Done

Ссылки на CLI и API

интервал наблюдения за детьми

Получает интервал дочернего контроля (в секундах) для дочернего элемента.

Функция «Наблюдение за детьми» предоставляет родителю механизм, позволяющий гарантировать отправку сообщения каждому сонному ребенку в течение интервала наблюдения. Если в течение интервала наблюдения передача дочернему элементу не осуществляется, OpenThread ставит в очередь и отправляет дочернему сообщению дочернее сообщение.

Параметры

Никаких параметров.

Примеры

childsupervision interval
30
Done

Ссылки на CLI и API

дочерний тайм-аут (набор)

Устанавливает тайм-аут дочернего потока (в секундах), используемый при работе в дочерней роли.

Параметры

childtimeout timeout-seconds

Примеры

childtimeout 300
Done

Ссылки на CLI и API

ребеноктайм-аут

Получает тайм-аут дочернего потока (в секундах), используемый при работе в дочерней роли.

Параметры

Никаких параметров.

Примеры

childtimeout
300
Done

Ссылки на CLI и API

отмена кооператива

Отменяет существующую подписку на наблюдение за удаленным ресурсом на сервере CoAP.

Параметры

Никаких параметров.

Примеры

coap cancel
Done

Ссылки на CLI и API

удаление колпака

Удаляет указанный ресурс CoAP.

Параметры

coap delete address uri-path [type] [payload]
  • address : IPv6-адрес сервера CoAP.
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию)
  • payload : строка полезных данных CoAP. Например, hellothere .

Примеры

coap delete fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done

Ссылки на CLI и API

  • Нет связанного API

плащ получить

Получает информацию об указанном ресурсе CoAP на сервере CoAP.

Параметры

coap get address uri-path [type]
  • address : IPv6-адрес сервера CoAP.
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию)
    • block- : используйте эту опцию, за которой следует поблочное значение, если ответ должен передаваться поблочно. Допустимые значения: block-16 , block-32 , block-64 , block-128 , block-256 , block-512 или block-1024 .

Примеры

coap get fdde:ad00:beef:0:2780:9423:166c:1aac test-resource
Done
coap get fdde:ad00:beef:0:2780:9423:166c:1aac test-resource block-1024
Done

Ссылки на CLI и API

  • Нет связанного API

кооператив наблюдать

Запускает запрос на подписку, который позволяет клиенту CoAP наблюдать за указанным ресурсом на сервере CoAP на предмет возможных изменений в его состоянии.

Параметры

coap observe address uri-path [type]
  • address : IPv6-адрес сервера CoAP.
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию).

Примеры

coap observe fdde:ad00:beef:0:2780:9423:166c:1aac test-resource
Done

Ссылки на CLI и API

  • Нет связанного API

параметры коап (получить, установить)

Получает текущие значения параметров CoAP, если команда выполняется без дополнительных параметров.

Устанавливает для параметров CoAP значения по умолчанию или значения, которые вы указываете, в зависимости от выбранного синтаксиса.

Параметры

coap parameters type [default | ack_timeout ack_random_factor_numerator ack_random_factor_denominator max_retransmit]
  • type : request на запросы CoAP или response на ответы CoAP. Если больше параметров не указано, команда печатает текущую конфигурацию.
  • default : устанавливает для параметров передачи следующие значения по умолчанию:
    • ack_timeout : 2000 миллисекунд.
    • ack_random_factor_numerator : 3
    • ack_random_factor_denominator : 2
    • max_retransmit : 4
  • ack_timeout : ACK_TIMEOUT (0-UINT32_MAX) в миллисекундах. Обратитесь к RFC7252.
  • ack_random_factor_numerator : числитель ACK_RANDOM_FACTOR с возможными значениями от 0 до 255. Обратитесь к RFC7252.
  • ack_random_factor_denominator : знаменатель ACK_RANDOM_FACTOR с возможными значениями от 0 до 255. Обратитесь к RFC7252.
  • max_retransmit : MAX_RETRANSMIT (0–255). Обратитесь к RFC7252.

Примеры

coap parameters request
Transmission parameters for request:
ACK_TIMEOUT=1000 ms, ACK_RANDOM_FACTOR=255/254, MAX_RETRANSMIT=2
Done
coap parameters request default
Transmission parameters for request:
default
Done
coap parameters request 1000 255 254 2
Transmission parameters for request:
ACK_TIMEOUT=1000 ms, ACK_RANDOM_FACTOR=255/254, MAX_RETRANSMIT=2
Done

Ссылки на CLI и API

  • Нет связанного API

столб

Создает указанный ресурс CoAP. Дополнительные сведения см. в разделе Проверка подключения к ресурсу протокола ограниченного приложения (CoAP) с использованием OT CLI .

Параметры

coap post address uri-path [type] [payload]
  • address : IPv6-адрес сервера CoAP.
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию)
    • block- : используйте эту опцию, за которой следует блочное значение, для отправки блоков со случайно сгенерированным количеством байтов для полезной нагрузки. Допустимые значения: block-16 , block-32 , block-64 , block-128 , block-256 , block-512 или block-1024 .
  • payload : запрос полезной нагрузки CoAP, который, если используется, представляет собой строку или целое число, в зависимости от type . Если typecon или non-con , параметр payload является необязательным. Если вы опустите параметр payload , будет отправлена ​​пустая полезная нагрузка. Однако если вы используете параметр payload , его значение должно быть строкой, например hellothere . Если typeblock- , значение параметра payload должно быть целым числом, указывающим количество блоков для отправки. Тип block- требует установки OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE .

Примеры

coap post fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done
coap post fdde:ad00:beef:0:2780:9423:166c:1aac test-resource block-1024 10
Done

Ссылки на CLI и API

  • Нет связанного API

накинуть куртку

Изменяет указанный ресурс CoAP. Дополнительные сведения см. в разделе Проверка подключения к ресурсу протокола ограниченного приложения (CoAP) с использованием OT CLI .

Параметры

coap put address uri-path [type] [payload]
  • address : IPv6-адрес сервера CoAP.
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию)
    • block- : используйте эту опцию, за которой следует блочное значение, для отправки блоков со случайно сгенерированным количеством байтов для полезной нагрузки. Допустимые значения: block-16 , block-32 , block-64 , block-128 , block-256 , block-512 или block-1024 .
  • payload : запрос полезной нагрузки CoAP, который, если используется, представляет собой строку или целое число, в зависимости от type . Если typecon или non-con , параметр payload является необязательным. Если вы опустите параметр payload , будет отправлена ​​пустая полезная нагрузка. Однако если вы используете параметр payload , его значение должно быть строкой, например hellothere . Если typeblock- , значение параметра payload должно быть целым числом, указывающим количество блоков для отправки. Тип block- требует установки OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE .

Примеры

coap put fdde:ad00:beef:0:2780:9423:166c:1aac test-resource con hellothere
Done
coap put fdde:ad00:beef:0:2780:9423:166c:1aac test-resource block-1024 10
Done

Ссылки на CLI и API

  • Нет связанного API

ресурс coap (получить, установить)

Получает или задает путь URI ресурса сервера CoAP.

Параметры

coap resource [uri-path]

Примеры

coap resource test-resource
Done
coap resource
test-resource
Done

Ссылки на CLI и API

комплект пальто

Устанавливает содержимое, отправляемое ресурсом на сервер CoAP. Если клиент CoAP наблюдает за ресурсом, этому клиенту отправляется уведомление.

Параметры

coap set new-content

Примеры

coap set Testing123
Done

Ссылки на CLI и API

начало сотрудничества

Запускает сервер CoAP. Дополнительные сведения см. в разделе Проверка подключения к ресурсу протокола ограниченного приложения (CoAP) с использованием OT CLI .

Параметры

Никаких параметров.

Примеры

coap start
Done

Ссылки на CLI и API

остановка кооператива

Останавливает сервер CoAP.

Параметры

Никаких параметров.

Примеры

coap stop
Done

Ссылки на CLI и API

Cops соединяются

Инициализирует сеанс безопасности дейтаграммного транспортного уровня (DTLS) с одноранговым узлом. Дополнительные сведения см. в разделе Проверка подключения к ресурсу ограниченного протокола приложений (CoAPS) с использованием OT CLI .

Параметры

coaps connect address

Параметр address — это IPv6-адрес узла.

Примеры

coaps connect fdde:ad00:beef:0:9903:14b:27e0:5744
Done
coaps connected

Ссылки на CLI и API

копы удалить

Строка полезных данных CoAPS, которую необходимо удалить.

Параметры

coaps delete uri-path [type] [payload]
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию)
  • payload : запрос полезной нагрузки CoAPS.

Примеры

coaps delete test-resource con hellothere
Done

Ссылки на CLI и API

  • Нет связанного API

Копсы отключаются

Останавливает сеанс DTLS.

Параметры

Никаких параметров.

Примеры

coaps disconnect
coaps disconnected
Done

Ссылки на CLI и API

копы получают

Получает информацию об указанном ресурсе CoAPS на сервере CoAPS. Дополнительные сведения см. в разделе Проверка подключения к ресурсу ограниченного протокола приложений (CoAPS) с использованием OT CLI .

Параметры

coaps get uri-path [type]
  • uri-path : URI-путь к ресурсу.
  • type :
    • con : Подтверждаемый
    • non-con : Неподтверждаемый (по умолчанию)
    • block- : используйте эту опцию, за которой следует поблочное значение, если ответ должен передаваться поблочно. Допустимые значения: block-16 , block-32 , block-64 , block-128 , block-256 , block-512 или block-1024 .

Примеры

coaps get test-resource
Done
coaps get test-resource block-1024
Done

Ссылки на CLI и API

  • Нет связанного API

куртки закрыты

Указывает, закрыта ли служба CoAP Secure. Дополнительные сведения см. в разделе Проверка подключения к ресурсу ограниченного протокола приложений (CoAPS) с использованием OT CLI .

Параметры

Никаких параметров.

Примеры

coaps isclosed
no
Done

Ссылки на CLI и API

Копс

Указывает, активно ли соединение службы CoAP Secure (уже подключено или находится в процессе установления соединения). Дополнительные сведения см. в разделе Проверка подключения к ресурсу ограниченного протокола приложений (CoAPS) с использованием OT CLI .

Параметры

Никаких параметров.

Примеры

coaps isconnactive
yes
Done

Ссылки на CLI и API

Coaps isconnected

Указывает, подключена ли служба CoAP Secure. Дополнительные сведения см. в разделе Проверка подключения к ресурсу ограниченного протокола приложений (CoAPS) с использованием OT CLI .

Параметры

Никаких параметров.

Примеры

coaps isconnected
yes
Done

Ссылки на CLI и API

полицейский пост

Создает указанный ресурс CoAPS. Для получения дополнительной информации обратитесь к тестируемому подключению к ресурсу Secure Protocol с ограниченным протоколом приложения (COAP) с использованием CLI OT .

Параметры

uri-path [type] [payload]
  • uri-path : URI PATH of Resource.
  • type :
    • con : Подтвердится
    • non-con : не подтверждаемый (по умолчанию)
    • block- : Используйте эту опцию, за которым следует блок-значение, для отправки блоков с случайным образом сгенерированным числом байтов для полезной нагрузки. Допустимые значения: block-16 , block-32 , block-64 , block-128 , block-256 , block-512 или block-1024 .
  • payload : запрос на полезную нагрузку COAP, который, если используется, является либо строкой, либо целым числом, в зависимости от type . Если type не является con или non-con , параметр полезной нагрузки является необязательным. Если вы оставите параметр полезной нагрузки, отправляется пустая полезная нагрузка. Однако, если вы используете параметр полезной нагрузки, его значение должно быть строкой, например, hellothere . Если type block- , значение параметра полезной нагрузки должно быть целым числом, которое указывает количество блоков для отправки. Тип block- требует OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE для установки.

Примеры

coaps post test-resource con hellothere
Done
coaps post test-resource block-1024 10
Done

Ссылки CLI и API

  • Нет связанных API

Коапс PSK

Устанавливает предварительную клавишу (PSK) и Sipher Suite DTLS_PSK_WITH_AES_128_CCM_8.

Параметры

coaps psk psk-value psk-id
  • psk-value : предварительный ключ
  • psk-id : предварительный идентификатор ключа.

Примеры

coaps psk 1234 key1
Done

Ссылки CLI и API

Коипсы положили

Изменяет указанный ресурс Coaps. Для получения дополнительной информации обратитесь к тестируемому подключению к ресурсу Secure Protocol с ограниченным протоколом приложения (COAP) с использованием CLI OT .

Параметры

uri-path [type] [payload]
  • uri-path : URI PATH of Resource.
  • type :
    • con : Подтвердится
    • non-con : не подтверждаемый (по умолчанию)
    • block- : Используйте эту опцию, за которым следует блок-значение, для отправки блоков с случайным образом сгенерированным числом байтов для полезной нагрузки. Допустимые значения: block-16 , block-32 , block-64 , block-128 , block-256 , block-512 или block-1024 .
  • payload : запрос на полезную нагрузку COAP, который, если используется, является либо строкой, либо целым числом, в зависимости от type . Если type не является con или non-con , параметр полезной нагрузки является необязательным. Если вы оставите параметр полезной нагрузки, отправляется пустая полезная нагрузка. Однако, если вы используете параметр полезной нагрузки, его значение должно быть строкой, например, hellothere . Если type block- , значение параметра полезной нагрузки должно быть целым числом, которое указывает количество блоков для отправки. Тип block- требует OPENTHREAD_CONFIG_COAP_BLOCKWISE_TRANSFER_ENABLE для установки.

Примеры

coaps put test-resource con hellothere
Done
coaps put test-resource block-1024 10
Done

Ссылки CLI и API

  • Нет связанных API

Resource Coaps (Get, SET)

Получает или устанавливает путь URI ресурса сервера Coaps. Для получения дополнительной информации обратитесь к тестируемому подключению к ресурсу Secure Protocol с ограниченным протоколом приложения (COAP) с использованием CLI OT .

Параметры

coaps resource [uri-path]

Примеры

coaps resource test-resource
Done
coaps resource
test-resource
Done

Ссылки CLI и API

набор копей

Устанавливает контент, отправленный ресурсом на сервере Coaps. Для получения дополнительной информации обратитесь к тестируемому подключению к ресурсу Secure Protocol с ограниченным протоколом приложения (COAP) с использованием CLI OT .

Параметры

coaps set new-content

Примеры

coaps set Testing123
Done

Ссылки CLI и API

  • Нет связанных API

Коипс начинается

Запускает безопасную службу COAP. Для получения дополнительной информации обратитесь к тестируемому подключению к ресурсу Secure Protocol с ограниченным протоколом приложения (COAP) с использованием CLI OT .

Параметры

coaps start [check-peer-cert | max-conn-attempts]

Параметр check-peer-cert определяет, включена ли проверка PEER-сертификата (по умолчанию) или отключена. Параметр max-conn-attempts устанавливает максимальное количество разрешенных попыток, успешных или неудачных, подключиться к безопасному серверу COAP. Значение по умолчанию этого параметра составляет 0 , что означает, что нет ограничения для количества попыток. Параметры check-peer-cert и max-conn-attempts работают вместе в следующих комбинациях, даже если вы можете указать только один аргумент:

  • Не указан аргумент: не используются дефолты.
  • Установка check-peer-cert на true : имеет тот же эффект, что и пропустить аргумент, который состоит в том, что значение check-peer-cert является true , а значение max-conn-attempts составляет 0.
  • Установка check-peer-cert на false : значение check-peer-cert является false , а значение max-conn-attempts составляет 0.
  • Определение числа: check-peer-cert true , а значение max-conn-attempts -это число, указанное в аргументе.

Примеры

coaps start
Done
coaps start false
Done
coaps start 8
Done

Ссылки CLI и API

Коупс останавливается

Остановит безопасную службу COAP. Для получения дополнительной информации обратитесь к тестируемому подключению к ресурсу Secure Protocol с ограниченным протоколом приложения (COAP) с использованием CLI OT .

Параметры

Никаких параметров.

Примеры

coaps stop
Done

Ссылки CLI и API

Коапс x509

Устанавливает сертификат x509 локального устройства с соответствующим закрытым ключом для сеанса DTLS с DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8 .

Параметры

Никаких параметров.

Примеры

coaps x509
Done

Ссылки CLI и API

Комиссар объявляет

Отправляет сообщение «Начать».

Параметры

commissioner announce mask count period destination
  • mask : Bitmask, которая идентифицирует каналы для отправки Announce MLE.
  • count : Количество MLE Announce передачи на канал.
  • period : количество миллисекундов между последовательными Announce MLE.
  • destination : адрес назначения IPv6 для сообщения. Сообщение может быть многоадресной рассылкой.

Примеры

commissioner announce 0x00050000 2 32 fdde:ad00:beef:0:0:ff:fe00:c00
Done

Ссылки CLI и API

Комиссар Энергия

Отправляет сообщение запроса на сканирование энергии. Вывод команды печатается по мере его получения.

Параметры

commissioner energy mask count period scanDuration destination
  • mask : Bitmask, которая идентифицирует каналы для выполнения IEEE 802.15.4.
  • count : Количество IEEE 802.15.4 Энергетическое сканирование на канал.
  • period : Количество миллисекундов между последовательными IEEE 802.15.4 Сканирование энергии.
  • scanDuration : продолжительность сканирования в миллисекундах для использования при выполнении IEEE 802.15.4 Сканирование энергии.
  • destination : адрес назначения IPv6 для сообщения. Сообщение может быть многоадресной рассылкой.

Примеры

commissioner energy 0x00050000 2 32 1000 fdde:ad00:beef:0:0:ff:fe00:c00
Done
Energy: 00050000 0 0 0 0

Ссылки CLI и API

Идентификатор комиссара (Get, Set)

Получает или устанавливает имя идентификатора комиссара Openthread.

Параметры

commissioner id name

Примеры

commissioner id OpenThread Commissioner
Done
commissioner id
OpenThread Commissioner
Done

Ссылки CLI и API

Уполномоченный, Стоинер ADD

Добавляет запись столяра.

Параметры

commissioner joiner add eui64|discerner pksd [timeout]
  • eui64 : IEEE EUI-64 Столярь. Чтобы соответствовать любому столяру, используйте * .
  • discerner : Сторонник проницательна в number/length формата.
  • pksd : предварительный ключ для столяра.
  • timeout : тайм -аут столяра за считанные секунды.

Примеры

commissioner joiner add d45e64fa83f81cf7 J01NME
Done
commissioner joiner add 0xabc/12 J01NME
Done

Ссылки CLI и API

Уполномоченный уполномоченный

Удаляет запись столяра.

Параметры

commissioner joiner remove eui64|discerner
  • eui64 : IEEE EUI-64 Столярь. Чтобы соответствовать любому столяру, используйте * .
  • discerner : Сторонник проницательна в number/length формата.

Примеры

commissioner joiner remove d45e64fa83f81cf7
Done
commissioner joiner remove 0xabc/12
Done

Ссылки CLI и API

Уполномоченный стола

Перечисляет все записи столяра в формате таблицы.

Параметры

Никаких параметров.

Примеры

commissioner joiner table
| ID                    | PSKd                             | Expiration |
+-----------------------+----------------------------------+------------+
|                     * |                           J01NME |      81015 |
|      d45e64fa83f81cf7 |                           J01NME |     101204 |
| 0x0000000000000abc/12 |                           J01NME |     114360 |
Done

Ссылки CLI и API

  • Нет связанных API

Комиссар Mgmtget

Отправляет сообщению MGMT_GET (Management Get) лидеру. Значения переменных, которые были установлены с использованием команды commissioner mgmtset , возвращаются.

Параметры

commissioner mgmtget [locator] [sessionid] [steeringdata] [joinerudpport] [-x TLVs]
  • locator : пограничный маршрутизатор RLOC16.
  • sessionid : идентификатор сессии комиссара.
  • steeringdata : Рулевые данные.
  • joinerudpport : столяр UDP -порт.
  • TLVs : набор TLV, которые будут извлечены.

Примеры

commissioner mgmtget locator sessionid
Done

Ссылки CLI и API

Комиссар Mgmtset

Отправляет сообщению MGMT_SET (набор управления) лидеру и устанавливает переменные на указанные значения.

Параметры

commissioner mgmtset [locator locator] [sessionid sessionid] [steeringdata steeringdata] [joinerudpport joinerudpport] [-x TLVs]
  • locator : пограничный маршрутизатор RLOC16.
  • sessionid : идентификатор сессии комиссара.
  • steeringdata : Рулевые данные.
  • joinerudpport : столяр UDP -порт.
  • TLVs : набор TLV, которые будут извлечены.

Примеры

commissioner mgmtset joinerudpport 9988
Done

Ссылки CLI и API

Комиссар Панид

Отправляет запрос на идентификатор PAN. Вывод команды возвращается по мере его получения.

Параметры

commissioner panid panid mask destination
  • paind : PAN ID для использования для проверки конфликтов.
  • mask ; Bitmask, которая идентифицирует каналы для выполнения IEEE 802.15.4 Active Scans.
  • destination : адрес назначения IPv6 для сообщения. Сообщение может быть многоадресной рассылкой.

Примеры

commissioner panid 0xdead 0x7fff800 fdde:ad00:beef:0:0:ff:fe00:c00
Done
Conflict: dead, 00000800

Ссылки CLI и API

Комиссар Provisioningurl

Устанавливает URL -адрес Уполномоченного комиссара.

Параметры

commissioner provisioningurl provisioningurl

Примеры

commissioner provisioningurl http://github.com/openthread/openthread
Done

Ссылки CLI и API

Комиссар SessionId

Получает текущий идентификатор сессии комиссара.

Параметры

Никаких параметров.

Примеры

commissioner sessionid
0
Done

Ссылки CLI и API

Комиссар старт

Запускает роль комиссара.

Параметры

Никаких параметров.

Примеры

commissioner start
Commissioner: petitioning
Done
Commissioner: active

Ссылки CLI и API

государство комиссара

Возвращает текущее состояние комиссара. Возможные значения являются active , disabled или petition (ходатайство стать комиссаром).

Параметры

Никаких параметров.

Примеры

commissioner state
active
Done

Ссылки CLI и API

Комиссар остановится

Остановит роль комиссара.

Параметры

Никаких параметров.

Примеры

commissioner stop
Done

Ссылки CLI и API

contextreusedelay (get, set)

Получает или устанавливает значение CONTEXT_ID_REUSE_DELAY .

Параметры

contextreusedelay delay

Используйте необязательный аргумент delay , чтобы установить CONTEXT_ID_REUSE_DELAY .

Примеры

contextreusedelay
11
Done
contextreusedelay 11
Done

Ссылки CLI и API

счетчики (Mac)

Получите счетчики слоя Mac.

Параметры

counters mac

Примеры

counters mac
TxTotal: 10
   TxUnicast: 3
   TxBroadcast: 7
   TxAckRequested: 3
   TxAcked: 3
   TxNoAckRequested: 7
   TxData: 10
   TxDataPoll: 0
   TxBeacon: 0
   TxBeaconRequest: 0
   TxOther: 0
   TxRetry: 0
   TxErrCca: 0
   TxErrBusyChannel: 0
RxTotal: 2
   RxUnicast: 1
   RxBroadcast: 1
   RxData: 2
   RxDataPoll: 0
   RxBeacon: 0
   RxBeaconRequest: 0
   RxOther: 0
   RxAddressFiltered: 0
   RxDestAddrFiltered: 0
   RxDuplicated: 0
   RxErrNoFrame: 0
   RxErrNoUnknownNeighbor: 0
   RxErrInvalidSrcAddr: 0
   RxErrSec: 0
   RxErrFcs: 0
   RxErrOther: 0
Done

Ссылки CLI и API

счетчики (MLE)

Получил речь потоки MLE.

Параметры

counters mle

Примеры

counters mle
Role Disabled: 0
Role Detached: 1
Role Child: 0
Role Router: 0
Role Leader: 1
Attach Attempts: 1
Partition Id Changes: 1
Better Partition Attach Attempts: 0
Parent Changes: 0
Done

Ссылки CLI и API

счетчики

Получает поддерживаемые встречные имена.

Параметры

Никаких параметров.

Примеры

counters
ip
mac
mle
Done

Ссылки CLI и API

  • Нет связанных API

счетчики IP

Получает счетчики IPv6.

Параметры

counters ip

Примеры

counters ip
TxSuccess: 10
TxFailed: 0
RxSuccess: 5
RxFailed: 0
Done

Ссылки CLI и API

счетчики IP Reset

Сбрасывает счетчики IPv6.

Параметры

counters ip reset

Примеры

counters ip reset
Done

Ссылки CLI и API

счетчики Mac Reset

Сбрасывает счетчики слоя Mac.

Параметры

counters mac reset

Примеры

counters mac reset
Done

Ссылки CLI и API

счетчики MLE Reset

Сбрасывает прилавки MLE.

Параметры

counters mle reset

Примеры

counters mle reset
Done

Ссылки CLI и API

CSL -канал

Устанавливает канал CSL.

Параметры

csl channel channel

Примеры

csl channel 20
Done

Ссылки CLI и API

csl

Получает конфигурацию CSL.

Параметры

Никаких параметров.

Примеры

csl
Channel: 11
Period: 160000us
Timeout: 1000s
Done

Ссылки CLI и API

период CSL

Устанавливает период CSL в микросекундах.

Отключить CSL, установив этот параметр на 0 .

Период CSL должен быть кратным OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC , в противном случае возвращается OT_ERROR_INVALID_ARGS .

Параметры

csl period period

Примеры

csl period 3000000
Done

Ссылки CLI и API

CSL Timeout

Устанавливает тайм -аут CSL за считанные секунды.

Параметры

csl timeout timeout

Примеры

cls timeout 10
Done

Ссылки CLI и API

Набор данных Active

Получает активный операционный набор данных.

OT CLI использует участники OtoperationalDataset для возврата значений наборов данных в консоли.

Параметры

dataset active [-x]

Необязательный аргумент -x печатает активные значения набора данных оперативного набора данных в виде шестиугольника TLV.

Примеры

dataset active
Active Timestamp: 1
Channel: 13
Channel Mask: 0x07fff800
Ext PAN ID: d63e8e3e495ebbc3
Mesh Local Prefix: fd3d:b50b:f96d:722d::/64
Network Key: dfd34f0f05cad978ec4e32b0413038ff
Network Name: OpenThread-8f28
PAN ID: 0x8f28
PSKc: c23a76e98f1a6483639b1ac1271e2e27
Security Policy: 0, onrcb
Done
dataset active -x
0e08000000000001000000030000103506000...3023d82c841eff0e68db86f35740c030000ff
Done

Ссылки CLI и API

DataCate ActiveMestamp (get, set)

Получает или устанавливает OtoperationalDataset :: MactiveTimestamp .

Параметры

dataset activetimestamp [timestamp]

Передайте необязательный аргумент timestamp , чтобы установить активную временную метку.

Примеры

dataset activetimestamp
123456789
Done
dataset activetimestamp 123456789
Done

Ссылки CLI и API

  • Нет связанных API

канал набора данных (get, set)

Получает или устанавливает OtoperationalDataset :: MCHANLEN .

Параметры

dataset channel [channel-num]

Используйте необязательный аргумент channel-num чтобы установить канал.

Примеры

dataset channel
12
Done
dataset channel 12
Done

Ссылки CLI и API

  • Нет связанных API

Набор данных канала (get, set)

Получает или устанавливает OtoperationalDataset :: mChannelmask

Параметры

dataset channelmask [channel-mask]

Используйте дополнительный аргумент channel-mask чтобы установить маску канала.

Примеры

dataset channelmask
0x07fff800
Done
dataset channelmask 0x07fff800
Done

Ссылки CLI и API

  • Нет связанных API

Набор данных Clear

Сбросить буфер набора данных эксплуатации.

Параметры

Никаких параметров.

Примеры

dataset clear
Done

Ссылки CLI и API

  • Нет связанных API

Комплект набора данных Active

Заверните буфер набора данных операционного набора данных в активном операционном наборе данных.

Параметры

Никаких параметров.

Примеры

dataset commit active
Done

Ссылки CLI и API

Комплект набора данных в ожидании

Выполните буфер наборов данных в ожидании оперативного набора данных.

Параметры

Никаких параметров.

Примеры

dataset commit pending
Done

Ссылки CLI и API

Задержка набора данных (get, set)

Получает или устанавливает otoperationaldataset :: mdelay .

Параметры

dataset delay [delay]

Используйте необязательный аргумент delay , чтобы установить значение таймера задержки.

Примеры

dataset delay
1000
Done
dataset delay 1000
Done

Ссылки CLI и API

DataCate Extpanid (get, set)

Получает или устанавливает OtoperationalDataset :: mextendenpanid .

Параметры

dataset extpanid [extpanid]

Используйте необязательный аргумент extpanid , чтобы установить расширенный идентификатор сети личной области.

Примеры

dataset extpanid
000db80123456789
Done
dataset extpanid 000db80123456789
Done

Ссылки CLI и API

Справка набора данных

Получает список команд CLI dataset . Для получения дополнительной информации обратитесь к отображению и управлению наборами данных с OT CLI .

Параметры

Никаких параметров.

Примеры

dataset help
help
active
activetimestamp
channel
channelmask
clear
commit
delay
extpanid
init
meshlocalprefix
mgmtgetcommand
mgmtsetcommand
networkkey
networkname
panid
pending
pendingtimestamp
pskc
securitypolicy
set
tlvs
Done

Ссылки CLI и API

  • Нет связанных API

DataSet init (Active, New, Onding, TLVS)

OT CLI проверяет для active , pending или tlvs и возвращает соответствующие значения. В противном случае OT CLI создает новую, случайную сеть и возвращает новый набор данных.

Параметры

dataset init {active|new|pending|tlvs} [hex-encoded-tlvs]

Используйте new для инициализации нового набора данных, затем введите dataset commit active . Используйте tlvs для HEX-кодируемых TLV.

Примеры

dataset init new
Done

Ссылки CLI и API

Набор данных meshlocalprefix (get, set)

Получает или устанавливает OtoperationalDataset :: MMESHLOCALPREFIX .

Параметры

dataset meshlocalprefix [meshlocalprefix]

Используйте дополнительный аргумент meshlocalprefix , чтобы установить сетку-локальный префикс.

Примеры

dataset meshlocalprefix
fd00:db8:0:0::/64
Done
dataset meshlocalprefix fd00:db8:0:0::
Done

Ссылки CLI и API

  • Нет связанных API

Набор данных MgmtgetCommand Active

Отправляет mgmt_active_get.

OT CLI отправляет mgmt_active_get с соответствующими аргументами. Чтобы узнать больше об этих параметрах и сопоставлениях аргументов, обратитесь к отображению и управлению наборами данных с OT CLI .

Параметры

dataset mgmtgetcommand active [address leader-address] [dataset-components] [-x tlv-list]
  • Используйте address для указания пункта назначения IPv6; В противном случае лидер ALOC используется в качестве дефолта.
  • Для dataset-components вы можете передать любую комбинацию OtoperationalDatasetComponents , например, activetimestamp , pendingtimestamp или networkkey .
  • Необязательный аргумент -x определяет необработанные TLV для запроса.

Примеры

dataset mgmtgetcommand active address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp securitypolicy
Done
dataset mgmtgetcommand active networkname
Done

Ссылки CLI и API

Набор данных MgmtgetCommand ожидает рассмотрения

Отправляет mgmt_pending_get.

Параметры

dataset mgmtgetcommand pending [address leader-address] [dataset-components] [-x tlv-list]

Чтобы узнать больше об этих параметрах и сопоставлениях аргументов, обратитесь к отображению и управлению наборами данных с OT CLI .

Примеры

dataset mgmtgetcommand pending address fdde:ad00:beef:0:558:f56b:d688:799 activetimestamp securitypolicy
Done
dataset mgmtgetcommand pending networkname
Done

Ссылки CLI и API

Набор данных mgmtsetCommand Active

Отправляет mgmt_active_set.

Параметры

dataset mgmtsetcommand active [dataset-components] [-x tlv-list]

Чтобы узнать больше об этих параметрах и сопоставлениях аргументов, обратитесь к отображению и управлению наборами данных с OT CLI .

Примеры

dataset mgmtsetcommand active activetimestamp 123 securitypolicy 1 onrcb
Done

Ссылки CLI и API

Набор данных MgmtsetCommand ожидает рассмотрения

Отправляет mgmt_pending_set.

Параметры

dataset mgmtsetcommand pending [dataset-components] [-x tlv-list]

Чтобы узнать больше об этих параметрах и сопоставлениях аргументов, обратитесь к отображению и управлению наборами данных с OT CLI .

Примеры

dataset mgmtsetcommand pending activetimestamp 123 securitypolicy 1 onrcb
Done

Ссылки CLI и API

DataSet NetworkKey (Get, SET)

Получает или устанавливает OtoperationalDataset :: MnetWorkKey .

Параметры

dataset networkkey [key]

Используйте необязательный аргумент key , чтобы установить сетевой ключ.

Примеры

dataset networkkey
00112233445566778899aabbccddeeff
Done
dataset networkkey 00112233445566778899aabbccddeeff
Done

Ссылки CLI и API

  • Нет связанных API

DataSet NetworkName (GET, SET)

Получает или устанавливает OtoperationalDataset :: MnetWorkName .

Параметры

dataset networkname [name]

Используйте дополнительный аргумент name , чтобы установить имя сети.

Примеры

dataset networkname
OpenThread
Done
dataset networkname OpenThread
Done

Ссылки CLI и API

Панид набора данных (GET, SET)

Получает или устанавливает OtoperationalDataset :: mpanid .

Параметры

dataset panid [panid]

Используйте дополнительный panid аргумент, чтобы установить идентификатор PAN.

Примеры

dataset panid
0x1234
Done
dataset panid 0x1234
Done

Ссылки CLI и API

  • Нет связанных API

Набор данных tenditimestamp (get, set)

Получает или устанавливает OtoperationalDataset :: MpendingTimeStamp .

Параметры

dataset pendingtimestamp [timestamp]

Используйте необязательный аргумент timestamp , чтобы установить ожидающую секунду временной метки.

Примеры

dataset pendingtimestamp
123456789
Done
dataset pendingtimestamp 123456789
Done

Ссылки CLI и API

  • Нет связанных API

Набор данных PSKC (GET, SET)

Получает или устанавливает OtoperationalDataset :: MPSKC .

Параметры

dataset pskc [-p passphrase] | [key]

Только для FTD используйте -p с аргументом passphrase . -p генерирует PSKC из кодированной UTF-8 passphrase , который вы предоставляете, вместе с именем сети и расширенным идентификатором PAN. Если установлено, -p использует буфер набора данных; В противном случае он использует текущий стек. В качестве альтернативы, вы можете установить PSKC как key (шестнадцатеричный формат).

Примеры

dataset pskc
67c0c203aa0b042bfb5381c47aef4d9e
Done
dataset pskc -p 123456
Done
dataset pskc 67c0c203aa0b042bfb5381c47aef4d9e
Done

Ссылки CLI и API

  • Нет связанных API

DataCate SecurityPolicy (Get, SET)

Получает или устанавливает политику безопасности наборов данных.

Параметры

dataset securitypolicy [rotationtime [onrcCepR]]

Примеры

dataset securitypolicy
672 onrc
Done
dataset securitypolicy 672 onrc
Done

Ссылки CLI и API

  • Нет связанных API

Набор набора данных (Active, ожидает)

Устанавливает активный операционный набор данных.

Если набор данных не включает активную метку времени, набор данных только частично завершен.

Если поток включен на устройство, которое имеет частично полный набор данных, устройство попытается прикрепить к существующей сети потоков, используя любую существующую информацию в наборе данных. Только сетевая сетевая клавиша необходима для прикрепления к сети.

Если канал не включен в набор данных, устройство отправит сообщения MLE по разным каналам, чтобы найти соседей на других каналах.

Если устройство успешно подключается к сети потоков, устройство будет затем извлекать полный активный набор данных от своего родителя. Обратите внимание, что устройство, способствующее маршрутизаторам, не будет переходить на роли маршрутизатора или лидера, пока не получит полный активный набор данных.

Команда dataset set CLI устанавливает активное рабочее набор данных с использованием кодируемых шестигранными TLV.

Параметры

dataset set {active|pending} tlvs

Примеры

dataset set active 0e08000000000001000000030000103506000...3023d82c841eff0e68db86f35740c030000ff
Done
dataset set pending 0e08000000000001000000030000103506000...3023d82c841eff0e68db86f35740c030000ff
Done

Ссылки CLI и API

Набор данных TLVS

Преобразует заданный операционный набор данных в otOperationalDatasetTlvs .

Параметры

Никаких параметров.

Примеры

dataset tlvs
0e080000000000010000000300001635060004001fffe0020...f7f8
Done

Ссылки CLI и API

Отмена набора данных

Отменяет постоянный (если есть) запрос на обновление набора данных.

Доступно при включении OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

Параметры

Никаких параметров.

Примеры

@dataset updater cancel
Done

Ссылки CLI и API

Обновление данных

Указывает, существует ли постоянный запрос обновления набора данных операции.

Доступно при включении OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

Параметры

Никаких параметров.

Примеры

dataset updater
Enabled
Done

Ссылки CLI и API

Запуск набора данных

Запрашивает обновление для оперативного набора данных.

Доступно при включении OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

aDataset должен содержать поля, которые должны быть обновлены и их новое значение. Он не должен содержать активные или ожидающие поля временной метки. Поле задержки является необязательным, если не предоставлено значение по умолчанию (1000 мс).

Параметры

Никаких параметров.

Примеры

channel
19
Done
dataset clear
Done
dataset channel 15
Done
dataset
Channel: 15
Done
dataset updater start
Done
dataset updater
Enabled
Done
Dataset update complete: OK
channel
15
Done

Ссылки CLI и API

отлаживать

Выполняет серию команд CLI, чтобы собрать информацию о сети устройств и потоков. Это предназначено для отладки. Вывод будет отображать каждую выполненную команду CLI, которому предшествовала $ , после чего сгенерированный вывод соответствующей команды. Сгенерированный вывод охватывает следующую информацию:

  • Версия
  • Текущее состояние
  • RLOC16, расширенный MAC -адрес
  • Список адресов IPv6 с одноадресной и многоадресной расстояния
  • Канал
  • Идентификатор сковороды и расширенный идентификатор сковороды
  • Сетевые данные
  • Идентификатор раздела
  • Лидерские данные

Если устройство работает как FTD:

  • Ребенок и сосед
  • Таблица маршрутизатора и информация о следующем прыжке
  • Таблица кеша адреса
  • Зарегистрированный адрес MTD Child IPv6
  • Свойства устройства

Если устройство поддерживает и действует как клиент SRP:

  • SRP Client Cathate
  • SRP клиентские услуги и информация об хосте

Если устройство поддерживает и действует как SRP SEAR:

  • Сервер SRP Server и режим адреса
  • SRP -сервер зарегистрированных хостов и сервисов

Если устройство поддерживает TREL:

  • Статус следов и таблица сверстников

Если устройство поддерживает и действует как пограничный маршрутизатор:

  • BR состояние
  • Префиксы BR (OMR, On-Link, NAT64)
  • Обнаруженная таблица префикса

Параметры

Никаких параметров.

Примеры

Ссылки CLI и API

  • Нет связанных API

DolementTimermin (SET)

Устанавливает минимальный таймер задержки (в секундах).

Параметры

delaytimermin delaytimermin

Примеры

delaytimermin 60
Done

Ссылки CLI и API

Задержка

Получите минимальный таймер задержки (в секундах).

Параметры

Никаких параметров.

Примеры

delaytimermin
30
Done

Ссылки CLI и API

Отметьте асинхронность

Начните изящный процесс отсоединения, аналогичный команде detach , не блокируя и ожидая обратного вызова, указывающего на то, что отделка закончена.

Параметры

Никаких параметров.

Примеры

detach async
Done

Ссылки CLI и API

отделить

Начните изящный процесс отсоединения, сначала уведомляя другие узлы (отправка адреса адреса, если действует в качестве маршрутизатора, или установите значение тайм -аута для дочернего времени на ноль на родителе, если действует в детстве), а затем останавливая работу протокола потока.

Параметры

Никаких параметров.

Примеры

detach
Finished detaching
Done

Ссылки CLI и API

DeviceProps (SET)

Устанавливает свойства устройства.

Параметры

deviceprops powerSupply isBr supportsCcm isUnstable weightAdjustment

powerSupply : должен быть «батарея», «внешняя», «внешняя стабильная», «внешняя неработающая».

Примеры

deviceprops battery 0 0 0 -5
Done
deviceprops
PowerSupply      : battery
IsBorderRouter   : no
SupportsCcm      : no
IsUnstable       : no
WeightAdjustment : -5
Done

Ссылки CLI и API

DeviceProps

Получите текущие свойства устройства.

Требуется OPENTHREAD_CONFIG_MLE_DEVICE_PROPERTY_LEADER_WEIGHT_ENABLE .

Параметры

Никаких параметров.

Примеры

deviceprops
PowerSupply      : external
IsBorderRouter   : yes
SupportsCcm      : no
IsUnstable       : no
WeightAdjustment : 0
Done

Ссылки CLI и API

обнаружить

Выполните операцию обнаружения MLE.

Параметры

discover [channel]

channel : канал, чтобы открыть для себя. Если канал не будет предоставлен, обнаружение будет охватывать все действительные каналы.

Примеры

discover
| J | Network Name     | Extended PAN     | PAN  | MAC Address      | Ch | dBm | LQI |
+---+------------------+------------------+------+------------------+----+-----+-----+
| 0 | OpenThread       | dead00beef00cafe | ffff | f1d92a82c8d8fe43 | 11 | -20 |   0 |
Done

Ссылки CLI и API

Откройте для себя reqcallback (включить, отключить)

Устанавливает обратный вызов для получения данных запроса на обнаружение MLE.

Параметры

discover reqcallback enable|disable

Примеры

discover reqcallback enable
Done

Ссылки CLI и API

DNS просмотр

Отправить запрос DNS для просмотра (перечисление экземпляра службы), чтобы получить список услуг для данного имени службы.

Параметры после service-name являются необязательными. Любое неопределенное (или нулевое) значение для этих необязательных параметров заменяется значением из текущей конфигурации по умолчанию ( dns config ).

Параметры

dns browse service-name [dns-server-IP] [dns-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

Примеры

dns browse _service._udp.example.com
DNS browse response for _service._udp.example.com.
inst1
    Port:1234, Priority:1, Weight:2, TTL:7200
    Host:host.example.com.
    HostAddress:fd00:0:0:0:0:0:0:abcd TTL:7200
    TXT:[a=6531, b=6c12] TTL:7300
instance2
    Port:1234, Priority:1, Weight:2, TTL:7200
    Host:host.example.com.
    HostAddress:fd00:0:0:0:0:0:0:abcd TTL:7200
    TXT:[a=1234] TTL:7300
Done
dns browse _airplay._tcp.default.service.arpa
DNS browse response for _airplay._tcp.default.service.arpa.
Mac mini
    Port:7000, Priority:0, Weight:0, TTL:10
    Host:Mac-mini.default.service.arpa.
    HostAddress:fd97:739d:386a:1:1c2e:d83c:fcbe:9cf4 TTL:10
Done

Ссылки CLI и API

сжатие DNS (включить, отключить)

Установите режим «Сжатие имени DNS».

По умолчанию сжатие имени DNS включено. При отключении имена DNS добавляются как полные и никогда не сжимаются. Это применимо к модулям DNS/SRP Client/SRP от OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Параметры

dns compression [enable|disable]

Примеры

dns compression enable
Enabled
dns compression disable
Done
dns compression
Disabled
Done

Ссылки CLI и API

DNS сжатие

Указывает, включен ли режим «Сжатие имен DNS» или нет.

Это предназначено только для тестирования и доступно при включении конфигурации OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

По умолчанию сжатие имени DNS включено. При отключении имена DNS добавляются как полные и никогда не сжимаются. Это применимо к модулям DNS/SRP Client/SRP от OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

Параметры

dns compression [enable|disable]

Примеры

dns compression
Enabled

Ссылки CLI и API

DNS Config (SET)

Устанавливает конфигурацию запроса по умолчанию на DNS Client.

В не нулевом aConfig вызывающий абонент может выбрать оставить некоторые поля в экземпляре otDnsQueryConfig . Неопределенные поля заменяются соответствующими определениями опции конфигурации OT OPENTHREAD_CONFIG_DNS_CLIENT DEFAULT {} для формирования конфигурации запроса по умолчанию.

Когда OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_ADDRESS_AUTO_SET_ENABLE включен, адрес IPv6 сервера в конфигурации по умолчанию устанавливается и обновляется DNS Client. Это делается только тогда, когда пользователь явно не устанавливает и не указывает его. Такое поведение требует, чтобы клиент SRP и его функция автоматического начала были включены. Затем клиент SRP будет контролировать сетевые данные потоков для записей службы DNS/SRP, чтобы выбрать сервер SRP. Выбранный адрес SRP -сервера также устанавливается в качестве адреса DNS -сервера в конфигурации по умолчанию.

Мы можем оставить некоторые поля как неопределенные (или использовать значение ноль). Неопределенные поля заменяются соответствующими определениями опции конфигурации OT OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT чтобы сформировать конфигурацию запроса по умолчанию. OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE требуется.

Параметры

dns config [dns-server-IP] [dns-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean] [service-mode]

Примеры

dns config fd00::1 1234 5000 2 0
Done
dns config
Server: [fd00:0:0:0:0:0:0:1]:1234
ResponseTimeout: 5000 ms
MaxTxAttempts: 2
RecursionDesired: no
Done
dns config fd00::2
Done
dns config
Server: [fd00:0:0:0:0:0:0:2]:53
ResponseTimeout: 3000 ms
MaxTxAttempts: 3
RecursionDesired: yes
Done

Ссылки CLI и API

DNS config

Получает текущую конфигурацию запроса по умолчанию, используемую DNS Client.

Когда начинается стек OpenthRead, конфигурация запроса DNS по умолчанию определяется из набора параметров конфигурации OT, такого как OPENTHREAD_CONFIG_DNS_CLIENT_DEFAULT_SERVER_IP6_ADDRESS , _DEFAULT_SERVER_PORT , _DEFAULT_RESPONSE_TIMEOUT и т. Д. (See config/dns_client.h .

Конфигурация включает в себя сервер IPv6 -адрес и порт, тайм -аут ответа в MSEC (время ожидания от ответа RX), максимальные попытки TX перед отчетом об отказе, логический флаг, чтобы указать, может ли сервер разрешить запрос повторно или нет. OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE требуется.

Параметры

Никаких параметров.

Примеры

dns config
Server: [fd00:0:0:0:0:0:0:1]:1234
ResponseTimeout: 5000 ms
MaxTxAttempts: 2
RecursionDesired: no
ServiceMode: srv
Nat64Mode: allow
Done

Ссылки CLI и API

DNS разрешается

Отправляет запрос DNS -разрешения адреса для записи AAAA (IPv6) для данного имени хоста.

aConfig может быть нулевым. В этом случае конфигурация по умолчанию (из otDnsClientGetDefaultConfig() ) будет использоваться в качестве конфигурации для этого запроса. В ненулевом aConfig некоторые поля могут быть оставлены неопределенными (ноль значения). Неопределенные поля затем заменяются значениями из конфигурации по умолчанию.

Отправьте DNS -запрос, чтобы получить адрес IPv6 для данного имени хоста.

Параметры после имени хоста являются необязательными. Любое неопределенное (или нулевое) значение для этих необязательных параметров заменяется значением из текущей конфигурации по умолчанию (DNS Config).

IP DNS Server может быть адресом IPv4, который будет синтезирован с адресом IPv6 с использованием предпочтительного префикса NAT64 из сетевых данных.

Параметры

dns resolve hostname [dns-server-IP] [dns-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

Примеры

dns resolve ipv6.google.com
DNS response for ipv6.google.com - 2a00:1450:401b:801:0:0:0:200e TTL: 300
dns resolve example.com 8.8.8.8
Synthesized IPv6 DNS server address: fdde:ad00:beef:2:0:0:808:808
DNS response for example.com. - fd4c:9574:3720:2:0:0:5db8:d822 TTL:20456
Done

Ссылки CLI и API

DNS Service

Запускает разрешение экземпляра службы DNS для данного экземпляра службы.

Доступен при включении OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE .

aConfig может быть нулевым. В этом случае конфигурация по умолчанию (из otDnsClientGetDefaultConfig() ) будет использоваться в качестве конфигурации для этого запроса. В ненулевом aConfig некоторые поля могут быть оставлены неопределенными (ноль значения). Неопределенные поля затем заменяются значениями из конфигурации по умолчанию.

Функция отправляет запросы для записей SRV и/или TXT для данного экземпляра службы. Поле mServiceMode в otDnsQueryConfig определяет, какие записи запроса (только SRV, только TXT или SRV и TXT) и как выполнить запрос (вместе в одном и том же сообщении, отдельно параллельно или в оптимизированном режиме, где клиент будет пробовать в то же самое сообщение сначала, а затем отдельно, если оно не может получить ответ).

Запись SRV содержит информацию о порте обслуживания, приоритете и весах вместе с именем хоста, связанным с экземпляром службы. Эта функция не выполняет разрешение адреса для имени хоста, обнаруженного из записи SRV. Сервер/Resolver может предоставить AAAA/A Записи (ы) для имени хоста в разделе «Дополнительные данные» ответа на запрос SRV/TXT, и эту информацию можно получить с использованием otDnsServiceResponseGetServiceInfo() в otDnsServiceCallback . Пользователи этого API не должны предполагать, что адрес хоста всегда будет доступен от otDnsServiceResponseGetServiceInfo() .

Отправить запрос DNS разрешения экземпляра службы для данного экземпляра службы. Сначала предоставлена ​​метка экземпляра службы, за которым следует имя службы (обратите внимание, что метка экземпляра службы может содержать точку '.' Символ).

Параметры после service-name являются необязательными. Любое неопределенное (или нулевое) значение для этих необязательных параметров заменяется значением из текущей конфигурации по умолчанию ( dns config ).

Параметры

dns service service-instance-label service-name [DNS-server-IP] [DNS-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

Примеры

Ссылки CLI и API

DNS ServiceHost

Запускает разрешение экземпляра службы DNS для данного экземпляра службы с потенциальным последующим разрешением адреса для имени хоста, обнаруженного для экземпляра службы.

Доступен при включении OPENTHREAD_CONFIG_DNS_CLIENT_SERVICE_DISCOVERY_ENABLE .

aConfig может быть нулевым. В этом случае конфигурация по умолчанию (из otDnsClientGetDefaultConfig() ) будет использоваться в качестве конфигурации для этого запроса. В ненулевом aConfig некоторые поля могут быть оставлены неопределенными (ноль значения). Неопределенные поля затем заменяются значениями из конфигурации по умолчанию. Эта функция не может быть использована с mServiceMode в DNS CONFIG SIGN в OT_DNS_SERVICE_MODE_TXT (то есть запрос только для записи TXT) и будет возвращать OT_ERROR_INVALID_ARGS .

Ведет себя аналогично otDnsClientResolveService() отправка запросов для записей SRV и TXT. Однако, если сервер/резольвер не предоставляет записи AAAA/A для имени хоста в ответе на запрос SRV (в разделе дополнительных данных), он выполнит разрешение имени хоста (отправка запроса AAAA) для обнаруженного имени хоста из Запись SRV. aCallback вызывается, когда получены ответы на все запросы (т.е. как разрешение адресов, так и адреса хоста завершено).

Отправьте запрос DNS-резолюции экземпляра службы для данного экземпляра службы с потенциальным разрешением имени хоста последующего последующего. Сначала предоставлена ​​метка экземпляра службы, за которым следует имя службы (обратите внимание, что метка экземпляра службы может содержать точку '.' Символ).

Параметры после service-name являются необязательными. Любое неопределенное (или нулевое) значение для этих необязательных параметров заменяется значением из текущей конфигурации по умолчанию ( dns config ).

Параметры

dns servicehost service-instance-label service-name [DNS-server-IP] [DNS-server-port] [response-timeout-ms] [max-tx-attempts] [recursion-desired-boolean]

Примеры

Ссылки CLI и API

DomainName (set)

Устанавливает имя домена потока.

Only succeeds when Thread protocols are disabled.

Parameters

domainname name

Use a backslash to escape spaces.

Примеры

domainname Test\ Thread
Done

CLI and API References

доменное имя

Gets the Thread Domain Name.

Parameters

Никаких параметров.

Примеры

domainname
Thread
Done

CLI and API References

dua iid (set,clear)

Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.

Available when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Parameters

dua iid iid|clear

dua iid clear passes a nullptr to otThreadSetFixedDuaInterfaceIdentifier . Otherwise, you can pass the iid .

Примеры

dua iid 0004000300020001
Done
dua iid clear
Done

CLI and API References

dua iid

Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.

Available when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Parameters

Никаких параметров.

Примеры

dua iid
0004000300020001
Done

CLI and API References

eidcache

Returns the EID-to-RLOC cache entries.

Parameters

Никаких параметров.

Примеры

eidcache
fd49:caf4:a29f:dc0e:97fc:69dd:3c16:df7d 2000 cache canEvict=1 transTime=0 eid=fd49:caf4:a29f:dc0e:97fc:69dd:3c16:df7d
fd49:caf4:a29f:dc0e:97fc:69dd:3c16:df7f fffe retry canEvict=1 timeout=10 retryDelay=30
Done

CLI and API References

eui64

Gets the factory-assigned IEEE EUI-64 for this interface.

Parameters

Никаких параметров.

Примеры

eui64
0615aae900124b00
Done

CLI and API References

extaddr (set)

Sets the IEEE 802.15.4 Extended Address.

Parameters

extaddr extaddr

Примеры

extaddr dead00beef00cafe
dead00beef00cafe
Done

CLI and API References

extaddr

Gets the IEEE 802.15.4 Extended Address.

Parameters

Никаких параметров.

Примеры

extaddr
dead00beef00cafe
Done

CLI and API References

extpanid (set)

Sets the IEEE 802.15.4 Extended PAN ID.

Параметры

extpanid extpanid

Примеры

extpanid dead00beef00cafe
Done

CLI and API References

extpanid

Gets the IEEE 802.15.4 Extended PAN ID.

Parameters

Никаких параметров.

Примеры

extpanid
dead00beef00cafe
Done

CLI and API References

сброс к заводским настройкам

Deletes all the settings stored on non-volatile memory, and then triggers a platform reset.

Parameters

Никаких параметров.

Примеры

factoryreset

CLI and API References

fake (a,an)

Sends fake Thread messages.

Available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Parameters

fake /a/an dst-ipaddr target meshLocalIid

Примеры

fake /a/an fdde:ad00:beef:0:0:ff:fe00:a800 fd00:7d03:7d03:7d03:55f2:bb6a:7a43:a03b 1111222233334444
Done

CLI and API References

фем

Gets external FEM parameters.

Parameters

Никаких параметров.

Примеры

fem
LNA gain 11 dBm
Done

CLI and API References

fem lnagain (get)

Gets the external FEM's Rx LNA gain in dBm.

Parameters

Никаких параметров.

Примеры

fem lnagain
11
Done

CLI and API References

fem lnagain (set)

Sets the external FEM's Rx LNA gain in dBm.

Parameters

Никаких параметров.

Примеры

fem lnagain 8
Done

CLI and API References

history ipaddr

Displays the unicast IPv6 address history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Event: Possible values are Added or Removed .
  • Address/Prefix Length: Unicast address with its prefix length (in bits).
  • Origin: Possible value are thread , slaac , dhcp6 , or manual .
  • Scope: IPv6 address scope.
  • P: Preferred flag.
  • V: Valid flag.
  • RLOC (R): This flag indicates if the IPv6 address is a routing locator.

Parameters

history ipaddr [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history ipaddr
| Age                  | Event   | Address / Prefix Length                     | Origin |Scope| P | V | R |
+----------------------+---------+---------------------------------------------+--------+-----+---+---+---+
|         00:00:04.991 | Removed | 2001:dead:beef:cafe:c4cb:caba:8d55:e30b/64  | slaac  |  14 | Y | Y | N |
|         00:00:44.647 | Added   | 2001:dead:beef:cafe:c4cb:caba:8d55:e30b/64  | slaac  |  14 | Y | Y | N |
|         00:01:07.199 | Added   | fd00:0:0:0:0:0:0:1/64                       | manual |  14 | Y | Y | N |
|         00:02:17.885 | Added   | fdde:ad00:beef:0:0:ff:fe00:fc00/64          | thread |   3 | N | Y | N |
|         00:02:17.885 | Added   | fdde:ad00:beef:0:0:ff:fe00:5400/64          | thread |   3 | N | Y | Y |
|         00:02:20.107 | Removed | fdde:ad00:beef:0:0:ff:fe00:5400/64          | thread |   3 | N | Y | Y |
|         00:02:21.575 | Added   | fdde:ad00:beef:0:0:ff:fe00:5400/64          | thread |   3 | N | Y | Y |
|         00:02:21.575 | Added   | fdde:ad00:beef:0:ecea:c4fc:ad96:4655/64     | thread |   3 | N | Y | N |
|         00:02:23.904 | Added   | fe80:0:0:0:3c12:a4d2:fbe0:31ad/64           | thread |   2 | Y | Y | N |
Done
history ipaddr list 5
00:00:20.327 -> event:Removed address:2001:dead:beef:cafe:c4cb:caba:8d55:e30b prefixlen:64 origin:slaac scope:14 preferred:yes valid:yes rloc:no
00:00:59.983 -> event:Added address:2001:dead:beef:cafe:c4cb:caba:8d55:e30b prefixlen:64 origin:slaac scope:14 preferred:yes valid:yes rloc:no
00:01:22.535 -> event:Added address:fd00:0:0:0:0:0:0:1 prefixlen:64 origin:manual scope:14 preferred:yes valid:yes rloc:no
00:02:33.221 -> event:Added address:fdde:ad00:beef:0:0:ff:fe00:fc00 prefixlen:64 origin:thread scope:3 preferred:no valid:yes rloc:no
00:02:33.221 -> event:Added address:fdde:ad00:beef:0:0:ff:fe00:5400 prefixlen:64 origin:thread scope:3 preferred:no valid:yes rloc:yes
Done

CLI and API References

history ipmaddr

Displays the multicast IPv6 address history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Event: Possible values are Subscribed or Unsubscribed .
  • Multicast Address
  • Origin: Possible values are Thread or Manual .

Parameters

history ipmaddr [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history ipmaddr
| Age                  | Event        | Multicast Address                       | Origin |
+----------------------+--------------+-----------------------------------------+--------+
|         00:00:08.592 | Unsubscribed | ff05:0:0:0:0:0:0:1                      | Manual |
|         00:01:25.353 | Subscribed   | ff05:0:0:0:0:0:0:1                      | Manual |
|         00:01:54.953 | Subscribed   | ff03:0:0:0:0:0:0:2                      | Thread |
|         00:01:54.953 | Subscribed   | ff02:0:0:0:0:0:0:2                      | Thread |
|         00:01:59.329 | Subscribed   | ff33:40:fdde:ad00:beef:0:0:1            | Thread |
|         00:01:59.329 | Subscribed   | ff32:40:fdde:ad00:beef:0:0:1            | Thread |
|         00:02:01.129 | Subscribed   | ff03:0:0:0:0:0:0:fc                     | Thread |
|         00:02:01.129 | Subscribed   | ff03:0:0:0:0:0:0:1                      | Thread |
|         00:02:01.129 | Subscribed   | ff02:0:0:0:0:0:0:1                      | Thread |
Done
history ipmaddr list
00:00:25.447 -> event:Unsubscribed address:ff05:0:0:0:0:0:0:1 origin:Manual
00:01:42.208 -> event:Subscribed address:ff05:0:0:0:0:0:0:1 origin:Manual
00:02:11.808 -> event:Subscribed address:ff03:0:0:0:0:0:0:2 origin:Thread
00:02:11.808 -> event:Subscribed address:ff02:0:0:0:0:0:0:2 origin:Thread
00:02:16.184 -> event:Subscribed address:ff33:40:fdde:ad00:beef:0:0:1 origin:Thread
00:02:16.184 -> event:Subscribed address:ff32:40:fdde:ad00:beef:0:0:1 origin:Thread
00:02:17.984 -> event:Subscribed address:ff03:0:0:0:0:0:0:fc origin:Thread
00:02:17.984 -> event:Subscribed address:ff03:0:0:0:0:0:0:1 origin:Thread
00:02:17.984 -> event:Subscribed address:ff02:0:0:0:0:0:0:1 origin:Thread
Done

CLI and API References

history neighbor

Displays the neighbor history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Type: Child or Router .
  • Event: Possible values are Added , Removed , or Changed .
  • Расширенный адрес
  • RLOC16
  • Mode: MLE link mode. Возможные значения:
    • - : no flags set (rx-off-when-idle, minimal Thread device, stable network data).
    • r : rx-on-when-idle
    • d : Full Thread Device.
    • n : Full Network Data
  • Ave RSS: Average number of frames (in dBm) received from the neighbor at the time the entry was recorded.

Parameters

history neighbor [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history neighbor
| Age                  | Type   | Event     | Extended Address | RLOC16 | Mode | Ave RSS |
+----------------------+--------+-----------+------------------+--------+------+---------+
|         00:00:29.233 | Child  | Added     | ae5105292f0b9169 | 0x8404 | -    |     -20 |
|         00:01:38.368 | Child  | Removed   | ae5105292f0b9169 | 0x8401 | -    |     -20 |
|         00:04:27.181 | Child  | Changed   | ae5105292f0b9169 | 0x8401 | -    |     -20 |
|         00:04:51.236 | Router | Added     | 865c7ca38a5fa960 | 0x9400 | rdn  |     -20 |
|         00:04:51.587 | Child  | Removed   | 865c7ca38a5fa960 | 0x8402 | rdn  |     -20 |
|         00:05:22.764 | Child  | Changed   | ae5105292f0b9169 | 0x8401 | rn   |     -20 |
|         00:06:40.764 | Child  | Added     | 4ec99efc874a1841 | 0x8403 | r    |     -20 |
|         00:06:44.060 | Child  | Added     | 865c7ca38a5fa960 | 0x8402 | rdn  |     -20 |
|         00:06:49.515 | Child  | Added     | ae5105292f0b9169 | 0x8401 | -    |     -20 |
Done
history neighbor list
00:00:34.753 -> type:Child event:Added extaddr:ae5105292f0b9169 rloc16:0x8404 mode:- rss:-20
00:01:43.888 -> type:Child event:Removed extaddr:ae5105292f0b9169 rloc16:0x8401 mode:- rss:-20
00:04:32.701 -> type:Child event:Changed extaddr:ae5105292f0b9169 rloc16:0x8401 mode:- rss:-20
00:04:56.756 -> type:Router event:Added extaddr:865c7ca38a5fa960 rloc16:0x9400 mode:rdn rss:-20
00:04:57.107 -> type:Child event:Removed extaddr:865c7ca38a5fa960 rloc16:0x8402 mode:rdn rss:-20
00:05:28.284 -> type:Child event:Changed extaddr:ae5105292f0b9169 rloc16:0x8401 mode:rn rss:-20
00:06:46.284 -> type:Child event:Added extaddr:4ec99efc874a1841 rloc16:0x8403 mode:r rss:-20
00:06:49.580 -> type:Child event:Added extaddr:865c7ca38a5fa960 rloc16:0x8402 mode:rdn rss:-20
00:06:55.035 -> type:Child event:Added extaddr:ae5105292f0b9169 rloc16:0x8401 mode:- rss:-20
Done

CLI and API References

history netinfo

Displays the network info history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Role: Device role. Possible values are router , child , detached , or disabled .
  • Mode: MLE link mode. Возможные значения:
    • - : no flags set (rx-off-when-idle, minimal Thread device, stable network data).
    • r : rx-on-when-idle
    • d : Full Thread Device.
    • n : Full Network Data
  • RLOC16
  • Partition ID.

Parameters

history netinfo [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history netinfo
| Age                  | Role     | Mode | RLOC16 | Partition ID |
+----------------------+----------+------+--------+--------------+
|         00:00:10.069 | router   | rdn  | 0x6000 |    151029327 |
|         00:02:09.337 | child    | rdn  | 0x2001 |    151029327 |
|         00:02:09.338 | child    | rdn  | 0x2001 |    151029327 |
|         00:07:40.806 | child    | -    | 0x2001 |    151029327 |
|         00:07:42.297 | detached | -    | 0x6000 |            0 |
|         00:07:42.968 | disabled | -    | 0x6000 |            0 |
Done
history netinfo list
00:00:59.467 -> role:router mode:rdn rloc16:0x6000 partition-id:151029327
00:02:58.735 -> role:child mode:rdn rloc16:0x2001 partition-id:151029327
00:02:58.736 -> role:child mode:rdn rloc16:0x2001 partition-id:151029327
00:08:30.204 -> role:child mode:- rloc16:0x2001 partition-id:151029327
00:08:31.695 -> role:detached mode:- rloc16:0x6000 partition-id:0
00:08:32.366 -> role:disabled mode:- rloc16:0x6000 partition-id:0
Done
history netinfo 2
| Age                  | Role     | Mode | RLOC16 | Partition ID |
+----------------------+----------+------+--------+--------------+
|         00:02:05.451 | router   | rdn  | 0x6000 |    151029327 |
|         00:04:04.719 | child    | rdn  | 0x2001 |    151029327 |
Done

CLI and API References

history prefix

Displays the network data for the mesh prefix history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Event: Possible values are Added or Removed .
  • Префикс
  • Flags/meaning:
    • p : Preferred flag
    • a : Stateless IPv6 address auto-configuration flag.
    • d : DHCPv6 IPv6 address configuration flag.
    • c : DHCPv6 other-configuration flag.
    • r : Default route flag.
    • o : On mesh flag.
    • s : Stable flag.
    • n : Nd Dns flag.
    • D : Domain prefix flag.
  • Pref: Preference. Values can be either high , med , or low .
  • RLOC16

Parameters

history prefix [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history prefix
| Age                  | Event   | Prefix                                      | Flags     | Pref | RLOC16 |
+----------------------+---------+---------------------------------------------+-----------+------+--------+
|         00:00:10.663 | Added   | fd00:1111:2222:3333::/64                    | paro      | med  | 0x5400 |
|         00:01:02.054 | Removed | fd00:dead:beef:1::/64                       | paros     | high | 0x5400 |
|         00:01:21.136 | Added   | fd00:abba:cddd:0::/64                       | paos      | med  | 0x5400 |
|         00:01:45.144 | Added   | fd00:dead:beef:1::/64                       | paros     | high | 0x3c00 |
|         00:01:50.944 | Added   | fd00:dead:beef:1::/64                       | paros     | high | 0x5400 |
|         00:01:59.887 | Added   | fd00:dead:beef:1::/64                       | paros     | med  | 0x8800 |
Done
history prefix list
00:04:12.487 -> event:Added prefix:fd00:1111:2222:3333::/64 flags:paro pref:med rloc16:0x5400
00:05:03.878 -> event:Removed prefix:fd00:dead:beef:1::/64 flags:paros pref:high rloc16:0x5400
00:05:22.960 -> event:Added prefix:fd00:abba:cddd:0::/64 flags:paos pref:med rloc16:0x5400
00:05:46.968 -> event:Added prefix:fd00:dead:beef:1::/64 flags:paros pref:high rloc16:0x3c00
00:05:52.768 -> event:Added prefix:fd00:dead:beef:1::/64 flags:paros pref:high rloc16:0x5400
00:06:01.711 -> event:Added prefix:fd00:dead:beef:1::/64 flags:paros pref:med rloc16:0x8800
Done

CLI and API References

history route

Displays the network data external-route history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Event: Possible values are Added or Removed .
  • Маршрут
  • Flags/meaning:
    • s : Stable flag.
    • n : NAT64 flag.
  • Pref: Preference. Values can be either high , med , or low .
  • RLOC16

Параметры

history route [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history route
| Age                  | Event   | Route                                       | Flags     | Pref | RLOC16 |
+----------------------+---------+---------------------------------------------+-----------+------+--------+
|         00:00:05.456 | Removed | fd00:1111:0::/48                            | s         | med  | 0x3c00 |
|         00:00:29.310 | Added   | fd00:1111:0::/48                            | s         | med  | 0x3c00 |
|         00:00:42.822 | Added   | fd00:1111:0::/48                            | s         | med  | 0x5400 |
|         00:01:27.688 | Added   | fd00:aaaa:bbbb:cccc::/64                    | s         | med  | 0x8800 |
Done
history route list 2
00:00:48.704 -> event:Removed route:fd00:1111:0::/48 flags:s pref:med rloc16:0x3c00
00:01:12.558 -> event:Added route:fd00:1111:0::/48 flags:s pref:med rloc16:0x3c00
Done

CLI and API References

history router

Displays the route-table history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Event: Possible values are Added , Removed , NextHopChanged , or CostChanged .
  • ID (RLOC16): Router ID and RLOC16 of the router.
  • Next Hop: Router ID and RLOC16 of the next hop. If there is no next hop, none is shown.
  • Path Cost: old cost -> new cost. A value of inf indicates an infinite path cost.

Parameters

history router [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history router
| Age                  | Event          | ID (RLOC16) | Next Hop    | Path Cost  |
+----------------------+----------------+-------------+-------------+------------+
|         00:00:05.258 | NextHopChanged |  7 (0x1c00) | 34 (0x8800) | inf ->   3 |
|         00:00:08.604 | NextHopChanged | 34 (0x8800) | 34 (0x8800) | inf ->   2 |
|         00:00:08.604 | Added          |  7 (0x1c00) |        none | inf -> inf |
|         00:00:11.931 | Added          | 34 (0x8800) |        none | inf -> inf |
|         00:00:14.948 | Removed        | 59 (0xec00) |        none | inf -> inf |
|         00:00:14.948 | Removed        | 54 (0xd800) |        none | inf -> inf |
|         00:00:14.948 | Removed        | 34 (0x8800) |        none | inf -> inf |
|         00:00:14.948 | Removed        |  7 (0x1c00) |        none | inf -> inf |
|         00:00:54.795 | NextHopChanged | 59 (0xec00) | 34 (0x8800) |   1 ->   5 |
|         00:02:33.735 | NextHopChanged | 54 (0xd800) |        none |  15 -> inf |
|         00:03:10.915 | CostChanged    | 54 (0xd800) | 34 (0x8800) |  13 ->  15 |
|         00:03:45.716 | NextHopChanged | 54 (0xd800) | 34 (0x8800) |  15 ->  13 |
|         00:03:46.188 | CostChanged    | 54 (0xd800) | 59 (0xec00) |  13 ->  15 |
|         00:04:19.124 | CostChanged    | 54 (0xd800) | 59 (0xec00) |  11 ->  13 |
|         00:04:52.008 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   9 ->  11 |
|         00:05:23.176 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   7 ->   9 |
|         00:05:51.081 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   5 ->   7 |
|         00:06:48.721 | CostChanged    | 54 (0xd800) | 59 (0xec00) |   3 ->   5 |
|         00:07:13.792 | NextHopChanged | 54 (0xd800) | 59 (0xec00) |   1 ->   3 |
|         00:09:28.681 | NextHopChanged |  7 (0x1c00) | 34 (0x8800) | inf ->   3 |
|         00:09:31.882 | Added          |  7 (0x1c00) |        none | inf -> inf |
|         00:09:51.240 | NextHopChanged | 54 (0xd800) | 54 (0xd800) | inf ->   1 |
|         00:09:54.204 | Added          | 54 (0xd800) |        none | inf -> inf |
|         00:10:20.645 | NextHopChanged | 34 (0x8800) | 34 (0x8800) | inf ->   2 |
|         00:10:24.242 | NextHopChanged | 59 (0xec00) | 59 (0xec00) | inf ->   1 |
|         00:10:24.242 | Added          | 34 (0x8800) |        none | inf -> inf |
|         00:10:41.900 | NextHopChanged | 59 (0xec00) |        none |   1 -> inf |
|         00:10:42.480 | Added          |  3 (0x0c00) |  3 (0x0c00) | inf -> inf |
|         00:10:43.614 | Added          | 59 (0xec00) | 59 (0xec00) | inf ->   1 |
Done
history router list 20
00:00:06.959 -> event:NextHopChanged router:7(0x1c00) nexthop:34(0x8800) old-cost:inf new-cost:3
00:00:10.305 -> event:NextHopChanged router:34(0x8800) nexthop:34(0x8800) old-cost:inf new-cost:2
00:00:10.305 -> event:Added router:7(0x1c00) nexthop:none old-cost:inf new-cost:inf
00:00:13.632 -> event:Added router:34(0x8800) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:59(0xec00) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:54(0xd800) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:34(0x8800) nexthop:none old-cost:inf new-cost:inf
00:00:16.649 -> event:Removed router:7(0x1c00) nexthop:none old-cost:inf new-cost:inf
00:00:56.496 -> event:NextHopChanged router:59(0xec00) nexthop:34(0x8800) old-cost:1 new-cost:5
00:02:35.436 -> event:NextHopChanged router:54(0xd800) nexthop:none old-cost:15 new-cost:inf
00:03:12.616 -> event:CostChanged router:54(0xd800) nexthop:34(0x8800) old-cost:13 new-cost:15
00:03:47.417 -> event:NextHopChanged router:54(0xd800) nexthop:34(0x8800) old-cost:15 new-cost:13
00:03:47.889 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:13 new-cost:15
00:04:20.825 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:11 new-cost:13
00:04:53.709 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:9 new-cost:11
00:05:24.877 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:7 new-cost:9
00:05:52.782 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:5 new-cost:7
00:06:50.422 -> event:CostChanged router:54(0xd800) nexthop:59(0xec00) old-cost:3 new-cost:5
00:07:15.493 -> event:NextHopChanged router:54(0xd800) nexthop:59(0xec00) old-cost:1 new-cost:3
00:09:30.382 -> event:NextHopChanged router:7(0x1c00) nexthop:34(0x8800) old-cost:inf new-cost:3
Done

CLI and API References

history rx

Displays the IPv6 message RX history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Тип:
    • IPv6 message type, such as UDP , TCP , HopOpts , and ICMP6 (and its subtype).
    • src : Source IPv6 address and port number.
    • dst : Destination IPv6 address and port number (port number is valid for UDP/TCP, otherwise it is 0).
  • Len: IPv6 payload length (excluding the IPv6 header).
  • Chksum: Message checksum (valid for UDP, TCP, or ICMP6 messages).
  • Sec: Indicates if link-layer security was used.
  • Prio: Message priority. Possible values are low , norm , high , or net (for Thread control messages).
  • RSS: Received Signal Strength (in dBm), averaged over all received fragment frames that formed the message. For TX history, NA (not applicable) is displayed.
  • Dir: Shows whether the message was sent ( TX ) or received ( RX ). A failed transmission is indicated with TX-F in table format or tx-success:no in list format. Examples of a failed transmission include a tx getting aborted and no ack getting sent from the peer for any of the message fragments.
  • Neighb: Short address (RLOC16) of the neighbor with whom the message was sent/received. If the frame was broadcast, it is shown as bcast in table format or 0xffff in list format. If the short address of the neighbor is not available, it is shown as unknwn in table format or 0xfffe in list format.
  • Radio: Radio link on which the message was sent/received (useful when OPENTHREAD_CONFIG_MULTI_RADIO is enabled). Can be 15.4 , trel , or all (if sent on all radio links).

Parameters

history rx [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history rx
| Age                  | Type             | Len   | Chksum | Sec | Prio | RSS  |Dir | Neighb | Radio |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xbd26 |  no |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:07.640 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.263 | src: [fdde:ad00:beef:0:0:ff:fe00:4800]:0                                    |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    12 | 0x3f7d | yes |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.302 | src: [fdde:ad00:beef:0:0:ff:fe00:4800]:61631                                |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:4801]:61631                                |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReqst) |    16 | 0x942c | yes | norm |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.304 | src: [fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0                               |
|                      | dst: [fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x4800 |  15.4 |
|         00:00:09.304 | src: [fdde:ad00:beef:0:0:ff:fe00:4800]:0                                    |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0x2e37 |  no |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:21.622 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xe177 |  no |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:26.640 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |   165 | 0x82ee | yes |  net |  -20 | RX | 0x4800 |  15.4 |
|         00:00:30.000 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    93 | 0x52df |  no |  net |  -20 | RX | unknwn |  15.4 |
|         00:00:30.480 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0x5ccf |  no |  net |  -20 | RX | unknwn |  15.4 |
|         00:00:30.772 | src: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
Done
history rx list 4
00:00:13.368
    type:UDP len:50 checksum:0xbd26 sec:no prio:net rss:-20 from:0x4800 radio:15.4
    src:[fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788
    dst:[ff02:0:0:0:0:0:0:1]:19788
00:00:14.991
    type:HopOpts len:44 checksum:0x0000 sec:yes prio:norm rss:-20 from:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:4800]:0
    dst:[ff03:0:0:0:0:0:0:2]:0
00:00:15.030
    type:UDP len:12 checksum:0x3f7d sec:yes prio:net rss:-20 from:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:4800]:61631
    dst:[fdde:ad00:beef:0:0:ff:fe00:4801]:61631
00:00:15.032
    type:ICMP6(EchoReqst) len:16 checksum:0x942c sec:yes prio:norm rss:-20 from:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0
    dst:[fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0
Done

CLI and API References

history rxtx

Displays the combined IPv6 message RX and TX history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Тип:
    • IPv6 message type, such as UDP , TCP , HopOpts , and ICMP6 (and its subtype).
    • src : Source IPv6 address and port number.
    • dst : Destination IPv6 address and port number (port number is valid for UDP/TCP, otherwise it is 0).
  • Len: IPv6 payload length (excluding the IPv6 header).
  • Chksum: Message checksum (valid for UDP, TCP, or ICMP6 messages).
  • Sec: Indicates if link-layer security was used.
  • Prio: Message priority. Possible values are low , norm , high , or net (for Thread control messages).
  • RSS: Received Signal Strength (in dBm), averaged over all received fragment frames that formed the message. For TX history, NA (not applicable) is displayed.
  • Dir: Shows whether the message was sent ( TX ) or received ( RX ). A failed transmission is indicated with TX-F in table format or tx-success:no in list format. Examples of a failed transmission include a tx getting aborted and no ack getting sent from the peer for any of the message fragments.
  • Neighb: Short address (RLOC16) of the neighbor with whom the message was sent/received. If the frame was broadcast, it is shown as bcast in table format or 0xffff in list format. If the short address of the neighbor is not available, it is shown as unknwn in table format or 0xfffe in list format.
  • Radio: Radio link on which the message was sent/received (useful when OPENTHREAD_CONFIG_MULTI_RADIO is enabled). Can be 15.4 , trel , or all (if sent on all radio links).

Parameters

history rxtx [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history rxtx
| Age                  | Type             | Len   | Chksum | Sec | Prio | RSS  |Dir | Neighb | Radio |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.267 | src: [fdde:ad00:beef:0:0:ff:fe00:800]:0                                     |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    12 | 0x6c6b | yes |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.290 | src: [fdde:ad00:beef:0:0:ff:fe00:800]:61631                                 |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:801]:61631                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReqst) |    16 | 0xc6a2 | yes | norm |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.292 | src: [fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0                               |
|                      | dst: [fdde:ad00:beef:0:af4c:3644:882a:3698]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReply) |    16 | 0xc5a2 | yes | norm |  NA  | TX | 0x0800 |  15.4 |
|         00:00:09.292 | src: [fdde:ad00:beef:0:af4c:3644:882a:3698]:0                               |
|                      | dst: [fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xaa0d | yes |  net |  NA  | TX | 0x0800 |  15.4 |
|         00:00:09.294 | src: [fdde:ad00:beef:0:0:ff:fe00:801]:61631                                 |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:800]:61631                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | HopOpts          |    44 | 0x0000 | yes | norm |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.296 | src: [fdde:ad00:beef:0:0:ff:fe00:800]:0                                     |
|                      | dst: [ff03:0:0:0:0:0:0:2]:0                                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xc1d8 |  no |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:09.569 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0x3cb1 |  no |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:16.519 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xeda0 |  no |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:20.599 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:1]:19788                                             |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |   165 | 0xbdfa | yes |  net |  -20 | RX | 0x0800 |  15.4 |
|         00:00:21.059 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    64 | 0x1c11 |  no |  net |  NA  | TX | 0x0800 |  15.4 |
|         00:00:21.062 | src: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
|                      | dst: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    93 | 0xedff |  no |  net |  -20 | RX | unknwn |  15.4 |
|         00:00:21.474 | src: [fe80:0:0:0:54d9:5153:ffc6:df26]:19788                                 |
|                      | dst: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    44 | 0xd383 |  no |  net |  NA  | TX | bcast  |  15.4 |
|         00:00:21.811 | src: [fe80:0:0:0:8893:c2cc:d983:1e1c]:19788                                 |
|                      | dst: [ff02:0:0:0:0:0:0:2]:19788                                             |
Done
history rxtx list 5
00:00:02.100
    type:UDP len:50 checksum:0xd843 sec:no prio:net rss:-20 from:0x0800 radio:15.4
    src:[fe80:0:0:0:54d9:5153:ffc6:df26]:19788
    dst:[ff02:0:0:0:0:0:0:1]:19788
00:00:15.331
    type:HopOpts len:44 checksum:0x0000 sec:yes prio:norm rss:-20 from:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:800]:0
    dst:[ff03:0:0:0:0:0:0:2]:0
00:00:15.354
    type:UDP len:12 checksum:0x6c6b sec:yes prio:net rss:-20 from:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:800]:61631
    dst:[fdde:ad00:beef:0:0:ff:fe00:801]:61631
00:00:15.356
    type:ICMP6(EchoReqst) len:16 checksum:0xc6a2 sec:yes prio:norm rss:-20 from:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0
    dst:[fdde:ad00:beef:0:af4c:3644:882a:3698]:0
00:00:15.356
    type:ICMP6(EchoReply) len:16 checksum:0xc5a2 sec:yes prio:norm tx-success:yes to:0x0800 radio:15.4
    src:[fdde:ad00:beef:0:af4c:3644:882a:3698]:0
    dst:[fdde:ad00:beef:0:efe8:4910:cf95:dee9]:0
Done

CLI and API References

history tx

Displays the IPv6 message TX history in table or list format.

Each table or list entry provides:

  • Age: Time elapsed since the command was issued, and given in the format: hours : minutes : seconds : milliseconds
  • Тип:
    • IPv6 message type, such as UDP , TCP , HopOpts , and ICMP6 (and its subtype).
    • src : Source IPv6 address and port number.
    • dst : Destination IPv6 address and port number (port number is valid for UDP/TCP, otherwise it is 0).
  • Len: IPv6 payload length (excluding the IPv6 header).
  • Chksum: Message checksum (valid for UDP, TCP, or ICMP6 messages).
  • Sec: Indicates if link-layer security was used.
  • Prio: Message priority. Possible values are low , norm , high , or net (for Thread control messages).
  • RSS: Received Signal Strength (in dBm), averaged over all received fragment frames that formed the message. For TX history, NA (not applicable) is displayed.
  • Dir: Shows whether the message was sent ( TX ) or received ( RX ). A failed transmission is indicated with TX-F in table format or tx-success:no in list format. Examples of a failed transmission include a tx getting aborted and no ack getting sent from the peer for any of the message fragments.
  • Neighb: Short address (RLOC16) of the neighbor with whom the message was sent/received. If the frame was broadcast, it is shown as bcast in table format or 0xffff in list format. If the short address of the neighbor is not available, it is shown as unknwn in table format or 0xfffe in list format.
  • Radio: Radio link on which the message was sent/received (useful when OPENTHREAD_CONFIG_MULTI_RADIO is enabled). Can be 15.4 , trel , or all (if sent on all radio links).

Parameters

history tx [list] [num-entries]
  • Use the list option to display the output in list format. Otherwise, the output is shown in table format.
  • Use the num-entries option to limit the output to the number of most-recent entries specified. If this option is not used, all stored entries are shown in the output.

Примеры

history tx
| Age                  | Type             | Len   | Chksum | Sec | Prio | RSS  |Dir | Neighb | Radio |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | ICMP6(EchoReply) |    16 | 0x932c | yes | norm |  NA  | TX | 0x4800 |  15.4 |
|         00:00:18.798 | src: [fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0                               |
|                      | dst: [fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0                               |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    50 | 0xce87 | yes |  net |  NA  | TX | 0x4800 |  15.4 |
|         00:00:18.800 | src: [fdde:ad00:beef:0:0:ff:fe00:4801]:61631                                |
|                      | dst: [fdde:ad00:beef:0:0:ff:fe00:4800]:61631                                |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    64 | 0xf7ba |  no |  net |  NA  | TX | 0x4800 |  15.4 |
|         00:00:39.499 | src: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
|                      | dst: [fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788                                 |
+----------------------+------------------+-------+--------+-----+------+------+----+--------+-------+
|                      | UDP              |    44 | 0x26d4 |  no |  net |  NA  | TX | bcast  |  15.4 |
|         00:00:40.256 | src: [fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788                                  |
|                      | dst: [ff02:0:0:0:0:0:0:2]:19788                                             |
Done
history tx list
00:00:23.957
    type:ICMP6(EchoReply) len:16 checksum:0x932c sec:yes prio:norm tx-success:yes to:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:dc0e:d6b3:f180:b75b]:0
    dst:[fdde:ad00:beef:0:ac09:a16b:3204:dc09]:0
00:00:23.959
    type:UDP len:50 checksum:0xce87 sec:yes prio:net tx-success:yes to:0x4800 radio:15.4
    src:[fdde:ad00:beef:0:0:ff:fe00:4801]:61631
    dst:[fdde:ad00:beef:0:0:ff:fe00:4800]:61631
00:00:44.658
    type:UDP len:64 checksum:0xf7ba sec:no prio:net tx-success:yes to:0x4800 radio:15.4
    src:[fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788
    dst:[fe80:0:0:0:d03d:d3e7:cc5e:7cd7]:19788
00:00:45.415
    type:UDP len:44 checksum:0x26d4 sec:no prio:net tx-success:yes to:0xffff radio:15.4
    src:[fe80:0:0:0:a4a5:bbac:a8e:bd07]:19788
    dst:[ff02:0:0:0:0:0:0:2]:19788
Done

CLI and API References

ifconfig (up,down)

Brings the IPv6 interface up or down.

Call this to enable or disable IPv6 communication.

Parameters

ifconfig up|down

Примеры

ifconfig up
Done
ifconfig down
Done

CLI and API References

есликонфигурация

Indicates whether or not the IPv6 interface is up.

Parameters

Никаких параметров.

Примеры

ifconfig
down
Done
ifconfig
up
Done

CLI and API References

instanceid

Gets the instance identifier.

The instance identifier is set to a random value when the instance is constructed, and then its value will not change after initialization.

Parameters

Никаких параметров.

Примеры

instanceid
468697314
Done

CLI and API References

ipaddr add

Adds a Network Interface Address to the Thread interface.

The passed-in instance aAddress is copied by the Thread interface. The Thread interface only supports a fixed number of externally added unicast addresses. See OPENTHREAD_CONFIG_IP6_MAX_EXT_UCAST_ADDRS .

Параметры

ipaddr add aAddress

Примеры

ipaddr add 2001::dead:beef:cafe
Done

CLI and API References

ipaddr del

Removes a Network Interface Address from the Thread interface.

Parameters

ipaddr del aAddress

Примеры

ipaddr del 2001::dead:beef:cafe
Done

CLI and API References

ipaddr

Gets the list of IPv6 addresses assigned to the Thread interface.

Parameters

ipaddr [-v]

Use -v to get more verbose information about the address:

  • origin : can be thread , slaac , dhcp6 , manual and indicates the origin of the address
  • plen : prefix length
  • preferred : preferred flag (boolean)
  • valid : valid flag (boolean)

Примеры

ipaddr
fdde:ad00:beef:0:0:ff:fe00:0
fdde:ad00:beef:0:558:f56b:d688:799
fe80:0:0:0:f3d9:2a82:c8d8:fe43
Done
ipaddr -v
fd5e:18fa:f4a5:b8:0:ff:fe00:fc00 origin:thread plen:64 preferred:0 valid:1
fd5e:18fa:f4a5:b8:0:ff:fe00:dc00 origin:thread plen:64 preferred:0 valid:1
fd5e:18fa:f4a5:b8:f8e:5d95:87a0:e82c origin:thread plen:64 preferred:0 valid:1
fe80:0:0:0:4891:b191:e277:8826 origin:thread plen:64 preferred:1 valid:1
Done

CLI and API References

ipaddr linklocal

Gets the Thread link-local IPv6 address.

The Thread link local address is derived using IEEE802.15.4 Extended Address as Interface Identifier.

Parameters

Никаких параметров.

Примеры

ipaddr linklocal
fe80:0:0:0:f3d9:2a82:c8d8:fe43
Done

CLI and API References

ipaddr mleid

Gets the Mesh Local EID address.

Parameters

Никаких параметров.

Примеры

ipaddr mleid
fdde:ad00:beef:0:558:f56b:d688:799
Done

CLI and API References

ipaddr rloc

Gets the Thread Routing Locator (RLOC) address.

Parameters

Никаких параметров.

Примеры

ipaddr rloc
fdde:ad00:beef:0:0:ff:fe00:0
Done

CLI and API References

ipmaddr add

Subscribes the Thread interface to a Network Interface Multicast Address.

The passed in instance aAddress will be copied by the Thread interface. The Thread interface only supports a fixed number of externally added multicast addresses. See OPENTHREAD_CONFIG_IP6_MAX_EXT_MCAST_ADDRS .

Parameters

ipmaddr add aAddress

Примеры

ipmaddr add ff05::1
Done

CLI and API References

ipmaddr del

Unsubscribes the Thread interface to a Network Interface Multicast Address.

Parameters

ipmaddr del aAddress

Примеры

ipmaddr del ff05::1
Done

CLI and API References

ipmaddr

Gets the list of IPv6 multicast addresses subscribed to the Thread interface.

Parameters

Никаких параметров.

Примеры

ipmaddr
ff05:0:0:0:0:0:0:1
ff33:40:fdde:ad00:beef:0:0:1
ff32:40:fdde:ad00:beef:0:0:1
Done

CLI and API References

ipmaddr llatn

Gets the Thread Link-Local All Thread Nodes multicast address.

The address is a link-local Unicast Prefix-Based Multicast Address [RFC 3306], with:

  • flgs set to 3 (P = 1 and T = 1)
  • scop set to 2
  • plen set to 64
  • network prefix set to the Mesh Local Prefix
  • group ID set to 1

Parameters

Никаких параметров.

Примеры

ipmaddr llatn
ff32:40:fdde:ad00:beef:0:0:1
Done

CLI and API References

ipmaddr promiscuous (enable,disable)

Enables or disables multicast promiscuous mode on the Thread interface.

Parameters

ipmaddr promiscuous enable|disable

Примеры

ipmaddr promiscuous enable
Done
ipmaddr promiscuous disable
Done

CLI and API References

ipmaddr promiscuous

Checks if multicast promiscuous mode is enabled on the Thread interface.

Параметры

Никаких параметров.

Примеры

ipmaddr promiscuous
Disabled
Done

CLI and API References

ipmaddr rlatn

Gets the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multicast Address [RFC 3306], with:

  • flgs set to 3 (P = 1 and T = 1)
  • scop set to 3
  • plen set to 64
  • network prefix set to the Mesh Local Prefix
  • group ID set to 1

Parameters

Никаких параметров.

Примеры

ipmaddr rlatn
ff33:40:fdde:ad00:beef:0:0:1
Done

CLI and API References

joiner discerner (set)

Sets the Joiner Discerner.

Parameters

joiner discerner discerner
  • Use {number}/{length} to set the discerner .
  • joiner discerner clear sets aDiscerner to nullptr .

Примеры

joiner discerner 0xabc/12
Done

CLI and API References

joiner discerner clear

Clear the Joiner discerner.

Parameters

Никаких параметров.

Примеры

joiner discerner clear
Done

CLI and API References

  • No associated API

joiner discerner

Gets the Joiner Discerner.

For more information, refer to otJoinerSetDiscerner .

Parameters

Никаких параметров.

Примеры

joiner discerner
0xabc/12
Done

CLI and API References

joiner help

Print the joiner help menu.

Parameters

Никаких параметров.

Примеры

joiner help
help
id
start
state
stop
Done

CLI and API References

  • No associated API

joiner id

Gets the Joiner ID.

If a Joiner Discerner is not set, Joiner ID is the first 64 bits of the result of computing SHA-256 over factory-assigned IEEE EUI-64. Otherwise the Joiner ID is calculated from the Joiner Discerner value.

The Joiner ID is also used as the device's IEEE 802.15.4 Extended Address during the commissioning process.

Parameters

Никаких параметров.

Примеры

joiner id
d65e64fa83f81cf7
Done

CLI and API References

joiner start

Enables the Thread Joiner role.

Parameters

joiner start joining-device-credential [provisioning-url]
  • joining-device-credential : Joiner Passphrase. Must be a string of all uppercase alphanumeric characters (0-9 and AY, excluding I, O, Q, and Z for readability), with a length between 6 and 32 characters.
  • provisioning-url : Provisioning URL for the Joiner (optional).

Примеры

joiner start J01NM3
Done

CLI and API References

joiner state

Gets the Joiner State.

Returns one of the following states:

  • Idle
  • Discover
  • Connecting
  • Connected
  • Entrust
  • Joined

Parameters

Никаких параметров.

Примеры

joiner state
Idle
Done

CLI and API References

joiner stop

Disables the Thread Joiner role.

Parameters

Никаких параметров.

Примеры

joiner stop
Done

CLI and API References

joinerport (set)

Sets the Joiner UDP Port.

Параметры

joinerport udp-port

Примеры

joinerport 1000
Done

CLI and API References

joinerport

Gets the Joiner UDP Port.

Parameters

Никаких параметров.

Примеры

joinerport
1000
Done

CLI and API References

keysequence counter (set)

Sets the thrKeySequenceCounter.

Parameters

keysequence counter counter

Примеры

keysequence counter 10
Done

CLI and API References

keysequence counter

Gets the thrKeySequenceCounter.

Parameters

Никаких параметров.

Примеры

keysequence counter
10
Done

CLI and API References

keysequence guardtime (set)

Sets the thrKeySwitchGuardTime (in hours).

Parameters

keysequence guardtime guardtime-hours

Use 0 to Thread Key Switch immediately if there's a key index match.

Примеры

keysequence guardtime 0
Done

CLI and API References

keysequence guardtime

Gets the thrKeySwitchGuardTime (in hours).

Parameters

Никаких параметров.

Примеры

keysequence guardtime
0
Done

CLI and API References

leaderdata

Gets the Thread Leader Data.

Parameters

Никаких параметров.

Примеры

leaderdata
Partition ID: 1077744240
Weighting: 64
Data Version: 109
Stable Data Version: 211
Leader Router ID: 60
Done

CLI and API References

leaderweight (set)

Sets the Thread Leader Weight used when operating in the Leader role.

Directly sets the Leader Weight to the new value, replacing its previous value (which may have been determined from the current otDeviceProperties ).

Parameters

leaderweight weight

Примеры

leaderweight 128
Done

CLI and API References

leaderweight

Gets the Thread Leader Weight used when operating in the Leader role.

Parameters

Никаких параметров.

Примеры

leaderweight
128
Done

CLI and API References

linkmetrics mgmt enhanced-ack clear

Sends a Link Metrics Management Request to clear an Enhanced-ACK Based Probing.

Parameters

linkmetrics mgmt peer-ipaddr enhanced-ack clear

peer-ipaddr should be the Link Local address of the neighboring device.

Примеры

linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 enhanced-ack clear
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: Success

CLI and API References

linkmetrics mgmt enhanced-ack register

Sends a Link Metrics Management Request to register an Enhanced-ACK Based Probing.

Parameters

linkmetrics mgmt peer-ipaddr enhanced-ack register [qmr][r]

[ q , m , and r ] map to otLinkMetricsValues . Per spec 4.11.3.4.4.6, you can only use a maximum of two options at once, for example q , or qm .

  • q : Layer 2 LQI.
  • m : Link Margin.
  • r : RSSI.
The additional r is optional and only used for reference devices. When this option is specified, Type/Average Enum of each Type Id Flags is set to reserved. This is used to verify that the Probing Subject correctly handles invalid Type Id Flags, and only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Примеры

linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 enhanced-ack register qm
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: Success
> linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 enhanced-ack register qm r
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: Cannot support new series

CLI and API References

linkmetrics mgmt forward

Sends an MLE Link Metrics Management Request to configure or clear a Forward Tracking Series.

Parameters

linkmetrics mgmt peer-ipaddr forward series-id [ldraX][pqmr]
  • peer-ipaddr : Peer address.
  • series-id : The Series ID.
  • [ l , d , r , and a ] map to otLinkMetricsSeriesFlags . X represents none of the otLinkMetricsSeriesFlags , and stops the accounting and removes the series.
    • l : MLE Link Probe.
    • d : MAC Data.
    • r : MAC Data Request.
    • a : MAC Ack.
    • X : Can only be used without any other flags.
  • [ p , q , m , and r ] map to otLinkMetricsValues .
    • p : Layer 2 Number of PDUs received.
    • q : Layer 2 LQI.
    • m : Link Margin.
    • r : RSSI.

Примеры

linkmetrics mgmt fe80:0:0:0:3092:f334:1455:1ad2 forward 1 dra pqmr
Done
> Received Link Metrics Management Response from: fe80:0:0:0:3092:f334:1455:1ad2
Status: SUCCESS

CLI and API References

linkmetrics probe

Sends an MLE Link Probe message.

Parameters

linkmetrics probe peer-ipaddr series-id length
  • peer-ipaddr : Peer address.
  • series-id : The Series ID for which this Probe message targets.
  • length : The length of the Probe message. A valid range is [0, 64].

Примеры

linkmetrics probe fe80:0:0:0:3092:f334:1455:1ad2 1 10
Done

CLI and API References

linkmetrics query forward

Perform a Link Metrics query (Forward Tracking Series).

Parameters

linkmetrics query peer-ipaddr forward series-id
  • peer-ipaddr : Peer address.
  • series-id : The Series ID.

Примеры

linkmetrics query fe80:0:0:0:3092:f334:1455:1ad2 forward 1
Done
> Received Link Metrics Report from: fe80:0:0:0:3092:f334:1455:1ad2
- PDU Counter: 2 (Count/Summation)
- LQI: 76 (Exponential Moving Average)
- Margin: 82 (dB) (Exponential Moving Average)
- RSSI: -18 (dBm) (Exponential Moving Average)

CLI and API References

linkmetrics query single

Perform a Link Metrics query (Single Probe).

Parameters

linkmetrics query peer-ipaddr single [pqmr]
  • peer-ipaddr : Peer address.
  • [ p , q , m , and r ] map to otLinkMetrics .
    • p : Layer 2 Number of PDUs received.
    • q : Layer 2 LQI.
    • m : Link Margin.
    • r : RSSI.

Примеры

linkmetrics query fe80:0:0:0:3092:f334:1455:1ad2 single qmr
Done
> Received Link Metrics Report from: fe80:0:0:0:3092:f334:1455:1ad2
- LQI: 76 (Exponential Moving Average)
- Margin: 82 (dB) (Exponential Moving Average)
- RSSI: -18 (dBm) (Exponential Moving Average)

CLI and API References

linkmetricsmgr (enable,disable)

Enable or disable Link Metrics Manager.

Parameters

linkmetricsmgr enable|disable

Примеры

linkmetricmgr enable
Done
linkmetricmgr disable
Done

CLI and API References

linkmetricsmgr show

Get Link Metrics data of a neighbor by its extended address.

Parameters

Никаких параметров.

Примеры

linkmetricsmgr show
ExtAddr:827aa7f7f63e1234, LinkMargin:80, Rssi:-20
Done

CLI and API References

locate (set)

Locate the closest destination of an anycast address (ie, find the destination's mesh local EID and RLOC16).

The closest destination is determined based on the current routing table and path costs within the Thread mesh.

Available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Parameters

locate anycastaddr

Примеры

locate fdde:ad00:beef:0:0:ff:fe00:fc00
fdde:ad00:beef:0:d9d3:9000:16b:d03b 0xc800
Done

CLI and API References

найти

Gets the current state ( In Progress or Idle ) of anycast locator.

Available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Parameters

Никаких параметров.

Примеры

locate
Idle
Done
locate fdde:ad00:beef:0:0:ff:fe00:fc10
locate
In Progress
Done

CLI and API References

log filename

Specifies filename to capture otPlatLog() messages, useful when debugging automated test scripts on Linux when logging disrupts the automated test scripts.

Requires OPENTHREAD_CONFIG_LOG_OUTPUT == OPENTHREAD_CONFIG_LOG_OUTPUT_DEBUG_UART and OPENTHREAD_POSIX .

Parameters

log filename filename

Примеры

CLI and API References

log level (set)

Sets the log level.

Parameters

log level level

Примеры

log level 4
Done

CLI and API References

log level

Get the log level.

Parameters

Никаких параметров.

Примеры

log level
1
Done

CLI and API References

mac retries direct (get,set)

Gets or sets the number of direct TX retries on the MAC layer.

Parameters

mac retries direct [number]

Use the optional number argument to set the number of direct TX retries.

Примеры

mac retries direct
3
Done
mac retries direct 5
Done

CLI and API References

mac retries indirect (get,set)

Gets or sets the number of indirect TX retries on the MAC layer.

Parameters

mac retries indirect [number]

Use the optional number argument to set the number of indirect Tx retries.

Примеры

mac retries indirect
3
Done
 max retries indirect 5
Done

CLI and API References

mac send

Instructs an Rx-Off-When-Idle device to send a MAC frame to its parent. This command is for certification, and can only be used when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Parameters

mac send datarequest | emptydata

You must choose one of the following two arguments:

  • datarequest : Enqueues an IEEE 802.15.4 Data Request message for transmission.
  • emptydata : Instructs the device to send an empty IEEE 802.15.4 data frame.

Примеры

mac send datarequest
Done
mac send emptydata
Done

CLI and API References

macfilter addr add

Is available only when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Adds an IEEE 802.15.4 Extended Address to the MAC filter list. If you specify the optional rss argument, this fixes the received signal strength for messages from the address. If you do not use the rss option, the address will use whatever default value you have set. If you have not set a default, the signal strength will be the over-air signal.

Parameters

macfilter addr add extaddr [rss]

Примеры

macfilter addr add 0f6127e33af6b403 -95
Done
macfilter addr add 0f6127e33af6b402
Done

CLI and API References

macfilter addr allowlist

Enables the allowlist MAC filter mode, which means that only the MAC addresses in the MAC filter list will be allowed access.

Parameters

Никаких параметров.

Примеры

macfilter addr allowlist
Done

CLI and API References

macfilter addr clear

Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

This command clears all the extended addresses from the MAC filter list.

Parameters

Никаких параметров.

Примеры

macfilter addr clear
Done

CLI and API References

macfilter addr denylist

Enables the denylist MAC filter mode, which means that all MAC addresses in the MAC filter list will be denied access.

Параметры

Никаких параметров.

Примеры

macfilter addr denylist
Done

CLI and API References

macfilter addr disable

Disables MAC filter modes.

Parameters

Никаких параметров.

Примеры

macfilter addr disable
Done

CLI and API References

  • No associated API

macfilter addr

Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Provides the following information:

  • Current mode of the MAC filter list: Either AllowList , DenyList, or Disabled
  • A list of all the extended addresses in the filter. The received signal strength (rss) and link quality indicator (lqi) are listed next to the address if these values have been set to be different from the default values.

Parameters

Никаких параметров.

Примеры

macfilter addr
Allowlist
0f6127e33af6b403 : rss -95 (lqi 1)
0f6127e33af6b402
Done

CLI and API References

macfilter addr remove

Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

This command removes the specified extended address from the MAC filter list.

Parameters

macfilter addr remove extaddr

Примеры

macfilter addr remove 0f6127e33af6b402
Done

CLI and API References

macfilter

Provides the following information:

  • Address Mode : Current mode of the MAC filter: Either AllowList , DenyList, or Disabled
  • A list of all the extended addresses in the MAC filter list. The received signal strength (rss) and link quality indicator (lqi) are listed next to the address if these values have been set to be different from the default values.
  • A separate list ( RssIn List ) that shows all the extended addresses where the rss has been set to be different from the default value.
  • Default rss : Shows the default values, if applicable, for the rss and lqi settings.

Parameters

Никаких параметров.

Примеры

macfilter
Address Mode: Allowlist
0f6127e33af6b403 : rss -95 (lqi 1)
0f6127e33af6b402
RssIn List:
0f6127e33af6b403 : rss -95 (lqi 1)
Default rss: -50 (lqi 3)
Done

CLI and API References

macfilter rss add

Adds the specified Extended Address to the RssIn list (or modifies an existing address in the RssIn list) and sets the received signal strength (in dBm) entry for messages from that address.

Parameters

macfilter rss add extaddr rss

To set a default value for the received signal strength for all received messages, use the * for the extaddr argument.

Примеры

macfilter rss add * -50
Done
macfilter rss add 0f6127e33af6b404 -85
Done

CLI and API References

macfilter rss add-lqi

Adds the specified Extended Address to the RssIn list (or modifies an existing address in the RssIn list) and sets the fixed link quality indicator for messages from that address. The Extended Address does not necessarily have to be in the address allowlist/denylist filter to set the lqi .

This is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Parameters

macfilter rss add-lqi extaddr lqi

To set a default value for the link quality indicator for all received messages, use the * for the extaddr argument. The allowed range is 0 to 3.

Примеры

macfilter rss add-lqi * 3
Done
macfilter rss add-lqi 0f6127e33af6b404 2
Done

CLI and API References

macfilter rss clear

Clears all the received signal strength ( rss ) and link quality indicator ( lqi ) entries (including defaults) from the RssIn list.

Performing this action means that all Extended Addresses will use the on-air signal.

Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Parameters

Никаких параметров.

Примеры

macfilter rss clear
Done

CLI and API References

macfilter rss

Provides the following information:

  • Listing of all the extended addresses where the received signal strength ( rss ) has been set to be different from the default value. The link quality indicator ( lqi ) is also shown. The rss and lqi settings map to each other. If you set one, the value of the other gets set automatically. This list of addresses is called the RssIn List . Setting either the rsi or the lqi adds the corresponding extended address to the RssIn list.
  • Default rss : Shows the default values, if applicable, for the rss and lqi settings.

Parameters

Никаких параметров.

Примеры

macfilter rss
0f6127e33af6b403 : rss -95 (lqi 1)
Default rss: -50 (lqi 3)
Done

CLI and API References

macfilter rss remove

Removes the specified Extended Address from the RssIn list.

Once removed from the RssIn list, this MAC address will instead use the default rss and lqi settings, assuming defaults have been set. (If no defaults have been set, the over-air signal is used.)

Is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

No action is performed if there is no existing entry in the RssIn list matching the specified Extended Address.

Parameters

macfilter rss remove extaddr

If you wish to remove the default received signal strength and link quality indicator settings, use the * as the extaddr . This unsets the defaults but does not remove entries from the RssIn list.

Примеры

macfilter rss remove *
Done
macfilter rss remove 0f6127e33af6b404
Done

CLI and API References

meshdiag childip6

Send a query to a parent to retrieve the IPv6 addresses of all its MTD children.

Parameters

meshdiag childip6 parent-rloc16

Примеры

meshdiag childip6 0xdc00
child-rloc16: 0xdc02
    fdde:ad00:beef:0:ded8:cd58:b73:2c21
    fd00:2:0:0:c24a:456:3b6b:c597
    fd00:1:0:0:120b:95fe:3ecc:d238
child-rloc16: 0xdc03
    fdde:ad00:beef:0:3aa6:b8bf:e7d6:eefe
    fd00:2:0:0:8ff8:a188:7436:6720
    fd00:1:0:0:1fcf:5495:790a:370f
Done

CLI and API References

meshdiag childtable

Start a query for child table of a router with a given RLOC16. Output lists all child entries. Information per child:

  • RLOC16
  • Extended MAC address
  • Thread Version
  • Timeout (in seconds)
  • Age (seconds since last heard)
  • Supervision interval (in seconds)
  • Number of queued messages (in case child is sleepy)
  • Режим устройства
  • RSS (average and last)
  • Error rates: frame tx (at MAC layer), IPv6 message tx (above MAC)
  • Connection time (seconds since link establishment {dd}d.{hh}:{mm}:{ss} format)
  • CSL info:
    • If synchronized
    • Period (in unit of 10-symbols-time)
    • Timeout (in seconds)

Parameters

Никаких параметров.

Примеры

meshdiag childtable 0x6400
rloc16:0x6402 ext-addr:8e6f4d323bbed1fe ver:4
    timeout:120 age:36 supvn:129 q-msg:0
    rx-on:yes type:ftd full-net:yes
    rss - ave:-20 last:-20 margin:80
    err-rate - frame:11.51% msg:0.76%
    conn-time:00:11:07
    csl - sync:no period:0 timeout:0 channel:0
rloc16:0x6403 ext-addr:ee24e64ecf8c079a ver:4
    timeout:120 age:19 supvn:129 q-msg:0
    rx-on:no type:mtd full-net:no
    rss - ave:-20 last:-20  margin:80
    err-rate - frame:0.73% msg:0.00%
    conn-time:01:08:53
    csl - sync:no period:0 timeout:0 channel:0
Done

CLI and API References

  • No associated API

meshdiag routerneighbortable

Start a query for router neighbor table of a router with a given RLOC16. Output lists all router neighbor entries. Information per entry:

  • RLOC16
  • Extended MAC address
  • Thread Version
  • RSS (average and last) and link margin
  • Error rates, frame tx (at MAC layer), IPv6 message tx (above MAC)
  • Connection time (seconds since link establishment {dd}d.{hh}:{mm}:{ss} format)

Параметры

meshdiag routerneighbortable router-rloc16

Примеры

meshdiag routerneighbortable 0x7400
rloc16:0x9c00 ext-addr:764788cf6e57a4d2 ver:4
   rss - ave:-20 last:-20 margin:80
   err-rate - frame:1.38% msg:0.00%
   conn-time:01:54:02
rloc16:0x7c00 ext-addr:4ed24fceec9bf6d3 ver:4
   rss - ave:-20 last:-20 margin:80
   err-rate - frame:0.72% msg:0.00%
   conn-time:00:11:27
Done

CLI and API References

meshdiag topology

Discover network topology (list of routers and their connections). Parameters are optional and indicate additional items to discover. Can be added in any order.

  • ip6-addrs to discover the list of IPv6 addresses of every router.
  • children to discover the child table of every router.

Information per router:

  • Router ID
  • RLOC16
  • Extended MAC address
  • Thread Version (if known)
  • Whether the router is this device is itself ( me )
  • Whether the router is the parent of this device when device is a child ( parent )
  • Whether the router is leader
  • Whether the router acts as a border router providing external connectivity ( br )
  • List of routers to which this router has a link:
    • 3-links : Router IDs to which this router has a incoming link with link quality 3
    • 2-links : Router IDs to which this router has a incoming link with link quality 2
    • 1-links : Router IDs to which this router has a incoming link with link quality 1
    • If a list if empty, it is omitted in the out.
  • If ip6-addrs , list of IPv6 addresses of the router
  • If children , list of all children of the router. Information per child:
    • RLOC16
    • Incoming Link Quality from perspective of parent to child (zero indicates unknown)
    • Child Device mode ( r rx-on-when-idle, d Full Thread Device, n Full Network Data, - no flags set)
    • Whether the child is this device itself ( me )
    • Whether the child acts as a border router providing external connectivity ( br )

Parameters

meshdiag topology [ip6-addrs] [children]

Примеры

meshdiag topology
id:02 rloc16:0x0800 ext-addr:8aa57d2c603fe16c ver:4 - me - leader
   3-links:{ 46 }
id:46 rloc16:0xb800 ext-addr:fe109d277e0175cc ver:4
   3-links:{ 02 51 57 }
id:33 rloc16:0x8400 ext-addr:d2e511a146b9e54d ver:4
   3-links:{ 51 57 }
id:51 rloc16:0xcc00 ext-addr:9aab43ababf05352 ver:4
   3-links:{ 33 57 }
   2-links:{ 46 }
id:57 rloc16:0xe400 ext-addr:dae9c4c0e9da55ff ver:4
   3-links:{ 46 51 }
   1-links:{ 33 }
Done

CLI and API References

mleadvimax

Gets the current Interval Max value used by Advertisement trickle timer.

This API requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE , and is intended for testing only.

Parameters

Никаких параметров.

Примеры

mleadvimax
12000
Done

CLI and API References

mliid

Sets the Mesh Local IID (for test purpose).

Requires OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE .

It must be used before Thread stack is enabled.

Only for testing/reference device.

Parameters

mliid iid

Примеры

mliid 1122334455667788
Done

CLI and API References

mlr reg

Registers Multicast Listeners to Primary Backbone Router.

OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE and OPENTHREAD_CONFIG_COMMISSIONER_ENABLE must be enabled.

Omit timeout to use the default MLR timeout on the Primary Backbone Router.

Use timeout = 0 to deregister Multicast Listeners.

Parameters

mlr reg ipaddr [timeout]

Примеры

mlr reg ff04::1
status 0, 0 failed
Done
mlr reg ff04::1 ff04::2 ff02::1
status 2, 1 failed
ff02:0:0:0:0:0:0:1
Done
mlr reg ff04::1 ff04::2 1000
status 0, 0 failed
Done
mlr reg ff04::1 ff04::2 0
status 0, 0 failed
Done

CLI and API References

mode (get,set)

Set the MLE Link Mode configuration.

Parameters

mode [rdn]
  • - : no flags set (rx-off-when-idle, minimal Thread device, stable network data)
  • r : rx-on-when-idle
  • d : Full Thread Device
  • n : Full Network Data

Примеры

mode rdn
Done
mode -
Done

CLI and API References

multiradio

Get the list of supported radio links by the device.

This command is always available, even when only a single radio is supported by the device.

Parameters

Никаких параметров.

Примеры

multiradio
[15.4, TREL]
Done

CLI and API References

  • No associated API

multiradio neighbor list

Gets the multi radio link information associated with a neighbor with a given Extended Address.

OPENTHREAD_CONFIG_MULTI_RADIO must be enabled.

Parameters

Никаких параметров.

Примеры

multiradio neighbor list
ExtAddr:3a65bc38dbe4a5be, RLOC16:0xcc00, Radios:[15.4(255), TREL(255)]
ExtAddr:17df23452ee4a4be, RLOC16:0x1300, Radios:[15.4(255)]
Done

CLI and API References

multiradio neighbor

Gets the multi radio link information associated with a neighbor with a given Extended Address.

OPENTHREAD_CONFIG_MULTI_RADIO must be enabled.

Parameters

multiradio neighbor ext-address

Примеры

multiradio neighbor 3a65bc38dbe4a5be
[15.4(255), TREL(255)]
Done

CLI and API References

nat64 (enable,disable)

Enable or disable NAT64 functions.

When OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled, setting disabled to true resets the mapping table in the translator.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE or OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE is enabled.

Parameters

nat64 enable|disable

Примеры

nat64 enable
Done
nat64 disable
Done

CLI and API References

nat64 cidr

Parameters

Никаких параметров.

Примеры

nat64 cidr 192.168.255.0/24
Done

CLI and API References

nat64 cidr

Gets the IPv4 CIDR configured in the NAT64 translator.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

Параметры

Никаких параметров.

Примеры

nat64 cidr
192.168.255.0/24
Done

CLI and API References

nat64 counters

Gets the NAT64 translator packet and error counters.

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

Parameters

Никаких параметров.

Примеры

nat64 counters
|               | 4 to 6                  | 6 to 4                  |
+---------------+-------------------------+-------------------------+
| Protocol      | Pkts     | Bytes        | Pkts     | Bytes        |
+---------------+----------+--------------+----------+--------------+
|         Total |       11 |          704 |       11 |          704 |
|           TCP |        0 |            0 |        0 |            0 |
|           UDP |        0 |            0 |        0 |            0 |
|          ICMP |       11 |          704 |       11 |          704 |
| Errors        | Pkts                    | Pkts                    |
+---------------+-------------------------+-------------------------+
|         Total |                       8 |                       4 |
|   Illegal Pkt |                       0 |                       0 |
|   Unsup Proto |                       0 |                       0 |
|    No Mapping |                       2 |                       0 |
Done

CLI and API References

nat64 mappings

Gets the next AddressMapping info (using an iterator).

Available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

Parameters

Никаких параметров.

Примеры

nat64 mappings
|          | Address                   |        | 4 to 6       | 6 to 4       |
+----------+---------------------------+--------+--------------+--------------+
| ID       | IPv6       | IPv4         | Expiry | Pkts | Bytes | Pkts | Bytes |
+----------+------------+--------------+--------+------+-------+------+-------+
| 00021cb9 | fdc7::df79 | 192.168.64.2 |  7196s |    6 |   456 |   11 |  1928 |
|          |                                TCP |    0 |     0 |    0 |     0 |
|          |                                UDP |    1 |   136 |   16 |  1608 |
|          |                               ICMP |    5 |   320 |    5 |   320 |

CLI and API References

nat64 state

Gets the state of NAT64 functions.

PrefixManager state is available when OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE is enabled. Translator state is available when OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled.

When OPENTHREAD_CONFIG_NAT64_BORDER_ROUTING_ENABLE is enabled, PrefixManager returns one of the following states:

  • Disabled : NAT64 prefix manager is disabled.
  • NotRunning : NAT64 prefix manager is enabled, but is not running. This could mean that the routing manager is disabled.
  • Idle : NAT64 prefix manager is enabled and is running, but is not publishing a NAT64 prefix. This can happen when there is another border router publishing a NAT64 prefix with a higher priority.
  • Active : NAT64 prefix manager is enabled, running, and publishing a NAT64 prefix.

When OPENTHREAD_CONFIG_NAT64_TRANSLATOR_ENABLE is enabled, Translator returns one of the following states:

  • Disabled : NAT64 translator is disabled.
  • NotRunning : NAT64 translator is enabled, but is not translating packets. This could mean that the Translator is not configured with a NAT64 prefix or a CIDR for NAT64.
  • Active : NAT64 translator is enabled and is translating packets.

Parameters

Никаких параметров.

Примеры

nat64 state
PrefixManager: Active
Translator: Active
Done

CLI and API References

neighbor conntime list

Prints the connection time and age of neighbors. This command is similar to neighbor conntime , but it displays the information in a list format. The age and connection time are both displayed in seconds.

Parameters

Никаких параметров.

Примеры

neighbor conntime list
0x8401 1a28be396a14a318 age:63 conn-time:644
0x5c00 723ebf0d9eba3264 age:23 conn-time:852
0xe800 ce53628a1e3f5b3c age:23 conn-time:180
Done

CLI and API References

neighbor conntime

Prints the connection time and age of neighbors. Information per neighbor:

  • RLOC16
  • Extended MAC
  • Last Heard (Age): Number of seconds since last heard from neighbor.
  • Connection Time: Number of seconds since link establishment with neighbor. Duration intervals are formatted as {hh}:{mm}:{ss} for hours, minutes, and seconds if the duration is less than one day. If the duration is longer than one day, the format is {dd}d.{hh}:{mm}:{ss} .

Parameters

Никаких параметров.

Примеры

neighbor conntime
| RLOC16 | Extended MAC     | Last Heard (Age) | Connection Time  |
+--------+------------------+------------------+------------------+
| 0x8401 | 1a28be396a14a318 |         00:00:13 |         00:07:59 |
| 0x5c00 | 723ebf0d9eba3264 |         00:00:03 |         00:11:27 |
| 0xe800 | ce53628a1e3f5b3c |         00:00:02 |         00:00:15 |
Done

CLI and API References

neighbor linkquality

Prints link quality information about all neighbors.

Parameters

Никаких параметров.

Примеры

neighbor linkquality
| RLOC16 | Extended MAC     | Frame Error | Msg Error | Avg RSS | Last RSS | Age   |
+--------+------------------+-------------+-----------+---------+----------+-------+
| 0xe800 | 9e2fa4e1b84f92db |      0.00 % |    0.00 % |     -46 |      -48 |     1 |
| 0xc001 | 0ad7ed6beaa6016d |      4.67 % |    0.08 % |     -68 |      -72 |    10 |
Done

CLI and API References

  • No associated API

neighbor list

Lists the RLOC16 of each neighbor.

Parameters

Никаких параметров.

Примеры

neighbor list
0xcc01 0xc800 0xf000
Done

CLI and API References

  • No associated API

neighbor table

Prints information in table format about all neighbors.

For Role , the only possible values for this table are C (Child) or R (Router).

The following columns provide information about the device mode of neighbors. Each column has a value of 0 (off) or 1 (on).

  • R : RX on when idle
  • D : Full Thread device
  • N : Full network data

Parameters

Никаких параметров.

Примеры

neighbor table
| Role | RLOC16 | Age | Avg RSSI | Last RSSI |R|D|N| Extended MAC     |
+------+--------+-----+----------+-----------+-+-+-+------------------+
|   C  | 0xcc01 |  96 |      -46 |       -46 |1|1|1| 1eb9ba8a6522636b |
|   R  | 0xc800 |   2 |      -29 |       -29 |1|1|1| 9a91556102c39ddb |
|   R  | 0xf000 |   3 |      -28 |       -28 |1|1|1| 0ad7ed6beaa6016d |
Done

CLI and API References

netdata full

Print "yes" or "no" indicating whether or not the "net data full" callback has been invoked since start of Thread operation or since the last time netdata full reset was used to reset the flag. This command requires OPENTHREAD_CONFIG_BORDER_ROUTER_SIGNAL_NETWORK_DATA_FULL . The "net data full" callback is invoked whenever:

  • The device is acting as a leader and receives a Network Data registration from a Border Router (BR) that it cannot add to Network Data (running out of space).
  • The device is acting as a BR and new entries cannot be added to its local Network Data.
  • The device is acting as a BR and tries to register its local Network Data entries with the leader, but determines that its local entries will not fit.

Parameters

No parameters.

Примеры

netdata full
no
Done

CLI and API References

netdata full reset

Reset the flag tracking whether "net data full" callback was invoked.

Parameters

No parameters.

Примеры

netdata full reset
Done

CLI and API References

  • No associated API

netdata length

Get the current length (number of bytes) of Partition's Thread Network Data.

Parameters

No parameters.

Примеры

netdata length
23
Done

CLI and API References

netdata maxlength

Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to otNetDataResetMaxLength() .

Parameters

No parameters.

Примеры

netdata maxlength
40
Done

CLI and API References

netdata maxlength reset

Reset the tracked maximum length of the Thread Network Data.

Parameters

No parameters.

Примеры

netdata maxlength reset
Done

CLI and API References

netdata publish dnssrp anycast

Publishes a DNS/SRP Service Anycast Address with a sequence number. Any current DNS/SRP Service entry being published from a previous publish dnssrp{anycast|unicast} command is removed and replaced with the new arguments.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE must be enabled.

Parameters

netdata publish dnssrp anycast seq-num

Примеры

netdata publish dnssrp anycast 1
Done

CLI and API References

netdata publish dnssrp unicast (addr,port)

Publishes a DNS/SRP Service Unicast Address with an address and port number. The address and port information is included in Service TLV data. Any current DNS/SRP Service entry being published from a previous publish dnssrp{anycast|unicast} command is removed and replaced with the new arguments.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE must be enabled.

Параметры

netdata publish dnssrp unicast address port

Примеры

netdata publish dnssrp unicast fd00::1234 51525
Done

CLI and API References

netdata publish dnssrp unicast (mle)

Publishes the device's Mesh-Local EID with a port number. MLE and port information is included in the Server TLV data. To use a different Unicast address, use the netdata publish dnssrp unicast (addr,port) command.

Any current DNS/SRP Service entry being published from a previous publish dnssrp{anycast|unicast} command is removed and replaced with the new arguments.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE must be enabled.

Parameters

netdata publish dnssrp unicast port

Примеры

netdata publish dnssrp unicast 50152
Done

CLI and API References

netdata publish prefix

Publish an on-mesh prefix entry. For more information, refer to Display and Manage Network Data with OT CLI .

Parameters

netdata publish prefix prefix [padcrosnD] [high|med|low]

OT CLI uses mapped arguments to configure otBorderRouterConfig values. For more information, refer to the OpenThread CLI Overview .

Примеры

netdata publish prefix fd00:1234:5678::/64 paos med
Done

CLI and API References

netdata publish replace

Replaces a previously published external route entry. For more information, refer to Display and Manage Network Data with OT CLI .

Parameters

netdata publish replace oldprefix prefix [sn] [high|med|low]

OT CLI uses mapped arguments to configure otExternalRouteConfig values. For more information, refer to the OpenThread CLI Overview .

Примеры

netdata publish replace ::/0 fd00:1234:5678::/64 s high
Done

CLI and API References

netdata publish route

Publish an external route entry. For more information, refer to Display and Manage Network Data with OT CLI .

Parameters

publish route prefix [sn] [high|med|low]

OT CLI uses mapped arguments to configure otExternalRouteConfig values. For more information, refer to the OpenThread CLI Overview .

Примеры

netdata publish route fd00:1234:5678::/64 s high
Done

CLI and API References

netdata register

Register configured prefixes, routes, and services with the Leader.

OT CLI checks for OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE . If OTBR is enabled, it registers local Network Data with the Leader. Otherwise, it calls the CLI function otServerRegister . For more information, refer to Display and Manage Network Data with OT CLI .

Parameters

No parameters.

Примеры

netdata register
Done

CLI and API References

netdata steeringdata check (discerner)

Check if the steering data includes a Joiner with a given discerner value.

Parameters

netdata steeringdata check discerner
  • discerner : The Joiner discerner in format {number}/{length} .

Примеры

netdata steeringdata check 0xabc/12
Done
netdata steeringdata check 0xdef/12
Error 23: NotFound

CLI and API References

netdata steeringdata check (eui64)

Check if the steering data includes a Joiner.

Parameters

netdata steeringdata check eui64
  • eui64 : The IEEE EUI-64 of the Joiner.

Примеры

netdata steeringdata check d45e64fa83f81cf7
Done

CLI and API References

netdata unpublish (prefix)

Unpublishes a previously published On-Mesh or External Route Prefix.

OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE must be enabled.

For more information, refer to Display and Manage Network Data with OT CLI .

Parameters

netdata unpublish prefix

Примеры

netdata unpublish fd00:1234:5678::/64
Done

CLI and API References

netdata unpublish dnssrp

Unpublishes any previously added DNS/SRP (Anycast or Unicast) Service entry from the Thread Network Data.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE must be enabled.

Parameters

No parameters.

Примеры

netdata unpublish dnssrp
Done

CLI and API References

нетстат

Gets the head of linked list of UDP Sockets.

Parameters

No parameters.

Примеры

netstat
| Local Address                                   | Peer Address                                    |
+-------------------------------------------------+-------------------------------------------------+
| [0:0:0:0:0:0:0:0]:49153                         | [0:0:0:0:0:0:0:0]:0                             |
| [0:0:0:0:0:0:0:0]:49152                         | [0:0:0:0:0:0:0:0]:0                             |
| [0:0:0:0:0:0:0:0]:61631                         | [0:0:0:0:0:0:0:0]:0                             |
| [0:0:0:0:0:0:0:0]:19788                         | [0:0:0:0:0:0:0:0]:0                             |
Done

CLI and API References

networkdiagnostic get

Sends a network diagnostic request to retrieve specified Type Length Values (TLVs) for the specified addresses(es).

Parameters

networkdiagnostic get addr type(s)

For addr , a unicast address triggers a Diagnostic Get . A multicast address triggers a Diagnostic Query . TLV values you can specify (separated by a space if you specify more than one TLV):

  • 0 : MAC Extended Address TLV
  • 1 : Address16 TLV
  • 2 : Mode TLV
  • 3 : Timeout TLV (the maximum polling time period for SEDs)
  • 4 : Connectivity TLV
  • 5 : Route64 TLV
  • 6 : Leader Data TLV
  • 7 : Network Data TLV
  • 8 : IPv6 Address List TLV
  • 9 : MAC Counters TLV
  • 14 : Battery Level TLV
  • 15 : Supply Voltage TLV
  • 16 : Child Table TLV
  • 17 : Channel Pages TLV
  • 19 : Max Child Timeout TLV
  • 23 : EUI64 TLV
  • 24 : Version TLV (version number for the protocols and features)
  • 25 : Vendor Name TLV
  • 26 : Vendor Model TLV
  • 27 : Vendor SW Version TLV
  • 28 : Thread Stack Version TLV (version identifier as UTF-8 string for Thread stack codebase/commit/version)
  • 29 : Child TLV
  • 34 : MLE Counters TLV
  • 35 : Vendor App URL TLV

Примеры

networkdiagnostic get fdde:ad00:beef:0:0:ff:fe00:fc00 0 1 6 23
DIAG_GET.rsp/ans: 00080e336e1c41494e1c01020c000608640b0f674074c503
Ext Address: 0e336e1c41494e1c
Rloc16: 0x0c00
Leader Data:
    PartitionId: 0x640b0f67
    Weighting: 64
    DataVersion: 116
    StableDataVersion: 197
    LeaderRouterId: 0x03
EUI64: 18b4300000000004
Done
networkdiagnostic get ff02::1 0 1
DIAG_GET.rsp/ans: 00080e336e1c41494e1c01020c00
Ext Address: '0e336e1c41494e1c'
Rloc16: 0x0c00
Done
DIAG_GET.rsp/ans: 00083efcdb7e3f9eb0f201021800
Ext Address: 3efcdb7e3f9eb0f2
Rloc16: 0x1800
Done

CLI and API References

networkdiagnostic reset

Sends a network diagnostic request to reset the specified Type Length Values (TLVs) on the specified address(es). This command only supports the following TLV values: 9 (MAC Counters TLV) or 34 (MLE Counters TLV)

Parameters

networkdiagnostic reset addr type(s)

Примеры

networkdiagnostic reset fd00:db8::ff:fe00:0 9
Done

CLI and API References

networkidtimeout (get,set)

Gets or sets the NETWORK_ID_TIMEOUT parameter.

Параметры

networkidtimeout [timeout]

Use the optional timeout argument to set the value of the NETWORK_ID_TIMEOUT parameter.

Примеры

networkidtimeout 120
Done
networkidtimeout
120
Done

CLI and API References

networkkey (key)

Set the Thread Network Key.

Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Parameters

networkkey key

Примеры

networkkey 00112233445566778899aabbccddeeff
Done

CLI and API References

сетевой ключ

Get the Thread Network Key.

Parameters

No parameters.

Примеры

networkkey
00112233445566778899aabbccddeeff
Done

CLI and API References

networkname (name)

Set the Thread Network Name.

Succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Parameters

networkname name

Примеры

networkname OpenThread
Done

CLI and API References

имя сети

Get the Thread Network Name.

Parameters

No parameters.

Примеры

networkname
OpenThread
Done

CLI and API References

networktime (set)

Sets the time sync parameters.

  • timesyncperiod : The time synchronization period, in seconds.
  • xtalthreshold : The XTAL accuracy threshold for a device to become Router-Capable device, in PPM.

Parameters

networktime timesyncperiod xtalthreshold

Примеры

networktime 100 300
Done

CLI and API References

networktime

Gets the Thread network time and the time sync parameters.

Parameters

No parameters.

Примеры

networktime
Network Time:     21084154us (synchronized)
Time Sync Period: 100s
XTAL Threshold:   300ppm
Done

CLI and API References

nexthop (get)

Gets the next hop and path cost towards a given RLOC16 destination.

Can be used with either aNextHopRloc16 or aPathCost being NULL indicating caller does not want to get the value.

Parameters

nexthop rloc16

Примеры

nexthop 0xc000
0xc000 cost:0
Done
nexthop 0x8001
0x2000 cost:3
Done

CLI and API References

следующий прыжок

Output table of allocated Router IDs and current next hop and path cost for each router.

Parameters

No parameters.

Примеры

nexthop
| ID   |NxtHop| Cost |
+------+------+------+
|    9 |    9 |    1 |
|   25 |   25 |    0 |
|   30 |   30 |    1 |
|   46 |    - |    - |
|   50 |   30 |    3 |
|   60 |   30 |    2 |
Done

CLI and API References

panid (panid)

Set the IEEE 802.15.4 PAN ID.

Succeeds only when Thread protocols are disabled. A successful call to this function also invalidates the Active and Pending Operational Datasets in non-volatile memory.

Parameters

panid panid

Примеры

panid 0xdead
Done

CLI and API References

panid

Get the IEEE 802.15.4 PAN ID.

Parameters

No parameters.

Примеры

panid
0xdead
Done

CLI and API References

родитель

Get the diagnostic information for a Thread Router as parent.

When operating as a Thread Router when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled, this command will return the cached information from when the device was previously attached as a Thread Child. Returning cached information is necessary to support the Thread Test Harness - Test Scenario 8.2.x requests the former parent (ie Joiner Router's) MAC address even if the device has already promoted to a router.

Parameters

No parameters.

Примеры

parent
Ext Addr: be1857c6c21dce55
Rloc: 5c00
Link Quality In: 3
Link Quality Out: 3
Age: 20
Version: 4
Done

CLI and API References

Starts the process for child to search for a better parent while staying attached to its current parent.

Must be used when device is attached as a child.

Parameters

No parameters.

Примеры

parent search
Done

CLI and API References

parentpriority (get,set)

Gets or sets the assigned parent priority value: 1, 0, -1 or -2. -2 means not assigned.

Параметры

parentpriority [parentpriority]

Примеры

parentpriority
1
Done
parentpriority 1
Done

CLI and API References

partitionid

Get the Thread Network Partition ID.

Parameters

No parameters.

Примеры

partitionid
4294967295
Done

CLI and API References

partitionid preferred (get,set)

OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is required.

Parameters

partitionid preferred partitionid

Примеры

partitionid preferred
4294967295
Done
partitionid preferred 0xffffffff
Done

CLI and API References

Платформа

Print the current platform

Parameters

No parameters.

Примеры

platform
NRF52840
Done

CLI and API References

  • No associated API

pollperiod (get,set)

Get or set the customized data poll period of sleepy end device (milliseconds). Only for certification test.

Parameters

No parameters.

Примеры

pollperiod
0
Done
pollperiod 10
Done

CLI and API References

preferrouterid

Specifies the preferred router ID that the leader should provide when solicited.

Parameters

preferrouterid routerid

Примеры

preferrouterid 16
Done

CLI and API References

prefix add

Adds a valid prefix to the Network Data.

Parameters

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

OT CLI uses mapped arguments to configure otBorderRouterConfig values. For more information, refer to the OpenThread CLI Overview .

Примеры

prefix add 2001:dead:beef:cafe::/64 paros med
Done
prefix add fd00:7d03:7d03:7d03::/64 prosD low
Done

CLI and API References

prefix meshlocal

Get the mesh local prefix.

Parameters

No parameters.

Примеры

prefix meshlocal
fdde:ad00:beef:0::/64
Done

CLI and API References

  • No associated API

префикс

Get the prefix list in the local Network Data.

For more information about otBorderRouterConfig flags, refer to OpenThread CLI Overview .

Parameters

No parameters.

Примеры

prefix
2001:dead:beef:cafe::/64 paros med
- fd00:7d03:7d03:7d03::/64 prosD med
Done

CLI and API References

prefix remove

Remove a border router configuration from the local network data.

Parameters

No parameters.

Примеры

prefix remove 2001:dead:beef:cafe::/64
Done

CLI and API References

promiscuous (enable,disable)

Enables or disables the link layer promiscuous mode.

Parameters

promiscuous enable|disable

Примеры

promiscuous enable
Done
promiscuous disable
Done

CLI and API References

распутный

Indicates whether or not promiscuous mode is enabled at the link layer.

Parameters

No parameters.

Примеры

promiscuous
Disabled
Done

CLI and API References

pskc (set)

Sets the pskc in hexadecimal format.

Parameters

pskc key

Примеры

pskc 67c0c203aa0b042bfb5381c47aef4d9e
Done

CLI and API References

  • No associated API

pskc -p

Generates the pskc from the passphrase (UTF-8 encoded), together with the current network name and extended PAN ID.

Parameters

pskc -p passphrase

Примеры

pskc -p 123456
Done

CLI and API References

  • No associated API

pskc

Get the Thread PSKc.

Parameters

No parameters.

Примеры

pskc
67c0c203aa0b042bfb5381c47aef4d9e
Done

CLI and API References

pskcref (set)

Set the Key Reference to the Thread PSKc.

Requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Will only succeed when Thread protocols are disabled. Upon success, this will also invalidate the Active and Pending Operational Datasets in non-volatile memory.

Parameters

pskc keyref

Примеры

pskc 0x20017
Done

CLI and API References

pskcref

Get Key Reference to Thread PSKc stored.

Requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Parameters

No parameters.

Примеры

pskcref
0x80000000
Done

CLI and API References

radio (enable,disable)

Enables or disables the radio.

Parameters

radio enable|disable

Примеры

radio enable
Done
radio disable
Done

CLI and API References

radio stats clear

Resets the radio statistics.

All times are reset to 0.

Parameters

No parameters.

Примеры

radio stats clear
Done

CLI and API References

radio stats

Gets the radio statistics.

The radio statistics include the time when the radio is in TX/RX/Sleep state. These times are in units of microseconds. All times are calculated from the last reset of radio statistics.

Parameters

No parameters.

Примеры

radio stats
Radio Statistics:
Total Time: 67.756s
Tx Time: 0.022944s (0.03%)
Rx Time: 1.482353s (2.18%)
Sleep Time: 66.251128s (97.77%)
Disabled Time: 0.000080s (0.00%)
Done

CLI and API References

rcp version

Get the radio version string.

Parameters

No parameters.

Примеры

rcp version
OPENTHREAD/20191113-00825-g82053cc9d-dirty; SIMULATION; Jun  4 2020 17:53:16
Done

CLI and API References

region (set)

Sets the region code.

The radio region format is the 2-bytes ascii representation of the ISO 3166 alpha-2 code.

Changing this can affect the transmit power limit.

Parameters

No parameters.

Примеры

region US
Done

CLI and API References

область

Get the region code.

The radio region format is the 2-bytes ascii representation of the ISO 3166 alpha-2 code.

Параметры

No parameters.

Примеры

region
US
Done

CLI and API References

releaserouterid (routerid)

Release a Router ID that has been allocated by the device in the Leader role.

Parameters

releaserouterid [routerid]

Примеры

releaserouterid 16
Done

CLI and API References

rloc16

Get the RLOC16.

Parameters

No parameters.

Примеры

rloc16
0xdead
Done

CLI and API References

route add

For parameters, use:

  • s: Stable flag
  • n: NAT64 flag
  • prf: Default Router Preference, [high, med, low].

Add a valid external route to the Network Data.

Parameters

route add prefix [sn] [high|med|low]

Примеры

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

CLI and API References

route remove

Remove an external route configuration from the local network data.

Parameters

route remove [prefix]

Примеры

route remove 2001:dead:beef:cafe::/64
Done

CLI and API References

маршрут

Get the external route list in the local Network Data.

Parameters

No parameters.

Примеры

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

CLI and API References

router (id)

The function retains diagnostic information for a given Thread Router.

Print diagnostic information for a Thread Router. The id may be a Router ID or an RLOC16.

Parameters

router [id]

Примеры

router 50
Alloc: 1
Router ID: 50
Rloc: c800
Next Hop: c800
Link: 1
Ext Addr: e2b3540590b0fd87
Cost: 0
Link Quality In: 3
Link Quality Out: 3
Age: 3
Done
router 0xc800
Alloc: 1
Router ID: 50
Rloc: c800
Next Hop: c800
Link: 1
Ext Addr: e2b3540590b0fd87
Cost: 0
Link Quality In: 3
Link Quality Out: 3
Age: 7
Done

CLI and API References

router list

List allocated Router IDs.

Parameters

No parameters.

Примеры

router list
8 24 50
Done

CLI and API References

стол маршрутизатора

Prints a list of routers in a table format.

Parameters

No parameters.

Примеры

router table
| ID | RLOC16 | Next Hop | Path Cost | LQ In | LQ Out | Age | Extended MAC     | Link |
+----+--------+----------+-----------+-------+--------+-----+------------------+------+
| 22 | 0x5800 |       63 |         0 |     0 |      0 |   0 | 0aeb8196c9f61658 |    0 |
| 49 | 0xc400 |       63 |         0 |     3 |      3 |   0 | faa1c03908e2dbf2 |    1 |
Done

CLI and API References

routerdowngradethreshold (get,set)

Gets or sets the ROUTER_DOWNGRADE_THRESHOLD value.

Parameters

routerdowngradethreshold [threshold]

Примеры

 routerdowngradethreshold
23
Done
 routerdowngradethreshold 23
Done

CLI and API References

routereligible (enable,disable)

Enables or disables the router role.

Parameters

routereligible [enable|disable]

Примеры

routereligible enable
Done
routereligible disable
Done

CLI and API References

routereligible

Indicates whether the router role is enabled or disabled.

Parameters

No parameters.

Примеры

routereligible
Enabled
Done

CLI and API References

routerselectionjitter

Gets or sets the ROUTER_SELECTION_JITTER value.

Parameters

routerselectionjitter [jitter]

Примеры

routerselectionjitter
120
Done
routerselectionjitter 120
Done

CLI and API References

routerupgradethreshold (get,set)

Gets or sets the ROUTER_UPGRADE_THRESHOLD value.

Parameters

routerupgradethreshold [threshold]

Примеры

routerupgradethreshold
16
Done
routerupgradethreshold 16
Done

CLI and API References

scan energy

Performs an IEEE 802.15.4 energy scan, and displays the time in milliseconds to use for scanning each channel. All channels are shown unless you specify a certain channel by using the channel option.

Parameters

scan energy [duration] [channel]

Примеры

scan energy 10
| Ch | RSSI |
+----+------+
| 11 |  -59 |
| 12 |  -62 |
| 13 |  -67 |
| 14 |  -61 |
| 15 |  -87 |
| 16 |  -86 |
| 17 |  -86 |
| 18 |  -52 |
| 19 |  -58 |
| 20 |  -82 |
| 21 |  -76 |
| 22 |  -82 |
| 23 |  -74 |
| 24 |  -81 |
| 25 |  -88 |
| 26 |  -71 |
Done
scan energy 10 20
| Ch | RSSI |
+----+------+
| 20 |  -82 |
Done

CLI and API References

сканировать

Performs an active IEEE 802.15.4 scan. The scan covers all channels if no channel is specified; otherwise the span covers only the channel specified.

Parameters

scan [channel]

Примеры

scan
| PAN  | MAC Address      | Ch | dBm | LQI |
+------+------------------+----+-----+-----+
| ffff | f1d92a82c8d8fe43 | 11 | -20 |   0 |
Done

CLI and API References

service add

Adds service to the network data.

  • enterpriseNumber: IANA enterprise number
  • serviceData: Hex-encoded binary service data
  • serverData: Hex-encoded binary server data

Параметры

service add enterpriseNumber serviceData serverData

Примеры

service add 44970 112233 aabbcc
Done
netdata register
Done

CLI and API References

service remove

Removes service from the network data.

  • enterpriseNumber: IANA enterprise number
  • serviceData: Hex-encoded binary service data

Parameters

service remove enterpriseNumber serviceData

Примеры

service remove 44970 112233
Done
netdata register
Done

CLI and API References

синглтон

Indicates whether a node is the only router on the network. Returns either true or false .

Parameters

No parameters.

Примеры

singleton
true
Done

CLI and API References

sntp query

Sends an SNTP query to obtain the current unix epoch time (from January 1, 1970).

  • SNTP server default IP address: 2001:4860:4806:8:: (Google IPv6 NTP Server)
  • SNTP server default port: 123

Parameters

sntp query [SNTP server IP] [SNTP server port]

Примеры

sntp query
SNTP response - Unix time: 1540894725 (era: 0)
Done
sntp query 64:ff9b::d8ef:2308
SNTP response - Unix time: 1540898611 (era: 0)
Done

CLI and API References

srp client autostart (get)

Indicates the current state of auto-start mode (enabled or disabled). For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

No parameters.

Примеры

srp client autostart
Disabled
Done

CLI and API References

srp client autostart disable

Disables the auto-start mode.

Disabling auto-start mode does not stop a running client. However, the SRP client stops monitoring Thread network data.

Parameters

No parameters.

Примеры

srp client autostart disable
Done

CLI and API References

srp client autostart enable

Enables auto-start mode.

When auto-start is enabled, the SRP client monitors Thread network data to discover SRP servers, to select the preferred server, and to automatically start and stop the client when an SRP server is detected.

Three categories of network data entries indicate the presence of an SRP sever, and are preferred in the following order:

  1. Unicast entries in which the server address is included in the service data. If there are multiple options, the option with the lowest numerical IPv6 address is preferred.
  2. Anycast entries that each have a sequence number. The largest sequence number as specified by Serial Number Arithmetic Logic in RFC-1982 is preferred.
  3. Unicast entries in which the server address information is included with the server data. If there are multiple options, the option with the lowest numerical IPv6 address is preferred.

Parameters

No parameters.

Примеры

srp client autostart enable
Done

CLI and API References

srp client callback (get,enable,disable)

Gets or enables/disables printing callback events from the SRP client. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp client callback [enable|disable]

Примеры

srp client callback enable
Done
srp client callback
Enabled
Done

CLI and API References

srp client host address (get)

Indicates whether auto address mode is enabled. If auto address mode is not enabled, then the list of SRP client host addresses is returned. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

No parameters.

Примеры

srp client host address
auto
Done
srp client host address
fd00:0:0:0:0:0:0:1234
fd00:0:0:0:0:0:0:beef
Done

CLI and API References

srp client host address (set)

Enable auto host address mode or explicitly set the list of host addresses. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp client host address [auto|address...]
  • Use the auto parameter to enable auto host address mode. When enabled, the client automatically uses all preferred Thread netif unicast addresses except for link-local and mesh-local addresses. If there is no valid address, the mesh local EID address gets added. The SRP client automatically re-registers if addresses on the Thread netif are added or removed or marked as non-preferred.
  • Explicitly specify the list of host addresses, separating each address by a space. You can set this list while the client is running. This will also disable auto host address mode.

Примеры

srp client host address auto
Done
srp client host address fd00::cafe
Done

CLI and API References

srp client host clear

Clears all host information and all services.

Parameters

No parameters.

Примеры

srp client host clear
Done

CLI and API References

srp client host name (get,set)

Gets or sets the host name of the SRP client. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp client host name [name]

To set the client host name when the host has either been removed or not yet registered with the server, use the name parameter.

Примеры

srp client host name dev4312
Done
srp client host name
dev4312
Done

CLI and API References

srp client host remove

Removes SRP client host information and all services from the SRP server. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp client host remove [removekeylease] [sendunregtoserver]
  • The parameter removekeylease is an optional boolean value that indicates whether the host key lease should also be removed (default is false ).
  • The parameter sendunregtoserver is an optional boolean value that indicates whether the client host should send an "update" message to the server even when the client host information has not yet been registered with the server (default is false ). This parameter can be specified only if the removekeylease parameter is specified first in the command.

Примеры

srp client host remove 1
Done

CLI and API References

srp client host

Gets the host info.

Параметры

No parameters.

Примеры

srp client host
name:"dev4312", state:Registered, addrs:[fd00:0:0:0:0:0:0:1234, fd00:0:0:0:0:0:0:beef]
Done

CLI and API References

srp client host state

Returns the state of the SRP client host. Possible states:

  • ToAdd : Item to be added/registered.
  • Adding : Item is being added/registered.
  • ToRefresh : Item to be refreshed for lease renewal.
  • Refreshing : Item is beig refreshed.
  • ToRemove : Item to be removed.
  • Removing : Item is being removed.
  • Registered : Item is registered with server.
  • Removed : Item has been removed.

Parameters

No parameters.

Примеры

srp client host state
Registered
Done

CLI and API References

  • No associated API

srp client keyleaseinterval (get,set)

Gets or sets the key lease interval in seconds.

Parameters

srp client keyleaseinterval [interval]

Примеры

srp client keyleaseinterval 864000
Done
srp client keyleaseinterval
864000
Done

CLI and API References

srp client leaseinterval (get,set)

Gets or sets the lease interval in seconds.

Parameters

srp client leaseinterval [interval]

Примеры

srp client leaseinterval 3600
Done
srp client leaseinterval
3600
Done

CLI and API References

srp client server address

Returns the server's IPv6 address.

Parameters

No parameters.

Примеры

srp client server address
fd00:0:0:0:d88a:618b:384d:e760
Done

CLI and API References

  • No associated API

srp client server port

Returns the server's port number.

Parameters

No parameters.

Примеры

srp client server port
4724
Done

CLI and API References

  • No associated API

srp client server

Gets the socket address (IPv6 address and port number) of the SRP server that is being used by the SRP client. If the client is not running, the address is unspecified (all zeros) with a port number of 0. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

No parameters.

Примеры

srp client server
[fd00:0:0:0:d88a:618b:384d:e760]:4724
Done

CLI and API References

srp client service add

Adds a service with a given instance name, service name, and port number. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp client service add instancename servicename port [priority] [weight] [txt]

The servicename parameter can optionally include a list of service subtype labels that are separated by commas. The examples here use generic naming. The priority and weight (both are uint16_t values) parameters are optional, and if not provided zero is used. The optional txt parameter sets the TXT data associated with the service. The txt value must be in hex-string format and is treated as an already encoded TXT data byte sequence.

Примеры

srp client service add ins1 _test1._udp 777
Done
srp client service add ins2 _test2._udp,_sub1,_sub2 111 1 1
Done

CLI and API References

srp client service key (get,set)

Gets or sets the service key record inclusion mode in the SRP client. This command is intended for testing only, and requires that OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE be enabled. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

No parameters.

Примеры

srp client service key enable
Done
srp client service key
Enabled
Done

CLI and API References

srp client service name clear

Clears a service, immediately removing it from the client service list, with no interaction with the SRP server.

Parameters

srp client service clear instancename servicename

Примеры

srp client service clear ins2 _test2._udp
Done

CLI and API References

srp client service remove

Requests a service to be unregistered with the SRP server.

Parameters

srp client service remove instancename servicename

Примеры

srp client service remove ins2 _test2._udp
Done

CLI and API References

srp client service

Gets the list of services being managed by client.

Parameters

No parameters.

Примеры

srp client service
instance:"ins2", name:"_test2._udp,_sub1,_sub2", state:Registered, port:111, priority:1, weight:1
instance:"ins1", name:"_test1._udp", state:Registered, port:777, priority:0, weight:0
Done

CLI and API References

srp client start

Starts the SRP client operation. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp client start serveraddr serverport

Примеры

srp client start fd00::d88a:618b:384d:e760 4724
Done

CLI and API References

srp client state

Indicates whether the SRP client is running or not.

Параметры

No parameters.

Примеры

srp client state
Enabled
Done

CLI and API References

srp client stop

Stops the SRP client operation.

Stops any further interactions with the SRP server. Note that it does not remove or clear host info and/or list of services. It marks all services to be added/removed again once the client is (re)started.

Parameters

No parameters.

Примеры

srp client stop
Done

CLI and API References

srp client ttl (get,set)

Gets or sets the ttl (time to live) value in seconds.

Parameters

srp client ttl [value]

Примеры

srp client ttl 3600
Done
srp client ttl
3600
Done

CLI and API References

srp server (enable,disable)

Enables or disables the SRP server. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp server [enable|disable]

Примеры

srp server disable
Done

CLI and API References

srp server addrmode (get,set)

Gets or sets the address mode used by the SRP server.

The address mode tells the SRP server how to determine its address and port number, which then get published in the Thread network data.

Parameters

srp server addrmode [anycast|unicast]

Примеры

srp server addrmode anycast
Done
srp server addrmode
anycast
Done

CLI and API References

srp server auto (enable,disable)

Enables or disables the auto-enable mode on the SRP server.

When this mode is enabled, the Border Routing Manager controls if and when to enable or disable the SRP server.

This command requires that OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE be enabled. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

srp server auto [enable|disable]

Примеры

srp server auto enable
Done
srp server auto
Enabled
Done

CLI and API References

srp server domain (get,set)

Gets or sets the domain name of the SRP server.

Parameters

srp server domain [domain-name]

Примеры

srp server domain thread.service.arpa.
Done
srp server domain
thread.service.arpa.
Done

CLI and API References

srp server host

Returns information about all registered hosts. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

No parameters.

Примеры

srp server host
srp-api-test-1.default.service.arpa.
    deleted: false
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
srp-api-test-0.default.service.arpa.
    deleted: false
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
Done

CLI and API References

srp server lease (get,set)

Gets or sets the SRP server lease values in number of seconds.

Parameters

srp server lease [min-lease max-lease min-key-lease max-key-lease]

Примеры

srp server lease 1800 7200 86400 1209600
Done
srp server lease
min lease: 1800
max lease: 7200
min key-lease: 86400
max key-lease: 1209600
Done

CLI and API References

srp server seqnum (get,set)

Gets or sets the sequence number used with the anycast address mode. The sequence number is included in the "DNS/SRP Service Anycast Address" entry that is published in the Network Data.

Parameters

srp server seqnum [seqnum]

Примеры

srp server seqnum 20
Done
srp server seqnum
20
Done

CLI and API References

srp server service

Returns information about registered services.

The TXT record is displayed as an array of entries. If an entry contains a key, the key is printed in ASCII format. The value portion is printed in hexadecimal bytes. For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Parameters

No parameters.

Примеры

srp server service
srp-api-test-1._ipps._tcp.default.service.arpa.
    deleted: false
    subtypes: (null)
    port: 49152
    priority: 0
    weight: 0
    ttl: 7200
    lease: 7200
    key-lease: 1209600
    TXT: [616263, xyz=585960]
    host: srp-api-test-1.default.service.arpa.
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
srp-api-test-0._ipps._tcp.default.service.arpa.
    deleted: false
    subtypes: _sub1,_sub2
    port: 49152
    priority: 0
    weight: 0
    ttl: 3600
    lease: 3600
    key-lease: 1209600
    TXT: [616263, xyz=585960]
    host: srp-api-test-0.default.service.arpa.
    addresses: [fdde:ad00:beef:0:0:ff:fe00:fc10]
Done

CLI and API References

srp server state

Returns one of the following possible states of the SRP server:

  • disabled : The SRP server is not enabled.
  • stopped : The SRP server is enabled but not active due to existing SRP servers that are already active in the Thread network. The SRP server may become active when the existing SRP servers are no longer active within the Thread network.
  • running : The SRP server is active and can handle service registrations.

For more information, refer to Set Up Service Registration Protocol (SRP) Server-Client Connectivity With OT CLI .

Параметры

No parameters.

Примеры

srp server state
running
Done

CLI and API References

состояние

Returns the current role of the Thread device, or changes the role as specified with one of the options. Possible values returned when inquiring about the device role:

  • child : The device is currently operating as a Thread child.
  • router : The device is currently operating as a Thread router.
  • leader : The device is currently operating as a Thread leader.
  • detached : The device is not currently participating in a Thread network/partition.
  • disabled : The Thread stack is currently disabled.

Using one of the options allows you to change the current role of a device, with the exclusion of changing to or from a disabled state.

Parameters

state [child|router|leader|detached]

Примеры

state
child
Done
state leader
Done

CLI and API References

tcp abort

Unceremoniously ends the TCP connection associated with the example TCP endpoint, transitioning the TCP endpoint to the closed state.

Parameters

No parameters.

Примеры

tcp abort
TCP: Connection reset
Done

CLI and API References

tcp benchmark result

Shows the latest result of the TCP benchmark test. Possible status values:

  • Непрерывный
  • Завершенный
  • Непроверенный

This command is primarily intended for creating scripts that automate the TCP benchmark test.

Parameters

No parameters.

Примеры

tcp benchmark result
TCP Benchmark Status: Ongoing
Done
tcp benchmark result
TCP Benchmark Status: Completed
TCP Benchmark Complete: Transferred 73728 bytes in 7056 milliseconds
TCP Goodput: 83.592 kb/s

CLI and API References

  • No associated API

tcp benchmark run

Transfers the specified number of bytes using the TCP connection currently associated with the example TCP endpoint provided by the tcp CLI.

Parameters

tcp benchmark run [size]

Use the size parameter to specify the number of bytes to send for the benchmark. If you do not use the size parameter, the default value ( OPENTHREAD_CONFIG_CLI_TCP_DEFAULT_BENCHMARK_SIZE ) is used.

Примеры

tcp benchmark run
Done
TCP Benchmark Complete: Transferred 73728 bytes in 7233 milliseconds
TCP Goodput: 81.546 kb/s

CLI and API References

  • No associated API

tcp bind

Associates an IPv6 address and a port to the example TCP endpoint provided by the tcp CLI. Associating the TCP endpoint to an IPv6 address and port is referred to as "naming the TCP endpoint." This binds the endpoint for communication. For more information, refer to Test TCP Functionality With OT CLI .

Parameters

tcp bind ip port
  • ip : IPv6 address to bind to. If you wish to have the TCP/IPv6 stack assign the binding IPv6 address, use the unspecified IPv6 address: :: .
  • port : TCP port number to bind to.

Примеры

tcp bind :: 30000
Done

CLI and API References

tcp connect

Establishes a connection with the specified peer.

If the connection establishment is successful, the resulting TCP connection is associated with the example TCP endpoint. For more information, refer to Test TCP Functionality With OT CLI .

Parameters

tcp connect ip port [fastopen]
  • ip : IP address of the peer The address can be an IPv4 address, which gets synthesized to an IPv6 address using the preferred NAT64 prefix from the network data. The command returns InvalidState when the preferred NAT64 prefix is unavailable.
  • port : TCP port number of the peer.
  • fastopen : This parameter is optional. If set to fast , TCP Fast Open is enabled for this connection. Otherwise, if this parameter is set to slow or not used, TCP Fast Open is disabled.

Примеры

tcp connect fe80:0:0:0:a8df:580a:860:ffa4 30000
Done
TCP: Connection established
tcp connect 172.17.0.1 1234
Connecting to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done

CLI and API References

tcp deinit

Deinitializes this TCP endpoint.

This means that OpenThread no longer keeps track of this TCP endpoint and deallocates all resources it has internally allocated for this TCP endpoint. The application can reuse the memory backing the TCP endpoint as it sees fit.

If it corresponds to a live TCP connection, the connection is terminated unceremoniously (as in otTcpAbort() ). All resources the application has provided for this TCP endpoint (linked buffers for the send buffer, memory for the receive buffer, the aEndpoint structure itself, etc.) are immediately returned to the application.

Parameters

Никаких параметров.

Примеры

tcp deinit
Done

CLI and API References

tcp init

Initializes the example TCP listener and the example TCP endpoint provided by the tcp CLI.

Parameters

tcp init [mode] [size]
  • The mode has three possible values:
    • tls : Specifies that the TCP connection between two nodes should also use the TLS protocol on top of TCP. When two nodes communicate over TCP, both nodes must either use TLS or neither node should use TLS because a non-TLS endpoint cannot communicate with a TLS endpoint.
    • linked or circular : Either one of these options means that TLS is not to be used, and the specified buffering type should be used for TCP buffering. The behavior of linked and circular is identical. Examine the code for the differences between these two buffering types. Two endpoints of a TCP connection are not required to use the same buffering type.
  • The size parameter sets the size of the receive buffer to associate with the example TCP endpoint. If left unspecified, the maximum size is used. The maximum size is set in OPENTHREAD_CONFIG_CLI_TCP_RECEIVE_BUFFER_SIZE .

Примеры

tcp init tls
Done

CLI and API References

tcp listen

Uses the example TCP listener to listen for incoming connections on the specified IPv6 address and port. For more information, refer to Test TCP Functionality With OT CLI .

Parameters

tcp listen ip port

The following parameters are required:

  • ip : IPv6 address or the unspecified IPv6 address ( :: ) of the example TCP listener provided by the tcp CLI.
  • port : TCP port of the example TCP listener. If no TCP connection is associated with the example TCP endpoint, then any incoming connections matching the specified IPv6 address and port are accepted and are associated with the example TCP endpoint.

Примеры

tcp listen :: 30000
Done

CLI and API References

tcp send

Sends data over the TCP connection associated with the example TCP endpoint that is provided with the tcp CLI. For more information, refer to Test TCP Functionality With OT CLI .

Parameters

tcp send message

The message parameter contains the message you want to send to the remote TCP endpoint.

Примеры

tcp send hello
Done

CLI and API References

  • No associated API

tcp sendend

Sends the "end of stream" signal over the TCP connection associated with the example TCP endpoint provided by the tcp CLI. This alerts the peer that it will not receive any more data over this TCP connection.

Parameters

Никаких параметров.

Примеры

tcp sendend
Done

CLI and API References

tcp stoplistening

Instructs the example TCP listener to stop listening for incoming TCP connections.

Parameters

No parameters.

Примеры

tcp stoplistening
Done

CLI and API References

thread start

Starts the Thread protocol operation.

Parameters

No parameters.

Примеры

thread start
Done

CLI and API References

thread stop

Stops the Thread protocol operation.

Parameters

No parameters.

Примеры

thread stop
Done

CLI and API References

  • No associated API

thread version

Gets the Thread protocol version.

Параметры

No parameters.

Примеры

 thread version
2
Done

CLI and API References

timeinqueue max

Gets the maximum time-in-queue for messages in the TX queue.

Requires OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE .

The time-in-queue is tracked for direct transmissions only and is measured as the duration from when a message is added to the transmit queue until it is passed to the MAC layer for transmission or dropped.

The collected statistics can be reset by calling otThreadResetTimeInQueueStat() .

Parameters

No parameters.

Примеры

timeinqueue max
281
Done

CLI and API References

timeinqueue reset

Resets the TX queue time-in-queue statistics.

Requires OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE .

Parameters

No parameters.

Примеры

timeinqueue reset
Done

CLI and API References

timeinqueue

Gets the time-in-queue histogram for messages in the TX queue.

Requires OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE .

Histogram of the time-in-queue of messages in the transmit queue is collected. The time-in-queue is tracked for direct transmissions only and is measured as the duration from when a message is added to the transmit queue until it is passed to the MAC layer for transmission or dropped.

The histogram is returned as an array of uint32_t values with aNumBins entries. The first entry in the array (at index 0) represents the number of messages with a time-in-queue less than aBinInterval . The second entry represents the number of messages with a time-in-queue greater than or equal to aBinInterval , but less than 2 * aBinInterval . И так далее. The last entry represents the number of messages with time-in-queue greater than or equal to (aNumBins - 1) * aBinInterval .

The collected statistics can be reset by calling otThreadResetTimeInQueueStat() . The histogram information is collected since the OpenThread instance was initialized or since the last time statistics collection was reset by calling the otThreadResetTimeInQueueStat() .

Pointers aNumBins and aBinInterval MUST NOT be NULL.

Parameters

Никаких параметров.

Примеры

timeinqueue
| Min  | Max  |Msg Count|
+------+------+---------+
|    0 |    9 |    1537 |
|   10 |   19 |     156 |
|   20 |   29 |      57 |
|   30 |   39 |     108 |
|   40 |   49 |      60 |
|   50 |   59 |      76 |
|   60 |   69 |      88 |
|   70 |   79 |      51 |
|   80 |   89 |      86 |
|   90 |   99 |      45 |
|  100 |  109 |      43 |
|  110 |  119 |      44 |
|  120 |  129 |      38 |
|  130 |  139 |      44 |
|  140 |  149 |      35 |
|  150 |  159 |      41 |
|  160 |  169 |      34 |
|  170 |  179 |      13 |
|  180 |  189 |      24 |
|  190 |  199 |       3 |
|  200 |  209 |       0 |
|  210 |  219 |       0 |
|  220 |  229 |       2 |
|  230 |  239 |       0 |
|  240 |  249 |       0 |
|  250 |  259 |       0 |
|  260 |  269 |       0 |
|  270 |  279 |       0 |
|  280 |  289 |       0 |
|  290 |  299 |       1 |
|  300 |  309 |       0 |
|  310 |  319 |       0 |
|  320 |  329 |       0 |
|  330 |  339 |       0 |
|  340 |  349 |       0 |
|  350 |  359 |       0 |
|  360 |  369 |       0 |
|  370 |  379 |       0 |
|  380 |  389 |       0 |
|  390 |  399 |       0 |
|  400 |  409 |       0 |
|  410 |  419 |       0 |
|  420 |  429 |       0 |
|  430 |  439 |       0 |
|  440 |  449 |       0 |
|  450 |  459 |       0 |
|  460 |  469 |       0 |
|  470 |  479 |       0 |
|  480 |  489 |       0 |
|  490 |  inf |       0 |
Done

CLI and API References

trel (enable,disable)

Enables or disables the TREL radio operation.

Parameters

trel enable|disable

Примеры

trel enable
Done
trel disable
Done

CLI and API References

trel counters reset

Resets the TREL counters.

Parameters

No parameters.

Примеры

trel counters reset
Done

CLI and API References

trel counters

Gets the TREL counters.

Parameters

No parameters.

Примеры

trel counters
Inbound:  Packets 32 Bytes 4000
Outbound: Packets 4 Bytes 320 Failures 1
Done

CLI and API References

trel filter (enable,disable)

Enables or disables TREL filter mode.

Parameters

trel filter enable|disable

Примеры

trel filter enable
Done
trel filter disable
Done

CLI and API References

trel filter

Indicates whether TREL filter mode is enabled.

When filter mode is enabled, all Rx and Tx traffic sent through the TREL interface gets silently dropped.

Parameters

No parameters.

Примеры

trel filter
Disabled
Done

CLI and API References

trel peers

Gets the TREL peer table in table or list format.

Parameters

trel peers [list]

Примеры

trel peers
| No  | Ext MAC Address  | Ext PAN Id       | IPv6 Socket Address                              |
+-----+------------------+------------------+--------------------------------------------------+
|   1 | 5e5785ba3a63adb9 | f0d9c001f00d2e43 | [fe80:0:0:0:cc79:2a29:d311:1aea]:9202            |
|   2 | ce792a29d3111aea | dead00beef00cafe | [fe80:0:0:0:5c57:85ba:3a63:adb9]:9203            |
Done
trel peers list
001 ExtAddr:5e5785ba3a63adb9 ExtPanId:f0d9c001f00d2e43 SockAddr:[fe80:0:0:0:cc79:2a29:d311:1aea]:9202
002 ExtAddr:ce792a29d3111aea ExtPanId:dead00beef00cafe SockAddr:[fe80:0:0:0:5c57:85ba:3a63:adb9]:9203
Done

CLI and API References

трел

Indicates whether the TREL operation is enabled.

Parameters

No parameters.

Примеры

trel
Enabled
Done

CLI and API References

tvcheck (enable,disable)

Enables or disables the Thread version check when upgrading to router or leader. This check is enabled by default.

Parameters

No parameters.

Примеры

tvcheck enable
Done
tvcheck disable
Done

CLI and API References

txpower (get,set)

Gets (or sets with the use of the optional txpower argument) the transmit power in dBm.

Parameters

txpower [txpower]

Примеры

txpower -10
Done
txpower
-10 dBm
Done

CLI and API References

udp bind

Assigns an IPv6 address and a port to an open socket, which binds the socket for communication. Assigning the IPv6 address and port is referred to as naming the socket. For more information, refer to Test UDP Functionality With OT CLI .

Parameters

udp bind [netif] ip port
  • netif : The binding network interface, which is determined as follows:
    • No value (leaving out this parameter from the command): Thread network interface is used.
    • -u : Unspecified network interface, which means that the UDP/IPv6 stack determines which network interface to bind the socket to.
    • -b : Backbone network interface is used.
  • ip : IPv6 address to bind to. If you wish to have the UDP/IPv6 stack assign the binding IPv6 address, then you can use the following value to use the unspecified IPv6 address: :: . Each example uses the unspecified IPv6 address.
  • port : UDP port number to bind to. Each of the examples is using port number 1234.

Примеры

udp bind :: 1234
Done
udp bind -u :: 1234
Done
udp bind -b :: 1234
Done

CLI and API References

udp close

Close a UDP/IPv6 socket.

Parameters

No parameters.

Примеры

udp close
Done

CLI and API References

udp connect

Connect a UDP/IPv6 socket.

Parameters

udp connect ip port

The following parameters are required:

  • ip : IP address of the peer.
  • port : UDP port number of the peer. The address can be an IPv4 address, which gets synthesized to an IPv6 address using the preferred NAT64 prefix from the network data. The command returns InvalidState when the preferred NAT64 prefix is unavailable.

Примеры

udp connect fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234
Done
udp connect 172.17.0.1 1234
Connecting to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done

CLI and API References

udp linksecurity (enable,disable)

Enables or disables link security.

Parameters

No parameters.

Примеры

udp linksecurity enable
Done
udp linksecurity disable
Done

CLI and API References

  • No associated API

udp linksecurity

Indicates whether link security is enabled or disabled.

Параметры

Никаких параметров.

Примеры

udp linksecurity
Enabled
Done

CLI and API References

  • No associated API

udp open

Open a UDP/IPv6 socket.

Parameters

No parameters.

Примеры

udp open
Done

CLI and API References

udp send

Sends a UDP message using the socket. For more information, refer to Test UDP Functionality With OT CLI .

Parameters

udp send [ip port] [type] value

The ip and port are optional as a pair, but if you specify one you must specify the other. If ip and port are not specified, the socket peer address is used from udp connect .

  • ip : Destination address. This address can be either an IPv4 or IPv6 address, An IPv4 address gets synthesized to an IPv6 address with the preferred NAT64 prefix from the network data. (If the preferred NAT64 prefix is unavailable, the command returns InvalidState ).
  • port : UDP destination port.
  • type / value combinations:
    • -t : The payload in the value parameter is treated as text. If no type value is entered, the payload in the value parameter is also treated as text.
    • -s : Auto-generated payload with the specified length given in the value parameter.
    • -x : Binary data in hexadecimal representation given in the value parameter.

Примеры

udp send hello
Done
udp send -t hello
Done
udp send -x 68656c6c6f
Done
udp send -s 800
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 hello
Done
udp send 172.17.0.1 1234 hello
Sending to synthesized IPv6 address: fdde:ad00:beef:2:0:0:ac11:1
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -t hello
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -x 68656c6c6f
Done
udp send fdde:ad00:beef:0:bb1:ebd6:ad10:f33 1234 -s 800
Done

CLI and API References

unsecure get

Lists all ports from the allowed unsecured port list.

Parameters

No parameters.

Примеры

unsecure get
1234
Done

CLI and API References

unsecureport add

Adds a port to the allowed unsecured port list.

Parameters

unsecureport add port

Примеры

unsecureport add 1234
Done

CLI and API References

unsecureport remove

Removes a specified port or all ports from the allowed unsecured port list.

Parameters

unsecureport remove port|all

Примеры

unsecureport remove 1234
Done
unsecureport remove all
Done

CLI and API References

uptime ms

Returns the current instance uptime (in msec).

Requires OPENTHREAD_CONFIG_UPTIME_ENABLE to be enabled.

The uptime is given as number of milliseconds since OpenThread instance was initialized.

Parameters

No parameters.

Примеры

uptime ms
426238
Done

CLI and API References

время безотказной работы

Returns the current instance uptime as a human-readable string.

Requires OPENTHREAD_CONFIG_UPTIME_ENABLE to be enabled.

The string follows the format " : : . " for hours, minutes, seconds and millisecond (if uptime is shorter than one day) or "

д. : : . " (if longer than a day).

If the resulting string does not fit in aBuffer (within its aSize characters), the string will be truncated but the outputted string is always null-terminated.

Parameters

No parameters.

Примеры

uptime
12:46:35.469
Done

CLI and API References

vendor appurl (set)

Set the vendor app URL string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorAppUrl should be UTF8 with max length of 64 chars ( MAX_VENDOR_APPL_URL_TLV_LENGTH ). Maximum length does not include the null \0 character.

Parameters

vendor appurl url

Примеры

vendor appurl http://www.example.com
Done

CLI and API References

vendor appurl

Get the vendor app URL string.

Parameters

No parameters.

Примеры

vendor appurl
http://www.example.com
Done

CLI and API References

vendor model (set)

Set the vendor model string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorModel should be UTF8 with max length of 32 chars ( MAX_VENDOR_MODEL_TLV_LENGTH ). Maximum length does not include the null \0 character.

Parameters

vendor model name

Примеры

vendor model Hub\ Max
Done

CLI and API References

vendor model

Get the vendor model string.

Параметры

No parameters.

Примеры

vendor model
Hub Max
Done

CLI and API References

vendor name (set)

Set the vendor name string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorName should be UTF8 with max length of 32 chars ( MAX_VENDOR_NAME_TLV_LENGTH ). Maximum length does not include the null \0 character.

Parameters

vendor name name

Примеры

vendor name nest
Done

CLI and API References

имя поставщика

Get the vendor name string.

Parameters

No parameters.

Примеры

vendor name
nest
Done

CLI and API References

vendor swversion (set)

Set the vendor software version string.

Requires OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorSwVersion should be UTF8 with max length of 16 chars( MAX_VENDOR_SW_VERSION_TLV_LENGTH ). Maximum length does not include the null \0 character.

Parameters

vendor swversion version

Примеры

vendor swversion Marble3.5.1
Done

CLI and API References

vendor swversion

Get the vendor software version string.

Parameters

Никаких параметров.

Примеры

vendor swversion
Marble3.5.1
Done

CLI and API References

verhoeff calculate

Calculates the Verhoeff checksum for a given decimal string.

Requires OPENTHREAD_CONFIG_VERHOEFF_CHECKSUM_ENABLE .

Parameters

verhoeff calculate decimalstring

Примеры

verhoeff calculate 30731842
1
Done

CLI and API References

verhoeff validate

Validates the Verhoeff checksum for a given decimal string.

Requires OPENTHREAD_CONFIG_VERHOEFF_CHECKSUM_ENABLE .

Parameters

verhoeff validate decimalstring

Примеры

verhoeff validate 307318421
Done

CLI and API References

version api

Prints the API version number.

Parameters

No parameters.

Примеры

version api
28
Done

CLI and API References

  • No associated API

версия

Gets the OpenThread version string.

Parameters

No parameters.

Примеры

version
OPENTHREAD/gf4f2f04; Jul 1 2016 17:00:09
Done

CLI and API References