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

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

Резюме

Функции этого модуля доступны , когда функция 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.

Typedefs

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

Переменные

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)
Эта функция разбирает Operational Dataset от А 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

Mescop Active Timestamp TLV

OT_MESHCOP_TLV_BORDER_AGENT_RLOC

Mescop Border Agent Locator TLV

OT_MESHCOP_TLV_CHANNEL

Mescop Channel TLV

OT_MESHCOP_TLV_CHANNELMASK

Meshcop Channel Mask TLV

OT_MESHCOP_TLV_COMMISSIONER_ID

meshcop Commissioner ID TLV

OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT

meshcop Комиссар UDP-порт TLV

OT_MESHCOP_TLV_COMM_SESSION_ID

meshcop ИД сеанса комиссара TLV

OT_MESHCOP_TLV_COUNT

Meshcop Count TLV

OT_MESHCOP_TLV_DELAYTIMER

Mescop Delay Timer TLV

OT_MESHCOP_TLV_DISCOVERYREQUEST

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

OT_MESHCOP_TLV_DISCOVERYRESPONSE

TLV отклика на обнаружение meshcop

OT_MESHCOP_TLV_ENERGY_LIST

Mescop Energy List TLV

OT_MESHCOP_TLV_EXTPANID

Mescop Extended Pan Id TLV

OT_MESHCOP_TLV_GET

meshcop Получить TLV

OT_MESHCOP_TLV_IPV6_ADDRESS_TLV

IPv6-адрес meshcop TLV

OT_MESHCOP_TLV_JOINERADVERTISEMENT

Mescop Joiner Advertising TLV

OT_MESHCOP_TLV_JOINER_DTLS

Meshcop Joiner DTLS Encapsulation TLV

OT_MESHCOP_TLV_JOINER_IID

Mescop Joiner IID TLV

OT_MESHCOP_TLV_JOINER_RLOC

meshcop Joiner Router Locator TLV

OT_MESHCOP_TLV_JOINER_ROUTER_KEK

Mescop Joiner Router KEK TLV

OT_MESHCOP_TLV_JOINER_UDP_PORT

Mescop Joiner UDP-порт 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

Mescop Pan Id TLV

OT_MESHCOP_TLV_PENDINGTIMESTAMP

Meshcop ожидающая отметка времени TLV

OT_MESHCOP_TLV_PERIOD

meshcop Период TLV

OT_MESHCOP_TLV_PROVISIONING_URL

TLV инициализации URL-адреса meshcop

OT_MESHCOP_TLV_PSKC

мешкоп PSKc TLV

OT_MESHCOP_TLV_SCAN_DURATION

Meshcop Scan Duration TLV

OT_MESHCOP_TLV_SECURITYPOLICY

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

OT_MESHCOP_TLV_STATE

Mescop State TLV

OT_MESHCOP_TLV_STEERING_DATA

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

OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV

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

OT_MESHCOP_TLV_VENDOR_DATA_TLV

Mescop Vendor Data TLV

OT_MESHCOP_TLV_VENDOR_MODEL_TLV

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

OT_MESHCOP_TLV_VENDOR_NAME_TLV

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

OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV

Mescop Vendor Stack Version TLV

OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV

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

Typedefs

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

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

otMeshcopTlvType

enum otMeshcopTlvType otMeshcopTlvType

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

otNetworkKey

struct otNetworkKey otNetworkKey

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

otNetworkKeyRef

otCryptoKeyRef otNetworkKeyRef

Этот тип данных представляет KeyRef to 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 to 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
Если какой-либо из входных аргументов недействителен.

otDatasetGetActive

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.
Возврат
ИСТИНА, если действующая сеть присутствует в активном наборе рабочих данных, в противном случае - ЛОЖЬ.

otDatasetParseTlvs

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

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

otDatasetSendMgmtActiveSet

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

otDatasetSetActive

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
Платформа не реализует функциональность настроек.

otDatasetSetActiveTlvs

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
)

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

Подробности
Параметры
[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
Dataset обновление успешно запущен ( 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 ID потока (байты)

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 (байты)