Общий

Этот модуль включает функции для всех ролей потоков.

Резюме

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

Все функции в этом модуле требуют OPENTHREAD_CONFIG_NETDATA_PUBLISHER_ENABLE быть включен.

Перечисления

anonymous enum {
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS = 0,
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS = 1,
OT_NETWORK_DIAGNOSTIC_TLV_MODE = 2,
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT = 3,
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY = 4,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE = 5,
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA = 6,
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA = 7,
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST = 8,
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS = 9,
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL = 14,
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE = 15,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE = 16,
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES = 17,
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST = 18,
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT = 19
}
перечислить
otDeviceRole {
OT_DEVICE_ROLE_DISABLED = 0,
OT_DEVICE_ROLE_DETACHED = 1,
OT_DEVICE_ROLE_CHILD = 2,
OT_DEVICE_ROLE_ROUTER = 3,
OT_DEVICE_ROLE_LEADER = 4
}
перечислить
Представляет роль устройства потока.
otNetDataPublisherEvent {
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED = 0,
OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED = 1
}
перечислить
Это перечисление представляет события, о которых сообщают обратные вызовы издателя.
otRoutePreference {
OT_ROUTE_PREFERENCE_LOW = -1,
OT_ROUTE_PREFERENCE_MED = 0,
OT_ROUTE_PREFERENCE_HIGH = 1
}
перечислить
Определяет допустимые значения mPreference в otExternalRouteConfig и otBorderRouterConfig .

Typedefs

otBorderRouterConfig typedef
Эта структура представляет конфигурацию пограничного маршрутизатора.
otExternalRouteConfig typedef
Эта структура представляет конфигурацию внешнего маршрута.
otIpCounters typedef
struct otIpCounters
Эта структура представляет счетчики уровня IP.
otLeaderData typedef
struct otLeaderData
Эта структура представляет данные лидера потока.
otLinkModeConfig typedef
Эта структура представляет конфигурацию режима соединения MLE.
otMleCounters typedef
Эта структура представляет счетчики потоков MLE.
otNeighborInfoIterator typedef
int16_t
Используется для перебора соседней таблицы.
otNetDataDnsSrpServicePublisherCallback )(otNetDataPublisherEvent aEvent, void *aContext) typedef
void(*
Этот тип указателя функции определяет обратный вызов, используемый для уведомления, когда запись «Служба DNS / SRP» добавляется или удаляется из сетевых данных потока.
otNetDataPrefixPublisherCallback )(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext) typedef
void(*
Этот тип указателя функции определяет обратный вызов, используемый для уведомления, когда запись префикса (на сетке или внешний маршрут) добавляется или удаляется из сетевых данных потока.
otNetDataPublisherEvent typedef
Это перечисление представляет события, о которых сообщают обратные вызовы издателя.
otNetworkDataIterator typedef
uint32_t
Используется для перебора информации о сетевых данных.
otNetworkDiagChildEntry typedef
Эта структура представляет собой запись в дочерней таблице диагностики сети.
otNetworkDiagConnectivity typedef
Эта структура представляет значение подключения для диагностики сети.
otNetworkDiagIterator typedef
uint16_t
Используется для перебора TLV диагностики сети.
otNetworkDiagMacCounters typedef
Эта структура представляет значение счетчиков Mac для диагностики сети.
otNetworkDiagRoute typedef
Эта структура представляет значение TLV маршрута диагностики сети.
otNetworkDiagRouteData typedef
Эта структура представляет данные маршрута диагностики сети.
otNetworkDiagTlv typedef
Эта структура представляет собой TLV диагностики сети.
otReceiveDiagnosticGetCallback )(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext) typedef
void(*
Этот указатель на функцию вызывается при получении ответа получения диагностики сети.
otRoutePreference typedef
Определяет допустимые значения mPreference в otExternalRouteConfig и otBorderRouterConfig .
otServerConfig typedef
Эта структура представляет конфигурацию Сервера.
otServiceConfig typedef
Эта структура представляет конфигурацию службы.
otThreadAnycastLocatorCallback )(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16) typedef
void(*
Этот тип определяет указатель на функцию обратного вызова для уведомления исход otThreadLocateAnycastDestination() запроса.
otThreadDiscoveryRequestCallback )(const otThreadDiscoveryRequestInfo *aInfo, void *aContext) typedef
void(*
Этот указатель на функцию вызывается каждый раз при получении сообщения MLE Discovery Request.
otThreadDiscoveryRequestInfo typedef
Эта структура представляет данные запроса обнаружения потока.
otThreadParentResponseCallback )(otThreadParentResponseInfo *aInfo, void *aContext) typedef
void(*
Этот указатель на функцию вызывается каждый раз, когда получено сообщение MLE Parent Response.
otThreadParentResponseInfo typedef
Эта структура представляет данные родительского ответа MLE.

Функции

otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Этот метод обеспечивает полную или стабильную копию сетевых данных потоков раздела.
otNetDataGetNextOnMeshPrefix ( otInstance *aInstance, otNetworkDataIterator *aIterator, otBorderRouterConfig *aConfig)
Эта функция получает следующий префикс On Mesh в сетевых данных раздела.
otNetDataGetNextRoute ( otInstance *aInstance, otNetworkDataIterator *aIterator, otExternalRouteConfig *aConfig)
Эта функция получает следующий внешний маршрут в сетевых данных раздела.
otNetDataGetNextService ( otInstance *aInstance, otNetworkDataIterator *aIterator, otServiceConfig *aConfig)
Эта функция получает следующий сервис в сетевых данных раздела.
otNetDataGetStableVersion ( otInstance *aInstance)
uint8_t
Получите стабильную версию сетевых данных.
otNetDataGetVersion ( otInstance *aInstance)
uint8_t
Получите версию сетевых данных.
otNetDataIsDnsSrpServiceAdded ( otInstance *aInstance)
bool
Эта функция указывает, добавлена ​​ли в настоящий момент запись «Служба DNS / SRP» в данные потоковой сети.
otNetDataIsPrefixAdded ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Эта функция указывает, добавлена ​​ли в настоящий момент опубликованная запись префикса (в сети или внешний маршрут) к данным потоковой сети.
otNetDataPublishDnsSrpServiceAnycast ( otInstance *aInstance, uint8_t aSequenceNUmber)
void
Эта функция запрашивает публикацию «произвольного адреса службы DNS / SRP» в сетевых данных потока.
otNetDataPublishDnsSrpServiceUnicast ( otInstance *aInstance, const otIp6Address *aAddress, uint16_t aPort)
void
Эта функция запрашивает публикацию «Одноадресного адреса службы DNS / SRP» в сетевых данных потока.
otNetDataPublishDnsSrpServiceUnicastMeshLocalEid ( otInstance *aInstance, uint16_t aPort)
void
Эта функция запрашивает публикацию «Одноадресного адреса службы DNS / SRP» в сетевых данных потока.
otNetDataPublishExternalRoute ( otInstance *aInstance, const otExternalRouteConfig *aConfig)
Эта функция запрашивает публикацию префикса внешнего маршрута в данных сети потока.
otNetDataPublishOnMeshPrefix ( otInstance *aInstance, const otBorderRouterConfig *aConfig)
Эта функция запрашивает публикацию префикса в сетке в данных потоковой сети.
otNetDataSetDnsSrpServicePublisherCallback ( otInstance *aInstance, otNetDataDnsSrpServicePublisherCallback aCallback, void *aContext)
void
Эта функция устанавливает обратный вызов для уведомления, когда опубликованная «Служба DNS / SRP» фактически добавлена ​​или удалена из данных сети потока.
otNetDataSetPrefixPublisherCallback ( otInstance *aInstance, otNetDataPrefixPublisherCallback aCallback, void *aContext)
void
Эта функция устанавливает обратный вызов для уведомления, когда опубликованная запись префикса фактически добавлена ​​или удалена из данных сети потока.
otNetDataSteeringDataCheckJoiner ( otInstance *aInstance, const otExtAddress *aEui64)
Проверьте, есть ли в данных рулевого управления Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner ( otInstance *aInstance, const struct otJoinerDiscerner *aDiscerner)
Проверьте, есть ли в данных рулевого управления Joiner с заданным значением различения.
otNetDataUnpublishDnsSrpService ( otInstance *aInstance)
void
Эта функция отменяет публикацию любой ранее добавленной записи «Служба DNS / SRP (Anycast или Unicast)» из данных потоковой сети.
otNetDataUnpublishPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
Эта функция отменяет публикацию ранее опубликованного префикса (на сетке или внешнем маршруте).
otThreadBecomeChild ( otInstance *aInstance)
Попытайтесь снова подключиться в детстве.
otThreadBecomeDetached ( otInstance *aInstance)
Отключитесь от сети Thread.
otThreadDeviceRoleToString ( otDeviceRole aRole)
const char *
Преобразуйте роль устройства в удобочитаемую строку.
otThreadDiscover ( otInstance *aInstance, uint32_t aScanChannels, uint16_t aPanId, bool aJoiner, bool aEnableEui64Filtering, otHandleActiveScanResult aCallback, void *aCallbackContext)
Эта функция запускает сканирование с обнаружением потоков.
otThreadGetChildTimeout ( otInstance *aInstance)
uint32_t
Получите время ожидания дочернего потока, используемое при работе в роли ребенка.
otThreadGetDeviceRole ( otInstance *aInstance)
Получите роль устройства.
otThreadGetDomainName ( otInstance *aInstance)
const char *
Получите доменное имя потока.
otThreadGetExtendedPanId ( otInstance *aInstance)
Получите расширенный идентификатор PAN IEEE 802.15.4.
otThreadGetFixedDuaInterfaceIdentifier ( otInstance *aInstance)
Получите идентификатор интерфейса, указанный вручную для одноадресного адреса домена потока.
otThreadGetIp6Counters ( otInstance *aInstance)
const otIpCounters *
Получите счетчики IPv6.
otThreadGetKeySequenceCounter ( otInstance *aInstance)
uint32_t
Получите thKeySequenceCounter.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
Получите thKeySwitchGuardTime.
otThreadGetLeaderData ( otInstance *aInstance, otLeaderData *aLeaderData)
Эта функция получает данные лидера потока.
otThreadGetLeaderRloc ( otInstance *aInstance, otIp6Address *aLeaderRloc)
Эта функция возвращает указатель на RLOC лидера.
otThreadGetLeaderRouterId ( otInstance *aInstance)
uint8_t
Получите идентификатор маршрутизатора лидера.
otThreadGetLeaderWeight ( otInstance *aInstance)
uint8_t
Получите вес лидера.
otThreadGetLinkLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Эта функция возвращает адрес многоадресной рассылки Thread Link - Local All Thread Nodes.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
Эта функция возвращает локальный IPv6-адрес ссылки потока.
otThreadGetLinkMode ( otInstance *aInstance)
Получите конфигурацию режима связи MLE.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
Эта функция возвращает указатель на адрес Mesh Local EID.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
Эта функция возвращает указатель на локальный префикс сетки.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
Получите счетчики потоков MLE.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Получите сетевой ключ потока.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
Получить otNetworkKeyRef Резьба Network Key.
otThreadGetNetworkName ( otInstance *aInstance)
const char *
Получите имя сети потока.
otThreadGetNextDiagnosticTlv (const otMessage *aMessage, otNetworkDiagIterator *aIterator, otNetworkDiagTlv *aNetworkDiagTlv)
Эта функция получает в сообщении следующий TLV диагностики сети.
otThreadGetNextNeighborInfo ( otInstance *aInstance, otNeighborInfoIterator *aIterator, otNeighborInfo *aInfo)
Эта функция получает информацию о следующем соседе.
otThreadGetParentAverageRssi ( otInstance *aInstance, int8_t *aParentRssi)
Функция извлекает средний RSSI для родительского потока.
otThreadGetParentInfo ( otInstance *aInstance, otRouterInfo *aParentInfo)
Функция извлекает диагностическую информацию для потокового маршрутизатора как родительского.
otThreadGetParentLastRssi ( otInstance *aInstance, int8_t *aLastRssi)
Функция извлекает RSSI последнего пакета из родительского потока.
otThreadGetPartitionId ( otInstance *aInstance)
uint32_t
Получите идентификатор раздела.
otThreadGetRealmLocalAllThreadNodesMulticastAddress ( otInstance *aInstance)
const otIp6Address *
Эта функция возвращает многоадресный адрес для всех узлов потоков в области потоков.
otThreadGetRloc ( otInstance *aInstance)
const otIp6Address *
Эта функция возвращает указатель на адрес локатора маршрутизации потоков (RLOC).
otThreadGetRloc16 ( otInstance *aInstance)
uint16_t
Получите RLOC16.
otThreadGetServiceAloc ( otInstance *aInstance, uint8_t aServiceId, otIp6Address *aServiceAloc)
Эта функция извлекает служебный ALOC для данного идентификатора службы.
otThreadGetVersion (void)
uint16_t
Эта функция получает версию протокола потока.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
Эта функция указывает, выполняется ли в настоящее время запрос на поиск с помощью anycast.
otThreadIsDiscoverInProgress ( otInstance *aInstance)
bool
Эта функция определяет, выполняется ли в настоящее время обнаружение потоков MLE.
otThreadIsSingleton ( otInstance *aInstance)
bool
Эта функция указывает, является ли узел единственным маршрутизатором в сети.
otThreadLocateAnycastDestination ( otInstance *aInstance, const otIp6Address *aAnycastAddress, otThreadAnycastLocatorCallback aCallback, void *aContext)
Эта функция запрашивает местонахождение ближайшего пункта назначения данного произвольного адреса.
otThreadRegisterParentResponseCallback ( otInstance *aInstance, otThreadParentResponseCallback aCallback, void *aContext)
void
Эта функция регистрирует обратный вызов для получения данных родительского ответа MLE.
otThreadResetIp6Counters ( otInstance *aInstance)
void
Сбросьте счетчики IPv6.
otThreadResetMleCounters ( otInstance *aInstance)
void
Сбросьте счетчики потоков MLE.
otThreadSendAddressNotification ( otInstance *aInstance, otIp6Address *aDestination, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid)
void
Эта функция отправляет сообщение упреждающего уведомления об адресе (ADDR_NTF.ntf).
otThreadSendDiagnosticGet ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount, otReceiveDiagnosticGetCallback aCallback, void *aCallbackContext)
Отправьте запрос диагностики сети.
otThreadSendDiagnosticReset ( otInstance *aInstance, const otIp6Address *aDestination, const uint8_t aTlvTypes[], uint8_t aCount)
Отправьте запрос на сброс диагностики сети.
otThreadSendProactiveBackboneNotification ( otInstance *aInstance, otIp6Address *aTarget, otIp6InterfaceIdentifier *aMlIid, uint32_t aTimeSinceLastTransaction)
Эта функция отправляет сообщение Proactive Backbone Notification (PRO_BB.ntf) по ссылке Backbone.
otThreadSetChildTimeout ( otInstance *aInstance, uint32_t aTimeout)
void
Установите время ожидания дочернего потока, используемое при работе с дочерней ролью.
otThreadSetDiscoveryRequestCallback ( otInstance *aInstance, otThreadDiscoveryRequestCallback aCallback, void *aContext)
void
Эта функция устанавливает обратный вызов для получения данных запроса обнаружения MLE.
otThreadSetDomainName ( otInstance *aInstance, const char *aDomainName)
Задайте доменное имя потока.
otThreadSetEnabled ( otInstance *aInstance, bool aEnabled)
Эта функция запускает работу протокола потока.
otThreadSetExtendedPanId ( otInstance *aInstance, const otExtendedPanId *aExtendedPanId)
Установите расширенный идентификатор PAN IEEE 802.15.4.
otThreadSetFixedDuaInterfaceIdentifier ( otInstance *aInstance, const otIp6InterfaceIdentifier *aIid)
Установите / очистите идентификатор интерфейса, указанный вручную для одноадресного адреса домена потока.
otThreadSetJoinerAdvertisement ( otInstance *aInstance, uint32_t aOui, const uint8_t *aAdvData, uint8_t aAdvDataLength)
Этот метод устанавливает объявление присоединения к потоку при обнаружении сети потоков.
otThreadSetKeySequenceCounter ( otInstance *aInstance, uint32_t aKeySequenceCounter)
void
Установите thKeySequenceCounter.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Установите thKeySwitchGuardTime.
otThreadSetLinkMode ( otInstance *aInstance, otLinkModeConfig aConfig)
Установите конфигурацию режима связи MLE.
otThreadSetMeshLocalPrefix ( otInstance *aInstance, const otMeshLocalPrefix *aMeshLocalPrefix)
Эта функция устанавливает локальный префикс сетки.
otThreadSetNetworkKey ( otInstance *aInstance, const otNetworkKey *aKey)
Установите сетевой ключ потока.
otThreadSetNetworkKeyRef ( otInstance *aInstance, otNetworkKeyRef aKeyRef)
Установите тему сетевой ключ как otNetworkKeyRef .
otThreadSetNetworkName ( otInstance *aInstance, const char *aNetworkName)
Задайте имя сети потока.

Структуры

otBorderRouterConfig

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

otExternalRouteConfig

Эта структура представляет конфигурацию внешнего маршрута.

otIpCounters

Эта структура представляет счетчики уровня IP.

otLeaderData

Эта структура представляет данные лидера потока.

otLinkModeConfig

Эта структура представляет конфигурацию режима соединения MLE.

otMleCounters

Эта структура представляет счетчики потоков MLE.

otNeighborInfo

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

otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters

Эта структура представляет значение счетчиков Mac для диагностики сети.

otNetworkDiagRoute

Эта структура представляет значение TLV маршрута диагностики сети.

otNetworkDiagRouteData

Эта структура представляет данные маршрута диагностики сети.

otNetworkDiagTlv

Эта структура представляет собой TLV диагностики сети.

otRouterInfo

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

otServerConfig

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

otServiceConfig

Эта структура представляет конфигурацию службы.

otThreadDiscoveryRequestInfo

Эта структура представляет данные запроса обнаружения потока.

otThreadParentResponseInfo

Эта структура представляет данные родительского ответа MLE.

Перечисления

анонимное перечисление

 anonymous enum
Характеристики
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

Уровень заряда батареи TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

TLV страниц канала.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE

Дочерняя таблица TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY

Связь TLV.

OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS

TLV расширенного адреса MAC.

OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST

TLV списка адресов IPv6.

OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA

TLV данных лидера.

OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS

MAC Счетчики TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT

Максимальное время ожидания дочернего TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Режим TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

TLV сетевых данных.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

Route64 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Адрес16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

Напряжение питания ПДК.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

Тайм-аут TLV (максимальный период времени опроса для SED)

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Тип Список TLV.

otDeviceRole

 otDeviceRole

Представляет роль устройства потока.

Характеристики
OT_DEVICE_ROLE_CHILD

Дочерняя роль потока.

OT_DEVICE_ROLE_DETACHED

В настоящее время не участвует в сети / разделе потока.

OT_DEVICE_ROLE_DISABLED

Стек потоков отключен.

OT_DEVICE_ROLE_LEADER

Роль лидера потока.

OT_DEVICE_ROLE_ROUTER

Роль маршрутизатора потоков.

otNetDataPublisherEvent

 otNetDataPublisherEvent

Это перечисление представляет события, о которых сообщают обратные вызовы издателя.

Характеристики
OT_NETDATA_PUBLISHER_EVENT_ENTRY_ADDED

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

OT_NETDATA_PUBLISHER_EVENT_ENTRY_REMOVED

Опубликованная запись удаляется из сетевых данных потока.

otRoutePreference

 otRoutePreference

Определяет допустимые значения mPreference в otExternalRouteConfig и otBorderRouterConfig .

Характеристики
OT_ROUTE_PREFERENCE_HIGH

Высокое предпочтение маршрута.

OT_ROUTE_PREFERENCE_LOW

Низкое предпочтение маршрута.

OT_ROUTE_PREFERENCE_MED

Среднее предпочтение маршрута.

Typedefs

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

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

otExternalRouteConfig

struct otExternalRouteConfig otExternalRouteConfig

Эта структура представляет конфигурацию внешнего маршрута.

otIpCounters

struct otIpCounters otIpCounters

Эта структура представляет счетчики уровня IP.

otLeaderData

struct otLeaderData otLeaderData

Эта структура представляет данные лидера потока.

otLinkModeConfig

struct otLinkModeConfig otLinkModeConfig

Эта структура представляет конфигурацию режима соединения MLE.

otMleCounters

struct otMleCounters otMleCounters

Эта структура представляет счетчики потоков MLE.

otNeighborInfoIterator

int16_t otNeighborInfoIterator

Используется для перебора соседней таблицы.

otNetDataDnsSrpServicePublisherCallback

void(* otNetDataDnsSrpServicePublisherCallback)(otNetDataPublisherEvent aEvent, void *aContext)

Этот тип указателя функции определяет обратный вызов, используемый для уведомления, когда запись «Служба DNS / SRP» добавляется или удаляется из сетевых данных потока.

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

Подробности
Параметры
[in] aEvent
Указывает на событие (была ли запись добавлена ​​или удалена).
[in] aContext
Указатель на контекст приложения.

otNetDataPrefixPublisherCallback

void(* otNetDataPrefixPublisherCallback)(otNetDataPublisherEvent aEvent, const otIp6Prefix *aPrefix, void *aContext)

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

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

Подробности
Параметры
[in] aEvent
Указывает на событие (была ли запись добавлена ​​или удалена).
[in] aPrefix
Указатель на запись префикса.
[in] aContext
Указатель на контекст приложения.

otNetDataPublisherEvent

enum otNetDataPublisherEvent otNetDataPublisherEvent

Это перечисление представляет события, о которых сообщают обратные вызовы издателя.

otNetworkDataIterator

uint32_t otNetworkDataIterator

Используется для перебора информации о сетевых данных.

otNetworkDiagChildEntry

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

otNetworkDiagIterator

uint16_t otNetworkDiagIterator

Используется для перебора TLV диагностики сети.

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

Эта структура представляет значение счетчиков Mac для диагностики сети.

См RFC 2863 для определения полей членов.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

Эта структура представляет значение TLV маршрута диагностики сети.

otNetworkDiagRouteData

struct otNetworkDiagRouteData otNetworkDiagRouteData

Эта структура представляет данные маршрута диагностики сети.

otNetworkDiagTlv

struct otNetworkDiagTlv otNetworkDiagTlv

Эта структура представляет собой TLV диагностики сети.

otReceiveDiagnosticGetCallback

void(* otReceiveDiagnosticGetCallback)(otError aError, otMessage *aMessage, const otMessageInfo *aMessageInfo, void *aContext)

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

Подробности
Параметры
[in] aError
Ошибка, когда не удалось получить ответ.
[in] aMessage
Указатель на буфер сообщений, содержащий полученную полезную нагрузку ответа на диагностику сети. Доступно только тогда , когда aError является OT_ERROR_NONE .
[in] aMessageInfo
Указатель на информационное сообщение для aMessage . Доступно только тогда , когда aError является OT_ERROR_NONE .
[in] aContext
Указатель на контекст приложения.

otRoutePreference

enum otRoutePreference otRoutePreference

Определяет допустимые значения mPreference в otExternalRouteConfig и otBorderRouterConfig .

otServerConfig

struct otServerConfig otServerConfig

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

otServiceConfig

struct otServiceConfig otServiceConfig

Эта структура представляет конфигурацию службы.

otThreadAnycastLocatorCallback

void(* otThreadAnycastLocatorCallback)(void *aContext, otError aError, const otIp6Address *aMeshLocalAddress, uint16_t aRloc16)

Этот тип определяет указатель на функцию обратного вызова для уведомления исход otThreadLocateAnycastDestination() запроса.

Подробности
Параметры
[in] aContext
Указатель на произвольный контекст (предоставляется при регистрации обратного вызова).
[in] aError
Ошибка при обработке запроса. OT_ERROR_NONE указывает на успех. OT_ERROR_RESPONSE_TIMEOUT указывает, что пункт назначения не может быть найден. OT_ERROR_ABORT указывает, что запрос был прерван.
[in] aMeshLocalAddress
Указатель на сетчатой локальной ЭИД из ближайшего назначения адреса эникастного когда aError является OT_ERROR_NONE, NULL в противном случае.
[in] aRloc16
RLOC16 места назначения, если он найден, в противном случае - недействительный RLOC16 (0xfffe).

otThreadDiscoveryRequestCallback

void(* otThreadDiscoveryRequestCallback)(const otThreadDiscoveryRequestInfo *aInfo, void *aContext)

Этот указатель на функцию вызывается каждый раз при получении сообщения MLE Discovery Request.

Подробности
Параметры
[in] aInfo
Указатель на информационные данные запроса обнаружения.
[in] aContext
Указатель на контекст, зависящий от приложения обратного вызова.

otThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

Эта структура представляет данные запроса обнаружения потока.

otThreadParentResponseCallback

void(* otThreadParentResponseCallback)(otThreadParentResponseInfo *aInfo, void *aContext)

Этот указатель на функцию вызывается каждый раз, когда получено сообщение MLE Parent Response.

Подробности
Параметры
[in] aStats
указатель на место в стеке, содержащее данные статистики.
[in] aContext
Указатель на контекст, зависящий от клиента обратного вызова.

otThreadParentResponseInfo

struct otThreadParentResponseInfo otThreadParentResponseInfo

Эта структура представляет данные родительского ответа MLE.

Функции

otNetDataGet

otError otNetDataGet(
  otInstance *aInstance,
  bool aStable,
  uint8_t *aData,
  uint8_t *aDataLength
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aStable
ИСТИНА при копировании стабильной версии, ЛОЖЬ при копировании полной версии.
[out] aData
Указатель на буфер данных.
[in,out] aDataLength
На входе, размер буфера данных , на который указывает aData . При выходе количество скопированных байтов.

otNetDataGetNextOnMeshPrefix

otError otNetDataGetNextOnMeshPrefix(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otBorderRouterConfig *aConfig
)

Эта функция получает следующий префикс On Mesh в сетевых данных раздела.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на контекст итератора сетевых данных. Чтобы получить первую запись в сетке, необходимо установить значение OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Указатель на место размещения информации о префиксе сетки.
Возвращаемые значения
OT_ERROR_NONE
Успешно найден следующий префикс On Mesh.
OT_ERROR_NOT_FOUND
Никакого последующего префикса On Mesh в данных потоковой сети не существует.

otNetDataGetNextRoute

otError otNetDataGetNextRoute(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otExternalRouteConfig *aConfig
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на контекст итератора сетевых данных. Чтобы получить первую запись внешнего маршрута, необходимо установить значение OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Указатель на место размещения информации о внешнем маршруте.
Возвращаемые значения
OT_ERROR_NONE
Успешно найден следующий внешний маршрут.
OT_ERROR_NOT_FOUND
В данных потоковой сети нет последующей записи внешнего маршрута.

otNetDataGetNextService

otError otNetDataGetNextService(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otServiceConfig *aConfig
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на контекст итератора сетевых данных. Чтобы получить первую запись службы, она должна быть установлена ​​на OT_NETWORK_DATA_ITERATOR_INIT.
[out] aConfig
Указатель на место размещения служебной информации.
Возвращаемые значения
OT_ERROR_NONE
Успешно нашел следующую услугу.
OT_ERROR_NOT_FOUND
В сетевых данных раздела нет последующей службы.

otNetDataGetStableVersion

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

Получите стабильную версию сетевых данных.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Версия стабильных сетевых данных.

otNetDataGetVersion

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

Получите версию сетевых данных.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Версия сетевых данных.

otNetDataIsDnsSrpServiceAdded

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

Эта функция указывает, добавлена ​​ли в настоящий момент запись «Служба DNS / SRP» в данные потоковой сети.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE быть включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
TRUE
Опубликованная запись службы DNS / SRP добавляется к данным сети потока.
FALSE
Запись не добавляется в данные потоковой сети или отсутствует запись для публикации.

otNetDataIsPrefixAdded

bool otNetDataIsPrefixAdded(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

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

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE быть включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPrefix
Указатель на префикс (НЕ ДОЛЖЕН быть NULL).
Возвращаемые значения
TRUE
Опубликованная запись префикса добавляется к данным потоковой сети.
FALSE
Запись не добавляется в данные потоковой сети или отсутствует запись для публикации.

otNetDataPublishDnsSrpServiceAnycast

void otNetDataPublishDnsSrpServiceAnycast(
  otInstance *aInstance,
  uint8_t aSequenceNUmber
)

Эта функция запрашивает публикацию «произвольного адреса службы DNS / SRP» в сетевых данных потока.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE быть включена.

Вызов этой функции будет удалить и заменить всю предыдущую «/ DNS SRP Service» запись , которая в настоящее время опубликована (от ранее вызова любого из otNetDataPublishDnsSrpService{Type}() функция).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aSequenceNUmber
Порядковый номер DNS / SRP Anycast Service.

otNetDataPublishDnsSrpServiceUnicast

void otNetDataPublishDnsSrpServiceUnicast(
  otInstance *aInstance,
  const otIp6Address *aAddress,
  uint16_t aPort
)

Эта функция запрашивает публикацию «Одноадресного адреса службы DNS / SRP» в сетевых данных потока.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE быть включена.

Вызов этой функции будет удалить и заменить всю предыдущую «/ DNS SRP Service» запись , которая в настоящее время опубликована (от ранее вызова любого из otNetDataPublishDnsSrpService{Type}() функция).

Эта функция публикует «Одноадресный адрес службы DNS / SRP», включая информацию об адресе и порте в данные TLV службы.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aAddress
Адрес сервера DNS / SRP для публикации (НЕ ДОЛЖЕН быть NULL).
[in] aPort
Номер порта сервера SRP для публикации.

otNetDataPublishDnsSrpServiceUnicastMeshLocalEid

void otNetDataPublishDnsSrpServiceUnicastMeshLocalEid(
  otInstance *aInstance,
  uint16_t aPort
)

Эта функция запрашивает публикацию «Одноадресного адреса службы DNS / SRP» в сетевых данных потока.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE быть включена.

Вызов этой функции будет удалить и заменить всю предыдущую «/ DNS SRP Service» запись , которая в настоящее время опубликована (от ранее вызова любого из otNetDataPublishDnsSrpService{Type}() функция).

В отличии от otNetDataPublishDnsSrpServiceUnicast() , который требует опубликованного адреса , который будет даным и включает в себя информацию в данной Service ППЗА, эта функция использует сетки локального EID устройства и включает в себя информацию в данном сервере TLV.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPort
Номер порта сервера SRP для публикации.

otNetDataPublishExternalRoute

otError otNetDataPublishExternalRoute(
  otInstance *aInstance,
  const otExternalRouteConfig *aConfig
)

Эта функция запрашивает публикацию префикса внешнего маршрута в данных сети потока.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE быть включена.

Только стабильные записи могут быть опубликованы (т.е. aConfig.mStable должен быть TRUE).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aConfig
Конфигурация внешнего маршрута для публикации (НЕ ДОЛЖНА быть ПУСТОЙ).
Возвращаемые значения
OT_ERROR_NONE
Внешний маршрут опубликован успешно.
OT_ERROR_INVALID_ARGS
aConfig не действует (плохой префикс, недопустимые комбинации флагов, или не стабильный).
OT_ERROR_ALREADY
Запись с таким префиксом уже есть в опубликованном списке.
OT_ERROR_NO_BUFS
Не удалось выделить запись для нового запроса. Издатель поддерживает ограниченное количество записей (общее между на сетчатый префикс и внешний маршрут) определяется конфигурационным OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataPublishOnMeshPrefix

otError otNetDataPublishOnMeshPrefix(
  otInstance *aInstance,
  const otBorderRouterConfig *aConfig
)

Эта функция запрашивает публикацию префикса в сетке в данных потоковой сети.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE быть включена.

Только стабильные записи могут быть опубликованы (т.е. aConfig.mStable должен быть TRUE).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aConfig
Конфигурация префикса в сети для публикации (НЕ ДОЛЖНА быть ПУСТОЙ).
Возвращаемые значения
OT_ERROR_NONE
Префикс на сетке опубликован успешно.
OT_ERROR_INVALID_ARGS
aConfig не действует (плохой префикс, недопустимые комбинации флагов, или не стабильный).
OT_ERROR_ALREADY
Запись с таким префиксом уже есть в опубликованном списке.
OT_ERROR_NO_BUFS
Не удалось выделить запись для нового запроса. Издатель поддерживает ограниченное количество записей (общее между на сетчатый префикс и внешний маршрут) определяется конфигурационным OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

otNetDataSetDnsSrpServicePublisherCallback

void otNetDataSetDnsSrpServicePublisherCallback(
  otInstance *aInstance,
  otNetDataDnsSrpServicePublisherCallback aCallback,
  void *aContext
)

Эта функция устанавливает обратный вызов для уведомления, когда опубликованная «Служба DNS / SRP» фактически добавлена ​​или удалена из данных сети потока.

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

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE быть включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель функции обратного вызова (может иметь значение NULL, если не требуется).
[in] aContext
Указатель приложений конкретного контекста (используется при aCallback вызова).

otNetDataSetPrefixPublisherCallback

void otNetDataSetPrefixPublisherCallback(
  otInstance *aInstance,
  otNetDataPrefixPublisherCallback aCallback,
  void *aContext
)

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

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

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE быть включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель функции обратного вызова (может иметь значение NULL, если не требуется).
[in] aContext
Указатель приложений конкретного контекста (используется при aCallback вызова).

otNetDataSteeringDataCheckJoiner

otError otNetDataSteeringDataCheckJoiner(
  otInstance *aInstance,
  const otExtAddress *aEui64
)

Проверьте, есть ли в данных рулевого управления Joiner.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEui64
Указатель на IEEE EUI-64 объединителя.
Возвращаемые значения
OT_ERROR_NONE
aEui64 включен в данные рулевого управления.
OT_ERROR_INVALID_STATE
Нет данных о рулевом управлении.
OT_ERROR_NOT_FOUND
aEui64 не включен в данных рулевого управления.

otNetDataSteeringDataCheckJoinerWithDiscerner

otError otNetDataSteeringDataCheckJoinerWithDiscerner(
  otInstance *aInstance,
  const struct otJoinerDiscerner *aDiscerner
)

Проверьте, есть ли в данных рулевого управления Joiner с заданным значением различения.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDiscerner
Указатель на Joiner Discerner.
Возвращаемые значения
OT_ERROR_NONE
aDiscerner включен в данные рулевого управления.
OT_ERROR_INVALID_STATE
Нет данных о рулевом управлении.
OT_ERROR_NOT_FOUND
aDiscerner не включен в данных рулевого управления.

otNetDataUnpublishDnsSrpService

void otNetDataUnpublishDnsSrpService(
  otInstance *aInstance
)

Эта функция отменяет публикацию любой ранее добавленной записи «Служба DNS / SRP (Anycast или Unicast)» из данных потоковой сети.

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE быть включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.

otNetDataUnpublishPrefix

otError otNetDataUnpublishPrefix(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix
)

Эта функция отменяет публикацию ранее опубликованного префикса (на сетке или внешнем маршруте).

Эта функция требует , чтобы функция OPENTHREAD_CONFIG_BORDER_ROUTER_ENABLE быть включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPrefix
Префикс отмены публикации (НЕ ДОЛЖЕН быть NULL).
Возвращаемые значения
OT_ERROR_NONE
Префикс был успешно удален.
OT_ERROR_NOT_FOUND
Не удалось найти префикс в опубликованном списке.

otThreadBecomeChild

otError otThreadBecomeChild(
  otInstance *aInstance
)

Попытайтесь снова подключиться в детстве.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_ERROR_NONE
Успешно начать попытку стать ребенком.
OT_ERROR_INVALID_STATE
Тема отключена.

otThreadBecomeDetached

otError otThreadBecomeDetached(
  otInstance *aInstance
)

Отключитесь от сети Thread.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_ERROR_NONE
Успешно отключен от сети потока.
OT_ERROR_INVALID_STATE
Тема отключена.

otThreadDeviceRoleToString

const char * otThreadDeviceRoleToString(
  otDeviceRole aRole
)

Преобразуйте роль устройства в удобочитаемую строку.

Подробности
Параметры
[in] aRole
Роль устройства для преобразования.
Возврат
Строка , представляющая aRole .

otThreadDiscover

otError otThreadDiscover(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aPanId,
  bool aJoiner,
  bool aEnableEui64Filtering,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

Эта функция запускает сканирование с обнаружением потоков.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aScanChannels
Битовый вектор, указывающий, какие каналы сканировать (например, OT_CHANNEL_11_MASK).
[in] aPanId
Фильтр PAN ID (установите значение Broadcast PAN, чтобы отключить фильтр).
[in] aJoiner
Значение флага присоединения в TLV запроса на обнаружение.
[in] aEnableEui64Filtering
TRUE для фильтрации ответов на EUI-64, в противном случае - FALSE.
[in] aCallback
Указатель на функцию, вызываемую при получении ответа MLE Discovery или завершении сканирования.
[in] aCallbackContext
Указатель на контекст приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно запущено сканирование с обнаружением потоков.
OT_ERROR_INVALID_STATE
Интерфейс IPv6 не включен (netif не работает).
OT_ERROR_NO_BUFS
Не удалось выделить сообщение для запроса на обнаружение.
OT_ERROR_BUSY
Сканирование с обнаружением потоков уже выполняется.

otThreadGetChildTimeout

uint32_t otThreadGetChildTimeout(
  otInstance *aInstance
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Значение времени ожидания дочернего потока в секундах.
Смотрите также:
otThreadSetChildTimeout

otThreadGetDeviceRole

otDeviceRole otThreadGetDeviceRole(
  otInstance *aInstance
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_DEVICE_ROLE_DISABLED
Стек потоков отключен.
OT_DEVICE_ROLE_DETACHED
Устройство в настоящее время не участвует в сети / разделе Thread.
OT_DEVICE_ROLE_CHILD
Устройство в настоящее время работает как дочерний поток.
OT_DEVICE_ROLE_ROUTER
В настоящее время устройство работает как маршрутизатор потоков.
OT_DEVICE_ROLE_LEADER
В настоящее время устройство работает как руководитель потока.

otThreadGetDomainName

const char * otThreadGetDomainName(
  otInstance *aInstance
)

Получите доменное имя потока.

Эта функция доступна только начиная с Thread 1.2.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на доменное имя потока.
Смотрите также:
otThreadSetDomainName

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

Получите расширенный идентификатор PAN IEEE 802.15.4.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на расширенный идентификатор PAN IEEE 802.15.4.
Смотрите также:
otThreadSetExtendedPanId

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

Эта функция доступна только с Ветка 1.2 , когда OPENTHREAD_CONFIG_DUA_ENABLE включена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на идентификатор интерфейса, который был установлен вручную, или NULL, если он не был установлен.
Смотрите также:
otThreadSetFixedDuaInterfaceIdentifier

otThreadGetIp6Counters

const otIpCounters * otThreadGetIp6Counters(
  otInstance *aInstance
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на счетчики IPv6.

otThreadGetKeySequenceCounter

uint32_t otThreadGetKeySequenceCounter(
  otInstance *aInstance
)

Получите thKeySequenceCounter.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Значение thrKeySequenceCounter.
Смотрите также:
otThreadSetKeySequenceCounter

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Получите thKeySwitchGuardTime.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Значение thrKeySwitchGuardTime (в часах).
Смотрите также:
otThreadSetKeySwitchGuardTime

otThreadGetLeaderData

otError otThreadGetLeaderData(
  otInstance *aInstance,
  otLeaderData *aLeaderData
)

Эта функция получает данные лидера потока.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aLeaderData
Указатель на место размещения данных выноски.
Возвращаемые значения
OT_ERROR_NONE
Данные лидера получены успешно.
OT_ERROR_DETACHED
В настоящее время не прикреплен.

otThreadGetLeaderRloc

otError otThreadGetLeaderRloc(
  otInstance *aInstance,
  otIp6Address *aLeaderRloc
)

Эта функция возвращает указатель на RLOC лидера.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aLeaderRloc
Указатель на RLOC Лидера.
Возвращаемые значения
OT_ERROR_NONE
Rloc Лидера был успешно записан в aLeaderRloc .
OT_ERROR_INVALID_ARGS
aLeaderRloc был NULL.
OT_ERROR_DETACHED
В настоящее время не прикреплен к разделу потока.

otThreadGetLeaderRouterId

uint8_t otThreadGetLeaderRouterId(
  otInstance *aInstance
)

Получите идентификатор маршрутизатора лидера.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Идентификатор маршрутизатора лидера.

otThreadGetLeaderWeight

uint8_t otThreadGetLeaderWeight(
  otInstance *aInstance
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Вес лидера.

otThreadGetLinkLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetLinkLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Эта функция возвращает адрес многоадресной рассылки Thread Link - Local All Thread Nodes.

Адрес является локальным для канала одноадресным многоадресным адресом на основе префикса [RFC 3306], с:

  • flgs установлено на 3 (P = 1 и T = 1)
  • область действия установлена ​​на 2
  • пленка установлена ​​на 64
  • префикс сети установлен на локальный префикс Mesh
  • ID группы установлен на 1

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на адрес многоадресной рассылки Thread Link - Local All Thread Nodes.

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Эта функция возвращает локальный IPv6-адрес ссылки потока.

Локальный адрес ссылки потока выводится с использованием расширенного адреса IEEE802.15.4 в качестве идентификатора интерфейса.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на локальный IPv6-адрес ссылки потока.

otThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

Получите конфигурацию режима связи MLE.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Конфигурация режима связи MLE.
Смотрите также:
otThreadSetLinkMode

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Эта функция возвращает указатель на адрес Mesh Local EID.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на адрес Mesh Local EID.

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

Эта функция возвращает указатель на локальный префикс сетки.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на локальный префикс сетки.

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

Получите счетчики потоков MLE.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на счетчики потоков MLE.

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

Получите сетевой ключ потока.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aNetworkKey
Указатель на otNetworkkey вернуть тему сетевого ключа.
Смотрите также:
otThreadSetNetworkKey

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Получить otNetworkKeyRef Резьба Network Key.

Эта функция требует , чтобы функция сборки времени OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE быть включен.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Ссылка на сетевой ключ потока, хранящийся в памяти.
Смотрите также:
otThreadSetNetworkKeyRef

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

Получите имя сети потока.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Указатель на имя сети потока.
Смотрите также:
otThreadSetNetworkName

otThreadGetNextDiagnosticTlv

otError otThreadGetNextDiagnosticTlv(
  const otMessage *aMessage,
  otNetworkDiagIterator *aIterator,
  otNetworkDiagTlv *aNetworkDiagTlv
)

Эта функция получает в сообщении следующий TLV диагностики сети.

Последующий вызов этой функции разрешен, только если текущее возвращаемое значение - OT_ERROR_NONE.

Подробности
Параметры
[in] aMessage
Указатель на сообщение.
[in,out] aIterator
Указатель на контекст итератора диагностики сети. Чтобы получить первый TLV диагностики сети, он должен быть установлен на OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT.
[out] aNetworkDiagTlv
Указатель на то, где будет размещена информация TLV диагностики сети.
Возвращаемые значения
OT_ERROR_NONE
Успешно найдено следующее TLV диагностики сети.
OT_ERROR_NOT_FOUND
В сообщении нет последующего TLV диагностики сети.
OT_ERROR_PARSE
Не удалось выполнить синтаксический анализ следующей диагностики сети.

otThreadGetNextNeighborInfo

otError otThreadGetNextNeighborInfo(
  otInstance *aInstance,
  otNeighborInfoIterator *aIterator,
  otNeighborInfo *aInfo
)

Эта функция получает информацию о следующем соседе.

Он используется для просмотра записей в таблице соседей.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in,out] aIterator
Указатель на контекст итератора. Чтобы получить первую соседнюю запись, она должна быть установлена ​​на OT_NEIGHBOR_INFO_ITERATOR_INIT.
[out] aInfo
Указатель на информацию о соседе.
Возвращаемые значения
OT_ERROR_NONE
Успешно найдена следующая соседняя запись в таблице.
OT_ERROR_NOT_FOUND
В таблице нет последующих записей о соседях.
OT_ERROR_INVALID_ARGS
aIterator или aInfo был NULL.

otThreadGetParentAverageRssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

Функция извлекает средний RSSI для родительского потока.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aParentRssi
Указатель на место размещения родительского RSSI.

otThreadGetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

The function retrieves diagnostic information for a Thread Router as parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aParentInfo
A pointer to where the parent router information is placed.

otThreadGetParentLastRssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

The function retrieves the RSSI of the last packet from the Thread Parent.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[out] aLastRssi
A pointer to where the last RSSI should be placed.
Return Values
OT_ERROR_NONE
Successfully retrieved the RSSI data.
OT_ERROR_FAILED
Unable to get RSSI data.
OT_ERROR_INVALID_ARGS
aLastRssi is NULL.

otThreadGetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

Get the Partition ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The Partition ID.

otThreadGetRealmLocalAllThreadNodesMulticastAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

This function returns the Thread Realm-Local All Thread Nodes multicast address.

The address is a realm-local Unicast Prefix-Based Multcast 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

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to Thread Realm-Local All Thread Nodes multicast address.

otThreadGetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

This function returns a pointer to the Thread Routing Locator (RLOC) address.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A pointer to the Thread Routing Locator (RLOC) address.

otThreadGetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Get the RLOC16.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
The RLOC16.

otThreadGetServiceAloc

otError otThreadGetServiceAloc(
  otInstance *aInstance,
  uint8_t aServiceId,
  otIp6Address *aServiceAloc
)

This function retrieves the Service ALOC for given Service ID.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aServiceId
Service ID to get ALOC for.
[out] aServiceAloc
A pointer to output the Service ALOC. MUST NOT BE NULL.
Return Values
OT_ERROR_NONE
Successfully retrieved the Service ALOC.
OT_ERROR_DETACHED
The Thread interface is not currently attached to a Thread Partition.

otThreadGetVersion

uint16_t otThreadGetVersion(
  void
)

This function gets the Thread protocol version.

Details
Returns
the Thread protocol version.

otThreadIsAnycastLocateInProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

This function indicates whether an anycast locate request is currently in progress.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
TRUE if an anycast locate request is currently in progress, FALSE otherwise.

otThreadIsDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

This function determines if an MLE Thread Discovery is currently in progress.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadIsSingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

This function indicates whether a node is the only router on the network.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
TRUE
It is the only router in the network.
FALSE
It is a child or is not a single router in the network.

otThreadLocateAnycastDestination

otError otThreadLocateAnycastDestination(
  otInstance *aInstance,
  const otIp6Address *aAnycastAddress,
  otThreadAnycastLocatorCallback aCallback,
  void *aContext
)

This function requests the closest destination of a given anycast address to be located.

This function is only available when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled.

If a previous request is ongoing, a subsequent call to this function will cancel and replace the earlier request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aAnycastAddress
The anycast address to locate. MUST NOT be NULL.
[in] aCallback
The callback function to report the result.
[in] aContext
An arbitrary context used with aCallback .
Return Values
OT_ERROR_NONE
The request started successfully. aCallback will be invoked to report the result.
OT_ERROR_INVALID_ARGS
The aAnycastAddress is not a valid anycast address or aCallback is NULL.
OT_ERROR_NO_BUFS
Out of buffer to prepare and send the request message.

otThreadRegisterParentResponseCallback

void otThreadRegisterParentResponseCallback(
  otInstance *aInstance,
  otThreadParentResponseCallback aCallback,
  void *aContext
)

This function registers a callback to receive MLE Parent Response data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Parent Response message.
[in] aContext
A pointer to callback client-specific context.

otThreadResetIp6Counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

Reset the IPv6 counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadResetMleCounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

Reset the Thread MLE counters.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

otThreadSendAddressNotification

void otThreadSendAddressNotification(
  otInstance *aInstance,
  otIp6Address *aDestination,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid
)

This function sends a Proactive Address Notification (ADDR_NTF.ntf) message.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
The destination to send the ADDR_NTF.ntf message.
[in] aTarget
The target address of the ADDR_NTF.ntf message.
[in] aMlIid
The ML-IID of the ADDR_NTF.ntf message.

otThreadSendDiagnosticGet

otError otThreadSendDiagnosticGet(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount,
  otReceiveDiagnosticGetCallback aCallback,
  void *aCallbackContext
)

Send a Network Diagnostic Get request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types.
[in] aCount
Number of types in aTlvTypes.
[in] aCallback
A pointer to a function that is called when Network Diagnostic Get response is received or NULL to disable the callback.
[in] aCallbackContext
A pointer to application-specific context.
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_GET.req.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_GET.req.

otThreadSendDiagnosticReset

otError otThreadSendDiagnosticReset(
  otInstance *aInstance,
  const otIp6Address *aDestination,
  const uint8_t aTlvTypes[],
  uint8_t aCount
)

Send a Network Diagnostic Reset request.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDestination
A pointer to destination address.
[in] aTlvTypes
An array of Network Diagnostic TLV types. Currently only Type 9 is allowed.
[in] aCount
Number of types in aTlvTypes
Return Values
OT_ERROR_NONE
Successfully queued the DIAG_RST.ntf.
OT_ERROR_NO_BUFS
Insufficient message buffers available to send DIAG_RST.ntf.

otThreadSendProactiveBackboneNotification

otError otThreadSendProactiveBackboneNotification(
  otInstance *aInstance,
  otIp6Address *aTarget,
  otIp6InterfaceIdentifier *aMlIid,
  uint32_t aTimeSinceLastTransaction
)

This function sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.

This function is only available when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTarget
The target address of the PRO_BB.ntf message.
[in] aMlIid
The ML-IID of the PRO_BB.ntf message.
[in] aTimeSinceLastTransaction
Time since last transaction (in seconds).
Return Values
OT_ERROR_NONE
Successfully sent PRO_BB.ntf on backbone link.
OT_ERROR_NO_BUFS
If insufficient message buffers available.

otThreadSetChildTimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Set the Thread Child Timeout used when operating in the Child role.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aTimeout
The timeout value in seconds.
See also:
otThreadGetChildTimeout

otThreadSetDiscoveryRequestCallback

void otThreadSetDiscoveryRequestCallback(
  otInstance *aInstance,
  otThreadDiscoveryRequestCallback aCallback,
  void *aContext
)

This function sets a callback to receive MLE Discovery Request data.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aCallback
A pointer to a function that is called upon receiving an MLE Discovery Request message.
[in] aContext
A pointer to callback application-specific context.

otThreadSetDomainName

otError otThreadSetDomainName(
  otInstance *aInstance,
  const char *aDomainName
)

Set the Thread Domain Name.

This function is only available since Thread 1.2. This function succeeds only when Thread protocols are disabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aDomainName
A pointer to the Thread Domain Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Domain Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetDomainName

otThreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

This function starts Thread protocol operation.

The interface must be up when calling this function.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aEnabled
TRUE if Thread is enabled, FALSE otherwise.
Return Values
OT_ERROR_NONE
Successfully started Thread protocol operation.
OT_ERROR_INVALID_STATE
The network interface was not not up.

otThreadSetExtendedPanId

otError otThreadSetExtendedPanId(
  otInstance *aInstance,
  const otExtendedPanId *aExtendedPanId
)

Set the IEEE 802.15.4 Extended PAN ID.

This function can only be called while Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aExtendedPanId
A pointer to the IEEE 802.15.4 Extended PAN ID.
Return Values
OT_ERROR_NONE
Successfully set the Extended PAN ID.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetExtendedPanId

otThreadSetFixedDuaInterfaceIdentifier

otError otThreadSetFixedDuaInterfaceIdentifier(
  otInstance *aInstance,
  const otIp6InterfaceIdentifier *aIid
)

Set/Clear the Interface Identifier manually specified for the Thread Domain Unicast Address.

This function is only available since Thread 1.2 when OPENTHREAD_CONFIG_DUA_ENABLE is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aIid
A pointer to the Interface Identifier to set or NULL to clear.
Return Values
OT_ERROR_NONE
Successfully set/cleared the Interface Identifier.
OT_ERROR_INVALID_ARGS
The specified Interface Identifier is reserved.
See also:
otThreadGetFixedDuaInterfaceIdentifier

otThreadSetJoinerAdvertisement

otError otThreadSetJoinerAdvertisement(
  otInstance *aInstance,
  uint32_t aOui,
  const uint8_t *aAdvData,
  uint8_t aAdvDataLength
)

This method sets the Thread Joiner Advertisement when discovering Thread network.

Thread Joiner Advertisement is used to allow a Joiner to advertise its own application-specific information (such as Vendor ID, Product ID, Discriminator, etc.) via a newly-proposed Joiner Advertisement TLV, and to make this information available to Commissioners or Commissioner Candidates without human interaction.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aOui
The Vendor IEEE OUI value that will be included in the Joiner Advertisement. Only the least significant 3 bytes will be used, and the most significant byte will be ignored.
[in] aAdvData
A pointer to the AdvData that will be included in the Joiner Advertisement.
[in] aAdvDataLength
The length of AdvData in bytes.
Return Values
OT_ERROR_NONE
Successfully set Joiner Advertisement.
OT_ERROR_INVALID_ARGS
Invalid AdvData.

otThreadSetKeySequenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Set the thrKeySequenceCounter.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySequenceCounter
The thrKeySequenceCounter value.
See also:
otThreadGetKeySequenceCounter

otThreadSetKeySwitchGuardTime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Set the thrKeySwitchGuardTime.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeySwitchGuardTime
The thrKeySwitchGuardTime value (in hours).
See also:
otThreadGetKeySwitchGuardTime

otThreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Set the MLE Link Mode configuration.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aConfig
A pointer to the Link Mode configuration.
Return Values
OT_ERROR_NONE
Successfully set the MLE Link Mode configuration.
See also:
otThreadGetLinkMode

otThreadSetMeshLocalPrefix

otError otThreadSetMeshLocalPrefix(
  otInstance *aInstance,
  const otMeshLocalPrefix *aMeshLocalPrefix
)

This function sets the Mesh Local Prefix.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aMeshLocalPrefix
A pointer to the Mesh Local Prefix.
Return Values
OT_ERROR_NONE
Successfully set the Mesh Local Prefix.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.

otThreadSetNetworkKey

otError otThreadSetNetworkKey(
  otInstance *aInstance,
  const otNetworkKey *aKey
)

Set the Thread Network Key.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKey
A pointer to a buffer containing the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKey

otThreadSetNetworkKeyRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Set the Thread Network Key as a otNetworkKeyRef .

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

This function requires the build-time feature OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE to be enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aKeyRef
Reference to the Thread Network Key.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Key.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkKeyRef

otThreadSetNetworkName

otError otThreadSetNetworkName(
  otInstance *aInstance,
  const char *aNetworkName
)

Set the Thread Network Name.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aNetworkName
A pointer to the Thread Network Name.
Return Values
OT_ERROR_NONE
Successfully set the Thread Network Name.
OT_ERROR_INVALID_STATE
Thread protocols are enabled.
See also:
otThreadGetNetworkName

Macros

OT_JOINER_ADVDATA_MAX_LENGTH

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Maximum AdvData Length of Joiner Advertisement.

OT_NEIGHBOR_INFO_ITERATOR_INIT

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Initializer for otNeighborInfoIterator.

OT_NETWORK_BASE_TLV_MAX_LENGTH

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

Maximum value length of Thread Base TLV.

OT_NETWORK_DATA_ITERATOR_INIT

 OT_NETWORK_DATA_ITERATOR_INIT 0

Value to initialize otNetworkDataIterator .

OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Size of Network Diagnostic Child Table entry.

OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Initializer for otNetworkDiagIterator.

OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Maximum Number of Network Diagnostic TLV Types to Request or Reset.

OT_NETWORK_MAX_ROUTER_ID

 OT_NETWORK_MAX_ROUTER_ID 62

Maximum Router ID.

OT_SERVER_DATA_MAX_SIZE

 OT_SERVER_DATA_MAX_SIZE 248

Max size of Server Data in bytes. Theoretical limit, practically much lower.

OT_SERVICE_DATA_MAX_SIZE

 OT_SERVICE_DATA_MAX_SIZE 252

Max size of Service Data in bytes.