Маршрутизатор / лидер

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

Резюме

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

otCacheEntryState перечислить
Это перечисление определяет состояние записи кэша EID.
otNeighborTableEvent {
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED ,
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED ,
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
}
перечислить
Это перечисление определяет константы , используемые в otNeighborTableCallback для обозначения изменений в соседней таблице.

Typedefs

otCacheEntryInfo typedef
Эта структура представляет собой запись кэша EID.
otCacheEntryIterator typedef
Этот тип представляет собой итератор, используемый для перебора записей таблицы кэша EID.
otCacheEntryState typedef
Это перечисление определяет состояние записи кэша EID.
otChildIp6AddressIterator typedef
uint16_t
Используется для перебора IPv6-адресов записи дочернего потока.
otNeighborTableCallback )(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo) typedef
void(*
Этот указатель на функцию вызывается для уведомления об изменении в таблице соседей.

Функции

otThreadBecomeLeader ( otInstance *aInstance)
Станьте лидером и создайте новый раздел.
otThreadBecomeRouter ( otInstance *aInstance)
Попытка стать роутером.
otThreadGetChildInfoById ( otInstance *aInstance, uint16_t aChildId, otChildInfo *aChildInfo)
Функция сохраняет диагностическую информацию для присоединенного дочернего элемента по его идентификатору ребенка или RLOC16.
otThreadGetChildInfoByIndex ( otInstance *aInstance, uint16_t aChildIndex, otChildInfo *aChildInfo)
Функция сохраняет диагностическую информацию для присоединенного дочернего элемента по внутреннему индексу таблицы.
otThreadGetChildNextIp6Address ( otInstance *aInstance, uint16_t aChildIndex, otChildIp6AddressIterator *aIterator, otIp6Address *aAddress)
Эта функция получает следующий IPv6-адрес (с помощью итератора) для данного потомка.
otThreadGetContextIdReuseDelay ( otInstance *aInstance)
uint32_t
Получите параметр CONTEXT_ID_REUSE_DELAY, используемый в роли лидера.
otThreadGetJoinerUdpPort ( otInstance *aInstance)
uint16_t
Получите порт Joiner UDP.
otThreadGetLocalLeaderWeight ( otInstance *aInstance)
uint8_t
Получите вес выноски резьбы, используемый при работе в роли лидера.
otThreadGetMaxAllowedChildren ( otInstance *aInstance)
uint16_t
Получите максимально разрешенное количество детей.
otThreadGetMaxChildIpAddresses ( otInstance *aInstance)
uint8_t
Эта функция получает максимальное количество IP-адресов, которые каждый дочерний элемент MTD может зарегистрировать на этом устройстве в качестве родительского.
otThreadGetMaxRouterId ( otInstance *aInstance)
uint8_t
Функция возвращает максимально допустимый идентификатор маршрутизатора.
otThreadGetNetworkIdTimeout ( otInstance *aInstance)
uint8_t
Получите параметр NETWORK_ID_TIMEOUT, используемый в роли маршрутизатора.
otThreadGetNextCacheEntry ( otInstance *aInstance, otCacheEntryInfo *aEntryInfo, otCacheEntryIterator *aIterator)
Эта функция получает следующую запись в кэше EID (с помощью итератора).
otThreadGetParentPriority ( otInstance *aInstance)
int8_t
Получите назначенный родительский приоритет.
otThreadGetPreferredLeaderPartitionId ( otInstance *aInstance)
uint32_t
Получите предпочтительный идентификатор раздела лидера потока, используемый при работе в роли лидера.
otThreadGetPskc ( otInstance *aInstance, otPskc *aPskc)
void
Получите тему PSKc.
otThreadGetPskcRef ( otInstance *aInstance)
Получить ключевую ссылку на сохраненный поток PSKc.
otThreadGetRouterDowngradeThreshold ( otInstance *aInstance)
uint8_t
Получите параметр ROUTER_DOWNGRADE_THRESHOLD, используемый в роли маршрутизатора.
otThreadGetRouterIdRange ( otInstance *aInstance, uint8_t *aMinRouterId, uint8_t *aMaxRouterId)
void
Эта функция получает диапазон идентификаторов маршрутизаторов, которые разрешено назначать узлам в сети потоков.
otThreadGetRouterIdSequence ( otInstance *aInstance)
uint8_t
Получите текущую последовательность идентификаторов маршрутизаторов.
otThreadGetRouterInfo ( otInstance *aInstance, uint16_t aRouterId, otRouterInfo *aRouterInfo)
Функция сохраняет диагностическую информацию для данного маршрутизатора потоков.
otThreadGetRouterSelectionJitter ( otInstance *aInstance)
uint8_t
Получите параметр ROUTER_SELECTION_JITTER, используемый в роли REED / Router.
otThreadGetRouterUpgradeThreshold ( otInstance *aInstance)
uint8_t
Получите параметр ROUTER_UPGRADE_THRESHOLD, используемый в роли REED.
otThreadIsRouterEligible ( otInstance *aInstance)
bool
Этот метод указывает, соответствует ли устройство требованиям маршрутизатора.
otThreadRegisterNeighborTableCallback ( otInstance *aInstance, otNeighborTableCallback aCallback)
void
Эта функция регистрирует функцию обратного вызова таблицы соседей.
otThreadReleaseRouterId ( otInstance *aInstance, uint8_t aRouterId)
Освободите идентификатор маршрутизатора, назначенный устройством в роли лидера.
otThreadSetCcmEnabled ( otInstance *aInstance, bool aEnabled)
void
Эта функция устанавливает, было ли устройство введено в эксплуатацию с помощью CCM.
otThreadSetContextIdReuseDelay ( otInstance *aInstance, uint32_t aDelay)
void
Установите параметр CONTEXT_ID_REUSE_DELAY, используемый в роли лидера.
otThreadSetJoinerUdpPort ( otInstance *aInstance, uint16_t aJoinerUdpPort)
Установите UDP-порт присоединения.
otThreadSetLocalLeaderWeight ( otInstance *aInstance, uint8_t aWeight)
void
Установите вес выноски резьбы, используемый при работе в роли лидера.
otThreadSetMaxAllowedChildren ( otInstance *aInstance, uint16_t aMaxChildren)
Установите максимальное количество детей, разрешенное в настоящее время.
otThreadSetMaxChildIpAddresses ( otInstance *aInstance, uint8_t aMaxIpAddresses)
Эта функция устанавливает / восстанавливает максимальное количество IP-адресов, которые каждый дочерний элемент MTD может зарегистрировать на этом устройстве в качестве родительского.
otThreadSetNetworkIdTimeout ( otInstance *aInstance, uint8_t aTimeout)
void
Установите параметр NETWORK_ID_TIMEOUT, используемый в роли лидера.
otThreadSetParentPriority ( otInstance *aInstance, int8_t aParentPriority)
Установите родительский приоритет.
otThreadSetPreferredLeaderPartitionId ( otInstance *aInstance, uint32_t aPartitionId)
void
Установите предпочтительный идентификатор раздела ведущего потока, используемый при работе в роли ведущего.
otThreadSetPreferredRouterId ( otInstance *aInstance, uint8_t aRouterId)
Установите предпочтительный идентификатор маршрутизатора.
otThreadSetPskc ( otInstance *aInstance, const otPskc *aPskc)
Установите поток PSKc.
otThreadSetPskcRef ( otInstance *aInstance, otPskcRef aKeyRef)
Установите поток PSKc.
otThreadSetRouterDowngradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Установите параметр ROUTER_DOWNGRADE_THRESHOLD, используемый в роли лидера.
otThreadSetRouterEligible ( otInstance *aInstance, bool aEligible)
Эта функция устанавливает, поддерживает ли устройство маршрутизатор.
otThreadSetRouterIdRange ( otInstance *aInstance, uint8_t aMinRouterId, uint8_t aMaxRouterId)
Эта функция устанавливает диапазон идентификаторов маршрутизаторов, которые разрешено назначать узлам в сети потоков.
otThreadSetRouterSelectionJitter ( otInstance *aInstance, uint8_t aRouterJitter)
void
Установите параметр ROUTER_SELECTION_JITTER, используемый в роли REED / Router.
otThreadSetRouterUpgradeThreshold ( otInstance *aInstance, uint8_t aThreshold)
void
Установите параметр ROUTER_UPGRADE_THRESHOLD, используемый в роли лидера.
otThreadSetSteeringData ( otInstance *aInstance, const otExtAddress *aExtAddress)
void
Установите данные рулевого управления вне диапазона.

Структуры

otCacheEntryInfo

Эта структура представляет собой запись кэша EID.

otCacheEntryIterator

Этот тип представляет собой итератор, используемый для перебора записей таблицы кэша EID.

otChildInfo

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

otNeighborTableEntryInfo

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

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

otCacheEntryState

 otCacheEntryState

Это перечисление определяет состояние записи кэша EID.

otNeighborTableEvent

 otNeighborTableEvent

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

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

Добавляется ребенок.

OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED

Изменен существующий дочерний режим.

OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED

Убирают ребенка.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED

Добавляется роутер.

OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED

Маршрутизатор удаляется.

Typedefs

otCacheEntryInfo

struct otCacheEntryInfo otCacheEntryInfo

Эта структура представляет собой запись кэша EID.

otCacheEntryIterator

struct otCacheEntryIterator otCacheEntryIterator

Этот тип представляет собой итератор, используемый для перебора записей таблицы кэша EID.

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

otCacheEntryState

enum otCacheEntryState otCacheEntryState

Это перечисление определяет состояние записи кэша EID.

otChildIp6AddressIterator

uint16_t otChildIp6AddressIterator

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

otNeighborTableCallback

void(* otNeighborTableCallback)(otNeighborTableEvent aEvent, const otNeighborTableEntryInfo *aEntryInfo)

Этот указатель на функцию вызывается для уведомления об изменении в таблице соседей.

Подробности
Параметры
[in] aEvent
Флаг события.
[in] aEntryInfo
Указатель на информацию о записи в таблице.

Функции

otThreadBecomeLeader

otError otThreadBecomeLeader(
  otInstance *aInstance
)

Станьте лидером и создайте новый раздел.

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

otThreadBecomeRouter

otError otThreadBecomeRouter(
  otInstance *aInstance
)

Попытка стать роутером.

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

otThreadGetChildInfoById

otError otThreadGetChildInfoById(
  otInstance *aInstance,
  uint16_t aChildId,
  otChildInfo *aChildInfo
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChildId
Дочерний идентификатор или RLOC16 для прикрепленного дочернего элемента.
[out] aChildInfo
Указатель на место размещения дочерней информации.
Возвращаемые значения
OT_ERROR_NONE
aChildInfo был успешно обновлен с информацией для данного идентификатора.
OT_ERROR_NOT_FOUND
Нет действительного ребенка с этим идентификатором ребенка.
OT_ERROR_INVALID_ARGS
Если aChildInfo является NULL.

otThreadGetChildInfoByIndex

otError otThreadGetChildInfoByIndex(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildInfo *aChildInfo
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChildIndex
Таблица index.
[out] aChildInfo
Указатель на место размещения дочерней информации.
Возвращаемые значения
OT_ERROR_NONE
aChildInfo был успешно обновлен с информацией для данного индекса.
OT_ERROR_NOT_FOUND
В этом индексе нет допустимого дочернего элемента.
OT_ERROR_INVALID_ARGS
Либо aChildInfo это значение NULL или aChildIndex находится вне диапазона (выше максимального индекса таблицы).
Смотрите также:
otGetMaxAllowedChildren

otThreadGetChildNextIp6Address

otError otThreadGetChildNextIp6Address(
  otInstance *aInstance,
  uint16_t aChildIndex,
  otChildIp6AddressIterator *aIterator,
  otIp6Address *aAddress
)

Эта функция получает следующий IPv6-адрес (с помощью итератора) для данного потомка.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aChildIndex
Дочерний index.
[in,out] aIterator
Указатель на итератор. В случае успеха итератор будет обновлен, чтобы указывать на следующую запись в списке. Чтобы получить первый IPv6-адрес, итератор должен быть установлен на OT_CHILD_IP6_ADDRESS_ITERATOR_INIT.
[out] aAddress
Указатель на IPv6-адрес, в который помещается следующий адрес дочернего элемента (в случае успеха).
Возвращаемые значения
OT_ERROR_NONE
Успешно найден следующий адрес IPv6 ( aAddress был успешно обновлен).
OT_ERROR_NOT_FOUND
У дочернего элемента нет последующей записи адреса IPv6.
OT_ERROR_INVALID_ARGS
aIterator или aAddress являются NULL, или ребенок в aChildIndex не является действительным.
Смотрите также:
otThreadGetChildInfoByIndex

otThreadGetContextIdReuseDelay

uint32_t otThreadGetContextIdReuseDelay(
  otInstance *aInstance
)

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

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

otThreadGetJoinerUdpPort

uint16_t otThreadGetJoinerUdpPort(
  otInstance *aInstance
)

Получите порт Joiner UDP.

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

otThreadGetLocalLeaderWeight

uint8_t otThreadGetLocalLeaderWeight(
  otInstance *aInstance
)

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

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

otThreadGetMaxAllowedChildren

uint16_t otThreadGetMaxAllowedChildren(
  otInstance *aInstance
)

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

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

otThreadGetMaxChildIpAddresses

uint8_t otThreadGetMaxChildIpAddresses(
  otInstance *aInstance
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Максимальное количество IP-адресов, которые каждый дочерний элемент MTD может зарегистрировать на этом устройстве в качестве родительского.
Смотрите также:
otThreadSetMaxChildIpAddresses

otThreadGetMaxRouterId

uint8_t otThreadGetMaxRouterId(
  otInstance *aInstance
)

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

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

otThreadGetNetworkIdTimeout

uint8_t otThreadGetNetworkIdTimeout(
  otInstance *aInstance
)

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

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

otThreadGetNextCacheEntry

otError otThreadGetNextCacheEntry(
  otInstance *aInstance,
  otCacheEntryInfo *aEntryInfo,
  otCacheEntryIterator *aIterator
)

Эта функция получает следующую запись в кэше EID (с помощью итератора).

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

otThreadGetParentPriority

int8_t otThreadGetParentPriority(
  otInstance *aInstance
)

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

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

otThreadGetPreferredLeaderPartitionId

uint32_t otThreadGetPreferredLeaderPartitionId(
  otInstance *aInstance
)

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

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

otThreadGetPskc

void otThreadGetPskc(
  otInstance *aInstance,
  otPskc *aPskc
)

Получите тему PSKc.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aPskc
Указатель на otPskc вернуть найденную тему PSKc.
Смотрите также:
otThreadSetPskc

otThreadGetPskcRef

otPskcRef otThreadGetPskcRef(
  otInstance *aInstance
)

Получить ключевую ссылку на сохраненный поток PSKc.

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

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

otThreadGetRouterDowngradeThreshold

uint8_t otThreadGetRouterDowngradeThreshold(
  otInstance *aInstance
)

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

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

otThreadGetRouterIdRange

void otThreadGetRouterIdRange(
  otInstance *aInstance,
  uint8_t *aMinRouterId,
  uint8_t *aMaxRouterId
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[out] aMinRouterId
Минимальный идентификатор роутера.
[out] aMaxRouterId
Максимальный идентификатор маршрутизатора.
Смотрите также:
otThreadSetRouterIdRange

otThreadGetRouterIdSequence

uint8_t otThreadGetRouterIdSequence(
  otInstance *aInstance
)

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

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

otThreadGetRouterInfo

otError otThreadGetRouterInfo(
  otInstance *aInstance,
  uint16_t aRouterId,
  otRouterInfo *aRouterInfo
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aRouterId
Идентификатор маршрутизатора или RLOC16 для данного маршрутизатора.
[out] aRouterInfo
Указатель на место размещения информации о маршрутизаторе.
Возвращаемые значения
OT_ERROR_NONE
Информация о маршрутизаторе для данного идентификатора успешно получена.
OT_ERROR_NOT_FOUND
Нет записи о маршрутизаторе с данным идентификатором.
OT_ERROR_INVALID_ARGS
aRouterInfo является NULL.

otThreadGetRouterSelectionJitter

uint8_t otThreadGetRouterSelectionJitter(
  otInstance *aInstance
)

Получите параметр ROUTER_SELECTION_JITTER, используемый в роли REED / Router.

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

otThreadGetRouterUpgradeThreshold

uint8_t otThreadGetRouterUpgradeThreshold(
  otInstance *aInstance
)

Получите параметр ROUTER_UPGRADE_THRESHOLD, используемый в роли REED.

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

otThreadIsRouterElposed

bool otThreadIsRouterEligible(
  otInstance *aInstance
)

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

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

otThreadRegisterNeighborTableCallback

void otThreadRegisterNeighborTableCallback(
  otInstance *aInstance,
  otNeighborTableCallback aCallback
)

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

Предоставленный обратный вызов (если не равен NULL) будет вызываться при изменении в таблице соседей (например, добавляется / удаляется дочерняя запись или соседняя запись маршрутизатора или изменяется существующий дочерний режим).

Последующие вызовы этого метода перезапишут предыдущий обратный вызов. Обратите внимание , что этот обратный вызов в вызове в то время как таблица сосед / ребенок обновляется и всегда перед otStateChangedCallback .

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

otThreadReleaseRouterId

otError otThreadReleaseRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

Освободите идентификатор маршрутизатора, назначенный устройством в роли лидера.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aRouterId
Идентификатор маршрутизатора, который нужно освободить. Допустимый диапазон: [0, 62].
Возвращаемые значения
OT_ERROR_NONE
Успешно освобожден идентификатор маршрутизатора.
OT_ERROR_INVALID_ARGS
aRouterId не находится в диапазоне [0, 62].
OT_ERROR_INVALID_STATE
Аппарат на данный момент не является лидером.
OT_ERROR_NOT_FOUND
Идентификатор маршрутизатора в настоящее время не назначен.

otThreadSetCcmEnabled

void otThreadSetCcmEnabled(
  otInstance *aInstance,
  bool aEnabled
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aEnabled
ИСТИНА, если устройство было введено в эксплуатацию с использованием CCM, в противном случае - ЛОЖЬ.

otThreadSetContextIdReuseDelay

void otThreadSetContextIdReuseDelay(
  otInstance *aInstance,
  uint32_t aDelay
)

Установите параметр CONTEXT_ID_REUSE_DELAY, используемый в роли лидера.

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

otThreadSetJoinerUdpPort

otError otThreadSetJoinerUdpPort(
  otInstance *aInstance,
  uint16_t aJoinerUdpPort
)

Установите UDP-порт присоединения.

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

otThreadSetLocalLeaderWeight

void otThreadSetLocalLeaderWeight(
  otInstance *aInstance,
  uint8_t aWeight
)

Установите вес выноски резьбы, используемый при работе в роли лидера.

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

otThreadSetMaxAllowedChildren

otError otThreadSetMaxAllowedChildren(
  otInstance *aInstance,
  uint16_t aMaxChildren
)

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

Этот параметр может быть установлен только тогда, когда работа протокола потока была остановлена.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMaxChildren
Максимально разрешенные дети.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите макс.
OT_ERROR_INVALID_ARGS
Если aMaxChildren не находится в диапазоне [1, OPENTHREAD_CONFIG_MLE_MAX_CHILDREN].
OT_ERROR_INVALID_STATE
Если поток не остановлен.
Смотрите также:
otThreadGetMaxAllowedChildren

otThreadSetMaxChildIpAddresses

otError otThreadSetMaxChildIpAddresses(
  otInstance *aInstance,
  uint8_t aMaxIpAddresses
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMaxIpAddresses
Максимальное количество IP-адресов, которые каждый дочерний элемент MTD может зарегистрировать на этом устройстве в качестве родительского. 0, чтобы очистить настройку и восстановить значение по умолчанию.
Возвращаемые значения
OT_ERROR_NONE
Номер успешно установлен / очищен.
OT_ERROR_INVALID_ARGS
Если превышает допустимое максимальное число.
Смотрите также:
otThreadGetMaxChildIpAddresses

otThreadSetNetworkIdTimeout

void otThreadSetNetworkIdTimeout(
  otInstance *aInstance,
  uint8_t aTimeout
)

Установите параметр NETWORK_ID_TIMEOUT, используемый в роли лидера.

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

otThreadSetParentPriority

otError otThreadSetParentPriority(
  otInstance *aInstance,
  int8_t aParentPriority
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aParentPriority
Значение родительского приоритета.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите родительский приоритет.
OT_ERROR_INVALID_ARGS
Если значение родительского приоритета не находится среди 1, 0, -1 и -2.
Смотрите также:
otThreadGetParentPriority

otThreadSetPreferredLeaderPartitionId

void otThreadSetPreferredLeaderPartitionId(
  otInstance *aInstance,
  uint32_t aPartitionId
)

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

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

otThreadSetPreferredRouterId

otError otThreadSetPreferredRouterId(
  otInstance *aInstance,
  uint8_t aRouterId
)

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

Став маршрутизатором / лидером, узел пытается использовать этот идентификатор маршрутизатора. Если предпочтительный идентификатор маршрутизатора не установлен или его нельзя использовать, выбирается случайно сгенерированный идентификатор маршрутизатора. Это свойство можно установить, только если роль устройства отключена или отключена.

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

otThreadSetPskc

otError otThreadSetPskc(
  otInstance *aInstance,
  const otPskc *aPskc
)

Установите поток PSKc.

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

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

otThreadSetPskcRef

otError otThreadSetPskcRef(
  otInstance *aInstance,
  otPskcRef aKeyRef
)

Установите поток PSKc.

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

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

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

otThreadSetRouterDowngradeThreshold

void otThreadSetRouterDowngradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Установите параметр ROUTER_DOWNGRADE_THRESHOLD, используемый в роли лидера.

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

otThreadSetRouterElposed

otError otThreadSetRouterEligible(
  otInstance *aInstance,
  bool aEligible
)

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

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

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

otThreadSetRouterIdRange

otError otThreadSetRouterIdRange(
  otInstance *aInstance,
  uint8_t aMinRouterId,
  uint8_t aMaxRouterId
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aMinRouterId
Минимальный идентификатор роутера.
[in] aMaxRouterId
Максимальный идентификатор маршрутизатора.
Возвращаемые значения
OT_ERROR_NONE
Диапазон успешно установлен.
OT_ERROR_INVALID_ARGS
aMinRouterId> aMaxRouterId, или диапазон не покрывается [0, 62].
Смотрите также:
otThreadGetRouterIdRange

otThreadSetRouterSelectionJitter

void otThreadSetRouterSelectionJitter(
  otInstance *aInstance,
  uint8_t aRouterJitter
)

Установите параметр ROUTER_SELECTION_JITTER, используемый в роли REED / Router.

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

otThreadSetRouterUpgradeThreshold

void otThreadSetRouterUpgradeThreshold(
  otInstance *aInstance,
  uint8_t aThreshold
)

Установите параметр ROUTER_UPGRADE_THRESHOLD, используемый в роли лидера.

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

otThreadSetSteeringData

void otThreadSetSteeringData(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Установите данные рулевого управления вне диапазона.

Конфигурация вариант OPENTHREAD_CONFIG_MLE_STEERING_DATA_SET_OOB_ENABLE должен быть установлен , чтобы позволить установку рулевых данных вне диапазона.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aExtAddress
Адрес, используемый для обновления данных рулевого управления. Все нули для очистки данных рулевого управления (без данных рулевого управления). Все 0xFF, чтобы настроить данные управления / фильтр Блума для принятия / разрешения всех. Конкретный EUI64, который затем добавляется к текущему фильтру данных рулевого управления / блюма.

Макросы

OT_CHILD_IP6_ADDRESS_ITERATOR_INIT

 OT_CHILD_IP6_ADDRESS_ITERATOR_INIT 0

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