Операционный набор данных

Этот модуль включает в себя функции для Dataset Updater.

Резюме

Функции в этом модуле доступны, когда функция обновления набора данных включена (т. е OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE имеет значение 1). Кроме того, эта функция доступна только в сборке FTD.

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

otMeshcopTlvType {
OT_MESHCOP_TLV_CHANNEL = 0,
OT_MESHCOP_TLV_PANID = 1,
OT_MESHCOP_TLV_EXTPANID = 2,
OT_MESHCOP_TLV_NETWORKNAME = 3,
OT_MESHCOP_TLV_PSKC = 4,
OT_MESHCOP_TLV_NETWORKKEY = 5,
OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE = 6,
OT_MESHCOP_TLV_MESHLOCALPREFIX = 7,
OT_MESHCOP_TLV_STEERING_DATA = 8,
OT_MESHCOP_TLV_BORDER_AGENT_RLOC = 9,
OT_MESHCOP_TLV_COMMISSIONER_ID = 10,
OT_MESHCOP_TLV_COMM_SESSION_ID = 11,
OT_MESHCOP_TLV_SECURITYPOLICY = 12,
OT_MESHCOP_TLV_GET = 13,
OT_MESHCOP_TLV_ACTIVETIMESTAMP = 14,
OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT = 15,
OT_MESHCOP_TLV_STATE = 16,
OT_MESHCOP_TLV_JOINER_DTLS = 17,
OT_MESHCOP_TLV_JOINER_UDP_PORT = 18,
OT_MESHCOP_TLV_JOINER_IID = 19,
OT_MESHCOP_TLV_JOINER_RLOC = 20,
OT_MESHCOP_TLV_JOINER_ROUTER_KEK = 21,
OT_MESHCOP_TLV_PROVISIONING_URL = 32,
OT_MESHCOP_TLV_VENDOR_NAME_TLV = 33,
OT_MESHCOP_TLV_VENDOR_MODEL_TLV = 34,
OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV = 35,
OT_MESHCOP_TLV_VENDOR_DATA_TLV = 36,
OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV = 37,
OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV = 48,
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV = 49,
OT_MESHCOP_TLV_PENDINGTIMESTAMP = 51,
OT_MESHCOP_TLV_DELAYTIMER = 52,
OT_MESHCOP_TLV_CHANNELMASK = 53,
OT_MESHCOP_TLV_COUNT = 54,
OT_MESHCOP_TLV_PERIOD = 55,
OT_MESHCOP_TLV_SCAN_DURATION = 56,
OT_MESHCOP_TLV_ENERGY_LIST = 57,
OT_MESHCOP_TLV_DISCOVERYREQUEST = 128,
OT_MESHCOP_TLV_DISCOVERYRESPONSE = 129,
OT_MESHCOP_TLV_JOINERADVERTISEMENT = 241
}
перечисление
Это перечисление представляет типы TLV meshcop.

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

otChannelMask определение типа
uint32_t
Этот тип представляет маску канала.
otDatasetMgmtSetCallback )(otError aResult, void *aContext) определение типа
void(*
Этот указатель функции вызывается, когда ответ на запрос MGMT_SET получен или истекает по тайм-ауту.
otDatasetUpdaterCallback )(otError aError, void *aContext) определение типа
void(*
Этот указатель функции обратного вызова вызывается, когда завершается запрос на обновление набора данных, сообщая об успешном или неудачном статусе запроса на обновление набора данных.
otExtendedPanId определение типа
Эта структура представляет расширенный идентификатор PAN.
otMeshLocalPrefix определение типа
Эта структура представляет собой локальный префикс Mesh.
otMeshcopTlvType определение типа
Это перечисление представляет типы TLV meshcop.
otNetworkKey определение типа
struct otNetworkKey
Эта структура представляет сетевой ключ потока.
otNetworkKeyRef определение типа
Этот тип данных представляет KeyRef для NetworkKey.
otNetworkName определение типа
Эта структура представляет собой сетевое имя.
otOperationalDataset определение типа
Эта структура представляет собой активный или ожидающий рабочий набор данных.
otOperationalDatasetComponents определение типа
Эта структура представляет собой наличие различных компонентов в наборе активных или ожидающих операций.
otOperationalDatasetTlvs определение типа
Эта структура представляет собой активный или ожидающий рабочий набор данных.
otPskc определение типа
struct otPskc
Эта структура представляет собой PSKc.
otPskcRef определение типа
Этот тип данных представляет KeyRef для PSKc.
otSecurityPolicy определение типа
Эта структура представляет политику безопасности.

Переменные

OT_TOOL_PACKED_END

Функции

otDatasetCreateNewNetwork ( otInstance *aInstance, otOperationalDataset *aDataset)
Этот метод создает новый рабочий набор данных для использования при формировании новой сети.
otDatasetGeneratePskc (const char *aPassPhrase, const otNetworkName *aNetworkName, const otExtendedPanId *aExtPanId, otPskc *aPskc)
Эта функция генерирует PSKc из заданной фразы-пароля, сетевого имени и расширенного идентификатора PAN.
otDatasetGetActive ( otInstance *aInstance, otOperationalDataset *aDataset)
Эта функция получает активный рабочий набор данных.
otDatasetGetActiveTlvs ( otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Эта функция получает активный рабочий набор данных.
otDatasetGetDelayTimerMinimal ( otInstance *aInstance)
uint32_t
Получите таймер с минимальной задержкой.
otDatasetGetPending ( otInstance *aInstance, otOperationalDataset *aDataset)
Эта функция получает ожидающий рабочий набор данных.
otDatasetGetPendingTlvs ( otInstance *aInstance, otOperationalDatasetTlvs *aDataset)
Эта функция получает ожидающий рабочий набор данных.
otDatasetIsCommissioned ( otInstance *aInstance)
bool
Эта функция указывает, присутствует ли действующая сеть в активном наборе операционных данных или нет.
otDatasetParseTlvs (const otOperationalDatasetTlvs *aDatasetTlvs, otOperationalDataset *aDataset)
Эта функция анализирует операционный набор данных из otOperationalDatasetTlvs .
otDatasetSendMgmtActiveGet ( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Эта функция отправляет MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet ( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Эта функция отправляет MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet ( otInstance *aInstance, const otOperationalDatasetComponents *aDatasetComponents, const uint8_t *aTlvTypes, uint8_t aLength, const otIp6Address *aAddress)
Эта функция отправляет MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet ( otInstance *aInstance, const otOperationalDataset *aDataset, const uint8_t *aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void *aContext)
Эта функция отправляет MGMT_PENDING_SET.
otDatasetSetActive ( otInstance *aInstance, const otOperationalDataset *aDataset)
Эта функция устанавливает активный набор операционных данных.
otDatasetSetActiveTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Эта функция устанавливает активный набор операционных данных.
otDatasetSetDelayTimerMinimal ( otInstance *aInstance, uint32_t aDelayTimerMinimal)
Установите таймер минимальной задержки.
otDatasetSetPending ( otInstance *aInstance, const otOperationalDataset *aDataset)
Эта функция устанавливает ожидающий рабочий набор данных.
otDatasetSetPendingTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Эта функция устанавливает ожидающий рабочий набор данных.
otDatasetUpdaterCancelUpdate ( otInstance *aInstance)
void
Эта функция отменяет текущий (если есть) запрос на обновление рабочего набора данных.
otDatasetUpdaterIsUpdateOngoing ( otInstance *aInstance)
bool
Эта функция указывает, имеется ли текущий запрос на обновление набора рабочих данных.
otDatasetUpdaterRequestUpdate ( otInstance *aInstance, const otOperationalDataset *aDataset, otDatasetUpdaterCallback aCallback, void *aContext)
Эта функция запрашивает обновление оперативного набора данных.
otNetworkNameFromString ( otNetworkName *aNetworkName, const char *aNameString)
Эта функция устанавливает экземпляр otNetworkName из заданной строки C, оканчивающейся нулем.

Структуры

otExtendedPanId

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

otNetworkKey

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

otNetworkName

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

otOperationalDataset

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

otOperationalDatasetComponents

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

otOperationalDatasetTlvs

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

otPskc

Эта структура представляет PSKc.

otSecurityPolicy

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

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

otMeshcopTlvType

 otMeshcopTlvType

Это перечисление представляет типы TLV meshcop.

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

Активная временная метка meshcop TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

TLV локатора пограничных агентов meshcop

OT_MESHCOP_TLV_CHANNEL

TLV канала meshcop

OT_MESHCOP_TLV_CHANNELMASK

Маска канала meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

Идентификатор комиссара meshcop TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Комиссар meshcop UDP Порт TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

Идентификатор сеанса комиссара meshcop TLV

OT_MESHCOP_TLV_COUNT

meshcop Количество TLV

OT_MESHCOP_TLV_DELAYTIMER

Таймер задержки meshcop TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

TLV запроса обнаружения meshcop

OT_MESHCOP_TLV_DISCOVERYRESPONSE

Meshcop Discovery Response TLV

OT_MESHCOP_TLV_ENERGY_LIST

Энергетический список meshcop TLV

OT_MESHCOP_TLV_EXTPANID

TLV расширенного идентификатора сковороды meshcop

OT_MESHCOP_TLV_GET

meshcop Получить TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

TLV-адрес IPv6-адреса meshcop

OT_MESHCOP_TLV_JOINERADVERTISEMENT

Meshcop Столярная реклама TLV

OT_MESHCOP_TLV_JOINER_DTLS

meshcop Joiner DTLS Инкапсуляция TLV

OT_MESHCOP_TLV_JOINER_IID

Meshcop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Meshcop Joiner Router Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Meshcop Соединительный фрезерный станок KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

UDP-порт UDP-соединителя meshcop TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop Mesh Local Prefix TLV

OT_MESHCOP_TLV_NETWORKKEY

TLV сетевого ключа meshcop

OT_MESHCOP_TLV_NETWORKNAME

имя сети meshcop TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

TLV последовательности сетевого ключа meshcop

OT_MESHCOP_TLV_PANID

Идентификатор TLV-идентификатора сети meshcop

OT_MESHCOP_TLV_PENDINGTIMESTAMP

meshcop Pending Timestamp TLV

OT_MESHCOP_TLV_PERIOD

meshcop Период TLV

OT_MESHCOP_TLV_PROVISIONING_URL

TLV URL-адреса обеспечения meshcop

OT_MESHCOP_TLV_PSKC

Meshcop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

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

OT_MESHCOP_TLV_SECURITYPOLICY

TLV политики безопасности meshcop

OT_MESHCOP_TLV_STATE

meshcop Государственный TLV

OT_MESHCOP_TLV_STEERING_DATA

Данные рулевого управления meshcop TLV

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

UDP-инкапсуляция meshcop TLV

OT_MESHCOP_TLV_VENDOR_DATA_TLV

TLV данных поставщика meshcop

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

TLV модели поставщика meshcop

OT_MESHCOP_TLV_VENDOR_NAME_TLV

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

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Версия стека поставщика meshcop TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

Версия ПО поставщика meshcop TLV

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

otChannelMask

uint32_t otChannelMask

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

otDatasetMgmtSetCallback

void(* otDatasetMgmtSetCallback)(otError aResult, void *aContext)

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

Подробности
Параметры
[in] aResult
Результат операции.
[in] aContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Просьба была принята лидером.
OT_ERROR_REJECTED
Просьба была отклонена лидером.
OT_ERROR_PARSE
Произошла ошибка при анализе ответа.
OT_ERROR_ABORT
Запрос был сброшен узлом.
OT_ERROR_RESPONSE_TIMEOUT
Ответ или подтверждение не получены в течение периода тайм-аута.

otDatasetUpdaterCallback

void(* otDatasetUpdaterCallback)(otError aError, void *aContext)

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

Подробности
Параметры
[in] aError
Статус ошибки. OT_ERROR_NONE указывает на успешное обновление набора данных. OT_ERROR_INVALID_STATE указывает на сбой из-за недопустимого состояния (MLE отключен). OT_ERROR_ALREADY указывает на сбой из-за того, что другое устройство в сети запрашивает конфликтующее обновление набора данных.
[in] aContext
Указатель на произвольный контекст (предоставляется пользователем в otDatasetUpdaterRequestUpdate() ).

otExtendedPanId

struct otExtendedPanId otExtendedPanId

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

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

Эта структура представляет собой локальный префикс Mesh.

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

Это перечисление представляет типы TLV meshcop.

otNetworkKey

struct otNetworkKey otNetworkKey

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

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Этот тип данных представляет KeyRef для NetworkKey.

Ссылка на ключ

otNetworkName

struct otNetworkName otNetworkName

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

otNetworkName представляет собой строку C с нулевым завершением (т. е. массив символов m8 ДОЛЖЕН заканчиваться нулевым символом \0 ).

otOperationalDataset

struct otOperationalDataset otOperationalDataset

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

Компоненты в наборе данных являются необязательными. Структура mComponets указывает, какие компоненты присутствуют в наборе данных.

otOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

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

otOperationalDatasetTlvs

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

Операционный набор данных закодирован в TLV, как указано в Thread.

otPskc

struct otPskc otPskc

Эта структура представляет собой PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

Этот тип данных представляет KeyRef для PSKc.

Ссылка на ключ

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

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

Переменные

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Функции

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

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

otDatasetGeneratePskc

otError otDatasetGeneratePskc(
  const char *aPassPhrase,
  const otNetworkName *aNetworkName,
  const otExtendedPanId *aExtPanId,
  otPskc *aPskc
)

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

PSKc используется для установления сессии комиссара.

Подробности
Параметры
[in] aPassPhrase
Парольная фраза для ввода в эксплуатацию.
[in] aNetworkName
Сетевое имя для вычисления PSKc.
[in] aExtPanId
Расширенный идентификатор PAN для вычисления PSKc.
[out] aPskc
Указатель на переменную для вывода сгенерированного PSKc.
Возвращаемые значения
OT_ERROR_NONE
Успешно сгенерируйте PSKc.
OT_ERROR_INVALID_ARGS
Если какой-либо из входных аргументов неверен.

отдатасетжетактиве

otError otDatasetGetActive(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

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

otDatasetGetActiveTlvs

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

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

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

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

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

otDatasetGetPending

otError otDatasetGetPending(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

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

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

otDatasetGetPendingTlvs

otError otDatasetGetPendingTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

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

otDatasetIsCommissioned

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

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

otDatasetParseTlvs

otError otDatasetParseTlvs(
  const otOperationalDatasetTlvs *aDatasetTlvs,
  otOperationalDataset *aDataset
)

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

Подробности
Параметры
[in] aDatasetTlvs
Указатель на TLV набора данных.
[out] aDataset
Указатель на место, где будет размещен набор данных.
Возвращаемые значения
OT_ERROR_NONE
Успешно установить aDataset из aDatasetTlvs .
OT_ERROR_INVALID_ARGS
aDatasetTlvs недействителен.

otDatasetSendMgmtActiveGet

otError otDatasetSendMgmtActiveGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDatasetComponents
Указатель на структуру компонентов набора данных, указывающую, какие компоненты запрашивать.
[in] aTlvTypes
Указатель на массив, содержащий дополнительные необработанные типы TLV, которые необходимо запросить.
[in] aLength
Длина aTlvTypes .
[in] aAddress
Указатель на пункт назначения IPv6, если он равен NULL, по умолчанию будет использовать ведущий ALOC.
Возвращаемые значения
OT_ERROR_NONE
Успешно отправить команду набора данных meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.

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

otError otDatasetSendMgmtActiveSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDataset
Указатель на рабочий набор данных.
[in] aTlvs
Указатель на TLV.
[in] aLength
Длина TLV.
[in] aCallback
Указатель на функцию, которая вызывается при получении ответа или тайм-ауте.
[in] aContext
Указатель на контекст приложения для aCallback .
Возвращаемые значения
OT_ERROR_NONE
Успешно отправить команду набора данных meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.
OT_ERROR_BUSY
Предыдущий запрос обрабатывается.

otDatasetSendMgmtPendingGet

otError otDatasetSendMgmtPendingGet(
  otInstance *aInstance,
  const otOperationalDatasetComponents *aDatasetComponents,
  const uint8_t *aTlvTypes,
  uint8_t aLength,
  const otIp6Address *aAddress
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDatasetComponents
Указатель на структуру компонентов набора данных, указывающую, какие компоненты запрашивать.
[in] aTlvTypes
Указатель на массив, содержащий дополнительные необработанные типы TLV, которые необходимо запросить.
[in] aLength
Длина aTlvTypes .
[in] aAddress
Указатель на пункт назначения IPv6, если он равен NULL, по умолчанию будет использовать ведущий ALOC.
Возвращаемые значения
OT_ERROR_NONE
Успешно отправить команду набора данных meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.

otDatasetSendMgmtPendingSet

otError otDatasetSendMgmtPendingSet(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  const uint8_t *aTlvs,
  uint8_t aLength,
  otDatasetMgmtSetCallback aCallback,
  void *aContext
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDataset
Указатель на рабочий набор данных.
[in] aTlvs
Указатель на TLV.
[in] aLength
Длина TLV.
[in] aCallback
Указатель на функцию, которая вызывается при получении ответа или тайм-ауте.
[in] aContext
Указатель на контекст приложения для aCallback .
Возвращаемые значения
OT_ERROR_NONE
Успешно отправить команду набора данных meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.
OT_ERROR_BUSY
Предыдущий запрос обрабатывается.

отдатасетсетактиве

otError otDatasetSetActive(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

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

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

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

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDataset
Указатель на активный рабочий набор данных.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите активный рабочий набор данных.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для установки активного рабочего набора данных.
OT_ERROR_NOT_IMPLEMENTED
Платформа не реализует функциональность настроек.

отдатасетсетактиветлвс

otError otDatasetSetActiveTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

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

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

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

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

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aDataset
Указатель на активный рабочий набор данных.
Возвращаемые значения
OT_ERROR_NONE
Успешно установите активный рабочий набор данных.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для установки активного рабочего набора данных.
OT_ERROR_NOT_IMPLEMENTED
Платформа не реализует функциональность настроек.

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

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

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

otDatasetSetPending

otError otDatasetSetPending(
  otInstance *aInstance,
  const otOperationalDataset *aDataset
)

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

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

otDatasetSetPendingTlvs

otError otDatasetSetPendingTlvs(
  otInstance *aInstance,
  const otOperationalDatasetTlvs *aDataset
)

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

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

otDatasetUpdaterCancelUpdate

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

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

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

otDatasetUpdaterIsUpdateOngoing

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

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

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

otDatasetUpdaterRequestUpdate

otError otDatasetUpdaterRequestUpdate(
  otInstance *aInstance,
  const otOperationalDataset *aDataset,
  otDatasetUpdaterCallback aCallback,
  void *aContext
)

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

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

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

otNetworkNameFromString

otError otNetworkNameFromString(
  otNetworkName *aNetworkName,
  const char *aNameString
)

Эта функция устанавливает экземпляр otNetworkName из заданной строки C, оканчивающейся нулем.

Эта функция также проверяет, соответствует ли заданная aNameString кодировке UTF-8 и ее длина не превышает OT_NETWORK_NAME_MAX_SIZE .

Подробности
Параметры
[out] aNetworkName
Указатель на otNetworkName для установки.
[in] aNameString
Строка имени C.
Возвращаемые значения
OT_ERROR_NONE
Успешно установить aNetworkName из aNameString .
OT_ERROR_INVALID_ARGS
aNameStrng недействителен (слишком длинный или не соответствует кодировке UTF-8).

Макросы

OT_CHANNEL_10_MASK

 OT_CHANNEL_10_MASK (1 << 10)

10 канал.

OT_CHANNEL_11_MASK

 OT_CHANNEL_11_MASK (1 << 11)

11 канал.

OT_CHANNEL_12_MASK

 OT_CHANNEL_12_MASK (1 << 12)

12 канал.

OT_CHANNEL_13_MASK

 OT_CHANNEL_13_MASK (1 << 13)

13 канал.

OT_CHANNEL_14_MASK

 OT_CHANNEL_14_MASK (1 << 14)

14 канал.

OT_CHANNEL_15_MASK

 OT_CHANNEL_15_MASK (1 << 15)

15 канал.

OT_CHANNEL_16_MASK

 OT_CHANNEL_16_MASK (1 << 16)

16 канал.

OT_CHANNEL_17_MASK

 OT_CHANNEL_17_MASK (1 << 17)

17 канал.

OT_CHANNEL_18_MASK

 OT_CHANNEL_18_MASK (1 << 18)

18 канал.

OT_CHANNEL_19_MASK

 OT_CHANNEL_19_MASK (1 << 19)

19 канал.

OT_CHANNEL_1_MASK

 OT_CHANNEL_1_MASK (1 << 1)

Канал 1.

OT_CHANNEL_20_MASK

 OT_CHANNEL_20_MASK (1 << 20)

20 канал.

OT_CHANNEL_21_MASK

 OT_CHANNEL_21_MASK (1 << 21)

21 канал.

OT_CHANNEL_22_MASK

 OT_CHANNEL_22_MASK (1 << 22)

22 канал.

OT_CHANNEL_23_MASK

 OT_CHANNEL_23_MASK (1 << 23)

23 канал.

OT_CHANNEL_24_MASK

 OT_CHANNEL_24_MASK (1 << 24)

24 канал.

OT_CHANNEL_25_MASK

 OT_CHANNEL_25_MASK (1 << 25)

25 канал.

OT_CHANNEL_26_MASK

 OT_CHANNEL_26_MASK (1 << 26)

26 канал.

OT_CHANNEL_2_MASK

 OT_CHANNEL_2_MASK (1 << 2)

Канал 2.

OT_CHANNEL_3_MASK

 OT_CHANNEL_3_MASK (1 << 3)

Канал 3.

OT_CHANNEL_4_MASK

 OT_CHANNEL_4_MASK (1 << 4)

Канал 4.

OT_CHANNEL_5_MASK

 OT_CHANNEL_5_MASK (1 << 5)

Канал 5.

OT_CHANNEL_6_MASK

 OT_CHANNEL_6_MASK (1 << 6)

6 канал.

OT_CHANNEL_7_MASK

 OT_CHANNEL_7_MASK (1 << 7)

Канал 7.

OT_CHANNEL_8_MASK

 OT_CHANNEL_8_MASK (1 << 8)

Канал 8.

OT_CHANNEL_9_MASK

 OT_CHANNEL_9_MASK (1 << 9)

Канал 9.

OT_EXT_PAN_ID_SIZE

 OT_EXT_PAN_ID_SIZE 8

Размер идентификатора PAN потока (в байтах)

OT_MESH_LOCAL_PREFIX_SIZE

 OT_MESH_LOCAL_PREFIX_SIZE OT_IP6_PREFIX_SIZE

Размер локального префикса сетки (в байтах)

OT_NETWORK_KEY_SIZE

 OT_NETWORK_KEY_SIZE 16

Размер сетевого ключа потока (байты)

OT_NETWORK_NAME_MAX_SIZE

 OT_NETWORK_NAME_MAX_SIZE 16

Максимальный размер поля сетевого имени потока (байты)

OT_OPERATIONAL_DATASET_MAX_LENGTH

 OT_OPERATIONAL_DATASET_MAX_LENGTH 254

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

OT_PSKC_MAX_SIZE

 OT_PSKC_MAX_SIZE 16

Максимальный размер PSKc (байты)

Ресурсы

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