Общий

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

Краткое содержание

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

Для всех функций в этом модуле необходимо включить 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,
OT_NETWORK_DIAGNOSTIC_TLV_VERSION = 24,
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME = 25,
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL = 26,
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION = 27,
OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION = 28,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD = 29,
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST = 30,
OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR = 31,
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER = 32,
OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID = 33,
OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS = 34
}		 перечисление
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
}		 перечисление
Представляет роль устройства Thread.
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 .

Определения типов

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

Функции

otConvertDurationInSecondsToString (uint32_t aDuration, char *aBuffer, uint16_t aSize)
void
Преобразует длительность uint32_t (в секундах) в удобочитаемую строку.
otNetDataContainsOmrPrefix ( otInstance *aInstance, const otIp6Prefix *aPrefix)
bool
Проверьте, может ли данный префикс действовать как действительный префикс OMR, а также ли сетевые данные лидера содержат этот префикс.
otNetDataGet ( otInstance *aInstance, bool aStable, uint8_t *aData, uint8_t *aDataLength)
Предоставьте полную или стабильную копию данных сети потоков раздела.
otNetDataGetCommissioningDataset ( otInstance *aInstance, otCommissioningDataset *aDataset)
void
Получает набор данных ввода в эксплуатацию из сетевых данных раздела.
otNetDataGetLength ( otInstance *aInstance)
uint8_t
Получите текущую длину (количество байтов) данных сети потоков раздела.
otNetDataGetMaxLength ( otInstance *aInstance)
uint8_t
Получите максимальную наблюдаемую длину данных сети потоков с момента инициализации стека OT или с момента последнего вызова otNetDataResetMaxLength() .
otNetDataGetNextLowpanContextInfo ( otInstance *aInstance, otNetworkDataIterator *aIterator, otLowpanContextInfo *aContextInfo)
Получите следующую информацию об идентификаторе контекста 6LoWPAN в сетевых данных раздела.
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)
Запрашивает публикацию префикса в сети в данных сети потоков.
otNetDataReplacePublishedExternalRoute ( otInstance *aInstance, const otIp6Prefix *aPrefix, const otExternalRouteConfig *aConfig)
Заменяет ранее опубликованный внешний маршрут в данных сети потоков.
otNetDataResetMaxLength ( otInstance *aInstance)
void
Сбросьте отслеживаемую максимальную длину данных сети потоков.
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.
otThreadDetachGracefully ( otInstance *aInstance, otDetachGracefullyCallback aCallback, void *aContext)
Уведомляет другие узлы в сети (если таковые имеются), а затем останавливает работу протокола 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
Получает thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime ( otInstance *aInstance)
uint32_t
Получает thrKeySwitchGuardTime (в часах).
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 *
Получает локальный адрес многоадресной рассылки для всех узлов потока.
otThreadGetLinkLocalIp6Address ( otInstance *aInstance)
const otIp6Address *
Получает локальный IPv6-адрес канала потока.
otThreadGetLinkMode ( otInstance *aInstance)
Получите конфигурацию режима связи MLE.
otThreadGetMaxTimeInQueue ( otInstance *aInstance)
uint32_t
Получает максимальное время нахождения сообщений в очереди передачи.
otThreadGetMeshLocalEid ( otInstance *aInstance)
const otIp6Address *
Получает локальный адрес EID Mesh.
otThreadGetMeshLocalPrefix ( otInstance *aInstance)
Возвращает указатель на локальный префикс сетки.
otThreadGetMleCounters ( otInstance *aInstance)
const otMleCounters *
Получает счетчики MLE потока.
otThreadGetNetworkKey ( otInstance *aInstance, otNetworkKey *aNetworkKey)
void
Получите сетевой ключ потока.
otThreadGetNetworkKeyRef ( otInstance *aInstance)
Получите otNetworkKeyRef для сетевого ключа потока.
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)
Функция получает диагностическую информацию для Thread Router как родительского.
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 службы для данного идентификатора службы.
otThreadGetTimeInQueueHistogram ( otInstance *aInstance, uint16_t *aNumBins, uint32_t *aBinInterval)
const uint32_t *
Получает гистограмму времени нахождения сообщений в очереди передачи.
otThreadGetVendorModel ( otInstance *aInstance)
const char *
Получите строку модели поставщика.
otThreadGetVendorName ( otInstance *aInstance)
const char *
Получите строку имени поставщика.
otThreadGetVendorSwVersion ( otInstance *aInstance)
const char *
Получите строку версии программного обеспечения поставщика.
otThreadGetVersion (void)
uint16_t
Получает версию протокола потока.
otThreadIsAnycastLocateInProgress ( otInstance *aInstance)
bool
Указывает, выполняется ли в данный момент запрос Anycast Location.
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.
otThreadResetTimeInQueueStat ( otInstance *aInstance)
void
Сбрасывает статистику времени нахождения в очереди передачи.
otThreadSearchForBetterParent ( otInstance *aInstance)
Запускает процесс поиска для ребенка лучшего родителя, оставаясь при этом привязанным к своему текущему родителю.
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)
Отправляет сообщение упреждающего уведомления магистральной сети (PRO_BB.ntf) по магистральной ссылке.
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)
Запускает работу протокола Thread.
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
Устанавливает thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime ( otInstance *aInstance, uint32_t aKeySwitchGuardTime)
void
Устанавливает thrKeySwitchGuardTime (в часах).
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)
Задайте имя сети потоков.
otThreadSetVendorModel ( otInstance *aInstance, const char *aVendorModel)
Установите строку модели поставщика.
otThreadSetVendorName ( otInstance *aInstance, const char *aVendorName)
Задайте строку имени поставщика.
otThreadSetVendorSwVersion ( otInstance *aInstance, const char *aVendorSwVersion)
Установите строку версии программного обеспечения поставщика.

Структуры

otBorderRouterConfig

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

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

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

otIpCounters

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

отлидердата

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

отлинкмодеконфиг

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

отловпанконтекстинфо

Представляет информацию идентификатора контекста 6LoWPAN, связанную с префиксом в сетевых данных.

otMleCounters

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

otNeighborInfo

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

отнетворкдиагчайлдэнтри

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

otNetworkDiagConnectivity

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

otNetworkDiagMacCounters

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

otNetworkDiagMleCounters

Представляет значение счетчиков MLE диагностики сети.

otNetworkDiagRoute

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

отнетворкдиагроутедата

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

отнетворкдиагтлв

Представляет TLV сетевой диагностики.

otRouterInfo

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

отсерверконфиг

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

отсервицеконфиг

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

отThreadDiscoveryRequestInfo

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

отСреадпарентреспонсенфо

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

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

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

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

Ответить на TLV.

OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL

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

OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES

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

OT_NETWORK_DIAGNOSTIC_TLV_CHILD

Детский TLV.

OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST

TLV списка дочерних IPv6-адресов.

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_MLE_COUNTERS

Счетчики MLE TLV.

OT_NETWORK_DIAGNOSTIC_TLV_MODE

Режим TLV.

OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA

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

OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID

TLV идентификатора запроса.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTE

TLV Route64.

OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR

TLV соседа маршрутизатора.

OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS

Адрес16 TLV.

OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE

TLV напряжения питания.

OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION

TLV версии стека потоков.

OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT

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

OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST

Введите список TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL

Модель поставщика TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME

Имя поставщика TLV.

OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION

TLV версии ПО поставщика.

OT_NETWORK_DIAGNOSTIC_TLV_VERSION

Версия ТЛВ.

otDeviceRole

 otDeviceRole

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

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

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

OT_DEVICE_ROLE_DETACHED

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

OT_DEVICE_ROLE_DISABLED

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

OT_DEVICE_ROLE_LEADER

Роль лидера темы.

OT_DEVICE_ROLE_ROUTER

Роль Thread Router.

отнетдатапублишеревент

 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

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

Определения типов

otBorderRouterConfig

struct otBorderRouterConfig otBorderRouterConfig

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

otDetachGracelyCallback

void(* otDetachGracefullyCallback)(void *aContext)

Этот обратный вызов сообщает приложению, что процесс отсоединения завершен.

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

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

struct otExternalRouteConfig otExternalRouteConfig

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

otIpCounters

struct otIpCounters otIpCounters

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

отлидердата

struct otLeaderData otLeaderData

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

отлинкмодеконфиг

struct otLinkModeConfig otLinkModeConfig

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

отловпанконтекстинфо

struct otLowpanContextInfo otLowpanContextInfo

Представляет информацию идентификатора контекста 6LoWPAN, связанную с префиксом в сетевых данных.

otMleCounters

struct otMleCounters otMleCounters

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

otNeighborInfoIterator

int16_t otNeighborInfoIterator

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

otNetDataDnsSrpServicePublisherCallback

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

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

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

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

отнетдатапрефикспублишерколлбэк

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

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

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

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

отнетдатапублишеревент

enum otNetDataPublisherEvent otNetDataPublisherEvent

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

otNetworkDataIterator

uint32_t otNetworkDataIterator

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

отнетворкдиагчайлдэнтри

struct otNetworkDiagChildEntry otNetworkDiagChildEntry

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

otNetworkDiagConnectivity

struct otNetworkDiagConnectivity otNetworkDiagConnectivity

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

отнетворкдиагитератор

uint16_t otNetworkDiagIterator

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

otNetworkDiagMacCounters

struct otNetworkDiagMacCounters otNetworkDiagMacCounters

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

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

otNetworkDiagMleCounters

struct otNetworkDiagMleCounters otNetworkDiagMleCounters

Представляет значение счетчиков MLE диагностики сети.

otNetworkDiagRoute

struct otNetworkDiagRoute otNetworkDiagRoute

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

отнетворкдиагроутедата

struct otNetworkDiagRouteData otNetworkDiagRouteData

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

отнетворкдиагтлв

struct otNetworkDiagTlv otNetworkDiagTlv

Представляет TLV сетевой диагностики.

otReceiveDiagnosticGetCallback

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

Указатель вызывается при получении ответа Network Diagnostic Get.

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

otRoutePreference

enum otRoutePreference otRoutePreference

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

отсерверконфиг

struct otServerConfig otServerConfig

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

отсервицеконфиг

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
Указатель на локальный EID ячейки ближайшего пункта назначения произвольного адреса, когда aError имеет значение OT_ERROR_NONE, в противном случае — NULL.
[in] aRloc16
RLOC16 пункта назначения, если он найден, в противном случае недействительный RLOC16 (0xfffe).

otThreadDiscoveryRequestCallback

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

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

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

отThreadDiscoveryRequestInfo

struct otThreadDiscoveryRequestInfo otThreadDiscoveryRequestInfo

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

otThreadParentResponseCallback

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

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

Это используется в otThreadRegisterParentResponseCallback() .

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

отСреадпарентреспонсенфо

struct otThreadParentResponseInfo otThreadParentResponseInfo

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

Функции

отконвертдуратионинсекондстостринг

void otConvertDurationInSecondsToString(
  uint32_t aDuration,
  char *aBuffer,
  uint16_t aSize
)

Преобразует длительность uint32_t (в секундах) в удобочитаемую строку.

Для включения требуется OPENTHREAD_CONFIG_UPTIME_ENABLE .

Строка имеет формат " : : " для часов, минут, секунд (если продолжительность короче одного дня) или "

д. : : » (если дольше суток).

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

Предназначен для использования с mAge или mConnectionTime в структурах otNeighborInfo или otChildInfo .

Подробности
Параметры
[in] aDuration
Интервал продолжительности в секундах.
[out] aBuffer
Указатель на массив символов для вывода строки.
[in] aSize
Размер aBuffer (в байтах). Рекомендуется использовать OT_DURATION_STRING_SIZE .

отнетдатаконтаинсомрпрефикс

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

Проверьте, может ли данный префикс действовать как действительный префикс OMR, а также ли сетевые данные лидера содержат этот префикс.

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

отнетдатажет

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aStable
TRUE при копировании стабильной версии, FALSE при копировании полной версии.
[out] aData
Указатель на буфер данных.
[in,out] aDataLength
При вводе размер буфера данных, на который указывает aData . При выходе количество скопированных байтов.
Возвращаемые значения
OT_ERROR_NONE
Данные сети потоков успешно скопированы в aData и обновлены aDataLength .
OT_ERROR_NO_BUFS
Недостаточно места в aData для полного копирования данных сети потоков.

отнетдатажеткоммиссиондингдатасет

void otNetDataGetCommissioningDataset(
  otInstance *aInstance,
  otCommissioningDataset *aDataset
)

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

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

отнетдатажетленгс

uint8_t otNetDataGetLength(
  otInstance *aInstance
)

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

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

отнетдатажетмаксленгс

uint8_t otNetDataGetMaxLength(
  otInstance *aInstance
)

Получите максимальную наблюдаемую длину данных сети потоков с момента инициализации стека OT или с момента последнего вызова otNetDataResetMaxLength() .

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

отнетдатажетнекстлоупанконтекстинфо

otError otNetDataGetNextLowpanContextInfo(
  otInstance *aInstance,
  otNetworkDataIterator *aIterator,
  otLowpanContextInfo *aContextInfo
)

Получите следующую информацию об идентификаторе контекста 6LoWPAN в сетевых данных раздела.

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

отнетдатажетнекстонмешпрефикс

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

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

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

отнетдатажетнекструте

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
В данных сети потоков не существует последующей записи внешнего маршрута.

отнетдатажетнекстсервице

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
В сетевых данных раздела не существует последующих служб.

отнетдатажетстаблеверсион

uint8_t otNetDataGetStableVersion(
  otInstance *aInstance
)

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

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

отнетдатажетверсион

uint8_t otNetDataGetVersion(
  otInstance *aInstance
)

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

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

отнетдатаисднссрпсервицедобедед

bool otNetDataIsDnsSrpServiceAdded(
  otInstance *aInstance
)

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

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

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

отнетдатаиспрефиксаддед

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» (из предыдущего вызова любой из функций otNetDataPublishDnsSrpService{Type}() ).

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

отнетдатапублишднссрпсервицеюникаст

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

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

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

Вызов этой функции удалит и заменит любую предыдущую опубликованную запись «Служба DNS/SRP» (из предыдущего вызова любой из функций 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» (из предыдущего вызова любой из функций otNetDataPublishDnsSrpService{Type}() ).

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

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

отнетдатапублишекстерналруте

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

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

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

Публиковать можно только стабильные записи (т. е. aConfig.mStable ДОЛЖНО быть TRUE).

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

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

отнетдатапублишонмешпрефикс

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

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

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

Публиковать можно только стабильные записи (т. е. aConfig.mStable ДОЛЖНО быть TRUE).

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

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

отнетдатареплеплепублидекстерналруте

otError otNetDataReplacePublishedExternalRoute(
  otInstance *aInstance,
  const otIp6Prefix *aPrefix,
  const otExternalRouteConfig *aConfig
)

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

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

Если нет ранее опубликованного внешнего маршрута, соответствующего aPrefix , эта функция ведет себя аналогично otNetDataPublishExternalRoute() , то есть запускает процесс публикации aConfig в качестве внешнего маршрута в данных сети потоков.

Если существует ранее опубликованная запись маршрута, соответствующая aPrefix , она будет заменена новым префиксом из aConfig .

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPrefix
Ранее опубликованный префикс внешнего маршрута, который необходимо заменить.
[in] aConfig
Конфигурация внешнего маршрута для публикации.
Возвращаемые значения
OT_ERROR_NONE
Внешний маршрут успешно опубликован.
OT_ERROR_INVALID_ARGS
Недопустимый параметр aConfig (неправильный префикс, недопустимые комбинации флагов или нестабильность).
OT_ERROR_NO_BUFS
Не удалось выделить запись для нового запроса. Издатель поддерживает ограниченное количество записей (совместно используемых префиксом внутри сети и внешним маршрутом), определяемое конфигурацией OPENTHREAD_CONFIG_NETDATA_PUBLISHER_MAX_PREFIX_ENTRIES .

отнетдатаресетмаксленгс

void otNetDataResetMaxLength(
  otInstance *aInstance
)

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

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

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 компании Joiner.
Возвращаемые значения
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 не включается в данные рулевого управления.

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

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
Успешно отключен от сети Thread.
OT_ERROR_INVALID_STATE
Тема отключена.

otThreadDetachизящно

otError otThreadDetachGracefully(
  otInstance *aInstance,
  otDetachGracefullyCallback aCallback,
  void *aContext
)

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

Он отправляет сообщение об освобождении адреса, если это маршрутизатор, или устанавливает тайм-аут дочернего маршрутизатора на 0, если это дочерний маршрутизатор.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aCallback
Указатель на функцию, которая вызывается после завершения отсоединения.
[in] aContext
Указатель на контекст обратного вызова, специфичный для приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно началось отсоединение.
OT_ERROR_BUSY
Отсоединение уже идет.

отThreadDeviceRoleToString

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 или завершении сканирования.
[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.
Возврат
Значение тайм-аута дочернего потока в секундах.
Смотрите также:
отThreadSetChildTimeout

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
)

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

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

otThreadGetExtendedPanId

const otExtendedPanId * otThreadGetExtendedPanId(
  otInstance *aInstance
)

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

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

otThreadGetFixedDuaInterfaceIdentifier

const otIp6InterfaceIdentifier * otThreadGetFixedDuaInterfaceIdentifier(
  otInstance *aInstance
)

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

Доступно, если включен 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
)

Получает thrKeySequenceCounter.

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

otThreadGetKeySwitchGuardTime

uint32_t otThreadGetKeySwitchGuardTime(
  otInstance *aInstance
)

Получает thrKeySwitchGuardTime (в часах).

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

отСреаджетлидердата

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
)

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

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

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

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

otThreadGetLinkLocalIp6Address

const otIp6Address * otThreadGetLinkLocalIp6Address(
  otInstance *aInstance
)

Получает локальный IPv6-адрес канала потока.

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

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

отThreadGetLinkMode

otLinkModeConfig otThreadGetLinkMode(
  otInstance *aInstance
)

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

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

otThreadGetMaxTimeInQueue

uint32_t otThreadGetMaxTimeInQueue(
  otInstance *aInstance
)

Получает максимальное время нахождения сообщений в очереди передачи.

Требуется OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE .

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

Собранную статистику можно сбросить, вызвав otThreadResetTimeInQueueStat() .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Максимальное время нахождения в очереди в миллисекундах для всех сообщений в очереди передачи (на данный момент).

otThreadGetMeshLocalEid

const otIp6Address * otThreadGetMeshLocalEid(
  otInstance *aInstance
)

Получает локальный адрес EID Mesh.

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

otThreadGetMeshLocalPrefix

const otMeshLocalPrefix * otThreadGetMeshLocalPrefix(
  otInstance *aInstance
)

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

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

otThreadGetMleCounters

const otMleCounters * otThreadGetMleCounters(
  otInstance *aInstance
)

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

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

otThreadGetNetworkKey

void otThreadGetNetworkKey(
  otInstance *aInstance,
  otNetworkKey *aNetworkKey
)

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

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

otThreadGetNetworkKeyRef

otNetworkKeyRef otThreadGetNetworkKeyRef(
  otInstance *aInstance
)

Получите otNetworkKeyRef для сетевого ключа потока.

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

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

otThreadGetNetworkName

const char * otThreadGetNetworkName(
  otInstance *aInstance
)

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

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

otThreadGetNextDiagnosticTlv

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

Получает следующий сетевой диагностику TLV в сообщении.

Требуется OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE .

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

Подробности
Параметры
[in] aMessage
Указатель на сообщение.
[in,out] aIterator
Указатель на контекст итератора сети. Чтобы получить первый сетевой диагностику TLV, он должен быть установлен на OT_NETWORD_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 был нулевым.

OtthreadgetParentaVeragerssi

otError otThreadGetParentAverageRssi(
  otInstance *aInstance,
  int8_t *aParentRssi
)

Функция получает средний RSSI для родителя потока.

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

OtthreadgetParentInfo

otError otThreadGetParentInfo(
  otInstance *aInstance,
  otRouterInfo *aParentInfo
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aParentInfo
Указатель, где размещена информация о родительском маршрутизаторе.

OtthreadgetParentLastrssi

otError otThreadGetParentLastRssi(
  otInstance *aInstance,
  int8_t *aLastRssi
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aLastRssi
Указатель на то, где должен быть размещен последний RSSI.
Возвращаемые значения
OT_ERROR_NONE
Успешно извлечен данные RSSI.
OT_ERROR_FAILED
Невозможно получить данные RSSI.
OT_ERROR_INVALID_ARGS
aLastRssi - ноль.

OtthreadgetPartitionId

uint32_t otThreadGetPartitionId(
  otInstance *aInstance
)

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

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

OtthreadgetRealMlocalAllThreadNodesMulticAstAddress

const otIp6Address * otThreadGetRealmLocalAllThreadNodesMulticastAddress(
  otInstance *aInstance
)

Получает многоадресный адрес многодзового узла.

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

  • FLGS устанавливает 3 (P = 1 и T = 1)
  • SCOP установлена ​​3
  • PLEN SET 64
  • Префикс сети установлен в локальный префикс сетки
  • идентификатор группы установлен на 1

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

OtthreadgetRloc

const otIp6Address * otThreadGetRloc(
  otInstance *aInstance
)

Получает адрес локатора маршрутизации потока (RLOC).

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

OtthreadgetRloc16

uint16_t otThreadGetRloc16(
  otInstance *aInstance
)

Получите RLOC16.

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

OtthreadgetServicealoc

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

Получает сервис Aloc для данного идентификатора обслуживания.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aServiceId
Идентификатор обслуживания, чтобы получить Aloc для.
[out] aServiceAloc
Указатель на вывод Сервиса ALOC. Не должен быть нулевым.
Возвращаемые значения
OT_ERROR_NONE
Успешно восстановил сервис Aloc.
OT_ERROR_DETACHED
Интерфейс потока в настоящее время не прикреплен к разделу потока.

OtthreadgetTimeInqueueuehistogram

const uint32_t * otThreadGetTimeInQueueHistogram(
  otInstance *aInstance,
  uint16_t *aNumBins,
  uint32_t *aBinInterval
)

Получает гистограмму времени в ходе сообщений в очереди TX.

Требуется OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE .

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

Гистограмма возвращается как массив значений uint32_t с записями aNumBins . Первая запись в массиве (в индексе 0) представляет количество сообщений с временем в ходе, чем aBinInterval . Вторая запись представляет количество сообщений с временем в ходе, больше или равным aBinInterval , но менее 2 * aBinInterval . И так далее. Последняя запись представляет количество сообщений с временем в ходе, больше или равным (aNumBins - 1) * aBinInterval .

Собранная статистика может быть сброшена, вызывая otThreadResetTimeInQueueStat() . Информация о гистограмме собирается с тех пор, как экземпляр OpenthRead был инициализирован или с тех пор, как статистика в последний раз была сброшена, вызывая otThreadResetTimeInQueueStat() .

Указатели aNumBins и aBinInterval не должны быть нулевыми.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aNumBins
Указатель вернуть количество бункеров в гистограмме (длина массива).
[out] aBinInterval
Указатель вернуть длину интервала бина гистограммы в миллисекундах.
Возврат
Указатель на массив записей aNumBins , представляющих собранную информацию о гистограмме.

OtthreadgetVendormodel

const char * otThreadGetVendorModel(
  otInstance *aInstance
)

Получите строку модели поставщика.

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

OtthreadgetVendorname

const char * otThreadGetVendorName(
  otInstance *aInstance
)

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

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

OtthreadgetVendorsWversion

const char * otThreadGetVendorSwVersion(
  otInstance *aInstance
)

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

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

OtthreadgetVersion

uint16_t otThreadGetVersion(
  void
)

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

Подробности
Возврат
Версия протокола потока.

OtthreadisanycastlocateinProgress

bool otThreadIsAnycastLocateInProgress(
  otInstance *aInstance
)

Указывает, находится ли в настоящее время запрос на местонахождение AnyCast.

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

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

OtthreadisDiscoverInProgress

bool otThreadIsDiscoverInProgress(
  otInstance *aInstance
)

Определяет, находится ли в настоящее время обнаружение потока MLE.

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

Otthreadissingleton

bool otThreadIsSingleton(
  otInstance *aInstance
)

Указывает, является ли узел единственным маршрутизатором в сети.

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

OtthreadlocateanyCastDestination

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

Запрашивает ближайший пункт назначения данного адреса AnyCast, который будет расположен.

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aAnycastAddress
Адрес AnyCast для поиска. Не должен быть нулевым.
[in] aCallback
Функция обратного вызова, чтобы сообщить о результате.
[in] aContext
Произвольный контекст, используемый с aCallback .
Возвращаемые значения
OT_ERROR_NONE
Запрос начался успешно. aCallback будет вызван, чтобы сообщить о результате.
OT_ERROR_INVALID_ARGS
aAnycastAddress не является действительным адресом AnyCast, или aCallback является нулевым.
OT_ERROR_NO_BUFS
Вне буфера, чтобы подготовиться и отправить сообщение запроса.

OtthreadRegisterParentResponseCallback

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

Регистрирует обратный вызов, чтобы получить данные родителей MLE.

Требуется OPENTHREAD_CONFIG_MLE_PARENT_RESPONSE_CALLBACK_API_ENABLE .

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

OtthreadResetip6counters

void otThreadResetIp6Counters(
  otInstance *aInstance
)

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

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

Otthreadresetmlecounters

void otThreadResetMleCounters(
  otInstance *aInstance
)

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

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

OtthreadResettimeInqueEStat

void otThreadResetTimeInQueueStat(
  otInstance *aInstance
)

Сбрасывает статистику времени в очереди TX.

Требуется OPENTHREAD_CONFIG_TX_QUEUE_STATISTICS_ENABLE .

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

OtthreadSearchForeBetterParent

otError otThreadSearchForBetterParent(
  otInstance *aInstance
)

Запускает процесс для ребенка, чтобы искать лучшего родителя, оставаясь прикрепленным к его нынешнему родителю.

Должен использоваться, когда устройство прикреплено в детстве.

Подробности
Возвращаемые значения
OT_ERROR_NONE
Успешно начал процесс для поиска лучшего родителя.
OT_ERROR_INVALID_STATE
Роль устройства не является ребенком.

OtthreadSendAddressNotification

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

Отправляет сообщение об уведомлении о проактивном адресе (addr_ntf.ntf).

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Назначение отправить сообщение addr_ntf.ntf.
[in] aTarget
Целевой адрес сообщения ADDR_NTF.NTF.
[in] aMlIid
ML-IID сообщения addr_ntf.ntf.

OtthreadSendDiAgnosticget

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

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

Требуется OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Указатель на адрес назначения.
[in] aTlvTypes
Массив сетевых диагностических типов TLV.
[in] aCount
Количество типов в AtlvTypes.
[in] aCallback
Указатель на функцию, которая вызывается, когда сетевой диагностический ответ получен или нулевой, чтобы отключить обратный вызов.
[in] aCallbackContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно в очереди diag_get.req.
OT_ERROR_NO_BUFS
Недостаточно буферов сообщений, доступных для отправки diag_get.req.

OtthreadSendDiAgnosticReset

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

Отправить запрос на сброс диагностики сети.

Требуется OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDestination
Указатель на адрес назначения.
[in] aTlvTypes
Массив сетевых диагностических типов TLV. В настоящее время разрешен только тип 9.
[in] aCount
Количество типов в атлвтипе
Возвращаемые значения
OT_ERROR_NONE
Успешно в очереди diag_rst.ntf.
OT_ERROR_NO_BUFS
Недостаточно буферов сообщений, доступных для отправки diag_rst.ntf.

OtthreadsendProactainatebackbonenotification

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

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aTarget
Целевой адрес сообщения pro_bb.ntf.
[in] aMlIid
ML-IID сообщения pro_bb.ntf.
[in] aTimeSinceLastTransaction
Время с момента последней транзакции (в секундах).
Возвращаемые значения
OT_ERROR_NONE
Успешно отправил Pro_bb.ntf на ссылке на основу.
OT_ERROR_NO_BUFS
Если доступен недостаточно буферов сообщений.

OtthreadsetchIdmimeout

void otThreadSetChildTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aTimeout
Значение тайм -аута за секунды.
Смотрите также:
OtthreadgetChildtimeout

OtthreadSetDiscoveryRequestCallback

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

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

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

OtthreadSetDomainName

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

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

Преуспевает только тогда, когда протоколы резьбы отключены.

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

OtthreadSetEnabled

otError otThreadSetEnabled(
  otInstance *aInstance,
  bool aEnabled
)

Запускает операцию протокола потока.

Интерфейс должен быть вновлен при вызове этой функции.

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

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

OtthreadSetexTendendPanid

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

Устанавливает IEEE 802.15.4 Расширенную кастрюлю.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtendedPanId
Указатель на IEEE 802.15.4.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите расширенную идентификатор PAN.
OT_ERROR_INVALID_STATE
Протоколы потоков включены.
Смотрите также:
OtthreadgetExtendPanid

OtthreadSetFixedDuaInterfaceIdentifier

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

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aIid
Указатель на идентификатор интерфейса для установки или нуля, чтобы очистить.
Возвращаемые значения
OT_ERROR_NONE
Успешно установил/очистил идентификатор интерфейса.
OT_ERROR_INVALID_ARGS
Указанный идентификатор интерфейса зарезервирован.
Смотрите также:
OtthreadgetFixedDuainterFaceIdentifier

OtthreadSetJoinerAdVertisement

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

Устанавливает рекламу Thread Joiner при обнаружении сети потоков.

Реклама The Thread Joiner используется, чтобы позволить столяру рекламировать свою собственную информацию о конкретной приложении (такую ​​как идентификатор поставщика, идентификатор продукта, дискриминатор и т. Д.) С помощью недавно представленной рекламы столяров TLV и предоставления этой информации для комиссаров или комиссара Кандидаты без человеческого взаимодействия.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aOui
Значение поставщика IEEE OUI, которое будет включено в рекламу Joiner. Будут использованы только наименее значимые 3 байта, и наиболее значимый байт будет проигнорирован.
[in] aAdvData
Указатель на Advdata, которая будет включена в рекламу Joiner.
[in] aAdvDataLength
Длина Advdata в байтах.
Возвращаемые значения
OT_ERROR_NONE
Успешно установить рекламу столяра.
OT_ERROR_INVALID_ARGS
Неверно Advdata.

OtthreadSetKey sechenceCounter

void otThreadSetKeySequenceCounter(
  otInstance *aInstance,
  uint32_t aKeySequenceCounter
)

Устанавливает Thrkey SechrokenceCounter.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aKeySequenceCounter
Значение THRKEY SESHENCECOUNTER.
Смотрите также:
OtthreadgetKey sechenceCounter

OtthreadSetKeySwitchGuardtime

void otThreadSetKeySwitchGuardTime(
  otInstance *aInstance,
  uint32_t aKeySwitchGuardTime
)

Устанавливает ThrkeysWitchGuardtime (в часы).

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

OtthreadSetLinkMode

otError otThreadSetLinkMode(
  otInstance *aInstance,
  otLinkModeConfig aConfig
)

Установите конфигурацию режима ссылки MLE.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aConfig
Указатель на конфигурацию режима ссылки.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите конфигурацию режима MLE Link.
Смотрите также:
OtthreadgetLinkMode

OtthreadSetMeshlocalPrefix

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

Устанавливает локальный префикс сетки.

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

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

OtthreadSetNetWorkKey

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

Установите сетевой ключ потока.

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

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

OtthreadSetNetWorkKeeRef

otError otThreadSetNetworkKeyRef(
  otInstance *aInstance,
  otNetworkKeyRef aKeyRef
)

Установите сетевой ключ Thread как otNetworkKeyRef .

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

Требуется функция строительства OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE для включения.

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

OtthreadSetNetWorkName

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

Установите имя сети Thread.

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

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

OtthreadSetVendormodel

otError otThreadSetVendorModel(
  otInstance *aInstance,
  const char *aVendorModel
)

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

Требуется OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorModel должен быть UTF8 с максимальной длиной 32 чарса ( MAX_VENDOR_MODEL_TLV_LENGTH ). Максимальная длина не включает символ NULL \0 .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aVendorModel
Строка модели поставщика.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите модель поставщика.
OT_ERROR_INVALID_ARGS
aVendorModel не является действительным (слишком длинный или не UTF8).

OtthreadSetVendorname

otError otThreadSetVendorName(
  otInstance *aInstance,
  const char *aVendorName
)

Установите строку имени поставщика.

Требуется OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorName должен быть UTF8 с максимальной длиной 32 чарса ( MAX_VENDOR_NAME_TLV_LENGTH ). Максимальная длина не включает символ NULL \0 .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aVendorName
Строка имени продавца.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите имя поставщика.
OT_ERROR_INVALID_ARGS
aVendorName не является действительным (слишком долго или не UTF8).

OtthreadSetVendorsWversion

otError otThreadSetVendorSwVersion(
  otInstance *aInstance,
  const char *aVendorSwVersion
)

Установите строку версии программного обеспечения поставщика.

Требуется OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE .

aVendorSwVersion должен быть UTF8 с максимальной длиной 16 chars ( MAX_VENDOR_SW_VERSION_TLV_LENGTH ). Максимальная длина не включает символ NULL \0 .

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aVendorSwVersion
Строка версии программного обеспечения поставщика.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите версию программного обеспечения поставщика.
OT_ERROR_INVALID_ARGS
aVendorSwVersion недопустим (слишком длинная или не UTF8).

Макросы

OT_DURATION_STRING_SIZE

 OT_DURATION_STRING_SIZE 21

Рекомендуемый размер для представления строки продолжительности uint32_t за секунды.

Ot_joiner_advdata_max_length

 OT_JOINER_ADVDATA_MAX_LENGTH 64

Максимальная продолжительность рекламы Advdata.

Ot_neighbor_info_iterator_init

 OT_NEIGHBOR_INFO_ITERATOR_INIT 0

Инициализатор для Otneighborinfoiterator.

Ot_network_base_tlv_max_length

 OT_NETWORK_BASE_TLV_MAX_LENGTH 254

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

Ot_network_data_iterator_init

 OT_NETWORK_DATA_ITERATOR_INIT 0

Значение для инициализации otNetworkDataIterator .

OT_NETWORD_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE

 OT_NETWORK_DIAGNOSTIC_CHILD_TABLE_ENTRY_SIZE 3

Размер сетевой диагностики детский таблица.

OT_NETWORD_DIAGNOSTIC_ITERATOR_INIT

 OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT 0

Инициализатор для OtnetWorkDiagiterator.

Ot_network_diagnostic_max_thread_stack_version_tlv_length

 OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH 64

Максимальная длина версии стека потоков TLV.

Ot_network_diagnostic_max_vendor_model_tlv_length

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH 32

Максимальная длина модели поставщика TLV.

Ot_network_diagnostic_max_vendor_name_tlv_length

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH 32

Максимальная длина имени поставщика TLV.

Ot_network_diagnostic_max_vendor_sw_version_tlv_length

 OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH 16

Максимальная длина поставщика SW версии TLV.

OT_NETWORD_DIAGNOSTIC_TYPELIST_MAX_ENTRIES

 OT_NETWORK_DIAGNOSTIC_TYPELIST_MAX_ENTRIES 19

Максимальное количество сетевых диагностических типов TLV для запроса или сброса.

Ot_network_max_router_id

 OT_NETWORK_MAX_ROUTER_ID 62

Максимальный идентификатор маршрутизатора.

Ot_server_data_max_size

 OT_SERVER_DATA_MAX_SIZE 248

Максимальный размер данных сервера в байтах. Теоретический предел, практически намного ниже.

Ot_service_data_max_size

 OT_SERVICE_DATA_MAX_SIZE 252

Максимальный размер сервисных данных в байтах.

Ресурсы

Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .