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

Включает функции для API набора операционных данных.

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

Только для сборок FTD Dataset Updater включает функции для управления обновлениями наборов данных.

Для сборок FTD и MTD API рабочих наборов данных включает функции для управления активными и ожидающими наборами данных, а также TLV наборов данных.

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

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 mescop.

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

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

Переменные

OT_TOOL_PACKED_END

Функции

otDatasetConvertToTlvs (const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Преобразует заданный набор операционных данных в otOperationalDatasetTlvs .
otDatasetCreateNewNetwork ( otInstance *aInstance, otOperationalDataset *aDataset)
Только для FTD: создает новый набор операционных данных для использования при формировании новой сети.
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
Только для FTD получает таймер минимальной задержки.
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)
Только для FTD устанавливает таймер минимальной задержки.
otDatasetSetPending ( otInstance *aInstance, const otOperationalDataset *aDataset)
Устанавливает ожидающий набор операционных данных.
otDatasetSetPendingTlvs ( otInstance *aInstance, const otOperationalDatasetTlvs *aDataset)
Устанавливает ожидающий набор операционных данных.
otDatasetUpdateTlvs (const otOperationalDataset *aDataset, otOperationalDatasetTlvs *aDatasetTlvs)
Обновляет данный набор операционных данных.
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 с нулевым завершением.

Структуры

отExtendedPanId

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

otNetworkKey

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

отNetworkName

Представляет сетевое имя.

otOperationalDataset

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

отOperationalDatasetComponents

Обозначает наличие различных компонентов в активном или ожидающем наборе операционных данных.

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

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

отPskc

Представляет PSKc.

otSecurityPolicy

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

отTimestamp

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

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

отМешкоптлвтипе

 otMeshcopTlvType

Представляет типы TLV mescop.

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

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

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Meshcop TLV локатора пограничного агента

OT_MESHCOP_TLV_CHANNEL

Mescop TLV канала

OT_MESHCOP_TLV_CHANNELMASK

mescop TLV маски канала

OT_MESHCOP_TLV_COMMISSIONER_ID

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

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

Mescop комиссар UDP порт TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

TLV-идентификатор сеанса комиссара mescop

OT_MESHCOP_TLV_COUNT

mescop Подсчет 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

mescop TLV расширенного идентификатора панорамы

OT_MESHCOP_TLV_GET

mescop Получить TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

Meshcop IPv6-адрес TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

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

OT_MESHCOP_TLV_JOINER_DTLS

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

OT_MESHCOP_TLV_JOINER_IID

mescop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

Meshcop Столярный локатор маршрутизатора TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Meshcop Столярный маршрутизатор KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Mescop Joiner UDP-порт TLV

OT_MESHCOP_TLV_MESHLOCALPREFIX

meshcop TLV локального префикса сетки

OT_MESHCOP_TLV_NETWORKKEY

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

OT_MESHCOP_TLV_NETWORKNAME

Meshcop Имя сети TLV

OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE

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

OT_MESHCOP_TLV_PANID

Mescop Pan Id TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

mescop Ожидающая временная метка TLV

OT_MESHCOP_TLV_PERIOD

mescop Период TLV

OT_MESHCOP_TLV_PROVISIONING_URL

mescop URL-адрес предоставления TLV

OT_MESHCOP_TLV_PSKC

mescop PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

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

OT_MESHCOP_TLV_SECURITYPOLICY

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

OT_MESHCOP_TLV_STATE

мешкоп Государственный TLV

OT_MESHCOP_TLV_STEERING_DATA

mescop TLV данных рулевого управления

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

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

OT_MESHCOP_TLV_VENDOR_DATA_TLV

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

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

Модель производителя Meshcop TLV

OT_MESHCOP_TLV_VENDOR_NAME_TLV

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

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

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

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

mescop Версия ПО производителя TLV

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

otChannelMask

uint32_t otChannelMask

Представляет маску канала.

отдатасетмгмтсетколлбэк

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
В течение периода ожидания не получен ответ или подтверждение.

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

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

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

Доступно, если включен OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

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

отExtendedPanId

struct otExtendedPanId otExtendedPanId

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

otMeshLocalPrefix

otIp6NetworkPrefix otMeshLocalPrefix

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

отМешкоптлвтипе

enum otMeshcopTlvType otMeshcopTlvType

Представляет типы TLV mescop.

otNetworkKey

struct otNetworkKey otNetworkKey

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

отнетворккейреф

otCryptoKeyRef otNetworkKeyRef

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

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

отNetworkName

struct otNetworkName otNetworkName

Представляет сетевое имя.

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

otOperationalDataset

struct otOperationalDataset otOperationalDataset

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

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

отOperationalDatasetComponents

struct otOperationalDatasetComponents otOperationalDatasetComponents

Обозначает наличие различных компонентов в активном или ожидающем наборе операционных данных.

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

struct otOperationalDatasetTlvs otOperationalDatasetTlvs

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

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

отPskc

struct otPskc otPskc

Представляет PSKc.

otPskcRef

otCryptoKeyRef otPskcRef

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

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

otSecurityPolicy

struct otSecurityPolicy otSecurityPolicy

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

отTimestamp

struct otTimestamp otTimestamp

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

Переменные

OT_TOOL_PACKED_END

OT_TOOL_PACKED_BEGIN struct otNetworkKey OT_TOOL_PACKED_END

Функции

отдатасетконверттотлвс

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

Преобразует заданный набор операционных данных в otOperationalDatasetTlvs .

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

otDatasetCreateNewNetwork

otError otDatasetCreateNewNetwork(
  otInstance *aInstance,
  otOperationalDataset *aDataset
)

Только для FTD: создает новый набор операционных данных для использования при формировании новой сети.

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

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

otError otDatasetGetActiveTlvs(
  otInstance *aInstance,
  otOperationalDatasetTlvs *aDataset
)

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

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

otDatasetGetDelayTimerMinimal

uint32_t otDatasetGetDelayTimerMinimal(
  otInstance *aInstance
)

Только для FTD получает таймер минимальной задержки.

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

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

bool otDatasetIsCommissioned(
  otInstance *aInstance
)

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

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

отдатасетпарсетлвс

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

Анализирует набор операционных данных из заданного otOperationalDatasetTlvs .

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

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

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, по умолчанию будет использовать Leader 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
Предыдущий запрос находится в обработке.

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

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, по умолчанию будет использовать Leader ALOC.
Возвращаемые значения
OT_ERROR_NONE
Успешно отправьте команду набора данных Meshcop.
OT_ERROR_NO_BUFS
Недостаточно места в буфере для отправки.

отдатасетсендмгмтпендингсет

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
)

Устанавливает активный набор рабочих данных.

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

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

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

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

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

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

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

Устанавливает активный набор рабочих данных.

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

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

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

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

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

otDatasetSetDelayTimerMinimal

otError otDatasetSetDelayTimerMinimal(
  otInstance *aInstance,
  uint32_t aDelayTimerMinimal
)

Только для FTD устанавливает таймер минимальной задержки.

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

отDatasetSetPending

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

Устанавливает ожидающий набор операционных данных.

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

отдатасетсетсетпендингтлвс

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

Устанавливает ожидающий набор операционных данных.

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

отдатасетупдатетлвс

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

Обновляет данный набор операционных данных.

aDataset содержит обновляемые поля и их новое значение.

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

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

void otDatasetUpdaterCancelUpdate(
  otInstance *aInstance
)

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

Доступно, если включен OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

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

отдатасетупдатерисупдатеонгоинг

bool otDatasetUpdaterIsUpdateOngoing(
  otInstance *aInstance
)

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

Доступно, если включен OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

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

отдатасетупдатеррекуеступдате

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

Запрашивает обновление набора операционных данных.

Доступно, если включен OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE .

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
Не удалось выделить буфер для сохранения набора данных.

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

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 . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .