Пример

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

Резюме

Перечисления
anonymous enum { OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, OT_CHANGED_THREAD_ROLE = 1 << 2, OT_CHANGED_THREAD_LL_ADDR = 1 << 3, OT_CHANGED_THREAD_ML_ADDR = 1 << 4, OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, OT_CHANGED_THREAD_NETDATA = 1 << 9, OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, OT_CHANGED_THREAD_CHANNEL = 1 << 14, OT_CHANGED_THREAD_PANID = 1 << 15, OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, OT_CHANGED_THREAD_EXT_PANID = 1 << 17, OT_CHANGED_MASTER_KEY = 1 << 18, OT_CHANGED_PSKC = 1 << 19, OT_CHANGED_SECURITY_POLICY = 1 << 20, OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, OT_CHANGED_COMMISSIONER_STATE = 1 << 23, OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, OT_CHANGED_JOINER_STATE = 1 << 27 }	перечисление Это перечисление определяет флаги, которые передаются как часть `otStateChangedCallback` .

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

anonymous enum { 
 OT_CHANGED_IP6_ADDRESS_ADDED = 1 << 0, 
 OT_CHANGED_IP6_ADDRESS_REMOVED = 1 << 1, 
 OT_CHANGED_THREAD_ROLE = 1 << 2, 
 OT_CHANGED_THREAD_LL_ADDR = 1 << 3, 
 OT_CHANGED_THREAD_ML_ADDR = 1 << 4, 
 OT_CHANGED_THREAD_RLOC_ADDED = 1 << 5, 
 OT_CHANGED_THREAD_RLOC_REMOVED = 1 << 6, 
 OT_CHANGED_THREAD_PARTITION_ID = 1 << 7, 
 OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER = 1 << 8, 
 OT_CHANGED_THREAD_NETDATA = 1 << 9, 
 OT_CHANGED_THREAD_CHILD_ADDED = 1 << 10, 
 OT_CHANGED_THREAD_CHILD_REMOVED = 1 << 11, 
 OT_CHANGED_IP6_MULTICAST_SUBSCRIBED = 1 << 12, 
 OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED = 1 << 13, 
 OT_CHANGED_THREAD_CHANNEL = 1 << 14, 
 OT_CHANGED_THREAD_PANID = 1 << 15, 
 OT_CHANGED_THREAD_NETWORK_NAME = 1 << 16, 
 OT_CHANGED_THREAD_EXT_PANID = 1 << 17, 
 OT_CHANGED_MASTER_KEY = 1 << 18, 
 OT_CHANGED_PSKC = 1 << 19, 
 OT_CHANGED_SECURITY_POLICY = 1 << 20, 
 OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL = 1 << 21, 
 OT_CHANGED_SUPPORTED_CHANNEL_MASK = 1 << 22, 
 OT_CHANGED_COMMISSIONER_STATE = 1 << 23, 
 OT_CHANGED_THREAD_NETIF_STATE = 1 << 24, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE = 1 << 25, 
 OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL = 1 << 26, 
 OT_CHANGED_JOINER_STATE = 1 << 27 
 }

перечисление

Это перечисление определяет флаги, которые передаются как часть otStateChangedCallback .

Определения типов
`otChangedFlags`	ЬурейеЕ `uint32_t` Этот тип представляет битовое поле, указывающее конкретное состояние / конфигурацию, которая изменилась.
`otInstance`	ЬурейеЕ `struct otInstance` Эта структура представляет структуру экземпляра OpenThread.
`otStateChangedCallback )(otChangedFlags aFlags, void *aContext)`	ЬурейеЕ `void(*` Этот указатель на функцию вызывается для уведомления об определенных изменениях конфигурации или состояния в OpenThread.

функции
`otGetRadioVersionString ( otInstance *aInstance)`	`const char *` Эта функция получает строку версии радио OpenThread.
`otGetVersionString (void)`	`const char *` Эта функция получает строку версии OpenThread.
`otInstanceErasePersistentInfo ( otInstance *aInstance)`	`otError` Эта функция стирает всю постоянную информацию OpenThread (настройки сети), хранящуюся в энергонезависимой памяти.
`otInstanceFactoryReset ( otInstance *aInstance)`	`void` Этот метод удаляет все настройки, хранящиеся в энергонезависимой памяти, а затем запускает сброс платформы.
`otInstanceFinalize ( otInstance *aInstance)`	`void` Эта функция отключает библиотеку OpenThread.
`otInstanceInit (void aInstanceBuffer, size_t aInstanceBufferSize)`	`otInstance *` Эта функция инициализирует библиотеку OpenThread.
`otInstanceInitSingle (void)`	`otInstance *` Эта функция инициализирует один статический экземпляр библиотеки OpenThread.
`otInstanceIsInitialized ( otInstance *aInstance)`	`bool` Эта функция указывает, является ли экземпляр действительным / инициализированным.
`otInstanceReset ( otInstance *aInstance)`	`void` Этот метод вызывает сброс платформы.
`otRemoveStateChangeCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`void` Эта функция удаляет обратный вызов, чтобы указать, когда определенная конфигурация или состояние изменяется в OpenThread.
`otSetStateChangedCallback ( otInstance aInstance, otStateChangedCallback aCallback, void aContext)`	`otError` Эта функция регистрирует обратный вызов, чтобы указать, когда определенная конфигурация или состояние изменяется в OpenThread.

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

анонимный enum

 anonymous enum

Это перечисление определяет флаги, которые передаются как часть otStateChangedCallback .

свойства
`OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL`	Channel Manager новый ожидающий поток Канал изменен.
`OT_CHANGED_COMMISSIONER_STATE`	Состояние комиссара изменилось.
`OT_CHANGED_IP6_ADDRESS_ADDED`	IPv6-адрес был добавлен.
`OT_CHANGED_IP6_ADDRESS_REMOVED`	IPv6-адрес был удален.
`OT_CHANGED_IP6_MULTICAST_SUBSCRIBED`	Подписан на многоадресный адрес IPv6.
`OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED`	Отписаться от многоадресного адреса IPv6.
`OT_CHANGED_JOINER_STATE`	Столярное состояние изменилось.
`OT_CHANGED_MASTER_KEY`	Главный ключ изменен.
`OT_CHANGED_PSKC`	PSKc изменился.
`OT_CHANGED_SECURITY_POLICY`	Политика безопасности изменена.
`OT_CHANGED_SUPPORTED_CHANNEL_MASK`	Изменена маска поддерживаемого канала.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL`	Конфигурация локального магистрального маршрутизатора изменена.
`OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE`	Состояние магистрального маршрутизатора изменено.
`OT_CHANGED_THREAD_CHANNEL`	Канал сетевого потока изменен.
`OT_CHANGED_THREAD_CHILD_ADDED`	Ребенок был добавлен.
`OT_CHANGED_THREAD_CHILD_REMOVED`	Ребенок был удален.
`OT_CHANGED_THREAD_EXT_PANID`	Изменен расширенный идентификатор сети в сети.
`OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER`	Последовательность ключей потока изменена.
`OT_CHANGED_THREAD_LL_ADDR`	Ссылочный локальный адрес изменился.
`OT_CHANGED_THREAD_ML_ADDR`	Адрес локальной сети изменен.
`OT_CHANGED_THREAD_NETDATA`	Данные сети потока изменены.
`OT_CHANGED_THREAD_NETIF_STATE`	Состояние сетевого интерфейса потока изменено.
`OT_CHANGED_THREAD_NETWORK_NAME`	Название сети потока изменено.
`OT_CHANGED_THREAD_PANID`	Идентификатор PAN сетевого потока изменен.
`OT_CHANGED_THREAD_PARTITION_ID`	ID раздела изменен.
`OT_CHANGED_THREAD_RLOC_ADDED`	RLOC был добавлен.
`OT_CHANGED_THREAD_RLOC_REMOVED`	RLOC был удален.
`OT_CHANGED_THREAD_ROLE`	Роль (отключена, отключена, дочерний, маршрутизатор, лидер) изменена.

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

otChangedFlags

uint32_t otChangedFlags

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

Смотрите OT_CHANGED_* определения.

otInstance

struct otInstance otInstance

Эта структура представляет структуру экземпляра OpenThread.

otStateChangedCallback

void(* otStateChangedCallback)(otChangedFlags aFlags, void *aContext)

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

подробности

параметры

`[in] aFlags`	Битовое поле, указывающее конкретное состояние, которое изменилось. Смотрите `OT_CHANGED_*` определения.
`[in] aContext`	Указатель на контекст приложения.

функции

otGetRadioVersionString

const char * otGetRadioVersionString(
  otInstance *aInstance
)

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

подробности

параметры

[in] aInstance

Указатель на экземпляр OpenThread.

Возвращает

Указатель на версию радио OpenThread.

otGetVersionString

const char * otGetVersionString(
  void
)

Эта функция получает строку версии OpenThread.

подробности
Возвращает	Указатель на версию OpenThread.

otInstanceErasePersistentInfo

 otError otInstanceErasePersistentInfo(
  otInstance *aInstance
)

Эта функция стирает всю постоянную информацию OpenThread (настройки сети), хранящуюся в энергонезависимой памяти.

Удаление успешно, только если устройство находится в disabled состоянии / роли.

подробности

параметры

[in] aInstance

Указатель на экземпляр OpenThread.

Возвращаемые значения

`OT_ERROR_NONE`	Вся постоянная информация / состояние были успешно удалены.
`OT_ERROR_INVALID_STATE`	Устройство не находится в `disabled` состоянии / роли.

otInstanceFactoryReset

void otInstanceFactoryReset(
  otInstance *aInstance
)

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

подробности

параметры

[in] aInstance

Указатель на экземпляр OpenThread.

otInstanceFinalize

void otInstanceFinalize(
  otInstance *aInstance
)

Эта функция отключает библиотеку OpenThread.

Вызывайте эту функцию, когда OpenThread больше не используется.

подробности

параметры

[in] aInstance

Указатель на экземпляр OpenThread.

otInstanceInit

 otInstance * otInstanceInit(
  void *aInstanceBuffer,
  size_t *aInstanceBufferSize
)

Эта функция инициализирует библиотеку OpenThread.

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

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

подробности

параметры

`[in] aInstanceBuffer`	Буфер для OpenThread, используемый для выделения структуры otInstance.
`[in,out] aInstanceBufferSize`	На входе размер aInstanceBuffer. На выходе, если недостаточно места для otInstance, количество байтов, необходимое для otInstance.

Возвращает

Указатель на новый экземпляр OpenThread.

Смотрите также:
otInstanceFinalize

otInstanceInitSingle

 otInstance * otInstanceInitSingle(
  void
)

Эта функция инициализирует один статический экземпляр библиотеки OpenThread.

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

подробности
Возвращает	Указатель на один экземпляр OpenThread.

otInstanceIsInitialized

bool otInstanceIsInitialized(
  otInstance *aInstance
)

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

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

подробности

параметры

[in] aInstance

Указатель на экземпляр OpenThread.

Возвращает

TRUE, если данный экземпляр действителен / инициализирован, FALSE в противном случае.

otInstanceReset

void otInstanceReset(
  otInstance *aInstance
)

Этот метод вызывает сброс платформы.

Процесс сброса гарантирует, что все состояние / информация OpenThread (хранящиеся в энергозависимой памяти) будут стерты. Обратите внимание, что otPlatformReset не стирает никакое постоянное состояние / информацию, сохраненную в энергонезависимой памяти.

подробности

параметры

[in] aInstance

Указатель на экземпляр OpenThread.

otRemoveStateChangeCallback

void otRemoveStateChangeCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

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

подробности

параметры

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

otSetStateChangedCallback

 otError otSetStateChangedCallback(
  otInstance *aInstance,
  otStateChangedCallback aCallback,
  void *aContext
)

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

подробности

параметры

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

Возвращаемые значения

`OT_ERROR_NONE`	Добавлен обратный вызов в список обратных вызовов.
`OT_ERROR_ALREADY`	Обратный звонок уже был зарегистрирован.
`OT_ERROR_NO_BUFS`	Не удалось добавить обратный вызов из-за ограничений ресурса.