Столяр

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

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

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

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)
Включает роль Thread Joiner.
otJoinerStateToString ( otJoinerState aState)
const char *
Преобразует заданное значение перечисления состояния соединения в удобочитаемую строку.
otJoinerStop ( otInstance *aInstance)
void
Отключает роль Thread Joiner.

Структуры

otJoinerDiscerner

Представляет столярного проницателя.

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

отДжойнерстате

 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

Представляет столярного проницателя.

отДжойнерстате

enum otJoinerState otJoinerState

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

Функции

otJoinerGetDiscerner

const otJoinerDiscerner * otJoinerGetDiscerner(
  otInstance *aInstance
)

Получает Проницатель Столяра.

Для получения дополнительной информации обратитесь к otJoinerSetDiscerner .

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

otJoinerGetId

const otExtAddress * otJoinerGetId(
  otInstance *aInstance
)

Получает идентификатор участника.

Если средство распознавания соединений не установлено, идентификатор соединения представляет собой первые 64 бита результата вычисления SHA-256 по назначенному на заводе стандарту IEEE EUI-64. В противном случае идентификатор соединения рассчитывается на основе значения средства распознавания соединения.

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

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

отджойнержетстате

otJoinerState otJoinerGetState(
  otInstance *aInstance
)

Получает состояние соединения.

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

otJoinerSetDiscerner

otError otJoinerSetDiscerner(
  otInstance *aInstance,
  otJoinerDiscerner *aDiscerner
)

Устанавливает средство распознавания соединений.

Средство распознавания соединений используется для расчета идентификатора соединения во время процесса ввода в эксплуатацию потока. Для получения дополнительной информации обратитесь к otJoinerGetId .

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

отДжойнерСтарт

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
)

Включает роль Thread Joiner.

Подробности
Параметры
[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 не включен или стек потоков полностью включен.

отджойнерстатетостринг

const char * otJoinerStateToString(
  otJoinerState aState
)

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

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

otJoinerStop

void otJoinerStop(
  otInstance *aInstance
)

Отключает роль Thread Joiner.

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

Макросы

OT_JOINER_MAX_DISCERNER_LENGTH

 OT_JOINER_MAX_DISCERNER_LENGTH 64

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

Ресурсы

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