Столяр

Этот модуль включает функции для роли объединения потоков.

Резюме

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

otJoinerState перечисление
Это перечисление определяет состояние присоединения.

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

otJoinerCallback )(otError aError, void *aContext) определение типа
void(*
Этот указатель функции вызывается для уведомления о завершении операции соединения.
otJoinerDiscerner определение типа
Эта структура представляет распознаватель столяров.
otJoinerState определение типа
Это перечисление определяет состояние присоединения.

Функции

otJoinerGetDiscerner ( otInstance *aInstance)
Эта функция получает распознаватель столяров.
otJoinerGetId ( otInstance *aInstance)
const otExtAddress *
Эта функция получает идентификатор столяра.
otJoinerGetState ( otInstance *aInstance)
Эта функция возвращает состояние соединения.
otJoinerSetDiscerner ( otInstance *aInstance, otJoinerDiscerner *aDiscerner)
Эта функция устанавливает распознаватель столяров.
otJoinerStart ( otInstance *aInstance, const char *aPskd, const char *aProvisioningUrl, const char *aVendorName, const char *aVendorModel, const char *aVendorSwVersion, const char *aVendorData, otJoinerCallback aCallback, void *aContext)
Эта функция включает роль объединения потоков.
otJoinerStateToString ( otJoinerState aState)
const char *
Эта функция преобразует заданное значение перечисления состояния столяра в удобочитаемую строку.
otJoinerStop ( otInstance *aInstance)
void
Эта функция отключает роль объединения потоков.

Структуры

otJoinerDiscerner

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

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

otJoinerState

 otJoinerState

Это перечисление определяет состояние присоединения.

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

otJoinerCallback

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

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

Подробности
Параметры
[in] aError
OT_ERROR_NONE, если процесс присоединения завершился успешно. OT_ERROR_SECURITY, если процесс присоединения завершился неудачно из-за учетных данных безопасности. OT_ERROR_NOT_FOUND, если сеть, к которой можно присоединиться, не обнаружена. OT_ERROR_RESPONSE_TIMEOUT, если время ответа истекло.
[in] aContext
Указатель на контекст конкретного приложения.

otJoinerDiscerner

struct otJoinerDiscerner otJoinerDiscerner

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

otJoinerState

enum otJoinerState otJoinerState

Это перечисление определяет состояние присоединения.

Функции

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

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

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

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

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

Если Joiner Discerner не установлен, Joiner ID — это первые 64 бита результата вычисления SHA-256 по сравнению с заводским значением IEEE EUI-64. В противном случае идентификатор присоединяющегося рассчитывается на основе значения распознавателя присоединяющегося.

Идентификатор присоединения также используется в качестве расширенного адреса устройства IEEE 802.15.4 в процессе ввода в эксплуатацию.

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

otJoinerGetState

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Эта функция возвращает состояние соединения.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возвращаемые значения
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_JOINED

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

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

Joiner Discerner используется для расчета идентификатора Joiner ID, используемого в процессе ввода в эксплуатацию/присоединения.

По умолчанию (когда распознаватель не указан или имеет значение NULL), идентификатор присоединения выводится как первые 64 бита результата вычисления SHA-256 по сравнению с заводским значением IEEE EUI-64. Обратите внимание, что это основное поведение, ожидаемое спецификацией Thread.

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

otJoinerStart

otError otJoinerStart(
  otInstance *aInstance,
  const char *aPskd,
  const char *aProvisioningUrl,
  const char *aVendorName,
  const char *aVendorModel,
  const char *aVendorSwVersion,
  const char *aVendorData,
  otJoinerCallback aCallback,
  void *aContext
)

Эта функция включает роль объединения потоков.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aPskd
Указатель на PSKd.
[in] aProvisioningUrl
Указатель на URL-адрес подготовки (может быть NULL).
[in] aVendorName
Указатель на имя поставщика (может быть NULL).
[in] aVendorModel
Указатель на модель поставщика (может быть NULL).
[in] aVendorSwVersion
Указатель на версию программного обеспечения поставщика (может быть NULL).
[in] aVendorData
Указатель на данные поставщика (может быть NULL).
[in] aCallback
Указатель на функцию, которая вызывается после завершения операции соединения.
[in] aContext
Указатель на контекст конкретного приложения.
Возвращаемые значения
OT_ERROR_NONE
Успешно начал роль Столяра.
OT_ERROR_BUSY
Предыдущая попытка все еще продолжается.
OT_ERROR_INVALID_ARGS
aPskd или aProvisioningUrl недействительны.
OT_ERROR_INVALID_STATE
Стек IPv6 не включен или стек потоков полностью включен.

otJoinerStateToString

const char * otJoinerStateToString(
  otJoinerState aState
)

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

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

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Эта функция отключает роль объединения потоков.

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

Макросы

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

Максимальная длина Joiner Discerner в битах.

Ресурсы

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